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; }
321 // This class is used to get an estimate of the optimization effects that we
322 // could get from complete loop unrolling. It comes from the fact that some
323 // loads might be replaced with concrete constant values and that could trigger
324 // a chain of instruction simplifications.
326 // E.g. we might have:
327 // int a[] = {0, 1, 0};
329 // for (i = 0; i < 3; i ++)
331 // If we completely unroll the loop, we would get:
332 // v = b[0]*a[0] + b[1]*a[1] + b[2]*a[2]
333 // Which then will be simplified to:
334 // v = b[0]* 0 + b[1]* 1 + b[2]* 0
337 class UnrollAnalyzer : public InstVisitor<UnrollAnalyzer, bool> {
338 typedef InstVisitor<UnrollAnalyzer, bool> Base;
339 friend class InstVisitor<UnrollAnalyzer, bool>;
341 struct SCEVGEPDescriptor {
347 /// \brief The loop we're going to analyze.
350 /// \brief TripCount of the given loop.
355 const TargetTransformInfo &TTI;
357 // While we walk the loop instructions, we we build up and maintain a mapping
358 // of simplified values specific to this iteration. The idea is to propagate
359 // any special information we have about loads that can be replaced with
360 // constants after complete unrolling, and account for likely simplifications
362 DenseMap<Value *, Constant *> SimplifiedValues;
364 // To avoid requesting SCEV info on every iteration, request it once, and
365 // for each value that would become ConstAddress+Constant after loop
366 // unrolling, save the corresponding data.
367 SmallDenseMap<Value *, SCEVGEPDescriptor> SCEVCache;
369 /// \brief Number of currently simulated iteration.
371 /// If an expression is ConstAddress+Constant, then the Constant is
372 /// Start + Iteration*Step, where Start and Step could be obtained from
376 /// \brief Upper threshold for complete unrolling.
377 unsigned MaxUnrolledLoopSize;
379 /// Base case for the instruction visitor.
380 bool visitInstruction(Instruction &I) { return false; };
382 /// TODO: Add visitors for other instruction types, e.g. ZExt, SExt.
384 /// Try to simplify binary operator I.
386 /// TODO: Probaly it's worth to hoist the code for estimating the
387 /// simplifications effects to a separate class, since we have a very similar
388 /// code in InlineCost already.
389 bool visitBinaryOperator(BinaryOperator &I) {
390 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
391 if (!isa<Constant>(LHS))
392 if (Constant *SimpleLHS = SimplifiedValues.lookup(LHS))
394 if (!isa<Constant>(RHS))
395 if (Constant *SimpleRHS = SimplifiedValues.lookup(RHS))
397 Value *SimpleV = nullptr;
398 const DataLayout &DL = I.getModule()->getDataLayout();
399 if (auto FI = dyn_cast<FPMathOperator>(&I))
401 SimplifyFPBinOp(I.getOpcode(), LHS, RHS, FI->getFastMathFlags(), DL);
403 SimpleV = SimplifyBinOp(I.getOpcode(), LHS, RHS, DL);
406 NumberOfOptimizedInstructions += TTI.getUserCost(&I);
408 if (Constant *C = dyn_cast_or_null<Constant>(SimpleV)) {
409 SimplifiedValues[&I] = C;
415 /// Try to fold load I.
416 bool visitLoad(LoadInst &I) {
417 Value *AddrOp = I.getPointerOperand();
418 if (!isa<Constant>(AddrOp))
419 if (Constant *SimplifiedAddrOp = SimplifiedValues.lookup(AddrOp))
420 AddrOp = SimplifiedAddrOp;
422 auto It = SCEVCache.find(AddrOp);
423 if (It == SCEVCache.end())
425 SCEVGEPDescriptor GEPDesc = It->second;
427 auto GV = dyn_cast<GlobalVariable>(GEPDesc.BaseAddr);
428 // We're only interested in loads that can be completely folded to a
430 if (!GV || !GV->hasInitializer())
433 ConstantDataSequential *CDS =
434 dyn_cast<ConstantDataSequential>(GV->getInitializer());
438 // This calculation should never overflow because we bound Iteration quite
439 // low and both the start and step are 32-bit integers. We use signed
440 // integers so that UBSan will catch if a bug sneaks into the code.
441 int ElemSize = CDS->getElementType()->getPrimitiveSizeInBits() / 8U;
442 int64_t Index = ((int64_t)GEPDesc.Start +
443 (int64_t)GEPDesc.Step * (int64_t)Iteration) /
445 if (Index >= CDS->getNumElements()) {
446 // FIXME: For now we conservatively ignore out of bound accesses, but
447 // we're allowed to perform the optimization in this case.
451 Constant *CV = CDS->getElementAsConstant(Index);
452 assert(CV && "Constant expected.");
453 SimplifiedValues[&I] = CV;
455 NumberOfOptimizedInstructions += TTI.getUserCost(&I);
459 /// Visit all GEPs in the loop and find those which after complete loop
460 /// unrolling would become a constant, or BaseAddress+Constant.
462 /// Such GEPs could allow to evaluate a load to a constant later - for now we
463 /// just store the corresponding BaseAddress and StartValue with StepValue in
465 void cacheSCEVResults() {
466 for (auto BB : L->getBlocks()) {
467 for (Instruction &I : *BB) {
468 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(&I)) {
469 Value *V = cast<Value>(GEP);
470 if (!SE.isSCEVable(V->getType()))
472 const SCEV *S = SE.getSCEV(V);
473 // FIXME: Hoist the initialization out of the loop.
474 FindConstantPointers Visitor(L, SE);
475 SCEVTraversal<FindConstantPointers> T(Visitor);
476 // Try to find (BaseAddress+Step+Offset) tuple.
477 // If succeeded, save it to the cache - it might help in folding
480 if (!Visitor.IndexIsConstant || !Visitor.BaseAddress)
483 const SCEV *BaseAddrSE = SE.getSCEV(Visitor.BaseAddress);
484 if (BaseAddrSE->getType() != S->getType())
486 const SCEV *OffSE = SE.getMinusSCEV(S, BaseAddrSE);
487 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(OffSE);
492 const SCEVConstant *StepSE =
493 dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE));
494 const SCEVConstant *StartSE = dyn_cast<SCEVConstant>(AR->getStart());
495 if (!StepSE || !StartSE)
498 // Check and skip caching if doing so would require lots of bits to
500 APInt Start = StartSE->getValue()->getValue();
501 APInt Step = StepSE->getValue()->getValue();
502 if (Start.getActiveBits() > 32 || Step.getActiveBits() > 32)
505 // We found a cacheable SCEV model for the GEP.
506 SCEVCache[V] = {Visitor.BaseAddress,
507 (unsigned)Start.getLimitedValue(),
508 (unsigned)Step.getLimitedValue()};
515 UnrollAnalyzer(const Loop *L, unsigned TripCount, ScalarEvolution &SE,
516 const TargetTransformInfo &TTI, unsigned MaxUnrolledLoopSize)
517 : L(L), TripCount(TripCount), SE(SE), TTI(TTI),
518 MaxUnrolledLoopSize(MaxUnrolledLoopSize),
519 NumberOfOptimizedInstructions(0), UnrolledLoopSize(0) {}
521 /// \brief Count the number of optimized instructions.
522 unsigned NumberOfOptimizedInstructions;
524 /// \brief Count the total number of instructions.
525 unsigned UnrolledLoopSize;
527 /// \brief Figure out if the loop is worth full unrolling.
529 /// Complete loop unrolling can make some loads constant, and we need to know
530 /// if that would expose any further optimization opportunities. This routine
531 /// estimates this optimization. It assigns computed number of instructions,
532 /// that potentially might be optimized away, to
533 /// NumberOfOptimizedInstructions, and total number of instructions to
534 /// UnrolledLoopSize (not counting blocks that won't be reached, if we were
535 /// able to compute the condition).
536 /// \returns false if we can't analyze the loop, or if we discovered that
537 /// unrolling won't give anything. Otherwise, returns true.
539 SmallSetVector<BasicBlock *, 16> BBWorklist;
541 // We want to be able to scale offsets by the trip count and add more
542 // offsets to them without checking for overflows, and we already don't want
543 // to analyze *massive* trip counts, so we force the max to be reasonably
545 assert(UnrollMaxIterationsCountToAnalyze < (INT_MAX / 2) &&
546 "The unroll iterations max is too large!");
548 // Don't simulate loops with a big or unknown tripcount
549 if (!UnrollMaxIterationsCountToAnalyze || !TripCount ||
550 TripCount > UnrollMaxIterationsCountToAnalyze)
553 // To avoid compute SCEV-expressions on every iteration, compute them once
554 // and store interesting to us in SCEVCache.
557 // Simulate execution of each iteration of the loop counting instructions,
558 // which would be simplified.
559 // Since the same load will take different values on different iterations,
560 // we literally have to go through all loop's iterations.
561 for (Iteration = 0; Iteration < TripCount; ++Iteration) {
562 SimplifiedValues.clear();
564 BBWorklist.insert(L->getHeader());
565 // Note that we *must not* cache the size, this loop grows the worklist.
566 for (unsigned Idx = 0; Idx != BBWorklist.size(); ++Idx) {
567 BasicBlock *BB = BBWorklist[Idx];
569 // Visit all instructions in the given basic block and try to simplify
570 // it. We don't change the actual IR, just count optimization
572 for (Instruction &I : *BB) {
573 UnrolledLoopSize += TTI.getUserCost(&I);
575 // If unrolled body turns out to be too big, bail out.
576 if (UnrolledLoopSize - NumberOfOptimizedInstructions >
581 // Add BB's successors to the worklist.
582 for (BasicBlock *Succ : successors(BB))
583 if (L->contains(Succ))
584 BBWorklist.insert(Succ);
587 // If we found no optimization opportunities on the first iteration, we
588 // won't find them on later ones too.
589 if (!NumberOfOptimizedInstructions)
597 /// ApproximateLoopSize - Approximate the size of the loop.
598 static unsigned ApproximateLoopSize(const Loop *L, unsigned &NumCalls,
599 bool &NotDuplicatable,
600 const TargetTransformInfo &TTI,
601 AssumptionCache *AC) {
602 SmallPtrSet<const Value *, 32> EphValues;
603 CodeMetrics::collectEphemeralValues(L, AC, EphValues);
606 for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
608 Metrics.analyzeBasicBlock(*I, TTI, EphValues);
609 NumCalls = Metrics.NumInlineCandidates;
610 NotDuplicatable = Metrics.notDuplicatable;
612 unsigned LoopSize = Metrics.NumInsts;
614 // Don't allow an estimate of size zero. This would allows unrolling of loops
615 // with huge iteration counts, which is a compile time problem even if it's
616 // not a problem for code quality. Also, the code using this size may assume
617 // that each loop has at least three instructions (likely a conditional
618 // branch, a comparison feeding that branch, and some kind of loop increment
619 // feeding that comparison instruction).
620 LoopSize = std::max(LoopSize, 3u);
625 // Returns the loop hint metadata node with the given name (for example,
626 // "llvm.loop.unroll.count"). If no such metadata node exists, then nullptr is
628 static MDNode *GetUnrollMetadataForLoop(const Loop *L, StringRef Name) {
629 if (MDNode *LoopID = L->getLoopID())
630 return GetUnrollMetadata(LoopID, Name);
634 // Returns true if the loop has an unroll(full) pragma.
635 static bool HasUnrollFullPragma(const Loop *L) {
636 return GetUnrollMetadataForLoop(L, "llvm.loop.unroll.full");
639 // Returns true if the loop has an unroll(disable) pragma.
640 static bool HasUnrollDisablePragma(const Loop *L) {
641 return GetUnrollMetadataForLoop(L, "llvm.loop.unroll.disable");
644 // Returns true if the loop has an runtime unroll(disable) pragma.
645 static bool HasRuntimeUnrollDisablePragma(const Loop *L) {
646 return GetUnrollMetadataForLoop(L, "llvm.loop.unroll.runtime.disable");
649 // If loop has an unroll_count pragma return the (necessarily
650 // positive) value from the pragma. Otherwise return 0.
651 static unsigned UnrollCountPragmaValue(const Loop *L) {
652 MDNode *MD = GetUnrollMetadataForLoop(L, "llvm.loop.unroll.count");
654 assert(MD->getNumOperands() == 2 &&
655 "Unroll count hint metadata should have two operands.");
657 mdconst::extract<ConstantInt>(MD->getOperand(1))->getZExtValue();
658 assert(Count >= 1 && "Unroll count must be positive.");
664 // Remove existing unroll metadata and add unroll disable metadata to
665 // indicate the loop has already been unrolled. This prevents a loop
666 // from being unrolled more than is directed by a pragma if the loop
667 // unrolling pass is run more than once (which it generally is).
668 static void SetLoopAlreadyUnrolled(Loop *L) {
669 MDNode *LoopID = L->getLoopID();
672 // First remove any existing loop unrolling metadata.
673 SmallVector<Metadata *, 4> MDs;
674 // Reserve first location for self reference to the LoopID metadata node.
675 MDs.push_back(nullptr);
676 for (unsigned i = 1, ie = LoopID->getNumOperands(); i < ie; ++i) {
677 bool IsUnrollMetadata = false;
678 MDNode *MD = dyn_cast<MDNode>(LoopID->getOperand(i));
680 const MDString *S = dyn_cast<MDString>(MD->getOperand(0));
681 IsUnrollMetadata = S && S->getString().startswith("llvm.loop.unroll.");
683 if (!IsUnrollMetadata)
684 MDs.push_back(LoopID->getOperand(i));
687 // Add unroll(disable) metadata to disable future unrolling.
688 LLVMContext &Context = L->getHeader()->getContext();
689 SmallVector<Metadata *, 1> DisableOperands;
690 DisableOperands.push_back(MDString::get(Context, "llvm.loop.unroll.disable"));
691 MDNode *DisableNode = MDNode::get(Context, DisableOperands);
692 MDs.push_back(DisableNode);
694 MDNode *NewLoopID = MDNode::get(Context, MDs);
695 // Set operand 0 to refer to the loop id itself.
696 NewLoopID->replaceOperandWith(0, NewLoopID);
697 L->setLoopID(NewLoopID);
700 bool LoopUnroll::canUnrollCompletely(
701 Loop *L, unsigned Threshold, unsigned AbsoluteThreshold,
702 uint64_t UnrolledSize, unsigned NumberOfOptimizedInstructions,
703 unsigned PercentOfOptimizedForCompleteUnroll) {
705 if (Threshold == NoThreshold) {
706 DEBUG(dbgs() << " Can fully unroll, because no threshold is set.\n");
710 if (UnrolledSize <= Threshold) {
711 DEBUG(dbgs() << " Can fully unroll, because unrolled size: "
712 << UnrolledSize << "<" << Threshold << "\n");
716 assert(UnrolledSize && "UnrolledSize can't be 0 at this point.");
717 unsigned PercentOfOptimizedInstructions =
718 (uint64_t)NumberOfOptimizedInstructions * 100ull / UnrolledSize;
720 if (UnrolledSize <= AbsoluteThreshold &&
721 PercentOfOptimizedInstructions >= PercentOfOptimizedForCompleteUnroll) {
722 DEBUG(dbgs() << " Can fully unroll, because unrolling will help removing "
723 << PercentOfOptimizedInstructions
724 << "% instructions (threshold: "
725 << PercentOfOptimizedForCompleteUnroll << "%)\n");
726 DEBUG(dbgs() << " Unrolled size (" << UnrolledSize
727 << ") is less than the threshold (" << AbsoluteThreshold
732 DEBUG(dbgs() << " Too large to fully unroll:\n");
733 DEBUG(dbgs() << " Unrolled size: " << UnrolledSize << "\n");
734 DEBUG(dbgs() << " Estimated number of optimized instructions: "
735 << NumberOfOptimizedInstructions << "\n");
736 DEBUG(dbgs() << " Absolute threshold: " << AbsoluteThreshold << "\n");
737 DEBUG(dbgs() << " Minimum percent of removed instructions: "
738 << PercentOfOptimizedForCompleteUnroll << "\n");
739 DEBUG(dbgs() << " Threshold for small loops: " << Threshold << "\n");
743 unsigned LoopUnroll::selectUnrollCount(
744 const Loop *L, unsigned TripCount, bool PragmaFullUnroll,
745 unsigned PragmaCount, const TargetTransformInfo::UnrollingPreferences &UP,
746 bool &SetExplicitly) {
747 SetExplicitly = true;
749 // User-specified count (either as a command-line option or
750 // constructor parameter) has highest precedence.
751 unsigned Count = UserCount ? CurrentCount : 0;
753 // If there is no user-specified count, unroll pragmas have the next
754 // highest precendence.
758 } else if (PragmaFullUnroll) {
767 SetExplicitly = false;
769 // Runtime trip count.
770 Count = UnrollRuntimeCount;
772 // Conservative heuristic: if we know the trip count, see if we can
773 // completely unroll (subject to the threshold, checked below); otherwise
774 // try to find greatest modulo of the trip count which is still under
778 if (TripCount && Count > TripCount)
783 bool LoopUnroll::runOnLoop(Loop *L, LPPassManager &LPM) {
784 if (skipOptnoneFunction(L))
787 Function &F = *L->getHeader()->getParent();
789 LoopInfo *LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
790 ScalarEvolution *SE = &getAnalysis<ScalarEvolution>();
791 const TargetTransformInfo &TTI =
792 getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F);
793 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
795 BasicBlock *Header = L->getHeader();
796 DEBUG(dbgs() << "Loop Unroll: F[" << Header->getParent()->getName()
797 << "] Loop %" << Header->getName() << "\n");
799 if (HasUnrollDisablePragma(L)) {
802 bool PragmaFullUnroll = HasUnrollFullPragma(L);
803 unsigned PragmaCount = UnrollCountPragmaValue(L);
804 bool HasPragma = PragmaFullUnroll || PragmaCount > 0;
806 TargetTransformInfo::UnrollingPreferences UP;
807 getUnrollingPreferences(L, TTI, UP);
809 // Find trip count and trip multiple if count is not available
810 unsigned TripCount = 0;
811 unsigned TripMultiple = 1;
812 // If there are multiple exiting blocks but one of them is the latch, use the
813 // latch for the trip count estimation. Otherwise insist on a single exiting
814 // block for the trip count estimation.
815 BasicBlock *ExitingBlock = L->getLoopLatch();
816 if (!ExitingBlock || !L->isLoopExiting(ExitingBlock))
817 ExitingBlock = L->getExitingBlock();
819 TripCount = SE->getSmallConstantTripCount(L, ExitingBlock);
820 TripMultiple = SE->getSmallConstantTripMultiple(L, ExitingBlock);
823 // Select an initial unroll count. This may be reduced later based
824 // on size thresholds.
825 bool CountSetExplicitly;
826 unsigned Count = selectUnrollCount(L, TripCount, PragmaFullUnroll,
827 PragmaCount, UP, CountSetExplicitly);
829 unsigned NumInlineCandidates;
830 bool notDuplicatable;
832 ApproximateLoopSize(L, NumInlineCandidates, notDuplicatable, TTI, &AC);
833 DEBUG(dbgs() << " Loop Size = " << LoopSize << "\n");
835 // When computing the unrolled size, note that the conditional branch on the
836 // backedge and the comparison feeding it are not replicated like the rest of
837 // the loop body (which is why 2 is subtracted).
838 uint64_t UnrolledSize = (uint64_t)(LoopSize-2) * Count + 2;
839 if (notDuplicatable) {
840 DEBUG(dbgs() << " Not unrolling loop which contains non-duplicatable"
841 << " instructions.\n");
844 if (NumInlineCandidates != 0) {
845 DEBUG(dbgs() << " Not unrolling loop with inlinable calls.\n");
849 unsigned Threshold, PartialThreshold;
850 unsigned AbsoluteThreshold, PercentOfOptimizedForCompleteUnroll;
851 selectThresholds(L, HasPragma, UP, Threshold, PartialThreshold,
852 AbsoluteThreshold, PercentOfOptimizedForCompleteUnroll);
854 // Given Count, TripCount and thresholds determine the type of
855 // unrolling which is to be performed.
856 enum { Full = 0, Partial = 1, Runtime = 2 };
858 if (TripCount && Count == TripCount) {
860 // If the loop is really small, we don't need to run an expensive analysis.
861 if (canUnrollCompletely(
862 L, Threshold, AbsoluteThreshold,
863 UnrolledSize, 0, 100)) {
866 // The loop isn't that small, but we still can fully unroll it if that
867 // helps to remove a significant number of instructions.
868 // To check that, run additional analysis on the loop.
869 UnrollAnalyzer UA(L, TripCount, *SE, TTI, AbsoluteThreshold);
870 if (UA.analyzeLoop() &&
871 canUnrollCompletely(L, Threshold, AbsoluteThreshold,
873 UA.NumberOfOptimizedInstructions,
874 PercentOfOptimizedForCompleteUnroll)) {
878 } else if (TripCount && Count < TripCount) {
884 // Reduce count based on the type of unrolling and the threshold values.
885 unsigned OriginalCount = Count;
886 bool AllowRuntime = UserRuntime ? CurrentRuntime : UP.Runtime;
887 if (HasRuntimeUnrollDisablePragma(L)) {
888 AllowRuntime = false;
890 if (Unrolling == Partial) {
891 bool AllowPartial = UserAllowPartial ? CurrentAllowPartial : UP.Partial;
892 if (!AllowPartial && !CountSetExplicitly) {
893 DEBUG(dbgs() << " will not try to unroll partially because "
894 << "-unroll-allow-partial not given\n");
897 if (PartialThreshold != NoThreshold && UnrolledSize > PartialThreshold) {
898 // Reduce unroll count to be modulo of TripCount for partial unrolling.
899 Count = (std::max(PartialThreshold, 3u)-2) / (LoopSize-2);
900 while (Count != 0 && TripCount % Count != 0)
903 } else if (Unrolling == Runtime) {
904 if (!AllowRuntime && !CountSetExplicitly) {
905 DEBUG(dbgs() << " will not try to unroll loop with runtime trip count "
906 << "-unroll-runtime not given\n");
909 // Reduce unroll count to be the largest power-of-two factor of
910 // the original count which satisfies the threshold limit.
911 while (Count != 0 && UnrolledSize > PartialThreshold) {
913 UnrolledSize = (LoopSize-2) * Count + 2;
915 if (Count > UP.MaxCount)
917 DEBUG(dbgs() << " partially unrolling with count: " << Count << "\n");
921 if (PragmaCount != 0)
922 // If loop has an unroll count pragma mark loop as unrolled to prevent
923 // unrolling beyond that requested by the pragma.
924 SetLoopAlreadyUnrolled(L);
926 // Emit optimization remarks if we are unable to unroll the loop
927 // as directed by a pragma.
928 DebugLoc LoopLoc = L->getStartLoc();
929 Function *F = Header->getParent();
930 LLVMContext &Ctx = F->getContext();
931 if (PragmaFullUnroll && PragmaCount == 0) {
932 if (TripCount && Count != TripCount) {
933 emitOptimizationRemarkMissed(
934 Ctx, DEBUG_TYPE, *F, LoopLoc,
935 "Unable to fully unroll loop as directed by unroll(full) pragma "
936 "because unrolled size is too large.");
937 } else if (!TripCount) {
938 emitOptimizationRemarkMissed(
939 Ctx, DEBUG_TYPE, *F, LoopLoc,
940 "Unable to fully unroll loop as directed by unroll(full) pragma "
941 "because loop has a runtime trip count.");
943 } else if (PragmaCount > 0 && Count != OriginalCount) {
944 emitOptimizationRemarkMissed(
945 Ctx, DEBUG_TYPE, *F, LoopLoc,
946 "Unable to unroll loop the number of times directed by "
947 "unroll_count pragma because unrolled size is too large.");
951 if (Unrolling != Full && Count < 2) {
952 // Partial unrolling by 1 is a nop. For full unrolling, a factor
953 // of 1 makes sense because loop control can be eliminated.
958 if (!UnrollLoop(L, Count, TripCount, AllowRuntime, UP.AllowExpensiveTripCount,
959 TripMultiple, LI, this, &LPM, &AC))