LLVM 24.0.0git
AMDGPUPromoteAlloca.cpp
Go to the documentation of this file.
1//===-- AMDGPUPromoteAlloca.cpp - Promote Allocas -------------------------===//
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// Eliminates allocas by either converting them into vectors or by migrating
10// them to local address space.
11//
12// Two passes are exposed by this file:
13// - "promote-alloca-to-vector", which runs early in the pipeline and only
14// promotes to vector. Promotion to vector is almost always profitable
15// except when the alloca is too big and the promotion would result in
16// very high register pressure.
17// - "promote-alloca", which does both promotion to vector and LDS and runs
18// much later in the pipeline. This runs after SROA because promoting to
19// LDS is of course less profitable than getting rid of the alloca or
20// vectorizing it, thus we only want to do it when the only alternative is
21// lowering the alloca to stack.
22//
23// Note that both of them exist for the old and new PMs. The new PM passes are
24// declared in AMDGPU.h and the legacy PM ones are declared here.s
25//
26//===----------------------------------------------------------------------===//
27
28#include "AMDGPU.h"
29#include "GCNSubtarget.h"
31#include "llvm/ADT/STLExtras.h"
38#include "llvm/IR/IRBuilder.h"
40#include "llvm/IR/IntrinsicsAMDGPU.h"
41#include "llvm/IR/IntrinsicsR600.h"
44#include "llvm/Pass.h"
48
49#define DEBUG_TYPE "amdgpu-promote-alloca"
50
51using namespace llvm;
52
53namespace {
54
55static cl::opt<bool>
56 DisablePromoteAllocaToVector("disable-promote-alloca-to-vector",
57 cl::desc("Disable promote alloca to vector"),
58 cl::init(false));
59
60static cl::opt<bool>
61 DisablePromoteAllocaToLDS("disable-promote-alloca-to-lds",
62 cl::desc("Disable promote alloca to LDS"),
63 cl::init(false));
64
65static cl::opt<unsigned> PromoteAllocaToVectorLimit(
66 "amdgpu-promote-alloca-to-vector-limit",
67 cl::desc("Maximum byte size to consider promote alloca to vector"),
68 cl::init(0));
69
70static cl::opt<unsigned> PromoteAllocaToVectorMaxRegs(
71 "amdgpu-promote-alloca-to-vector-max-regs",
73 "Maximum vector size (in 32b registers) to use when promoting alloca"),
74 cl::init(32));
75
76// Use up to 1/4 of available register budget for vectorization.
77// FIXME: Increase the limit for whole function budgets? Perhaps x2?
78static cl::opt<unsigned> PromoteAllocaToVectorVGPRRatio(
79 "amdgpu-promote-alloca-to-vector-vgpr-ratio",
80 cl::desc("Ratio of VGPRs to budget for promoting alloca to vectors"),
81 cl::init(4));
82
84 LoopUserWeight("promote-alloca-vector-loop-user-weight",
85 cl::desc("The bonus weight of users of allocas within loop "
86 "when sorting profitable allocas"),
87 cl::init(4));
88
89// We support vector indices of the form ((A * stride) >> shift) + B
90// VarIndex is A, VarMul is stride, VarShift is shift and ConstIndex is B. All
91// parts are optional.
92struct GEPToVectorIndex {
93 WeakTrackingVH VarIndex = nullptr; // defaults to 0
94 ConstantInt *VarMul = nullptr; // defaults to 1
95 ConstantInt *VarShift = nullptr; // defaults to 0
96 ConstantInt *ConstIndex = nullptr; // defaults to 0
97 Value *Full = nullptr;
98};
99
100struct MemTransferInfo {
101 ConstantInt *SrcIndex = nullptr;
102 ConstantInt *DestIndex = nullptr;
103};
104
105// Analysis for planning the different strategies of alloca promotion.
106struct AllocaAnalysis {
107 AllocaInst *Alloca = nullptr;
108 DenseSet<Value *> Pointers;
110 unsigned Score = 0;
111 bool HaveSelectOrPHI = false;
112 struct {
113 FixedVectorType *Ty = nullptr;
115 SmallVector<Instruction *> UsersToRemove;
118 } Vector;
119 struct {
120 bool Enable = false;
121 SmallVector<User *> Worklist;
122 } LDS;
123
124 explicit AllocaAnalysis(AllocaInst *Alloca) : Alloca(Alloca) {}
125};
126
127// Shared implementation which can do both promotion to vector and to LDS.
128class AMDGPUPromoteAllocaImpl {
129private:
130 const TargetMachine &TM;
131 LoopInfo &LI;
132 Module &Mod;
133 const DataLayout &DL;
134
135 // FIXME: This should be per-kernel.
136 uint32_t LocalMemLimit = 0;
137 uint32_t CurrentLocalMemUsage = 0;
138 unsigned MaxVGPRs;
139 unsigned VGPRBudgetRatio;
140 unsigned MaxVectorRegs;
141
142 bool IsAMDGCN = false;
143 bool IsAMDHSA = false;
144
145 std::pair<Value *, Value *> getLocalSizeYZ(IRBuilder<> &Builder);
146 Value *getWorkitemID(IRBuilder<> &Builder, unsigned N);
147
148 bool collectAllocaUses(AllocaAnalysis &AA) const;
149
150 /// Val is a derived pointer from Alloca. OpIdx0/OpIdx1 are the operand
151 /// indices to an instruction with 2 pointer inputs (e.g. select, icmp).
152 /// Returns true if both operands are derived from the same alloca. Val should
153 /// be the same value as one of the input operands of UseInst.
154 bool binaryOpIsDerivedFromSameAlloca(Value *Alloca, Value *Val,
155 Instruction *UseInst, int OpIdx0,
156 int OpIdx1) const;
157
158 /// Check whether we have enough local memory for promotion.
159 bool hasSufficientLocalMem(const Function &F);
160
161 FixedVectorType *getVectorTypeForAlloca(Type *AllocaTy) const;
162 void analyzePromoteToVector(AllocaAnalysis &AA) const;
163 void promoteAllocaToVector(AllocaAnalysis &AA);
164 void analyzePromoteToLDS(AllocaAnalysis &AA) const;
165 bool tryPromoteAllocaToLDS(AllocaAnalysis &AA, bool SufficientLDS,
166 SetVector<IntrinsicInst *> &DeferredIntrs);
167 void
168 finishDeferredAllocaToLDSPromotion(SetVector<IntrinsicInst *> &DeferredIntrs);
169
170 void scoreAlloca(AllocaAnalysis &AA) const;
171
172 void setFunctionLimits(const Function &F);
173
174public:
175 AMDGPUPromoteAllocaImpl(TargetMachine &TM, Module &M, LoopInfo &LI)
176 : TM(TM), LI(LI), Mod(M), DL(M.getDataLayout()) {
177 const Triple &TT = M.getTargetTriple();
178 IsAMDGCN = TT.isAMDGCN();
179 IsAMDHSA = TT.getOS() == Triple::AMDHSA;
180 }
181
182 bool run(Function &F, bool PromoteToLDS);
183};
184
185// FIXME: This can create globals so should be a module pass.
186class AMDGPUPromoteAlloca : public FunctionPass {
187public:
188 static char ID;
189
190 AMDGPUPromoteAlloca() : FunctionPass(ID) {}
191
192 bool runOnFunction(Function &F) override {
193 if (skipFunction(F))
194 return false;
195 if (auto *TPC = getAnalysisIfAvailable<TargetPassConfig>())
196 return AMDGPUPromoteAllocaImpl(
197 TPC->getTM<TargetMachine>(), *F.getParent(),
198 getAnalysis<LoopInfoWrapperPass>().getLoopInfo())
199 .run(F, /*PromoteToLDS*/ true);
200 return false;
201 }
202
203 StringRef getPassName() const override { return "AMDGPU Promote Alloca"; }
204
205 void getAnalysisUsage(AnalysisUsage &AU) const override {
206 AU.setPreservesCFG();
209 }
210};
211
212static unsigned getMaxVGPRs(unsigned LDSBytes, const TargetMachine &TM,
213 const Function &F) {
214 const GCNSubtarget &ST = TM.getSubtarget<GCNSubtarget>(F);
215
216 unsigned DynamicVGPRBlockSize = AMDGPU::getDynamicVGPRBlockSize(F);
217 unsigned MaxVGPRs = ST.getMaxNumVGPRs(
218 ST.getWavesPerEU(ST.getFlatWorkGroupSizes(F), LDSBytes, F).first,
219 DynamicVGPRBlockSize);
220
221 // A non-entry function has only 32 caller preserved registers.
222 // Do not promote alloca which will force spilling unless we know the function
223 // will be inlined.
224 if (!F.hasFnAttribute(Attribute::AlwaysInline) &&
225 !AMDGPU::isEntryFunctionCC(F.getCallingConv()))
226 MaxVGPRs = std::min(MaxVGPRs, 32u);
227 return MaxVGPRs;
228}
229
230} // end anonymous namespace
231
232char AMDGPUPromoteAlloca::ID = 0;
233
235 "AMDGPU promote alloca to vector or LDS", false, false)
236// Move LDS uses from functions to kernels before promote alloca for accurate
237// estimation of LDS available
238INITIALIZE_PASS_DEPENDENCY(AMDGPULowerModuleLDSLegacy)
240INITIALIZE_PASS_END(AMDGPUPromoteAlloca, DEBUG_TYPE,
241 "AMDGPU promote alloca to vector or LDS", false, false)
242
243char &llvm::AMDGPUPromoteAllocaID = AMDGPUPromoteAlloca::ID;
244
247 auto &LI = AM.getResult<LoopAnalysis>(F);
248 bool Changed = AMDGPUPromoteAllocaImpl(TM, *F.getParent(), LI)
249 .run(F, /*PromoteToLDS=*/true);
250 if (Changed) {
253 return PA;
254 }
255 return PreservedAnalyses::all();
256}
257
260 auto &LI = AM.getResult<LoopAnalysis>(F);
261 bool Changed = AMDGPUPromoteAllocaImpl(TM, *F.getParent(), LI)
262 .run(F, /*PromoteToLDS=*/false);
263 if (Changed) {
266 return PA;
267 }
268 return PreservedAnalyses::all();
269}
270
272 return new AMDGPUPromoteAlloca();
273}
274
275bool AMDGPUPromoteAllocaImpl::collectAllocaUses(AllocaAnalysis &AA) const {
276 const auto RejectUser = [&](Instruction *Inst, Twine Msg) {
277 LLVM_DEBUG(dbgs() << " Cannot promote alloca: " << Msg << "\n"
278 << " " << *Inst << "\n");
279 return false;
280 };
281
282 SmallVector<Instruction *, 4> WorkList({AA.Alloca});
283 while (!WorkList.empty()) {
284 auto *Cur = WorkList.pop_back_val();
285 if (find(AA.Pointers, Cur) != AA.Pointers.end())
286 continue;
287 AA.Pointers.insert(Cur);
288 for (auto &U : Cur->uses()) {
289 auto *Inst = cast<Instruction>(U.getUser());
290 if (isa<StoreInst>(Inst)) {
291 if (U.getOperandNo() != StoreInst::getPointerOperandIndex()) {
292 return RejectUser(Inst, "pointer escapes via store");
293 }
294 }
295 AA.Uses.push_back(&U);
296
297 if (isa<GetElementPtrInst>(U.getUser())) {
298 WorkList.push_back(Inst);
299 } else if (auto *SI = dyn_cast<SelectInst>(Inst)) {
300 // Only promote a select if we know that the other select operand is
301 // from another pointer that will also be promoted.
302 if (!binaryOpIsDerivedFromSameAlloca(AA.Alloca, Cur, SI, 1, 2))
303 return RejectUser(Inst, "select from mixed objects");
304 WorkList.push_back(Inst);
305 AA.HaveSelectOrPHI = true;
306 } else if (auto *Phi = dyn_cast<PHINode>(Inst)) {
307 // Repeat for phis.
308
309 // TODO: Handle more complex cases. We should be able to replace loops
310 // over arrays.
311 switch (Phi->getNumIncomingValues()) {
312 case 1:
313 break;
314 case 2:
315 if (!binaryOpIsDerivedFromSameAlloca(AA.Alloca, Cur, Phi, 0, 1))
316 return RejectUser(Inst, "phi from mixed objects");
317 break;
318 default:
319 return RejectUser(Inst, "phi with too many operands");
320 }
321
322 WorkList.push_back(Inst);
323 AA.HaveSelectOrPHI = true;
324 }
325 }
326 }
327 return true;
328}
329
330void AMDGPUPromoteAllocaImpl::scoreAlloca(AllocaAnalysis &AA) const {
331 LLVM_DEBUG(dbgs() << "Scoring: " << *AA.Alloca << "\n");
332 unsigned Score = 0;
333 // Increment score by one for each user + a bonus for users within loops.
334 for (auto *U : AA.Uses) {
335 Instruction *Inst = cast<Instruction>(U->getUser());
336 if (isa<GetElementPtrInst>(Inst) || isa<SelectInst>(Inst) ||
337 isa<PHINode>(Inst))
338 continue;
339 unsigned UserScore =
340 1 + (LoopUserWeight * LI.getLoopDepth(Inst->getParent()));
341 LLVM_DEBUG(dbgs() << " [+" << UserScore << "]:\t" << *Inst << "\n");
342 Score += UserScore;
343 }
344 LLVM_DEBUG(dbgs() << " => Final Score:" << Score << "\n");
345 AA.Score = Score;
346}
347
348void AMDGPUPromoteAllocaImpl::setFunctionLimits(const Function &F) {
349 // Load per function limits, overriding with global options where appropriate.
350 // R600 register tuples/aliasing are fragile with large vector promotions so
351 // apply architecture specific limit here.
352 const int R600MaxVectorRegs = 16;
353 MaxVectorRegs = F.getFnAttributeAsParsedInteger(
354 "amdgpu-promote-alloca-to-vector-max-regs",
355 IsAMDGCN ? PromoteAllocaToVectorMaxRegs : R600MaxVectorRegs);
356 if (PromoteAllocaToVectorMaxRegs.getNumOccurrences())
357 MaxVectorRegs = PromoteAllocaToVectorMaxRegs;
358 VGPRBudgetRatio = F.getFnAttributeAsParsedInteger(
359 "amdgpu-promote-alloca-to-vector-vgpr-ratio",
360 PromoteAllocaToVectorVGPRRatio);
361 if (PromoteAllocaToVectorVGPRRatio.getNumOccurrences())
362 VGPRBudgetRatio = PromoteAllocaToVectorVGPRRatio;
363}
364
365bool AMDGPUPromoteAllocaImpl::run(Function &F, bool PromoteToLDS) {
366 if (DisablePromoteAllocaToLDS && DisablePromoteAllocaToVector)
367 return false;
368
369 bool SufficientLDS = PromoteToLDS && hasSufficientLocalMem(F);
370 MaxVGPRs = IsAMDGCN ? getMaxVGPRs(CurrentLocalMemUsage, TM, F) : 128;
371 setFunctionLimits(F);
372
373 unsigned VectorizationBudget =
374 (PromoteAllocaToVectorLimit ? PromoteAllocaToVectorLimit * 8
375 : (MaxVGPRs * 32)) /
376 VGPRBudgetRatio;
377
378 std::vector<AllocaAnalysis> Allocas;
379 for (Instruction &I : F.getEntryBlock()) {
380 if (AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
381 // Array allocations are probably not worth handling, since an allocation
382 // of the array type is the canonical form.
383 if (!AI->isStaticAlloca() || AI->isArrayAllocation())
384 continue;
385
386 LLVM_DEBUG(dbgs() << "Analyzing: " << *AI << '\n');
387
388 AllocaAnalysis AA{AI};
389 if (collectAllocaUses(AA)) {
390 analyzePromoteToVector(AA);
391 if (PromoteToLDS)
392 analyzePromoteToLDS(AA);
393 if (AA.Vector.Ty || AA.LDS.Enable) {
394 scoreAlloca(AA);
395 Allocas.push_back(std::move(AA));
396 }
397 }
398 }
399 }
400
401 stable_sort(Allocas,
402 [](const auto &A, const auto &B) { return A.Score > B.Score; });
403
404 // clang-format off
406 dbgs() << "Sorted Worklist:\n";
407 for (const auto &AA : Allocas)
408 dbgs() << " " << *AA.Alloca << "\n";
409 );
410 // clang-format on
411
412 bool Changed = false;
413 SetVector<IntrinsicInst *> DeferredIntrs;
414 for (AllocaAnalysis &AA : Allocas) {
415 if (AA.Vector.Ty) {
416 std::optional<TypeSize> Size = AA.Alloca->getAllocationSize(DL);
417 assert(Size); // Expected to succeed on non-array alloca.
418 const unsigned AllocaCost = Size->getFixedValue() * 8;
419 // First, check if we have enough budget to vectorize this alloca.
420 if (AllocaCost <= VectorizationBudget) {
421 promoteAllocaToVector(AA);
422 Changed = true;
423 assert((VectorizationBudget - AllocaCost) < VectorizationBudget &&
424 "Underflow!");
425 VectorizationBudget -= AllocaCost;
426 LLVM_DEBUG(dbgs() << " Remaining vectorization budget:"
427 << VectorizationBudget << "\n");
428 continue;
429 } else {
430 LLVM_DEBUG(dbgs() << "Alloca too big for vectorization (size:"
431 << AllocaCost << ", budget:" << VectorizationBudget
432 << "): " << *AA.Alloca << "\n");
433 }
434 }
435
436 if (AA.LDS.Enable &&
437 tryPromoteAllocaToLDS(AA, SufficientLDS, DeferredIntrs))
438 Changed = true;
439 }
440 finishDeferredAllocaToLDSPromotion(DeferredIntrs);
441
442 // NOTE: tryPromoteAllocaToVector removes the alloca, so Allocas contains
443 // dangling pointers. If we want to reuse it past this point, the loop above
444 // would need to be updated to remove successfully promoted allocas.
445
446 return Changed;
447}
448
449// Checks if the instruction I is a memset user of the alloca AI that we can
450// deal with. Currently, only non-volatile memsets that affect the whole alloca
451// are handled.
453 const DataLayout &DL) {
454 using namespace PatternMatch;
455 // For now we only care about non-volatile memsets that affect the whole type
456 // (start at index 0 and fill the whole alloca).
457 //
458 // TODO: Now that we moved to PromoteAlloca we could handle any memsets
459 // (except maybe volatile ones?) - we just need to use shufflevector if it
460 // only affects a subset of the vector.
461 const unsigned Size = DL.getTypeStoreSize(AI->getAllocatedType());
462 return I->getOperand(0) == AI &&
463 match(I->getOperand(2), m_SpecificInt(Size)) && !I->isVolatile();
464}
465
466static Value *calculateVectorIndex(Value *Ptr, AllocaAnalysis &AA) {
467 IRBuilder<> B(Ptr->getContext());
468
469 Ptr = Ptr->stripPointerCasts();
470 if (Ptr == AA.Alloca)
471 return B.getInt32(0);
472
473 auto *GEP = cast<GetElementPtrInst>(Ptr);
474 auto I = AA.Vector.GEPVectorIdx.find(GEP);
475 assert(I != AA.Vector.GEPVectorIdx.end() && "Must have entry for GEP!");
476
477 if (!I->second.Full) {
478 Value *Result = nullptr;
479 B.SetInsertPoint(GEP);
480
481 if (I->second.VarIndex) {
482 Result = I->second.VarIndex;
483 Result = B.CreateSExtOrTrunc(Result, B.getInt32Ty());
484
485 if (I->second.VarMul)
486 Result = B.CreateMul(Result, I->second.VarMul);
487
488 if (I->second.VarShift)
489 Result = B.CreateAShr(Result, I->second.VarShift, "", /*isExact*/ true);
490 }
491
492 if (I->second.ConstIndex) {
493 if (Result)
494 Result = B.CreateAdd(Result, I->second.ConstIndex);
495 else
496 Result = I->second.ConstIndex;
497 }
498
499 if (!Result)
500 Result = B.getInt32(0);
501
502 I->second.Full = Result;
503 }
504
505 return I->second.Full;
506}
507
508static std::optional<GEPToVectorIndex>
510 Type *VecElemTy, const DataLayout &DL) {
511 // TODO: Extracting a "multiple of X" from a GEP might be a useful generic
512 // helper.
513 LLVMContext &Ctx = GEP->getContext();
514 unsigned BW = DL.getIndexTypeSizeInBits(GEP->getType());
516 APInt ConstOffset(BW, 0);
517
518 // Walk backwards through nested GEPs to collect both constant and variable
519 // offsets, so that nested vector GEP chains can be lowered in one step.
520 //
521 // Given this IR fragment as input:
522 //
523 // %0 = alloca [10 x <2 x i32>], align 8, addrspace(5)
524 // %1 = getelementptr [10 x <2 x i32>], ptr addrspace(5) %0, i32 0, i32 %j
525 // %2 = getelementptr i8, ptr addrspace(5) %1, i32 4
526 // %3 = load i32, ptr addrspace(5) %2, align 4
527 //
528 // Combine both GEP operations in a single pass, producing:
529 // BasePtr = %0
530 // ConstOffset = 4
531 // VarOffsets = { %j -> element_size(<2 x i32>) }
532 //
533 // That lets us emit a single buffer_load directly into a VGPR, without ever
534 // allocating scratch memory for the intermediate pointer.
535 Value *CurPtr = GEP;
536 while (auto *CurGEP = dyn_cast<GetElementPtrInst>(CurPtr)) {
537 if (!CurGEP->collectOffset(DL, BW, VarOffsets, ConstOffset))
538 return {};
539
540 // Move to the next outer pointer.
541 CurPtr = CurGEP->getPointerOperand();
542 }
543
544 assert(CurPtr == Alloca && "GEP not based on alloca");
545
546 int64_t VecElemSize = DL.getTypeAllocSize(VecElemTy);
547 if (VarOffsets.size() > 1)
548 return {};
549
550 // We support vector indices of the form ((VarIndex * stride) >> shift) + B.
551 // IndexQuot represents B. Check that the constant offset is a multiple
552 // of the vector element size.
553 if (ConstOffset.srem(VecElemSize) != 0)
554 return {};
555 APInt IndexQuot = ConstOffset.sdiv(VecElemSize);
556
557 GEPToVectorIndex Result;
558
559 if (!ConstOffset.isZero())
560 Result.ConstIndex = ConstantInt::get(Ctx, IndexQuot.sextOrTrunc(BW));
561
562 // If there are no variable offsets, only a constant offset, then we're done.
563 if (VarOffsets.empty())
564 return Result;
565
566 // Scale is the stride in the (A * stride) part. Check that there is only one
567 // variable offset and extract the scale factor.
568 const auto &VarOffset = VarOffsets.front();
569 auto ScaleOpt = VarOffset.second.tryZExtValue();
570 if (!ScaleOpt || *ScaleOpt == 0)
571 return {};
572
573 uint64_t Scale = *ScaleOpt;
574 Result.VarIndex = VarOffset.first;
575 auto *OffsetType = dyn_cast<IntegerType>(Result.VarIndex->getType());
576 if (!OffsetType)
577 return {};
578
579 // The vector index for the variable part is: VarIndex * Scale / VecElemSize.
580 if (Scale >= (uint64_t)VecElemSize) {
581 if (Scale % VecElemSize != 0)
582 return {};
583
584 // Scale is a multiple of VecElemSize, so the index is just: VarIndex *
585 // (Scale / VecElemSize).
586 uint64_t VarMul = Scale / VecElemSize;
587 // Only the multiplier is needed.
588 if (VarMul != 1)
589 Result.VarMul = ConstantInt::get(Ctx, APInt(BW, VarMul));
590 } else {
591 if ((uint64_t)VecElemSize % Scale != 0)
592 return {};
593
594 // VecElemSize is a multiple of Scale, so the index is just: VarIndex /
595 // (VecElemSize / Scale).
596 uint64_t Divisor = VecElemSize / Scale;
597 // The divisor must be a power of 2 so we can use a right shift.
598 if (!isPowerOf2_64(Divisor))
599 return {};
600
601 // VarIndex must be known to be divisible by that divisor.
602 KnownBits KB = computeKnownBits(VarOffset.first, DL);
603 if (KB.countMinTrailingZeros() < Log2_64(Divisor))
604 return {};
605
606 Result.VarShift = ConstantInt::get(Ctx, APInt(BW, Log2_64(Divisor)));
607 }
608
609 return Result;
610}
611
612/// Promotes a single user of the alloca to a vector form.
613///
614/// \param Inst Instruction to be promoted.
615/// \param DL Module Data Layout.
616/// \param AA Alloca Analysis.
617/// \param VecStoreSize Size of \p VectorTy in bytes.
618/// \param ElementSize Size of \p VectorTy element type in bytes.
619/// \param CurVal Current value of the vector (e.g. last stored value)
620/// \param[out] DeferredLoads \p Inst is added to this vector if it can't
621/// be promoted now. This happens when promoting requires \p
622/// CurVal, but \p CurVal is nullptr.
623/// \return the stored value if \p Inst would have written to the alloca, or
624/// nullptr otherwise.
626 AllocaAnalysis &AA,
627 unsigned VecStoreSize,
628 unsigned ElementSize,
629 function_ref<Value *()> GetCurVal) {
630 // Note: we use InstSimplifyFolder because it can leverage the DataLayout
631 // to do more folding, especially in the case of vector splats.
634 Builder.SetInsertPoint(Inst);
635
636 Type *VecEltTy = AA.Vector.Ty->getElementType();
637
638 switch (Inst->getOpcode()) {
639 case Instruction::Load: {
640 Value *CurVal = GetCurVal();
641 Value *Index =
643
644 // We're loading the full vector.
645 Type *AccessTy = Inst->getType();
646 TypeSize AccessSize = DL.getTypeStoreSize(AccessTy);
647 if (Constant *CI = dyn_cast<Constant>(Index)) {
648 if (CI->isNullValue() && AccessSize == VecStoreSize) {
649 Inst->replaceAllUsesWith(
650 Builder.CreateBitPreservingCastChain(DL, CurVal, AccessTy));
651 return nullptr;
652 }
653 }
654
655 // Loading a subvector.
656 if (isa<FixedVectorType>(AccessTy)) {
657 assert(AccessSize.isKnownMultipleOf(DL.getTypeStoreSize(VecEltTy)));
658 const unsigned NumLoadedElts = AccessSize / DL.getTypeStoreSize(VecEltTy);
659 auto *SubVecTy = FixedVectorType::get(VecEltTy, NumLoadedElts);
660 assert(DL.getTypeStoreSize(SubVecTy) == DL.getTypeStoreSize(AccessTy));
661
662 // If idx is dynamic, then sandwich load with bitcasts.
663 // ie. VectorTy SubVecTy AccessTy
664 // <64 x i8> -> <16 x i8> <8 x i16>
665 // <64 x i8> -> <4 x i128> -> i128 -> <8 x i16>
666 // Extracting subvector with dynamic index has very large expansion in
667 // the amdgpu backend. Limit to pow2.
668 FixedVectorType *VectorTy = AA.Vector.Ty;
669 TypeSize NumBits = DL.getTypeStoreSize(SubVecTy) * 8u;
670 uint64_t LoadAlign = cast<LoadInst>(Inst)->getAlign().value();
671 bool IsAlignedLoad = NumBits <= (LoadAlign * 8u);
672 unsigned TotalNumElts = VectorTy->getNumElements();
673 bool IsProperlyDivisible = TotalNumElts % NumLoadedElts == 0;
674 if (!isa<ConstantInt>(Index) &&
675 llvm::isPowerOf2_32(SubVecTy->getNumElements()) &&
676 IsProperlyDivisible && IsAlignedLoad) {
677 IntegerType *NewElemTy = Builder.getIntNTy(NumBits);
678 const unsigned NewNumElts =
679 DL.getTypeStoreSize(VectorTy) * 8u / NumBits;
680 const unsigned LShrAmt = llvm::Log2_32(SubVecTy->getNumElements());
681 FixedVectorType *BitCastTy =
682 FixedVectorType::get(NewElemTy, NewNumElts);
683 Value *BCVal =
684 Builder.CreateBitPreservingCastChain(DL, CurVal, BitCastTy);
685 Value *NewIdx = Builder.CreateLShr(
686 Index, ConstantInt::get(Index->getType(), LShrAmt));
687 Value *ExtVal = Builder.CreateExtractElement(BCVal, NewIdx);
688 Value *BCOut =
689 Builder.CreateBitPreservingCastChain(DL, ExtVal, AccessTy);
690 Inst->replaceAllUsesWith(BCOut);
691 return nullptr;
692 }
693
694 Value *SubVec = PoisonValue::get(SubVecTy);
695 for (unsigned K = 0; K < NumLoadedElts; ++K) {
696 Value *CurIdx =
697 Builder.CreateAdd(Index, ConstantInt::get(Index->getType(), K));
698 SubVec = Builder.CreateInsertElement(
699 SubVec, Builder.CreateExtractElement(CurVal, CurIdx), K);
700 }
701
702 Inst->replaceAllUsesWith(
703 Builder.CreateBitPreservingCastChain(DL, SubVec, AccessTy));
704 return nullptr;
705 }
706
707 // We're loading one element.
708 Value *ExtractElement = Builder.CreateExtractElement(CurVal, Index);
709 if (AccessTy != VecEltTy)
710 ExtractElement = Builder.CreateBitOrPointerCast(ExtractElement, AccessTy);
711
712 Inst->replaceAllUsesWith(ExtractElement);
713 return nullptr;
714 }
715 case Instruction::Store: {
716 // For stores, it's a bit trickier and it depends on whether we're storing
717 // the full vector or not. If we're storing the full vector, we don't need
718 // to know the current value. If this is a store of a single element, we
719 // need to know the value.
721 Value *Index = calculateVectorIndex(SI->getPointerOperand(), AA);
722 Value *Val = SI->getValueOperand();
723
724 // We're storing the full vector, we can handle this without knowing CurVal.
725 Type *AccessTy = Val->getType();
726 TypeSize AccessSize = DL.getTypeStoreSize(AccessTy);
727 if (Constant *CI = dyn_cast<Constant>(Index))
728 if (CI->isNullValue() && AccessSize == VecStoreSize)
729 return Builder.CreateBitPreservingCastChain(DL, Val, AA.Vector.Ty);
730
731 // Storing a subvector.
732 if (isa<FixedVectorType>(AccessTy)) {
733 assert(AccessSize.isKnownMultipleOf(DL.getTypeStoreSize(VecEltTy)));
734 const unsigned NumWrittenElts =
735 AccessSize / DL.getTypeStoreSize(VecEltTy);
736 const unsigned NumVecElts = AA.Vector.Ty->getNumElements();
737 auto *SubVecTy = FixedVectorType::get(VecEltTy, NumWrittenElts);
738 assert(DL.getTypeStoreSize(SubVecTy) == DL.getTypeStoreSize(AccessTy));
739
740 Val = Builder.CreateBitPreservingCastChain(DL, Val, SubVecTy);
741 Value *CurVec = GetCurVal();
742 for (unsigned K = 0, NumElts = std::min(NumWrittenElts, NumVecElts);
743 K < NumElts; ++K) {
744 Value *CurIdx =
745 Builder.CreateAdd(Index, ConstantInt::get(Index->getType(), K));
746 CurVec = Builder.CreateInsertElement(
747 CurVec, Builder.CreateExtractElement(Val, K), CurIdx);
748 }
749 return CurVec;
750 }
751
752 if (Val->getType() != VecEltTy)
753 Val = Builder.CreateBitOrPointerCast(Val, VecEltTy);
754 return Builder.CreateInsertElement(GetCurVal(), Val, Index);
755 }
756 case Instruction::Call: {
757 if (auto *MTI = dyn_cast<MemTransferInst>(Inst)) {
758 // For memcpy, we need to know curval.
759 ConstantInt *Length = cast<ConstantInt>(MTI->getLength());
760 unsigned NumCopied = Length->getZExtValue() / ElementSize;
761 MemTransferInfo *TI = &AA.Vector.TransferInfo[MTI];
762 unsigned SrcBegin = TI->SrcIndex->getZExtValue();
763 unsigned DestBegin = TI->DestIndex->getZExtValue();
764
765 SmallVector<int> Mask;
766 for (unsigned Idx = 0; Idx < AA.Vector.Ty->getNumElements(); ++Idx) {
767 if (Idx >= DestBegin && Idx < DestBegin + NumCopied) {
768 Mask.push_back(SrcBegin < AA.Vector.Ty->getNumElements()
769 ? SrcBegin++
771 } else {
772 Mask.push_back(Idx);
773 }
774 }
775
776 return Builder.CreateShuffleVector(GetCurVal(), Mask);
777 }
778
779 if (auto *MSI = dyn_cast<MemSetInst>(Inst)) {
780 // For memset, we don't need to know the previous value because we
781 // currently only allow memsets that cover the whole alloca.
782 Value *Elt = MSI->getOperand(1);
783 const unsigned BytesPerElt = DL.getTypeStoreSize(VecEltTy);
784 if (BytesPerElt > 1) {
785 Value *EltBytes = Builder.CreateVectorSplat(BytesPerElt, Elt);
786
787 // If the element type of the vector is a pointer, we need to first cast
788 // to an integer, then use a PtrCast.
789 if (VecEltTy->isPointerTy()) {
790 Type *PtrInt = Builder.getIntNTy(BytesPerElt * 8);
791 Elt = Builder.CreateBitCast(EltBytes, PtrInt);
792 Elt = Builder.CreateIntToPtr(Elt, VecEltTy);
793 } else
794 Elt = Builder.CreateBitCast(EltBytes, VecEltTy);
795 }
796
797 return Builder.CreateVectorSplat(AA.Vector.Ty->getElementCount(), Elt);
798 }
799
800 if (auto *Intr = dyn_cast<IntrinsicInst>(Inst)) {
801 if (Intr->getIntrinsicID() == Intrinsic::objectsize) {
802 Intr->replaceAllUsesWith(
803 Builder.getIntN(Intr->getType()->getIntegerBitWidth(),
804 DL.getTypeAllocSize(AA.Vector.Ty)));
805 return nullptr;
806 }
807 }
808
809 llvm_unreachable("Unsupported call when promoting alloca to vector");
810 }
811
812 default:
813 llvm_unreachable("Inconsistency in instructions promotable to vector");
814 }
815
816 llvm_unreachable("Did not return after promoting instruction!");
817}
818
819static bool isSupportedAccessType(FixedVectorType *VecTy, Type *AccessTy,
820 const DataLayout &DL) {
821 // Access as a vector type can work if the size of the access vector is a
822 // multiple of the size of the alloca's vector element type.
823 //
824 // Examples:
825 // - VecTy = <8 x float>, AccessTy = <4 x float> -> OK
826 // - VecTy = <4 x double>, AccessTy = <2 x float> -> OK
827 // - VecTy = <4 x double>, AccessTy = <3 x float> -> NOT OK
828 // - 3*32 is not a multiple of 64
829 //
830 // We could handle more complicated cases, but it'd make things a lot more
831 // complicated.
832 if (isa<FixedVectorType>(AccessTy)) {
833 TypeSize AccTS = DL.getTypeStoreSize(AccessTy);
834 // If the type size and the store size don't match, we would need to do more
835 // than just bitcast to translate between an extracted/insertable subvectors
836 // and the accessed value.
837 if (AccTS * 8 != DL.getTypeSizeInBits(AccessTy))
838 return false;
839 TypeSize VecTS = DL.getTypeStoreSize(VecTy->getElementType());
840 return AccTS.isKnownMultipleOf(VecTS);
841 }
842
844 DL);
845}
846
847/// Iterates over an instruction worklist that may contain multiple instructions
848/// from the same basic block, but in a different order.
849template <typename InstContainer>
850static void forEachWorkListItem(const InstContainer &WorkList,
851 std::function<void(Instruction *)> Fn) {
852 // Bucket up uses of the alloca by the block they occur in.
853 // This is important because we have to handle multiple defs/uses in a block
854 // ourselves: SSAUpdater is purely for cross-block references.
856 for (Instruction *User : WorkList)
857 UsesByBlock[User->getParent()].insert(User);
858
859 for (Instruction *User : WorkList) {
860 BasicBlock *BB = User->getParent();
861 auto &BlockUses = UsesByBlock[BB];
862
863 // Already processed, skip.
864 if (BlockUses.empty())
865 continue;
866
867 // Only user in the block, directly process it.
868 if (BlockUses.size() == 1) {
869 Fn(User);
870 continue;
871 }
872
873 // Multiple users in the block, do a linear scan to see users in order.
874 for (Instruction &Inst : *BB) {
875 if (!BlockUses.contains(&Inst))
876 continue;
877
878 Fn(&Inst);
879 }
880
881 // Clear the block so we know it's been processed.
882 BlockUses.clear();
883 }
884}
885
886/// Find an insert point after an alloca, after all other allocas clustered at
887/// the start of the block.
890 for (BasicBlock::iterator E = BB.end(); I != E && isa<AllocaInst>(*I); ++I)
891 ;
892 return I;
893}
894
896AMDGPUPromoteAllocaImpl::getVectorTypeForAlloca(Type *AllocaTy) const {
897 if (DisablePromoteAllocaToVector) {
898 LLVM_DEBUG(dbgs() << " Promote alloca to vectors is disabled\n");
899 return nullptr;
900 }
901
902 auto *VectorTy = dyn_cast<FixedVectorType>(AllocaTy);
903 if (auto *ArrayTy = dyn_cast<ArrayType>(AllocaTy)) {
904 uint64_t NumElems = 1;
905 Type *ElemTy;
906 do {
907 NumElems *= ArrayTy->getNumElements();
908 ElemTy = ArrayTy->getElementType();
909 } while ((ArrayTy = dyn_cast<ArrayType>(ElemTy)));
910
911 // Check for array of vectors
912 auto *InnerVectorTy = dyn_cast<FixedVectorType>(ElemTy);
913 if (InnerVectorTy) {
914 NumElems *= InnerVectorTy->getNumElements();
915 ElemTy = InnerVectorTy->getElementType();
916 }
917
918 if (VectorType::isValidElementType(ElemTy) && NumElems > 0) {
919 unsigned ElementSize = DL.getTypeSizeInBits(ElemTy) / 8;
920 if (ElementSize > 0) {
921 unsigned AllocaSize = DL.getTypeStoreSize(AllocaTy);
922 // Expand vector if required to match padding of inner type,
923 // i.e. odd size subvectors.
924 // Storage size of new vector must match that of alloca for correct
925 // behaviour of byte offsets and GEP computation.
926 if (NumElems * ElementSize != AllocaSize)
927 NumElems = AllocaSize / ElementSize;
928 if (NumElems > 0 && (AllocaSize % ElementSize) == 0)
929 VectorTy = FixedVectorType::get(ElemTy, NumElems);
930 }
931 }
932 }
933 if (!VectorTy) {
934 LLVM_DEBUG(dbgs() << " Cannot convert type to vector\n");
935 return nullptr;
936 }
937
938 const unsigned MaxElements =
939 (MaxVectorRegs * 32) / DL.getTypeSizeInBits(VectorTy->getElementType());
940
941 if (VectorTy->getNumElements() > MaxElements ||
942 VectorTy->getNumElements() < 2) {
943 LLVM_DEBUG(dbgs() << " " << *VectorTy
944 << " has an unsupported number of elements\n");
945 return nullptr;
946 }
947
948 Type *VecEltTy = VectorTy->getElementType();
949 unsigned ElementSizeInBits = DL.getTypeSizeInBits(VecEltTy);
950 if (ElementSizeInBits != DL.getTypeAllocSizeInBits(VecEltTy)) {
951 LLVM_DEBUG(dbgs() << " Cannot convert to vector if the allocation size "
952 "does not match the type's size\n");
953 return nullptr;
954 }
955
956 return VectorTy;
957}
958
959void AMDGPUPromoteAllocaImpl::analyzePromoteToVector(AllocaAnalysis &AA) const {
960 if (AA.HaveSelectOrPHI) {
961 LLVM_DEBUG(dbgs() << " Cannot convert to vector due to select or phi\n");
962 return;
963 }
964
965 Type *AllocaTy = AA.Alloca->getAllocatedType();
966 AA.Vector.Ty = getVectorTypeForAlloca(AllocaTy);
967 if (!AA.Vector.Ty)
968 return;
969
970 const auto RejectUser = [&](Instruction *Inst, Twine Msg) {
971 LLVM_DEBUG(dbgs() << " Cannot promote alloca to vector: " << Msg << "\n"
972 << " " << *Inst << "\n");
973 AA.Vector.Ty = nullptr;
974 };
975
976 Type *VecEltTy = AA.Vector.Ty->getElementType();
977 unsigned ElementSize = DL.getTypeSizeInBits(VecEltTy) / 8;
978 assert(ElementSize > 0);
979 for (auto *U : AA.Uses) {
980 Instruction *Inst = cast<Instruction>(U->getUser());
981
982 if (Value *Ptr = getLoadStorePointerOperand(Inst)) {
983 assert(!isa<StoreInst>(Inst) ||
984 U->getOperandNo() == StoreInst::getPointerOperandIndex());
985
986 Type *AccessTy = getLoadStoreType(Inst);
987 if (AccessTy->isAggregateType())
988 return RejectUser(Inst, "unsupported load/store as aggregate");
989 assert(!AccessTy->isAggregateType() || AccessTy->isArrayTy());
990
991 // Check that this is a simple access of a vector element.
992 bool IsSimple = isa<LoadInst>(Inst) ? cast<LoadInst>(Inst)->isSimple()
993 : cast<StoreInst>(Inst)->isSimple();
994 if (!IsSimple)
995 return RejectUser(Inst, "not a simple load or store");
996
997 Ptr = Ptr->stripPointerCasts();
998
999 // Alloca already accessed as vector.
1000 if (Ptr == AA.Alloca &&
1001 DL.getTypeStoreSize(AA.Alloca->getAllocatedType()) ==
1002 DL.getTypeStoreSize(AccessTy)) {
1003 AA.Vector.Worklist.push_back(Inst);
1004 continue;
1005 }
1006
1007 if (!isSupportedAccessType(AA.Vector.Ty, AccessTy, DL))
1008 return RejectUser(Inst, "not a supported access type");
1009
1010 AA.Vector.Worklist.push_back(Inst);
1011 continue;
1012 }
1013
1014 if (auto *GEP = dyn_cast<GetElementPtrInst>(Inst)) {
1015 // If we can't compute a vector index from this GEP, then we can't
1016 // promote this alloca to vector.
1017 auto Index = computeGEPToVectorIndex(GEP, AA.Alloca, VecEltTy, DL);
1018 if (!Index)
1019 return RejectUser(Inst, "cannot compute vector index for GEP");
1020
1021 AA.Vector.GEPVectorIdx[GEP] = std::move(Index.value());
1022 AA.Vector.UsersToRemove.push_back(Inst);
1023 continue;
1024 }
1025
1026 if (MemSetInst *MSI = dyn_cast<MemSetInst>(Inst);
1027 MSI && isSupportedMemset(MSI, AA.Alloca, DL)) {
1028 AA.Vector.Worklist.push_back(Inst);
1029 continue;
1030 }
1031
1032 if (MemTransferInst *TransferInst = dyn_cast<MemTransferInst>(Inst)) {
1033 if (TransferInst->isVolatile())
1034 return RejectUser(Inst, "mem transfer inst is volatile");
1035
1036 ConstantInt *Len = dyn_cast<ConstantInt>(TransferInst->getLength());
1037 if (!Len || (Len->getZExtValue() % ElementSize))
1038 return RejectUser(Inst, "mem transfer inst length is non-constant or "
1039 "not a multiple of the vector element size");
1040
1041 auto getConstIndexIntoAlloca = [&](Value *Ptr) -> ConstantInt * {
1042 if (Ptr == AA.Alloca)
1043 return ConstantInt::get(Ptr->getContext(), APInt(32, 0));
1044
1046 const auto &GEPI = AA.Vector.GEPVectorIdx.find(GEP)->second;
1047 if (GEPI.VarIndex)
1048 return nullptr;
1049 if (GEPI.ConstIndex)
1050 return GEPI.ConstIndex;
1051 return ConstantInt::get(Ptr->getContext(), APInt(32, 0));
1052 };
1053
1054 MemTransferInfo *TI =
1055 &AA.Vector.TransferInfo.try_emplace(TransferInst).first->second;
1056 unsigned OpNum = U->getOperandNo();
1057 if (OpNum == 0) {
1058 Value *Dest = TransferInst->getDest();
1059 ConstantInt *Index = getConstIndexIntoAlloca(Dest);
1060 if (!Index)
1061 return RejectUser(Inst, "could not calculate constant dest index");
1062 TI->DestIndex = Index;
1063 } else {
1064 assert(OpNum == 1);
1065 Value *Src = TransferInst->getSource();
1066 ConstantInt *Index = getConstIndexIntoAlloca(Src);
1067 if (!Index)
1068 return RejectUser(Inst, "could not calculate constant src index");
1069 TI->SrcIndex = Index;
1070 }
1071 continue;
1072 }
1073
1074 if (auto *Intr = dyn_cast<IntrinsicInst>(Inst)) {
1075 if (Intr->getIntrinsicID() == Intrinsic::objectsize) {
1076 AA.Vector.Worklist.push_back(Inst);
1077 continue;
1078 }
1079 }
1080
1081 // Ignore assume-like intrinsics and comparisons used in assumes.
1082 if (isAssumeLikeIntrinsic(Inst)) {
1083 if (!Inst->use_empty())
1084 return RejectUser(Inst, "assume-like intrinsic cannot have any users");
1085 AA.Vector.UsersToRemove.push_back(Inst);
1086 continue;
1087 }
1088
1089 if (isa<ICmpInst>(Inst) && all_of(Inst->users(), [](User *U) {
1090 return isAssumeLikeIntrinsic(cast<Instruction>(U));
1091 })) {
1092 AA.Vector.UsersToRemove.push_back(Inst);
1093 continue;
1094 }
1095
1096 return RejectUser(Inst, "unhandled alloca user");
1097 }
1098
1099 // Follow-up check to ensure we've seen both sides of all transfer insts.
1100 for (const auto &Entry : AA.Vector.TransferInfo) {
1101 const MemTransferInfo &TI = Entry.second;
1102 if (!TI.SrcIndex || !TI.DestIndex)
1103 return RejectUser(Entry.first,
1104 "mem transfer inst between different objects");
1105 AA.Vector.Worklist.push_back(Entry.first);
1106 }
1107}
1108
1109void AMDGPUPromoteAllocaImpl::promoteAllocaToVector(AllocaAnalysis &AA) {
1110 LLVM_DEBUG(dbgs() << "Promoting to vectors: " << *AA.Alloca << '\n');
1111 LLVM_DEBUG(dbgs() << " type conversion: " << *AA.Alloca->getAllocatedType()
1112 << " -> " << *AA.Vector.Ty << '\n');
1113 const unsigned VecStoreSize = DL.getTypeStoreSize(AA.Vector.Ty);
1114
1115 Type *VecEltTy = AA.Vector.Ty->getElementType();
1116 const unsigned ElementSize = DL.getTypeSizeInBits(VecEltTy) / 8;
1117
1118 // Alloca is uninitialized memory. Imitate that by making the first value
1119 // undef.
1120 SSAUpdater Updater;
1121 Updater.Initialize(AA.Vector.Ty, "promotealloca");
1122
1123 BasicBlock *EntryBB = AA.Alloca->getParent();
1124 BasicBlock::iterator InitInsertPos =
1125 skipToNonAllocaInsertPt(*EntryBB, AA.Alloca->getIterator());
1126 IRBuilder<> Builder(&*InitInsertPos);
1127 Value *AllocaInitValue = Builder.CreateFreeze(PoisonValue::get(AA.Vector.Ty));
1128 AllocaInitValue->takeName(AA.Alloca);
1129
1130 Updater.AddAvailableValue(AA.Alloca->getParent(), AllocaInitValue);
1131
1132 // First handle the initial worklist, in basic block order.
1133 //
1134 // Insert a placeholder whenever we need the vector value at the top of a
1135 // basic block.
1137 forEachWorkListItem(AA.Vector.Worklist, [&](Instruction *I) {
1138 BasicBlock *BB = I->getParent();
1139 auto GetCurVal = [&]() -> Value * {
1140 if (Value *CurVal = Updater.FindValueForBlock(BB))
1141 return CurVal;
1142
1143 if (!Placeholders.empty() && Placeholders.back()->getParent() == BB)
1144 return Placeholders.back();
1145
1146 // If the current value in the basic block is not yet known, insert a
1147 // placeholder that we will replace later.
1148 IRBuilder<> Builder(I);
1149 auto *Placeholder = cast<Instruction>(Builder.CreateFreeze(
1150 PoisonValue::get(AA.Vector.Ty), "promotealloca.placeholder"));
1151 Placeholders.insert(Placeholder);
1152 return Placeholders.back();
1153 };
1154
1155 Value *Result = promoteAllocaUserToVector(I, DL, AA, VecStoreSize,
1156 ElementSize, GetCurVal);
1157 // If the returned result is a placeholder, it means the instruction does
1158 // not really modify the alloca. So no need to make it being available value
1159 // to SSAUpdater.
1160 // This will stop placeholder being cached in SSAUpdater. The cached
1161 // placeholder may cause stale pointer being referenced when doing
1162 // placeholder replacement.
1163 if (Result && (!isa<Instruction>(Result) ||
1164 !Placeholders.contains(cast<Instruction>(Result))))
1165 Updater.AddAvailableValue(BB, Result);
1166 });
1167
1168 // Now fixup the placeholders.
1169 for (Instruction *Placeholder : Placeholders) {
1170 Placeholder->replaceAllUsesWith(
1171 Updater.GetValueInMiddleOfBlock(Placeholder->getParent()));
1172 Placeholder->eraseFromParent();
1173 }
1174
1175 // Delete all instructions.
1176 for (Instruction *I : AA.Vector.Worklist) {
1177 assert(I->use_empty());
1178 I->eraseFromParent();
1179 }
1180
1181 // Delete all the users that are known to be removeable.
1182 for (Instruction *I : reverse(AA.Vector.UsersToRemove)) {
1183 I->dropDroppableUses();
1184 assert(I->use_empty());
1185 I->eraseFromParent();
1186 }
1187
1188 // Alloca should now be dead too.
1189 assert(AA.Alloca->use_empty());
1190 AA.Alloca->eraseFromParent();
1191}
1192
1193std::pair<Value *, Value *>
1194AMDGPUPromoteAllocaImpl::getLocalSizeYZ(IRBuilder<> &Builder) {
1195 Function &F = *Builder.GetInsertBlock()->getParent();
1197
1198 if (!IsAMDHSA) {
1199 CallInst *LocalSizeY = Builder.CreateIntrinsicWithoutFolding(
1200 Intrinsic::r600_read_local_size_y, {});
1201 CallInst *LocalSizeZ = Builder.CreateIntrinsicWithoutFolding(
1202 Intrinsic::r600_read_local_size_z, {});
1203
1204 ST.makeLIDRangeMetadata(LocalSizeY);
1205 ST.makeLIDRangeMetadata(LocalSizeZ);
1206
1207 return std::pair(LocalSizeY, LocalSizeZ);
1208 }
1209
1210 // We must read the size out of the dispatch pointer.
1211 assert(IsAMDGCN);
1212
1213 // We are indexing into this struct, and want to extract the workgroup_size_*
1214 // fields.
1215 //
1216 // typedef struct hsa_kernel_dispatch_packet_s {
1217 // uint16_t header;
1218 // uint16_t setup;
1219 // uint16_t workgroup_size_x ;
1220 // uint16_t workgroup_size_y;
1221 // uint16_t workgroup_size_z;
1222 // uint16_t reserved0;
1223 // uint32_t grid_size_x ;
1224 // uint32_t grid_size_y ;
1225 // uint32_t grid_size_z;
1226 //
1227 // uint32_t private_segment_size;
1228 // uint32_t group_segment_size;
1229 // uint64_t kernel_object;
1230 //
1231 // #ifdef HSA_LARGE_MODEL
1232 // void *kernarg_address;
1233 // #elif defined HSA_LITTLE_ENDIAN
1234 // void *kernarg_address;
1235 // uint32_t reserved1;
1236 // #else
1237 // uint32_t reserved1;
1238 // void *kernarg_address;
1239 // #endif
1240 // uint64_t reserved2;
1241 // hsa_signal_t completion_signal; // uint64_t wrapper
1242 // } hsa_kernel_dispatch_packet_t
1243 //
1244 CallInst *DispatchPtr =
1245 Builder.CreateIntrinsicWithoutFolding(Intrinsic::amdgcn_dispatch_ptr, {});
1246 DispatchPtr->addRetAttr(Attribute::NoAlias);
1247 DispatchPtr->addRetAttr(Attribute::NonNull);
1248 F.removeFnAttr("amdgpu-no-dispatch-ptr");
1249
1250 // Size of the dispatch packet struct.
1251 DispatchPtr->addDereferenceableRetAttr(64);
1252
1253 Type *I32Ty = Type::getInt32Ty(Mod.getContext());
1254
1255 // We could do a single 64-bit load here, but it's likely that the basic
1256 // 32-bit and extract sequence is already present, and it is probably easier
1257 // to CSE this. The loads should be mergeable later anyway.
1258 Value *GEPXY = Builder.CreateConstInBoundsGEP1_64(I32Ty, DispatchPtr, 1);
1259 LoadInst *LoadXY = Builder.CreateAlignedLoad(I32Ty, GEPXY, Align(4));
1260
1261 Value *GEPZU = Builder.CreateConstInBoundsGEP1_64(I32Ty, DispatchPtr, 2);
1262 LoadInst *LoadZU = Builder.CreateAlignedLoad(I32Ty, GEPZU, Align(4));
1263
1264 MDNode *MD = MDNode::get(Mod.getContext(), {});
1265 LoadXY->setMetadata(LLVMContext::MD_invariant_load, MD);
1266 LoadZU->setMetadata(LLVMContext::MD_invariant_load, MD);
1267 ST.makeLIDRangeMetadata(LoadZU);
1268
1269 // Extract y component. Upper half of LoadZU should be zero already.
1270 Value *Y = Builder.CreateLShr(LoadXY, 16);
1271
1272 return std::pair(Y, LoadZU);
1273}
1274
1275Value *AMDGPUPromoteAllocaImpl::getWorkitemID(IRBuilder<> &Builder,
1276 unsigned N) {
1277 Function *F = Builder.GetInsertBlock()->getParent();
1280 StringRef AttrName;
1281
1282 switch (N) {
1283 case 0:
1284 IntrID = IsAMDGCN ? (Intrinsic::ID)Intrinsic::amdgcn_workitem_id_x
1285 : (Intrinsic::ID)Intrinsic::r600_read_tidig_x;
1286 AttrName = "amdgpu-no-workitem-id-x";
1287 break;
1288 case 1:
1289 IntrID = IsAMDGCN ? (Intrinsic::ID)Intrinsic::amdgcn_workitem_id_y
1290 : (Intrinsic::ID)Intrinsic::r600_read_tidig_y;
1291 AttrName = "amdgpu-no-workitem-id-y";
1292 break;
1293
1294 case 2:
1295 IntrID = IsAMDGCN ? (Intrinsic::ID)Intrinsic::amdgcn_workitem_id_z
1296 : (Intrinsic::ID)Intrinsic::r600_read_tidig_z;
1297 AttrName = "amdgpu-no-workitem-id-z";
1298 break;
1299 default:
1300 llvm_unreachable("invalid dimension");
1301 }
1302
1303 Function *WorkitemIdFn = Intrinsic::getOrInsertDeclaration(&Mod, IntrID);
1304 CallInst *CI = Builder.CreateCall(WorkitemIdFn);
1305 ST.makeLIDRangeMetadata(CI);
1306 F->removeFnAttr(AttrName);
1307
1308 return CI;
1309}
1310
1311static bool isCallPromotable(CallInst *CI) {
1313 if (!II)
1314 return false;
1315
1316 switch (II->getIntrinsicID()) {
1317 case Intrinsic::memcpy:
1318 case Intrinsic::memmove:
1319 case Intrinsic::memset:
1320 case Intrinsic::lifetime_start:
1321 case Intrinsic::lifetime_end:
1322 case Intrinsic::invariant_start:
1323 case Intrinsic::invariant_end:
1324 case Intrinsic::launder_invariant_group:
1325 case Intrinsic::strip_invariant_group:
1326 case Intrinsic::objectsize:
1327 return true;
1328 default:
1329 return false;
1330 }
1331}
1332
1333bool AMDGPUPromoteAllocaImpl::binaryOpIsDerivedFromSameAlloca(
1334 Value *BaseAlloca, Value *Val, Instruction *Inst, int OpIdx0,
1335 int OpIdx1) const {
1336 // Figure out which operand is the one we might not be promoting.
1337 Value *OtherOp = Inst->getOperand(OpIdx0);
1338 if (Val == OtherOp)
1339 OtherOp = Inst->getOperand(OpIdx1);
1340
1342 return true;
1343
1344 // TODO: getUnderlyingObject will not work on a vector getelementptr
1345 Value *OtherObj = getUnderlyingObject(OtherOp);
1346 if (!isa<AllocaInst>(OtherObj))
1347 return false;
1348
1349 // TODO: We should be able to replace undefs with the right pointer type.
1350
1351 // TODO: If we know the other base object is another promotable
1352 // alloca, not necessarily this alloca, we can do this. The
1353 // important part is both must have the same address space at
1354 // the end.
1355 if (OtherObj != BaseAlloca) {
1356 LLVM_DEBUG(
1357 dbgs() << "Found a binary instruction with another alloca object\n");
1358 return false;
1359 }
1360
1361 return true;
1362}
1363
1364void AMDGPUPromoteAllocaImpl::analyzePromoteToLDS(AllocaAnalysis &AA) const {
1365 if (DisablePromoteAllocaToLDS) {
1366 LLVM_DEBUG(dbgs() << " Promote alloca to LDS is disabled\n");
1367 return;
1368 }
1369
1370 // Don't promote the alloca to LDS for shader calling conventions as the work
1371 // item ID intrinsics are not supported for these calling conventions.
1372 // Furthermore not all LDS is available for some of the stages.
1373 const Function &ContainingFunction = *AA.Alloca->getFunction();
1374 CallingConv::ID CC = ContainingFunction.getCallingConv();
1375
1376 switch (CC) {
1379 break;
1380 default:
1381 LLVM_DEBUG(
1382 dbgs()
1383 << " promote alloca to LDS not supported with calling convention.\n");
1384 return;
1385 }
1386
1387 for (Use *Use : AA.Uses) {
1388 auto *User = Use->getUser();
1389
1390 if (CallInst *CI = dyn_cast<CallInst>(User)) {
1391 if (!isCallPromotable(CI))
1392 return;
1393
1394 if (find(AA.LDS.Worklist, User) == AA.LDS.Worklist.end())
1395 AA.LDS.Worklist.push_back(User);
1396 continue;
1397 }
1398
1400 if (UseInst->getOpcode() == Instruction::PtrToInt)
1401 return;
1402
1403 if (LoadInst *LI = dyn_cast<LoadInst>(UseInst)) {
1404 if (LI->isVolatile())
1405 return;
1406 continue;
1407 }
1408
1409 if (StoreInst *SI = dyn_cast<StoreInst>(UseInst)) {
1410 if (SI->isVolatile())
1411 return;
1412 continue;
1413 }
1414
1415 if (AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(UseInst)) {
1416 if (RMW->isVolatile())
1417 return;
1418 continue;
1419 }
1420
1421 if (AtomicCmpXchgInst *CAS = dyn_cast<AtomicCmpXchgInst>(UseInst)) {
1422 if (CAS->isVolatile())
1423 return;
1424 continue;
1425 }
1426
1427 // Only promote a select if we know that the other select operand
1428 // is from another pointer that will also be promoted.
1429 if (ICmpInst *ICmp = dyn_cast<ICmpInst>(UseInst)) {
1430 if (!binaryOpIsDerivedFromSameAlloca(AA.Alloca, Use->get(), ICmp, 0, 1))
1431 return;
1432
1433 // May need to rewrite constant operands.
1434 if (find(AA.LDS.Worklist, User) == AA.LDS.Worklist.end())
1435 AA.LDS.Worklist.push_back(ICmp);
1436 continue;
1437 }
1438
1440 // Be conservative if an address could be computed outside the bounds of
1441 // the alloca.
1442 if (!GEP->isInBounds())
1443 return;
1445 // Do not promote vector/aggregate type instructions. It is hard to track
1446 // their users.
1447
1448 // Do not promote addrspacecast.
1449 //
1450 // TODO: If we know the address is only observed through flat pointers, we
1451 // could still promote.
1452 return;
1453 }
1454
1455 if (find(AA.LDS.Worklist, User) == AA.LDS.Worklist.end())
1456 AA.LDS.Worklist.push_back(User);
1457 }
1458
1459 AA.LDS.Enable = true;
1460}
1461
1462bool AMDGPUPromoteAllocaImpl::hasSufficientLocalMem(const Function &F) {
1463
1464 FunctionType *FTy = F.getFunctionType();
1466
1467 // If the function has any arguments in the local address space, then it's
1468 // possible these arguments require the entire local memory space, so
1469 // we cannot use local memory in the pass.
1470 for (Type *ParamTy : FTy->params()) {
1471 PointerType *PtrTy = dyn_cast<PointerType>(ParamTy);
1472 if (PtrTy && PtrTy->getAddressSpace() == AMDGPUAS::LOCAL_ADDRESS) {
1473 LocalMemLimit = 0;
1474 LLVM_DEBUG(dbgs() << "Function has local memory argument. Promoting to "
1475 "local memory disabled.\n");
1476 return false;
1477 }
1478 }
1479
1480 LocalMemLimit = ST.getAddressableLocalMemorySize();
1481 if (LocalMemLimit == 0)
1482 return false;
1483
1485 SmallPtrSet<const Constant *, 8> VisitedConstants;
1487
1488 auto visitUsers = [&](const GlobalVariable *GV, const Constant *Val) -> bool {
1489 for (const User *U : Val->users()) {
1490 if (const Instruction *Use = dyn_cast<Instruction>(U)) {
1491 if (Use->getFunction() == &F)
1492 return true;
1493 } else {
1494 const Constant *C = cast<Constant>(U);
1495 if (VisitedConstants.insert(C).second)
1496 Stack.push_back(C);
1497 }
1498 }
1499
1500 return false;
1501 };
1502
1503 for (GlobalVariable &GV : Mod.globals()) {
1505 continue;
1506
1507 if (visitUsers(&GV, &GV)) {
1508 UsedLDS.insert(&GV);
1509 Stack.clear();
1510 continue;
1511 }
1512
1513 // For any ConstantExpr uses, we need to recursively search the users until
1514 // we see a function.
1515 while (!Stack.empty()) {
1516 const Constant *C = Stack.pop_back_val();
1517 if (visitUsers(&GV, C)) {
1518 UsedLDS.insert(&GV);
1519 Stack.clear();
1520 break;
1521 }
1522 }
1523 }
1524
1525 SmallVector<std::pair<uint64_t, Align>, 16> AllocatedSizes;
1526 AllocatedSizes.reserve(UsedLDS.size());
1527
1528 for (const GlobalVariable *GV : UsedLDS) {
1529 Align Alignment =
1530 DL.getValueOrABITypeAlignment(GV->getAlign(), GV->getValueType());
1531 uint64_t AllocSize = GV->getGlobalSize(DL);
1532
1533 // HIP uses an extern unsized array in local address space for dynamically
1534 // allocated shared memory. In that case, we have to disable the promotion.
1535 if (GV->hasExternalLinkage() && AllocSize == 0) {
1536 LocalMemLimit = 0;
1537 LLVM_DEBUG(dbgs() << "Function has a reference to externally allocated "
1538 "local memory. Promoting to local memory "
1539 "disabled.\n");
1540 return false;
1541 }
1542
1543 AllocatedSizes.emplace_back(AllocSize, Alignment);
1544 }
1545
1546 // Sort to try to estimate the worst case alignment padding
1547 //
1548 // FIXME: We should really do something to fix the addresses to a more optimal
1549 // value instead
1550 llvm::sort(AllocatedSizes, llvm::less_second());
1551
1552 // Check how much local memory is being used by global objects
1553 CurrentLocalMemUsage = 0;
1554
1555 // FIXME: Try to account for padding here. The real padding and address is
1556 // currently determined from the inverse order of uses in the function when
1557 // legalizing, which could also potentially change. We try to estimate the
1558 // worst case here, but we probably should fix the addresses earlier.
1559 for (auto Alloc : AllocatedSizes) {
1560 CurrentLocalMemUsage = alignTo(CurrentLocalMemUsage, Alloc.second);
1561 CurrentLocalMemUsage += Alloc.first;
1562 }
1563
1564 unsigned MaxOccupancy =
1565 ST.getWavesPerEU(ST.getFlatWorkGroupSizes(F), CurrentLocalMemUsage, F)
1566 .second;
1567
1568 // Round up to the next tier of usage.
1569 unsigned MaxSizeWithWaveCount =
1570 ST.getMaxLocalMemSizeWithWaveCount(MaxOccupancy, F);
1571
1572 // Program may already use more LDS than is usable at maximum occupancy.
1573 if (CurrentLocalMemUsage > MaxSizeWithWaveCount)
1574 return false;
1575
1576 LocalMemLimit = MaxSizeWithWaveCount;
1577
1578 LLVM_DEBUG(dbgs() << F.getName() << " uses " << CurrentLocalMemUsage
1579 << " bytes of LDS\n"
1580 << " Rounding size to " << MaxSizeWithWaveCount
1581 << " with a maximum occupancy of " << MaxOccupancy << '\n'
1582 << " and " << (LocalMemLimit - CurrentLocalMemUsage)
1583 << " available for promotion\n");
1584
1585 return true;
1586}
1587
1588// FIXME: Should try to pick the most likely to be profitable allocas first.
1589bool AMDGPUPromoteAllocaImpl::tryPromoteAllocaToLDS(
1590 AllocaAnalysis &AA, bool SufficientLDS,
1591 SetVector<IntrinsicInst *> &DeferredIntrs) {
1592 LLVM_DEBUG(dbgs() << "Trying to promote to LDS: " << *AA.Alloca << '\n');
1593
1594 // Not likely to have sufficient local memory for promotion.
1595 if (!SufficientLDS)
1596 return false;
1597
1598 IRBuilder<> Builder(AA.Alloca);
1599
1600 const Function &ContainingFunction = *AA.Alloca->getParent()->getParent();
1601 const AMDGPUSubtarget &ST = AMDGPUSubtarget::get(TM, ContainingFunction);
1602 unsigned WorkGroupSize = ST.getFlatWorkGroupSizes(ContainingFunction).second;
1603
1604 Align Alignment = AA.Alloca->getAlign();
1605
1606 // FIXME: This computed padding is likely wrong since it depends on inverse
1607 // usage order.
1608 //
1609 // FIXME: It is also possible that if we're allowed to use all of the memory
1610 // could end up using more than the maximum due to alignment padding.
1611
1612 uint32_t NewSize = alignTo(CurrentLocalMemUsage, Alignment);
1613 std::optional<TypeSize> ElemSize = AA.Alloca->getAllocationSize(DL);
1614 if (!ElemSize || ElemSize->isScalable())
1615 return false;
1616 TypeSize AllocSize = WorkGroupSize * *ElemSize;
1617 NewSize += AllocSize.getFixedValue();
1618
1619 if (NewSize > LocalMemLimit) {
1620 LLVM_DEBUG(dbgs() << " " << AllocSize
1621 << " bytes of local memory not available to promote\n");
1622 return false;
1623 }
1624
1625 CurrentLocalMemUsage = NewSize;
1626
1627 LLVM_DEBUG(dbgs() << "Promoting alloca to local memory\n");
1628
1629 Function *F = AA.Alloca->getFunction();
1630
1631 Type *GVTy = ArrayType::get(AA.Alloca->getAllocatedType(), WorkGroupSize);
1634 Twine(F->getName()) + Twine('.') + AA.Alloca->getName(), nullptr,
1637 GV->setAlignment(AA.Alloca->getAlign());
1638
1639 Value *TCntY, *TCntZ;
1640
1641 std::tie(TCntY, TCntZ) = getLocalSizeYZ(Builder);
1642 Value *TIdX = getWorkitemID(Builder, 0);
1643 Value *TIdY = getWorkitemID(Builder, 1);
1644 Value *TIdZ = getWorkitemID(Builder, 2);
1645
1646 Value *Tmp0 = Builder.CreateMul(TCntY, TCntZ, "", true, true);
1647 Tmp0 = Builder.CreateMul(Tmp0, TIdX);
1648 Value *Tmp1 = Builder.CreateMul(TIdY, TCntZ, "", true, true);
1649 Value *TID = Builder.CreateAdd(Tmp0, Tmp1);
1650 TID = Builder.CreateAdd(TID, TIdZ);
1651
1652 LLVMContext &Context = Mod.getContext();
1654
1655 Value *Offset = Builder.CreateInBoundsGEP(GVTy, GV, Indices);
1656 AA.Alloca->mutateType(Offset->getType());
1657 AA.Alloca->replaceAllUsesWith(Offset);
1658 AA.Alloca->eraseFromParent();
1659
1661
1662 for (Value *V : AA.LDS.Worklist) {
1664 if (!Call) {
1665 if (ICmpInst *CI = dyn_cast<ICmpInst>(V)) {
1666 Value *LHS = CI->getOperand(0);
1667 Value *RHS = CI->getOperand(1);
1668
1669 Type *NewTy = LHS->getType()->getWithNewType(NewPtrTy);
1671 CI->setOperand(0, Constant::getNullValue(NewTy));
1672
1674 CI->setOperand(1, Constant::getNullValue(NewTy));
1675
1676 continue;
1677 }
1678
1679 // The operand's value should be corrected on its own and we don't want to
1680 // touch the users.
1682 continue;
1683
1684 assert(V->getType()->isPtrOrPtrVectorTy());
1685
1686 Type *NewTy = V->getType()->getWithNewType(NewPtrTy);
1687 V->mutateType(NewTy);
1688
1689 // Adjust the types of any constant operands.
1692 SI->setOperand(1, Constant::getNullValue(NewTy));
1693
1695 SI->setOperand(2, Constant::getNullValue(NewTy));
1696 } else if (PHINode *Phi = dyn_cast<PHINode>(V)) {
1697 for (unsigned I = 0, E = Phi->getNumIncomingValues(); I != E; ++I) {
1699 Phi->getIncomingValue(I)))
1700 Phi->setIncomingValue(I, Constant::getNullValue(NewTy));
1701 }
1702 }
1703
1704 continue;
1705 }
1706
1708 Builder.SetInsertPoint(Intr);
1709 switch (Intr->getIntrinsicID()) {
1710 case Intrinsic::lifetime_start:
1711 case Intrinsic::lifetime_end:
1712 // These intrinsics are for address space 0 only
1713 Intr->eraseFromParent();
1714 continue;
1715 case Intrinsic::memcpy:
1716 case Intrinsic::memmove:
1717 // These have 2 pointer operands. In case if second pointer also needs
1718 // to be replaced we defer processing of these intrinsics until all
1719 // other values are processed.
1720 DeferredIntrs.insert(Intr);
1721 continue;
1722 case Intrinsic::memset: {
1723 MemSetInst *MemSet = cast<MemSetInst>(Intr);
1724 Builder.CreateMemSet(MemSet->getRawDest(), MemSet->getValue(),
1725 MemSet->getLength(), MemSet->getDestAlign(),
1726 MemSet->isVolatile());
1727 Intr->eraseFromParent();
1728 continue;
1729 }
1730 case Intrinsic::invariant_start:
1731 case Intrinsic::invariant_end:
1732 case Intrinsic::launder_invariant_group:
1733 case Intrinsic::strip_invariant_group: {
1735 if (Intr->getIntrinsicID() == Intrinsic::invariant_start) {
1736 Args.emplace_back(Intr->getArgOperand(0));
1737 } else if (Intr->getIntrinsicID() == Intrinsic::invariant_end) {
1738 Args.emplace_back(Intr->getArgOperand(0));
1739 Args.emplace_back(Intr->getArgOperand(1));
1740 }
1741 Args.emplace_back(Offset);
1743 Intr->getModule(), Intr->getIntrinsicID(), Offset->getType());
1744 CallInst *NewIntr =
1745 CallInst::Create(F, Args, Intr->getName(), Intr->getIterator());
1746 Intr->mutateType(NewIntr->getType());
1747 Intr->replaceAllUsesWith(NewIntr);
1748 Intr->eraseFromParent();
1749 continue;
1750 }
1751 case Intrinsic::objectsize: {
1752 Value *Src = Intr->getOperand(0);
1753
1754 Value *NewCall = Builder.CreateIntrinsic(
1755 Intrinsic::objectsize,
1757 {Src, Intr->getOperand(1), Intr->getOperand(2), Intr->getOperand(3)});
1758 Intr->replaceAllUsesWith(NewCall);
1759 Intr->eraseFromParent();
1760 continue;
1761 }
1762 default:
1763 Intr->print(errs());
1764 llvm_unreachable("Don't know how to promote alloca intrinsic use.");
1765 }
1766 }
1767
1768 return true;
1769}
1770
1771void AMDGPUPromoteAllocaImpl::finishDeferredAllocaToLDSPromotion(
1772 SetVector<IntrinsicInst *> &DeferredIntrs) {
1773
1774 for (IntrinsicInst *Intr : DeferredIntrs) {
1775 IRBuilder<> Builder(Intr);
1776 Builder.SetInsertPoint(Intr);
1778 assert(ID == Intrinsic::memcpy || ID == Intrinsic::memmove);
1779
1781 auto *B = Builder.CreateMemTransferInst(
1782 ID, MI->getRawDest(), MI->getDestAlign(), MI->getRawSource(),
1783 MI->getSourceAlign(), MI->getLength(), MI->isVolatile());
1784
1785 for (unsigned I = 0; I != 2; ++I) {
1786 if (uint64_t Bytes = Intr->getParamDereferenceableBytes(I)) {
1787 B->addDereferenceableParamAttr(I, Bytes);
1788 }
1789 }
1790
1791 Intr->eraseFromParent();
1792 }
1793}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
unsigned uint64_t
static Value * promoteAllocaUserToVector(Instruction *Inst, const DataLayout &DL, AllocaAnalysis &AA, unsigned VecStoreSize, unsigned ElementSize, function_ref< Value *()> GetCurVal)
Promotes a single user of the alloca to a vector form.
AMDGPU promote alloca to vector or LDS
static bool isSupportedAccessType(FixedVectorType *VecTy, Type *AccessTy, const DataLayout &DL)
static void forEachWorkListItem(const InstContainer &WorkList, std::function< void(Instruction *)> Fn)
Iterates over an instruction worklist that may contain multiple instructions from the same basic bloc...
static std::optional< GEPToVectorIndex > computeGEPToVectorIndex(GetElementPtrInst *GEP, AllocaInst *Alloca, Type *VecElemTy, const DataLayout &DL)
static bool isSupportedMemset(MemSetInst *I, AllocaInst *AI, const DataLayout &DL)
static BasicBlock::iterator skipToNonAllocaInsertPt(BasicBlock &BB, BasicBlock::iterator I)
Find an insert point after an alloca, after all other allocas clustered at the start of the block.
static bool isCallPromotable(CallInst *CI)
static Value * calculateVectorIndex(Value *Ptr, AllocaAnalysis &AA)
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
@ Enable
static bool runOnFunction(Function &F, bool PostInlining)
AMD GCN specific subclass of TargetSubtarget.
#define DEBUG_TYPE
Hexagon Common GEP
IRTranslator LLVM IR MI
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
uint64_t IntrinsicInst * II
if(auto Err=PB.parsePassPipeline(MPM, Passes)) return wrap(std MPM run * Mod
#define INITIALIZE_PASS_DEPENDENCY(depName)
Definition PassSupport.h:42
#define INITIALIZE_PASS_END(passName, arg, name, cfg, analysis)
Definition PassSupport.h:44
#define INITIALIZE_PASS_BEGIN(passName, arg, name, cfg, analysis)
Definition PassSupport.h:39
Remove Loads Into Fake Uses
const char * Msg
This file contains some templates that are useful if you are working with the STL at all.
#define LLVM_DEBUG(...)
Definition Debug.h:119
static TableGen::Emitter::Opt Y("gen-skeleton-entry", EmitSkeleton, "Generate example skeleton entry")
Target-Independent Code Generator Pass Configuration Options pass.
Value * RHS
Value * LHS
static const AMDGPUSubtarget & get(const MachineFunction &MF)
Class for arbitrary precision integers.
Definition APInt.h:78
bool isZero() const
Determine if this value is zero, i.e. all bits are clear.
Definition APInt.h:377
LLVM_ABI APInt sdiv(const APInt &RHS) const
Signed division function for APInt.
Definition APInt.cpp:1665
LLVM_ABI APInt sextOrTrunc(unsigned width) const
Sign extend or truncate to width.
Definition APInt.cpp:1079
LLVM_ABI APInt srem(const APInt &RHS) const
Function for signed remainder operation.
Definition APInt.cpp:1766
an instruction to allocate memory on the stack
Type * getAllocatedType() const
Return the type that is being allocated by the instruction.
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Represent the analysis usage information of a pass.
AnalysisUsage & addRequired()
LLVM_ABI void setPreservesCFG()
This function should be called by the pass, iff they do not:
Definition Pass.cpp:275
static LLVM_ABI ArrayType * get(Type *ElementType, uint64_t NumElements)
This static method is the primary way to construct an ArrayType.
An instruction that atomically checks whether a specified value is in a memory location,...
an instruction that atomically reads a memory location, combines it with another value,...
LLVM Basic Block Representation.
Definition BasicBlock.h:62
iterator end()
Definition BasicBlock.h:459
const Function * getParent() const
Return the enclosing method, or null if none.
Definition BasicBlock.h:213
InstListType::iterator iterator
Instruction iterators...
Definition BasicBlock.h:170
Represents analyses that only rely on functions' control flow.
Definition Analysis.h:73
uint64_t getParamDereferenceableBytes(unsigned i) const
Extract the number of dereferenceable bytes for a call or parameter (0=unknown).
void addDereferenceableRetAttr(uint64_t Bytes)
adds the dereferenceable attribute to the list of attributes.
void addRetAttr(Attribute::AttrKind Kind)
Adds the attribute to the return value.
Value * getArgOperand(unsigned i) const
This class represents a function call, abstracting a target machine's calling convention.
static CallInst * Create(FunctionType *Ty, Value *F, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static LLVM_ABI bool isBitOrNoopPointerCastable(Type *SrcTy, Type *DestTy, const DataLayout &DL)
Check whether a bitcast, inttoptr, or ptrtoint cast between these types is valid and a no-op.
This is the shared class of boolean and integer constants.
Definition Constants.h:87
uint64_t getZExtValue() const
Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate...
Definition Constants.h:168
This is an important base class in LLVM.
Definition Constant.h:43
static LLVM_ABI Constant * getNullValue(Type *Ty)
Constructor to create a '0' constant of arbitrary type.
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition DenseMap.h:284
Implements a dense probed hash-table based set.
Definition DenseSet.h:281
Class to represent fixed width SIMD vectors.
unsigned getNumElements() const
static LLVM_ABI FixedVectorType * get(Type *ElementType, unsigned NumElts)
Definition Type.cpp:867
FunctionPass class - This class is used to implement most global optimizations.
Definition Pass.h:314
Class to represent function types.
CallingConv::ID getCallingConv() const
getCallingConv()/setCallingConv(CC) - These method get and set the calling convention of this functio...
Definition Function.h:272
an instruction for type-safe pointer arithmetic to access elements of arrays and structs
bool hasExternalLinkage() const
void setUnnamedAddr(UnnamedAddr Val)
unsigned getAddressSpace() const
@ InternalLinkage
Rename collisions when linking (static functions).
Definition GlobalValue.h:60
Type * getValueType() const
MaybeAlign getAlign() const
Returns the alignment of the given variable.
LLVM_ABI uint64_t getGlobalSize(const DataLayout &DL) const
Get the size of this global variable in bytes.
Definition Globals.cpp:640
void setAlignment(Align Align)
Sets the alignment attribute of the GlobalVariable.
This instruction compares its operands according to the predicate given to the constructor.
LLVM_ABI CallInst * CreateIntrinsicWithoutFolding(Intrinsic::ID ID, ArrayRef< Type * > OverloadTypes, ArrayRef< Value * > Args, FMFSource FMFSource={}, const Twine &Name="", ArrayRef< OperandBundleDef > OpBundles={})
Create a call to intrinsic ID with Args, mangled using OverloadTypes.
LoadInst * CreateAlignedLoad(Type *Ty, Value *Ptr, MaybeAlign Align, const char *Name)
Definition IRBuilder.h:1934
Value * CreateLShr(Value *LHS, Value *RHS, const Twine &Name="", bool isExact=false)
Definition IRBuilder.h:1532
BasicBlock * GetInsertBlock() const
Definition IRBuilder.h:175
Value * CreateInBoundsGEP(Type *Ty, Value *Ptr, ArrayRef< Value * > IdxList, const Twine &Name="")
Definition IRBuilder.h:2019
CallInst * CreateMemSet(Value *Ptr, Value *Val, uint64_t Size, MaybeAlign Align, bool isVolatile=false, const AAMDNodes &AAInfo=AAMDNodes())
Create and insert a memset to the specified pointer and the specified value.
Definition IRBuilder.h:608
LLVM_ABI Value * CreateIntrinsic(Intrinsic::ID ID, ArrayRef< Type * > OverloadTypes, ArrayRef< Value * > Args, FMFSource FMFSource={}, const Twine &Name="", ArrayRef< OperandBundleDef > OpBundles={}, function_ref< void(CallInst *)> SetFn=[](CallInst *) {})
Variant to create a possibly constant-folded intrinsic.
Value * CreateAdd(Value *LHS, Value *RHS, const Twine &Name="", bool HasNUW=false, bool HasNSW=false)
Definition IRBuilder.h:1422
CallInst * CreateCall(FunctionType *FTy, Value *Callee, ArrayRef< Value * > Args={}, const Twine &Name="", MDNode *FPMathTag=nullptr)
Definition IRBuilder.h:2554
Value * CreateConstInBoundsGEP1_64(Type *Ty, Value *Ptr, uint64_t Idx0, const Twine &Name="")
Definition IRBuilder.h:2061
void SetInsertPoint(BasicBlock *TheBB)
This specifies that created instructions should be appended to the end of the specified block.
Definition IRBuilder.h:181
LLVM_ABI CallInst * CreateMemTransferInst(Intrinsic::ID IntrID, Value *Dst, MaybeAlign DstAlign, Value *Src, MaybeAlign SrcAlign, Value *Size, bool isVolatile=false, const AAMDNodes &AAInfo=AAMDNodes())
Value * CreateMul(Value *LHS, Value *RHS, const Twine &Name="", bool HasNUW=false, bool HasNSW=false)
Definition IRBuilder.h:1456
This provides a uniform API for creating instructions and inserting them into a basic block: either a...
Definition IRBuilder.h:2893
InstSimplifyFolder - Use InstructionSimplify to fold operations to existing values.
LLVM_ABI const Module * getModule() const
Return the module owning the function this instruction belongs to or nullptr it the function does not...
LLVM_ABI InstListType::iterator eraseFromParent()
This method unlinks 'this' from the containing basic block and deletes it.
LLVM_ABI void setMetadata(unsigned KindID, MDNode *Node)
Set the metadata of the specified kind to the specified node.
unsigned getOpcode() const
Returns a member of one of the enums like Instruction::Add.
Class to represent integer types.
A wrapper class for inspecting calls to intrinsic functions.
Intrinsic::ID getIntrinsicID() const
Return the intrinsic ID of this intrinsic.
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
An instruction for reading from memory.
Analysis pass that exposes the LoopInfo for a function.
Definition LoopInfo.h:594
The legacy pass manager's analysis pass to compute loop information.
Definition LoopInfo.h:619
Metadata node.
Definition Metadata.h:1069
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition Metadata.h:1567
This class implements a map that also provides access to all stored values in a deterministic order.
Definition MapVector.h:38
bool empty() const
Definition MapVector.h:79
size_type size() const
Definition MapVector.h:58
std::pair< KeyT, ValueT > & front()
Definition MapVector.h:81
Value * getLength() const
Value * getRawDest() const
MaybeAlign getDestAlign() const
bool isVolatile() const
Value * getValue() const
This class wraps the llvm.memset and llvm.memset.inline intrinsics.
This class wraps the llvm.memcpy/memmove intrinsics.
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:67
virtual void getAnalysisUsage(AnalysisUsage &) const
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
Definition Pass.cpp:112
Class to represent pointers.
static LLVM_ABI PointerType * get(LLVMContext &C, unsigned AddressSpace)
This constructs an opaque pointer to an object in a numbered address space.
Definition Type.cpp:911
static LLVM_ABI PoisonValue * get(Type *T)
Static factory methods - Return an 'poison' object of the specified type.
A set of analyses that are preserved following a run of a transformation pass.
Definition Analysis.h:112
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition Analysis.h:118
PreservedAnalyses & preserveSet()
Mark an analysis set as preserved.
Definition Analysis.h:151
Helper class for SSA formation on a set of values defined in multiple blocks.
Definition SSAUpdater.h:39
LLVM_ABI void Initialize(Type *Ty, StringRef Name)
Reset this object to get ready for a new set of SSA updates with type 'Ty'.
LLVM_ABI Value * GetValueInMiddleOfBlock(BasicBlock *BB)
Construct SSA form, materializing a value that is live in the middle of the specified block.
LLVM_ABI void AddAvailableValue(BasicBlock *BB, Value *V)
Indicate that a rewritten value is available in the specified block with the specified value.
This class represents the LLVM 'select' instruction.
A vector that has set insertion semantics.
Definition SetVector.h:57
bool contains(const_arg_type key) const
Check if the SetVector contains the given key.
Definition SetVector.h:258
bool insert(const value_type &X)
Insert a new element into the SetVector.
Definition SetVector.h:157
size_type size() const
Definition SmallPtrSet.h:99
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
A SetVector that performs no allocations if smaller than a certain size.
Definition SetVector.h:345
reference emplace_back(ArgTypes &&... Args)
void reserve(size_type N)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
An instruction for storing to memory.
static unsigned getPointerOperandIndex()
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
Primary interface to the complete machine description for the target machine.
const STC & getSubtarget(const Function &F) const
This method returns a pointer to the specified type of TargetSubtargetInfo.
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:48
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
bool isArrayTy() const
True if this is an instance of ArrayType.
Definition Type.h:279
static LLVM_ABI IntegerType * getInt32Ty(LLVMContext &C)
Definition Type.cpp:309
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:282
bool isAggregateType() const
Return true if the type is an aggregate type.
Definition Type.h:319
LLVM_ABI Type * getWithNewType(Type *EltTy) const
Given vector type, change the element type, whilst keeping the old number of elements.
static LLVM_ABI IntegerType * getIntNTy(LLVMContext &C, unsigned N)
Definition Type.cpp:313
A Use represents the edge between a Value definition and its users.
Definition Use.h:35
void setOperand(unsigned i, Value *Val)
Definition User.h:212
Value * getOperand(unsigned i) const
Definition User.h:207
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:255
LLVM_ABI void print(raw_ostream &O, bool IsForDebug=false) const
Implement operator<< on Value.
LLVM_ABI void replaceAllUsesWith(Value *V)
Change all uses of this to point to a new Value.
Definition Value.cpp:553
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:258
iterator_range< user_iterator > users()
Definition Value.h:426
LLVM_ABI const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs and address space casts.
Definition Value.cpp:713
bool use_empty() const
Definition Value.h:346
void mutateType(Type *Ty)
Mutate the type of this Value to be of the specified type.
Definition Value.h:807
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
LLVM_ABI void takeName(Value *V)
Transfer the name from V to this value.
Definition Value.cpp:400
static LLVM_ABI bool isValidElementType(Type *ElemTy)
Return true if the specified type is valid as a element type.
Type * getElementType() const
Value handle that is nullable, but tries to track the Value.
constexpr bool isKnownMultipleOf(ScalarTy RHS) const
This function tells the caller whether the element count is known at compile time to be a multiple of...
Definition TypeSize.h:180
constexpr ScalarTy getFixedValue() const
Definition TypeSize.h:200
An efficient, type-erasing, non-owning reference to a callable.
const ParentTy * getParent() const
Definition ilist_node.h:34
self_iterator getIterator()
Definition ilist_node.h:123
CallInst * Call
Changed
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Abstract Attribute helper functions.
Definition Attributor.h:165
@ LOCAL_ADDRESS
Address space for local memory.
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
LLVM_READNONE constexpr bool isEntryFunctionCC(CallingConv::ID CC)
unsigned getDynamicVGPRBlockSize(const Function &F)
@ Entry
Definition COFF.h:862
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition CallingConv.h:24
@ AMDGPU_KERNEL
Used for AMDGPU code object kernels.
@ SPIR_KERNEL
Used for SPIR kernel functions.
This namespace contains an enum with a value for every intrinsic/builtin function known by LLVM.
LLVM_ABI Function * getOrInsertDeclaration(Module *M, ID id, ArrayRef< Type * > OverloadTys={})
Look up the Function declaration of the intrinsic id in the Module M.
specific_intval< false > m_SpecificInt(const APInt &V)
Match a specific integer value or vector with all elements equal to the value.
bool match(Val *V, const Pattern &P)
initializer< Ty > init(const Ty &Val)
NodeAddr< PhiNode * > Phi
Definition RDFGraph.h:390
This is an optimization pass for GlobalISel generic memory operations.
@ Offset
Definition DWP.cpp:578
@ Length
Definition DWP.cpp:578
void stable_sort(R &&Range)
Definition STLExtras.h:2116
auto find(R &&Range, const T &Val)
Provide wrappers to std::find which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1765
bool all_of(R &&range, UnaryPredicate P)
Provide wrappers to std::all_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1739
LLVM_ABI bool isAssumeLikeIntrinsic(const Instruction *I)
Return true if it is an intrinsic that cannot be speculated but also cannot trap.
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
const Value * getLoadStorePointerOperand(const Value *V)
A helper function that returns the pointer operand of a load or store instruction.
constexpr bool isPowerOf2_64(uint64_t Value)
Return true if the argument is a power of two > 0 (64 bit edition.)
Definition MathExtras.h:285
unsigned Log2_64(uint64_t Value)
Return the floor log base 2 of the specified value, -1 if the value is zero.
Definition MathExtras.h:338
const Value * getPointerOperand(const Value *V)
A helper function that returns the pointer operand of a load, store or GEP instruction.
unsigned Log2_32(uint32_t Value)
Return the floor log base 2 of the specified value, -1 if the value is zero.
Definition MathExtras.h:332
auto reverse(ContainerTy &&C)
Definition STLExtras.h:407
constexpr bool isPowerOf2_32(uint32_t Value)
Return true if the argument is a power of two > 0.
Definition MathExtras.h:280
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1636
LLVM_ABI void computeKnownBits(const Value *V, KnownBits &Known, const DataLayout &DL, AssumptionCache *AC=nullptr, const Instruction *CxtI=nullptr, const DominatorTree *DT=nullptr, bool UseInstrInfo=true, unsigned Depth=0)
Determine which bits of V are known to be either zero or one and return them in the KnownZero/KnownOn...
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:209
constexpr uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition Alignment.h:144
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
constexpr int PoisonMaskElem
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
FunctionPass * createAMDGPUPromoteAlloca()
@ Mod
The access may modify the value stored in memory.
Definition ModRef.h:34
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
Type * getLoadStoreType(const Value *I)
A helper function that returns the type of a load or store instruction.
char & AMDGPUPromoteAllocaID
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
LLVM_ABI const Value * getUnderlyingObject(const Value *V, unsigned MaxLookup=MaxLookupSearchDepth)
This method strips off any GEP address adjustments, pointer casts or llvm.threadlocal....
#define N
AMDGPUPromoteAllocaPass(TargetMachine &TM)
Definition AMDGPU.h:279
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
unsigned countMinTrailingZeros() const
Returns the minimum number of trailing zero bits.
Definition KnownBits.h:256
A MapVector that performs no allocations if smaller than a certain size.
Definition MapVector.h:342
Function object to check whether the second component of a container supported by std::get (like std:...
Definition STLExtras.h:1448