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 // Temporarily check both the attribute and the subtarget feature, until the
218 // latter is removed.
219 if (DynamicVGPRBlockSize == 0 && ST.isDynamicVGPREnabled())
220 DynamicVGPRBlockSize = ST.getDynamicVGPRBlockSize();
221
222 unsigned MaxVGPRs = ST.getMaxNumVGPRs(
223 ST.getWavesPerEU(ST.getFlatWorkGroupSizes(F), LDSBytes, F).first,
224 DynamicVGPRBlockSize);
225
226 // A non-entry function has only 32 caller preserved registers.
227 // Do not promote alloca which will force spilling unless we know the function
228 // will be inlined.
229 if (!F.hasFnAttribute(Attribute::AlwaysInline) &&
230 !AMDGPU::isEntryFunctionCC(F.getCallingConv()))
231 MaxVGPRs = std::min(MaxVGPRs, 32u);
232 return MaxVGPRs;
233}
234
235} // end anonymous namespace
236
237char AMDGPUPromoteAlloca::ID = 0;
238
240 "AMDGPU promote alloca to vector or LDS", false, false)
241// Move LDS uses from functions to kernels before promote alloca for accurate
242// estimation of LDS available
243INITIALIZE_PASS_DEPENDENCY(AMDGPULowerModuleLDSLegacy)
245INITIALIZE_PASS_END(AMDGPUPromoteAlloca, DEBUG_TYPE,
246 "AMDGPU promote alloca to vector or LDS", false, false)
247
248char &llvm::AMDGPUPromoteAllocaID = AMDGPUPromoteAlloca::ID;
249
252 auto &LI = AM.getResult<LoopAnalysis>(F);
253 bool Changed = AMDGPUPromoteAllocaImpl(TM, *F.getParent(), LI)
254 .run(F, /*PromoteToLDS=*/true);
255 if (Changed) {
258 return PA;
259 }
260 return PreservedAnalyses::all();
261}
262
265 auto &LI = AM.getResult<LoopAnalysis>(F);
266 bool Changed = AMDGPUPromoteAllocaImpl(TM, *F.getParent(), LI)
267 .run(F, /*PromoteToLDS=*/false);
268 if (Changed) {
271 return PA;
272 }
273 return PreservedAnalyses::all();
274}
275
277 return new AMDGPUPromoteAlloca();
278}
279
280bool AMDGPUPromoteAllocaImpl::collectAllocaUses(AllocaAnalysis &AA) const {
281 const auto RejectUser = [&](Instruction *Inst, Twine Msg) {
282 LLVM_DEBUG(dbgs() << " Cannot promote alloca: " << Msg << "\n"
283 << " " << *Inst << "\n");
284 return false;
285 };
286
287 SmallVector<Instruction *, 4> WorkList({AA.Alloca});
288 while (!WorkList.empty()) {
289 auto *Cur = WorkList.pop_back_val();
290 if (find(AA.Pointers, Cur) != AA.Pointers.end())
291 continue;
292 AA.Pointers.insert(Cur);
293 for (auto &U : Cur->uses()) {
294 auto *Inst = cast<Instruction>(U.getUser());
295 if (isa<StoreInst>(Inst)) {
296 if (U.getOperandNo() != StoreInst::getPointerOperandIndex()) {
297 return RejectUser(Inst, "pointer escapes via store");
298 }
299 }
300 AA.Uses.push_back(&U);
301
302 if (isa<GetElementPtrInst>(U.getUser())) {
303 WorkList.push_back(Inst);
304 } else if (auto *SI = dyn_cast<SelectInst>(Inst)) {
305 // Only promote a select if we know that the other select operand is
306 // from another pointer that will also be promoted.
307 if (!binaryOpIsDerivedFromSameAlloca(AA.Alloca, Cur, SI, 1, 2))
308 return RejectUser(Inst, "select from mixed objects");
309 WorkList.push_back(Inst);
310 AA.HaveSelectOrPHI = true;
311 } else if (auto *Phi = dyn_cast<PHINode>(Inst)) {
312 // Repeat for phis.
313
314 // TODO: Handle more complex cases. We should be able to replace loops
315 // over arrays.
316 switch (Phi->getNumIncomingValues()) {
317 case 1:
318 break;
319 case 2:
320 if (!binaryOpIsDerivedFromSameAlloca(AA.Alloca, Cur, Phi, 0, 1))
321 return RejectUser(Inst, "phi from mixed objects");
322 break;
323 default:
324 return RejectUser(Inst, "phi with too many operands");
325 }
326
327 WorkList.push_back(Inst);
328 AA.HaveSelectOrPHI = true;
329 }
330 }
331 }
332 return true;
333}
334
335void AMDGPUPromoteAllocaImpl::scoreAlloca(AllocaAnalysis &AA) const {
336 LLVM_DEBUG(dbgs() << "Scoring: " << *AA.Alloca << "\n");
337 unsigned Score = 0;
338 // Increment score by one for each user + a bonus for users within loops.
339 for (auto *U : AA.Uses) {
340 Instruction *Inst = cast<Instruction>(U->getUser());
341 if (isa<GetElementPtrInst>(Inst) || isa<SelectInst>(Inst) ||
342 isa<PHINode>(Inst))
343 continue;
344 unsigned UserScore =
345 1 + (LoopUserWeight * LI.getLoopDepth(Inst->getParent()));
346 LLVM_DEBUG(dbgs() << " [+" << UserScore << "]:\t" << *Inst << "\n");
347 Score += UserScore;
348 }
349 LLVM_DEBUG(dbgs() << " => Final Score:" << Score << "\n");
350 AA.Score = Score;
351}
352
353void AMDGPUPromoteAllocaImpl::setFunctionLimits(const Function &F) {
354 // Load per function limits, overriding with global options where appropriate.
355 // R600 register tuples/aliasing are fragile with large vector promotions so
356 // apply architecture specific limit here.
357 const int R600MaxVectorRegs = 16;
358 MaxVectorRegs = F.getFnAttributeAsParsedInteger(
359 "amdgpu-promote-alloca-to-vector-max-regs",
360 IsAMDGCN ? PromoteAllocaToVectorMaxRegs : R600MaxVectorRegs);
361 if (PromoteAllocaToVectorMaxRegs.getNumOccurrences())
362 MaxVectorRegs = PromoteAllocaToVectorMaxRegs;
363 VGPRBudgetRatio = F.getFnAttributeAsParsedInteger(
364 "amdgpu-promote-alloca-to-vector-vgpr-ratio",
365 PromoteAllocaToVectorVGPRRatio);
366 if (PromoteAllocaToVectorVGPRRatio.getNumOccurrences())
367 VGPRBudgetRatio = PromoteAllocaToVectorVGPRRatio;
368}
369
370bool AMDGPUPromoteAllocaImpl::run(Function &F, bool PromoteToLDS) {
371 if (DisablePromoteAllocaToLDS && DisablePromoteAllocaToVector)
372 return false;
373
374 bool SufficientLDS = PromoteToLDS && hasSufficientLocalMem(F);
375 MaxVGPRs = IsAMDGCN ? getMaxVGPRs(CurrentLocalMemUsage, TM, F) : 128;
376 setFunctionLimits(F);
377
378 unsigned VectorizationBudget =
379 (PromoteAllocaToVectorLimit ? PromoteAllocaToVectorLimit * 8
380 : (MaxVGPRs * 32)) /
381 VGPRBudgetRatio;
382
383 std::vector<AllocaAnalysis> Allocas;
384 for (Instruction &I : F.getEntryBlock()) {
385 if (AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
386 // Array allocations are probably not worth handling, since an allocation
387 // of the array type is the canonical form.
388 if (!AI->isStaticAlloca() || AI->isArrayAllocation())
389 continue;
390
391 LLVM_DEBUG(dbgs() << "Analyzing: " << *AI << '\n');
392
393 AllocaAnalysis AA{AI};
394 if (collectAllocaUses(AA)) {
395 analyzePromoteToVector(AA);
396 if (PromoteToLDS)
397 analyzePromoteToLDS(AA);
398 if (AA.Vector.Ty || AA.LDS.Enable) {
399 scoreAlloca(AA);
400 Allocas.push_back(std::move(AA));
401 }
402 }
403 }
404 }
405
406 stable_sort(Allocas,
407 [](const auto &A, const auto &B) { return A.Score > B.Score; });
408
409 // clang-format off
411 dbgs() << "Sorted Worklist:\n";
412 for (const auto &AA : Allocas)
413 dbgs() << " " << *AA.Alloca << "\n";
414 );
415 // clang-format on
416
417 bool Changed = false;
418 SetVector<IntrinsicInst *> DeferredIntrs;
419 for (AllocaAnalysis &AA : Allocas) {
420 if (AA.Vector.Ty) {
421 std::optional<TypeSize> Size = AA.Alloca->getAllocationSize(DL);
422 assert(Size); // Expected to succeed on non-array alloca.
423 const unsigned AllocaCost = Size->getFixedValue() * 8;
424 // First, check if we have enough budget to vectorize this alloca.
425 if (AllocaCost <= VectorizationBudget) {
426 promoteAllocaToVector(AA);
427 Changed = true;
428 assert((VectorizationBudget - AllocaCost) < VectorizationBudget &&
429 "Underflow!");
430 VectorizationBudget -= AllocaCost;
431 LLVM_DEBUG(dbgs() << " Remaining vectorization budget:"
432 << VectorizationBudget << "\n");
433 continue;
434 } else {
435 LLVM_DEBUG(dbgs() << "Alloca too big for vectorization (size:"
436 << AllocaCost << ", budget:" << VectorizationBudget
437 << "): " << *AA.Alloca << "\n");
438 }
439 }
440
441 if (AA.LDS.Enable &&
442 tryPromoteAllocaToLDS(AA, SufficientLDS, DeferredIntrs))
443 Changed = true;
444 }
445 finishDeferredAllocaToLDSPromotion(DeferredIntrs);
446
447 // NOTE: tryPromoteAllocaToVector removes the alloca, so Allocas contains
448 // dangling pointers. If we want to reuse it past this point, the loop above
449 // would need to be updated to remove successfully promoted allocas.
450
451 return Changed;
452}
453
454// Checks if the instruction I is a memset user of the alloca AI that we can
455// deal with. Currently, only non-volatile memsets that affect the whole alloca
456// are handled.
458 const DataLayout &DL) {
459 using namespace PatternMatch;
460 // For now we only care about non-volatile memsets that affect the whole type
461 // (start at index 0 and fill the whole alloca).
462 //
463 // TODO: Now that we moved to PromoteAlloca we could handle any memsets
464 // (except maybe volatile ones?) - we just need to use shufflevector if it
465 // only affects a subset of the vector.
466 const unsigned Size = DL.getTypeStoreSize(AI->getAllocatedType());
467 return I->getOperand(0) == AI &&
468 match(I->getOperand(2), m_SpecificInt(Size)) && !I->isVolatile();
469}
470
471static Value *calculateVectorIndex(Value *Ptr, AllocaAnalysis &AA) {
472 IRBuilder<> B(Ptr->getContext());
473
474 Ptr = Ptr->stripPointerCasts();
475 if (Ptr == AA.Alloca)
476 return B.getInt32(0);
477
478 auto *GEP = cast<GetElementPtrInst>(Ptr);
479 auto I = AA.Vector.GEPVectorIdx.find(GEP);
480 assert(I != AA.Vector.GEPVectorIdx.end() && "Must have entry for GEP!");
481
482 if (!I->second.Full) {
483 Value *Result = nullptr;
484 B.SetInsertPoint(GEP);
485
486 if (I->second.VarIndex) {
487 Result = I->second.VarIndex;
488 Result = B.CreateSExtOrTrunc(Result, B.getInt32Ty());
489
490 if (I->second.VarMul)
491 Result = B.CreateMul(Result, I->second.VarMul);
492
493 if (I->second.VarShift)
494 Result = B.CreateAShr(Result, I->second.VarShift, "", /*isExact*/ true);
495 }
496
497 if (I->second.ConstIndex) {
498 if (Result)
499 Result = B.CreateAdd(Result, I->second.ConstIndex);
500 else
501 Result = I->second.ConstIndex;
502 }
503
504 if (!Result)
505 Result = B.getInt32(0);
506
507 I->second.Full = Result;
508 }
509
510 return I->second.Full;
511}
512
513static std::optional<GEPToVectorIndex>
515 Type *VecElemTy, const DataLayout &DL) {
516 // TODO: Extracting a "multiple of X" from a GEP might be a useful generic
517 // helper.
518 LLVMContext &Ctx = GEP->getContext();
519 unsigned BW = DL.getIndexTypeSizeInBits(GEP->getType());
521 APInt ConstOffset(BW, 0);
522
523 // Walk backwards through nested GEPs to collect both constant and variable
524 // offsets, so that nested vector GEP chains can be lowered in one step.
525 //
526 // Given this IR fragment as input:
527 //
528 // %0 = alloca [10 x <2 x i32>], align 8, addrspace(5)
529 // %1 = getelementptr [10 x <2 x i32>], ptr addrspace(5) %0, i32 0, i32 %j
530 // %2 = getelementptr i8, ptr addrspace(5) %1, i32 4
531 // %3 = load i32, ptr addrspace(5) %2, align 4
532 //
533 // Combine both GEP operations in a single pass, producing:
534 // BasePtr = %0
535 // ConstOffset = 4
536 // VarOffsets = { %j -> element_size(<2 x i32>) }
537 //
538 // That lets us emit a single buffer_load directly into a VGPR, without ever
539 // allocating scratch memory for the intermediate pointer.
540 Value *CurPtr = GEP;
541 while (auto *CurGEP = dyn_cast<GetElementPtrInst>(CurPtr)) {
542 if (!CurGEP->collectOffset(DL, BW, VarOffsets, ConstOffset))
543 return {};
544
545 // Move to the next outer pointer.
546 CurPtr = CurGEP->getPointerOperand();
547 }
548
549 assert(CurPtr == Alloca && "GEP not based on alloca");
550
551 int64_t VecElemSize = DL.getTypeAllocSize(VecElemTy);
552 if (VarOffsets.size() > 1)
553 return {};
554
555 // We support vector indices of the form ((VarIndex * stride) >> shift) + B.
556 // IndexQuot represents B. Check that the constant offset is a multiple
557 // of the vector element size.
558 if (ConstOffset.srem(VecElemSize) != 0)
559 return {};
560 APInt IndexQuot = ConstOffset.sdiv(VecElemSize);
561
562 GEPToVectorIndex Result;
563
564 if (!ConstOffset.isZero())
565 Result.ConstIndex = ConstantInt::get(Ctx, IndexQuot.sextOrTrunc(BW));
566
567 // If there are no variable offsets, only a constant offset, then we're done.
568 if (VarOffsets.empty())
569 return Result;
570
571 // Scale is the stride in the (A * stride) part. Check that there is only one
572 // variable offset and extract the scale factor.
573 const auto &VarOffset = VarOffsets.front();
574 auto ScaleOpt = VarOffset.second.tryZExtValue();
575 if (!ScaleOpt || *ScaleOpt == 0)
576 return {};
577
578 uint64_t Scale = *ScaleOpt;
579 Result.VarIndex = VarOffset.first;
580 auto *OffsetType = dyn_cast<IntegerType>(Result.VarIndex->getType());
581 if (!OffsetType)
582 return {};
583
584 // The vector index for the variable part is: VarIndex * Scale / VecElemSize.
585 if (Scale >= (uint64_t)VecElemSize) {
586 if (Scale % VecElemSize != 0)
587 return {};
588
589 // Scale is a multiple of VecElemSize, so the index is just: VarIndex *
590 // (Scale / VecElemSize).
591 uint64_t VarMul = Scale / VecElemSize;
592 // Only the multiplier is needed.
593 if (VarMul != 1)
594 Result.VarMul = ConstantInt::get(Ctx, APInt(BW, VarMul));
595 } else {
596 if ((uint64_t)VecElemSize % Scale != 0)
597 return {};
598
599 // VecElemSize is a multiple of Scale, so the index is just: VarIndex /
600 // (VecElemSize / Scale).
601 uint64_t Divisor = VecElemSize / Scale;
602 // The divisor must be a power of 2 so we can use a right shift.
603 if (!isPowerOf2_64(Divisor))
604 return {};
605
606 // VarIndex must be known to be divisible by that divisor.
607 KnownBits KB = computeKnownBits(VarOffset.first, DL);
608 if (KB.countMinTrailingZeros() < Log2_64(Divisor))
609 return {};
610
611 Result.VarShift = ConstantInt::get(Ctx, APInt(BW, Log2_64(Divisor)));
612 }
613
614 return Result;
615}
616
617/// Promotes a single user of the alloca to a vector form.
618///
619/// \param Inst Instruction to be promoted.
620/// \param DL Module Data Layout.
621/// \param AA Alloca Analysis.
622/// \param VecStoreSize Size of \p VectorTy in bytes.
623/// \param ElementSize Size of \p VectorTy element type in bytes.
624/// \param CurVal Current value of the vector (e.g. last stored value)
625/// \param[out] DeferredLoads \p Inst is added to this vector if it can't
626/// be promoted now. This happens when promoting requires \p
627/// CurVal, but \p CurVal is nullptr.
628/// \return the stored value if \p Inst would have written to the alloca, or
629/// nullptr otherwise.
631 AllocaAnalysis &AA,
632 unsigned VecStoreSize,
633 unsigned ElementSize,
634 function_ref<Value *()> GetCurVal) {
635 // Note: we use InstSimplifyFolder because it can leverage the DataLayout
636 // to do more folding, especially in the case of vector splats.
639 Builder.SetInsertPoint(Inst);
640
641 Type *VecEltTy = AA.Vector.Ty->getElementType();
642
643 switch (Inst->getOpcode()) {
644 case Instruction::Load: {
645 Value *CurVal = GetCurVal();
646 Value *Index =
648
649 // We're loading the full vector.
650 Type *AccessTy = Inst->getType();
651 TypeSize AccessSize = DL.getTypeStoreSize(AccessTy);
652 if (Constant *CI = dyn_cast<Constant>(Index)) {
653 if (CI->isNullValue() && AccessSize == VecStoreSize) {
654 Inst->replaceAllUsesWith(
655 Builder.CreateBitPreservingCastChain(DL, CurVal, AccessTy));
656 return nullptr;
657 }
658 }
659
660 // Loading a subvector.
661 if (isa<FixedVectorType>(AccessTy)) {
662 assert(AccessSize.isKnownMultipleOf(DL.getTypeStoreSize(VecEltTy)));
663 const unsigned NumLoadedElts = AccessSize / DL.getTypeStoreSize(VecEltTy);
664 auto *SubVecTy = FixedVectorType::get(VecEltTy, NumLoadedElts);
665 assert(DL.getTypeStoreSize(SubVecTy) == DL.getTypeStoreSize(AccessTy));
666
667 // If idx is dynamic, then sandwich load with bitcasts.
668 // ie. VectorTy SubVecTy AccessTy
669 // <64 x i8> -> <16 x i8> <8 x i16>
670 // <64 x i8> -> <4 x i128> -> i128 -> <8 x i16>
671 // Extracting subvector with dynamic index has very large expansion in
672 // the amdgpu backend. Limit to pow2.
673 FixedVectorType *VectorTy = AA.Vector.Ty;
674 TypeSize NumBits = DL.getTypeStoreSize(SubVecTy) * 8u;
675 uint64_t LoadAlign = cast<LoadInst>(Inst)->getAlign().value();
676 bool IsAlignedLoad = NumBits <= (LoadAlign * 8u);
677 unsigned TotalNumElts = VectorTy->getNumElements();
678 bool IsProperlyDivisible = TotalNumElts % NumLoadedElts == 0;
679 if (!isa<ConstantInt>(Index) &&
680 llvm::isPowerOf2_32(SubVecTy->getNumElements()) &&
681 IsProperlyDivisible && IsAlignedLoad) {
682 IntegerType *NewElemTy = Builder.getIntNTy(NumBits);
683 const unsigned NewNumElts =
684 DL.getTypeStoreSize(VectorTy) * 8u / NumBits;
685 const unsigned LShrAmt = llvm::Log2_32(SubVecTy->getNumElements());
686 FixedVectorType *BitCastTy =
687 FixedVectorType::get(NewElemTy, NewNumElts);
688 Value *BCVal =
689 Builder.CreateBitPreservingCastChain(DL, CurVal, BitCastTy);
690 Value *NewIdx = Builder.CreateLShr(
691 Index, ConstantInt::get(Index->getType(), LShrAmt));
692 Value *ExtVal = Builder.CreateExtractElement(BCVal, NewIdx);
693 Value *BCOut =
694 Builder.CreateBitPreservingCastChain(DL, ExtVal, AccessTy);
695 Inst->replaceAllUsesWith(BCOut);
696 return nullptr;
697 }
698
699 Value *SubVec = PoisonValue::get(SubVecTy);
700 for (unsigned K = 0; K < NumLoadedElts; ++K) {
701 Value *CurIdx =
702 Builder.CreateAdd(Index, ConstantInt::get(Index->getType(), K));
703 SubVec = Builder.CreateInsertElement(
704 SubVec, Builder.CreateExtractElement(CurVal, CurIdx), K);
705 }
706
707 Inst->replaceAllUsesWith(
708 Builder.CreateBitPreservingCastChain(DL, SubVec, AccessTy));
709 return nullptr;
710 }
711
712 // We're loading one element.
713 Value *ExtractElement = Builder.CreateExtractElement(CurVal, Index);
714 if (AccessTy != VecEltTy)
715 ExtractElement = Builder.CreateBitOrPointerCast(ExtractElement, AccessTy);
716
717 Inst->replaceAllUsesWith(ExtractElement);
718 return nullptr;
719 }
720 case Instruction::Store: {
721 // For stores, it's a bit trickier and it depends on whether we're storing
722 // the full vector or not. If we're storing the full vector, we don't need
723 // to know the current value. If this is a store of a single element, we
724 // need to know the value.
726 Value *Index = calculateVectorIndex(SI->getPointerOperand(), AA);
727 Value *Val = SI->getValueOperand();
728
729 // We're storing the full vector, we can handle this without knowing CurVal.
730 Type *AccessTy = Val->getType();
731 TypeSize AccessSize = DL.getTypeStoreSize(AccessTy);
732 if (Constant *CI = dyn_cast<Constant>(Index))
733 if (CI->isNullValue() && AccessSize == VecStoreSize)
734 return Builder.CreateBitPreservingCastChain(DL, Val, AA.Vector.Ty);
735
736 // Storing a subvector.
737 if (isa<FixedVectorType>(AccessTy)) {
738 assert(AccessSize.isKnownMultipleOf(DL.getTypeStoreSize(VecEltTy)));
739 const unsigned NumWrittenElts =
740 AccessSize / DL.getTypeStoreSize(VecEltTy);
741 const unsigned NumVecElts = AA.Vector.Ty->getNumElements();
742 auto *SubVecTy = FixedVectorType::get(VecEltTy, NumWrittenElts);
743 assert(DL.getTypeStoreSize(SubVecTy) == DL.getTypeStoreSize(AccessTy));
744
745 Val = Builder.CreateBitPreservingCastChain(DL, Val, SubVecTy);
746 Value *CurVec = GetCurVal();
747 for (unsigned K = 0, NumElts = std::min(NumWrittenElts, NumVecElts);
748 K < NumElts; ++K) {
749 Value *CurIdx =
750 Builder.CreateAdd(Index, ConstantInt::get(Index->getType(), K));
751 CurVec = Builder.CreateInsertElement(
752 CurVec, Builder.CreateExtractElement(Val, K), CurIdx);
753 }
754 return CurVec;
755 }
756
757 if (Val->getType() != VecEltTy)
758 Val = Builder.CreateBitOrPointerCast(Val, VecEltTy);
759 return Builder.CreateInsertElement(GetCurVal(), Val, Index);
760 }
761 case Instruction::Call: {
762 if (auto *MTI = dyn_cast<MemTransferInst>(Inst)) {
763 // For memcpy, we need to know curval.
764 ConstantInt *Length = cast<ConstantInt>(MTI->getLength());
765 unsigned NumCopied = Length->getZExtValue() / ElementSize;
766 MemTransferInfo *TI = &AA.Vector.TransferInfo[MTI];
767 unsigned SrcBegin = TI->SrcIndex->getZExtValue();
768 unsigned DestBegin = TI->DestIndex->getZExtValue();
769
770 SmallVector<int> Mask;
771 for (unsigned Idx = 0; Idx < AA.Vector.Ty->getNumElements(); ++Idx) {
772 if (Idx >= DestBegin && Idx < DestBegin + NumCopied) {
773 Mask.push_back(SrcBegin < AA.Vector.Ty->getNumElements()
774 ? SrcBegin++
776 } else {
777 Mask.push_back(Idx);
778 }
779 }
780
781 return Builder.CreateShuffleVector(GetCurVal(), Mask);
782 }
783
784 if (auto *MSI = dyn_cast<MemSetInst>(Inst)) {
785 // For memset, we don't need to know the previous value because we
786 // currently only allow memsets that cover the whole alloca.
787 Value *Elt = MSI->getOperand(1);
788 const unsigned BytesPerElt = DL.getTypeStoreSize(VecEltTy);
789 if (BytesPerElt > 1) {
790 Value *EltBytes = Builder.CreateVectorSplat(BytesPerElt, Elt);
791
792 // If the element type of the vector is a pointer, we need to first cast
793 // to an integer, then use a PtrCast.
794 if (VecEltTy->isPointerTy()) {
795 Type *PtrInt = Builder.getIntNTy(BytesPerElt * 8);
796 Elt = Builder.CreateBitCast(EltBytes, PtrInt);
797 Elt = Builder.CreateIntToPtr(Elt, VecEltTy);
798 } else
799 Elt = Builder.CreateBitCast(EltBytes, VecEltTy);
800 }
801
802 return Builder.CreateVectorSplat(AA.Vector.Ty->getElementCount(), Elt);
803 }
804
805 if (auto *Intr = dyn_cast<IntrinsicInst>(Inst)) {
806 if (Intr->getIntrinsicID() == Intrinsic::objectsize) {
807 Intr->replaceAllUsesWith(
808 Builder.getIntN(Intr->getType()->getIntegerBitWidth(),
809 DL.getTypeAllocSize(AA.Vector.Ty)));
810 return nullptr;
811 }
812 }
813
814 llvm_unreachable("Unsupported call when promoting alloca to vector");
815 }
816
817 default:
818 llvm_unreachable("Inconsistency in instructions promotable to vector");
819 }
820
821 llvm_unreachable("Did not return after promoting instruction!");
822}
823
824static bool isSupportedAccessType(FixedVectorType *VecTy, Type *AccessTy,
825 const DataLayout &DL) {
826 // Access as a vector type can work if the size of the access vector is a
827 // multiple of the size of the alloca's vector element type.
828 //
829 // Examples:
830 // - VecTy = <8 x float>, AccessTy = <4 x float> -> OK
831 // - VecTy = <4 x double>, AccessTy = <2 x float> -> OK
832 // - VecTy = <4 x double>, AccessTy = <3 x float> -> NOT OK
833 // - 3*32 is not a multiple of 64
834 //
835 // We could handle more complicated cases, but it'd make things a lot more
836 // complicated.
837 if (isa<FixedVectorType>(AccessTy)) {
838 TypeSize AccTS = DL.getTypeStoreSize(AccessTy);
839 // If the type size and the store size don't match, we would need to do more
840 // than just bitcast to translate between an extracted/insertable subvectors
841 // and the accessed value.
842 if (AccTS * 8 != DL.getTypeSizeInBits(AccessTy))
843 return false;
844 TypeSize VecTS = DL.getTypeStoreSize(VecTy->getElementType());
845 return AccTS.isKnownMultipleOf(VecTS);
846 }
847
849 DL);
850}
851
852/// Iterates over an instruction worklist that may contain multiple instructions
853/// from the same basic block, but in a different order.
854template <typename InstContainer>
855static void forEachWorkListItem(const InstContainer &WorkList,
856 std::function<void(Instruction *)> Fn) {
857 // Bucket up uses of the alloca by the block they occur in.
858 // This is important because we have to handle multiple defs/uses in a block
859 // ourselves: SSAUpdater is purely for cross-block references.
861 for (Instruction *User : WorkList)
862 UsesByBlock[User->getParent()].insert(User);
863
864 for (Instruction *User : WorkList) {
865 BasicBlock *BB = User->getParent();
866 auto &BlockUses = UsesByBlock[BB];
867
868 // Already processed, skip.
869 if (BlockUses.empty())
870 continue;
871
872 // Only user in the block, directly process it.
873 if (BlockUses.size() == 1) {
874 Fn(User);
875 continue;
876 }
877
878 // Multiple users in the block, do a linear scan to see users in order.
879 for (Instruction &Inst : *BB) {
880 if (!BlockUses.contains(&Inst))
881 continue;
882
883 Fn(&Inst);
884 }
885
886 // Clear the block so we know it's been processed.
887 BlockUses.clear();
888 }
889}
890
891/// Find an insert point after an alloca, after all other allocas clustered at
892/// the start of the block.
895 for (BasicBlock::iterator E = BB.end(); I != E && isa<AllocaInst>(*I); ++I)
896 ;
897 return I;
898}
899
901AMDGPUPromoteAllocaImpl::getVectorTypeForAlloca(Type *AllocaTy) const {
902 if (DisablePromoteAllocaToVector) {
903 LLVM_DEBUG(dbgs() << " Promote alloca to vectors is disabled\n");
904 return nullptr;
905 }
906
907 auto *VectorTy = dyn_cast<FixedVectorType>(AllocaTy);
908 if (auto *ArrayTy = dyn_cast<ArrayType>(AllocaTy)) {
909 uint64_t NumElems = 1;
910 Type *ElemTy;
911 do {
912 NumElems *= ArrayTy->getNumElements();
913 ElemTy = ArrayTy->getElementType();
914 } while ((ArrayTy = dyn_cast<ArrayType>(ElemTy)));
915
916 // Check for array of vectors
917 auto *InnerVectorTy = dyn_cast<FixedVectorType>(ElemTy);
918 if (InnerVectorTy) {
919 NumElems *= InnerVectorTy->getNumElements();
920 ElemTy = InnerVectorTy->getElementType();
921 }
922
923 if (VectorType::isValidElementType(ElemTy) && NumElems > 0) {
924 unsigned ElementSize = DL.getTypeSizeInBits(ElemTy) / 8;
925 if (ElementSize > 0) {
926 unsigned AllocaSize = DL.getTypeStoreSize(AllocaTy);
927 // Expand vector if required to match padding of inner type,
928 // i.e. odd size subvectors.
929 // Storage size of new vector must match that of alloca for correct
930 // behaviour of byte offsets and GEP computation.
931 if (NumElems * ElementSize != AllocaSize)
932 NumElems = AllocaSize / ElementSize;
933 if (NumElems > 0 && (AllocaSize % ElementSize) == 0)
934 VectorTy = FixedVectorType::get(ElemTy, NumElems);
935 }
936 }
937 }
938 if (!VectorTy) {
939 LLVM_DEBUG(dbgs() << " Cannot convert type to vector\n");
940 return nullptr;
941 }
942
943 const unsigned MaxElements =
944 (MaxVectorRegs * 32) / DL.getTypeSizeInBits(VectorTy->getElementType());
945
946 if (VectorTy->getNumElements() > MaxElements ||
947 VectorTy->getNumElements() < 2) {
948 LLVM_DEBUG(dbgs() << " " << *VectorTy
949 << " has an unsupported number of elements\n");
950 return nullptr;
951 }
952
953 Type *VecEltTy = VectorTy->getElementType();
954 unsigned ElementSizeInBits = DL.getTypeSizeInBits(VecEltTy);
955 if (ElementSizeInBits != DL.getTypeAllocSizeInBits(VecEltTy)) {
956 LLVM_DEBUG(dbgs() << " Cannot convert to vector if the allocation size "
957 "does not match the type's size\n");
958 return nullptr;
959 }
960
961 return VectorTy;
962}
963
964void AMDGPUPromoteAllocaImpl::analyzePromoteToVector(AllocaAnalysis &AA) const {
965 if (AA.HaveSelectOrPHI) {
966 LLVM_DEBUG(dbgs() << " Cannot convert to vector due to select or phi\n");
967 return;
968 }
969
970 Type *AllocaTy = AA.Alloca->getAllocatedType();
971 AA.Vector.Ty = getVectorTypeForAlloca(AllocaTy);
972 if (!AA.Vector.Ty)
973 return;
974
975 const auto RejectUser = [&](Instruction *Inst, Twine Msg) {
976 LLVM_DEBUG(dbgs() << " Cannot promote alloca to vector: " << Msg << "\n"
977 << " " << *Inst << "\n");
978 AA.Vector.Ty = nullptr;
979 };
980
981 Type *VecEltTy = AA.Vector.Ty->getElementType();
982 unsigned ElementSize = DL.getTypeSizeInBits(VecEltTy) / 8;
983 assert(ElementSize > 0);
984 for (auto *U : AA.Uses) {
985 Instruction *Inst = cast<Instruction>(U->getUser());
986
987 if (Value *Ptr = getLoadStorePointerOperand(Inst)) {
988 assert(!isa<StoreInst>(Inst) ||
989 U->getOperandNo() == StoreInst::getPointerOperandIndex());
990
991 Type *AccessTy = getLoadStoreType(Inst);
992 if (AccessTy->isAggregateType())
993 return RejectUser(Inst, "unsupported load/store as aggregate");
994 assert(!AccessTy->isAggregateType() || AccessTy->isArrayTy());
995
996 // Check that this is a simple access of a vector element.
997 bool IsSimple = isa<LoadInst>(Inst) ? cast<LoadInst>(Inst)->isSimple()
998 : cast<StoreInst>(Inst)->isSimple();
999 if (!IsSimple)
1000 return RejectUser(Inst, "not a simple load or store");
1001
1002 Ptr = Ptr->stripPointerCasts();
1003
1004 // Alloca already accessed as vector.
1005 if (Ptr == AA.Alloca &&
1006 DL.getTypeStoreSize(AA.Alloca->getAllocatedType()) ==
1007 DL.getTypeStoreSize(AccessTy)) {
1008 AA.Vector.Worklist.push_back(Inst);
1009 continue;
1010 }
1011
1012 if (!isSupportedAccessType(AA.Vector.Ty, AccessTy, DL))
1013 return RejectUser(Inst, "not a supported access type");
1014
1015 AA.Vector.Worklist.push_back(Inst);
1016 continue;
1017 }
1018
1019 if (auto *GEP = dyn_cast<GetElementPtrInst>(Inst)) {
1020 // If we can't compute a vector index from this GEP, then we can't
1021 // promote this alloca to vector.
1022 auto Index = computeGEPToVectorIndex(GEP, AA.Alloca, VecEltTy, DL);
1023 if (!Index)
1024 return RejectUser(Inst, "cannot compute vector index for GEP");
1025
1026 AA.Vector.GEPVectorIdx[GEP] = std::move(Index.value());
1027 AA.Vector.UsersToRemove.push_back(Inst);
1028 continue;
1029 }
1030
1031 if (MemSetInst *MSI = dyn_cast<MemSetInst>(Inst);
1032 MSI && isSupportedMemset(MSI, AA.Alloca, DL)) {
1033 AA.Vector.Worklist.push_back(Inst);
1034 continue;
1035 }
1036
1037 if (MemTransferInst *TransferInst = dyn_cast<MemTransferInst>(Inst)) {
1038 if (TransferInst->isVolatile())
1039 return RejectUser(Inst, "mem transfer inst is volatile");
1040
1041 ConstantInt *Len = dyn_cast<ConstantInt>(TransferInst->getLength());
1042 if (!Len || (Len->getZExtValue() % ElementSize))
1043 return RejectUser(Inst, "mem transfer inst length is non-constant or "
1044 "not a multiple of the vector element size");
1045
1046 auto getConstIndexIntoAlloca = [&](Value *Ptr) -> ConstantInt * {
1047 if (Ptr == AA.Alloca)
1048 return ConstantInt::get(Ptr->getContext(), APInt(32, 0));
1049
1051 const auto &GEPI = AA.Vector.GEPVectorIdx.find(GEP)->second;
1052 if (GEPI.VarIndex)
1053 return nullptr;
1054 if (GEPI.ConstIndex)
1055 return GEPI.ConstIndex;
1056 return ConstantInt::get(Ptr->getContext(), APInt(32, 0));
1057 };
1058
1059 MemTransferInfo *TI =
1060 &AA.Vector.TransferInfo.try_emplace(TransferInst).first->second;
1061 unsigned OpNum = U->getOperandNo();
1062 if (OpNum == 0) {
1063 Value *Dest = TransferInst->getDest();
1064 ConstantInt *Index = getConstIndexIntoAlloca(Dest);
1065 if (!Index)
1066 return RejectUser(Inst, "could not calculate constant dest index");
1067 TI->DestIndex = Index;
1068 } else {
1069 assert(OpNum == 1);
1070 Value *Src = TransferInst->getSource();
1071 ConstantInt *Index = getConstIndexIntoAlloca(Src);
1072 if (!Index)
1073 return RejectUser(Inst, "could not calculate constant src index");
1074 TI->SrcIndex = Index;
1075 }
1076 continue;
1077 }
1078
1079 if (auto *Intr = dyn_cast<IntrinsicInst>(Inst)) {
1080 if (Intr->getIntrinsicID() == Intrinsic::objectsize) {
1081 AA.Vector.Worklist.push_back(Inst);
1082 continue;
1083 }
1084 }
1085
1086 // Ignore assume-like intrinsics and comparisons used in assumes.
1087 if (isAssumeLikeIntrinsic(Inst)) {
1088 if (!Inst->use_empty())
1089 return RejectUser(Inst, "assume-like intrinsic cannot have any users");
1090 AA.Vector.UsersToRemove.push_back(Inst);
1091 continue;
1092 }
1093
1094 if (isa<ICmpInst>(Inst) && all_of(Inst->users(), [](User *U) {
1095 return isAssumeLikeIntrinsic(cast<Instruction>(U));
1096 })) {
1097 AA.Vector.UsersToRemove.push_back(Inst);
1098 continue;
1099 }
1100
1101 return RejectUser(Inst, "unhandled alloca user");
1102 }
1103
1104 // Follow-up check to ensure we've seen both sides of all transfer insts.
1105 for (const auto &Entry : AA.Vector.TransferInfo) {
1106 const MemTransferInfo &TI = Entry.second;
1107 if (!TI.SrcIndex || !TI.DestIndex)
1108 return RejectUser(Entry.first,
1109 "mem transfer inst between different objects");
1110 AA.Vector.Worklist.push_back(Entry.first);
1111 }
1112}
1113
1114void AMDGPUPromoteAllocaImpl::promoteAllocaToVector(AllocaAnalysis &AA) {
1115 LLVM_DEBUG(dbgs() << "Promoting to vectors: " << *AA.Alloca << '\n');
1116 LLVM_DEBUG(dbgs() << " type conversion: " << *AA.Alloca->getAllocatedType()
1117 << " -> " << *AA.Vector.Ty << '\n');
1118 const unsigned VecStoreSize = DL.getTypeStoreSize(AA.Vector.Ty);
1119
1120 Type *VecEltTy = AA.Vector.Ty->getElementType();
1121 const unsigned ElementSize = DL.getTypeSizeInBits(VecEltTy) / 8;
1122
1123 // Alloca is uninitialized memory. Imitate that by making the first value
1124 // undef.
1125 SSAUpdater Updater;
1126 Updater.Initialize(AA.Vector.Ty, "promotealloca");
1127
1128 BasicBlock *EntryBB = AA.Alloca->getParent();
1129 BasicBlock::iterator InitInsertPos =
1130 skipToNonAllocaInsertPt(*EntryBB, AA.Alloca->getIterator());
1131 IRBuilder<> Builder(&*InitInsertPos);
1132 Value *AllocaInitValue = Builder.CreateFreeze(PoisonValue::get(AA.Vector.Ty));
1133 AllocaInitValue->takeName(AA.Alloca);
1134
1135 Updater.AddAvailableValue(AA.Alloca->getParent(), AllocaInitValue);
1136
1137 // First handle the initial worklist, in basic block order.
1138 //
1139 // Insert a placeholder whenever we need the vector value at the top of a
1140 // basic block.
1142 forEachWorkListItem(AA.Vector.Worklist, [&](Instruction *I) {
1143 BasicBlock *BB = I->getParent();
1144 auto GetCurVal = [&]() -> Value * {
1145 if (Value *CurVal = Updater.FindValueForBlock(BB))
1146 return CurVal;
1147
1148 if (!Placeholders.empty() && Placeholders.back()->getParent() == BB)
1149 return Placeholders.back();
1150
1151 // If the current value in the basic block is not yet known, insert a
1152 // placeholder that we will replace later.
1153 IRBuilder<> Builder(I);
1154 auto *Placeholder = cast<Instruction>(Builder.CreateFreeze(
1155 PoisonValue::get(AA.Vector.Ty), "promotealloca.placeholder"));
1156 Placeholders.insert(Placeholder);
1157 return Placeholders.back();
1158 };
1159
1160 Value *Result = promoteAllocaUserToVector(I, DL, AA, VecStoreSize,
1161 ElementSize, GetCurVal);
1162 // If the returned result is a placeholder, it means the instruction does
1163 // not really modify the alloca. So no need to make it being available value
1164 // to SSAUpdater.
1165 // This will stop placeholder being cached in SSAUpdater. The cached
1166 // placeholder may cause stale pointer being referenced when doing
1167 // placeholder replacement.
1168 if (Result && (!isa<Instruction>(Result) ||
1169 !Placeholders.contains(cast<Instruction>(Result))))
1170 Updater.AddAvailableValue(BB, Result);
1171 });
1172
1173 // Now fixup the placeholders.
1174 for (Instruction *Placeholder : Placeholders) {
1175 Placeholder->replaceAllUsesWith(
1176 Updater.GetValueInMiddleOfBlock(Placeholder->getParent()));
1177 Placeholder->eraseFromParent();
1178 }
1179
1180 // Delete all instructions.
1181 for (Instruction *I : AA.Vector.Worklist) {
1182 assert(I->use_empty());
1183 I->eraseFromParent();
1184 }
1185
1186 // Delete all the users that are known to be removeable.
1187 for (Instruction *I : reverse(AA.Vector.UsersToRemove)) {
1188 I->dropDroppableUses();
1189 assert(I->use_empty());
1190 I->eraseFromParent();
1191 }
1192
1193 // Alloca should now be dead too.
1194 assert(AA.Alloca->use_empty());
1195 AA.Alloca->eraseFromParent();
1196}
1197
1198std::pair<Value *, Value *>
1199AMDGPUPromoteAllocaImpl::getLocalSizeYZ(IRBuilder<> &Builder) {
1200 Function &F = *Builder.GetInsertBlock()->getParent();
1202
1203 if (!IsAMDHSA) {
1204 CallInst *LocalSizeY = Builder.CreateIntrinsicWithoutFolding(
1205 Intrinsic::r600_read_local_size_y, {});
1206 CallInst *LocalSizeZ = Builder.CreateIntrinsicWithoutFolding(
1207 Intrinsic::r600_read_local_size_z, {});
1208
1209 ST.makeLIDRangeMetadata(LocalSizeY);
1210 ST.makeLIDRangeMetadata(LocalSizeZ);
1211
1212 return std::pair(LocalSizeY, LocalSizeZ);
1213 }
1214
1215 // We must read the size out of the dispatch pointer.
1216 assert(IsAMDGCN);
1217
1218 // We are indexing into this struct, and want to extract the workgroup_size_*
1219 // fields.
1220 //
1221 // typedef struct hsa_kernel_dispatch_packet_s {
1222 // uint16_t header;
1223 // uint16_t setup;
1224 // uint16_t workgroup_size_x ;
1225 // uint16_t workgroup_size_y;
1226 // uint16_t workgroup_size_z;
1227 // uint16_t reserved0;
1228 // uint32_t grid_size_x ;
1229 // uint32_t grid_size_y ;
1230 // uint32_t grid_size_z;
1231 //
1232 // uint32_t private_segment_size;
1233 // uint32_t group_segment_size;
1234 // uint64_t kernel_object;
1235 //
1236 // #ifdef HSA_LARGE_MODEL
1237 // void *kernarg_address;
1238 // #elif defined HSA_LITTLE_ENDIAN
1239 // void *kernarg_address;
1240 // uint32_t reserved1;
1241 // #else
1242 // uint32_t reserved1;
1243 // void *kernarg_address;
1244 // #endif
1245 // uint64_t reserved2;
1246 // hsa_signal_t completion_signal; // uint64_t wrapper
1247 // } hsa_kernel_dispatch_packet_t
1248 //
1249 CallInst *DispatchPtr =
1250 Builder.CreateIntrinsicWithoutFolding(Intrinsic::amdgcn_dispatch_ptr, {});
1251 DispatchPtr->addRetAttr(Attribute::NoAlias);
1252 DispatchPtr->addRetAttr(Attribute::NonNull);
1253 F.removeFnAttr("amdgpu-no-dispatch-ptr");
1254
1255 // Size of the dispatch packet struct.
1256 DispatchPtr->addDereferenceableRetAttr(64);
1257
1258 Type *I32Ty = Type::getInt32Ty(Mod.getContext());
1259
1260 // We could do a single 64-bit load here, but it's likely that the basic
1261 // 32-bit and extract sequence is already present, and it is probably easier
1262 // to CSE this. The loads should be mergeable later anyway.
1263 Value *GEPXY = Builder.CreateConstInBoundsGEP1_64(I32Ty, DispatchPtr, 1);
1264 LoadInst *LoadXY = Builder.CreateAlignedLoad(I32Ty, GEPXY, Align(4));
1265
1266 Value *GEPZU = Builder.CreateConstInBoundsGEP1_64(I32Ty, DispatchPtr, 2);
1267 LoadInst *LoadZU = Builder.CreateAlignedLoad(I32Ty, GEPZU, Align(4));
1268
1269 MDNode *MD = MDNode::get(Mod.getContext(), {});
1270 LoadXY->setMetadata(LLVMContext::MD_invariant_load, MD);
1271 LoadZU->setMetadata(LLVMContext::MD_invariant_load, MD);
1272 ST.makeLIDRangeMetadata(LoadZU);
1273
1274 // Extract y component. Upper half of LoadZU should be zero already.
1275 Value *Y = Builder.CreateLShr(LoadXY, 16);
1276
1277 return std::pair(Y, LoadZU);
1278}
1279
1280Value *AMDGPUPromoteAllocaImpl::getWorkitemID(IRBuilder<> &Builder,
1281 unsigned N) {
1282 Function *F = Builder.GetInsertBlock()->getParent();
1285 StringRef AttrName;
1286
1287 switch (N) {
1288 case 0:
1289 IntrID = IsAMDGCN ? (Intrinsic::ID)Intrinsic::amdgcn_workitem_id_x
1290 : (Intrinsic::ID)Intrinsic::r600_read_tidig_x;
1291 AttrName = "amdgpu-no-workitem-id-x";
1292 break;
1293 case 1:
1294 IntrID = IsAMDGCN ? (Intrinsic::ID)Intrinsic::amdgcn_workitem_id_y
1295 : (Intrinsic::ID)Intrinsic::r600_read_tidig_y;
1296 AttrName = "amdgpu-no-workitem-id-y";
1297 break;
1298
1299 case 2:
1300 IntrID = IsAMDGCN ? (Intrinsic::ID)Intrinsic::amdgcn_workitem_id_z
1301 : (Intrinsic::ID)Intrinsic::r600_read_tidig_z;
1302 AttrName = "amdgpu-no-workitem-id-z";
1303 break;
1304 default:
1305 llvm_unreachable("invalid dimension");
1306 }
1307
1308 Function *WorkitemIdFn = Intrinsic::getOrInsertDeclaration(&Mod, IntrID);
1309 CallInst *CI = Builder.CreateCall(WorkitemIdFn);
1310 ST.makeLIDRangeMetadata(CI);
1311 F->removeFnAttr(AttrName);
1312
1313 return CI;
1314}
1315
1316static bool isCallPromotable(CallInst *CI) {
1318 if (!II)
1319 return false;
1320
1321 switch (II->getIntrinsicID()) {
1322 case Intrinsic::memcpy:
1323 case Intrinsic::memmove:
1324 case Intrinsic::memset:
1325 case Intrinsic::lifetime_start:
1326 case Intrinsic::lifetime_end:
1327 case Intrinsic::invariant_start:
1328 case Intrinsic::invariant_end:
1329 case Intrinsic::launder_invariant_group:
1330 case Intrinsic::strip_invariant_group:
1331 case Intrinsic::objectsize:
1332 return true;
1333 default:
1334 return false;
1335 }
1336}
1337
1338bool AMDGPUPromoteAllocaImpl::binaryOpIsDerivedFromSameAlloca(
1339 Value *BaseAlloca, Value *Val, Instruction *Inst, int OpIdx0,
1340 int OpIdx1) const {
1341 // Figure out which operand is the one we might not be promoting.
1342 Value *OtherOp = Inst->getOperand(OpIdx0);
1343 if (Val == OtherOp)
1344 OtherOp = Inst->getOperand(OpIdx1);
1345
1347 return true;
1348
1349 // TODO: getUnderlyingObject will not work on a vector getelementptr
1350 Value *OtherObj = getUnderlyingObject(OtherOp);
1351 if (!isa<AllocaInst>(OtherObj))
1352 return false;
1353
1354 // TODO: We should be able to replace undefs with the right pointer type.
1355
1356 // TODO: If we know the other base object is another promotable
1357 // alloca, not necessarily this alloca, we can do this. The
1358 // important part is both must have the same address space at
1359 // the end.
1360 if (OtherObj != BaseAlloca) {
1361 LLVM_DEBUG(
1362 dbgs() << "Found a binary instruction with another alloca object\n");
1363 return false;
1364 }
1365
1366 return true;
1367}
1368
1369void AMDGPUPromoteAllocaImpl::analyzePromoteToLDS(AllocaAnalysis &AA) const {
1370 if (DisablePromoteAllocaToLDS) {
1371 LLVM_DEBUG(dbgs() << " Promote alloca to LDS is disabled\n");
1372 return;
1373 }
1374
1375 // Don't promote the alloca to LDS for shader calling conventions as the work
1376 // item ID intrinsics are not supported for these calling conventions.
1377 // Furthermore not all LDS is available for some of the stages.
1378 const Function &ContainingFunction = *AA.Alloca->getFunction();
1379 CallingConv::ID CC = ContainingFunction.getCallingConv();
1380
1381 switch (CC) {
1384 break;
1385 default:
1386 LLVM_DEBUG(
1387 dbgs()
1388 << " promote alloca to LDS not supported with calling convention.\n");
1389 return;
1390 }
1391
1392 for (Use *Use : AA.Uses) {
1393 auto *User = Use->getUser();
1394
1395 if (CallInst *CI = dyn_cast<CallInst>(User)) {
1396 if (!isCallPromotable(CI))
1397 return;
1398
1399 if (find(AA.LDS.Worklist, User) == AA.LDS.Worklist.end())
1400 AA.LDS.Worklist.push_back(User);
1401 continue;
1402 }
1403
1405 if (UseInst->getOpcode() == Instruction::PtrToInt)
1406 return;
1407
1408 if (LoadInst *LI = dyn_cast<LoadInst>(UseInst)) {
1409 if (LI->isVolatile())
1410 return;
1411 continue;
1412 }
1413
1414 if (StoreInst *SI = dyn_cast<StoreInst>(UseInst)) {
1415 if (SI->isVolatile())
1416 return;
1417 continue;
1418 }
1419
1420 if (AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(UseInst)) {
1421 if (RMW->isVolatile())
1422 return;
1423 continue;
1424 }
1425
1426 if (AtomicCmpXchgInst *CAS = dyn_cast<AtomicCmpXchgInst>(UseInst)) {
1427 if (CAS->isVolatile())
1428 return;
1429 continue;
1430 }
1431
1432 // Only promote a select if we know that the other select operand
1433 // is from another pointer that will also be promoted.
1434 if (ICmpInst *ICmp = dyn_cast<ICmpInst>(UseInst)) {
1435 if (!binaryOpIsDerivedFromSameAlloca(AA.Alloca, Use->get(), ICmp, 0, 1))
1436 return;
1437
1438 // May need to rewrite constant operands.
1439 if (find(AA.LDS.Worklist, User) == AA.LDS.Worklist.end())
1440 AA.LDS.Worklist.push_back(ICmp);
1441 continue;
1442 }
1443
1445 // Be conservative if an address could be computed outside the bounds of
1446 // the alloca.
1447 if (!GEP->isInBounds())
1448 return;
1450 // Do not promote vector/aggregate type instructions. It is hard to track
1451 // their users.
1452
1453 // Do not promote addrspacecast.
1454 //
1455 // TODO: If we know the address is only observed through flat pointers, we
1456 // could still promote.
1457 return;
1458 }
1459
1460 if (find(AA.LDS.Worklist, User) == AA.LDS.Worklist.end())
1461 AA.LDS.Worklist.push_back(User);
1462 }
1463
1464 AA.LDS.Enable = true;
1465}
1466
1467bool AMDGPUPromoteAllocaImpl::hasSufficientLocalMem(const Function &F) {
1468
1469 FunctionType *FTy = F.getFunctionType();
1471
1472 // If the function has any arguments in the local address space, then it's
1473 // possible these arguments require the entire local memory space, so
1474 // we cannot use local memory in the pass.
1475 for (Type *ParamTy : FTy->params()) {
1476 PointerType *PtrTy = dyn_cast<PointerType>(ParamTy);
1477 if (PtrTy && PtrTy->getAddressSpace() == AMDGPUAS::LOCAL_ADDRESS) {
1478 LocalMemLimit = 0;
1479 LLVM_DEBUG(dbgs() << "Function has local memory argument. Promoting to "
1480 "local memory disabled.\n");
1481 return false;
1482 }
1483 }
1484
1485 LocalMemLimit = ST.getAddressableLocalMemorySize();
1486 if (LocalMemLimit == 0)
1487 return false;
1488
1490 SmallPtrSet<const Constant *, 8> VisitedConstants;
1492
1493 auto visitUsers = [&](const GlobalVariable *GV, const Constant *Val) -> bool {
1494 for (const User *U : Val->users()) {
1495 if (const Instruction *Use = dyn_cast<Instruction>(U)) {
1496 if (Use->getFunction() == &F)
1497 return true;
1498 } else {
1499 const Constant *C = cast<Constant>(U);
1500 if (VisitedConstants.insert(C).second)
1501 Stack.push_back(C);
1502 }
1503 }
1504
1505 return false;
1506 };
1507
1508 for (GlobalVariable &GV : Mod.globals()) {
1510 continue;
1511
1512 if (visitUsers(&GV, &GV)) {
1513 UsedLDS.insert(&GV);
1514 Stack.clear();
1515 continue;
1516 }
1517
1518 // For any ConstantExpr uses, we need to recursively search the users until
1519 // we see a function.
1520 while (!Stack.empty()) {
1521 const Constant *C = Stack.pop_back_val();
1522 if (visitUsers(&GV, C)) {
1523 UsedLDS.insert(&GV);
1524 Stack.clear();
1525 break;
1526 }
1527 }
1528 }
1529
1530 SmallVector<std::pair<uint64_t, Align>, 16> AllocatedSizes;
1531 AllocatedSizes.reserve(UsedLDS.size());
1532
1533 for (const GlobalVariable *GV : UsedLDS) {
1534 Align Alignment =
1535 DL.getValueOrABITypeAlignment(GV->getAlign(), GV->getValueType());
1536 uint64_t AllocSize = GV->getGlobalSize(DL);
1537
1538 // HIP uses an extern unsized array in local address space for dynamically
1539 // allocated shared memory. In that case, we have to disable the promotion.
1540 if (GV->hasExternalLinkage() && AllocSize == 0) {
1541 LocalMemLimit = 0;
1542 LLVM_DEBUG(dbgs() << "Function has a reference to externally allocated "
1543 "local memory. Promoting to local memory "
1544 "disabled.\n");
1545 return false;
1546 }
1547
1548 AllocatedSizes.emplace_back(AllocSize, Alignment);
1549 }
1550
1551 // Sort to try to estimate the worst case alignment padding
1552 //
1553 // FIXME: We should really do something to fix the addresses to a more optimal
1554 // value instead
1555 llvm::sort(AllocatedSizes, llvm::less_second());
1556
1557 // Check how much local memory is being used by global objects
1558 CurrentLocalMemUsage = 0;
1559
1560 // FIXME: Try to account for padding here. The real padding and address is
1561 // currently determined from the inverse order of uses in the function when
1562 // legalizing, which could also potentially change. We try to estimate the
1563 // worst case here, but we probably should fix the addresses earlier.
1564 for (auto Alloc : AllocatedSizes) {
1565 CurrentLocalMemUsage = alignTo(CurrentLocalMemUsage, Alloc.second);
1566 CurrentLocalMemUsage += Alloc.first;
1567 }
1568
1569 unsigned MaxOccupancy =
1570 ST.getWavesPerEU(ST.getFlatWorkGroupSizes(F), CurrentLocalMemUsage, F)
1571 .second;
1572
1573 // Round up to the next tier of usage.
1574 unsigned MaxSizeWithWaveCount =
1575 ST.getMaxLocalMemSizeWithWaveCount(MaxOccupancy, F);
1576
1577 // Program may already use more LDS than is usable at maximum occupancy.
1578 if (CurrentLocalMemUsage > MaxSizeWithWaveCount)
1579 return false;
1580
1581 LocalMemLimit = MaxSizeWithWaveCount;
1582
1583 LLVM_DEBUG(dbgs() << F.getName() << " uses " << CurrentLocalMemUsage
1584 << " bytes of LDS\n"
1585 << " Rounding size to " << MaxSizeWithWaveCount
1586 << " with a maximum occupancy of " << MaxOccupancy << '\n'
1587 << " and " << (LocalMemLimit - CurrentLocalMemUsage)
1588 << " available for promotion\n");
1589
1590 return true;
1591}
1592
1593// FIXME: Should try to pick the most likely to be profitable allocas first.
1594bool AMDGPUPromoteAllocaImpl::tryPromoteAllocaToLDS(
1595 AllocaAnalysis &AA, bool SufficientLDS,
1596 SetVector<IntrinsicInst *> &DeferredIntrs) {
1597 LLVM_DEBUG(dbgs() << "Trying to promote to LDS: " << *AA.Alloca << '\n');
1598
1599 // Not likely to have sufficient local memory for promotion.
1600 if (!SufficientLDS)
1601 return false;
1602
1603 IRBuilder<> Builder(AA.Alloca);
1604
1605 const Function &ContainingFunction = *AA.Alloca->getParent()->getParent();
1606 const AMDGPUSubtarget &ST = AMDGPUSubtarget::get(TM, ContainingFunction);
1607 unsigned WorkGroupSize = ST.getFlatWorkGroupSizes(ContainingFunction).second;
1608
1609 Align Alignment = AA.Alloca->getAlign();
1610
1611 // FIXME: This computed padding is likely wrong since it depends on inverse
1612 // usage order.
1613 //
1614 // FIXME: It is also possible that if we're allowed to use all of the memory
1615 // could end up using more than the maximum due to alignment padding.
1616
1617 uint32_t NewSize = alignTo(CurrentLocalMemUsage, Alignment);
1618 std::optional<TypeSize> ElemSize = AA.Alloca->getAllocationSize(DL);
1619 if (!ElemSize || ElemSize->isScalable())
1620 return false;
1621 TypeSize AllocSize = WorkGroupSize * *ElemSize;
1622 NewSize += AllocSize.getFixedValue();
1623
1624 if (NewSize > LocalMemLimit) {
1625 LLVM_DEBUG(dbgs() << " " << AllocSize
1626 << " bytes of local memory not available to promote\n");
1627 return false;
1628 }
1629
1630 CurrentLocalMemUsage = NewSize;
1631
1632 LLVM_DEBUG(dbgs() << "Promoting alloca to local memory\n");
1633
1634 Function *F = AA.Alloca->getFunction();
1635
1636 Type *GVTy = ArrayType::get(AA.Alloca->getAllocatedType(), WorkGroupSize);
1639 Twine(F->getName()) + Twine('.') + AA.Alloca->getName(), nullptr,
1642 GV->setAlignment(AA.Alloca->getAlign());
1643
1644 Value *TCntY, *TCntZ;
1645
1646 std::tie(TCntY, TCntZ) = getLocalSizeYZ(Builder);
1647 Value *TIdX = getWorkitemID(Builder, 0);
1648 Value *TIdY = getWorkitemID(Builder, 1);
1649 Value *TIdZ = getWorkitemID(Builder, 2);
1650
1651 Value *Tmp0 = Builder.CreateMul(TCntY, TCntZ, "", true, true);
1652 Tmp0 = Builder.CreateMul(Tmp0, TIdX);
1653 Value *Tmp1 = Builder.CreateMul(TIdY, TCntZ, "", true, true);
1654 Value *TID = Builder.CreateAdd(Tmp0, Tmp1);
1655 TID = Builder.CreateAdd(TID, TIdZ);
1656
1657 LLVMContext &Context = Mod.getContext();
1659
1660 Value *Offset = Builder.CreateInBoundsGEP(GVTy, GV, Indices);
1661 AA.Alloca->mutateType(Offset->getType());
1662 AA.Alloca->replaceAllUsesWith(Offset);
1663 AA.Alloca->eraseFromParent();
1664
1666
1667 for (Value *V : AA.LDS.Worklist) {
1669 if (!Call) {
1670 if (ICmpInst *CI = dyn_cast<ICmpInst>(V)) {
1671 Value *LHS = CI->getOperand(0);
1672 Value *RHS = CI->getOperand(1);
1673
1674 Type *NewTy = LHS->getType()->getWithNewType(NewPtrTy);
1676 CI->setOperand(0, Constant::getNullValue(NewTy));
1677
1679 CI->setOperand(1, Constant::getNullValue(NewTy));
1680
1681 continue;
1682 }
1683
1684 // The operand's value should be corrected on its own and we don't want to
1685 // touch the users.
1687 continue;
1688
1689 assert(V->getType()->isPtrOrPtrVectorTy());
1690
1691 Type *NewTy = V->getType()->getWithNewType(NewPtrTy);
1692 V->mutateType(NewTy);
1693
1694 // Adjust the types of any constant operands.
1697 SI->setOperand(1, Constant::getNullValue(NewTy));
1698
1700 SI->setOperand(2, Constant::getNullValue(NewTy));
1701 } else if (PHINode *Phi = dyn_cast<PHINode>(V)) {
1702 for (unsigned I = 0, E = Phi->getNumIncomingValues(); I != E; ++I) {
1704 Phi->getIncomingValue(I)))
1705 Phi->setIncomingValue(I, Constant::getNullValue(NewTy));
1706 }
1707 }
1708
1709 continue;
1710 }
1711
1713 Builder.SetInsertPoint(Intr);
1714 switch (Intr->getIntrinsicID()) {
1715 case Intrinsic::lifetime_start:
1716 case Intrinsic::lifetime_end:
1717 // These intrinsics are for address space 0 only
1718 Intr->eraseFromParent();
1719 continue;
1720 case Intrinsic::memcpy:
1721 case Intrinsic::memmove:
1722 // These have 2 pointer operands. In case if second pointer also needs
1723 // to be replaced we defer processing of these intrinsics until all
1724 // other values are processed.
1725 DeferredIntrs.insert(Intr);
1726 continue;
1727 case Intrinsic::memset: {
1728 MemSetInst *MemSet = cast<MemSetInst>(Intr);
1729 Builder.CreateMemSet(MemSet->getRawDest(), MemSet->getValue(),
1730 MemSet->getLength(), MemSet->getDestAlign(),
1731 MemSet->isVolatile());
1732 Intr->eraseFromParent();
1733 continue;
1734 }
1735 case Intrinsic::invariant_start:
1736 case Intrinsic::invariant_end:
1737 case Intrinsic::launder_invariant_group:
1738 case Intrinsic::strip_invariant_group: {
1740 if (Intr->getIntrinsicID() == Intrinsic::invariant_start) {
1741 Args.emplace_back(Intr->getArgOperand(0));
1742 } else if (Intr->getIntrinsicID() == Intrinsic::invariant_end) {
1743 Args.emplace_back(Intr->getArgOperand(0));
1744 Args.emplace_back(Intr->getArgOperand(1));
1745 }
1746 Args.emplace_back(Offset);
1748 Intr->getModule(), Intr->getIntrinsicID(), Offset->getType());
1749 CallInst *NewIntr =
1750 CallInst::Create(F, Args, Intr->getName(), Intr->getIterator());
1751 Intr->mutateType(NewIntr->getType());
1752 Intr->replaceAllUsesWith(NewIntr);
1753 Intr->eraseFromParent();
1754 continue;
1755 }
1756 case Intrinsic::objectsize: {
1757 Value *Src = Intr->getOperand(0);
1758
1759 Value *NewCall = Builder.CreateIntrinsic(
1760 Intrinsic::objectsize,
1762 {Src, Intr->getOperand(1), Intr->getOperand(2), Intr->getOperand(3)});
1763 Intr->replaceAllUsesWith(NewCall);
1764 Intr->eraseFromParent();
1765 continue;
1766 }
1767 default:
1768 Intr->print(errs());
1769 llvm_unreachable("Don't know how to promote alloca intrinsic use.");
1770 }
1771 }
1772
1773 return true;
1774}
1775
1776void AMDGPUPromoteAllocaImpl::finishDeferredAllocaToLDSPromotion(
1777 SetVector<IntrinsicInst *> &DeferredIntrs) {
1778
1779 for (IntrinsicInst *Intr : DeferredIntrs) {
1780 IRBuilder<> Builder(Intr);
1781 Builder.SetInsertPoint(Intr);
1783 assert(ID == Intrinsic::memcpy || ID == Intrinsic::memmove);
1784
1786 auto *B = Builder.CreateMemTransferInst(
1787 ID, MI->getRawDest(), MI->getDestAlign(), MI->getRawSource(),
1788 MI->getSourceAlign(), MI->getLength(), MI->isVolatile());
1789
1790 for (unsigned I = 0; I != 2; ++I) {
1791 if (uint64_t Bytes = Intr->getParamDereferenceableBytes(I)) {
1792 B->addDereferenceableParamAttr(I, Bytes);
1793 }
1794 }
1795
1796 Intr->eraseFromParent();
1797 }
1798}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
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:381
LLVM_ABI APInt sdiv(const APInt &RHS) const
Signed division function for APInt.
Definition APInt.cpp:1670
LLVM_ABI APInt sextOrTrunc(unsigned width) const
Sign extend or truncate to width.
Definition APInt.cpp:1084
LLVM_ABI APInt srem(const APInt &RHS) const
Function for signed remainder operation.
Definition APInt.cpp:1771
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:587
The legacy pass manager's analysis pass to compute loop information.
Definition LoopInfo.h:612
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:272
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