1 //===-- LoopUnroll.cpp - Loop unroller pass -------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass implements a simple loop unroller. It works best when loops have
11 // been canonicalized by the -indvars pass, allowing it to determine the trip
12 // counts of loops easily.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Transforms/Scalar.h"
16 #include "llvm/ADT/SetVector.h"
17 #include "llvm/Analysis/AssumptionCache.h"
18 #include "llvm/Analysis/CodeMetrics.h"
19 #include "llvm/Analysis/InstructionSimplify.h"
20 #include "llvm/Analysis/LoopPass.h"
21 #include "llvm/Analysis/ScalarEvolution.h"
22 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
23 #include "llvm/Analysis/TargetTransformInfo.h"
24 #include "llvm/IR/DataLayout.h"
25 #include "llvm/IR/DiagnosticInfo.h"
26 #include "llvm/IR/Dominators.h"
27 #include "llvm/IR/InstVisitor.h"
28 #include "llvm/IR/IntrinsicInst.h"
29 #include "llvm/IR/Metadata.h"
30 #include "llvm/Support/CommandLine.h"
31 #include "llvm/Support/Debug.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include "llvm/Transforms/Utils/UnrollLoop.h"
38 #define DEBUG_TYPE "loop-unroll"
40 static cl::opt<unsigned>
41 UnrollThreshold("unroll-threshold", cl::init(150), cl::Hidden,
42 cl::desc("The cut-off point for automatic loop unrolling"));
44 static cl::opt<unsigned> UnrollMaxIterationsCountToAnalyze(
45 "unroll-max-iteration-count-to-analyze", cl::init(0), cl::Hidden,
46 cl::desc("Don't allow loop unrolling to simulate more than this number of"
47 "iterations when checking full unroll profitability"));
49 static cl::opt<unsigned> UnrollMinPercentOfOptimized(
50 "unroll-percent-of-optimized-for-complete-unroll", cl::init(20), cl::Hidden,
51 cl::desc("If complete unrolling could trigger further optimizations, and, "
52 "by that, remove the given percent of instructions, perform the "
53 "complete unroll even if it's beyond the threshold"));
55 static cl::opt<unsigned> UnrollAbsoluteThreshold(
56 "unroll-absolute-threshold", cl::init(2000), cl::Hidden,
57 cl::desc("Don't unroll if the unrolled size is bigger than this threshold,"
58 " even if we can remove big portion of instructions later."));
60 static cl::opt<unsigned>
61 UnrollCount("unroll-count", cl::init(0), cl::Hidden,
62 cl::desc("Use this unroll count for all loops including those with "
63 "unroll_count pragma values, for testing purposes"));
66 UnrollAllowPartial("unroll-allow-partial", cl::init(false), cl::Hidden,
67 cl::desc("Allows loops to be partially unrolled until "
68 "-unroll-threshold loop size is reached."));
71 UnrollRuntime("unroll-runtime", cl::ZeroOrMore, cl::init(false), cl::Hidden,
72 cl::desc("Unroll loops with run-time trip counts"));
74 static cl::opt<unsigned>
75 PragmaUnrollThreshold("pragma-unroll-threshold", cl::init(16 * 1024), cl::Hidden,
76 cl::desc("Unrolled size limit for loops with an unroll(full) or "
77 "unroll_count pragma."));
80 class LoopUnroll : public LoopPass {
82 static char ID; // Pass ID, replacement for typeid
83 LoopUnroll(int T = -1, int C = -1, int P = -1, int R = -1) : LoopPass(ID) {
84 CurrentThreshold = (T == -1) ? UnrollThreshold : unsigned(T);
85 CurrentAbsoluteThreshold = UnrollAbsoluteThreshold;
86 CurrentMinPercentOfOptimized = UnrollMinPercentOfOptimized;
87 CurrentCount = (C == -1) ? UnrollCount : unsigned(C);
88 CurrentAllowPartial = (P == -1) ? UnrollAllowPartial : (bool)P;
89 CurrentRuntime = (R == -1) ? UnrollRuntime : (bool)R;
91 UserThreshold = (T != -1) || (UnrollThreshold.getNumOccurrences() > 0);
92 UserAbsoluteThreshold = (UnrollAbsoluteThreshold.getNumOccurrences() > 0);
93 UserPercentOfOptimized =
94 (UnrollMinPercentOfOptimized.getNumOccurrences() > 0);
95 UserAllowPartial = (P != -1) ||
96 (UnrollAllowPartial.getNumOccurrences() > 0);
97 UserRuntime = (R != -1) || (UnrollRuntime.getNumOccurrences() > 0);
98 UserCount = (C != -1) || (UnrollCount.getNumOccurrences() > 0);
100 initializeLoopUnrollPass(*PassRegistry::getPassRegistry());
103 /// A magic value for use with the Threshold parameter to indicate
104 /// that the loop unroll should be performed regardless of how much
105 /// code expansion would result.
106 static const unsigned NoThreshold = UINT_MAX;
108 // Threshold to use when optsize is specified (and there is no
109 // explicit -unroll-threshold).
110 static const unsigned OptSizeUnrollThreshold = 50;
112 // Default unroll count for loops with run-time trip count if
113 // -unroll-count is not set
114 static const unsigned UnrollRuntimeCount = 8;
116 unsigned CurrentCount;
117 unsigned CurrentThreshold;
118 unsigned CurrentAbsoluteThreshold;
119 unsigned CurrentMinPercentOfOptimized;
120 bool CurrentAllowPartial;
122 bool UserCount; // CurrentCount is user-specified.
123 bool UserThreshold; // CurrentThreshold is user-specified.
124 bool UserAbsoluteThreshold; // CurrentAbsoluteThreshold is
126 bool UserPercentOfOptimized; // CurrentMinPercentOfOptimized is
128 bool UserAllowPartial; // CurrentAllowPartial is user-specified.
129 bool UserRuntime; // CurrentRuntime is user-specified.
131 bool runOnLoop(Loop *L, LPPassManager &LPM) override;
133 /// This transformation requires natural loop information & requires that
134 /// loop preheaders be inserted into the CFG...
136 void getAnalysisUsage(AnalysisUsage &AU) const override {
137 AU.addRequired<AssumptionCacheTracker>();
138 AU.addRequired<LoopInfoWrapperPass>();
139 AU.addPreserved<LoopInfoWrapperPass>();
140 AU.addRequiredID(LoopSimplifyID);
141 AU.addPreservedID(LoopSimplifyID);
142 AU.addRequiredID(LCSSAID);
143 AU.addPreservedID(LCSSAID);
144 AU.addRequired<ScalarEvolution>();
145 AU.addPreserved<ScalarEvolution>();
146 AU.addRequired<TargetTransformInfoWrapperPass>();
147 // FIXME: Loop unroll requires LCSSA. And LCSSA requires dom info.
148 // If loop unroll does not preserve dom info then LCSSA pass on next
149 // loop will receive invalid dom info.
150 // For now, recreate dom info, if loop is unrolled.
151 AU.addPreserved<DominatorTreeWrapperPass>();
154 // Fill in the UnrollingPreferences parameter with values from the
155 // TargetTransformationInfo.
156 void getUnrollingPreferences(Loop *L, const TargetTransformInfo &TTI,
157 TargetTransformInfo::UnrollingPreferences &UP) {
158 UP.Threshold = CurrentThreshold;
159 UP.AbsoluteThreshold = CurrentAbsoluteThreshold;
160 UP.MinPercentOfOptimized = CurrentMinPercentOfOptimized;
161 UP.OptSizeThreshold = OptSizeUnrollThreshold;
162 UP.PartialThreshold = CurrentThreshold;
163 UP.PartialOptSizeThreshold = OptSizeUnrollThreshold;
164 UP.Count = CurrentCount;
165 UP.MaxCount = UINT_MAX;
166 UP.Partial = CurrentAllowPartial;
167 UP.Runtime = CurrentRuntime;
168 UP.AllowExpensiveTripCount = false;
169 TTI.getUnrollingPreferences(L, UP);
172 // Select and return an unroll count based on parameters from
173 // user, unroll preferences, unroll pragmas, or a heuristic.
174 // SetExplicitly is set to true if the unroll count is is set by
175 // the user or a pragma rather than selected heuristically.
177 selectUnrollCount(const Loop *L, unsigned TripCount, bool PragmaFullUnroll,
178 unsigned PragmaCount,
179 const TargetTransformInfo::UnrollingPreferences &UP,
180 bool &SetExplicitly);
182 // Select threshold values used to limit unrolling based on a
183 // total unrolled size. Parameters Threshold and PartialThreshold
184 // are set to the maximum unrolled size for fully and partially
185 // unrolled loops respectively.
186 void selectThresholds(const Loop *L, bool HasPragma,
187 const TargetTransformInfo::UnrollingPreferences &UP,
188 unsigned &Threshold, unsigned &PartialThreshold,
189 unsigned &AbsoluteThreshold,
190 unsigned &PercentOfOptimizedForCompleteUnroll) {
191 // Determine the current unrolling threshold. While this is
192 // normally set from UnrollThreshold, it is overridden to a
193 // smaller value if the current function is marked as
194 // optimize-for-size, and the unroll threshold was not user
196 Threshold = UserThreshold ? CurrentThreshold : UP.Threshold;
197 PartialThreshold = UserThreshold ? CurrentThreshold : UP.PartialThreshold;
198 AbsoluteThreshold = UserAbsoluteThreshold ? CurrentAbsoluteThreshold
199 : UP.AbsoluteThreshold;
200 PercentOfOptimizedForCompleteUnroll = UserPercentOfOptimized
201 ? CurrentMinPercentOfOptimized
202 : UP.MinPercentOfOptimized;
204 if (!UserThreshold &&
205 L->getHeader()->getParent()->hasFnAttribute(
206 Attribute::OptimizeForSize)) {
207 Threshold = UP.OptSizeThreshold;
208 PartialThreshold = UP.PartialOptSizeThreshold;
211 // If the loop has an unrolling pragma, we want to be more
212 // aggressive with unrolling limits. Set thresholds to at
213 // least the PragmaTheshold value which is larger than the
215 if (Threshold != NoThreshold)
216 Threshold = std::max<unsigned>(Threshold, PragmaUnrollThreshold);
217 if (PartialThreshold != NoThreshold)
219 std::max<unsigned>(PartialThreshold, PragmaUnrollThreshold);
222 bool canUnrollCompletely(Loop *L, unsigned Threshold,
223 unsigned AbsoluteThreshold, uint64_t UnrolledSize,
224 unsigned NumberOfOptimizedInstructions,
225 unsigned PercentOfOptimizedForCompleteUnroll);
229 char LoopUnroll::ID = 0;
230 INITIALIZE_PASS_BEGIN(LoopUnroll, "loop-unroll", "Unroll loops", false, false)
231 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
232 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
233 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
234 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
235 INITIALIZE_PASS_DEPENDENCY(LCSSA)
236 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
237 INITIALIZE_PASS_END(LoopUnroll, "loop-unroll", "Unroll loops", false, false)
239 Pass *llvm::createLoopUnrollPass(int Threshold, int Count, int AllowPartial,
241 return new LoopUnroll(Threshold, Count, AllowPartial, Runtime);
244 Pass *llvm::createSimpleLoopUnrollPass() {
245 return llvm::createLoopUnrollPass(-1, -1, 0, 0);
249 /// \brief SCEV expressions visitor used for finding expressions that would
250 /// become constants if the loop L is unrolled.
251 struct FindConstantPointers {
252 /// \brief Shows whether the expression is ConstAddress+Constant or not.
253 bool IndexIsConstant;
255 /// \brief Used for filtering out SCEV expressions with two or more AddRec
258 /// Used to filter out complicated SCEV expressions, having several AddRec
259 /// sub-expressions. We don't handle them, because unrolling one loop
260 /// would help to replace only one of these inductions with a constant, and
261 /// consequently, the expression would remain non-constant.
264 /// \brief If the SCEV expression becomes ConstAddress+Constant, this value
265 /// holds ConstAddress. Otherwise, it's nullptr.
268 /// \brief The loop, which we try to completely unroll.
273 FindConstantPointers(const Loop *L, ScalarEvolution &SE)
274 : IndexIsConstant(true), HaveSeenAR(false), BaseAddress(nullptr),
277 /// Examine the given expression S and figure out, if it can be a part of an
278 /// expression, that could become a constant after the loop is unrolled.
279 /// The routine sets IndexIsConstant and HaveSeenAR according to the analysis
281 /// \returns true if we need to examine subexpressions, and false otherwise.
282 bool follow(const SCEV *S) {
283 if (const SCEVUnknown *SC = dyn_cast<SCEVUnknown>(S)) {
284 // We've reached the leaf node of SCEV, it's most probably just a
286 // If it's the only one SCEV-subexpression, then it might be a base
287 // address of an index expression.
288 // If we've already recorded base address, then just give up on this SCEV
289 // - it's too complicated.
291 IndexIsConstant = false;
294 BaseAddress = SC->getValue();
297 if (isa<SCEVConstant>(S))
299 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
300 // If the current SCEV expression is AddRec, and its loop isn't the loop
301 // we are about to unroll, then we won't get a constant address after
302 // unrolling, and thus, won't be able to eliminate the load.
303 if (AR->getLoop() != L) {
304 IndexIsConstant = false;
307 // We don't handle multiple AddRecs here, so give up in this case.
309 IndexIsConstant = false;
315 // Continue traversal.
318 bool isDone() const { return !IndexIsConstant; }
320 } // End anonymous namespace.
323 /// \brief Struct to represent a GEP whose start and step are known fixed
324 /// offsets from a base address due to SCEV's analysis.
325 struct SCEVGEPDescriptor {
330 } // End anonymous namespace.
332 /// \brief Build a cache of all the GEP instructions which SCEV can describe.
334 /// Visit all GEPs in the loop and find those which after complete loop
335 /// unrolling would become a constant, or BaseAddress+Constant. For those where
336 /// we can identify small constant starts and steps from a base address, return
337 /// a map from the GEP to the base, start, and step relevant for that GEP. This
338 /// is essentially a simplified and fast to query form of the SCEV analysis
339 /// which we can afford to look into repeatedly for different iterations of the
341 static SmallDenseMap<Value *, SCEVGEPDescriptor>
342 buildSCEVGEPCache(const Loop &L, ScalarEvolution &SE) {
343 SmallDenseMap<Value *, SCEVGEPDescriptor> Cache;
345 for (auto BB : L.getBlocks()) {
346 for (Instruction &I : *BB) {
347 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(&I)) {
348 Value *V = cast<Value>(GEP);
349 if (!SE.isSCEVable(V->getType()))
351 const SCEV *S = SE.getSCEV(V);
352 // FIXME: Hoist the initialization out of the loop.
353 FindConstantPointers Visitor(&L, SE);
354 SCEVTraversal<FindConstantPointers> T(Visitor);
355 // Try to find (BaseAddress+Step+Offset) tuple.
356 // If succeeded, save it to the cache - it might help in folding
359 if (!Visitor.IndexIsConstant || !Visitor.BaseAddress)
362 const SCEV *BaseAddrSE = SE.getSCEV(Visitor.BaseAddress);
363 if (BaseAddrSE->getType() != S->getType())
365 const SCEV *OffSE = SE.getMinusSCEV(S, BaseAddrSE);
366 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(OffSE);
371 const SCEVConstant *StepSE =
372 dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE));
373 const SCEVConstant *StartSE = dyn_cast<SCEVConstant>(AR->getStart());
374 if (!StepSE || !StartSE)
377 // Check and skip caching if doing so would require lots of bits to
379 APInt Start = StartSE->getValue()->getValue();
380 APInt Step = StepSE->getValue()->getValue();
381 if (Start.getActiveBits() > 32 || Step.getActiveBits() > 32)
384 // We found a cacheable SCEV model for the GEP.
385 Cache[V] = {Visitor.BaseAddress,
386 (unsigned)Start.getLimitedValue(),
387 (unsigned)Step.getLimitedValue()};
396 // This class is used to get an estimate of the optimization effects that we
397 // could get from complete loop unrolling. It comes from the fact that some
398 // loads might be replaced with concrete constant values and that could trigger
399 // a chain of instruction simplifications.
401 // E.g. we might have:
402 // int a[] = {0, 1, 0};
404 // for (i = 0; i < 3; i ++)
406 // If we completely unroll the loop, we would get:
407 // v = b[0]*a[0] + b[1]*a[1] + b[2]*a[2]
408 // Which then will be simplified to:
409 // v = b[0]* 0 + b[1]* 1 + b[2]* 0
412 class UnrollAnalyzer : public InstVisitor<UnrollAnalyzer, bool> {
413 typedef InstVisitor<UnrollAnalyzer, bool> Base;
414 friend class InstVisitor<UnrollAnalyzer, bool>;
416 /// \brief The loop we're going to analyze.
419 /// \brief TripCount of the given loop.
424 const TargetTransformInfo &TTI;
426 // While we walk the loop instructions, we we build up and maintain a mapping
427 // of simplified values specific to this iteration. The idea is to propagate
428 // any special information we have about loads that can be replaced with
429 // constants after complete unrolling, and account for likely simplifications
431 DenseMap<Value *, Constant *> SimplifiedValues;
433 // To avoid requesting SCEV info on every iteration, request it once, and
434 // for each value that would become ConstAddress+Constant after loop
435 // unrolling, save the corresponding data.
436 SmallDenseMap<Value *, SCEVGEPDescriptor> SCEVGEPCache;
438 /// \brief Number of currently simulated iteration.
440 /// If an expression is ConstAddress+Constant, then the Constant is
441 /// Start + Iteration*Step, where Start and Step could be obtained from
445 /// \brief Upper threshold for complete unrolling.
446 unsigned MaxUnrolledLoopSize;
448 /// Base case for the instruction visitor.
449 bool visitInstruction(Instruction &I) { return false; };
451 /// TODO: Add visitors for other instruction types, e.g. ZExt, SExt.
453 /// Try to simplify binary operator I.
455 /// TODO: Probaly it's worth to hoist the code for estimating the
456 /// simplifications effects to a separate class, since we have a very similar
457 /// code in InlineCost already.
458 bool visitBinaryOperator(BinaryOperator &I) {
459 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
460 if (!isa<Constant>(LHS))
461 if (Constant *SimpleLHS = SimplifiedValues.lookup(LHS))
463 if (!isa<Constant>(RHS))
464 if (Constant *SimpleRHS = SimplifiedValues.lookup(RHS))
466 Value *SimpleV = nullptr;
467 const DataLayout &DL = I.getModule()->getDataLayout();
468 if (auto FI = dyn_cast<FPMathOperator>(&I))
470 SimplifyFPBinOp(I.getOpcode(), LHS, RHS, FI->getFastMathFlags(), DL);
472 SimpleV = SimplifyBinOp(I.getOpcode(), LHS, RHS, DL);
474 if (Constant *C = dyn_cast_or_null<Constant>(SimpleV))
475 SimplifiedValues[&I] = C;
480 /// Try to fold load I.
481 bool visitLoad(LoadInst &I) {
482 Value *AddrOp = I.getPointerOperand();
483 if (!isa<Constant>(AddrOp))
484 if (Constant *SimplifiedAddrOp = SimplifiedValues.lookup(AddrOp))
485 AddrOp = SimplifiedAddrOp;
487 auto It = SCEVGEPCache.find(AddrOp);
488 if (It == SCEVGEPCache.end())
490 SCEVGEPDescriptor GEPDesc = It->second;
492 auto GV = dyn_cast<GlobalVariable>(GEPDesc.BaseAddr);
493 // We're only interested in loads that can be completely folded to a
495 if (!GV || !GV->hasInitializer())
498 ConstantDataSequential *CDS =
499 dyn_cast<ConstantDataSequential>(GV->getInitializer());
503 // This calculation should never overflow because we bound Iteration quite
504 // low and both the start and step are 32-bit integers. We use signed
505 // integers so that UBSan will catch if a bug sneaks into the code.
506 int ElemSize = CDS->getElementType()->getPrimitiveSizeInBits() / 8U;
507 int64_t Index = ((int64_t)GEPDesc.Start +
508 (int64_t)GEPDesc.Step * (int64_t)Iteration) /
510 if (Index >= CDS->getNumElements()) {
511 // FIXME: For now we conservatively ignore out of bound accesses, but
512 // we're allowed to perform the optimization in this case.
516 Constant *CV = CDS->getElementAsConstant(Index);
517 assert(CV && "Constant expected.");
518 SimplifiedValues[&I] = CV;
524 UnrollAnalyzer(const Loop *L, unsigned TripCount, ScalarEvolution &SE,
525 const TargetTransformInfo &TTI, unsigned MaxUnrolledLoopSize)
526 : L(L), TripCount(TripCount), SE(SE), TTI(TTI),
527 MaxUnrolledLoopSize(MaxUnrolledLoopSize),
528 NumberOfOptimizedInstructions(0), UnrolledLoopSize(0) {}
530 /// \brief Count the number of optimized instructions.
531 unsigned NumberOfOptimizedInstructions;
533 /// \brief Count the total number of instructions.
534 unsigned UnrolledLoopSize;
536 /// \brief Figure out if the loop is worth full unrolling.
538 /// Complete loop unrolling can make some loads constant, and we need to know
539 /// if that would expose any further optimization opportunities. This routine
540 /// estimates this optimization. It assigns computed number of instructions,
541 /// that potentially might be optimized away, to
542 /// NumberOfOptimizedInstructions, and total number of instructions to
543 /// UnrolledLoopSize (not counting blocks that won't be reached, if we were
544 /// able to compute the condition).
545 /// \returns false if we can't analyze the loop, or if we discovered that
546 /// unrolling won't give anything. Otherwise, returns true.
548 SmallSetVector<BasicBlock *, 16> BBWorklist;
550 // We want to be able to scale offsets by the trip count and add more
551 // offsets to them without checking for overflows, and we already don't want
552 // to analyze *massive* trip counts, so we force the max to be reasonably
554 assert(UnrollMaxIterationsCountToAnalyze < (INT_MAX / 2) &&
555 "The unroll iterations max is too large!");
557 // Don't simulate loops with a big or unknown tripcount
558 if (!UnrollMaxIterationsCountToAnalyze || !TripCount ||
559 TripCount > UnrollMaxIterationsCountToAnalyze)
562 // To avoid compute SCEV-expressions on every iteration, compute them once
563 // and store interesting to us in SCEVGEPCache.
564 SCEVGEPCache = buildSCEVGEPCache(*L, SE);
566 // Simulate execution of each iteration of the loop counting instructions,
567 // which would be simplified.
568 // Since the same load will take different values on different iterations,
569 // we literally have to go through all loop's iterations.
570 for (Iteration = 0; Iteration < TripCount; ++Iteration) {
571 SimplifiedValues.clear();
573 BBWorklist.insert(L->getHeader());
574 // Note that we *must not* cache the size, this loop grows the worklist.
575 for (unsigned Idx = 0; Idx != BBWorklist.size(); ++Idx) {
576 BasicBlock *BB = BBWorklist[Idx];
578 // Visit all instructions in the given basic block and try to simplify
579 // it. We don't change the actual IR, just count optimization
581 for (Instruction &I : *BB) {
582 UnrolledLoopSize += TTI.getUserCost(&I);
584 // Visit the instruction to analyze its loop cost after unrolling,
585 // and if the visitor returns true, then we can optimize this
588 NumberOfOptimizedInstructions += TTI.getUserCost(&I);
590 // If unrolled body turns out to be too big, bail out.
591 if (UnrolledLoopSize - NumberOfOptimizedInstructions >
596 // Add BB's successors to the worklist.
597 for (BasicBlock *Succ : successors(BB))
598 if (L->contains(Succ))
599 BBWorklist.insert(Succ);
602 // If we found no optimization opportunities on the first iteration, we
603 // won't find them on later ones too.
604 if (!NumberOfOptimizedInstructions)
612 /// ApproximateLoopSize - Approximate the size of the loop.
613 static unsigned ApproximateLoopSize(const Loop *L, unsigned &NumCalls,
614 bool &NotDuplicatable,
615 const TargetTransformInfo &TTI,
616 AssumptionCache *AC) {
617 SmallPtrSet<const Value *, 32> EphValues;
618 CodeMetrics::collectEphemeralValues(L, AC, EphValues);
621 for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
623 Metrics.analyzeBasicBlock(*I, TTI, EphValues);
624 NumCalls = Metrics.NumInlineCandidates;
625 NotDuplicatable = Metrics.notDuplicatable;
627 unsigned LoopSize = Metrics.NumInsts;
629 // Don't allow an estimate of size zero. This would allows unrolling of loops
630 // with huge iteration counts, which is a compile time problem even if it's
631 // not a problem for code quality. Also, the code using this size may assume
632 // that each loop has at least three instructions (likely a conditional
633 // branch, a comparison feeding that branch, and some kind of loop increment
634 // feeding that comparison instruction).
635 LoopSize = std::max(LoopSize, 3u);
640 // Returns the loop hint metadata node with the given name (for example,
641 // "llvm.loop.unroll.count"). If no such metadata node exists, then nullptr is
643 static MDNode *GetUnrollMetadataForLoop(const Loop *L, StringRef Name) {
644 if (MDNode *LoopID = L->getLoopID())
645 return GetUnrollMetadata(LoopID, Name);
649 // Returns true if the loop has an unroll(full) pragma.
650 static bool HasUnrollFullPragma(const Loop *L) {
651 return GetUnrollMetadataForLoop(L, "llvm.loop.unroll.full");
654 // Returns true if the loop has an unroll(disable) pragma.
655 static bool HasUnrollDisablePragma(const Loop *L) {
656 return GetUnrollMetadataForLoop(L, "llvm.loop.unroll.disable");
659 // Returns true if the loop has an runtime unroll(disable) pragma.
660 static bool HasRuntimeUnrollDisablePragma(const Loop *L) {
661 return GetUnrollMetadataForLoop(L, "llvm.loop.unroll.runtime.disable");
664 // If loop has an unroll_count pragma return the (necessarily
665 // positive) value from the pragma. Otherwise return 0.
666 static unsigned UnrollCountPragmaValue(const Loop *L) {
667 MDNode *MD = GetUnrollMetadataForLoop(L, "llvm.loop.unroll.count");
669 assert(MD->getNumOperands() == 2 &&
670 "Unroll count hint metadata should have two operands.");
672 mdconst::extract<ConstantInt>(MD->getOperand(1))->getZExtValue();
673 assert(Count >= 1 && "Unroll count must be positive.");
679 // Remove existing unroll metadata and add unroll disable metadata to
680 // indicate the loop has already been unrolled. This prevents a loop
681 // from being unrolled more than is directed by a pragma if the loop
682 // unrolling pass is run more than once (which it generally is).
683 static void SetLoopAlreadyUnrolled(Loop *L) {
684 MDNode *LoopID = L->getLoopID();
687 // First remove any existing loop unrolling metadata.
688 SmallVector<Metadata *, 4> MDs;
689 // Reserve first location for self reference to the LoopID metadata node.
690 MDs.push_back(nullptr);
691 for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i) {
692 bool IsUnrollMetadata = false;
693 MDNode *MD = dyn_cast<MDNode>(LoopID->getOperand(i));
695 const MDString *S = dyn_cast<MDString>(MD->getOperand(0));
696 IsUnrollMetadata = S && S->getString().startswith("llvm.loop.unroll.");
698 if (!IsUnrollMetadata)
699 MDs.push_back(LoopID->getOperand(i));
702 // Add unroll(disable) metadata to disable future unrolling.
703 LLVMContext &Context = L->getHeader()->getContext();
704 SmallVector<Metadata *, 1> DisableOperands;
705 DisableOperands.push_back(MDString::get(Context, "llvm.loop.unroll.disable"));
706 MDNode *DisableNode = MDNode::get(Context, DisableOperands);
707 MDs.push_back(DisableNode);
709 MDNode *NewLoopID = MDNode::get(Context, MDs);
710 // Set operand 0 to refer to the loop id itself.
711 NewLoopID->replaceOperandWith(0, NewLoopID);
712 L->setLoopID(NewLoopID);
715 bool LoopUnroll::canUnrollCompletely(
716 Loop *L, unsigned Threshold, unsigned AbsoluteThreshold,
717 uint64_t UnrolledSize, unsigned NumberOfOptimizedInstructions,
718 unsigned PercentOfOptimizedForCompleteUnroll) {
720 if (Threshold == NoThreshold) {
721 DEBUG(dbgs() << " Can fully unroll, because no threshold is set.\n");
725 if (UnrolledSize <= Threshold) {
726 DEBUG(dbgs() << " Can fully unroll, because unrolled size: "
727 << UnrolledSize << "<" << Threshold << "\n");
731 assert(UnrolledSize && "UnrolledSize can't be 0 at this point.");
732 unsigned PercentOfOptimizedInstructions =
733 (uint64_t)NumberOfOptimizedInstructions * 100ull / UnrolledSize;
735 if (UnrolledSize <= AbsoluteThreshold &&
736 PercentOfOptimizedInstructions >= PercentOfOptimizedForCompleteUnroll) {
737 DEBUG(dbgs() << " Can fully unroll, because unrolling will help removing "
738 << PercentOfOptimizedInstructions
739 << "% instructions (threshold: "
740 << PercentOfOptimizedForCompleteUnroll << "%)\n");
741 DEBUG(dbgs() << " Unrolled size (" << UnrolledSize
742 << ") is less than the threshold (" << AbsoluteThreshold
747 DEBUG(dbgs() << " Too large to fully unroll:\n");
748 DEBUG(dbgs() << " Unrolled size: " << UnrolledSize << "\n");
749 DEBUG(dbgs() << " Estimated number of optimized instructions: "
750 << NumberOfOptimizedInstructions << "\n");
751 DEBUG(dbgs() << " Absolute threshold: " << AbsoluteThreshold << "\n");
752 DEBUG(dbgs() << " Minimum percent of removed instructions: "
753 << PercentOfOptimizedForCompleteUnroll << "\n");
754 DEBUG(dbgs() << " Threshold for small loops: " << Threshold << "\n");
758 unsigned LoopUnroll::selectUnrollCount(
759 const Loop *L, unsigned TripCount, bool PragmaFullUnroll,
760 unsigned PragmaCount, const TargetTransformInfo::UnrollingPreferences &UP,
761 bool &SetExplicitly) {
762 SetExplicitly = true;
764 // User-specified count (either as a command-line option or
765 // constructor parameter) has highest precedence.
766 unsigned Count = UserCount ? CurrentCount : 0;
768 // If there is no user-specified count, unroll pragmas have the next
769 // highest precendence.
773 } else if (PragmaFullUnroll) {
782 SetExplicitly = false;
784 // Runtime trip count.
785 Count = UnrollRuntimeCount;
787 // Conservative heuristic: if we know the trip count, see if we can
788 // completely unroll (subject to the threshold, checked below); otherwise
789 // try to find greatest modulo of the trip count which is still under
793 if (TripCount && Count > TripCount)
798 bool LoopUnroll::runOnLoop(Loop *L, LPPassManager &LPM) {
799 if (skipOptnoneFunction(L))
802 Function &F = *L->getHeader()->getParent();
804 LoopInfo *LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
805 ScalarEvolution *SE = &getAnalysis<ScalarEvolution>();
806 const TargetTransformInfo &TTI =
807 getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F);
808 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
810 BasicBlock *Header = L->getHeader();
811 DEBUG(dbgs() << "Loop Unroll: F[" << Header->getParent()->getName()
812 << "] Loop %" << Header->getName() << "\n");
814 if (HasUnrollDisablePragma(L)) {
817 bool PragmaFullUnroll = HasUnrollFullPragma(L);
818 unsigned PragmaCount = UnrollCountPragmaValue(L);
819 bool HasPragma = PragmaFullUnroll || PragmaCount > 0;
821 TargetTransformInfo::UnrollingPreferences UP;
822 getUnrollingPreferences(L, TTI, UP);
824 // Find trip count and trip multiple if count is not available
825 unsigned TripCount = 0;
826 unsigned TripMultiple = 1;
827 // If there are multiple exiting blocks but one of them is the latch, use the
828 // latch for the trip count estimation. Otherwise insist on a single exiting
829 // block for the trip count estimation.
830 BasicBlock *ExitingBlock = L->getLoopLatch();
831 if (!ExitingBlock || !L->isLoopExiting(ExitingBlock))
832 ExitingBlock = L->getExitingBlock();
834 TripCount = SE->getSmallConstantTripCount(L, ExitingBlock);
835 TripMultiple = SE->getSmallConstantTripMultiple(L, ExitingBlock);
838 // Select an initial unroll count. This may be reduced later based
839 // on size thresholds.
840 bool CountSetExplicitly;
841 unsigned Count = selectUnrollCount(L, TripCount, PragmaFullUnroll,
842 PragmaCount, UP, CountSetExplicitly);
844 unsigned NumInlineCandidates;
845 bool notDuplicatable;
847 ApproximateLoopSize(L, NumInlineCandidates, notDuplicatable, TTI, &AC);
848 DEBUG(dbgs() << " Loop Size = " << LoopSize << "\n");
850 // When computing the unrolled size, note that the conditional branch on the
851 // backedge and the comparison feeding it are not replicated like the rest of
852 // the loop body (which is why 2 is subtracted).
853 uint64_t UnrolledSize = (uint64_t)(LoopSize-2) * Count + 2;
854 if (notDuplicatable) {
855 DEBUG(dbgs() << " Not unrolling loop which contains non-duplicatable"
856 << " instructions.\n");
859 if (NumInlineCandidates != 0) {
860 DEBUG(dbgs() << " Not unrolling loop with inlinable calls.\n");
864 unsigned Threshold, PartialThreshold;
865 unsigned AbsoluteThreshold, PercentOfOptimizedForCompleteUnroll;
866 selectThresholds(L, HasPragma, UP, Threshold, PartialThreshold,
867 AbsoluteThreshold, PercentOfOptimizedForCompleteUnroll);
869 // Given Count, TripCount and thresholds determine the type of
870 // unrolling which is to be performed.
871 enum { Full = 0, Partial = 1, Runtime = 2 };
873 if (TripCount && Count == TripCount) {
875 // If the loop is really small, we don't need to run an expensive analysis.
876 if (canUnrollCompletely(
877 L, Threshold, AbsoluteThreshold,
878 UnrolledSize, 0, 100)) {
881 // The loop isn't that small, but we still can fully unroll it if that
882 // helps to remove a significant number of instructions.
883 // To check that, run additional analysis on the loop.
884 UnrollAnalyzer UA(L, TripCount, *SE, TTI, AbsoluteThreshold);
885 if (UA.analyzeLoop() &&
886 canUnrollCompletely(L, Threshold, AbsoluteThreshold,
888 UA.NumberOfOptimizedInstructions,
889 PercentOfOptimizedForCompleteUnroll)) {
893 } else if (TripCount && Count < TripCount) {
899 // Reduce count based on the type of unrolling and the threshold values.
900 unsigned OriginalCount = Count;
901 bool AllowRuntime = UserRuntime ? CurrentRuntime : UP.Runtime;
902 if (HasRuntimeUnrollDisablePragma(L)) {
903 AllowRuntime = false;
905 if (Unrolling == Partial) {
906 bool AllowPartial = UserAllowPartial ? CurrentAllowPartial : UP.Partial;
907 if (!AllowPartial && !CountSetExplicitly) {
908 DEBUG(dbgs() << " will not try to unroll partially because "
909 << "-unroll-allow-partial not given\n");
912 if (PartialThreshold != NoThreshold && UnrolledSize > PartialThreshold) {
913 // Reduce unroll count to be modulo of TripCount for partial unrolling.
914 Count = (std::max(PartialThreshold, 3u)-2) / (LoopSize-2);
915 while (Count != 0 && TripCount % Count != 0)
918 } else if (Unrolling == Runtime) {
919 if (!AllowRuntime && !CountSetExplicitly) {
920 DEBUG(dbgs() << " will not try to unroll loop with runtime trip count "
921 << "-unroll-runtime not given\n");
924 // Reduce unroll count to be the largest power-of-two factor of
925 // the original count which satisfies the threshold limit.
926 while (Count != 0 && UnrolledSize > PartialThreshold) {
928 UnrolledSize = (LoopSize-2) * Count + 2;
930 if (Count > UP.MaxCount)
932 DEBUG(dbgs() << " partially unrolling with count: " << Count << "\n");
936 if (PragmaCount != 0)
937 // If loop has an unroll count pragma mark loop as unrolled to prevent
938 // unrolling beyond that requested by the pragma.
939 SetLoopAlreadyUnrolled(L);
941 // Emit optimization remarks if we are unable to unroll the loop
942 // as directed by a pragma.
943 DebugLoc LoopLoc = L->getStartLoc();
944 Function *F = Header->getParent();
945 LLVMContext &Ctx = F->getContext();
946 if (PragmaFullUnroll && PragmaCount == 0) {
947 if (TripCount && Count != TripCount) {
948 emitOptimizationRemarkMissed(
949 Ctx, DEBUG_TYPE, *F, LoopLoc,
950 "Unable to fully unroll loop as directed by unroll(full) pragma "
951 "because unrolled size is too large.");
952 } else if (!TripCount) {
953 emitOptimizationRemarkMissed(
954 Ctx, DEBUG_TYPE, *F, LoopLoc,
955 "Unable to fully unroll loop as directed by unroll(full) pragma "
956 "because loop has a runtime trip count.");
958 } else if (PragmaCount > 0 && Count != OriginalCount) {
959 emitOptimizationRemarkMissed(
960 Ctx, DEBUG_TYPE, *F, LoopLoc,
961 "Unable to unroll loop the number of times directed by "
962 "unroll_count pragma because unrolled size is too large.");
966 if (Unrolling != Full && Count < 2) {
967 // Partial unrolling by 1 is a nop. For full unrolling, a factor
968 // of 1 makes sense because loop control can be eliminated.
973 if (!UnrollLoop(L, Count, TripCount, AllowRuntime, UP.AllowExpensiveTripCount,
974 TripMultiple, LI, this, &LPM, &AC))