| 1 | //===-- SPIRVLegalizePointerCast.cpp ----------------------*- C++ -*-===// |
| 2 | // |
| 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | // |
| 9 | // The LLVM IR has multiple legal patterns we cannot lower to Logical SPIR-V. |
| 10 | // This pass modifies such loads to have an IR we can directly lower to valid |
| 11 | // logical SPIR-V. |
| 12 | // OpenCL can avoid this because they rely on ptrcast, which is not supported |
| 13 | // by logical SPIR-V. |
| 14 | // |
| 15 | // This pass relies on the assign_ptr_type intrinsic to deduce the type of the |
| 16 | // pointed values, must replace all occurences of `ptrcast`. This is why |
| 17 | // unhandled cases are reported as unreachable: we MUST cover all cases. |
| 18 | // |
| 19 | // 1. Loading the first element of an array |
| 20 | // |
| 21 | // %array = [10 x i32] |
| 22 | // %value = load i32, ptr %array |
| 23 | // |
| 24 | // LLVM can skip the GEP instruction, and only request loading the first 4 |
| 25 | // bytes. In logical SPIR-V, we need an OpAccessChain to access the first |
| 26 | // element. This pass will add a getelementptr instruction before the load. |
| 27 | // |
| 28 | // |
| 29 | // 2. Implicit downcast from load |
| 30 | // |
| 31 | // %1 = getelementptr <4 x i32>, ptr %vec4, i64 0 |
| 32 | // %2 = load <3 x i32>, ptr %1 |
| 33 | // |
| 34 | // The pointer in the GEP instruction is only used for offset computations, |
| 35 | // but it doesn't NEED to match the pointed type. OpAccessChain however |
| 36 | // requires this. Also, LLVM loads define the bitwidth of the load, not the |
| 37 | // pointer. In this example, we can guess %vec4 is a vec4 thanks to the GEP |
| 38 | // instruction basetype, but we only want to load the first 3 elements, hence |
| 39 | // do a partial load. In logical SPIR-V, this is not legal. What we must do |
| 40 | // is load the full vector (basetype), extract 3 elements, and recombine them |
| 41 | // to form a 3-element vector. |
| 42 | // |
| 43 | //===----------------------------------------------------------------------===// |
| 44 | |
| 45 | #include "SPIRV.h" |
| 46 | #include "SPIRVSubtarget.h" |
| 47 | #include "SPIRVTargetMachine.h" |
| 48 | #include "SPIRVUtils.h" |
| 49 | #include "llvm/IR/IRBuilder.h" |
| 50 | #include "llvm/IR/IntrinsicInst.h" |
| 51 | #include "llvm/IR/Intrinsics.h" |
| 52 | #include "llvm/IR/IntrinsicsSPIRV.h" |
| 53 | #include "llvm/Transforms/Utils/Cloning.h" |
| 54 | #include "llvm/Transforms/Utils/LowerMemIntrinsics.h" |
| 55 | |
| 56 | using namespace llvm; |
| 57 | |
| 58 | namespace { |
| 59 | class SPIRVLegalizePointerCastImpl { |
| 60 | |
| 61 | // Builds the `spv_assign_type` assigning |Ty| to |Value| at the current |
| 62 | // builder position. |
| 63 | void buildAssignType(IRBuilder<> &B, Type *Ty, Value *Arg) { |
| 64 | Value *OfType = PoisonValue::get(T: Ty); |
| 65 | CallInst *AssignCI = buildIntrWithMD(IntrID: Intrinsic::spv_assign_type, |
| 66 | Types: {Arg->getType()}, Arg: OfType, Arg2: Arg, Imms: {}, B); |
| 67 | GR->addAssignPtrTypeInstr(Val: Arg, AssignPtrTyCI: AssignCI); |
| 68 | } |
| 69 | |
| 70 | static FixedVectorType *makeVectorFromTotalBits(Type *ElemTy, |
| 71 | TypeSize TotalBits) { |
| 72 | unsigned ElemBits = ElemTy->getScalarSizeInBits(); |
| 73 | assert(ElemBits && TotalBits % ElemBits == 0 && |
| 74 | "TotalBits must be divisible by element bit size" ); |
| 75 | return FixedVectorType::get(ElementType: ElemTy, NumElts: TotalBits / ElemBits); |
| 76 | } |
| 77 | |
| 78 | Value *resizeVectorBitsWithShuffle(IRBuilder<> &B, Value *V, |
| 79 | FixedVectorType *DstTy) { |
| 80 | auto *SrcTy = cast<FixedVectorType>(Val: V->getType()); |
| 81 | assert(SrcTy->getElementType() == DstTy->getElementType() && |
| 82 | "shuffle resize expects identical element types" ); |
| 83 | |
| 84 | const unsigned NumNeeded = DstTy->getNumElements(); |
| 85 | const unsigned NumSource = SrcTy->getNumElements(); |
| 86 | |
| 87 | SmallVector<int> Mask(NumNeeded); |
| 88 | for (unsigned I = 0; I < NumNeeded; ++I) |
| 89 | Mask[I] = (I < NumSource) ? static_cast<int>(I) : -1; |
| 90 | |
| 91 | Value *Resized = B.CreateShuffleVector(V1: V, V2: V, Mask); |
| 92 | buildAssignType(B, Ty: DstTy, Arg: Resized); |
| 93 | return Resized; |
| 94 | } |
| 95 | |
| 96 | // Loads parts of the vector of type |SourceType| from the pointer |Source| |
| 97 | // and create a new vector of type |TargetType|. |TargetType| must be a vector |
| 98 | // type. |
| 99 | // Returns the loaded value. |
| 100 | Value *loadVectorFromVector(IRBuilder<> &B, FixedVectorType *SourceType, |
| 101 | FixedVectorType *TargetType, Value *Source, |
| 102 | Align OriginalAlign) { |
| 103 | LoadInst *NewLoad = B.CreateLoad(Ty: SourceType, Ptr: Source); |
| 104 | NewLoad->setAlignment(OriginalAlign); |
| 105 | buildAssignType(B, Ty: SourceType, Arg: NewLoad); |
| 106 | Value *AssignValue = NewLoad; |
| 107 | if (TargetType->getElementType() != SourceType->getElementType()) { |
| 108 | const DataLayout &DL = B.getDataLayout(); |
| 109 | TypeSize TargetTypeSize = DL.getTypeSizeInBits(Ty: TargetType); |
| 110 | TypeSize SourceTypeSize = DL.getTypeSizeInBits(Ty: SourceType); |
| 111 | |
| 112 | Value *BitcastSrcVal = NewLoad; |
| 113 | FixedVectorType *BitcastSrcTy = |
| 114 | cast<FixedVectorType>(Val: BitcastSrcVal->getType()); |
| 115 | FixedVectorType *BitcastDstTy = TargetType; |
| 116 | |
| 117 | if (TargetTypeSize != SourceTypeSize) { |
| 118 | unsigned TargetElemBits = |
| 119 | TargetType->getElementType()->getScalarSizeInBits(); |
| 120 | if (SourceTypeSize % TargetElemBits == 0) { |
| 121 | // No Resize needed. Same total bits as source, but use target element |
| 122 | // type. |
| 123 | BitcastDstTy = makeVectorFromTotalBits(ElemTy: TargetType->getElementType(), |
| 124 | TotalBits: SourceTypeSize); |
| 125 | } else { |
| 126 | // Resize source to target total bitwidth using source element type. |
| 127 | BitcastSrcTy = makeVectorFromTotalBits(ElemTy: SourceType->getElementType(), |
| 128 | TotalBits: TargetTypeSize); |
| 129 | BitcastSrcVal = resizeVectorBitsWithShuffle(B, V: NewLoad, DstTy: BitcastSrcTy); |
| 130 | } |
| 131 | } |
| 132 | AssignValue = |
| 133 | B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, |
| 134 | OverloadTypes: {BitcastDstTy, BitcastSrcTy}, Args: {BitcastSrcVal}); |
| 135 | buildAssignType(B, Ty: BitcastDstTy, Arg: AssignValue); |
| 136 | if (BitcastDstTy == TargetType) |
| 137 | return AssignValue; |
| 138 | } |
| 139 | |
| 140 | auto *AssignVecTy = cast<FixedVectorType>(Val: AssignValue->getType()); |
| 141 | const unsigned NumTarget = TargetType->getNumElements(); |
| 142 | const unsigned NumSource = AssignVecTy->getNumElements(); |
| 143 | |
| 144 | // Optimizations may widen a narrow load to cover padding (e.g., loading a |
| 145 | // <1 x float> column as <4 x float>). Since extra lanes read trailing |
| 146 | // padding, insert only the valid lanes into a poison vector to avoid poison |
| 147 | // scalars. |
| 148 | if (NumTarget > NumSource) { |
| 149 | Value *Result = PoisonValue::get(T: TargetType); |
| 150 | buildAssignType(B, Ty: TargetType, Arg: Result); |
| 151 | for (unsigned I = 0; I < NumSource; ++I) { |
| 152 | Value *Scalar = extractScalarFromVector(B, Vector: AssignValue, Index: I); |
| 153 | Result = makeInsertElement(B, Vector: Result, Element: Scalar, Index: I); |
| 154 | } |
| 155 | return Result; |
| 156 | } |
| 157 | |
| 158 | assert(NumTarget < NumSource); |
| 159 | SmallVector<int> Mask(/* Size= */ NumTarget); |
| 160 | for (unsigned I = 0; I < NumTarget; ++I) |
| 161 | Mask[I] = I; |
| 162 | Value *Output = B.CreateShuffleVector(V1: AssignValue, V2: AssignValue, Mask); |
| 163 | buildAssignType(B, Ty: TargetType, Arg: Output); |
| 164 | return Output; |
| 165 | } |
| 166 | |
| 167 | // Returns true if |FromTy| has a memory layout compatible with loading or |
| 168 | // storing |ToTy|. |
| 169 | bool isCompatibleMemoryLayout(Type *ToTy, Type *FromTy) { |
| 170 | if (ToTy == FromTy) |
| 171 | return true; |
| 172 | auto *SVT = dyn_cast<FixedVectorType>(Val: FromTy); |
| 173 | auto *DVT = dyn_cast<FixedVectorType>(Val: ToTy); |
| 174 | if (SVT && DVT) |
| 175 | return true; |
| 176 | if (SVT && (ToTy->isIntegerTy() || ToTy->isFloatingPointTy()) && |
| 177 | ToTy->getPrimitiveSizeInBits() == SVT->getPrimitiveSizeInBits()) |
| 178 | return true; |
| 179 | auto *SAT = dyn_cast<ArrayType>(Val: FromTy); |
| 180 | if (SAT && DVT) { |
| 181 | if (SAT->getElementType() == DVT->getElementType()) |
| 182 | return true; |
| 183 | if (auto *MAT = dyn_cast<FixedVectorType>(Val: SAT->getElementType())) |
| 184 | if (MAT->getElementType() == DVT->getElementType()) |
| 185 | return true; |
| 186 | } |
| 187 | return false; |
| 188 | } |
| 189 | |
| 190 | // Traverses the aggregate type to find the first sub-type that matches |
| 191 | // the TargetElemType's memory layout, optionally emitting a GEP intrinsic. |
| 192 | std::optional<std::pair<Value *, Type *>> |
| 193 | getPointerToFirstCompatibleType(IRBuilder<> &B, Value *BasePtr, |
| 194 | Type *PointerType, Type *TargetElemType, |
| 195 | bool IsInBounds) { |
| 196 | Type *CurrentTy = GR->findDeducedElementType(Val: BasePtr); |
| 197 | assert(CurrentTy && "Could not deduce aggregate type" ); |
| 198 | SmallVector<Value *, 8> Args{/* isInBounds= */ B.getInt1(V: IsInBounds), |
| 199 | BasePtr}; |
| 200 | Args.push_back(Elt: B.getInt32(C: 0)); // Pointer offset |
| 201 | |
| 202 | while (!isCompatibleMemoryLayout(ToTy: TargetElemType, FromTy: CurrentTy)) { |
| 203 | if (auto *ST = dyn_cast<StructType>(Val: CurrentTy)) { |
| 204 | if (ST->getNumElements() == 0) |
| 205 | return std::nullopt; |
| 206 | CurrentTy = ST->getTypeAtIndex(N: 0u); |
| 207 | } else if (auto *AT = dyn_cast<ArrayType>(Val: CurrentTy)) { |
| 208 | CurrentTy = AT->getElementType(); |
| 209 | } else if (auto *VT = dyn_cast<FixedVectorType>(Val: CurrentTy)) { |
| 210 | CurrentTy = VT->getElementType(); |
| 211 | } else { |
| 212 | return std::nullopt; |
| 213 | } |
| 214 | Args.push_back(Elt: B.getInt32(C: 0)); |
| 215 | } |
| 216 | |
| 217 | Value *GEP = BasePtr; |
| 218 | if (Args.size() > 3) { |
| 219 | std::array<Type *, 2> Types = {PointerType, BasePtr->getType()}; |
| 220 | GEP = B.CreateIntrinsic(ID: Intrinsic::spv_gep, OverloadTypes: {Types}, Args: {Args}); |
| 221 | GR->buildAssignPtr(B, ElemTy: CurrentTy, Arg: GEP); |
| 222 | } |
| 223 | |
| 224 | return std::make_pair(x&: GEP, y&: CurrentTy); |
| 225 | } |
| 226 | |
| 227 | static IntrinsicInst *getResourceGetPointer(Value *Ptr) { |
| 228 | if (auto *II = dyn_cast<IntrinsicInst>(Val: Ptr)) |
| 229 | if (II->getIntrinsicID() == Intrinsic::spv_resource_getpointer) |
| 230 | return II; |
| 231 | return nullptr; |
| 232 | } |
| 233 | |
| 234 | Value *gepByteOffset(IRBuilder<> &B, Value *BasePtr, unsigned ByteOffset) { |
| 235 | if (ByteOffset == 0) |
| 236 | return BasePtr; |
| 237 | |
| 238 | if (IntrinsicInst *ResourcePtr = getResourceGetPointer(Ptr: BasePtr)) { |
| 239 | Value *Handle = ResourcePtr->getOperand(i_nocapture: 0); |
| 240 | Value *BaseOffset = ResourcePtr->getOperand(i_nocapture: 1); |
| 241 | Value *NewOffset; |
| 242 | if (auto *CI = dyn_cast<ConstantInt>(Val: BaseOffset)) { |
| 243 | NewOffset = |
| 244 | ConstantInt::get(Ty: CI->getType(), V: CI->getZExtValue() + ByteOffset); |
| 245 | } else { |
| 246 | NewOffset = B.CreateAdd( |
| 247 | LHS: BaseOffset, RHS: ConstantInt::get(Ty: BaseOffset->getType(), V: ByteOffset)); |
| 248 | buildAssignType(B, Ty: NewOffset->getType(), Arg: NewOffset); |
| 249 | } |
| 250 | SmallVector<OperandBundleDef> OpBundles; |
| 251 | ResourcePtr->getOperandBundlesAsDefs(Defs&: OpBundles); |
| 252 | CallInst *ResourcePtrAtOffset = B.CreateCall( |
| 253 | FTy: ResourcePtr->getFunctionType(), Callee: ResourcePtr->getCalledOperand(), |
| 254 | Args: {Handle, NewOffset}, OpBundles); |
| 255 | ResourcePtrAtOffset->setAttributes(ResourcePtr->getAttributes()); |
| 256 | ResourcePtrAtOffset->setCallingConv(ResourcePtr->getCallingConv()); |
| 257 | Type *I8Ty = Type::getInt8Ty(C&: B.getContext()); |
| 258 | GR->buildAssignPtr(B, ElemTy: I8Ty, Arg: ResourcePtrAtOffset); |
| 259 | return ResourcePtrAtOffset; |
| 260 | } |
| 261 | llvm_unreachable( |
| 262 | "byte layout pointer must come from spv.resource.getpointer" ); |
| 263 | } |
| 264 | |
| 265 | Value *scalarToStoreInt(IRBuilder<> &B, Value *Scalar) { |
| 266 | Type *Ty = Scalar->getType(); |
| 267 | const DataLayout &DL = B.getDataLayout(); |
| 268 | Type *IntTy = |
| 269 | IntegerType::get(C&: B.getContext(), NumBits: DL.getTypeStoreSizeInBits(Ty)); |
| 270 | if (Ty == IntTy) |
| 271 | return Scalar; |
| 272 | if (Ty->isIntOrIntVectorTy()) |
| 273 | return B.CreateIntCast(V: Scalar, DestTy: IntTy, /*isSigned=*/false); |
| 274 | return B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, OverloadTypes: {IntTy, Ty}, Args: {Scalar}); |
| 275 | } |
| 276 | |
| 277 | Value *storeIntToScalar(IRBuilder<> &B, Value *IntVal, Type *ScalarTy) { |
| 278 | if (IntVal->getType() == ScalarTy) |
| 279 | return IntVal; |
| 280 | if (ScalarTy->isIntOrIntVectorTy()) |
| 281 | return B.CreateIntCast(V: IntVal, DestTy: ScalarTy, /*isSigned=*/false); |
| 282 | return B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, |
| 283 | OverloadTypes: {ScalarTy, IntVal->getType()}, Args: {IntVal}); |
| 284 | } |
| 285 | |
| 286 | void storeScalarToByteLayout(IRBuilder<> &B, Value *Src, Value *Dst, |
| 287 | Align Alignment) { |
| 288 | LLVMContext &Ctx = B.getContext(); |
| 289 | Type *I8Ty = Type::getInt8Ty(C&: Ctx); |
| 290 | const DataLayout &DL = B.getDataLayout(); |
| 291 | Value *IntVal = scalarToStoreInt(B, Scalar: Src); |
| 292 | if (IntVal != Src) |
| 293 | buildAssignType(B, Ty: IntVal->getType(), Arg: IntVal); |
| 294 | unsigned NumBytes = DL.getTypeStoreSize(Ty: Src->getType()); |
| 295 | |
| 296 | auto StoreByte = [&](unsigned I, Value *Shifted) { |
| 297 | Value *Byte = B.CreateTrunc(V: Shifted, DestTy: I8Ty); |
| 298 | buildAssignType(B, Ty: I8Ty, Arg: Byte); |
| 299 | Value *Ptr = gepByteOffset(B, BasePtr: Dst, ByteOffset: I); |
| 300 | StoreInst *SI = B.CreateStore(Val: Byte, Ptr); |
| 301 | SI->setAlignment(commonAlignment(A: Alignment, Offset: I)); |
| 302 | }; |
| 303 | |
| 304 | if (NumBytes > 0) |
| 305 | StoreByte(0, IntVal); |
| 306 | |
| 307 | for (unsigned I = 1; I < NumBytes; ++I) { |
| 308 | Value *Shifted = |
| 309 | B.CreateLShr(LHS: IntVal, RHS: ConstantInt::get(Ty: IntVal->getType(), V: 8 * I)); |
| 310 | StoreByte(I, Shifted); |
| 311 | } |
| 312 | } |
| 313 | |
| 314 | Value *loadScalarFromByteLayout(IRBuilder<> &B, Type *AccessTy, Value *Src, |
| 315 | Align Alignment) { |
| 316 | LLVMContext &Ctx = B.getContext(); |
| 317 | Type *I8Ty = Type::getInt8Ty(C&: Ctx); |
| 318 | const DataLayout &DL = B.getDataLayout(); |
| 319 | unsigned NumBytes = DL.getTypeStoreSize(Ty: AccessTy); |
| 320 | Type *IntTy = IntegerType::get(C&: Ctx, NumBits: DL.getTypeStoreSizeInBits(Ty: AccessTy)); |
| 321 | Value *IntVal = ConstantInt::get(Ty: IntTy, V: 0); |
| 322 | |
| 323 | for (unsigned I = 0; I < NumBytes; ++I) { |
| 324 | Value *Ptr = gepByteOffset(B, BasePtr: Src, ByteOffset: I); |
| 325 | LoadInst *LI = B.CreateLoad(Ty: I8Ty, Ptr); |
| 326 | LI->setAlignment(commonAlignment(A: Alignment, Offset: I)); |
| 327 | buildAssignType(B, Ty: I8Ty, Arg: LI); |
| 328 | Value *Extended = B.CreateZExt(V: LI, DestTy: IntTy); |
| 329 | buildAssignType(B, Ty: IntTy, Arg: Extended); |
| 330 | |
| 331 | if (I == 0) { |
| 332 | IntVal = Extended; |
| 333 | } else { |
| 334 | Value *Shifted = B.CreateShl(LHS: Extended, RHS: ConstantInt::get(Ty: IntTy, V: 8 * I)); |
| 335 | buildAssignType(B, Ty: IntTy, Arg: Shifted); |
| 336 | IntVal = B.CreateOr(LHS: IntVal, RHS: Shifted); |
| 337 | } |
| 338 | buildAssignType(B, Ty: IntTy, Arg: IntVal); |
| 339 | } |
| 340 | |
| 341 | Value *Result = storeIntToScalar(B, IntVal, ScalarTy: AccessTy); |
| 342 | if (Result != IntVal) |
| 343 | buildAssignType(B, Ty: AccessTy, Arg: Result); |
| 344 | return Result; |
| 345 | } |
| 346 | |
| 347 | // Classifies a ptrcast reinterpretation: casted pointee matches the access |
| 348 | // type but differs from the original storage layout (e.g. i8 byte buffer as |
| 349 | // i32). ByteWise means multi-byte access must use per-byte i8 load/store. |
| 350 | bool shouldReinterpretByteWise(IRBuilder<> &B, Type *AccessTy, |
| 351 | Value *OriginalPtr) { |
| 352 | Type *OriginalElemTy = GR->findDeducedElementType(Val: OriginalPtr); |
| 353 | const DataLayout &DL = B.getDataLayout(); |
| 354 | if (getResourceGetPointer(Ptr: OriginalPtr) && |
| 355 | OriginalElemTy == Type::getInt8Ty(C&: B.getContext()) && |
| 356 | AccessTy->isSingleValueType() && DL.getTypeStoreSize(Ty: AccessTy) > 1) |
| 357 | return true; |
| 358 | |
| 359 | return false; |
| 360 | } |
| 361 | |
| 362 | static bool canReinterpretType(Type *FromTy, Type *ToTy) { |
| 363 | return FromTy && ToTy && CastInst::isBitCastable(SrcTy: FromTy, DestTy: ToTy); |
| 364 | } |
| 365 | |
| 366 | bool tryReinterpretLoad(IRBuilder<> &B, Type *AccessTy, Value *OriginalPtr, |
| 367 | Value *CastedPtr, LoadInst *IllegalLoad) { |
| 368 | Type *CastedElemTy = GR->findDeducedElementType(Val: CastedPtr); |
| 369 | if (!CastedElemTy || CastedElemTy != AccessTy) |
| 370 | return false; |
| 371 | |
| 372 | Align Alignment = IllegalLoad->getAlign(); |
| 373 | if (shouldReinterpretByteWise(B, AccessTy, OriginalPtr)) { |
| 374 | const DataLayout &DL = B.getDataLayout(); |
| 375 | Value *Loaded; |
| 376 | if (auto *VT = dyn_cast<FixedVectorType>(Val: AccessTy)) { |
| 377 | unsigned ElemSize = DL.getTypeStoreSize(Ty: VT->getElementType()); |
| 378 | SmallVector<Value *, 4> LoadedElements; |
| 379 | for (unsigned I = 0; I < VT->getNumElements(); ++I) { |
| 380 | Value *ElemPtr = gepByteOffset(B, BasePtr: OriginalPtr, ByteOffset: I * ElemSize); |
| 381 | LoadedElements.push_back(Elt: loadScalarFromByteLayout( |
| 382 | B, AccessTy: VT->getElementType(), Src: ElemPtr, |
| 383 | Alignment: commonAlignment(A: Alignment, Offset: I * ElemSize))); |
| 384 | } |
| 385 | Loaded = buildVectorFromLoadedElements(B, TargetType: VT, LoadedElements); |
| 386 | } else { |
| 387 | Loaded = loadScalarFromByteLayout(B, AccessTy, Src: OriginalPtr, Alignment); |
| 388 | buildAssignType(B, Ty: AccessTy, Arg: Loaded); |
| 389 | } |
| 390 | GR->replaceAllUsesWith(Old: IllegalLoad, New: Loaded, /* DeleteOld= */ true); |
| 391 | DeadInstructions.push_back(x: IllegalLoad); |
| 392 | return true; |
| 393 | } |
| 394 | |
| 395 | Type *OriginalTy = GR->findDeducedElementType(Val: OriginalPtr); |
| 396 | if (!canReinterpretType(FromTy: OriginalTy, ToTy: AccessTy)) |
| 397 | report_fatal_error( |
| 398 | reason: "Cannot lower a pointer cast without equal-width numeric types for " |
| 399 | "Logical SPIR-V" , |
| 400 | gen_crash_diag: false); |
| 401 | LoadInst *LI = B.CreateLoad(Ty: OriginalTy, Ptr: OriginalPtr); |
| 402 | LI->setAlignment(Alignment); |
| 403 | LI->setVolatile(IllegalLoad->isVolatile()); |
| 404 | LI->setAtomic(Ordering: IllegalLoad->getOrdering(), SSID: IllegalLoad->getSyncScopeID()); |
| 405 | buildAssignType(B, Ty: OriginalTy, Arg: LI); |
| 406 | Value *Loaded = |
| 407 | B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, OverloadTypes: {AccessTy, OriginalTy}, Args: {LI}); |
| 408 | buildAssignType(B, Ty: AccessTy, Arg: Loaded); |
| 409 | GR->replaceAllUsesWith(Old: IllegalLoad, New: Loaded, /* DeleteOld= */ true); |
| 410 | DeadInstructions.push_back(x: IllegalLoad); |
| 411 | return true; |
| 412 | } |
| 413 | |
| 414 | bool tryReinterpretStore(IRBuilder<> &B, Type *AccessTy, Value *OriginalPtr, |
| 415 | Value *CastedPtr, Value *StoreSrc, Align Alignment, |
| 416 | Instruction *IllegalStore) { |
| 417 | Type *CastedElemTy = GR->findDeducedElementType(Val: CastedPtr); |
| 418 | if (!CastedElemTy || CastedElemTy != AccessTy) |
| 419 | return false; |
| 420 | |
| 421 | if (shouldReinterpretByteWise(B, AccessTy, OriginalPtr)) { |
| 422 | const DataLayout &DL = B.getDataLayout(); |
| 423 | if (auto *VT = dyn_cast<FixedVectorType>(Val: StoreSrc->getType())) { |
| 424 | unsigned ElemSize = DL.getTypeStoreSize(Ty: VT->getElementType()); |
| 425 | for (unsigned I = 0; I < VT->getNumElements(); ++I) { |
| 426 | Value *Elem = extractScalarFromVector(B, Vector: StoreSrc, Index: I); |
| 427 | Value *ElemPtr = gepByteOffset(B, BasePtr: OriginalPtr, ByteOffset: I * ElemSize); |
| 428 | storeScalarToByteLayout(B, Src: Elem, Dst: ElemPtr, |
| 429 | Alignment: commonAlignment(A: Alignment, Offset: I * ElemSize)); |
| 430 | } |
| 431 | } else { |
| 432 | storeScalarToByteLayout(B, Src: StoreSrc, Dst: OriginalPtr, Alignment); |
| 433 | } |
| 434 | return true; |
| 435 | } |
| 436 | |
| 437 | Type *OriginalTy = GR->findDeducedElementType(Val: OriginalPtr); |
| 438 | if (!canReinterpretType(FromTy: AccessTy, ToTy: OriginalTy)) |
| 439 | report_fatal_error( |
| 440 | reason: "Cannot lower a pointer cast without equal-width numeric types for " |
| 441 | "Logical SPIR-V" , |
| 442 | gen_crash_diag: false); |
| 443 | Value *Stored = B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, |
| 444 | OverloadTypes: {OriginalTy, AccessTy}, Args: {StoreSrc}); |
| 445 | buildAssignType(B, Ty: OriginalTy, Arg: Stored); |
| 446 | StoreInst *SI = B.CreateStore(Val: Stored, Ptr: OriginalPtr); |
| 447 | SI->setAlignment(Alignment); |
| 448 | if (auto *OldSI = dyn_cast<StoreInst>(Val: IllegalStore)) { |
| 449 | SI->setVolatile(OldSI->isVolatile()); |
| 450 | SI->setAtomic(Ordering: OldSI->getOrdering(), SSID: OldSI->getSyncScopeID()); |
| 451 | } |
| 452 | return true; |
| 453 | } |
| 454 | |
| 455 | // Builds a legalized load from a pointer, drilling down through |
| 456 | // memory layouts to find a compatible type. Load flags will be |
| 457 | // copied from |IllegalLoad|, which should be the load being legalized. |
| 458 | Value *buildLegalizedLoad(IRBuilder<> &B, Type *ElementType, Value *Source, |
| 459 | LoadInst *IllegalLoad, Value *CastedPtr) { |
| 460 | auto ResultOpt = getPointerToFirstCompatibleType( |
| 461 | B, BasePtr: Source, PointerType: IllegalLoad->getPointerOperandType(), TargetElemType: ElementType, IsInBounds: false); |
| 462 | if (!ResultOpt) { |
| 463 | if (tryReinterpretLoad(B, AccessTy: ElementType, OriginalPtr: Source, CastedPtr, IllegalLoad)) |
| 464 | return nullptr; |
| 465 | llvm_unreachable("Failed to load from aggregate: " |
| 466 | "Could not find compatible memory layout." ); |
| 467 | } |
| 468 | auto [GEP, CurrentTy] = *ResultOpt; |
| 469 | |
| 470 | auto *SAT = dyn_cast<ArrayType>(Val: CurrentTy); |
| 471 | auto *SVT = dyn_cast<FixedVectorType>(Val: CurrentTy); |
| 472 | auto *DVT = dyn_cast<FixedVectorType>(Val: ElementType); |
| 473 | auto *MAT = |
| 474 | SAT ? dyn_cast<FixedVectorType>(Val: SAT->getElementType()) : nullptr; |
| 475 | |
| 476 | if (ElementType == CurrentTy) { |
| 477 | LoadInst *LI = B.CreateLoad(Ty: ElementType, Ptr: GEP); |
| 478 | LI->setAlignment(IllegalLoad->getAlign()); |
| 479 | buildAssignType(B, Ty: ElementType, Arg: LI); |
| 480 | return LI; |
| 481 | } |
| 482 | if (SVT && !DVT) { |
| 483 | LoadInst *LI = B.CreateLoad(Ty: CurrentTy, Ptr: GEP); |
| 484 | LI->setAlignment(IllegalLoad->getAlign()); |
| 485 | buildAssignType(B, Ty: CurrentTy, Arg: LI); |
| 486 | Value *Result = B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, |
| 487 | OverloadTypes: {ElementType, CurrentTy}, Args: {LI}); |
| 488 | buildAssignType(B, Ty: ElementType, Arg: Result); |
| 489 | return Result; |
| 490 | } |
| 491 | if (SVT && DVT) |
| 492 | return loadVectorFromVector(B, SourceType: SVT, TargetType: DVT, Source: GEP, OriginalAlign: IllegalLoad->getAlign()); |
| 493 | if (SAT && DVT && SAT->getElementType() == DVT->getElementType()) |
| 494 | return loadVectorFromArray(B, TargetType: DVT, Source: GEP, OriginalAlign: IllegalLoad->getAlign()); |
| 495 | if (MAT && DVT && MAT->getElementType() == DVT->getElementType()) |
| 496 | return loadVectorFromMatrixArray(B, TargetType: DVT, Source: GEP, ArrElemVecTy: MAT, |
| 497 | OriginalAlign: IllegalLoad->getAlign()); |
| 498 | |
| 499 | llvm_unreachable("Failed to load from aggregate." ); |
| 500 | } |
| 501 | |
| 502 | Value * |
| 503 | buildVectorFromLoadedElements(IRBuilder<> &B, FixedVectorType *TargetType, |
| 504 | SmallVector<Value *, 4> &LoadedElements) { |
| 505 | // <1 x T> shares the SPIR-V type with T, so emitting OpCompositeInsert on |
| 506 | // a scalar would be invalid. Bridge with spv_bitcast instead unless |
| 507 | // SPV_EXT_long_vector is available. |
| 508 | bool CanUseAnyVectorRank = TM.getSubtargetImpl()->canUseExtension( |
| 509 | E: SPIRV::Extension::SPV_EXT_long_vector); |
| 510 | if (TargetType->getNumElements() == 1 && !CanUseAnyVectorRank) { |
| 511 | Value *Scalar = LoadedElements[0]; |
| 512 | Value *NewVector = B.CreateIntrinsic( |
| 513 | ID: Intrinsic::spv_bitcast, OverloadTypes: {TargetType, Scalar->getType()}, Args: {Scalar}); |
| 514 | buildAssignType(B, Ty: TargetType, Arg: NewVector); |
| 515 | return NewVector; |
| 516 | } |
| 517 | |
| 518 | // Build the vector from the loaded elements. |
| 519 | Value *NewVector = PoisonValue::get(T: TargetType); |
| 520 | buildAssignType(B, Ty: TargetType, Arg: NewVector); |
| 521 | |
| 522 | for (unsigned I = 0, E = TargetType->getNumElements(); I < E; ++I) { |
| 523 | Value *Index = B.getInt32(C: I); |
| 524 | SmallVector<Type *, 4> Types = {TargetType, TargetType, |
| 525 | TargetType->getElementType(), |
| 526 | Index->getType()}; |
| 527 | SmallVector<Value *> Args = {NewVector, LoadedElements[I], Index}; |
| 528 | NewVector = B.CreateIntrinsic(ID: Intrinsic::spv_insertelt, OverloadTypes: {Types}, Args: {Args}); |
| 529 | buildAssignType(B, Ty: TargetType, Arg: NewVector); |
| 530 | } |
| 531 | return NewVector; |
| 532 | } |
| 533 | |
| 534 | // Loads elements from a matrix with an array of vector memory layout and |
| 535 | // constructs a vector. |
| 536 | Value *loadVectorFromMatrixArray(IRBuilder<> &B, FixedVectorType *TargetType, |
| 537 | Value *Source, FixedVectorType *ArrElemVecTy, |
| 538 | Align OriginalAlign) { |
| 539 | Type *TargetElemTy = TargetType->getElementType(); |
| 540 | unsigned ScalarsPerArrayElement = ArrElemVecTy->getNumElements(); |
| 541 | const DataLayout &DL = B.getDataLayout(); |
| 542 | uint64_t ArrElemVecSize = DL.getTypeAllocSize(Ty: ArrElemVecTy); |
| 543 | // Load each element of the array. |
| 544 | SmallVector<Value *, 4> LoadedElements; |
| 545 | std::array<Type *, 2> Types = {Source->getType(), Source->getType()}; |
| 546 | for (unsigned I = 0, E = TargetType->getNumElements(); I < E; ++I) { |
| 547 | unsigned ArrayIndex = I / ScalarsPerArrayElement; |
| 548 | unsigned ElementIndexInArrayElem = I % ScalarsPerArrayElement; |
| 549 | // Create a GEP to access the i-th element of the array. |
| 550 | std::array<Value *, 4> Args = { |
| 551 | B.getInt1(/*Inbounds=*/V: false), Source, B.getInt32(C: 0), |
| 552 | ConstantInt::get(Ty: B.getInt32Ty(), V: ArrayIndex)}; |
| 553 | auto *ElementPtr = B.CreateIntrinsic(ID: Intrinsic::spv_gep, OverloadTypes: {Types}, Args: {Args}); |
| 554 | GR->buildAssignPtr(B, ElemTy: ArrElemVecTy, Arg: ElementPtr); |
| 555 | LoadInst *LoadVec = B.CreateLoad(Ty: ArrElemVecTy, Ptr: ElementPtr); |
| 556 | LoadVec->setAlignment( |
| 557 | commonAlignment(A: OriginalAlign, Offset: ArrayIndex * ArrElemVecSize)); |
| 558 | buildAssignType(B, Ty: ArrElemVecTy, Arg: LoadVec); |
| 559 | LoadedElements.push_back(Elt: makeExtractElement(B, ElementType: TargetElemTy, Vector: LoadVec, |
| 560 | Index: ElementIndexInArrayElem)); |
| 561 | } |
| 562 | return buildVectorFromLoadedElements(B, TargetType, LoadedElements); |
| 563 | } |
| 564 | |
| 565 | // Loads elements from an array and constructs a vector. |
| 566 | Value *loadVectorFromArray(IRBuilder<> &B, FixedVectorType *TargetType, |
| 567 | Value *Source, Align OriginalAlign) { |
| 568 | // Load each element of the array. |
| 569 | SmallVector<Value *, 4> LoadedElements; |
| 570 | std::array<Type *, 2> Types = {Source->getType(), Source->getType()}; |
| 571 | const DataLayout &DL = B.getDataLayout(); |
| 572 | uint64_t ElemSize = DL.getTypeAllocSize(Ty: TargetType->getElementType()); |
| 573 | for (unsigned I = 0, E = TargetType->getNumElements(); I < E; ++I) { |
| 574 | // Create a GEP to access the i-th element of the array. |
| 575 | std::array<Value *, 4> Args = {B.getInt1(/*Inbounds=*/V: false), Source, |
| 576 | B.getInt32(C: 0), |
| 577 | ConstantInt::get(Ty: B.getInt32Ty(), V: I)}; |
| 578 | auto *ElementPtr = B.CreateIntrinsic(ID: Intrinsic::spv_gep, OverloadTypes: {Types}, Args: {Args}); |
| 579 | GR->buildAssignPtr(B, ElemTy: TargetType->getElementType(), Arg: ElementPtr); |
| 580 | |
| 581 | // Load the value from the element pointer. |
| 582 | LoadInst *Load = B.CreateLoad(Ty: TargetType->getElementType(), Ptr: ElementPtr); |
| 583 | Load->setAlignment(commonAlignment(A: OriginalAlign, Offset: I * ElemSize)); |
| 584 | buildAssignType(B, Ty: TargetType->getElementType(), Arg: Load); |
| 585 | LoadedElements.push_back(Elt: Load); |
| 586 | } |
| 587 | return buildVectorFromLoadedElements(B, TargetType, LoadedElements); |
| 588 | } |
| 589 | |
| 590 | // Stores elements from a vector into a matrix (an array of vectors). |
| 591 | void storeMatrixArrayFromVector(IRBuilder<> &B, Value *SrcVector, |
| 592 | Value *DstArrayPtr, ArrayType *ArrTy, |
| 593 | Align Alignment) { |
| 594 | auto *SrcVecTy = cast<FixedVectorType>(Val: SrcVector->getType()); |
| 595 | auto *ArrElemVecTy = cast<FixedVectorType>(Val: ArrTy->getElementType()); |
| 596 | Type *ElemTy = ArrElemVecTy->getElementType(); |
| 597 | unsigned ScalarsPerArrayElement = ArrElemVecTy->getNumElements(); |
| 598 | unsigned SrcNumElements = SrcVecTy->getNumElements(); |
| 599 | assert( |
| 600 | SrcNumElements % ScalarsPerArrayElement == 0 && |
| 601 | "Source vector size must be a multiple of array element vector size" ); |
| 602 | |
| 603 | std::array<Type *, 2> Types = {DstArrayPtr->getType(), |
| 604 | DstArrayPtr->getType()}; |
| 605 | const DataLayout &DL = B.getDataLayout(); |
| 606 | uint64_t ArrElemVecSize = DL.getTypeAllocSize(Ty: ArrElemVecTy); |
| 607 | |
| 608 | for (unsigned I = 0; I < SrcNumElements; I += ScalarsPerArrayElement) { |
| 609 | unsigned ArrayIndex = I / ScalarsPerArrayElement; |
| 610 | // Create a GEP to access the array element. |
| 611 | std::array<Value *, 4> Args = { |
| 612 | B.getInt1(/*Inbounds=*/V: false), DstArrayPtr, B.getInt32(C: 0), |
| 613 | ConstantInt::get(Ty: B.getInt32Ty(), V: ArrayIndex)}; |
| 614 | auto *ElementPtr = B.CreateIntrinsic(ID: Intrinsic::spv_gep, OverloadTypes: {Types}, Args: {Args}); |
| 615 | GR->buildAssignPtr(B, ElemTy: ArrElemVecTy, Arg: ElementPtr); |
| 616 | |
| 617 | // Extract scalar elements from the source vector for this array slot. |
| 618 | SmallVector<Value *, 4> Elements; |
| 619 | for (unsigned J = 0; J < ScalarsPerArrayElement; ++J) |
| 620 | Elements.push_back(Elt: makeExtractElement(B, ElementType: ElemTy, Vector: SrcVector, Index: I + J)); |
| 621 | |
| 622 | // Build a vector from the extracted elements and store it. |
| 623 | Value *Vec = buildVectorFromLoadedElements(B, TargetType: ArrElemVecTy, LoadedElements&: Elements); |
| 624 | StoreInst *SI = B.CreateStore(Val: Vec, Ptr: ElementPtr); |
| 625 | SI->setAlignment(commonAlignment(A: Alignment, Offset: ArrayIndex * ArrElemVecSize)); |
| 626 | } |
| 627 | } |
| 628 | |
| 629 | // Stores elements from a vector into an array. |
| 630 | void storeArrayFromVector(IRBuilder<> &B, Value *SrcVector, |
| 631 | Value *DstArrayPtr, ArrayType *ArrTy, |
| 632 | Align Alignment) { |
| 633 | auto *VecTy = cast<FixedVectorType>(Val: SrcVector->getType()); |
| 634 | Type *ElemTy = ArrTy->getElementType(); |
| 635 | |
| 636 | // Ensure the element types of the array and vector are the same. |
| 637 | assert(VecTy->getElementType() == ElemTy && |
| 638 | "Element types of array and vector must be the same." ); |
| 639 | std::array<Type *, 2> Types = {DstArrayPtr->getType(), |
| 640 | DstArrayPtr->getType()}; |
| 641 | const DataLayout &DL = B.getDataLayout(); |
| 642 | uint64_t ElemSize = DL.getTypeAllocSize(Ty: ElemTy); |
| 643 | |
| 644 | for (unsigned I = 0, E = VecTy->getNumElements(); I < E; ++I) { |
| 645 | // Create a GEP to access the i-th element of the array. |
| 646 | std::array<Value *, 4> Args = {B.getInt1(/*Inbounds=*/V: false), DstArrayPtr, |
| 647 | B.getInt32(C: 0), |
| 648 | ConstantInt::get(Ty: B.getInt32Ty(), V: I)}; |
| 649 | auto *ElementPtr = B.CreateIntrinsic(ID: Intrinsic::spv_gep, OverloadTypes: {Types}, Args: {Args}); |
| 650 | GR->buildAssignPtr(B, ElemTy, Arg: ElementPtr); |
| 651 | |
| 652 | // Extract the element from the vector and store it. |
| 653 | bool CanUseAnyVectorRank = TM.getSubtargetImpl()->canUseExtension( |
| 654 | E: SPIRV::Extension::SPV_EXT_long_vector); |
| 655 | Value *Element = (E == 1 && !CanUseAnyVectorRank) |
| 656 | ? SrcVector |
| 657 | : makeExtractElement(B, ElementType: ElemTy, Vector: SrcVector, Index: I); |
| 658 | StoreInst *SI = B.CreateStore(Val: Element, Ptr: ElementPtr); |
| 659 | SI->setAlignment(commonAlignment(A: Alignment, Offset: I * ElemSize)); |
| 660 | } |
| 661 | } |
| 662 | |
| 663 | // Replaces the load instruction to get rid of the ptrcast used as source |
| 664 | // operand. |
| 665 | void transformLoad(IRBuilder<> &B, LoadInst *LI, Value *CastedOperand, |
| 666 | Value *OriginalOperand) { |
| 667 | Type *ToTy = GR->findDeducedElementType(Val: CastedOperand); |
| 668 | B.SetInsertPoint(LI); |
| 669 | |
| 670 | Value *Output = |
| 671 | buildLegalizedLoad(B, ElementType: ToTy, Source: OriginalOperand, IllegalLoad: LI, CastedPtr: CastedOperand); |
| 672 | if (!Output) |
| 673 | return; |
| 674 | |
| 675 | GR->replaceAllUsesWith(Old: LI, New: Output, /* DeleteOld= */ true); |
| 676 | DeadInstructions.push_back(x: LI); |
| 677 | } |
| 678 | |
| 679 | // Creates an spv_insertelt instruction (equivalent to llvm's insertelement). |
| 680 | Value *makeInsertElement(IRBuilder<> &B, Value *Vector, Value *Element, |
| 681 | unsigned Index) { |
| 682 | Type *Int32Ty = Type::getInt32Ty(C&: B.getContext()); |
| 683 | SmallVector<Type *, 4> Types = {Vector->getType(), Vector->getType(), |
| 684 | Element->getType(), Int32Ty}; |
| 685 | SmallVector<Value *> Args = {Vector, Element, B.getInt32(C: Index)}; |
| 686 | Value *NewI = B.CreateIntrinsic(ID: Intrinsic::spv_insertelt, OverloadTypes: {Types}, Args: {Args}); |
| 687 | buildAssignType(B, Ty: Vector->getType(), Arg: NewI); |
| 688 | return NewI; |
| 689 | } |
| 690 | |
| 691 | // Creates an spv_extractelt instruction (equivalent to llvm's |
| 692 | // extractelement). |
| 693 | Value *(IRBuilder<> &B, Type *ElementType, Value *Vector, |
| 694 | unsigned Index) { |
| 695 | Type *Int32Ty = Type::getInt32Ty(C&: B.getContext()); |
| 696 | SmallVector<Type *, 3> Types = {ElementType, Vector->getType(), Int32Ty}; |
| 697 | SmallVector<Value *> Args = {Vector, B.getInt32(C: Index)}; |
| 698 | Value *NewI = B.CreateIntrinsic(ID: Intrinsic::spv_extractelt, OverloadTypes: {Types}, Args: {Args}); |
| 699 | buildAssignType(B, Ty: ElementType, Arg: NewI); |
| 700 | return NewI; |
| 701 | } |
| 702 | |
| 703 | // Extracts scalar element |Index| from |Vector|. A <1 x T> vector shares its |
| 704 | // SPIR-V type with the scalar T, so a plain extractelement would be invalid; |
| 705 | // bridge it with spv_bitcast instead. |
| 706 | Value *(IRBuilder<> &B, Value *Vector, |
| 707 | unsigned Index) { |
| 708 | auto *VecTy = cast<FixedVectorType>(Val: Vector->getType()); |
| 709 | Type *ElemTy = VecTy->getElementType(); |
| 710 | if (VecTy->getNumElements() == 1) { |
| 711 | Value *Scalar = |
| 712 | B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, OverloadTypes: {ElemTy, VecTy}, Args: {Vector}); |
| 713 | buildAssignType(B, Ty: ElemTy, Arg: Scalar); |
| 714 | return Scalar; |
| 715 | } |
| 716 | return makeExtractElement(B, ElementType: ElemTy, Vector, Index); |
| 717 | } |
| 718 | |
| 719 | // Stores the given Src vector operand into the Dst vector, adjusting the size |
| 720 | // if required. |
| 721 | Value *storeVectorFromVector(IRBuilder<> &B, Value *Src, Value *Dst, |
| 722 | Align Alignment) { |
| 723 | FixedVectorType *SrcType = cast<FixedVectorType>(Val: Src->getType()); |
| 724 | FixedVectorType *DstType = |
| 725 | cast<FixedVectorType>(Val: GR->findDeducedElementType(Val: Dst)); |
| 726 | auto dstNumElements = DstType->getNumElements(); |
| 727 | auto srcNumElements = SrcType->getNumElements(); |
| 728 | |
| 729 | // if the element type differs, it is a bitcast. |
| 730 | if (DstType->getElementType() != SrcType->getElementType()) { |
| 731 | // Support bitcast between vectors of different sizes only if |
| 732 | // the total bitwidth is the same. |
| 733 | [[maybe_unused]] auto dstBitWidth = |
| 734 | DstType->getElementType()->getScalarSizeInBits() * dstNumElements; |
| 735 | [[maybe_unused]] auto srcBitWidth = |
| 736 | SrcType->getElementType()->getScalarSizeInBits() * srcNumElements; |
| 737 | assert(dstBitWidth == srcBitWidth && |
| 738 | "Unsupported bitcast between vectors of different sizes." ); |
| 739 | |
| 740 | Src = |
| 741 | B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, OverloadTypes: {DstType, SrcType}, Args: {Src}); |
| 742 | buildAssignType(B, Ty: DstType, Arg: Src); |
| 743 | |
| 744 | StoreInst *SI = B.CreateStore(Val: Src, Ptr: Dst); |
| 745 | SI->setAlignment(Alignment); |
| 746 | return SI; |
| 747 | } |
| 748 | |
| 749 | assert(DstType->getNumElements() >= SrcType->getNumElements()); |
| 750 | LoadInst *LI = B.CreateLoad(Ty: DstType, Ptr: Dst); |
| 751 | LI->setAlignment(Alignment); |
| 752 | Value *OldValues = LI; |
| 753 | buildAssignType(B, Ty: OldValues->getType(), Arg: OldValues); |
| 754 | |
| 755 | for (unsigned I = 0; I < SrcType->getNumElements(); ++I) { |
| 756 | Value *Element = extractScalarFromVector(B, Vector: Src, Index: I); |
| 757 | OldValues = makeInsertElement(B, Vector: OldValues, Element, Index: I); |
| 758 | } |
| 759 | |
| 760 | StoreInst *SI = B.CreateStore(Val: OldValues, Ptr: Dst); |
| 761 | SI->setAlignment(Alignment); |
| 762 | return SI; |
| 763 | } |
| 764 | |
| 765 | // Builds a legalized store to a pointer, drilling down through |
| 766 | // memory layouts to find a compatible type. |
| 767 | void buildLegalizedStore(IRBuilder<> &B, Value *Src, Value *Dst, |
| 768 | Align Alignment, Value *CastedPtr, |
| 769 | Instruction *IllegalStore) { |
| 770 | auto ResultOpt = getPointerToFirstCompatibleType(B, BasePtr: Dst, PointerType: Dst->getType(), |
| 771 | TargetElemType: Src->getType(), IsInBounds: true); |
| 772 | if (!ResultOpt) { |
| 773 | if (tryReinterpretStore(B, AccessTy: Src->getType(), OriginalPtr: Dst, CastedPtr, StoreSrc: Src, Alignment, |
| 774 | IllegalStore)) |
| 775 | return; |
| 776 | llvm_unreachable("Failed to store to aggregate: " |
| 777 | "Could not find compatible memory layout." ); |
| 778 | } |
| 779 | auto [GEP, CurrentTy] = *ResultOpt; |
| 780 | |
| 781 | auto *DAT = dyn_cast<ArrayType>(Val: CurrentTy); |
| 782 | auto *DVT = dyn_cast<FixedVectorType>(Val: CurrentTy); |
| 783 | auto *SVT = dyn_cast<FixedVectorType>(Val: Src->getType()); |
| 784 | auto *DMAT = |
| 785 | DAT ? dyn_cast<FixedVectorType>(Val: DAT->getElementType()) : nullptr; |
| 786 | |
| 787 | if (Src->getType() == CurrentTy) { |
| 788 | StoreInst *SI = B.CreateStore(Val: Src, Ptr: GEP); |
| 789 | SI->setAlignment(Alignment); |
| 790 | return; |
| 791 | } |
| 792 | if (DVT && !SVT) { |
| 793 | Value *Result = B.CreateIntrinsic(ID: Intrinsic::spv_bitcast, |
| 794 | OverloadTypes: {CurrentTy, Src->getType()}, Args: {Src}); |
| 795 | buildAssignType(B, Ty: CurrentTy, Arg: Result); |
| 796 | StoreInst *SI = B.CreateStore(Val: Result, Ptr: GEP); |
| 797 | SI->setAlignment(Alignment); |
| 798 | return; |
| 799 | } |
| 800 | if (DVT && SVT) { |
| 801 | storeVectorFromVector(B, Src, Dst: GEP, Alignment); |
| 802 | return; |
| 803 | } |
| 804 | if (DAT && SVT && SVT->getElementType() == DAT->getElementType()) { |
| 805 | storeArrayFromVector(B, SrcVector: Src, DstArrayPtr: GEP, ArrTy: DAT, Alignment); |
| 806 | return; |
| 807 | } |
| 808 | if (DMAT && SVT && DMAT->getElementType() == SVT->getElementType()) { |
| 809 | storeMatrixArrayFromVector(B, SrcVector: Src, DstArrayPtr: GEP, ArrTy: DAT, Alignment); |
| 810 | return; |
| 811 | } |
| 812 | |
| 813 | llvm_unreachable("Failed to store to aggregate." ); |
| 814 | } |
| 815 | |
| 816 | // Transforms a store instruction (or SPV intrinsic) using a ptrcast as |
| 817 | // operand into a valid logical SPIR-V store with no ptrcast. |
| 818 | void transformStore(IRBuilder<> &B, Instruction *IllegalStore, Value *Src, |
| 819 | Value *Dst, Value *CastedOperand, Align Alignment) { |
| 820 | B.SetInsertPoint(IllegalStore); |
| 821 | buildLegalizedStore(B, Src, Dst, Alignment, CastedPtr: CastedOperand, IllegalStore); |
| 822 | DeadInstructions.push_back(x: IllegalStore); |
| 823 | } |
| 824 | |
| 825 | void legalizePointerCast(IntrinsicInst *II) { |
| 826 | Value *CastedOperand = II; |
| 827 | Value *OriginalOperand = II->getOperand(i_nocapture: 0); |
| 828 | |
| 829 | IRBuilder<> B(*II->getModule()); |
| 830 | std::vector<Value *> Users; |
| 831 | for (Use &U : II->uses()) |
| 832 | Users.push_back(x: U.getUser()); |
| 833 | |
| 834 | for (Value *User : Users) { |
| 835 | if (LoadInst *LI = dyn_cast<LoadInst>(Val: User)) { |
| 836 | transformLoad(B, LI, CastedOperand, OriginalOperand); |
| 837 | continue; |
| 838 | } |
| 839 | |
| 840 | if (StoreInst *SI = dyn_cast<StoreInst>(Val: User)) { |
| 841 | transformStore(B, IllegalStore: SI, Src: SI->getValueOperand(), Dst: OriginalOperand, |
| 842 | CastedOperand, Alignment: SI->getAlign()); |
| 843 | continue; |
| 844 | } |
| 845 | |
| 846 | if (IntrinsicInst *Intrin = dyn_cast<IntrinsicInst>(Val: User)) { |
| 847 | if (Intrin->getIntrinsicID() == Intrinsic::spv_assign_ptr_type) { |
| 848 | DeadInstructions.push_back(x: Intrin); |
| 849 | continue; |
| 850 | } |
| 851 | |
| 852 | if (Intrin->getIntrinsicID() == Intrinsic::spv_gep) { |
| 853 | GR->replaceAllUsesWith(Old: CastedOperand, New: OriginalOperand, |
| 854 | /* DeleteOld= */ false); |
| 855 | continue; |
| 856 | } |
| 857 | |
| 858 | if (Intrin->getIntrinsicID() == Intrinsic::spv_store) { |
| 859 | Align Alignment; |
| 860 | if (ConstantInt *C = dyn_cast<ConstantInt>(Val: Intrin->getOperand(i_nocapture: 3))) |
| 861 | Alignment = Align(C->getZExtValue()); |
| 862 | transformStore(B, IllegalStore: Intrin, Src: Intrin->getArgOperand(i: 0), Dst: OriginalOperand, |
| 863 | CastedOperand, Alignment); |
| 864 | continue; |
| 865 | } |
| 866 | } |
| 867 | |
| 868 | llvm_unreachable("Unsupported ptrcast user. Please fix." ); |
| 869 | } |
| 870 | |
| 871 | DeadInstructions.push_back(x: II); |
| 872 | } |
| 873 | |
| 874 | public: |
| 875 | SPIRVLegalizePointerCastImpl(const SPIRVTargetMachine &TM) : TM(TM) {} |
| 876 | |
| 877 | bool run(Function &F) { |
| 878 | const SPIRVSubtarget &ST = TM.getSubtarget<SPIRVSubtarget>(F); |
| 879 | GR = ST.getSPIRVGlobalRegistry(); |
| 880 | DeadInstructions.clear(); |
| 881 | |
| 882 | std::vector<IntrinsicInst *> WorkList; |
| 883 | for (auto &BB : F) { |
| 884 | for (auto &I : BB) { |
| 885 | auto *II = dyn_cast<IntrinsicInst>(Val: &I); |
| 886 | if (II && II->getIntrinsicID() == Intrinsic::spv_ptrcast) |
| 887 | WorkList.push_back(x: II); |
| 888 | } |
| 889 | } |
| 890 | |
| 891 | for (IntrinsicInst *II : WorkList) |
| 892 | legalizePointerCast(II); |
| 893 | |
| 894 | for (Instruction *I : DeadInstructions) |
| 895 | I->eraseFromParent(); |
| 896 | |
| 897 | return DeadInstructions.size() != 0; |
| 898 | } |
| 899 | |
| 900 | private: |
| 901 | const SPIRVTargetMachine &TM; |
| 902 | SPIRVGlobalRegistry *GR = nullptr; |
| 903 | std::vector<Instruction *> DeadInstructions; |
| 904 | }; |
| 905 | |
| 906 | class SPIRVLegalizePointerCastLegacy : public FunctionPass { |
| 907 | public: |
| 908 | static char ID; |
| 909 | SPIRVLegalizePointerCastLegacy(const SPIRVTargetMachine &TM) |
| 910 | : FunctionPass(ID), TM(TM) {} |
| 911 | |
| 912 | bool runOnFunction(Function &F) override { |
| 913 | return SPIRVLegalizePointerCastImpl(TM).run(F); |
| 914 | } |
| 915 | |
| 916 | private: |
| 917 | const SPIRVTargetMachine &TM; |
| 918 | }; |
| 919 | } // namespace |
| 920 | |
| 921 | PreservedAnalyses |
| 922 | SPIRVLegalizePointerCastPass::run(Function &F, FunctionAnalysisManager &AM) { |
| 923 | return SPIRVLegalizePointerCastImpl(TM).run(F) ? PreservedAnalyses::none() |
| 924 | : PreservedAnalyses::all(); |
| 925 | } |
| 926 | |
| 927 | char SPIRVLegalizePointerCastLegacy::ID = 0; |
| 928 | INITIALIZE_PASS(SPIRVLegalizePointerCastLegacy, "spirv-legalize-pointer-cast" , |
| 929 | "SPIRV legalize pointer cast pass" , false, false) |
| 930 | |
| 931 | FunctionPass *llvm::createSPIRVLegalizePointerCastPass(SPIRVTargetMachine *TM) { |
| 932 | return new SPIRVLegalizePointerCastLegacy(*TM); |
| 933 | } |
| 934 | |