1 //===-- InductiveRangeCheckElimination.cpp - ------------------------------===//
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 //===----------------------------------------------------------------------===//
9 // The InductiveRangeCheckElimination pass splits a loop's iteration space into
10 // three disjoint ranges. It does that in a way such that the loop running in
11 // the middle loop provably does not need range checks. As an example, it will
14 // len = < known positive >
15 // for (i = 0; i < n; i++) {
16 // if (0 <= i && i < len) {
19 // throw_out_of_bounds();
25 // len = < known positive >
26 // limit = smin(n, len)
27 // // no first segment
28 // for (i = 0; i < limit; i++) {
29 // if (0 <= i && i < len) { // this check is fully redundant
32 // throw_out_of_bounds();
35 // for (i = limit; i < n; i++) {
36 // if (0 <= i && i < len) {
39 // throw_out_of_bounds();
42 //===----------------------------------------------------------------------===//
44 #include "llvm/ADT/Optional.h"
45 #include "llvm/Analysis/BranchProbabilityInfo.h"
46 #include "llvm/Analysis/LoopInfo.h"
47 #include "llvm/Analysis/LoopPass.h"
48 #include "llvm/Analysis/ScalarEvolution.h"
49 #include "llvm/Analysis/ScalarEvolutionExpander.h"
50 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
51 #include "llvm/IR/Dominators.h"
52 #include "llvm/IR/Function.h"
53 #include "llvm/IR/IRBuilder.h"
54 #include "llvm/IR/Instructions.h"
55 #include "llvm/IR/PatternMatch.h"
56 #include "llvm/Pass.h"
57 #include "llvm/Support/Debug.h"
58 #include "llvm/Support/raw_ostream.h"
59 #include "llvm/Transforms/Scalar.h"
60 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
61 #include "llvm/Transforms/Utils/Cloning.h"
62 #include "llvm/Transforms/Utils/LoopUtils.h"
63 #include "llvm/Transforms/Utils/LoopSimplify.h"
67 static cl::opt<unsigned> LoopSizeCutoff("irce-loop-size-cutoff", cl::Hidden,
70 static cl::opt<bool> PrintChangedLoops("irce-print-changed-loops", cl::Hidden,
73 static cl::opt<bool> PrintRangeChecks("irce-print-range-checks", cl::Hidden,
76 static cl::opt<int> MaxExitProbReciprocal("irce-max-exit-prob-reciprocal",
77 cl::Hidden, cl::init(10));
79 static cl::opt<bool> SkipProfitabilityChecks("irce-skip-profitability-checks",
80 cl::Hidden, cl::init(false));
82 static const char *ClonedLoopTag = "irce.loop.clone";
84 #define DEBUG_TYPE "irce"
88 /// An inductive range check is conditional branch in a loop with
90 /// 1. a very cold successor (i.e. the branch jumps to that successor very
95 /// 2. a condition that is provably true for some contiguous range of values
96 /// taken by the containing loop's induction variable.
98 class InductiveRangeCheck {
99 // Classifies a range check
100 enum RangeCheckKind : unsigned {
101 // Range check of the form "0 <= I".
102 RANGE_CHECK_LOWER = 1,
104 // Range check of the form "I < L" where L is known positive.
105 RANGE_CHECK_UPPER = 2,
107 // The logical and of the RANGE_CHECK_LOWER and RANGE_CHECK_UPPER
109 RANGE_CHECK_BOTH = RANGE_CHECK_LOWER | RANGE_CHECK_UPPER,
111 // Unrecognized range check condition.
112 RANGE_CHECK_UNKNOWN = (unsigned)-1
115 static StringRef rangeCheckKindToStr(RangeCheckKind);
117 const SCEV *Offset = nullptr;
118 const SCEV *Scale = nullptr;
119 Value *Length = nullptr;
120 Use *CheckUse = nullptr;
121 RangeCheckKind Kind = RANGE_CHECK_UNKNOWN;
123 static RangeCheckKind parseRangeCheckICmp(Loop *L, ICmpInst *ICI,
124 ScalarEvolution &SE, Value *&Index,
128 extractRangeChecksFromCond(Loop *L, ScalarEvolution &SE, Use &ConditionUse,
129 SmallVectorImpl<InductiveRangeCheck> &Checks,
130 SmallPtrSetImpl<Value *> &Visited);
133 const SCEV *getOffset() const { return Offset; }
134 const SCEV *getScale() const { return Scale; }
135 Value *getLength() const { return Length; }
137 void print(raw_ostream &OS) const {
138 OS << "InductiveRangeCheck:\n";
139 OS << " Kind: " << rangeCheckKindToStr(Kind) << "\n";
149 OS << "\n CheckUse: ";
150 getCheckUse()->getUser()->print(OS);
151 OS << " Operand: " << getCheckUse()->getOperandNo() << "\n";
159 Use *getCheckUse() const { return CheckUse; }
161 /// Represents an signed integer range [Range.getBegin(), Range.getEnd()). If
162 /// R.getEnd() sle R.getBegin(), then R denotes the empty range.
169 Range(const SCEV *Begin, const SCEV *End) : Begin(Begin), End(End) {
170 assert(Begin->getType() == End->getType() && "ill-typed range!");
173 Type *getType() const { return Begin->getType(); }
174 const SCEV *getBegin() const { return Begin; }
175 const SCEV *getEnd() const { return End; }
178 /// This is the value the condition of the branch needs to evaluate to for the
179 /// branch to take the hot successor (see (1) above).
180 bool getPassingDirection() { return true; }
182 /// Computes a range for the induction variable (IndVar) in which the range
183 /// check is redundant and can be constant-folded away. The induction
184 /// variable is not required to be the canonical {0,+,1} induction variable.
185 Optional<Range> computeSafeIterationSpace(ScalarEvolution &SE,
186 const SCEVAddRecExpr *IndVar) const;
188 /// Parse out a set of inductive range checks from \p BI and append them to \p
191 /// NB! There may be conditions feeding into \p BI that aren't inductive range
192 /// checks, and hence don't end up in \p Checks.
194 extractRangeChecksFromBranch(BranchInst *BI, Loop *L, ScalarEvolution &SE,
195 BranchProbabilityInfo &BPI,
196 SmallVectorImpl<InductiveRangeCheck> &Checks);
199 class InductiveRangeCheckElimination : public LoopPass {
202 InductiveRangeCheckElimination() : LoopPass(ID) {
203 initializeInductiveRangeCheckEliminationPass(
204 *PassRegistry::getPassRegistry());
207 void getAnalysisUsage(AnalysisUsage &AU) const override {
208 AU.addRequired<BranchProbabilityInfoWrapperPass>();
209 getLoopAnalysisUsage(AU);
212 bool runOnLoop(Loop *L, LPPassManager &LPM) override;
215 char InductiveRangeCheckElimination::ID = 0;
218 INITIALIZE_PASS_BEGIN(InductiveRangeCheckElimination, "irce",
219 "Inductive range check elimination", false, false)
220 INITIALIZE_PASS_DEPENDENCY(BranchProbabilityInfoWrapperPass)
221 INITIALIZE_PASS_DEPENDENCY(LoopPass)
222 INITIALIZE_PASS_END(InductiveRangeCheckElimination, "irce",
223 "Inductive range check elimination", false, false)
225 StringRef InductiveRangeCheck::rangeCheckKindToStr(
226 InductiveRangeCheck::RangeCheckKind RCK) {
228 case InductiveRangeCheck::RANGE_CHECK_UNKNOWN:
229 return "RANGE_CHECK_UNKNOWN";
231 case InductiveRangeCheck::RANGE_CHECK_UPPER:
232 return "RANGE_CHECK_UPPER";
234 case InductiveRangeCheck::RANGE_CHECK_LOWER:
235 return "RANGE_CHECK_LOWER";
237 case InductiveRangeCheck::RANGE_CHECK_BOTH:
238 return "RANGE_CHECK_BOTH";
241 llvm_unreachable("unknown range check type!");
244 /// Parse a single ICmp instruction, `ICI`, into a range check. If `ICI` cannot
245 /// be interpreted as a range check, return `RANGE_CHECK_UNKNOWN` and set
246 /// `Index` and `Length` to `nullptr`. Otherwise set `Index` to the value being
247 /// range checked, and set `Length` to the upper limit `Index` is being range
248 /// checked with if (and only if) the range check type is stronger or equal to
249 /// RANGE_CHECK_UPPER.
251 InductiveRangeCheck::RangeCheckKind
252 InductiveRangeCheck::parseRangeCheckICmp(Loop *L, ICmpInst *ICI,
253 ScalarEvolution &SE, Value *&Index,
256 auto IsNonNegativeAndNotLoopVarying = [&SE, L](Value *V) {
257 const SCEV *S = SE.getSCEV(V);
258 if (isa<SCEVCouldNotCompute>(S))
261 return SE.getLoopDisposition(S, L) == ScalarEvolution::LoopInvariant &&
262 SE.isKnownNonNegative(S);
265 using namespace llvm::PatternMatch;
267 ICmpInst::Predicate Pred = ICI->getPredicate();
268 Value *LHS = ICI->getOperand(0);
269 Value *RHS = ICI->getOperand(1);
273 return RANGE_CHECK_UNKNOWN;
275 case ICmpInst::ICMP_SLE:
278 case ICmpInst::ICMP_SGE:
279 if (match(RHS, m_ConstantInt<0>())) {
281 return RANGE_CHECK_LOWER;
283 return RANGE_CHECK_UNKNOWN;
285 case ICmpInst::ICMP_SLT:
288 case ICmpInst::ICMP_SGT:
289 if (match(RHS, m_ConstantInt<-1>())) {
291 return RANGE_CHECK_LOWER;
294 if (IsNonNegativeAndNotLoopVarying(LHS)) {
297 return RANGE_CHECK_UPPER;
299 return RANGE_CHECK_UNKNOWN;
301 case ICmpInst::ICMP_ULT:
304 case ICmpInst::ICMP_UGT:
305 if (IsNonNegativeAndNotLoopVarying(LHS)) {
308 return RANGE_CHECK_BOTH;
310 return RANGE_CHECK_UNKNOWN;
313 llvm_unreachable("default clause returns!");
316 void InductiveRangeCheck::extractRangeChecksFromCond(
317 Loop *L, ScalarEvolution &SE, Use &ConditionUse,
318 SmallVectorImpl<InductiveRangeCheck> &Checks,
319 SmallPtrSetImpl<Value *> &Visited) {
320 using namespace llvm::PatternMatch;
322 Value *Condition = ConditionUse.get();
323 if (!Visited.insert(Condition).second)
326 if (match(Condition, m_And(m_Value(), m_Value()))) {
327 SmallVector<InductiveRangeCheck, 8> SubChecks;
328 extractRangeChecksFromCond(L, SE, cast<User>(Condition)->getOperandUse(0),
330 extractRangeChecksFromCond(L, SE, cast<User>(Condition)->getOperandUse(1),
333 if (SubChecks.size() == 2) {
334 // Handle a special case where we know how to merge two checks separately
335 // checking the upper and lower bounds into a full range check.
336 const auto &RChkA = SubChecks[0];
337 const auto &RChkB = SubChecks[1];
338 if ((RChkA.Length == RChkB.Length || !RChkA.Length || !RChkB.Length) &&
339 RChkA.Offset == RChkB.Offset && RChkA.Scale == RChkB.Scale) {
341 // If RChkA.Kind == RChkB.Kind then we just found two identical checks.
342 // But if one of them is a RANGE_CHECK_LOWER and the other is a
343 // RANGE_CHECK_UPPER (only possibility if they're different) then
344 // together they form a RANGE_CHECK_BOTH.
346 (InductiveRangeCheck::RangeCheckKind)(RChkA.Kind | RChkB.Kind);
347 SubChecks[0].Length = RChkA.Length ? RChkA.Length : RChkB.Length;
348 SubChecks[0].CheckUse = &ConditionUse;
350 // We updated one of the checks in place, now erase the other.
351 SubChecks.pop_back();
355 Checks.insert(Checks.end(), SubChecks.begin(), SubChecks.end());
359 ICmpInst *ICI = dyn_cast<ICmpInst>(Condition);
363 Value *Length = nullptr, *Index;
364 auto RCKind = parseRangeCheckICmp(L, ICI, SE, Index, Length);
365 if (RCKind == InductiveRangeCheck::RANGE_CHECK_UNKNOWN)
368 const auto *IndexAddRec = dyn_cast<SCEVAddRecExpr>(SE.getSCEV(Index));
370 IndexAddRec && (IndexAddRec->getLoop() == L) && IndexAddRec->isAffine();
375 InductiveRangeCheck IRC;
377 IRC.Offset = IndexAddRec->getStart();
378 IRC.Scale = IndexAddRec->getStepRecurrence(SE);
379 IRC.CheckUse = &ConditionUse;
381 Checks.push_back(IRC);
384 void InductiveRangeCheck::extractRangeChecksFromBranch(
385 BranchInst *BI, Loop *L, ScalarEvolution &SE, BranchProbabilityInfo &BPI,
386 SmallVectorImpl<InductiveRangeCheck> &Checks) {
388 if (BI->isUnconditional() || BI->getParent() == L->getLoopLatch())
391 BranchProbability LikelyTaken(15, 16);
393 if (!SkipProfitabilityChecks &&
394 BPI.getEdgeProbability(BI->getParent(), (unsigned)0) < LikelyTaken)
397 SmallPtrSet<Value *, 8> Visited;
398 InductiveRangeCheck::extractRangeChecksFromCond(L, SE, BI->getOperandUse(0),
402 // Add metadata to the loop L to disable loop optimizations. Callers need to
403 // confirm that optimizing loop L is not beneficial.
404 static void DisableAllLoopOptsOnLoop(Loop &L) {
405 // We do not care about any existing loopID related metadata for L, since we
406 // are setting all loop metadata to false.
407 LLVMContext &Context = L.getHeader()->getContext();
408 // Reserve first location for self reference to the LoopID metadata node.
409 MDNode *Dummy = MDNode::get(Context, {});
410 MDNode *DisableUnroll = MDNode::get(
411 Context, {MDString::get(Context, "llvm.loop.unroll.disable")});
413 ConstantAsMetadata::get(ConstantInt::get(Type::getInt1Ty(Context), 0));
414 MDNode *DisableVectorize = MDNode::get(
416 {MDString::get(Context, "llvm.loop.vectorize.enable"), FalseVal});
417 MDNode *DisableLICMVersioning = MDNode::get(
418 Context, {MDString::get(Context, "llvm.loop.licm_versioning.disable")});
419 MDNode *DisableDistribution= MDNode::get(
421 {MDString::get(Context, "llvm.loop.distribute.enable"), FalseVal});
423 MDNode::get(Context, {Dummy, DisableUnroll, DisableVectorize,
424 DisableLICMVersioning, DisableDistribution});
425 // Set operand 0 to refer to the loop id itself.
426 NewLoopID->replaceOperandWith(0, NewLoopID);
427 L.setLoopID(NewLoopID);
432 // Keeps track of the structure of a loop. This is similar to llvm::Loop,
433 // except that it is more lightweight and can track the state of a loop through
434 // changing and potentially invalid IR. This structure also formalizes the
435 // kinds of loops we can deal with -- ones that have a single latch that is also
436 // an exiting block *and* have a canonical induction variable.
437 struct LoopStructure {
443 // `Latch's terminator instruction is `LatchBr', and it's `LatchBrExitIdx'th
444 // successor is `LatchExit', the exit block of the loop.
446 BasicBlock *LatchExit;
447 unsigned LatchBrExitIdx;
449 // The loop represented by this instance of LoopStructure is semantically
452 // intN_ty inc = IndVarIncreasing ? 1 : -1;
453 // pred_ty predicate = IndVarIncreasing ? ICMP_SLT : ICMP_SGT;
455 // for (intN_ty iv = IndVarStart; predicate(iv, LoopExitAt); iv = IndVarNext)
461 bool IndVarIncreasing;
464 : Tag(""), Header(nullptr), Latch(nullptr), LatchBr(nullptr),
465 LatchExit(nullptr), LatchBrExitIdx(-1), IndVarNext(nullptr),
466 IndVarStart(nullptr), LoopExitAt(nullptr), IndVarIncreasing(false) {}
468 template <typename M> LoopStructure map(M Map) const {
469 LoopStructure Result;
471 Result.Header = cast<BasicBlock>(Map(Header));
472 Result.Latch = cast<BasicBlock>(Map(Latch));
473 Result.LatchBr = cast<BranchInst>(Map(LatchBr));
474 Result.LatchExit = cast<BasicBlock>(Map(LatchExit));
475 Result.LatchBrExitIdx = LatchBrExitIdx;
476 Result.IndVarNext = Map(IndVarNext);
477 Result.IndVarStart = Map(IndVarStart);
478 Result.LoopExitAt = Map(LoopExitAt);
479 Result.IndVarIncreasing = IndVarIncreasing;
483 static Optional<LoopStructure> parseLoopStructure(ScalarEvolution &,
484 BranchProbabilityInfo &BPI,
489 /// This class is used to constrain loops to run within a given iteration space.
490 /// The algorithm this class implements is given a Loop and a range [Begin,
491 /// End). The algorithm then tries to break out a "main loop" out of the loop
492 /// it is given in a way that the "main loop" runs with the induction variable
493 /// in a subset of [Begin, End). The algorithm emits appropriate pre and post
494 /// loops to run any remaining iterations. The pre loop runs any iterations in
495 /// which the induction variable is < Begin, and the post loop runs any
496 /// iterations in which the induction variable is >= End.
498 class LoopConstrainer {
499 // The representation of a clone of the original loop we started out with.
502 std::vector<BasicBlock *> Blocks;
504 // `Map` maps values in the clonee into values in the cloned version
505 ValueToValueMapTy Map;
507 // An instance of `LoopStructure` for the cloned loop
508 LoopStructure Structure;
511 // Result of rewriting the range of a loop. See changeIterationSpaceEnd for
512 // more details on what these fields mean.
513 struct RewrittenRangeInfo {
514 BasicBlock *PseudoExit;
515 BasicBlock *ExitSelector;
516 std::vector<PHINode *> PHIValuesAtPseudoExit;
520 : PseudoExit(nullptr), ExitSelector(nullptr), IndVarEnd(nullptr) {}
523 // Calculated subranges we restrict the iteration space of the main loop to.
524 // See the implementation of `calculateSubRanges' for more details on how
525 // these fields are computed. `LowLimit` is None if there is no restriction
526 // on low end of the restricted iteration space of the main loop. `HighLimit`
527 // is None if there is no restriction on high end of the restricted iteration
528 // space of the main loop.
531 Optional<const SCEV *> LowLimit;
532 Optional<const SCEV *> HighLimit;
535 // A utility function that does a `replaceUsesOfWith' on the incoming block
536 // set of a `PHINode' -- replaces instances of `Block' in the `PHINode's
537 // incoming block list with `ReplaceBy'.
538 static void replacePHIBlock(PHINode *PN, BasicBlock *Block,
539 BasicBlock *ReplaceBy);
541 // Compute a safe set of limits for the main loop to run in -- effectively the
542 // intersection of `Range' and the iteration space of the original loop.
543 // Return None if unable to compute the set of subranges.
545 Optional<SubRanges> calculateSubRanges() const;
547 // Clone `OriginalLoop' and return the result in CLResult. The IR after
548 // running `cloneLoop' is well formed except for the PHI nodes in CLResult --
549 // the PHI nodes say that there is an incoming edge from `OriginalPreheader`
550 // but there is no such edge.
552 void cloneLoop(ClonedLoop &CLResult, const char *Tag) const;
554 // Create the appropriate loop structure needed to describe a cloned copy of
555 // `Original`. The clone is described by `VM`.
556 Loop *createClonedLoopStructure(Loop *Original, Loop *Parent,
557 ValueToValueMapTy &VM);
559 // Rewrite the iteration space of the loop denoted by (LS, Preheader). The
560 // iteration space of the rewritten loop ends at ExitLoopAt. The start of the
561 // iteration space is not changed. `ExitLoopAt' is assumed to be slt
562 // `OriginalHeaderCount'.
564 // If there are iterations left to execute, control is made to jump to
565 // `ContinuationBlock', otherwise they take the normal loop exit. The
566 // returned `RewrittenRangeInfo' object is populated as follows:
568 // .PseudoExit is a basic block that unconditionally branches to
569 // `ContinuationBlock'.
571 // .ExitSelector is a basic block that decides, on exit from the loop,
572 // whether to branch to the "true" exit or to `PseudoExit'.
574 // .PHIValuesAtPseudoExit are PHINodes in `PseudoExit' that compute the value
575 // for each PHINode in the loop header on taking the pseudo exit.
577 // After changeIterationSpaceEnd, `Preheader' is no longer a legitimate
578 // preheader because it is made to branch to the loop header only
582 changeIterationSpaceEnd(const LoopStructure &LS, BasicBlock *Preheader,
584 BasicBlock *ContinuationBlock) const;
586 // The loop denoted by `LS' has `OldPreheader' as its preheader. This
587 // function creates a new preheader for `LS' and returns it.
589 BasicBlock *createPreheader(const LoopStructure &LS, BasicBlock *OldPreheader,
590 const char *Tag) const;
592 // `ContinuationBlockAndPreheader' was the continuation block for some call to
593 // `changeIterationSpaceEnd' and is the preheader to the loop denoted by `LS'.
594 // This function rewrites the PHI nodes in `LS.Header' to start with the
596 void rewriteIncomingValuesForPHIs(
597 LoopStructure &LS, BasicBlock *ContinuationBlockAndPreheader,
598 const LoopConstrainer::RewrittenRangeInfo &RRI) const;
600 // Even though we do not preserve any passes at this time, we at least need to
601 // keep the parent loop structure consistent. The `LPPassManager' seems to
602 // verify this after running a loop pass. This function adds the list of
603 // blocks denoted by BBs to this loops parent loop if required.
604 void addToParentLoopIfNeeded(ArrayRef<BasicBlock *> BBs);
606 // Some global state.
614 // Information about the original loop we started out with.
616 const SCEV *LatchTakenCount;
617 BasicBlock *OriginalPreheader;
619 // The preheader of the main loop. This may or may not be different from
620 // `OriginalPreheader'.
621 BasicBlock *MainLoopPreheader;
623 // The range we need to run the main loop in.
624 InductiveRangeCheck::Range Range;
626 // The structure of the main loop (see comment at the beginning of this class
628 LoopStructure MainLoopStructure;
631 LoopConstrainer(Loop &L, LoopInfo &LI, LPPassManager &LPM,
632 const LoopStructure &LS, ScalarEvolution &SE,
633 DominatorTree &DT, InductiveRangeCheck::Range R)
634 : F(*L.getHeader()->getParent()), Ctx(L.getHeader()->getContext()),
635 SE(SE), DT(DT), LPM(LPM), LI(LI), OriginalLoop(L),
636 LatchTakenCount(nullptr), OriginalPreheader(nullptr),
637 MainLoopPreheader(nullptr), Range(R), MainLoopStructure(LS) {}
639 // Entry point for the algorithm. Returns true on success.
645 void LoopConstrainer::replacePHIBlock(PHINode *PN, BasicBlock *Block,
646 BasicBlock *ReplaceBy) {
647 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
648 if (PN->getIncomingBlock(i) == Block)
649 PN->setIncomingBlock(i, ReplaceBy);
652 static bool CanBeSMax(ScalarEvolution &SE, const SCEV *S) {
654 APInt::getSignedMaxValue(cast<IntegerType>(S->getType())->getBitWidth());
655 return SE.getSignedRange(S).contains(SMax) &&
656 SE.getUnsignedRange(S).contains(SMax);
659 static bool CanBeSMin(ScalarEvolution &SE, const SCEV *S) {
661 APInt::getSignedMinValue(cast<IntegerType>(S->getType())->getBitWidth());
662 return SE.getSignedRange(S).contains(SMin) &&
663 SE.getUnsignedRange(S).contains(SMin);
666 Optional<LoopStructure>
667 LoopStructure::parseLoopStructure(ScalarEvolution &SE, BranchProbabilityInfo &BPI,
668 Loop &L, const char *&FailureReason) {
669 if (!L.isLoopSimplifyForm()) {
670 FailureReason = "loop not in LoopSimplify form";
674 BasicBlock *Latch = L.getLoopLatch();
675 assert(Latch && "Simplified loops only have one latch!");
677 if (Latch->getTerminator()->getMetadata(ClonedLoopTag)) {
678 FailureReason = "loop has already been cloned";
682 if (!L.isLoopExiting(Latch)) {
683 FailureReason = "no loop latch";
687 BasicBlock *Header = L.getHeader();
688 BasicBlock *Preheader = L.getLoopPreheader();
690 FailureReason = "no preheader";
694 BranchInst *LatchBr = dyn_cast<BranchInst>(Latch->getTerminator());
695 if (!LatchBr || LatchBr->isUnconditional()) {
696 FailureReason = "latch terminator not conditional branch";
700 unsigned LatchBrExitIdx = LatchBr->getSuccessor(0) == Header ? 1 : 0;
702 BranchProbability ExitProbability =
703 BPI.getEdgeProbability(LatchBr->getParent(), LatchBrExitIdx);
705 if (!SkipProfitabilityChecks &&
706 ExitProbability > BranchProbability(1, MaxExitProbReciprocal)) {
707 FailureReason = "short running loop, not profitable";
711 ICmpInst *ICI = dyn_cast<ICmpInst>(LatchBr->getCondition());
712 if (!ICI || !isa<IntegerType>(ICI->getOperand(0)->getType())) {
713 FailureReason = "latch terminator branch not conditional on integral icmp";
717 const SCEV *LatchCount = SE.getExitCount(&L, Latch);
718 if (isa<SCEVCouldNotCompute>(LatchCount)) {
719 FailureReason = "could not compute latch count";
723 ICmpInst::Predicate Pred = ICI->getPredicate();
724 Value *LeftValue = ICI->getOperand(0);
725 const SCEV *LeftSCEV = SE.getSCEV(LeftValue);
726 IntegerType *IndVarTy = cast<IntegerType>(LeftValue->getType());
728 Value *RightValue = ICI->getOperand(1);
729 const SCEV *RightSCEV = SE.getSCEV(RightValue);
731 // We canonicalize `ICI` such that `LeftSCEV` is an add recurrence.
732 if (!isa<SCEVAddRecExpr>(LeftSCEV)) {
733 if (isa<SCEVAddRecExpr>(RightSCEV)) {
734 std::swap(LeftSCEV, RightSCEV);
735 std::swap(LeftValue, RightValue);
736 Pred = ICmpInst::getSwappedPredicate(Pred);
738 FailureReason = "no add recurrences in the icmp";
743 auto HasNoSignedWrap = [&](const SCEVAddRecExpr *AR) {
744 if (AR->getNoWrapFlags(SCEV::FlagNSW))
747 IntegerType *Ty = cast<IntegerType>(AR->getType());
748 IntegerType *WideTy =
749 IntegerType::get(Ty->getContext(), Ty->getBitWidth() * 2);
751 const SCEVAddRecExpr *ExtendAfterOp =
752 dyn_cast<SCEVAddRecExpr>(SE.getSignExtendExpr(AR, WideTy));
754 const SCEV *ExtendedStart = SE.getSignExtendExpr(AR->getStart(), WideTy);
755 const SCEV *ExtendedStep =
756 SE.getSignExtendExpr(AR->getStepRecurrence(SE), WideTy);
758 bool NoSignedWrap = ExtendAfterOp->getStart() == ExtendedStart &&
759 ExtendAfterOp->getStepRecurrence(SE) == ExtendedStep;
765 // We may have proved this when computing the sign extension above.
766 return AR->getNoWrapFlags(SCEV::FlagNSW) != SCEV::FlagAnyWrap;
769 auto IsInductionVar = [&](const SCEVAddRecExpr *AR, bool &IsIncreasing) {
773 // Currently we only work with induction variables that have been proved to
774 // not wrap. This restriction can potentially be lifted in the future.
776 if (!HasNoSignedWrap(AR))
779 if (const SCEVConstant *StepExpr =
780 dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE))) {
781 ConstantInt *StepCI = StepExpr->getValue();
782 if (StepCI->isOne() || StepCI->isMinusOne()) {
783 IsIncreasing = StepCI->isOne();
791 // `ICI` is interpreted as taking the backedge if the *next* value of the
792 // induction variable satisfies some constraint.
794 const SCEVAddRecExpr *IndVarNext = cast<SCEVAddRecExpr>(LeftSCEV);
795 bool IsIncreasing = false;
796 if (!IsInductionVar(IndVarNext, IsIncreasing)) {
797 FailureReason = "LHS in icmp not induction variable";
801 const SCEV *StartNext = IndVarNext->getStart();
802 const SCEV *Addend = SE.getNegativeSCEV(IndVarNext->getStepRecurrence(SE));
803 const SCEV *IndVarStart = SE.getAddExpr(StartNext, Addend);
805 ConstantInt *One = ConstantInt::get(IndVarTy, 1);
806 // TODO: generalize the predicates here to also match their unsigned variants.
808 bool FoundExpectedPred =
809 (Pred == ICmpInst::ICMP_SLT && LatchBrExitIdx == 1) ||
810 (Pred == ICmpInst::ICMP_SGT && LatchBrExitIdx == 0);
812 if (!FoundExpectedPred) {
813 FailureReason = "expected icmp slt semantically, found something else";
817 if (LatchBrExitIdx == 0) {
818 if (CanBeSMax(SE, RightSCEV)) {
819 // TODO: this restriction is easily removable -- we just have to
820 // remember that the icmp was an slt and not an sle.
821 FailureReason = "limit may overflow when coercing sle to slt";
825 if (!SE.isLoopEntryGuardedByCond(
826 &L, CmpInst::ICMP_SLT, IndVarStart,
827 SE.getAddExpr(RightSCEV, SE.getOne(RightSCEV->getType())))) {
828 FailureReason = "Induction variable start not bounded by upper limit";
832 IRBuilder<> B(Preheader->getTerminator());
833 RightValue = B.CreateAdd(RightValue, One);
835 if (!SE.isLoopEntryGuardedByCond(&L, CmpInst::ICMP_SLT, IndVarStart,
837 FailureReason = "Induction variable start not bounded by upper limit";
842 bool FoundExpectedPred =
843 (Pred == ICmpInst::ICMP_SGT && LatchBrExitIdx == 1) ||
844 (Pred == ICmpInst::ICMP_SLT && LatchBrExitIdx == 0);
846 if (!FoundExpectedPred) {
847 FailureReason = "expected icmp sgt semantically, found something else";
851 if (LatchBrExitIdx == 0) {
852 if (CanBeSMin(SE, RightSCEV)) {
853 // TODO: this restriction is easily removable -- we just have to
854 // remember that the icmp was an sgt and not an sge.
855 FailureReason = "limit may overflow when coercing sge to sgt";
859 if (!SE.isLoopEntryGuardedByCond(
860 &L, CmpInst::ICMP_SGT, IndVarStart,
861 SE.getMinusSCEV(RightSCEV, SE.getOne(RightSCEV->getType())))) {
862 FailureReason = "Induction variable start not bounded by lower limit";
866 IRBuilder<> B(Preheader->getTerminator());
867 RightValue = B.CreateSub(RightValue, One);
869 if (!SE.isLoopEntryGuardedByCond(&L, CmpInst::ICMP_SGT, IndVarStart,
871 FailureReason = "Induction variable start not bounded by lower limit";
877 BasicBlock *LatchExit = LatchBr->getSuccessor(LatchBrExitIdx);
879 assert(SE.getLoopDisposition(LatchCount, &L) ==
880 ScalarEvolution::LoopInvariant &&
881 "loop variant exit count doesn't make sense!");
883 assert(!L.contains(LatchExit) && "expected an exit block!");
884 const DataLayout &DL = Preheader->getModule()->getDataLayout();
885 Value *IndVarStartV =
886 SCEVExpander(SE, DL, "irce")
887 .expandCodeFor(IndVarStart, IndVarTy, Preheader->getTerminator());
888 IndVarStartV->setName("indvar.start");
890 LoopStructure Result;
893 Result.Header = Header;
894 Result.Latch = Latch;
895 Result.LatchBr = LatchBr;
896 Result.LatchExit = LatchExit;
897 Result.LatchBrExitIdx = LatchBrExitIdx;
898 Result.IndVarStart = IndVarStartV;
899 Result.IndVarNext = LeftValue;
900 Result.IndVarIncreasing = IsIncreasing;
901 Result.LoopExitAt = RightValue;
903 FailureReason = nullptr;
908 Optional<LoopConstrainer::SubRanges>
909 LoopConstrainer::calculateSubRanges() const {
910 IntegerType *Ty = cast<IntegerType>(LatchTakenCount->getType());
912 if (Range.getType() != Ty)
915 LoopConstrainer::SubRanges Result;
917 // I think we can be more aggressive here and make this nuw / nsw if the
918 // addition that feeds into the icmp for the latch's terminating branch is nuw
919 // / nsw. In any case, a wrapping 2's complement addition is safe.
920 ConstantInt *One = ConstantInt::get(Ty, 1);
921 const SCEV *Start = SE.getSCEV(MainLoopStructure.IndVarStart);
922 const SCEV *End = SE.getSCEV(MainLoopStructure.LoopExitAt);
924 bool Increasing = MainLoopStructure.IndVarIncreasing;
926 // We compute `Smallest` and `Greatest` such that [Smallest, Greatest) is the
927 // range of values the induction variable takes.
929 const SCEV *Smallest = nullptr, *Greatest = nullptr;
935 // These two computations may sign-overflow. Here is why that is okay:
937 // We know that the induction variable does not sign-overflow on any
938 // iteration except the last one, and it starts at `Start` and ends at
939 // `End`, decrementing by one every time.
941 // * if `Smallest` sign-overflows we know `End` is `INT_SMAX`. Since the
942 // induction variable is decreasing we know that that the smallest value
943 // the loop body is actually executed with is `INT_SMIN` == `Smallest`.
945 // * if `Greatest` sign-overflows, we know it can only be `INT_SMIN`. In
946 // that case, `Clamp` will always return `Smallest` and
947 // [`Result.LowLimit`, `Result.HighLimit`) = [`Smallest`, `Smallest`)
948 // will be an empty range. Returning an empty range is always safe.
951 Smallest = SE.getAddExpr(End, SE.getSCEV(One));
952 Greatest = SE.getAddExpr(Start, SE.getSCEV(One));
955 auto Clamp = [this, Smallest, Greatest](const SCEV *S) {
956 return SE.getSMaxExpr(Smallest, SE.getSMinExpr(Greatest, S));
959 // In some cases we can prove that we don't need a pre or post loop
961 bool ProvablyNoPreloop =
962 SE.isKnownPredicate(ICmpInst::ICMP_SLE, Range.getBegin(), Smallest);
963 if (!ProvablyNoPreloop)
964 Result.LowLimit = Clamp(Range.getBegin());
966 bool ProvablyNoPostLoop =
967 SE.isKnownPredicate(ICmpInst::ICMP_SLE, Greatest, Range.getEnd());
968 if (!ProvablyNoPostLoop)
969 Result.HighLimit = Clamp(Range.getEnd());
974 void LoopConstrainer::cloneLoop(LoopConstrainer::ClonedLoop &Result,
975 const char *Tag) const {
976 for (BasicBlock *BB : OriginalLoop.getBlocks()) {
977 BasicBlock *Clone = CloneBasicBlock(BB, Result.Map, Twine(".") + Tag, &F);
978 Result.Blocks.push_back(Clone);
979 Result.Map[BB] = Clone;
982 auto GetClonedValue = [&Result](Value *V) {
983 assert(V && "null values not in domain!");
984 auto It = Result.Map.find(V);
985 if (It == Result.Map.end())
987 return static_cast<Value *>(It->second);
991 cast<BasicBlock>(GetClonedValue(OriginalLoop.getLoopLatch()));
992 ClonedLatch->getTerminator()->setMetadata(ClonedLoopTag,
993 MDNode::get(Ctx, {}));
995 Result.Structure = MainLoopStructure.map(GetClonedValue);
996 Result.Structure.Tag = Tag;
998 for (unsigned i = 0, e = Result.Blocks.size(); i != e; ++i) {
999 BasicBlock *ClonedBB = Result.Blocks[i];
1000 BasicBlock *OriginalBB = OriginalLoop.getBlocks()[i];
1002 assert(Result.Map[OriginalBB] == ClonedBB && "invariant!");
1004 for (Instruction &I : *ClonedBB)
1005 RemapInstruction(&I, Result.Map,
1006 RF_NoModuleLevelChanges | RF_IgnoreMissingLocals);
1008 // Exit blocks will now have one more predecessor and their PHI nodes need
1009 // to be edited to reflect that. No phi nodes need to be introduced because
1010 // the loop is in LCSSA.
1012 for (auto *SBB : successors(OriginalBB)) {
1013 if (OriginalLoop.contains(SBB))
1014 continue; // not an exit block
1016 for (Instruction &I : *SBB) {
1017 auto *PN = dyn_cast<PHINode>(&I);
1021 Value *OldIncoming = PN->getIncomingValueForBlock(OriginalBB);
1022 PN->addIncoming(GetClonedValue(OldIncoming), ClonedBB);
1028 LoopConstrainer::RewrittenRangeInfo LoopConstrainer::changeIterationSpaceEnd(
1029 const LoopStructure &LS, BasicBlock *Preheader, Value *ExitSubloopAt,
1030 BasicBlock *ContinuationBlock) const {
1032 // We start with a loop with a single latch:
1034 // +--------------------+
1038 // +--------+-----------+
1039 // | ----------------\
1041 // +--------v----v------+ |
1045 // +--------------------+ |
1049 // +--------------------+ |
1051 // | latch >----------/
1053 // +-------v------------+
1056 // | +--------------------+
1058 // +---> original exit |
1060 // +--------------------+
1062 // We change the control flow to look like
1065 // +--------------------+
1067 // | preheader >-------------------------+
1069 // +--------v-----------+ |
1070 // | /-------------+ |
1072 // +--------v--v--------+ | |
1074 // | header | | +--------+ |
1076 // +--------------------+ | | +-----v-----v-----------+
1078 // | | | .pseudo.exit |
1080 // | | +-----------v-----------+
1083 // | | +--------v-------------+
1084 // +--------------------+ | | | |
1085 // | | | | | ContinuationBlock |
1086 // | latch >------+ | | |
1087 // | | | +----------------------+
1088 // +---------v----------+ |
1091 // | +---------------^-----+
1093 // +-----> .exit.selector |
1095 // +----------v----------+
1097 // +--------------------+ |
1099 // | original exit <----+
1101 // +--------------------+
1104 RewrittenRangeInfo RRI;
1106 BasicBlock *BBInsertLocation = LS.Latch->getNextNode();
1107 RRI.ExitSelector = BasicBlock::Create(Ctx, Twine(LS.Tag) + ".exit.selector",
1108 &F, BBInsertLocation);
1109 RRI.PseudoExit = BasicBlock::Create(Ctx, Twine(LS.Tag) + ".pseudo.exit", &F,
1112 BranchInst *PreheaderJump = cast<BranchInst>(Preheader->getTerminator());
1113 bool Increasing = LS.IndVarIncreasing;
1115 IRBuilder<> B(PreheaderJump);
1117 // EnterLoopCond - is it okay to start executing this `LS'?
1118 Value *EnterLoopCond = Increasing
1119 ? B.CreateICmpSLT(LS.IndVarStart, ExitSubloopAt)
1120 : B.CreateICmpSGT(LS.IndVarStart, ExitSubloopAt);
1122 B.CreateCondBr(EnterLoopCond, LS.Header, RRI.PseudoExit);
1123 PreheaderJump->eraseFromParent();
1125 LS.LatchBr->setSuccessor(LS.LatchBrExitIdx, RRI.ExitSelector);
1126 B.SetInsertPoint(LS.LatchBr);
1127 Value *TakeBackedgeLoopCond =
1128 Increasing ? B.CreateICmpSLT(LS.IndVarNext, ExitSubloopAt)
1129 : B.CreateICmpSGT(LS.IndVarNext, ExitSubloopAt);
1130 Value *CondForBranch = LS.LatchBrExitIdx == 1
1131 ? TakeBackedgeLoopCond
1132 : B.CreateNot(TakeBackedgeLoopCond);
1134 LS.LatchBr->setCondition(CondForBranch);
1136 B.SetInsertPoint(RRI.ExitSelector);
1138 // IterationsLeft - are there any more iterations left, given the original
1139 // upper bound on the induction variable? If not, we branch to the "real"
1141 Value *IterationsLeft = Increasing
1142 ? B.CreateICmpSLT(LS.IndVarNext, LS.LoopExitAt)
1143 : B.CreateICmpSGT(LS.IndVarNext, LS.LoopExitAt);
1144 B.CreateCondBr(IterationsLeft, RRI.PseudoExit, LS.LatchExit);
1146 BranchInst *BranchToContinuation =
1147 BranchInst::Create(ContinuationBlock, RRI.PseudoExit);
1149 // We emit PHI nodes into `RRI.PseudoExit' that compute the "latest" value of
1150 // each of the PHI nodes in the loop header. This feeds into the initial
1151 // value of the same PHI nodes if/when we continue execution.
1152 for (Instruction &I : *LS.Header) {
1153 auto *PN = dyn_cast<PHINode>(&I);
1157 PHINode *NewPHI = PHINode::Create(PN->getType(), 2, PN->getName() + ".copy",
1158 BranchToContinuation);
1160 NewPHI->addIncoming(PN->getIncomingValueForBlock(Preheader), Preheader);
1161 NewPHI->addIncoming(PN->getIncomingValueForBlock(LS.Latch),
1163 RRI.PHIValuesAtPseudoExit.push_back(NewPHI);
1166 RRI.IndVarEnd = PHINode::Create(LS.IndVarNext->getType(), 2, "indvar.end",
1167 BranchToContinuation);
1168 RRI.IndVarEnd->addIncoming(LS.IndVarStart, Preheader);
1169 RRI.IndVarEnd->addIncoming(LS.IndVarNext, RRI.ExitSelector);
1171 // The latch exit now has a branch from `RRI.ExitSelector' instead of
1172 // `LS.Latch'. The PHI nodes need to be updated to reflect that.
1173 for (Instruction &I : *LS.LatchExit) {
1174 if (PHINode *PN = dyn_cast<PHINode>(&I))
1175 replacePHIBlock(PN, LS.Latch, RRI.ExitSelector);
1183 void LoopConstrainer::rewriteIncomingValuesForPHIs(
1184 LoopStructure &LS, BasicBlock *ContinuationBlock,
1185 const LoopConstrainer::RewrittenRangeInfo &RRI) const {
1187 unsigned PHIIndex = 0;
1188 for (Instruction &I : *LS.Header) {
1189 auto *PN = dyn_cast<PHINode>(&I);
1193 for (unsigned i = 0, e = PN->getNumIncomingValues(); i < e; ++i)
1194 if (PN->getIncomingBlock(i) == ContinuationBlock)
1195 PN->setIncomingValue(i, RRI.PHIValuesAtPseudoExit[PHIIndex++]);
1198 LS.IndVarStart = RRI.IndVarEnd;
1201 BasicBlock *LoopConstrainer::createPreheader(const LoopStructure &LS,
1202 BasicBlock *OldPreheader,
1203 const char *Tag) const {
1205 BasicBlock *Preheader = BasicBlock::Create(Ctx, Tag, &F, LS.Header);
1206 BranchInst::Create(LS.Header, Preheader);
1208 for (Instruction &I : *LS.Header) {
1209 auto *PN = dyn_cast<PHINode>(&I);
1213 for (unsigned i = 0, e = PN->getNumIncomingValues(); i < e; ++i)
1214 replacePHIBlock(PN, OldPreheader, Preheader);
1220 void LoopConstrainer::addToParentLoopIfNeeded(ArrayRef<BasicBlock *> BBs) {
1221 Loop *ParentLoop = OriginalLoop.getParentLoop();
1225 for (BasicBlock *BB : BBs)
1226 ParentLoop->addBasicBlockToLoop(BB, LI);
1229 Loop *LoopConstrainer::createClonedLoopStructure(Loop *Original, Loop *Parent,
1230 ValueToValueMapTy &VM) {
1231 Loop &New = *new Loop();
1233 Parent->addChildLoop(&New);
1235 LI.addTopLevelLoop(&New);
1238 // Add all of the blocks in Original to the new loop.
1239 for (auto *BB : Original->blocks())
1240 if (LI.getLoopFor(BB) == Original)
1241 New.addBasicBlockToLoop(cast<BasicBlock>(VM[BB]), LI);
1243 // Add all of the subloops to the new loop.
1244 for (Loop *SubLoop : *Original)
1245 createClonedLoopStructure(SubLoop, &New, VM);
1250 bool LoopConstrainer::run() {
1251 BasicBlock *Preheader = nullptr;
1252 LatchTakenCount = SE.getExitCount(&OriginalLoop, MainLoopStructure.Latch);
1253 Preheader = OriginalLoop.getLoopPreheader();
1254 assert(!isa<SCEVCouldNotCompute>(LatchTakenCount) && Preheader != nullptr &&
1257 OriginalPreheader = Preheader;
1258 MainLoopPreheader = Preheader;
1260 Optional<SubRanges> MaybeSR = calculateSubRanges();
1261 if (!MaybeSR.hasValue()) {
1262 DEBUG(dbgs() << "irce: could not compute subranges\n");
1266 SubRanges SR = MaybeSR.getValue();
1267 bool Increasing = MainLoopStructure.IndVarIncreasing;
1269 cast<IntegerType>(MainLoopStructure.IndVarNext->getType());
1271 SCEVExpander Expander(SE, F.getParent()->getDataLayout(), "irce");
1272 Instruction *InsertPt = OriginalPreheader->getTerminator();
1274 // It would have been better to make `PreLoop' and `PostLoop'
1275 // `Optional<ClonedLoop>'s, but `ValueToValueMapTy' does not have a copy
1277 ClonedLoop PreLoop, PostLoop;
1279 Increasing ? SR.LowLimit.hasValue() : SR.HighLimit.hasValue();
1280 bool NeedsPostLoop =
1281 Increasing ? SR.HighLimit.hasValue() : SR.LowLimit.hasValue();
1283 Value *ExitPreLoopAt = nullptr;
1284 Value *ExitMainLoopAt = nullptr;
1285 const SCEVConstant *MinusOneS =
1286 cast<SCEVConstant>(SE.getConstant(IVTy, -1, true /* isSigned */));
1289 const SCEV *ExitPreLoopAtSCEV = nullptr;
1292 ExitPreLoopAtSCEV = *SR.LowLimit;
1294 if (CanBeSMin(SE, *SR.HighLimit)) {
1295 DEBUG(dbgs() << "irce: could not prove no-overflow when computing "
1296 << "preloop exit limit. HighLimit = " << *(*SR.HighLimit)
1300 ExitPreLoopAtSCEV = SE.getAddExpr(*SR.HighLimit, MinusOneS);
1303 ExitPreLoopAt = Expander.expandCodeFor(ExitPreLoopAtSCEV, IVTy, InsertPt);
1304 ExitPreLoopAt->setName("exit.preloop.at");
1307 if (NeedsPostLoop) {
1308 const SCEV *ExitMainLoopAtSCEV = nullptr;
1311 ExitMainLoopAtSCEV = *SR.HighLimit;
1313 if (CanBeSMin(SE, *SR.LowLimit)) {
1314 DEBUG(dbgs() << "irce: could not prove no-overflow when computing "
1315 << "mainloop exit limit. LowLimit = " << *(*SR.LowLimit)
1319 ExitMainLoopAtSCEV = SE.getAddExpr(*SR.LowLimit, MinusOneS);
1322 ExitMainLoopAt = Expander.expandCodeFor(ExitMainLoopAtSCEV, IVTy, InsertPt);
1323 ExitMainLoopAt->setName("exit.mainloop.at");
1326 // We clone these ahead of time so that we don't have to deal with changing
1327 // and temporarily invalid IR as we transform the loops.
1329 cloneLoop(PreLoop, "preloop");
1331 cloneLoop(PostLoop, "postloop");
1333 RewrittenRangeInfo PreLoopRRI;
1336 Preheader->getTerminator()->replaceUsesOfWith(MainLoopStructure.Header,
1337 PreLoop.Structure.Header);
1340 createPreheader(MainLoopStructure, Preheader, "mainloop");
1341 PreLoopRRI = changeIterationSpaceEnd(PreLoop.Structure, Preheader,
1342 ExitPreLoopAt, MainLoopPreheader);
1343 rewriteIncomingValuesForPHIs(MainLoopStructure, MainLoopPreheader,
1347 BasicBlock *PostLoopPreheader = nullptr;
1348 RewrittenRangeInfo PostLoopRRI;
1350 if (NeedsPostLoop) {
1352 createPreheader(PostLoop.Structure, Preheader, "postloop");
1353 PostLoopRRI = changeIterationSpaceEnd(MainLoopStructure, MainLoopPreheader,
1354 ExitMainLoopAt, PostLoopPreheader);
1355 rewriteIncomingValuesForPHIs(PostLoop.Structure, PostLoopPreheader,
1359 BasicBlock *NewMainLoopPreheader =
1360 MainLoopPreheader != Preheader ? MainLoopPreheader : nullptr;
1361 BasicBlock *NewBlocks[] = {PostLoopPreheader, PreLoopRRI.PseudoExit,
1362 PreLoopRRI.ExitSelector, PostLoopRRI.PseudoExit,
1363 PostLoopRRI.ExitSelector, NewMainLoopPreheader};
1365 // Some of the above may be nullptr, filter them out before passing to
1366 // addToParentLoopIfNeeded.
1368 std::remove(std::begin(NewBlocks), std::end(NewBlocks), nullptr);
1370 addToParentLoopIfNeeded(makeArrayRef(std::begin(NewBlocks), NewBlocksEnd));
1374 if (!PreLoop.Blocks.empty()) {
1375 auto *L = createClonedLoopStructure(
1376 &OriginalLoop, OriginalLoop.getParentLoop(), PreLoop.Map);
1377 formLCSSARecursively(*L, DT, &LI, &SE);
1378 simplifyLoop(L, &DT, &LI, &SE, nullptr, true);
1379 // Pre loops are slow paths, we do not need to perform any loop
1380 // optimizations on them.
1381 DisableAllLoopOptsOnLoop(*L);
1384 if (!PostLoop.Blocks.empty()) {
1385 auto *L = createClonedLoopStructure(
1386 &OriginalLoop, OriginalLoop.getParentLoop(), PostLoop.Map);
1387 formLCSSARecursively(*L, DT, &LI, &SE);
1388 simplifyLoop(L, &DT, &LI, &SE, nullptr, true);
1389 // Post loops are slow paths, we do not need to perform any loop
1390 // optimizations on them.
1391 DisableAllLoopOptsOnLoop(*L);
1394 formLCSSARecursively(OriginalLoop, DT, &LI, &SE);
1395 simplifyLoop(&OriginalLoop, &DT, &LI, &SE, nullptr, true);
1400 /// Computes and returns a range of values for the induction variable (IndVar)
1401 /// in which the range check can be safely elided. If it cannot compute such a
1402 /// range, returns None.
1403 Optional<InductiveRangeCheck::Range>
1404 InductiveRangeCheck::computeSafeIterationSpace(
1405 ScalarEvolution &SE, const SCEVAddRecExpr *IndVar) const {
1406 // IndVar is of the form "A + B * I" (where "I" is the canonical induction
1407 // variable, that may or may not exist as a real llvm::Value in the loop) and
1408 // this inductive range check is a range check on the "C + D * I" ("C" is
1409 // getOffset() and "D" is getScale()). We rewrite the value being range
1410 // checked to "M + N * IndVar" where "N" = "D * B^(-1)" and "M" = "C - NA".
1411 // Currently we support this only for "B" = "D" = { 1 or -1 }, but the code
1412 // can be generalized as needed.
1414 // The actual inequalities we solve are of the form
1416 // 0 <= M + 1 * IndVar < L given L >= 0 (i.e. N == 1)
1418 // The inequality is satisfied by -M <= IndVar < (L - M) [^1]. All additions
1419 // and subtractions are twos-complement wrapping and comparisons are signed.
1423 // If there exists IndVar such that -M <= IndVar < (L - M) then it follows
1424 // that -M <= (-M + L) [== Eq. 1]. Since L >= 0, if (-M + L) sign-overflows
1425 // then (-M + L) < (-M). Hence by [Eq. 1], (-M + L) could not have
1428 // This means IndVar = t + (-M) for t in [0, L). Hence (IndVar + M) = t.
1429 // Hence 0 <= (IndVar + M) < L
1431 // [^1]: Note that the solution does _not_ apply if L < 0; consider values M =
1432 // 127, IndVar = 126 and L = -2 in an i8 world.
1434 if (!IndVar->isAffine())
1437 const SCEV *A = IndVar->getStart();
1438 const SCEVConstant *B = dyn_cast<SCEVConstant>(IndVar->getStepRecurrence(SE));
1442 const SCEV *C = getOffset();
1443 const SCEVConstant *D = dyn_cast<SCEVConstant>(getScale());
1447 ConstantInt *ConstD = D->getValue();
1448 if (!(ConstD->isMinusOne() || ConstD->isOne()))
1451 const SCEV *M = SE.getMinusSCEV(C, A);
1453 const SCEV *Begin = SE.getNegativeSCEV(M);
1454 const SCEV *UpperLimit = nullptr;
1456 // We strengthen "0 <= I" to "0 <= I < INT_SMAX" and "I < L" to "0 <= I < L".
1457 // We can potentially do much better here.
1458 if (Value *V = getLength()) {
1459 UpperLimit = SE.getSCEV(V);
1461 assert(Kind == InductiveRangeCheck::RANGE_CHECK_LOWER && "invariant!");
1462 unsigned BitWidth = cast<IntegerType>(IndVar->getType())->getBitWidth();
1463 UpperLimit = SE.getConstant(APInt::getSignedMaxValue(BitWidth));
1466 const SCEV *End = SE.getMinusSCEV(UpperLimit, M);
1467 return InductiveRangeCheck::Range(Begin, End);
1470 static Optional<InductiveRangeCheck::Range>
1471 IntersectRange(ScalarEvolution &SE,
1472 const Optional<InductiveRangeCheck::Range> &R1,
1473 const InductiveRangeCheck::Range &R2) {
1476 auto &R1Value = R1.getValue();
1478 // TODO: we could widen the smaller range and have this work; but for now we
1479 // bail out to keep things simple.
1480 if (R1Value.getType() != R2.getType())
1483 const SCEV *NewBegin = SE.getSMaxExpr(R1Value.getBegin(), R2.getBegin());
1484 const SCEV *NewEnd = SE.getSMinExpr(R1Value.getEnd(), R2.getEnd());
1486 return InductiveRangeCheck::Range(NewBegin, NewEnd);
1489 bool InductiveRangeCheckElimination::runOnLoop(Loop *L, LPPassManager &LPM) {
1493 if (L->getBlocks().size() >= LoopSizeCutoff) {
1494 DEBUG(dbgs() << "irce: giving up constraining loop, too large\n";);
1498 BasicBlock *Preheader = L->getLoopPreheader();
1500 DEBUG(dbgs() << "irce: loop has no preheader, leaving\n");
1504 LLVMContext &Context = Preheader->getContext();
1505 SmallVector<InductiveRangeCheck, 16> RangeChecks;
1506 ScalarEvolution &SE = getAnalysis<ScalarEvolutionWrapperPass>().getSE();
1507 BranchProbabilityInfo &BPI =
1508 getAnalysis<BranchProbabilityInfoWrapperPass>().getBPI();
1510 for (auto BBI : L->getBlocks())
1511 if (BranchInst *TBI = dyn_cast<BranchInst>(BBI->getTerminator()))
1512 InductiveRangeCheck::extractRangeChecksFromBranch(TBI, L, SE, BPI,
1515 if (RangeChecks.empty())
1518 auto PrintRecognizedRangeChecks = [&](raw_ostream &OS) {
1519 OS << "irce: looking at loop "; L->print(OS);
1520 OS << "irce: loop has " << RangeChecks.size()
1521 << " inductive range checks: \n";
1522 for (InductiveRangeCheck &IRC : RangeChecks)
1526 DEBUG(PrintRecognizedRangeChecks(dbgs()));
1528 if (PrintRangeChecks)
1529 PrintRecognizedRangeChecks(errs());
1531 const char *FailureReason = nullptr;
1532 Optional<LoopStructure> MaybeLoopStructure =
1533 LoopStructure::parseLoopStructure(SE, BPI, *L, FailureReason);
1534 if (!MaybeLoopStructure.hasValue()) {
1535 DEBUG(dbgs() << "irce: could not parse loop structure: " << FailureReason
1539 LoopStructure LS = MaybeLoopStructure.getValue();
1540 bool Increasing = LS.IndVarIncreasing;
1541 const SCEV *MinusOne =
1542 SE.getConstant(LS.IndVarNext->getType(), Increasing ? -1 : 1, true);
1543 const SCEVAddRecExpr *IndVar =
1544 cast<SCEVAddRecExpr>(SE.getAddExpr(SE.getSCEV(LS.IndVarNext), MinusOne));
1546 Optional<InductiveRangeCheck::Range> SafeIterRange;
1547 Instruction *ExprInsertPt = Preheader->getTerminator();
1549 SmallVector<InductiveRangeCheck, 4> RangeChecksToEliminate;
1551 IRBuilder<> B(ExprInsertPt);
1552 for (InductiveRangeCheck &IRC : RangeChecks) {
1553 auto Result = IRC.computeSafeIterationSpace(SE, IndVar);
1554 if (Result.hasValue()) {
1555 auto MaybeSafeIterRange =
1556 IntersectRange(SE, SafeIterRange, Result.getValue());
1557 if (MaybeSafeIterRange.hasValue()) {
1558 RangeChecksToEliminate.push_back(IRC);
1559 SafeIterRange = MaybeSafeIterRange.getValue();
1564 if (!SafeIterRange.hasValue())
1567 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1568 LoopConstrainer LC(*L, getAnalysis<LoopInfoWrapperPass>().getLoopInfo(), LPM,
1569 LS, SE, DT, SafeIterRange.getValue());
1570 bool Changed = LC.run();
1573 auto PrintConstrainedLoopInfo = [L]() {
1574 dbgs() << "irce: in function ";
1575 dbgs() << L->getHeader()->getParent()->getName() << ": ";
1576 dbgs() << "constrained ";
1580 DEBUG(PrintConstrainedLoopInfo());
1582 if (PrintChangedLoops)
1583 PrintConstrainedLoopInfo();
1585 // Optimize away the now-redundant range checks.
1587 for (InductiveRangeCheck &IRC : RangeChecksToEliminate) {
1588 ConstantInt *FoldedRangeCheck = IRC.getPassingDirection()
1589 ? ConstantInt::getTrue(Context)
1590 : ConstantInt::getFalse(Context);
1591 IRC.getCheckUse()->set(FoldedRangeCheck);
1598 Pass *llvm::createInductiveRangeCheckEliminationPass() {
1599 return new InductiveRangeCheckElimination;