contrib/llvm/lib/Target/AMDGPU/AMDGPUPromoteAlloca.cpp

   1 //===-- AMDGPUPromoteAlloca.cpp - Promote Allocas -------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass eliminates allocas by either converting them into vectors or
  11 // by migrating them to local address space.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "AMDGPU.h"
  16 #include "AMDGPUSubtarget.h"
  17 #include "Utils/AMDGPUBaseInfo.h"
  18 #include "llvm/ADT/APInt.h"
  19 #include "llvm/ADT/None.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 #include "llvm/ADT/StringRef.h"
  22 #include "llvm/ADT/Triple.h"
  23 #include "llvm/ADT/Twine.h"
  24 #include "llvm/Analysis/CaptureTracking.h"
  25 #include "llvm/Analysis/ValueTracking.h"
  26 #include "llvm/CodeGen/TargetPassConfig.h"
  27 #include "llvm/IR/Attributes.h"
  28 #include "llvm/IR/BasicBlock.h"
  29 #include "llvm/IR/Constant.h"
  30 #include "llvm/IR/Constants.h"
  31 #include "llvm/IR/DataLayout.h"
  32 #include "llvm/IR/DerivedTypes.h"
  33 #include "llvm/IR/Function.h"
  34 #include "llvm/IR/GlobalValue.h"
  35 #include "llvm/IR/GlobalVariable.h"
  36 #include "llvm/IR/IRBuilder.h"
  37 #include "llvm/IR/Instruction.h"
  38 #include "llvm/IR/Instructions.h"
  39 #include "llvm/IR/IntrinsicInst.h"
  40 #include "llvm/IR/Intrinsics.h"
  41 #include "llvm/IR/LLVMContext.h"
  42 #include "llvm/IR/Metadata.h"
  43 #include "llvm/IR/Module.h"
  44 #include "llvm/IR/Type.h"
  45 #include "llvm/IR/User.h"
  46 #include "llvm/IR/Value.h"
  47 #include "llvm/Pass.h"
  48 #include "llvm/Support/Casting.h"
  49 #include "llvm/Support/Debug.h"
  50 #include "llvm/Support/ErrorHandling.h"
  51 #include "llvm/Support/MathExtras.h"
  52 #include "llvm/Support/raw_ostream.h"
  53 #include "llvm/Target/TargetMachine.h"
  54 #include <algorithm>
  55 #include <cassert>
  56 #include <cstdint>
  57 #include <map>
  58 #include <tuple>
  59 #include <utility>
  60 #include <vector>
  61
  62 #define DEBUG_TYPE "amdgpu-promote-alloca"
  63
  64 using namespace llvm;
  65
  66 namespace {
  67
  68 // FIXME: This can create globals so should be a module pass.
  69 class AMDGPUPromoteAlloca : public FunctionPass {
  70 private:
  71   const TargetMachine *TM;
  72   Module *Mod = nullptr;
  73   const DataLayout *DL = nullptr;
  74   AMDGPUAS AS;
  75
  76   // FIXME: This should be per-kernel.
  77   uint32_t LocalMemLimit = 0;
  78   uint32_t CurrentLocalMemUsage = 0;
  79
  80   bool IsAMDGCN = false;
  81   bool IsAMDHSA = false;
  82
  83   std::pair<Value *, Value *> getLocalSizeYZ(IRBuilder<> &Builder);
  84   Value *getWorkitemID(IRBuilder<> &Builder, unsigned N);
  85
  86   /// BaseAlloca is the alloca root the search started from.
  87   /// Val may be that alloca or a recursive user of it.
  88   bool collectUsesWithPtrTypes(Value *BaseAlloca,
  89                                Value *Val,
  90                                std::vector<Value*> &WorkList) const;
  91
  92   /// Val is a derived pointer from Alloca. OpIdx0/OpIdx1 are the operand
  93   /// indices to an instruction with 2 pointer inputs (e.g. select, icmp).
  94   /// Returns true if both operands are derived from the same alloca. Val should
  95   /// be the same value as one of the input operands of UseInst.
  96   bool binaryOpIsDerivedFromSameAlloca(Value *Alloca, Value *Val,
  97                                        Instruction *UseInst,
  98                                        int OpIdx0, int OpIdx1) const;
  99
 100   /// Check whether we have enough local memory for promotion.
 101   bool hasSufficientLocalMem(const Function &F);
 102
 103 public:
 104   static char ID;
 105
 106   AMDGPUPromoteAlloca() : FunctionPass(ID) {}
 107
 108   bool doInitialization(Module &M) override;
 109   bool runOnFunction(Function &F) override;
 110
 111   StringRef getPassName() const override { return "AMDGPU Promote Alloca"; }
 112
 113   bool handleAlloca(AllocaInst &I, bool SufficientLDS);
 114
 115   void getAnalysisUsage(AnalysisUsage &AU) const override {
 116     AU.setPreservesCFG();
 117     FunctionPass::getAnalysisUsage(AU);
 118   }
 119 };
 120
 121 } // end anonymous namespace
 122
 123 char AMDGPUPromoteAlloca::ID = 0;
 124
 125 INITIALIZE_PASS(AMDGPUPromoteAlloca, DEBUG_TYPE,
 126                 "AMDGPU promote alloca to vector or LDS", false, false)
 127
 128 char &llvm::AMDGPUPromoteAllocaID = AMDGPUPromoteAlloca::ID;
 129
 130 bool AMDGPUPromoteAlloca::doInitialization(Module &M) {
 131   Mod = &M;
 132   DL = &Mod->getDataLayout();
 133
 134   return false;
 135 }
 136
 137 bool AMDGPUPromoteAlloca::runOnFunction(Function &F) {
 138   if (skipFunction(F))
 139     return false;
 140
 141   if (auto *TPC = getAnalysisIfAvailable<TargetPassConfig>())
 142     TM = &TPC->getTM<TargetMachine>();
 143   else
 144     return false;
 145
 146   const Triple &TT = TM->getTargetTriple();
 147   IsAMDGCN = TT.getArch() == Triple::amdgcn;
 148   IsAMDHSA = TT.getOS() == Triple::AMDHSA;
 149
 150   const AMDGPUSubtarget &ST = TM->getSubtarget<AMDGPUSubtarget>(F);
 151   if (!ST.isPromoteAllocaEnabled())
 152     return false;
 153
 154   AS = AMDGPU::getAMDGPUAS(*F.getParent());
 155
 156   bool SufficientLDS = hasSufficientLocalMem(F);
 157   bool Changed = false;
 158   BasicBlock &EntryBB = *F.begin();
 159   for (auto I = EntryBB.begin(), E = EntryBB.end(); I != E; ) {
 160     AllocaInst *AI = dyn_cast<AllocaInst>(I);
 161
 162     ++I;
 163     if (AI)
 164       Changed |= handleAlloca(*AI, SufficientLDS);
 165   }
 166
 167   return Changed;
 168 }
 169
 170 std::pair<Value *, Value *>
 171 AMDGPUPromoteAlloca::getLocalSizeYZ(IRBuilder<> &Builder) {
 172   const AMDGPUSubtarget &ST = TM->getSubtarget<AMDGPUSubtarget>(
 173                                 *Builder.GetInsertBlock()->getParent());
 174
 175   if (!IsAMDHSA) {
 176     Function *LocalSizeYFn
 177       = Intrinsic::getDeclaration(Mod, Intrinsic::r600_read_local_size_y);
 178     Function *LocalSizeZFn
 179       = Intrinsic::getDeclaration(Mod, Intrinsic::r600_read_local_size_z);
 180
 181     CallInst *LocalSizeY = Builder.CreateCall(LocalSizeYFn, {});
 182     CallInst *LocalSizeZ = Builder.CreateCall(LocalSizeZFn, {});
 183
 184     ST.makeLIDRangeMetadata(LocalSizeY);
 185     ST.makeLIDRangeMetadata(LocalSizeZ);
 186
 187     return std::make_pair(LocalSizeY, LocalSizeZ);
 188   }
 189
 190   // We must read the size out of the dispatch pointer.
 191   assert(IsAMDGCN);
 192
 193   // We are indexing into this struct, and want to extract the workgroup_size_*
 194   // fields.
 195   //
 196   //   typedef struct hsa_kernel_dispatch_packet_s {
 197   //     uint16_t header;
 198   //     uint16_t setup;
 199   //     uint16_t workgroup_size_x ;
 200   //     uint16_t workgroup_size_y;
 201   //     uint16_t workgroup_size_z;
 202   //     uint16_t reserved0;
 203   //     uint32_t grid_size_x ;
 204   //     uint32_t grid_size_y ;
 205   //     uint32_t grid_size_z;
 206   //
 207   //     uint32_t private_segment_size;
 208   //     uint32_t group_segment_size;
 209   //     uint64_t kernel_object;
 210   //
 211   // #ifdef HSA_LARGE_MODEL
 212   //     void *kernarg_address;
 213   // #elif defined HSA_LITTLE_ENDIAN
 214   //     void *kernarg_address;
 215   //     uint32_t reserved1;
 216   // #else
 217   //     uint32_t reserved1;
 218   //     void *kernarg_address;
 219   // #endif
 220   //     uint64_t reserved2;
 221   //     hsa_signal_t completion_signal; // uint64_t wrapper
 222   //   } hsa_kernel_dispatch_packet_t
 223   //
 224   Function *DispatchPtrFn
 225     = Intrinsic::getDeclaration(Mod, Intrinsic::amdgcn_dispatch_ptr);
 226
 227   CallInst *DispatchPtr = Builder.CreateCall(DispatchPtrFn, {});
 228   DispatchPtr->addAttribute(AttributeList::ReturnIndex, Attribute::NoAlias);
 229   DispatchPtr->addAttribute(AttributeList::ReturnIndex, Attribute::NonNull);
 230
 231   // Size of the dispatch packet struct.
 232   DispatchPtr->addDereferenceableAttr(AttributeList::ReturnIndex, 64);
 233
 234   Type *I32Ty = Type::getInt32Ty(Mod->getContext());
 235   Value *CastDispatchPtr = Builder.CreateBitCast(
 236     DispatchPtr, PointerType::get(I32Ty, AS.CONSTANT_ADDRESS));
 237
 238   // We could do a single 64-bit load here, but it's likely that the basic
 239   // 32-bit and extract sequence is already present, and it is probably easier
 240   // to CSE this. The loads should be mergable later anyway.
 241   Value *GEPXY = Builder.CreateConstInBoundsGEP1_64(CastDispatchPtr, 1);
 242   LoadInst *LoadXY = Builder.CreateAlignedLoad(GEPXY, 4);
 243
 244   Value *GEPZU = Builder.CreateConstInBoundsGEP1_64(CastDispatchPtr, 2);
 245   LoadInst *LoadZU = Builder.CreateAlignedLoad(GEPZU, 4);
 246
 247   MDNode *MD = MDNode::get(Mod->getContext(), None);
 248   LoadXY->setMetadata(LLVMContext::MD_invariant_load, MD);
 249   LoadZU->setMetadata(LLVMContext::MD_invariant_load, MD);
 250   ST.makeLIDRangeMetadata(LoadZU);
 251
 252   // Extract y component. Upper half of LoadZU should be zero already.
 253   Value *Y = Builder.CreateLShr(LoadXY, 16);
 254
 255   return std::make_pair(Y, LoadZU);
 256 }
 257
 258 Value *AMDGPUPromoteAlloca::getWorkitemID(IRBuilder<> &Builder, unsigned N) {
 259   const AMDGPUSubtarget &ST = TM->getSubtarget<AMDGPUSubtarget>(
 260                                 *Builder.GetInsertBlock()->getParent());
 261   Intrinsic::ID IntrID = Intrinsic::ID::not_intrinsic;
 262
 263   switch (N) {
 264   case 0:
 265     IntrID = IsAMDGCN ? Intrinsic::amdgcn_workitem_id_x
 266       : Intrinsic::r600_read_tidig_x;
 267     break;
 268   case 1:
 269     IntrID = IsAMDGCN ? Intrinsic::amdgcn_workitem_id_y
 270       : Intrinsic::r600_read_tidig_y;
 271     break;
 272
 273   case 2:
 274     IntrID = IsAMDGCN ? Intrinsic::amdgcn_workitem_id_z
 275       : Intrinsic::r600_read_tidig_z;
 276     break;
 277   default:
 278     llvm_unreachable("invalid dimension");
 279   }
 280
 281   Function *WorkitemIdFn = Intrinsic::getDeclaration(Mod, IntrID);
 282   CallInst *CI = Builder.CreateCall(WorkitemIdFn);
 283   ST.makeLIDRangeMetadata(CI);
 284
 285   return CI;
 286 }
 287
 288 static VectorType *arrayTypeToVecType(ArrayType *ArrayTy) {
 289   return VectorType::get(ArrayTy->getElementType(),
 290                          ArrayTy->getNumElements());
 291 }
 292
 293 static Value *
 294 calculateVectorIndex(Value *Ptr,
 295                      const std::map<GetElementPtrInst *, Value *> &GEPIdx) {
 296   GetElementPtrInst *GEP = cast<GetElementPtrInst>(Ptr);
 297
 298   auto I = GEPIdx.find(GEP);
 299   return I == GEPIdx.end() ? nullptr : I->second;
 300 }
 301
 302 static Value* GEPToVectorIndex(GetElementPtrInst *GEP) {
 303   // FIXME we only support simple cases
 304   if (GEP->getNumOperands() != 3)
 305     return nullptr;
 306
 307   ConstantInt *I0 = dyn_cast<ConstantInt>(GEP->getOperand(1));
 308   if (!I0 || !I0->isZero())
 309     return nullptr;
 310
 311   return GEP->getOperand(2);
 312 }
 313
 314 // Not an instruction handled below to turn into a vector.
 315 //
 316 // TODO: Check isTriviallyVectorizable for calls and handle other
 317 // instructions.
 318 static bool canVectorizeInst(Instruction *Inst, User *User) {
 319   switch (Inst->getOpcode()) {
 320   case Instruction::Load: {
 321     LoadInst *LI = cast<LoadInst>(Inst);
 322     // Currently only handle the case where the Pointer Operand is a GEP so check for that case.
 323     return isa<GetElementPtrInst>(LI->getPointerOperand()) && !LI->isVolatile();
 324   }
 325   case Instruction::BitCast:
 326   case Instruction::AddrSpaceCast:
 327     return true;
 328   case Instruction::Store: {
 329     // Must be the stored pointer operand, not a stored value, plus
 330     // since it should be canonical form, the User should be a GEP.
 331     StoreInst *SI = cast<StoreInst>(Inst);
 332     return (SI->getPointerOperand() == User) && isa<GetElementPtrInst>(User) && !SI->isVolatile();
 333   }
 334   default:
 335     return false;
 336   }
 337 }
 338
 339 static bool tryPromoteAllocaToVector(AllocaInst *Alloca, AMDGPUAS AS) {
 340   ArrayType *AllocaTy = dyn_cast<ArrayType>(Alloca->getAllocatedType());
 341
 342   DEBUG(dbgs() << "Alloca candidate for vectorization\n");
 343
 344   // FIXME: There is no reason why we can't support larger arrays, we
 345   // are just being conservative for now.
 346   // FIXME: We also reject alloca's of the form [ 2 x [ 2 x i32 ]] or equivalent. Potentially these
 347   // could also be promoted but we don't currently handle this case
 348   if (!AllocaTy ||
 349       AllocaTy->getNumElements() > 4 ||
 350       AllocaTy->getNumElements() < 2 ||
 351       !VectorType::isValidElementType(AllocaTy->getElementType())) {
 352     DEBUG(dbgs() << "  Cannot convert type to vector\n");
 353     return false;
 354   }
 355
 356   std::map<GetElementPtrInst*, Value*> GEPVectorIdx;
 357   std::vector<Value*> WorkList;
 358   for (User *AllocaUser : Alloca->users()) {
 359     GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(AllocaUser);
 360     if (!GEP) {
 361       if (!canVectorizeInst(cast<Instruction>(AllocaUser), Alloca))
 362         return false;
 363
 364       WorkList.push_back(AllocaUser);
 365       continue;
 366     }
 367
 368     Value *Index = GEPToVectorIndex(GEP);
 369
 370     // If we can't compute a vector index from this GEP, then we can't
 371     // promote this alloca to vector.
 372     if (!Index) {
 373       DEBUG(dbgs() << "  Cannot compute vector index for GEP " << *GEP << '\n');
 374       return false;
 375     }
 376
 377     GEPVectorIdx[GEP] = Index;
 378     for (User *GEPUser : AllocaUser->users()) {
 379       if (!canVectorizeInst(cast<Instruction>(GEPUser), AllocaUser))
 380         return false;
 381
 382       WorkList.push_back(GEPUser);
 383     }
 384   }
 385
 386   VectorType *VectorTy = arrayTypeToVecType(AllocaTy);
 387
 388   DEBUG(dbgs() << "  Converting alloca to vector "
 389         << *AllocaTy << " -> " << *VectorTy << '\n');
 390
 391   for (Value *V : WorkList) {
 392     Instruction *Inst = cast<Instruction>(V);
 393     IRBuilder<> Builder(Inst);
 394     switch (Inst->getOpcode()) {
 395     case Instruction::Load: {
 396       Type *VecPtrTy = VectorTy->getPointerTo(AS.PRIVATE_ADDRESS);
 397       Value *Ptr = cast<LoadInst>(Inst)->getPointerOperand();
 398       Value *Index = calculateVectorIndex(Ptr, GEPVectorIdx);
 399
 400       Value *BitCast = Builder.CreateBitCast(Alloca, VecPtrTy);
 401       Value *VecValue = Builder.CreateLoad(BitCast);
 402       Value *ExtractElement = Builder.CreateExtractElement(VecValue, Index);
 403       Inst->replaceAllUsesWith(ExtractElement);
 404       Inst->eraseFromParent();
 405       break;
 406     }
 407     case Instruction::Store: {
 408       Type *VecPtrTy = VectorTy->getPointerTo(AS.PRIVATE_ADDRESS);
 409
 410       StoreInst *SI = cast<StoreInst>(Inst);
 411       Value *Ptr = SI->getPointerOperand();
 412       Value *Index = calculateVectorIndex(Ptr, GEPVectorIdx);
 413       Value *BitCast = Builder.CreateBitCast(Alloca, VecPtrTy);
 414       Value *VecValue = Builder.CreateLoad(BitCast);
 415       Value *NewVecValue = Builder.CreateInsertElement(VecValue,
 416                                                        SI->getValueOperand(),
 417                                                        Index);
 418       Builder.CreateStore(NewVecValue, BitCast);
 419       Inst->eraseFromParent();
 420       break;
 421     }
 422     case Instruction::BitCast:
 423     case Instruction::AddrSpaceCast:
 424       break;
 425
 426     default:
 427       llvm_unreachable("Inconsistency in instructions promotable to vector");
 428     }
 429   }
 430   return true;
 431 }
 432
 433 static bool isCallPromotable(CallInst *CI) {
 434   IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI);
 435   if (!II)
 436     return false;
 437
 438   switch (II->getIntrinsicID()) {
 439   case Intrinsic::memcpy:
 440   case Intrinsic::memmove:
 441   case Intrinsic::memset:
 442   case Intrinsic::lifetime_start:
 443   case Intrinsic::lifetime_end:
 444   case Intrinsic::invariant_start:
 445   case Intrinsic::invariant_end:
 446   case Intrinsic::invariant_group_barrier:
 447   case Intrinsic::objectsize:
 448     return true;
 449   default:
 450     return false;
 451   }
 452 }
 453
 454 bool AMDGPUPromoteAlloca::binaryOpIsDerivedFromSameAlloca(Value *BaseAlloca,
 455                                                           Value *Val,
 456                                                           Instruction *Inst,
 457                                                           int OpIdx0,
 458                                                           int OpIdx1) const {
 459   // Figure out which operand is the one we might not be promoting.
 460   Value *OtherOp = Inst->getOperand(OpIdx0);
 461   if (Val == OtherOp)
 462     OtherOp = Inst->getOperand(OpIdx1);
 463
 464   if (isa<ConstantPointerNull>(OtherOp))
 465     return true;
 466
 467   Value *OtherObj = GetUnderlyingObject(OtherOp, *DL);
 468   if (!isa<AllocaInst>(OtherObj))
 469     return false;
 470
 471   // TODO: We should be able to replace undefs with the right pointer type.
 472
 473   // TODO: If we know the other base object is another promotable
 474   // alloca, not necessarily this alloca, we can do this. The
 475   // important part is both must have the same address space at
 476   // the end.
 477   if (OtherObj != BaseAlloca) {
 478     DEBUG(dbgs() << "Found a binary instruction with another alloca object\n");
 479     return false;
 480   }
 481
 482   return true;
 483 }
 484
 485 bool AMDGPUPromoteAlloca::collectUsesWithPtrTypes(
 486   Value *BaseAlloca,
 487   Value *Val,
 488   std::vector<Value*> &WorkList) const {
 489
 490   for (User *User : Val->users()) {
 491     if (is_contained(WorkList, User))
 492       continue;
 493
 494     if (CallInst *CI = dyn_cast<CallInst>(User)) {
 495       if (!isCallPromotable(CI))
 496         return false;
 497
 498       WorkList.push_back(User);
 499       continue;
 500     }
 501
 502     Instruction *UseInst = cast<Instruction>(User);
 503     if (UseInst->getOpcode() == Instruction::PtrToInt)
 504       return false;
 505
 506     if (LoadInst *LI = dyn_cast<LoadInst>(UseInst)) {
 507       if (LI->isVolatile())
 508         return false;
 509
 510       continue;
 511     }
 512
 513     if (StoreInst *SI = dyn_cast<StoreInst>(UseInst)) {
 514       if (SI->isVolatile())
 515         return false;
 516
 517       // Reject if the stored value is not the pointer operand.
 518       if (SI->getPointerOperand() != Val)
 519         return false;
 520     } else if (AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(UseInst)) {
 521       if (RMW->isVolatile())
 522         return false;
 523     } else if (AtomicCmpXchgInst *CAS = dyn_cast<AtomicCmpXchgInst>(UseInst)) {
 524       if (CAS->isVolatile())
 525         return false;
 526     }
 527
 528     // Only promote a select if we know that the other select operand
 529     // is from another pointer that will also be promoted.
 530     if (ICmpInst *ICmp = dyn_cast<ICmpInst>(UseInst)) {
 531       if (!binaryOpIsDerivedFromSameAlloca(BaseAlloca, Val, ICmp, 0, 1))
 532         return false;
 533
 534       // May need to rewrite constant operands.
 535       WorkList.push_back(ICmp);
 536     }
 537
 538     if (UseInst->getOpcode() == Instruction::AddrSpaceCast) {
 539       // Give up if the pointer may be captured.
 540       if (PointerMayBeCaptured(UseInst, true, true))
 541         return false;
 542       // Don't collect the users of this.
 543       WorkList.push_back(User);
 544       continue;
 545     }
 546
 547     if (!User->getType()->isPointerTy())
 548       continue;
 549
 550     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(UseInst)) {
 551       // Be conservative if an address could be computed outside the bounds of
 552       // the alloca.
 553       if (!GEP->isInBounds())
 554         return false;
 555     }
 556
 557     // Only promote a select if we know that the other select operand is from
 558     // another pointer that will also be promoted.
 559     if (SelectInst *SI = dyn_cast<SelectInst>(UseInst)) {
 560       if (!binaryOpIsDerivedFromSameAlloca(BaseAlloca, Val, SI, 1, 2))
 561         return false;
 562     }
 563
 564     // Repeat for phis.
 565     if (PHINode *Phi = dyn_cast<PHINode>(UseInst)) {
 566       // TODO: Handle more complex cases. We should be able to replace loops
 567       // over arrays.
 568       switch (Phi->getNumIncomingValues()) {
 569       case 1:
 570         break;
 571       case 2:
 572         if (!binaryOpIsDerivedFromSameAlloca(BaseAlloca, Val, Phi, 0, 1))
 573           return false;
 574         break;
 575       default:
 576         return false;
 577       }
 578     }
 579
 580     WorkList.push_back(User);
 581     if (!collectUsesWithPtrTypes(BaseAlloca, User, WorkList))
 582       return false;
 583   }
 584
 585   return true;
 586 }
 587
 588 bool AMDGPUPromoteAlloca::hasSufficientLocalMem(const Function &F) {
 589
 590   FunctionType *FTy = F.getFunctionType();
 591   const AMDGPUSubtarget &ST = TM->getSubtarget<AMDGPUSubtarget>(F);
 592
 593   // If the function has any arguments in the local address space, then it's
 594   // possible these arguments require the entire local memory space, so
 595   // we cannot use local memory in the pass.
 596   for (Type *ParamTy : FTy->params()) {
 597     PointerType *PtrTy = dyn_cast<PointerType>(ParamTy);
 598     if (PtrTy && PtrTy->getAddressSpace() == AS.LOCAL_ADDRESS) {
 599       LocalMemLimit = 0;
 600       DEBUG(dbgs() << "Function has local memory argument. Promoting to "
 601                       "local memory disabled.\n");
 602       return false;
 603     }
 604   }
 605
 606   LocalMemLimit = ST.getLocalMemorySize();
 607   if (LocalMemLimit == 0)
 608     return false;
 609
 610   const DataLayout &DL = Mod->getDataLayout();
 611
 612   // Check how much local memory is being used by global objects
 613   CurrentLocalMemUsage = 0;
 614   for (GlobalVariable &GV : Mod->globals()) {
 615     if (GV.getType()->getAddressSpace() != AS.LOCAL_ADDRESS)
 616       continue;
 617
 618     for (const User *U : GV.users()) {
 619       const Instruction *Use = dyn_cast<Instruction>(U);
 620       if (!Use)
 621         continue;
 622
 623       if (Use->getParent()->getParent() == &F) {
 624         unsigned Align = GV.getAlignment();
 625         if (Align == 0)
 626           Align = DL.getABITypeAlignment(GV.getValueType());
 627
 628         // FIXME: Try to account for padding here. The padding is currently
 629         // determined from the inverse order of uses in the function. I'm not
 630         // sure if the use list order is in any way connected to this, so the
 631         // total reported size is likely incorrect.
 632         uint64_t AllocSize = DL.getTypeAllocSize(GV.getValueType());
 633         CurrentLocalMemUsage = alignTo(CurrentLocalMemUsage, Align);
 634         CurrentLocalMemUsage += AllocSize;
 635         break;
 636       }
 637     }
 638   }
 639
 640   unsigned MaxOccupancy = ST.getOccupancyWithLocalMemSize(CurrentLocalMemUsage,
 641                                                           F);
 642
 643   // Restrict local memory usage so that we don't drastically reduce occupancy,
 644   // unless it is already significantly reduced.
 645
 646   // TODO: Have some sort of hint or other heuristics to guess occupancy based
 647   // on other factors..
 648   unsigned OccupancyHint = ST.getWavesPerEU(F).second;
 649   if (OccupancyHint == 0)
 650     OccupancyHint = 7;
 651
 652   // Clamp to max value.
 653   OccupancyHint = std::min(OccupancyHint, ST.getMaxWavesPerEU());
 654
 655   // Check the hint but ignore it if it's obviously wrong from the existing LDS
 656   // usage.
 657   MaxOccupancy = std::min(OccupancyHint, MaxOccupancy);
 658
 659
 660   // Round up to the next tier of usage.
 661   unsigned MaxSizeWithWaveCount
 662     = ST.getMaxLocalMemSizeWithWaveCount(MaxOccupancy, F);
 663
 664   // Program is possibly broken by using more local mem than available.
 665   if (CurrentLocalMemUsage > MaxSizeWithWaveCount)
 666     return false;
 667
 668   LocalMemLimit = MaxSizeWithWaveCount;
 669
 670   DEBUG(
 671     dbgs() << F.getName() << " uses " << CurrentLocalMemUsage << " bytes of LDS\n"
 672     << "  Rounding size to " << MaxSizeWithWaveCount
 673     << " with a maximum occupancy of " << MaxOccupancy << '\n'
 674     << " and " << (LocalMemLimit - CurrentLocalMemUsage)
 675     << " available for promotion\n"
 676   );
 677
 678   return true;
 679 }
 680
 681 // FIXME: Should try to pick the most likely to be profitable allocas first.
 682 bool AMDGPUPromoteAlloca::handleAlloca(AllocaInst &I, bool SufficientLDS) {
 683   // Array allocations are probably not worth handling, since an allocation of
 684   // the array type is the canonical form.
 685   if (!I.isStaticAlloca() || I.isArrayAllocation())
 686     return false;
 687
 688   IRBuilder<> Builder(&I);
 689
 690   // First try to replace the alloca with a vector
 691   Type *AllocaTy = I.getAllocatedType();
 692
 693   DEBUG(dbgs() << "Trying to promote " << I << '\n');
 694
 695   if (tryPromoteAllocaToVector(&I, AS))
 696     return true; // Promoted to vector.
 697
 698   const Function &ContainingFunction = *I.getParent()->getParent();
 699   CallingConv::ID CC = ContainingFunction.getCallingConv();
 700
 701   // Don't promote the alloca to LDS for shader calling conventions as the work
 702   // item ID intrinsics are not supported for these calling conventions.
 703   // Furthermore not all LDS is available for some of the stages.
 704   switch (CC) {
 705   case CallingConv::AMDGPU_KERNEL:
 706   case CallingConv::SPIR_KERNEL:
 707     break;
 708   default:
 709     DEBUG(dbgs() << " promote alloca to LDS not supported with calling convention.\n");
 710     return false;
 711   }
 712
 713   // Not likely to have sufficient local memory for promotion.
 714   if (!SufficientLDS)
 715     return false;
 716
 717   const AMDGPUSubtarget &ST =
 718     TM->getSubtarget<AMDGPUSubtarget>(ContainingFunction);
 719   unsigned WorkGroupSize = ST.getFlatWorkGroupSizes(ContainingFunction).second;
 720
 721   const DataLayout &DL = Mod->getDataLayout();
 722
 723   unsigned Align = I.getAlignment();
 724   if (Align == 0)
 725     Align = DL.getABITypeAlignment(I.getAllocatedType());
 726
 727   // FIXME: This computed padding is likely wrong since it depends on inverse
 728   // usage order.
 729   //
 730   // FIXME: It is also possible that if we're allowed to use all of the memory
 731   // could could end up using more than the maximum due to alignment padding.
 732
 733   uint32_t NewSize = alignTo(CurrentLocalMemUsage, Align);
 734   uint32_t AllocSize = WorkGroupSize * DL.getTypeAllocSize(AllocaTy);
 735   NewSize += AllocSize;
 736
 737   if (NewSize > LocalMemLimit) {
 738     DEBUG(dbgs() << "  " << AllocSize
 739           << " bytes of local memory not available to promote\n");
 740     return false;
 741   }
 742
 743   CurrentLocalMemUsage = NewSize;
 744
 745   std::vector<Value*> WorkList;
 746
 747   if (!collectUsesWithPtrTypes(&I, &I, WorkList)) {
 748     DEBUG(dbgs() << " Do not know how to convert all uses\n");
 749     return false;
 750   }
 751
 752   DEBUG(dbgs() << "Promoting alloca to local memory\n");
 753
 754   Function *F = I.getParent()->getParent();
 755
 756   Type *GVTy = ArrayType::get(I.getAllocatedType(), WorkGroupSize);
 757   GlobalVariable *GV = new GlobalVariable(
 758       *Mod, GVTy, false, GlobalValue::InternalLinkage,
 759       UndefValue::get(GVTy),
 760       Twine(F->getName()) + Twine('.') + I.getName(),
 761       nullptr,
 762       GlobalVariable::NotThreadLocal,
 763       AS.LOCAL_ADDRESS);
 764   GV->setUnnamedAddr(GlobalValue::UnnamedAddr::Global);
 765   GV->setAlignment(I.getAlignment());
 766
 767   Value *TCntY, *TCntZ;
 768
 769   std::tie(TCntY, TCntZ) = getLocalSizeYZ(Builder);
 770   Value *TIdX = getWorkitemID(Builder, 0);
 771   Value *TIdY = getWorkitemID(Builder, 1);
 772   Value *TIdZ = getWorkitemID(Builder, 2);
 773
 774   Value *Tmp0 = Builder.CreateMul(TCntY, TCntZ, "", true, true);
 775   Tmp0 = Builder.CreateMul(Tmp0, TIdX);
 776   Value *Tmp1 = Builder.CreateMul(TIdY, TCntZ, "", true, true);
 777   Value *TID = Builder.CreateAdd(Tmp0, Tmp1);
 778   TID = Builder.CreateAdd(TID, TIdZ);
 779
 780   Value *Indices[] = {
 781     Constant::getNullValue(Type::getInt32Ty(Mod->getContext())),
 782     TID
 783   };
 784
 785   Value *Offset = Builder.CreateInBoundsGEP(GVTy, GV, Indices);
 786   I.mutateType(Offset->getType());
 787   I.replaceAllUsesWith(Offset);
 788   I.eraseFromParent();
 789
 790   for (Value *V : WorkList) {
 791     CallInst *Call = dyn_cast<CallInst>(V);
 792     if (!Call) {
 793       if (ICmpInst *CI = dyn_cast<ICmpInst>(V)) {
 794         Value *Src0 = CI->getOperand(0);
 795         Type *EltTy = Src0->getType()->getPointerElementType();
 796         PointerType *NewTy = PointerType::get(EltTy, AS.LOCAL_ADDRESS);
 797
 798         if (isa<ConstantPointerNull>(CI->getOperand(0)))
 799           CI->setOperand(0, ConstantPointerNull::get(NewTy));
 800
 801         if (isa<ConstantPointerNull>(CI->getOperand(1)))
 802           CI->setOperand(1, ConstantPointerNull::get(NewTy));
 803
 804         continue;
 805       }
 806
 807       // The operand's value should be corrected on its own and we don't want to
 808       // touch the users.
 809       if (isa<AddrSpaceCastInst>(V))
 810         continue;
 811
 812       Type *EltTy = V->getType()->getPointerElementType();
 813       PointerType *NewTy = PointerType::get(EltTy, AS.LOCAL_ADDRESS);
 814
 815       // FIXME: It doesn't really make sense to try to do this for all
 816       // instructions.
 817       V->mutateType(NewTy);
 818
 819       // Adjust the types of any constant operands.
 820       if (SelectInst *SI = dyn_cast<SelectInst>(V)) {
 821         if (isa<ConstantPointerNull>(SI->getOperand(1)))
 822           SI->setOperand(1, ConstantPointerNull::get(NewTy));
 823
 824         if (isa<ConstantPointerNull>(SI->getOperand(2)))
 825           SI->setOperand(2, ConstantPointerNull::get(NewTy));
 826       } else if (PHINode *Phi = dyn_cast<PHINode>(V)) {
 827         for (unsigned I = 0, E = Phi->getNumIncomingValues(); I != E; ++I) {
 828           if (isa<ConstantPointerNull>(Phi->getIncomingValue(I)))
 829             Phi->setIncomingValue(I, ConstantPointerNull::get(NewTy));
 830         }
 831       }
 832
 833       continue;
 834     }
 835
 836     IntrinsicInst *Intr = cast<IntrinsicInst>(Call);
 837     Builder.SetInsertPoint(Intr);
 838     switch (Intr->getIntrinsicID()) {
 839     case Intrinsic::lifetime_start:
 840     case Intrinsic::lifetime_end:
 841       // These intrinsics are for address space 0 only
 842       Intr->eraseFromParent();
 843       continue;
 844     case Intrinsic::memcpy: {
 845       MemCpyInst *MemCpy = cast<MemCpyInst>(Intr);
 846       Builder.CreateMemCpy(MemCpy->getRawDest(), MemCpy->getRawSource(),
 847                            MemCpy->getLength(), MemCpy->getAlignment(),
 848                            MemCpy->isVolatile());
 849       Intr->eraseFromParent();
 850       continue;
 851     }
 852     case Intrinsic::memmove: {
 853       MemMoveInst *MemMove = cast<MemMoveInst>(Intr);
 854       Builder.CreateMemMove(MemMove->getRawDest(), MemMove->getRawSource(),
 855                             MemMove->getLength(), MemMove->getAlignment(),
 856                             MemMove->isVolatile());
 857       Intr->eraseFromParent();
 858       continue;
 859     }
 860     case Intrinsic::memset: {
 861       MemSetInst *MemSet = cast<MemSetInst>(Intr);
 862       Builder.CreateMemSet(MemSet->getRawDest(), MemSet->getValue(),
 863                            MemSet->getLength(), MemSet->getAlignment(),
 864                            MemSet->isVolatile());
 865       Intr->eraseFromParent();
 866       continue;
 867     }
 868     case Intrinsic::invariant_start:
 869     case Intrinsic::invariant_end:
 870     case Intrinsic::invariant_group_barrier:
 871       Intr->eraseFromParent();
 872       // FIXME: I think the invariant marker should still theoretically apply,
 873       // but the intrinsics need to be changed to accept pointers with any
 874       // address space.
 875       continue;
 876     case Intrinsic::objectsize: {
 877       Value *Src = Intr->getOperand(0);
 878       Type *SrcTy = Src->getType()->getPointerElementType();
 879       Function *ObjectSize = Intrinsic::getDeclaration(Mod,
 880         Intrinsic::objectsize,
 881         { Intr->getType(), PointerType::get(SrcTy, AS.LOCAL_ADDRESS) }
 882       );
 883
 884       CallInst *NewCall = Builder.CreateCall(
 885           ObjectSize, {Src, Intr->getOperand(1), Intr->getOperand(2)});
 886       Intr->replaceAllUsesWith(NewCall);
 887       Intr->eraseFromParent();
 888       continue;
 889     }
 890     default:
 891       Intr->print(errs());
 892       llvm_unreachable("Don't know how to promote alloca intrinsic use.");
 893     }
 894   }
 895   return true;
 896 }
 897
 898 FunctionPass *llvm::createAMDGPUPromoteAlloca() {
 899   return new AMDGPUPromoteAlloca();
 900 }