1 //===- ScalarEvolution.cpp - Scalar Evolution Analysis --------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file contains the implementation of the scalar evolution analysis 10 // engine, which is used primarily to analyze expressions involving induction 11 // variables in loops. 12 // 13 // There are several aspects to this library. First is the representation of 14 // scalar expressions, which are represented as subclasses of the SCEV class. 15 // These classes are used to represent certain types of subexpressions that we 16 // can handle. We only create one SCEV of a particular shape, so 17 // pointer-comparisons for equality are legal. 18 // 19 // One important aspect of the SCEV objects is that they are never cyclic, even 20 // if there is a cycle in the dataflow for an expression (ie, a PHI node). If 21 // the PHI node is one of the idioms that we can represent (e.g., a polynomial 22 // recurrence) then we represent it directly as a recurrence node, otherwise we 23 // represent it as a SCEVUnknown node. 24 // 25 // In addition to being able to represent expressions of various types, we also 26 // have folders that are used to build the *canonical* representation for a 27 // particular expression. These folders are capable of using a variety of 28 // rewrite rules to simplify the expressions. 29 // 30 // Once the folders are defined, we can implement the more interesting 31 // higher-level code, such as the code that recognizes PHI nodes of various 32 // types, computes the execution count of a loop, etc. 33 // 34 // TODO: We should use these routines and value representations to implement 35 // dependence analysis! 36 // 37 //===----------------------------------------------------------------------===// 38 // 39 // There are several good references for the techniques used in this analysis. 40 // 41 // Chains of recurrences -- a method to expedite the evaluation 42 // of closed-form functions 43 // Olaf Bachmann, Paul S. Wang, Eugene V. Zima 44 // 45 // On computational properties of chains of recurrences 46 // Eugene V. Zima 47 // 48 // Symbolic Evaluation of Chains of Recurrences for Loop Optimization 49 // Robert A. van Engelen 50 // 51 // Efficient Symbolic Analysis for Optimizing Compilers 52 // Robert A. van Engelen 53 // 54 // Using the chains of recurrences algebra for data dependence testing and 55 // induction variable substitution 56 // MS Thesis, Johnie Birch 57 // 58 //===----------------------------------------------------------------------===// 59 60 #include "llvm/Analysis/ScalarEvolution.h" 61 #include "llvm/ADT/APInt.h" 62 #include "llvm/ADT/ArrayRef.h" 63 #include "llvm/ADT/DenseMap.h" 64 #include "llvm/ADT/DepthFirstIterator.h" 65 #include "llvm/ADT/EquivalenceClasses.h" 66 #include "llvm/ADT/FoldingSet.h" 67 #include "llvm/ADT/None.h" 68 #include "llvm/ADT/Optional.h" 69 #include "llvm/ADT/STLExtras.h" 70 #include "llvm/ADT/ScopeExit.h" 71 #include "llvm/ADT/Sequence.h" 72 #include "llvm/ADT/SetVector.h" 73 #include "llvm/ADT/SmallPtrSet.h" 74 #include "llvm/ADT/SmallSet.h" 75 #include "llvm/ADT/SmallVector.h" 76 #include "llvm/ADT/Statistic.h" 77 #include "llvm/ADT/StringRef.h" 78 #include "llvm/Analysis/AssumptionCache.h" 79 #include "llvm/Analysis/ConstantFolding.h" 80 #include "llvm/Analysis/InstructionSimplify.h" 81 #include "llvm/Analysis/LoopInfo.h" 82 #include "llvm/Analysis/ScalarEvolutionDivision.h" 83 #include "llvm/Analysis/ScalarEvolutionExpressions.h" 84 #include "llvm/Analysis/TargetLibraryInfo.h" 85 #include "llvm/Analysis/ValueTracking.h" 86 #include "llvm/Config/llvm-config.h" 87 #include "llvm/IR/Argument.h" 88 #include "llvm/IR/BasicBlock.h" 89 #include "llvm/IR/CFG.h" 90 #include "llvm/IR/Constant.h" 91 #include "llvm/IR/ConstantRange.h" 92 #include "llvm/IR/Constants.h" 93 #include "llvm/IR/DataLayout.h" 94 #include "llvm/IR/DerivedTypes.h" 95 #include "llvm/IR/Dominators.h" 96 #include "llvm/IR/Function.h" 97 #include "llvm/IR/GlobalAlias.h" 98 #include "llvm/IR/GlobalValue.h" 99 #include "llvm/IR/GlobalVariable.h" 100 #include "llvm/IR/InstIterator.h" 101 #include "llvm/IR/InstrTypes.h" 102 #include "llvm/IR/Instruction.h" 103 #include "llvm/IR/Instructions.h" 104 #include "llvm/IR/IntrinsicInst.h" 105 #include "llvm/IR/Intrinsics.h" 106 #include "llvm/IR/LLVMContext.h" 107 #include "llvm/IR/Metadata.h" 108 #include "llvm/IR/Operator.h" 109 #include "llvm/IR/PatternMatch.h" 110 #include "llvm/IR/Type.h" 111 #include "llvm/IR/Use.h" 112 #include "llvm/IR/User.h" 113 #include "llvm/IR/Value.h" 114 #include "llvm/IR/Verifier.h" 115 #include "llvm/InitializePasses.h" 116 #include "llvm/Pass.h" 117 #include "llvm/Support/Casting.h" 118 #include "llvm/Support/CommandLine.h" 119 #include "llvm/Support/Compiler.h" 120 #include "llvm/Support/Debug.h" 121 #include "llvm/Support/ErrorHandling.h" 122 #include "llvm/Support/KnownBits.h" 123 #include "llvm/Support/SaveAndRestore.h" 124 #include "llvm/Support/raw_ostream.h" 125 #include <algorithm> 126 #include <cassert> 127 #include <climits> 128 #include <cstddef> 129 #include <cstdint> 130 #include <cstdlib> 131 #include <map> 132 #include <memory> 133 #include <tuple> 134 #include <utility> 135 #include <vector> 136 137 using namespace llvm; 138 using namespace PatternMatch; 139 140 #define DEBUG_TYPE "scalar-evolution" 141 142 STATISTIC(NumArrayLenItCounts, 143 "Number of trip counts computed with array length"); 144 STATISTIC(NumTripCountsComputed, 145 "Number of loops with predictable loop counts"); 146 STATISTIC(NumTripCountsNotComputed, 147 "Number of loops without predictable loop counts"); 148 STATISTIC(NumBruteForceTripCountsComputed, 149 "Number of loops with trip counts computed by force"); 150 151 static cl::opt<unsigned> 152 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden, 153 cl::ZeroOrMore, 154 cl::desc("Maximum number of iterations SCEV will " 155 "symbolically execute a constant " 156 "derived loop"), 157 cl::init(100)); 158 159 // FIXME: Enable this with EXPENSIVE_CHECKS when the test suite is clean. 160 static cl::opt<bool> VerifySCEV( 161 "verify-scev", cl::Hidden, 162 cl::desc("Verify ScalarEvolution's backedge taken counts (slow)")); 163 static cl::opt<bool> VerifySCEVStrict( 164 "verify-scev-strict", cl::Hidden, 165 cl::desc("Enable stricter verification with -verify-scev is passed")); 166 static cl::opt<bool> 167 VerifySCEVMap("verify-scev-maps", cl::Hidden, 168 cl::desc("Verify no dangling value in ScalarEvolution's " 169 "ExprValueMap (slow)")); 170 171 static cl::opt<bool> VerifyIR( 172 "scev-verify-ir", cl::Hidden, 173 cl::desc("Verify IR correctness when making sensitive SCEV queries (slow)"), 174 cl::init(false)); 175 176 static cl::opt<unsigned> MulOpsInlineThreshold( 177 "scev-mulops-inline-threshold", cl::Hidden, 178 cl::desc("Threshold for inlining multiplication operands into a SCEV"), 179 cl::init(32)); 180 181 static cl::opt<unsigned> AddOpsInlineThreshold( 182 "scev-addops-inline-threshold", cl::Hidden, 183 cl::desc("Threshold for inlining addition operands into a SCEV"), 184 cl::init(500)); 185 186 static cl::opt<unsigned> MaxSCEVCompareDepth( 187 "scalar-evolution-max-scev-compare-depth", cl::Hidden, 188 cl::desc("Maximum depth of recursive SCEV complexity comparisons"), 189 cl::init(32)); 190 191 static cl::opt<unsigned> MaxSCEVOperationsImplicationDepth( 192 "scalar-evolution-max-scev-operations-implication-depth", cl::Hidden, 193 cl::desc("Maximum depth of recursive SCEV operations implication analysis"), 194 cl::init(2)); 195 196 static cl::opt<unsigned> MaxValueCompareDepth( 197 "scalar-evolution-max-value-compare-depth", cl::Hidden, 198 cl::desc("Maximum depth of recursive value complexity comparisons"), 199 cl::init(2)); 200 201 static cl::opt<unsigned> 202 MaxArithDepth("scalar-evolution-max-arith-depth", cl::Hidden, 203 cl::desc("Maximum depth of recursive arithmetics"), 204 cl::init(32)); 205 206 static cl::opt<unsigned> MaxConstantEvolvingDepth( 207 "scalar-evolution-max-constant-evolving-depth", cl::Hidden, 208 cl::desc("Maximum depth of recursive constant evolving"), cl::init(32)); 209 210 static cl::opt<unsigned> 211 MaxCastDepth("scalar-evolution-max-cast-depth", cl::Hidden, 212 cl::desc("Maximum depth of recursive SExt/ZExt/Trunc"), 213 cl::init(8)); 214 215 static cl::opt<unsigned> 216 MaxAddRecSize("scalar-evolution-max-add-rec-size", cl::Hidden, 217 cl::desc("Max coefficients in AddRec during evolving"), 218 cl::init(8)); 219 220 static cl::opt<unsigned> 221 HugeExprThreshold("scalar-evolution-huge-expr-threshold", cl::Hidden, 222 cl::desc("Size of the expression which is considered huge"), 223 cl::init(4096)); 224 225 static cl::opt<bool> 226 ClassifyExpressions("scalar-evolution-classify-expressions", 227 cl::Hidden, cl::init(true), 228 cl::desc("When printing analysis, include information on every instruction")); 229 230 static cl::opt<bool> UseExpensiveRangeSharpening( 231 "scalar-evolution-use-expensive-range-sharpening", cl::Hidden, 232 cl::init(false), 233 cl::desc("Use more powerful methods of sharpening expression ranges. May " 234 "be costly in terms of compile time")); 235 236 //===----------------------------------------------------------------------===// 237 // SCEV class definitions 238 //===----------------------------------------------------------------------===// 239 240 //===----------------------------------------------------------------------===// 241 // Implementation of the SCEV class. 242 // 243 244 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 245 LLVM_DUMP_METHOD void SCEV::dump() const { 246 print(dbgs()); 247 dbgs() << '\n'; 248 } 249 #endif 250 251 void SCEV::print(raw_ostream &OS) const { 252 switch (getSCEVType()) { 253 case scConstant: 254 cast<SCEVConstant>(this)->getValue()->printAsOperand(OS, false); 255 return; 256 case scPtrToInt: { 257 const SCEVPtrToIntExpr *PtrToInt = cast<SCEVPtrToIntExpr>(this); 258 const SCEV *Op = PtrToInt->getOperand(); 259 OS << "(ptrtoint " << *Op->getType() << " " << *Op << " to " 260 << *PtrToInt->getType() << ")"; 261 return; 262 } 263 case scTruncate: { 264 const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this); 265 const SCEV *Op = Trunc->getOperand(); 266 OS << "(trunc " << *Op->getType() << " " << *Op << " to " 267 << *Trunc->getType() << ")"; 268 return; 269 } 270 case scZeroExtend: { 271 const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this); 272 const SCEV *Op = ZExt->getOperand(); 273 OS << "(zext " << *Op->getType() << " " << *Op << " to " 274 << *ZExt->getType() << ")"; 275 return; 276 } 277 case scSignExtend: { 278 const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this); 279 const SCEV *Op = SExt->getOperand(); 280 OS << "(sext " << *Op->getType() << " " << *Op << " to " 281 << *SExt->getType() << ")"; 282 return; 283 } 284 case scAddRecExpr: { 285 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this); 286 OS << "{" << *AR->getOperand(0); 287 for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i) 288 OS << ",+," << *AR->getOperand(i); 289 OS << "}<"; 290 if (AR->hasNoUnsignedWrap()) 291 OS << "nuw><"; 292 if (AR->hasNoSignedWrap()) 293 OS << "nsw><"; 294 if (AR->hasNoSelfWrap() && 295 !AR->getNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW))) 296 OS << "nw><"; 297 AR->getLoop()->getHeader()->printAsOperand(OS, /*PrintType=*/false); 298 OS << ">"; 299 return; 300 } 301 case scAddExpr: 302 case scMulExpr: 303 case scUMaxExpr: 304 case scSMaxExpr: 305 case scUMinExpr: 306 case scSMinExpr: { 307 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this); 308 const char *OpStr = nullptr; 309 switch (NAry->getSCEVType()) { 310 case scAddExpr: OpStr = " + "; break; 311 case scMulExpr: OpStr = " * "; break; 312 case scUMaxExpr: OpStr = " umax "; break; 313 case scSMaxExpr: OpStr = " smax "; break; 314 case scUMinExpr: 315 OpStr = " umin "; 316 break; 317 case scSMinExpr: 318 OpStr = " smin "; 319 break; 320 default: 321 llvm_unreachable("There are no other nary expression types."); 322 } 323 OS << "("; 324 ListSeparator LS(OpStr); 325 for (const SCEV *Op : NAry->operands()) 326 OS << LS << *Op; 327 OS << ")"; 328 switch (NAry->getSCEVType()) { 329 case scAddExpr: 330 case scMulExpr: 331 if (NAry->hasNoUnsignedWrap()) 332 OS << "<nuw>"; 333 if (NAry->hasNoSignedWrap()) 334 OS << "<nsw>"; 335 break; 336 default: 337 // Nothing to print for other nary expressions. 338 break; 339 } 340 return; 341 } 342 case scUDivExpr: { 343 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this); 344 OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")"; 345 return; 346 } 347 case scUnknown: { 348 const SCEVUnknown *U = cast<SCEVUnknown>(this); 349 Type *AllocTy; 350 if (U->isSizeOf(AllocTy)) { 351 OS << "sizeof(" << *AllocTy << ")"; 352 return; 353 } 354 if (U->isAlignOf(AllocTy)) { 355 OS << "alignof(" << *AllocTy << ")"; 356 return; 357 } 358 359 Type *CTy; 360 Constant *FieldNo; 361 if (U->isOffsetOf(CTy, FieldNo)) { 362 OS << "offsetof(" << *CTy << ", "; 363 FieldNo->printAsOperand(OS, false); 364 OS << ")"; 365 return; 366 } 367 368 // Otherwise just print it normally. 369 U->getValue()->printAsOperand(OS, false); 370 return; 371 } 372 case scCouldNotCompute: 373 OS << "***COULDNOTCOMPUTE***"; 374 return; 375 } 376 llvm_unreachable("Unknown SCEV kind!"); 377 } 378 379 Type *SCEV::getType() const { 380 switch (getSCEVType()) { 381 case scConstant: 382 return cast<SCEVConstant>(this)->getType(); 383 case scPtrToInt: 384 case scTruncate: 385 case scZeroExtend: 386 case scSignExtend: 387 return cast<SCEVCastExpr>(this)->getType(); 388 case scAddRecExpr: 389 case scMulExpr: 390 case scUMaxExpr: 391 case scSMaxExpr: 392 case scUMinExpr: 393 case scSMinExpr: 394 return cast<SCEVNAryExpr>(this)->getType(); 395 case scAddExpr: 396 return cast<SCEVAddExpr>(this)->getType(); 397 case scUDivExpr: 398 return cast<SCEVUDivExpr>(this)->getType(); 399 case scUnknown: 400 return cast<SCEVUnknown>(this)->getType(); 401 case scCouldNotCompute: 402 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 403 } 404 llvm_unreachable("Unknown SCEV kind!"); 405 } 406 407 bool SCEV::isZero() const { 408 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 409 return SC->getValue()->isZero(); 410 return false; 411 } 412 413 bool SCEV::isOne() const { 414 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 415 return SC->getValue()->isOne(); 416 return false; 417 } 418 419 bool SCEV::isAllOnesValue() const { 420 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 421 return SC->getValue()->isMinusOne(); 422 return false; 423 } 424 425 bool SCEV::isNonConstantNegative() const { 426 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(this); 427 if (!Mul) return false; 428 429 // If there is a constant factor, it will be first. 430 const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0)); 431 if (!SC) return false; 432 433 // Return true if the value is negative, this matches things like (-42 * V). 434 return SC->getAPInt().isNegative(); 435 } 436 437 SCEVCouldNotCompute::SCEVCouldNotCompute() : 438 SCEV(FoldingSetNodeIDRef(), scCouldNotCompute, 0) {} 439 440 bool SCEVCouldNotCompute::classof(const SCEV *S) { 441 return S->getSCEVType() == scCouldNotCompute; 442 } 443 444 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) { 445 FoldingSetNodeID ID; 446 ID.AddInteger(scConstant); 447 ID.AddPointer(V); 448 void *IP = nullptr; 449 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 450 SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V); 451 UniqueSCEVs.InsertNode(S, IP); 452 return S; 453 } 454 455 const SCEV *ScalarEvolution::getConstant(const APInt &Val) { 456 return getConstant(ConstantInt::get(getContext(), Val)); 457 } 458 459 const SCEV * 460 ScalarEvolution::getConstant(Type *Ty, uint64_t V, bool isSigned) { 461 IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty)); 462 return getConstant(ConstantInt::get(ITy, V, isSigned)); 463 } 464 465 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID, SCEVTypes SCEVTy, 466 const SCEV *op, Type *ty) 467 : SCEV(ID, SCEVTy, computeExpressionSize(op)), Ty(ty) { 468 Operands[0] = op; 469 } 470 471 SCEVPtrToIntExpr::SCEVPtrToIntExpr(const FoldingSetNodeIDRef ID, const SCEV *Op, 472 Type *ITy) 473 : SCEVCastExpr(ID, scPtrToInt, Op, ITy) { 474 assert(getOperand()->getType()->isPointerTy() && Ty->isIntegerTy() && 475 "Must be a non-bit-width-changing pointer-to-integer cast!"); 476 } 477 478 SCEVIntegralCastExpr::SCEVIntegralCastExpr(const FoldingSetNodeIDRef ID, 479 SCEVTypes SCEVTy, const SCEV *op, 480 Type *ty) 481 : SCEVCastExpr(ID, SCEVTy, op, ty) {} 482 483 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID, const SCEV *op, 484 Type *ty) 485 : SCEVIntegralCastExpr(ID, scTruncate, op, ty) { 486 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 487 "Cannot truncate non-integer value!"); 488 } 489 490 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID, 491 const SCEV *op, Type *ty) 492 : SCEVIntegralCastExpr(ID, scZeroExtend, op, ty) { 493 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 494 "Cannot zero extend non-integer value!"); 495 } 496 497 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID, 498 const SCEV *op, Type *ty) 499 : SCEVIntegralCastExpr(ID, scSignExtend, op, ty) { 500 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 501 "Cannot sign extend non-integer value!"); 502 } 503 504 void SCEVUnknown::deleted() { 505 // Clear this SCEVUnknown from various maps. 506 SE->forgetMemoizedResults(this); 507 508 // Remove this SCEVUnknown from the uniquing map. 509 SE->UniqueSCEVs.RemoveNode(this); 510 511 // Release the value. 512 setValPtr(nullptr); 513 } 514 515 void SCEVUnknown::allUsesReplacedWith(Value *New) { 516 // Remove this SCEVUnknown from the uniquing map. 517 SE->UniqueSCEVs.RemoveNode(this); 518 519 // Update this SCEVUnknown to point to the new value. This is needed 520 // because there may still be outstanding SCEVs which still point to 521 // this SCEVUnknown. 522 setValPtr(New); 523 } 524 525 bool SCEVUnknown::isSizeOf(Type *&AllocTy) const { 526 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 527 if (VCE->getOpcode() == Instruction::PtrToInt) 528 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 529 if (CE->getOpcode() == Instruction::GetElementPtr && 530 CE->getOperand(0)->isNullValue() && 531 CE->getNumOperands() == 2) 532 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1))) 533 if (CI->isOne()) { 534 AllocTy = cast<PointerType>(CE->getOperand(0)->getType()) 535 ->getElementType(); 536 return true; 537 } 538 539 return false; 540 } 541 542 bool SCEVUnknown::isAlignOf(Type *&AllocTy) const { 543 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 544 if (VCE->getOpcode() == Instruction::PtrToInt) 545 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 546 if (CE->getOpcode() == Instruction::GetElementPtr && 547 CE->getOperand(0)->isNullValue()) { 548 Type *Ty = 549 cast<PointerType>(CE->getOperand(0)->getType())->getElementType(); 550 if (StructType *STy = dyn_cast<StructType>(Ty)) 551 if (!STy->isPacked() && 552 CE->getNumOperands() == 3 && 553 CE->getOperand(1)->isNullValue()) { 554 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2))) 555 if (CI->isOne() && 556 STy->getNumElements() == 2 && 557 STy->getElementType(0)->isIntegerTy(1)) { 558 AllocTy = STy->getElementType(1); 559 return true; 560 } 561 } 562 } 563 564 return false; 565 } 566 567 bool SCEVUnknown::isOffsetOf(Type *&CTy, Constant *&FieldNo) const { 568 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 569 if (VCE->getOpcode() == Instruction::PtrToInt) 570 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 571 if (CE->getOpcode() == Instruction::GetElementPtr && 572 CE->getNumOperands() == 3 && 573 CE->getOperand(0)->isNullValue() && 574 CE->getOperand(1)->isNullValue()) { 575 Type *Ty = 576 cast<PointerType>(CE->getOperand(0)->getType())->getElementType(); 577 // Ignore vector types here so that ScalarEvolutionExpander doesn't 578 // emit getelementptrs that index into vectors. 579 if (Ty->isStructTy() || Ty->isArrayTy()) { 580 CTy = Ty; 581 FieldNo = CE->getOperand(2); 582 return true; 583 } 584 } 585 586 return false; 587 } 588 589 //===----------------------------------------------------------------------===// 590 // SCEV Utilities 591 //===----------------------------------------------------------------------===// 592 593 /// Compare the two values \p LV and \p RV in terms of their "complexity" where 594 /// "complexity" is a partial (and somewhat ad-hoc) relation used to order 595 /// operands in SCEV expressions. \p EqCache is a set of pairs of values that 596 /// have been previously deemed to be "equally complex" by this routine. It is 597 /// intended to avoid exponential time complexity in cases like: 598 /// 599 /// %a = f(%x, %y) 600 /// %b = f(%a, %a) 601 /// %c = f(%b, %b) 602 /// 603 /// %d = f(%x, %y) 604 /// %e = f(%d, %d) 605 /// %f = f(%e, %e) 606 /// 607 /// CompareValueComplexity(%f, %c) 608 /// 609 /// Since we do not continue running this routine on expression trees once we 610 /// have seen unequal values, there is no need to track them in the cache. 611 static int 612 CompareValueComplexity(EquivalenceClasses<const Value *> &EqCacheValue, 613 const LoopInfo *const LI, Value *LV, Value *RV, 614 unsigned Depth) { 615 if (Depth > MaxValueCompareDepth || EqCacheValue.isEquivalent(LV, RV)) 616 return 0; 617 618 // Order pointer values after integer values. This helps SCEVExpander form 619 // GEPs. 620 bool LIsPointer = LV->getType()->isPointerTy(), 621 RIsPointer = RV->getType()->isPointerTy(); 622 if (LIsPointer != RIsPointer) 623 return (int)LIsPointer - (int)RIsPointer; 624 625 // Compare getValueID values. 626 unsigned LID = LV->getValueID(), RID = RV->getValueID(); 627 if (LID != RID) 628 return (int)LID - (int)RID; 629 630 // Sort arguments by their position. 631 if (const auto *LA = dyn_cast<Argument>(LV)) { 632 const auto *RA = cast<Argument>(RV); 633 unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo(); 634 return (int)LArgNo - (int)RArgNo; 635 } 636 637 if (const auto *LGV = dyn_cast<GlobalValue>(LV)) { 638 const auto *RGV = cast<GlobalValue>(RV); 639 640 const auto IsGVNameSemantic = [&](const GlobalValue *GV) { 641 auto LT = GV->getLinkage(); 642 return !(GlobalValue::isPrivateLinkage(LT) || 643 GlobalValue::isInternalLinkage(LT)); 644 }; 645 646 // Use the names to distinguish the two values, but only if the 647 // names are semantically important. 648 if (IsGVNameSemantic(LGV) && IsGVNameSemantic(RGV)) 649 return LGV->getName().compare(RGV->getName()); 650 } 651 652 // For instructions, compare their loop depth, and their operand count. This 653 // is pretty loose. 654 if (const auto *LInst = dyn_cast<Instruction>(LV)) { 655 const auto *RInst = cast<Instruction>(RV); 656 657 // Compare loop depths. 658 const BasicBlock *LParent = LInst->getParent(), 659 *RParent = RInst->getParent(); 660 if (LParent != RParent) { 661 unsigned LDepth = LI->getLoopDepth(LParent), 662 RDepth = LI->getLoopDepth(RParent); 663 if (LDepth != RDepth) 664 return (int)LDepth - (int)RDepth; 665 } 666 667 // Compare the number of operands. 668 unsigned LNumOps = LInst->getNumOperands(), 669 RNumOps = RInst->getNumOperands(); 670 if (LNumOps != RNumOps) 671 return (int)LNumOps - (int)RNumOps; 672 673 for (unsigned Idx : seq(0u, LNumOps)) { 674 int Result = 675 CompareValueComplexity(EqCacheValue, LI, LInst->getOperand(Idx), 676 RInst->getOperand(Idx), Depth + 1); 677 if (Result != 0) 678 return Result; 679 } 680 } 681 682 EqCacheValue.unionSets(LV, RV); 683 return 0; 684 } 685 686 // Return negative, zero, or positive, if LHS is less than, equal to, or greater 687 // than RHS, respectively. A three-way result allows recursive comparisons to be 688 // more efficient. 689 // If the max analysis depth was reached, return None, assuming we do not know 690 // if they are equivalent for sure. 691 static Optional<int> 692 CompareSCEVComplexity(EquivalenceClasses<const SCEV *> &EqCacheSCEV, 693 EquivalenceClasses<const Value *> &EqCacheValue, 694 const LoopInfo *const LI, const SCEV *LHS, 695 const SCEV *RHS, DominatorTree &DT, unsigned Depth = 0) { 696 // Fast-path: SCEVs are uniqued so we can do a quick equality check. 697 if (LHS == RHS) 698 return 0; 699 700 // Primarily, sort the SCEVs by their getSCEVType(). 701 SCEVTypes LType = LHS->getSCEVType(), RType = RHS->getSCEVType(); 702 if (LType != RType) 703 return (int)LType - (int)RType; 704 705 if (EqCacheSCEV.isEquivalent(LHS, RHS)) 706 return 0; 707 708 if (Depth > MaxSCEVCompareDepth) 709 return None; 710 711 // Aside from the getSCEVType() ordering, the particular ordering 712 // isn't very important except that it's beneficial to be consistent, 713 // so that (a + b) and (b + a) don't end up as different expressions. 714 switch (LType) { 715 case scUnknown: { 716 const SCEVUnknown *LU = cast<SCEVUnknown>(LHS); 717 const SCEVUnknown *RU = cast<SCEVUnknown>(RHS); 718 719 int X = CompareValueComplexity(EqCacheValue, LI, LU->getValue(), 720 RU->getValue(), Depth + 1); 721 if (X == 0) 722 EqCacheSCEV.unionSets(LHS, RHS); 723 return X; 724 } 725 726 case scConstant: { 727 const SCEVConstant *LC = cast<SCEVConstant>(LHS); 728 const SCEVConstant *RC = cast<SCEVConstant>(RHS); 729 730 // Compare constant values. 731 const APInt &LA = LC->getAPInt(); 732 const APInt &RA = RC->getAPInt(); 733 unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth(); 734 if (LBitWidth != RBitWidth) 735 return (int)LBitWidth - (int)RBitWidth; 736 return LA.ult(RA) ? -1 : 1; 737 } 738 739 case scAddRecExpr: { 740 const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS); 741 const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS); 742 743 // There is always a dominance between two recs that are used by one SCEV, 744 // so we can safely sort recs by loop header dominance. We require such 745 // order in getAddExpr. 746 const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop(); 747 if (LLoop != RLoop) { 748 const BasicBlock *LHead = LLoop->getHeader(), *RHead = RLoop->getHeader(); 749 assert(LHead != RHead && "Two loops share the same header?"); 750 if (DT.dominates(LHead, RHead)) 751 return 1; 752 else 753 assert(DT.dominates(RHead, LHead) && 754 "No dominance between recurrences used by one SCEV?"); 755 return -1; 756 } 757 758 // Addrec complexity grows with operand count. 759 unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands(); 760 if (LNumOps != RNumOps) 761 return (int)LNumOps - (int)RNumOps; 762 763 // Lexicographically compare. 764 for (unsigned i = 0; i != LNumOps; ++i) { 765 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, 766 LA->getOperand(i), RA->getOperand(i), DT, 767 Depth + 1); 768 if (X != 0) 769 return X; 770 } 771 EqCacheSCEV.unionSets(LHS, RHS); 772 return 0; 773 } 774 775 case scAddExpr: 776 case scMulExpr: 777 case scSMaxExpr: 778 case scUMaxExpr: 779 case scSMinExpr: 780 case scUMinExpr: { 781 const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS); 782 const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS); 783 784 // Lexicographically compare n-ary expressions. 785 unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands(); 786 if (LNumOps != RNumOps) 787 return (int)LNumOps - (int)RNumOps; 788 789 for (unsigned i = 0; i != LNumOps; ++i) { 790 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, 791 LC->getOperand(i), RC->getOperand(i), DT, 792 Depth + 1); 793 if (X != 0) 794 return X; 795 } 796 EqCacheSCEV.unionSets(LHS, RHS); 797 return 0; 798 } 799 800 case scUDivExpr: { 801 const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS); 802 const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS); 803 804 // Lexicographically compare udiv expressions. 805 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getLHS(), 806 RC->getLHS(), DT, Depth + 1); 807 if (X != 0) 808 return X; 809 X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getRHS(), 810 RC->getRHS(), DT, Depth + 1); 811 if (X == 0) 812 EqCacheSCEV.unionSets(LHS, RHS); 813 return X; 814 } 815 816 case scPtrToInt: 817 case scTruncate: 818 case scZeroExtend: 819 case scSignExtend: { 820 const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS); 821 const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS); 822 823 // Compare cast expressions by operand. 824 auto X = 825 CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getOperand(), 826 RC->getOperand(), DT, Depth + 1); 827 if (X == 0) 828 EqCacheSCEV.unionSets(LHS, RHS); 829 return X; 830 } 831 832 case scCouldNotCompute: 833 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 834 } 835 llvm_unreachable("Unknown SCEV kind!"); 836 } 837 838 /// Given a list of SCEV objects, order them by their complexity, and group 839 /// objects of the same complexity together by value. When this routine is 840 /// finished, we know that any duplicates in the vector are consecutive and that 841 /// complexity is monotonically increasing. 842 /// 843 /// Note that we go take special precautions to ensure that we get deterministic 844 /// results from this routine. In other words, we don't want the results of 845 /// this to depend on where the addresses of various SCEV objects happened to 846 /// land in memory. 847 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops, 848 LoopInfo *LI, DominatorTree &DT) { 849 if (Ops.size() < 2) return; // Noop 850 851 EquivalenceClasses<const SCEV *> EqCacheSCEV; 852 EquivalenceClasses<const Value *> EqCacheValue; 853 854 // Whether LHS has provably less complexity than RHS. 855 auto IsLessComplex = [&](const SCEV *LHS, const SCEV *RHS) { 856 auto Complexity = 857 CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LHS, RHS, DT); 858 return Complexity && *Complexity < 0; 859 }; 860 if (Ops.size() == 2) { 861 // This is the common case, which also happens to be trivially simple. 862 // Special case it. 863 const SCEV *&LHS = Ops[0], *&RHS = Ops[1]; 864 if (IsLessComplex(RHS, LHS)) 865 std::swap(LHS, RHS); 866 return; 867 } 868 869 // Do the rough sort by complexity. 870 llvm::stable_sort(Ops, [&](const SCEV *LHS, const SCEV *RHS) { 871 return IsLessComplex(LHS, RHS); 872 }); 873 874 // Now that we are sorted by complexity, group elements of the same 875 // complexity. Note that this is, at worst, N^2, but the vector is likely to 876 // be extremely short in practice. Note that we take this approach because we 877 // do not want to depend on the addresses of the objects we are grouping. 878 for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) { 879 const SCEV *S = Ops[i]; 880 unsigned Complexity = S->getSCEVType(); 881 882 // If there are any objects of the same complexity and same value as this 883 // one, group them. 884 for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) { 885 if (Ops[j] == S) { // Found a duplicate. 886 // Move it to immediately after i'th element. 887 std::swap(Ops[i+1], Ops[j]); 888 ++i; // no need to rescan it. 889 if (i == e-2) return; // Done! 890 } 891 } 892 } 893 } 894 895 /// Returns true if \p Ops contains a huge SCEV (the subtree of S contains at 896 /// least HugeExprThreshold nodes). 897 static bool hasHugeExpression(ArrayRef<const SCEV *> Ops) { 898 return any_of(Ops, [](const SCEV *S) { 899 return S->getExpressionSize() >= HugeExprThreshold; 900 }); 901 } 902 903 //===----------------------------------------------------------------------===// 904 // Simple SCEV method implementations 905 //===----------------------------------------------------------------------===// 906 907 /// Compute BC(It, K). The result has width W. Assume, K > 0. 908 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K, 909 ScalarEvolution &SE, 910 Type *ResultTy) { 911 // Handle the simplest case efficiently. 912 if (K == 1) 913 return SE.getTruncateOrZeroExtend(It, ResultTy); 914 915 // We are using the following formula for BC(It, K): 916 // 917 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K! 918 // 919 // Suppose, W is the bitwidth of the return value. We must be prepared for 920 // overflow. Hence, we must assure that the result of our computation is 921 // equal to the accurate one modulo 2^W. Unfortunately, division isn't 922 // safe in modular arithmetic. 923 // 924 // However, this code doesn't use exactly that formula; the formula it uses 925 // is something like the following, where T is the number of factors of 2 in 926 // K! (i.e. trailing zeros in the binary representation of K!), and ^ is 927 // exponentiation: 928 // 929 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T) 930 // 931 // This formula is trivially equivalent to the previous formula. However, 932 // this formula can be implemented much more efficiently. The trick is that 933 // K! / 2^T is odd, and exact division by an odd number *is* safe in modular 934 // arithmetic. To do exact division in modular arithmetic, all we have 935 // to do is multiply by the inverse. Therefore, this step can be done at 936 // width W. 937 // 938 // The next issue is how to safely do the division by 2^T. The way this 939 // is done is by doing the multiplication step at a width of at least W + T 940 // bits. This way, the bottom W+T bits of the product are accurate. Then, 941 // when we perform the division by 2^T (which is equivalent to a right shift 942 // by T), the bottom W bits are accurate. Extra bits are okay; they'll get 943 // truncated out after the division by 2^T. 944 // 945 // In comparison to just directly using the first formula, this technique 946 // is much more efficient; using the first formula requires W * K bits, 947 // but this formula less than W + K bits. Also, the first formula requires 948 // a division step, whereas this formula only requires multiplies and shifts. 949 // 950 // It doesn't matter whether the subtraction step is done in the calculation 951 // width or the input iteration count's width; if the subtraction overflows, 952 // the result must be zero anyway. We prefer here to do it in the width of 953 // the induction variable because it helps a lot for certain cases; CodeGen 954 // isn't smart enough to ignore the overflow, which leads to much less 955 // efficient code if the width of the subtraction is wider than the native 956 // register width. 957 // 958 // (It's possible to not widen at all by pulling out factors of 2 before 959 // the multiplication; for example, K=2 can be calculated as 960 // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires 961 // extra arithmetic, so it's not an obvious win, and it gets 962 // much more complicated for K > 3.) 963 964 // Protection from insane SCEVs; this bound is conservative, 965 // but it probably doesn't matter. 966 if (K > 1000) 967 return SE.getCouldNotCompute(); 968 969 unsigned W = SE.getTypeSizeInBits(ResultTy); 970 971 // Calculate K! / 2^T and T; we divide out the factors of two before 972 // multiplying for calculating K! / 2^T to avoid overflow. 973 // Other overflow doesn't matter because we only care about the bottom 974 // W bits of the result. 975 APInt OddFactorial(W, 1); 976 unsigned T = 1; 977 for (unsigned i = 3; i <= K; ++i) { 978 APInt Mult(W, i); 979 unsigned TwoFactors = Mult.countTrailingZeros(); 980 T += TwoFactors; 981 Mult.lshrInPlace(TwoFactors); 982 OddFactorial *= Mult; 983 } 984 985 // We need at least W + T bits for the multiplication step 986 unsigned CalculationBits = W + T; 987 988 // Calculate 2^T, at width T+W. 989 APInt DivFactor = APInt::getOneBitSet(CalculationBits, T); 990 991 // Calculate the multiplicative inverse of K! / 2^T; 992 // this multiplication factor will perform the exact division by 993 // K! / 2^T. 994 APInt Mod = APInt::getSignedMinValue(W+1); 995 APInt MultiplyFactor = OddFactorial.zext(W+1); 996 MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod); 997 MultiplyFactor = MultiplyFactor.trunc(W); 998 999 // Calculate the product, at width T+W 1000 IntegerType *CalculationTy = IntegerType::get(SE.getContext(), 1001 CalculationBits); 1002 const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy); 1003 for (unsigned i = 1; i != K; ++i) { 1004 const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i)); 1005 Dividend = SE.getMulExpr(Dividend, 1006 SE.getTruncateOrZeroExtend(S, CalculationTy)); 1007 } 1008 1009 // Divide by 2^T 1010 const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor)); 1011 1012 // Truncate the result, and divide by K! / 2^T. 1013 1014 return SE.getMulExpr(SE.getConstant(MultiplyFactor), 1015 SE.getTruncateOrZeroExtend(DivResult, ResultTy)); 1016 } 1017 1018 /// Return the value of this chain of recurrences at the specified iteration 1019 /// number. We can evaluate this recurrence by multiplying each element in the 1020 /// chain by the binomial coefficient corresponding to it. In other words, we 1021 /// can evaluate {A,+,B,+,C,+,D} as: 1022 /// 1023 /// A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3) 1024 /// 1025 /// where BC(It, k) stands for binomial coefficient. 1026 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It, 1027 ScalarEvolution &SE) const { 1028 const SCEV *Result = getStart(); 1029 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) { 1030 // The computation is correct in the face of overflow provided that the 1031 // multiplication is performed _after_ the evaluation of the binomial 1032 // coefficient. 1033 const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType()); 1034 if (isa<SCEVCouldNotCompute>(Coeff)) 1035 return Coeff; 1036 1037 Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff)); 1038 } 1039 return Result; 1040 } 1041 1042 //===----------------------------------------------------------------------===// 1043 // SCEV Expression folder implementations 1044 //===----------------------------------------------------------------------===// 1045 1046 const SCEV *ScalarEvolution::getLosslessPtrToIntExpr(const SCEV *Op, 1047 unsigned Depth) { 1048 assert(Depth <= 1 && 1049 "getLosslessPtrToIntExpr() should self-recurse at most once."); 1050 1051 // We could be called with an integer-typed operands during SCEV rewrites. 1052 // Since the operand is an integer already, just perform zext/trunc/self cast. 1053 if (!Op->getType()->isPointerTy()) 1054 return Op; 1055 1056 assert(!getDataLayout().isNonIntegralPointerType(Op->getType()) && 1057 "Source pointer type must be integral for ptrtoint!"); 1058 1059 // What would be an ID for such a SCEV cast expression? 1060 FoldingSetNodeID ID; 1061 ID.AddInteger(scPtrToInt); 1062 ID.AddPointer(Op); 1063 1064 void *IP = nullptr; 1065 1066 // Is there already an expression for such a cast? 1067 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 1068 return S; 1069 1070 Type *IntPtrTy = getDataLayout().getIntPtrType(Op->getType()); 1071 1072 // We can only model ptrtoint if SCEV's effective (integer) type 1073 // is sufficiently wide to represent all possible pointer values. 1074 if (getDataLayout().getTypeSizeInBits(getEffectiveSCEVType(Op->getType())) != 1075 getDataLayout().getTypeSizeInBits(IntPtrTy)) 1076 return getCouldNotCompute(); 1077 1078 // If not, is this expression something we can't reduce any further? 1079 if (auto *U = dyn_cast<SCEVUnknown>(Op)) { 1080 // Perform some basic constant folding. If the operand of the ptr2int cast 1081 // is a null pointer, don't create a ptr2int SCEV expression (that will be 1082 // left as-is), but produce a zero constant. 1083 // NOTE: We could handle a more general case, but lack motivational cases. 1084 if (isa<ConstantPointerNull>(U->getValue())) 1085 return getZero(IntPtrTy); 1086 1087 // Create an explicit cast node. 1088 // We can reuse the existing insert position since if we get here, 1089 // we won't have made any changes which would invalidate it. 1090 SCEV *S = new (SCEVAllocator) 1091 SCEVPtrToIntExpr(ID.Intern(SCEVAllocator), Op, IntPtrTy); 1092 UniqueSCEVs.InsertNode(S, IP); 1093 addToLoopUseLists(S); 1094 return S; 1095 } 1096 1097 assert(Depth == 0 && "getLosslessPtrToIntExpr() should not self-recurse for " 1098 "non-SCEVUnknown's."); 1099 1100 // Otherwise, we've got some expression that is more complex than just a 1101 // single SCEVUnknown. But we don't want to have a SCEVPtrToIntExpr of an 1102 // arbitrary expression, we want to have SCEVPtrToIntExpr of an SCEVUnknown 1103 // only, and the expressions must otherwise be integer-typed. 1104 // So sink the cast down to the SCEVUnknown's. 1105 1106 /// The SCEVPtrToIntSinkingRewriter takes a scalar evolution expression, 1107 /// which computes a pointer-typed value, and rewrites the whole expression 1108 /// tree so that *all* the computations are done on integers, and the only 1109 /// pointer-typed operands in the expression are SCEVUnknown. 1110 class SCEVPtrToIntSinkingRewriter 1111 : public SCEVRewriteVisitor<SCEVPtrToIntSinkingRewriter> { 1112 using Base = SCEVRewriteVisitor<SCEVPtrToIntSinkingRewriter>; 1113 1114 public: 1115 SCEVPtrToIntSinkingRewriter(ScalarEvolution &SE) : SCEVRewriteVisitor(SE) {} 1116 1117 static const SCEV *rewrite(const SCEV *Scev, ScalarEvolution &SE) { 1118 SCEVPtrToIntSinkingRewriter Rewriter(SE); 1119 return Rewriter.visit(Scev); 1120 } 1121 1122 const SCEV *visit(const SCEV *S) { 1123 Type *STy = S->getType(); 1124 // If the expression is not pointer-typed, just keep it as-is. 1125 if (!STy->isPointerTy()) 1126 return S; 1127 // Else, recursively sink the cast down into it. 1128 return Base::visit(S); 1129 } 1130 1131 const SCEV *visitAddExpr(const SCEVAddExpr *Expr) { 1132 SmallVector<const SCEV *, 2> Operands; 1133 bool Changed = false; 1134 for (auto *Op : Expr->operands()) { 1135 Operands.push_back(visit(Op)); 1136 Changed |= Op != Operands.back(); 1137 } 1138 return !Changed ? Expr : SE.getAddExpr(Operands, Expr->getNoWrapFlags()); 1139 } 1140 1141 const SCEV *visitMulExpr(const SCEVMulExpr *Expr) { 1142 SmallVector<const SCEV *, 2> Operands; 1143 bool Changed = false; 1144 for (auto *Op : Expr->operands()) { 1145 Operands.push_back(visit(Op)); 1146 Changed |= Op != Operands.back(); 1147 } 1148 return !Changed ? Expr : SE.getMulExpr(Operands, Expr->getNoWrapFlags()); 1149 } 1150 1151 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 1152 assert(Expr->getType()->isPointerTy() && 1153 "Should only reach pointer-typed SCEVUnknown's."); 1154 return SE.getLosslessPtrToIntExpr(Expr, /*Depth=*/1); 1155 } 1156 }; 1157 1158 // And actually perform the cast sinking. 1159 const SCEV *IntOp = SCEVPtrToIntSinkingRewriter::rewrite(Op, *this); 1160 assert(IntOp->getType()->isIntegerTy() && 1161 "We must have succeeded in sinking the cast, " 1162 "and ending up with an integer-typed expression!"); 1163 return IntOp; 1164 } 1165 1166 const SCEV *ScalarEvolution::getPtrToIntExpr(const SCEV *Op, Type *Ty) { 1167 assert(Ty->isIntegerTy() && "Target type must be an integer type!"); 1168 1169 const SCEV *IntOp = getLosslessPtrToIntExpr(Op); 1170 if (isa<SCEVCouldNotCompute>(IntOp)) 1171 return IntOp; 1172 1173 return getTruncateOrZeroExtend(IntOp, Ty); 1174 } 1175 1176 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op, Type *Ty, 1177 unsigned Depth) { 1178 assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) && 1179 "This is not a truncating conversion!"); 1180 assert(isSCEVable(Ty) && 1181 "This is not a conversion to a SCEVable type!"); 1182 Ty = getEffectiveSCEVType(Ty); 1183 1184 FoldingSetNodeID ID; 1185 ID.AddInteger(scTruncate); 1186 ID.AddPointer(Op); 1187 ID.AddPointer(Ty); 1188 void *IP = nullptr; 1189 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1190 1191 // Fold if the operand is constant. 1192 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1193 return getConstant( 1194 cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(), Ty))); 1195 1196 // trunc(trunc(x)) --> trunc(x) 1197 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) 1198 return getTruncateExpr(ST->getOperand(), Ty, Depth + 1); 1199 1200 // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing 1201 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op)) 1202 return getTruncateOrSignExtend(SS->getOperand(), Ty, Depth + 1); 1203 1204 // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing 1205 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1206 return getTruncateOrZeroExtend(SZ->getOperand(), Ty, Depth + 1); 1207 1208 if (Depth > MaxCastDepth) { 1209 SCEV *S = 1210 new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator), Op, Ty); 1211 UniqueSCEVs.InsertNode(S, IP); 1212 addToLoopUseLists(S); 1213 return S; 1214 } 1215 1216 // trunc(x1 + ... + xN) --> trunc(x1) + ... + trunc(xN) and 1217 // trunc(x1 * ... * xN) --> trunc(x1) * ... * trunc(xN), 1218 // if after transforming we have at most one truncate, not counting truncates 1219 // that replace other casts. 1220 if (isa<SCEVAddExpr>(Op) || isa<SCEVMulExpr>(Op)) { 1221 auto *CommOp = cast<SCEVCommutativeExpr>(Op); 1222 SmallVector<const SCEV *, 4> Operands; 1223 unsigned numTruncs = 0; 1224 for (unsigned i = 0, e = CommOp->getNumOperands(); i != e && numTruncs < 2; 1225 ++i) { 1226 const SCEV *S = getTruncateExpr(CommOp->getOperand(i), Ty, Depth + 1); 1227 if (!isa<SCEVIntegralCastExpr>(CommOp->getOperand(i)) && 1228 isa<SCEVTruncateExpr>(S)) 1229 numTruncs++; 1230 Operands.push_back(S); 1231 } 1232 if (numTruncs < 2) { 1233 if (isa<SCEVAddExpr>(Op)) 1234 return getAddExpr(Operands); 1235 else if (isa<SCEVMulExpr>(Op)) 1236 return getMulExpr(Operands); 1237 else 1238 llvm_unreachable("Unexpected SCEV type for Op."); 1239 } 1240 // Although we checked in the beginning that ID is not in the cache, it is 1241 // possible that during recursion and different modification ID was inserted 1242 // into the cache. So if we find it, just return it. 1243 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 1244 return S; 1245 } 1246 1247 // If the input value is a chrec scev, truncate the chrec's operands. 1248 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) { 1249 SmallVector<const SCEV *, 4> Operands; 1250 for (const SCEV *Op : AddRec->operands()) 1251 Operands.push_back(getTruncateExpr(Op, Ty, Depth + 1)); 1252 return getAddRecExpr(Operands, AddRec->getLoop(), SCEV::FlagAnyWrap); 1253 } 1254 1255 // Return zero if truncating to known zeros. 1256 uint32_t MinTrailingZeros = GetMinTrailingZeros(Op); 1257 if (MinTrailingZeros >= getTypeSizeInBits(Ty)) 1258 return getZero(Ty); 1259 1260 // The cast wasn't folded; create an explicit cast node. We can reuse 1261 // the existing insert position since if we get here, we won't have 1262 // made any changes which would invalidate it. 1263 SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator), 1264 Op, Ty); 1265 UniqueSCEVs.InsertNode(S, IP); 1266 addToLoopUseLists(S); 1267 return S; 1268 } 1269 1270 // Get the limit of a recurrence such that incrementing by Step cannot cause 1271 // signed overflow as long as the value of the recurrence within the 1272 // loop does not exceed this limit before incrementing. 1273 static const SCEV *getSignedOverflowLimitForStep(const SCEV *Step, 1274 ICmpInst::Predicate *Pred, 1275 ScalarEvolution *SE) { 1276 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType()); 1277 if (SE->isKnownPositive(Step)) { 1278 *Pred = ICmpInst::ICMP_SLT; 1279 return SE->getConstant(APInt::getSignedMinValue(BitWidth) - 1280 SE->getSignedRangeMax(Step)); 1281 } 1282 if (SE->isKnownNegative(Step)) { 1283 *Pred = ICmpInst::ICMP_SGT; 1284 return SE->getConstant(APInt::getSignedMaxValue(BitWidth) - 1285 SE->getSignedRangeMin(Step)); 1286 } 1287 return nullptr; 1288 } 1289 1290 // Get the limit of a recurrence such that incrementing by Step cannot cause 1291 // unsigned overflow as long as the value of the recurrence within the loop does 1292 // not exceed this limit before incrementing. 1293 static const SCEV *getUnsignedOverflowLimitForStep(const SCEV *Step, 1294 ICmpInst::Predicate *Pred, 1295 ScalarEvolution *SE) { 1296 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType()); 1297 *Pred = ICmpInst::ICMP_ULT; 1298 1299 return SE->getConstant(APInt::getMinValue(BitWidth) - 1300 SE->getUnsignedRangeMax(Step)); 1301 } 1302 1303 namespace { 1304 1305 struct ExtendOpTraitsBase { 1306 typedef const SCEV *(ScalarEvolution::*GetExtendExprTy)(const SCEV *, Type *, 1307 unsigned); 1308 }; 1309 1310 // Used to make code generic over signed and unsigned overflow. 1311 template <typename ExtendOp> struct ExtendOpTraits { 1312 // Members present: 1313 // 1314 // static const SCEV::NoWrapFlags WrapType; 1315 // 1316 // static const ExtendOpTraitsBase::GetExtendExprTy GetExtendExpr; 1317 // 1318 // static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1319 // ICmpInst::Predicate *Pred, 1320 // ScalarEvolution *SE); 1321 }; 1322 1323 template <> 1324 struct ExtendOpTraits<SCEVSignExtendExpr> : public ExtendOpTraitsBase { 1325 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNSW; 1326 1327 static const GetExtendExprTy GetExtendExpr; 1328 1329 static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1330 ICmpInst::Predicate *Pred, 1331 ScalarEvolution *SE) { 1332 return getSignedOverflowLimitForStep(Step, Pred, SE); 1333 } 1334 }; 1335 1336 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits< 1337 SCEVSignExtendExpr>::GetExtendExpr = &ScalarEvolution::getSignExtendExpr; 1338 1339 template <> 1340 struct ExtendOpTraits<SCEVZeroExtendExpr> : public ExtendOpTraitsBase { 1341 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNUW; 1342 1343 static const GetExtendExprTy GetExtendExpr; 1344 1345 static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1346 ICmpInst::Predicate *Pred, 1347 ScalarEvolution *SE) { 1348 return getUnsignedOverflowLimitForStep(Step, Pred, SE); 1349 } 1350 }; 1351 1352 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits< 1353 SCEVZeroExtendExpr>::GetExtendExpr = &ScalarEvolution::getZeroExtendExpr; 1354 1355 } // end anonymous namespace 1356 1357 // The recurrence AR has been shown to have no signed/unsigned wrap or something 1358 // close to it. Typically, if we can prove NSW/NUW for AR, then we can just as 1359 // easily prove NSW/NUW for its preincrement or postincrement sibling. This 1360 // allows normalizing a sign/zero extended AddRec as such: {sext/zext(Step + 1361 // Start),+,Step} => {(Step + sext/zext(Start),+,Step} As a result, the 1362 // expression "Step + sext/zext(PreIncAR)" is congruent with 1363 // "sext/zext(PostIncAR)" 1364 template <typename ExtendOpTy> 1365 static const SCEV *getPreStartForExtend(const SCEVAddRecExpr *AR, Type *Ty, 1366 ScalarEvolution *SE, unsigned Depth) { 1367 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType; 1368 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr; 1369 1370 const Loop *L = AR->getLoop(); 1371 const SCEV *Start = AR->getStart(); 1372 const SCEV *Step = AR->getStepRecurrence(*SE); 1373 1374 // Check for a simple looking step prior to loop entry. 1375 const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Start); 1376 if (!SA) 1377 return nullptr; 1378 1379 // Create an AddExpr for "PreStart" after subtracting Step. Full SCEV 1380 // subtraction is expensive. For this purpose, perform a quick and dirty 1381 // difference, by checking for Step in the operand list. 1382 SmallVector<const SCEV *, 4> DiffOps; 1383 for (const SCEV *Op : SA->operands()) 1384 if (Op != Step) 1385 DiffOps.push_back(Op); 1386 1387 if (DiffOps.size() == SA->getNumOperands()) 1388 return nullptr; 1389 1390 // Try to prove `WrapType` (SCEV::FlagNSW or SCEV::FlagNUW) on `PreStart` + 1391 // `Step`: 1392 1393 // 1. NSW/NUW flags on the step increment. 1394 auto PreStartFlags = 1395 ScalarEvolution::maskFlags(SA->getNoWrapFlags(), SCEV::FlagNUW); 1396 const SCEV *PreStart = SE->getAddExpr(DiffOps, PreStartFlags); 1397 const SCEVAddRecExpr *PreAR = dyn_cast<SCEVAddRecExpr>( 1398 SE->getAddRecExpr(PreStart, Step, L, SCEV::FlagAnyWrap)); 1399 1400 // "{S,+,X} is <nsw>/<nuw>" and "the backedge is taken at least once" implies 1401 // "S+X does not sign/unsign-overflow". 1402 // 1403 1404 const SCEV *BECount = SE->getBackedgeTakenCount(L); 1405 if (PreAR && PreAR->getNoWrapFlags(WrapType) && 1406 !isa<SCEVCouldNotCompute>(BECount) && SE->isKnownPositive(BECount)) 1407 return PreStart; 1408 1409 // 2. Direct overflow check on the step operation's expression. 1410 unsigned BitWidth = SE->getTypeSizeInBits(AR->getType()); 1411 Type *WideTy = IntegerType::get(SE->getContext(), BitWidth * 2); 1412 const SCEV *OperandExtendedStart = 1413 SE->getAddExpr((SE->*GetExtendExpr)(PreStart, WideTy, Depth), 1414 (SE->*GetExtendExpr)(Step, WideTy, Depth)); 1415 if ((SE->*GetExtendExpr)(Start, WideTy, Depth) == OperandExtendedStart) { 1416 if (PreAR && AR->getNoWrapFlags(WrapType)) { 1417 // If we know `AR` == {`PreStart`+`Step`,+,`Step`} is `WrapType` (FlagNSW 1418 // or FlagNUW) and that `PreStart` + `Step` is `WrapType` too, then 1419 // `PreAR` == {`PreStart`,+,`Step`} is also `WrapType`. Cache this fact. 1420 SE->setNoWrapFlags(const_cast<SCEVAddRecExpr *>(PreAR), WrapType); 1421 } 1422 return PreStart; 1423 } 1424 1425 // 3. Loop precondition. 1426 ICmpInst::Predicate Pred; 1427 const SCEV *OverflowLimit = 1428 ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(Step, &Pred, SE); 1429 1430 if (OverflowLimit && 1431 SE->isLoopEntryGuardedByCond(L, Pred, PreStart, OverflowLimit)) 1432 return PreStart; 1433 1434 return nullptr; 1435 } 1436 1437 // Get the normalized zero or sign extended expression for this AddRec's Start. 1438 template <typename ExtendOpTy> 1439 static const SCEV *getExtendAddRecStart(const SCEVAddRecExpr *AR, Type *Ty, 1440 ScalarEvolution *SE, 1441 unsigned Depth) { 1442 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr; 1443 1444 const SCEV *PreStart = getPreStartForExtend<ExtendOpTy>(AR, Ty, SE, Depth); 1445 if (!PreStart) 1446 return (SE->*GetExtendExpr)(AR->getStart(), Ty, Depth); 1447 1448 return SE->getAddExpr((SE->*GetExtendExpr)(AR->getStepRecurrence(*SE), Ty, 1449 Depth), 1450 (SE->*GetExtendExpr)(PreStart, Ty, Depth)); 1451 } 1452 1453 // Try to prove away overflow by looking at "nearby" add recurrences. A 1454 // motivating example for this rule: if we know `{0,+,4}` is `ult` `-1` and it 1455 // does not itself wrap then we can conclude that `{1,+,4}` is `nuw`. 1456 // 1457 // Formally: 1458 // 1459 // {S,+,X} == {S-T,+,X} + T 1460 // => Ext({S,+,X}) == Ext({S-T,+,X} + T) 1461 // 1462 // If ({S-T,+,X} + T) does not overflow ... (1) 1463 // 1464 // RHS == Ext({S-T,+,X} + T) == Ext({S-T,+,X}) + Ext(T) 1465 // 1466 // If {S-T,+,X} does not overflow ... (2) 1467 // 1468 // RHS == Ext({S-T,+,X}) + Ext(T) == {Ext(S-T),+,Ext(X)} + Ext(T) 1469 // == {Ext(S-T)+Ext(T),+,Ext(X)} 1470 // 1471 // If (S-T)+T does not overflow ... (3) 1472 // 1473 // RHS == {Ext(S-T)+Ext(T),+,Ext(X)} == {Ext(S-T+T),+,Ext(X)} 1474 // == {Ext(S),+,Ext(X)} == LHS 1475 // 1476 // Thus, if (1), (2) and (3) are true for some T, then 1477 // Ext({S,+,X}) == {Ext(S),+,Ext(X)} 1478 // 1479 // (3) is implied by (1) -- "(S-T)+T does not overflow" is simply "({S-T,+,X}+T) 1480 // does not overflow" restricted to the 0th iteration. Therefore we only need 1481 // to check for (1) and (2). 1482 // 1483 // In the current context, S is `Start`, X is `Step`, Ext is `ExtendOpTy` and T 1484 // is `Delta` (defined below). 1485 template <typename ExtendOpTy> 1486 bool ScalarEvolution::proveNoWrapByVaryingStart(const SCEV *Start, 1487 const SCEV *Step, 1488 const Loop *L) { 1489 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType; 1490 1491 // We restrict `Start` to a constant to prevent SCEV from spending too much 1492 // time here. It is correct (but more expensive) to continue with a 1493 // non-constant `Start` and do a general SCEV subtraction to compute 1494 // `PreStart` below. 1495 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start); 1496 if (!StartC) 1497 return false; 1498 1499 APInt StartAI = StartC->getAPInt(); 1500 1501 for (unsigned Delta : {-2, -1, 1, 2}) { 1502 const SCEV *PreStart = getConstant(StartAI - Delta); 1503 1504 FoldingSetNodeID ID; 1505 ID.AddInteger(scAddRecExpr); 1506 ID.AddPointer(PreStart); 1507 ID.AddPointer(Step); 1508 ID.AddPointer(L); 1509 void *IP = nullptr; 1510 const auto *PreAR = 1511 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 1512 1513 // Give up if we don't already have the add recurrence we need because 1514 // actually constructing an add recurrence is relatively expensive. 1515 if (PreAR && PreAR->getNoWrapFlags(WrapType)) { // proves (2) 1516 const SCEV *DeltaS = getConstant(StartC->getType(), Delta); 1517 ICmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE; 1518 const SCEV *Limit = ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep( 1519 DeltaS, &Pred, this); 1520 if (Limit && isKnownPredicate(Pred, PreAR, Limit)) // proves (1) 1521 return true; 1522 } 1523 } 1524 1525 return false; 1526 } 1527 1528 // Finds an integer D for an expression (C + x + y + ...) such that the top 1529 // level addition in (D + (C - D + x + y + ...)) would not wrap (signed or 1530 // unsigned) and the number of trailing zeros of (C - D + x + y + ...) is 1531 // maximized, where C is the \p ConstantTerm, x, y, ... are arbitrary SCEVs, and 1532 // the (C + x + y + ...) expression is \p WholeAddExpr. 1533 static APInt extractConstantWithoutWrapping(ScalarEvolution &SE, 1534 const SCEVConstant *ConstantTerm, 1535 const SCEVAddExpr *WholeAddExpr) { 1536 const APInt &C = ConstantTerm->getAPInt(); 1537 const unsigned BitWidth = C.getBitWidth(); 1538 // Find number of trailing zeros of (x + y + ...) w/o the C first: 1539 uint32_t TZ = BitWidth; 1540 for (unsigned I = 1, E = WholeAddExpr->getNumOperands(); I < E && TZ; ++I) 1541 TZ = std::min(TZ, SE.GetMinTrailingZeros(WholeAddExpr->getOperand(I))); 1542 if (TZ) { 1543 // Set D to be as many least significant bits of C as possible while still 1544 // guaranteeing that adding D to (C - D + x + y + ...) won't cause a wrap: 1545 return TZ < BitWidth ? C.trunc(TZ).zext(BitWidth) : C; 1546 } 1547 return APInt(BitWidth, 0); 1548 } 1549 1550 // Finds an integer D for an affine AddRec expression {C,+,x} such that the top 1551 // level addition in (D + {C-D,+,x}) would not wrap (signed or unsigned) and the 1552 // number of trailing zeros of (C - D + x * n) is maximized, where C is the \p 1553 // ConstantStart, x is an arbitrary \p Step, and n is the loop trip count. 1554 static APInt extractConstantWithoutWrapping(ScalarEvolution &SE, 1555 const APInt &ConstantStart, 1556 const SCEV *Step) { 1557 const unsigned BitWidth = ConstantStart.getBitWidth(); 1558 const uint32_t TZ = SE.GetMinTrailingZeros(Step); 1559 if (TZ) 1560 return TZ < BitWidth ? ConstantStart.trunc(TZ).zext(BitWidth) 1561 : ConstantStart; 1562 return APInt(BitWidth, 0); 1563 } 1564 1565 const SCEV * 1566 ScalarEvolution::getZeroExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) { 1567 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 1568 "This is not an extending conversion!"); 1569 assert(isSCEVable(Ty) && 1570 "This is not a conversion to a SCEVable type!"); 1571 Ty = getEffectiveSCEVType(Ty); 1572 1573 // Fold if the operand is constant. 1574 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1575 return getConstant( 1576 cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(), Ty))); 1577 1578 // zext(zext(x)) --> zext(x) 1579 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1580 return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1); 1581 1582 // Before doing any expensive analysis, check to see if we've already 1583 // computed a SCEV for this Op and Ty. 1584 FoldingSetNodeID ID; 1585 ID.AddInteger(scZeroExtend); 1586 ID.AddPointer(Op); 1587 ID.AddPointer(Ty); 1588 void *IP = nullptr; 1589 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1590 if (Depth > MaxCastDepth) { 1591 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator), 1592 Op, Ty); 1593 UniqueSCEVs.InsertNode(S, IP); 1594 addToLoopUseLists(S); 1595 return S; 1596 } 1597 1598 // zext(trunc(x)) --> zext(x) or x or trunc(x) 1599 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) { 1600 // It's possible the bits taken off by the truncate were all zero bits. If 1601 // so, we should be able to simplify this further. 1602 const SCEV *X = ST->getOperand(); 1603 ConstantRange CR = getUnsignedRange(X); 1604 unsigned TruncBits = getTypeSizeInBits(ST->getType()); 1605 unsigned NewBits = getTypeSizeInBits(Ty); 1606 if (CR.truncate(TruncBits).zeroExtend(NewBits).contains( 1607 CR.zextOrTrunc(NewBits))) 1608 return getTruncateOrZeroExtend(X, Ty, Depth); 1609 } 1610 1611 // If the input value is a chrec scev, and we can prove that the value 1612 // did not overflow the old, smaller, value, we can zero extend all of the 1613 // operands (often constants). This allows analysis of something like 1614 // this: for (unsigned char X = 0; X < 100; ++X) { int Y = X; } 1615 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) 1616 if (AR->isAffine()) { 1617 const SCEV *Start = AR->getStart(); 1618 const SCEV *Step = AR->getStepRecurrence(*this); 1619 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 1620 const Loop *L = AR->getLoop(); 1621 1622 if (!AR->hasNoUnsignedWrap()) { 1623 auto NewFlags = proveNoWrapViaConstantRanges(AR); 1624 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1625 } 1626 1627 // If we have special knowledge that this addrec won't overflow, 1628 // we don't need to do any further analysis. 1629 if (AR->hasNoUnsignedWrap()) 1630 return getAddRecExpr( 1631 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1), 1632 getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 1633 1634 // Check whether the backedge-taken count is SCEVCouldNotCompute. 1635 // Note that this serves two purposes: It filters out loops that are 1636 // simply not analyzable, and it covers the case where this code is 1637 // being called from within backedge-taken count analysis, such that 1638 // attempting to ask for the backedge-taken count would likely result 1639 // in infinite recursion. In the later case, the analysis code will 1640 // cope with a conservative value, and it will take care to purge 1641 // that value once it has finished. 1642 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 1643 if (!isa<SCEVCouldNotCompute>(MaxBECount)) { 1644 // Manually compute the final value for AR, checking for overflow. 1645 1646 // Check whether the backedge-taken count can be losslessly casted to 1647 // the addrec's type. The count is always unsigned. 1648 const SCEV *CastedMaxBECount = 1649 getTruncateOrZeroExtend(MaxBECount, Start->getType(), Depth); 1650 const SCEV *RecastedMaxBECount = getTruncateOrZeroExtend( 1651 CastedMaxBECount, MaxBECount->getType(), Depth); 1652 if (MaxBECount == RecastedMaxBECount) { 1653 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2); 1654 // Check whether Start+Step*MaxBECount has no unsigned overflow. 1655 const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step, 1656 SCEV::FlagAnyWrap, Depth + 1); 1657 const SCEV *ZAdd = getZeroExtendExpr(getAddExpr(Start, ZMul, 1658 SCEV::FlagAnyWrap, 1659 Depth + 1), 1660 WideTy, Depth + 1); 1661 const SCEV *WideStart = getZeroExtendExpr(Start, WideTy, Depth + 1); 1662 const SCEV *WideMaxBECount = 1663 getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1); 1664 const SCEV *OperandExtendedAdd = 1665 getAddExpr(WideStart, 1666 getMulExpr(WideMaxBECount, 1667 getZeroExtendExpr(Step, WideTy, Depth + 1), 1668 SCEV::FlagAnyWrap, Depth + 1), 1669 SCEV::FlagAnyWrap, Depth + 1); 1670 if (ZAdd == OperandExtendedAdd) { 1671 // Cache knowledge of AR NUW, which is propagated to this AddRec. 1672 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNUW); 1673 // Return the expression with the addrec on the outside. 1674 return getAddRecExpr( 1675 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1676 Depth + 1), 1677 getZeroExtendExpr(Step, Ty, Depth + 1), L, 1678 AR->getNoWrapFlags()); 1679 } 1680 // Similar to above, only this time treat the step value as signed. 1681 // This covers loops that count down. 1682 OperandExtendedAdd = 1683 getAddExpr(WideStart, 1684 getMulExpr(WideMaxBECount, 1685 getSignExtendExpr(Step, WideTy, Depth + 1), 1686 SCEV::FlagAnyWrap, Depth + 1), 1687 SCEV::FlagAnyWrap, Depth + 1); 1688 if (ZAdd == OperandExtendedAdd) { 1689 // Cache knowledge of AR NW, which is propagated to this AddRec. 1690 // Negative step causes unsigned wrap, but it still can't self-wrap. 1691 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 1692 // Return the expression with the addrec on the outside. 1693 return getAddRecExpr( 1694 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1695 Depth + 1), 1696 getSignExtendExpr(Step, Ty, Depth + 1), L, 1697 AR->getNoWrapFlags()); 1698 } 1699 } 1700 } 1701 1702 // Normally, in the cases we can prove no-overflow via a 1703 // backedge guarding condition, we can also compute a backedge 1704 // taken count for the loop. The exceptions are assumptions and 1705 // guards present in the loop -- SCEV is not great at exploiting 1706 // these to compute max backedge taken counts, but can still use 1707 // these to prove lack of overflow. Use this fact to avoid 1708 // doing extra work that may not pay off. 1709 if (!isa<SCEVCouldNotCompute>(MaxBECount) || HasGuards || 1710 !AC.assumptions().empty()) { 1711 1712 auto NewFlags = proveNoUnsignedWrapViaInduction(AR); 1713 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1714 if (AR->hasNoUnsignedWrap()) { 1715 // Same as nuw case above - duplicated here to avoid a compile time 1716 // issue. It's not clear that the order of checks does matter, but 1717 // it's one of two issue possible causes for a change which was 1718 // reverted. Be conservative for the moment. 1719 return getAddRecExpr( 1720 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1721 Depth + 1), 1722 getZeroExtendExpr(Step, Ty, Depth + 1), L, 1723 AR->getNoWrapFlags()); 1724 } 1725 1726 // For a negative step, we can extend the operands iff doing so only 1727 // traverses values in the range zext([0,UINT_MAX]). 1728 if (isKnownNegative(Step)) { 1729 const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) - 1730 getSignedRangeMin(Step)); 1731 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) || 1732 isKnownOnEveryIteration(ICmpInst::ICMP_UGT, AR, N)) { 1733 // Cache knowledge of AR NW, which is propagated to this 1734 // AddRec. Negative step causes unsigned wrap, but it 1735 // still can't self-wrap. 1736 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 1737 // Return the expression with the addrec on the outside. 1738 return getAddRecExpr( 1739 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1740 Depth + 1), 1741 getSignExtendExpr(Step, Ty, Depth + 1), L, 1742 AR->getNoWrapFlags()); 1743 } 1744 } 1745 } 1746 1747 // zext({C,+,Step}) --> (zext(D) + zext({C-D,+,Step}))<nuw><nsw> 1748 // if D + (C - D + Step * n) could be proven to not unsigned wrap 1749 // where D maximizes the number of trailing zeros of (C - D + Step * n) 1750 if (const auto *SC = dyn_cast<SCEVConstant>(Start)) { 1751 const APInt &C = SC->getAPInt(); 1752 const APInt &D = extractConstantWithoutWrapping(*this, C, Step); 1753 if (D != 0) { 1754 const SCEV *SZExtD = getZeroExtendExpr(getConstant(D), Ty, Depth); 1755 const SCEV *SResidual = 1756 getAddRecExpr(getConstant(C - D), Step, L, AR->getNoWrapFlags()); 1757 const SCEV *SZExtR = getZeroExtendExpr(SResidual, Ty, Depth + 1); 1758 return getAddExpr(SZExtD, SZExtR, 1759 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1760 Depth + 1); 1761 } 1762 } 1763 1764 if (proveNoWrapByVaryingStart<SCEVZeroExtendExpr>(Start, Step, L)) { 1765 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNUW); 1766 return getAddRecExpr( 1767 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1), 1768 getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 1769 } 1770 } 1771 1772 // zext(A % B) --> zext(A) % zext(B) 1773 { 1774 const SCEV *LHS; 1775 const SCEV *RHS; 1776 if (matchURem(Op, LHS, RHS)) 1777 return getURemExpr(getZeroExtendExpr(LHS, Ty, Depth + 1), 1778 getZeroExtendExpr(RHS, Ty, Depth + 1)); 1779 } 1780 1781 // zext(A / B) --> zext(A) / zext(B). 1782 if (auto *Div = dyn_cast<SCEVUDivExpr>(Op)) 1783 return getUDivExpr(getZeroExtendExpr(Div->getLHS(), Ty, Depth + 1), 1784 getZeroExtendExpr(Div->getRHS(), Ty, Depth + 1)); 1785 1786 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) { 1787 // zext((A + B + ...)<nuw>) --> (zext(A) + zext(B) + ...)<nuw> 1788 if (SA->hasNoUnsignedWrap()) { 1789 // If the addition does not unsign overflow then we can, by definition, 1790 // commute the zero extension with the addition operation. 1791 SmallVector<const SCEV *, 4> Ops; 1792 for (const auto *Op : SA->operands()) 1793 Ops.push_back(getZeroExtendExpr(Op, Ty, Depth + 1)); 1794 return getAddExpr(Ops, SCEV::FlagNUW, Depth + 1); 1795 } 1796 1797 // zext(C + x + y + ...) --> (zext(D) + zext((C - D) + x + y + ...)) 1798 // if D + (C - D + x + y + ...) could be proven to not unsigned wrap 1799 // where D maximizes the number of trailing zeros of (C - D + x + y + ...) 1800 // 1801 // Often address arithmetics contain expressions like 1802 // (zext (add (shl X, C1), C2)), for instance, (zext (5 + (4 * X))). 1803 // This transformation is useful while proving that such expressions are 1804 // equal or differ by a small constant amount, see LoadStoreVectorizer pass. 1805 if (const auto *SC = dyn_cast<SCEVConstant>(SA->getOperand(0))) { 1806 const APInt &D = extractConstantWithoutWrapping(*this, SC, SA); 1807 if (D != 0) { 1808 const SCEV *SZExtD = getZeroExtendExpr(getConstant(D), Ty, Depth); 1809 const SCEV *SResidual = 1810 getAddExpr(getConstant(-D), SA, SCEV::FlagAnyWrap, Depth); 1811 const SCEV *SZExtR = getZeroExtendExpr(SResidual, Ty, Depth + 1); 1812 return getAddExpr(SZExtD, SZExtR, 1813 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1814 Depth + 1); 1815 } 1816 } 1817 } 1818 1819 if (auto *SM = dyn_cast<SCEVMulExpr>(Op)) { 1820 // zext((A * B * ...)<nuw>) --> (zext(A) * zext(B) * ...)<nuw> 1821 if (SM->hasNoUnsignedWrap()) { 1822 // If the multiply does not unsign overflow then we can, by definition, 1823 // commute the zero extension with the multiply operation. 1824 SmallVector<const SCEV *, 4> Ops; 1825 for (const auto *Op : SM->operands()) 1826 Ops.push_back(getZeroExtendExpr(Op, Ty, Depth + 1)); 1827 return getMulExpr(Ops, SCEV::FlagNUW, Depth + 1); 1828 } 1829 1830 // zext(2^K * (trunc X to iN)) to iM -> 1831 // 2^K * (zext(trunc X to i{N-K}) to iM)<nuw> 1832 // 1833 // Proof: 1834 // 1835 // zext(2^K * (trunc X to iN)) to iM 1836 // = zext((trunc X to iN) << K) to iM 1837 // = zext((trunc X to i{N-K}) << K)<nuw> to iM 1838 // (because shl removes the top K bits) 1839 // = zext((2^K * (trunc X to i{N-K}))<nuw>) to iM 1840 // = (2^K * (zext(trunc X to i{N-K}) to iM))<nuw>. 1841 // 1842 if (SM->getNumOperands() == 2) 1843 if (auto *MulLHS = dyn_cast<SCEVConstant>(SM->getOperand(0))) 1844 if (MulLHS->getAPInt().isPowerOf2()) 1845 if (auto *TruncRHS = dyn_cast<SCEVTruncateExpr>(SM->getOperand(1))) { 1846 int NewTruncBits = getTypeSizeInBits(TruncRHS->getType()) - 1847 MulLHS->getAPInt().logBase2(); 1848 Type *NewTruncTy = IntegerType::get(getContext(), NewTruncBits); 1849 return getMulExpr( 1850 getZeroExtendExpr(MulLHS, Ty), 1851 getZeroExtendExpr( 1852 getTruncateExpr(TruncRHS->getOperand(), NewTruncTy), Ty), 1853 SCEV::FlagNUW, Depth + 1); 1854 } 1855 } 1856 1857 // The cast wasn't folded; create an explicit cast node. 1858 // Recompute the insert position, as it may have been invalidated. 1859 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1860 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator), 1861 Op, Ty); 1862 UniqueSCEVs.InsertNode(S, IP); 1863 addToLoopUseLists(S); 1864 return S; 1865 } 1866 1867 const SCEV * 1868 ScalarEvolution::getSignExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) { 1869 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 1870 "This is not an extending conversion!"); 1871 assert(isSCEVable(Ty) && 1872 "This is not a conversion to a SCEVable type!"); 1873 Ty = getEffectiveSCEVType(Ty); 1874 1875 // Fold if the operand is constant. 1876 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1877 return getConstant( 1878 cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(), Ty))); 1879 1880 // sext(sext(x)) --> sext(x) 1881 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op)) 1882 return getSignExtendExpr(SS->getOperand(), Ty, Depth + 1); 1883 1884 // sext(zext(x)) --> zext(x) 1885 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1886 return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1); 1887 1888 // Before doing any expensive analysis, check to see if we've already 1889 // computed a SCEV for this Op and Ty. 1890 FoldingSetNodeID ID; 1891 ID.AddInteger(scSignExtend); 1892 ID.AddPointer(Op); 1893 ID.AddPointer(Ty); 1894 void *IP = nullptr; 1895 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1896 // Limit recursion depth. 1897 if (Depth > MaxCastDepth) { 1898 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator), 1899 Op, Ty); 1900 UniqueSCEVs.InsertNode(S, IP); 1901 addToLoopUseLists(S); 1902 return S; 1903 } 1904 1905 // sext(trunc(x)) --> sext(x) or x or trunc(x) 1906 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) { 1907 // It's possible the bits taken off by the truncate were all sign bits. If 1908 // so, we should be able to simplify this further. 1909 const SCEV *X = ST->getOperand(); 1910 ConstantRange CR = getSignedRange(X); 1911 unsigned TruncBits = getTypeSizeInBits(ST->getType()); 1912 unsigned NewBits = getTypeSizeInBits(Ty); 1913 if (CR.truncate(TruncBits).signExtend(NewBits).contains( 1914 CR.sextOrTrunc(NewBits))) 1915 return getTruncateOrSignExtend(X, Ty, Depth); 1916 } 1917 1918 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) { 1919 // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw> 1920 if (SA->hasNoSignedWrap()) { 1921 // If the addition does not sign overflow then we can, by definition, 1922 // commute the sign extension with the addition operation. 1923 SmallVector<const SCEV *, 4> Ops; 1924 for (const auto *Op : SA->operands()) 1925 Ops.push_back(getSignExtendExpr(Op, Ty, Depth + 1)); 1926 return getAddExpr(Ops, SCEV::FlagNSW, Depth + 1); 1927 } 1928 1929 // sext(C + x + y + ...) --> (sext(D) + sext((C - D) + x + y + ...)) 1930 // if D + (C - D + x + y + ...) could be proven to not signed wrap 1931 // where D maximizes the number of trailing zeros of (C - D + x + y + ...) 1932 // 1933 // For instance, this will bring two seemingly different expressions: 1934 // 1 + sext(5 + 20 * %x + 24 * %y) and 1935 // sext(6 + 20 * %x + 24 * %y) 1936 // to the same form: 1937 // 2 + sext(4 + 20 * %x + 24 * %y) 1938 if (const auto *SC = dyn_cast<SCEVConstant>(SA->getOperand(0))) { 1939 const APInt &D = extractConstantWithoutWrapping(*this, SC, SA); 1940 if (D != 0) { 1941 const SCEV *SSExtD = getSignExtendExpr(getConstant(D), Ty, Depth); 1942 const SCEV *SResidual = 1943 getAddExpr(getConstant(-D), SA, SCEV::FlagAnyWrap, Depth); 1944 const SCEV *SSExtR = getSignExtendExpr(SResidual, Ty, Depth + 1); 1945 return getAddExpr(SSExtD, SSExtR, 1946 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1947 Depth + 1); 1948 } 1949 } 1950 } 1951 // If the input value is a chrec scev, and we can prove that the value 1952 // did not overflow the old, smaller, value, we can sign extend all of the 1953 // operands (often constants). This allows analysis of something like 1954 // this: for (signed char X = 0; X < 100; ++X) { int Y = X; } 1955 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) 1956 if (AR->isAffine()) { 1957 const SCEV *Start = AR->getStart(); 1958 const SCEV *Step = AR->getStepRecurrence(*this); 1959 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 1960 const Loop *L = AR->getLoop(); 1961 1962 if (!AR->hasNoSignedWrap()) { 1963 auto NewFlags = proveNoWrapViaConstantRanges(AR); 1964 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1965 } 1966 1967 // If we have special knowledge that this addrec won't overflow, 1968 // we don't need to do any further analysis. 1969 if (AR->hasNoSignedWrap()) 1970 return getAddRecExpr( 1971 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 1972 getSignExtendExpr(Step, Ty, Depth + 1), L, SCEV::FlagNSW); 1973 1974 // Check whether the backedge-taken count is SCEVCouldNotCompute. 1975 // Note that this serves two purposes: It filters out loops that are 1976 // simply not analyzable, and it covers the case where this code is 1977 // being called from within backedge-taken count analysis, such that 1978 // attempting to ask for the backedge-taken count would likely result 1979 // in infinite recursion. In the later case, the analysis code will 1980 // cope with a conservative value, and it will take care to purge 1981 // that value once it has finished. 1982 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 1983 if (!isa<SCEVCouldNotCompute>(MaxBECount)) { 1984 // Manually compute the final value for AR, checking for 1985 // overflow. 1986 1987 // Check whether the backedge-taken count can be losslessly casted to 1988 // the addrec's type. The count is always unsigned. 1989 const SCEV *CastedMaxBECount = 1990 getTruncateOrZeroExtend(MaxBECount, Start->getType(), Depth); 1991 const SCEV *RecastedMaxBECount = getTruncateOrZeroExtend( 1992 CastedMaxBECount, MaxBECount->getType(), Depth); 1993 if (MaxBECount == RecastedMaxBECount) { 1994 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2); 1995 // Check whether Start+Step*MaxBECount has no signed overflow. 1996 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step, 1997 SCEV::FlagAnyWrap, Depth + 1); 1998 const SCEV *SAdd = getSignExtendExpr(getAddExpr(Start, SMul, 1999 SCEV::FlagAnyWrap, 2000 Depth + 1), 2001 WideTy, Depth + 1); 2002 const SCEV *WideStart = getSignExtendExpr(Start, WideTy, Depth + 1); 2003 const SCEV *WideMaxBECount = 2004 getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1); 2005 const SCEV *OperandExtendedAdd = 2006 getAddExpr(WideStart, 2007 getMulExpr(WideMaxBECount, 2008 getSignExtendExpr(Step, WideTy, Depth + 1), 2009 SCEV::FlagAnyWrap, Depth + 1), 2010 SCEV::FlagAnyWrap, Depth + 1); 2011 if (SAdd == OperandExtendedAdd) { 2012 // Cache knowledge of AR NSW, which is propagated to this AddRec. 2013 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNSW); 2014 // Return the expression with the addrec on the outside. 2015 return getAddRecExpr( 2016 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, 2017 Depth + 1), 2018 getSignExtendExpr(Step, Ty, Depth + 1), L, 2019 AR->getNoWrapFlags()); 2020 } 2021 // Similar to above, only this time treat the step value as unsigned. 2022 // This covers loops that count up with an unsigned step. 2023 OperandExtendedAdd = 2024 getAddExpr(WideStart, 2025 getMulExpr(WideMaxBECount, 2026 getZeroExtendExpr(Step, WideTy, Depth + 1), 2027 SCEV::FlagAnyWrap, Depth + 1), 2028 SCEV::FlagAnyWrap, Depth + 1); 2029 if (SAdd == OperandExtendedAdd) { 2030 // If AR wraps around then 2031 // 2032 // abs(Step) * MaxBECount > unsigned-max(AR->getType()) 2033 // => SAdd != OperandExtendedAdd 2034 // 2035 // Thus (AR is not NW => SAdd != OperandExtendedAdd) <=> 2036 // (SAdd == OperandExtendedAdd => AR is NW) 2037 2038 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 2039 2040 // Return the expression with the addrec on the outside. 2041 return getAddRecExpr( 2042 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, 2043 Depth + 1), 2044 getZeroExtendExpr(Step, Ty, Depth + 1), L, 2045 AR->getNoWrapFlags()); 2046 } 2047 } 2048 } 2049 2050 auto NewFlags = proveNoSignedWrapViaInduction(AR); 2051 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 2052 if (AR->hasNoSignedWrap()) { 2053 // Same as nsw case above - duplicated here to avoid a compile time 2054 // issue. It's not clear that the order of checks does matter, but 2055 // it's one of two issue possible causes for a change which was 2056 // reverted. Be conservative for the moment. 2057 return getAddRecExpr( 2058 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 2059 getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 2060 } 2061 2062 // sext({C,+,Step}) --> (sext(D) + sext({C-D,+,Step}))<nuw><nsw> 2063 // if D + (C - D + Step * n) could be proven to not signed wrap 2064 // where D maximizes the number of trailing zeros of (C - D + Step * n) 2065 if (const auto *SC = dyn_cast<SCEVConstant>(Start)) { 2066 const APInt &C = SC->getAPInt(); 2067 const APInt &D = extractConstantWithoutWrapping(*this, C, Step); 2068 if (D != 0) { 2069 const SCEV *SSExtD = getSignExtendExpr(getConstant(D), Ty, Depth); 2070 const SCEV *SResidual = 2071 getAddRecExpr(getConstant(C - D), Step, L, AR->getNoWrapFlags()); 2072 const SCEV *SSExtR = getSignExtendExpr(SResidual, Ty, Depth + 1); 2073 return getAddExpr(SSExtD, SSExtR, 2074 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 2075 Depth + 1); 2076 } 2077 } 2078 2079 if (proveNoWrapByVaryingStart<SCEVSignExtendExpr>(Start, Step, L)) { 2080 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNSW); 2081 return getAddRecExpr( 2082 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 2083 getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 2084 } 2085 } 2086 2087 // If the input value is provably positive and we could not simplify 2088 // away the sext build a zext instead. 2089 if (isKnownNonNegative(Op)) 2090 return getZeroExtendExpr(Op, Ty, Depth + 1); 2091 2092 // The cast wasn't folded; create an explicit cast node. 2093 // Recompute the insert position, as it may have been invalidated. 2094 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 2095 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator), 2096 Op, Ty); 2097 UniqueSCEVs.InsertNode(S, IP); 2098 addToLoopUseLists(S); 2099 return S; 2100 } 2101 2102 /// getAnyExtendExpr - Return a SCEV for the given operand extended with 2103 /// unspecified bits out to the given type. 2104 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op, 2105 Type *Ty) { 2106 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 2107 "This is not an extending conversion!"); 2108 assert(isSCEVable(Ty) && 2109 "This is not a conversion to a SCEVable type!"); 2110 Ty = getEffectiveSCEVType(Ty); 2111 2112 // Sign-extend negative constants. 2113 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 2114 if (SC->getAPInt().isNegative()) 2115 return getSignExtendExpr(Op, Ty); 2116 2117 // Peel off a truncate cast. 2118 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) { 2119 const SCEV *NewOp = T->getOperand(); 2120 if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty)) 2121 return getAnyExtendExpr(NewOp, Ty); 2122 return getTruncateOrNoop(NewOp, Ty); 2123 } 2124 2125 // Next try a zext cast. If the cast is folded, use it. 2126 const SCEV *ZExt = getZeroExtendExpr(Op, Ty); 2127 if (!isa<SCEVZeroExtendExpr>(ZExt)) 2128 return ZExt; 2129 2130 // Next try a sext cast. If the cast is folded, use it. 2131 const SCEV *SExt = getSignExtendExpr(Op, Ty); 2132 if (!isa<SCEVSignExtendExpr>(SExt)) 2133 return SExt; 2134 2135 // Force the cast to be folded into the operands of an addrec. 2136 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) { 2137 SmallVector<const SCEV *, 4> Ops; 2138 for (const SCEV *Op : AR->operands()) 2139 Ops.push_back(getAnyExtendExpr(Op, Ty)); 2140 return getAddRecExpr(Ops, AR->getLoop(), SCEV::FlagNW); 2141 } 2142 2143 // If the expression is obviously signed, use the sext cast value. 2144 if (isa<SCEVSMaxExpr>(Op)) 2145 return SExt; 2146 2147 // Absent any other information, use the zext cast value. 2148 return ZExt; 2149 } 2150 2151 /// Process the given Ops list, which is a list of operands to be added under 2152 /// the given scale, update the given map. This is a helper function for 2153 /// getAddRecExpr. As an example of what it does, given a sequence of operands 2154 /// that would form an add expression like this: 2155 /// 2156 /// m + n + 13 + (A * (o + p + (B * (q + m + 29)))) + r + (-1 * r) 2157 /// 2158 /// where A and B are constants, update the map with these values: 2159 /// 2160 /// (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0) 2161 /// 2162 /// and add 13 + A*B*29 to AccumulatedConstant. 2163 /// This will allow getAddRecExpr to produce this: 2164 /// 2165 /// 13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B) 2166 /// 2167 /// This form often exposes folding opportunities that are hidden in 2168 /// the original operand list. 2169 /// 2170 /// Return true iff it appears that any interesting folding opportunities 2171 /// may be exposed. This helps getAddRecExpr short-circuit extra work in 2172 /// the common case where no interesting opportunities are present, and 2173 /// is also used as a check to avoid infinite recursion. 2174 static bool 2175 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M, 2176 SmallVectorImpl<const SCEV *> &NewOps, 2177 APInt &AccumulatedConstant, 2178 const SCEV *const *Ops, size_t NumOperands, 2179 const APInt &Scale, 2180 ScalarEvolution &SE) { 2181 bool Interesting = false; 2182 2183 // Iterate over the add operands. They are sorted, with constants first. 2184 unsigned i = 0; 2185 while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) { 2186 ++i; 2187 // Pull a buried constant out to the outside. 2188 if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero()) 2189 Interesting = true; 2190 AccumulatedConstant += Scale * C->getAPInt(); 2191 } 2192 2193 // Next comes everything else. We're especially interested in multiplies 2194 // here, but they're in the middle, so just visit the rest with one loop. 2195 for (; i != NumOperands; ++i) { 2196 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]); 2197 if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) { 2198 APInt NewScale = 2199 Scale * cast<SCEVConstant>(Mul->getOperand(0))->getAPInt(); 2200 if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) { 2201 // A multiplication of a constant with another add; recurse. 2202 const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1)); 2203 Interesting |= 2204 CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant, 2205 Add->op_begin(), Add->getNumOperands(), 2206 NewScale, SE); 2207 } else { 2208 // A multiplication of a constant with some other value. Update 2209 // the map. 2210 SmallVector<const SCEV *, 4> MulOps(drop_begin(Mul->operands())); 2211 const SCEV *Key = SE.getMulExpr(MulOps); 2212 auto Pair = M.insert({Key, NewScale}); 2213 if (Pair.second) { 2214 NewOps.push_back(Pair.first->first); 2215 } else { 2216 Pair.first->second += NewScale; 2217 // The map already had an entry for this value, which may indicate 2218 // a folding opportunity. 2219 Interesting = true; 2220 } 2221 } 2222 } else { 2223 // An ordinary operand. Update the map. 2224 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair = 2225 M.insert({Ops[i], Scale}); 2226 if (Pair.second) { 2227 NewOps.push_back(Pair.first->first); 2228 } else { 2229 Pair.first->second += Scale; 2230 // The map already had an entry for this value, which may indicate 2231 // a folding opportunity. 2232 Interesting = true; 2233 } 2234 } 2235 } 2236 2237 return Interesting; 2238 } 2239 2240 // We're trying to construct a SCEV of type `Type' with `Ops' as operands and 2241 // `OldFlags' as can't-wrap behavior. Infer a more aggressive set of 2242 // can't-overflow flags for the operation if possible. 2243 static SCEV::NoWrapFlags 2244 StrengthenNoWrapFlags(ScalarEvolution *SE, SCEVTypes Type, 2245 const ArrayRef<const SCEV *> Ops, 2246 SCEV::NoWrapFlags Flags) { 2247 using namespace std::placeholders; 2248 2249 using OBO = OverflowingBinaryOperator; 2250 2251 bool CanAnalyze = 2252 Type == scAddExpr || Type == scAddRecExpr || Type == scMulExpr; 2253 (void)CanAnalyze; 2254 assert(CanAnalyze && "don't call from other places!"); 2255 2256 int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW; 2257 SCEV::NoWrapFlags SignOrUnsignWrap = 2258 ScalarEvolution::maskFlags(Flags, SignOrUnsignMask); 2259 2260 // If FlagNSW is true and all the operands are non-negative, infer FlagNUW. 2261 auto IsKnownNonNegative = [&](const SCEV *S) { 2262 return SE->isKnownNonNegative(S); 2263 }; 2264 2265 if (SignOrUnsignWrap == SCEV::FlagNSW && all_of(Ops, IsKnownNonNegative)) 2266 Flags = 2267 ScalarEvolution::setFlags(Flags, (SCEV::NoWrapFlags)SignOrUnsignMask); 2268 2269 SignOrUnsignWrap = ScalarEvolution::maskFlags(Flags, SignOrUnsignMask); 2270 2271 if (SignOrUnsignWrap != SignOrUnsignMask && 2272 (Type == scAddExpr || Type == scMulExpr) && Ops.size() == 2 && 2273 isa<SCEVConstant>(Ops[0])) { 2274 2275 auto Opcode = [&] { 2276 switch (Type) { 2277 case scAddExpr: 2278 return Instruction::Add; 2279 case scMulExpr: 2280 return Instruction::Mul; 2281 default: 2282 llvm_unreachable("Unexpected SCEV op."); 2283 } 2284 }(); 2285 2286 const APInt &C = cast<SCEVConstant>(Ops[0])->getAPInt(); 2287 2288 // (A <opcode> C) --> (A <opcode> C)<nsw> if the op doesn't sign overflow. 2289 if (!(SignOrUnsignWrap & SCEV::FlagNSW)) { 2290 auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 2291 Opcode, C, OBO::NoSignedWrap); 2292 if (NSWRegion.contains(SE->getSignedRange(Ops[1]))) 2293 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 2294 } 2295 2296 // (A <opcode> C) --> (A <opcode> C)<nuw> if the op doesn't unsign overflow. 2297 if (!(SignOrUnsignWrap & SCEV::FlagNUW)) { 2298 auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 2299 Opcode, C, OBO::NoUnsignedWrap); 2300 if (NUWRegion.contains(SE->getUnsignedRange(Ops[1]))) 2301 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2302 } 2303 } 2304 2305 return Flags; 2306 } 2307 2308 bool ScalarEvolution::isAvailableAtLoopEntry(const SCEV *S, const Loop *L) { 2309 return isLoopInvariant(S, L) && properlyDominates(S, L->getHeader()); 2310 } 2311 2312 /// Get a canonical add expression, or something simpler if possible. 2313 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops, 2314 SCEV::NoWrapFlags OrigFlags, 2315 unsigned Depth) { 2316 assert(!(OrigFlags & ~(SCEV::FlagNUW | SCEV::FlagNSW)) && 2317 "only nuw or nsw allowed"); 2318 assert(!Ops.empty() && "Cannot get empty add!"); 2319 if (Ops.size() == 1) return Ops[0]; 2320 #ifndef NDEBUG 2321 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 2322 for (unsigned i = 1, e = Ops.size(); i != e; ++i) 2323 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 2324 "SCEVAddExpr operand types don't match!"); 2325 #endif 2326 2327 // Sort by complexity, this groups all similar expression types together. 2328 GroupByComplexity(Ops, &LI, DT); 2329 2330 // If there are any constants, fold them together. 2331 unsigned Idx = 0; 2332 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 2333 ++Idx; 2334 assert(Idx < Ops.size()); 2335 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 2336 // We found two constants, fold them together! 2337 Ops[0] = getConstant(LHSC->getAPInt() + RHSC->getAPInt()); 2338 if (Ops.size() == 2) return Ops[0]; 2339 Ops.erase(Ops.begin()+1); // Erase the folded element 2340 LHSC = cast<SCEVConstant>(Ops[0]); 2341 } 2342 2343 // If we are left with a constant zero being added, strip it off. 2344 if (LHSC->getValue()->isZero()) { 2345 Ops.erase(Ops.begin()); 2346 --Idx; 2347 } 2348 2349 if (Ops.size() == 1) return Ops[0]; 2350 } 2351 2352 // Delay expensive flag strengthening until necessary. 2353 auto ComputeFlags = [this, OrigFlags](const ArrayRef<const SCEV *> Ops) { 2354 return StrengthenNoWrapFlags(this, scAddExpr, Ops, OrigFlags); 2355 }; 2356 2357 // Limit recursion calls depth. 2358 if (Depth > MaxArithDepth || hasHugeExpression(Ops)) 2359 return getOrCreateAddExpr(Ops, ComputeFlags(Ops)); 2360 2361 if (SCEV *S = std::get<0>(findExistingSCEVInCache(scAddExpr, Ops))) { 2362 // Don't strengthen flags if we have no new information. 2363 SCEVAddExpr *Add = static_cast<SCEVAddExpr *>(S); 2364 if (Add->getNoWrapFlags(OrigFlags) != OrigFlags) 2365 Add->setNoWrapFlags(ComputeFlags(Ops)); 2366 return S; 2367 } 2368 2369 // Okay, check to see if the same value occurs in the operand list more than 2370 // once. If so, merge them together into an multiply expression. Since we 2371 // sorted the list, these values are required to be adjacent. 2372 Type *Ty = Ops[0]->getType(); 2373 bool FoundMatch = false; 2374 for (unsigned i = 0, e = Ops.size(); i != e-1; ++i) 2375 if (Ops[i] == Ops[i+1]) { // X + Y + Y --> X + Y*2 2376 // Scan ahead to count how many equal operands there are. 2377 unsigned Count = 2; 2378 while (i+Count != e && Ops[i+Count] == Ops[i]) 2379 ++Count; 2380 // Merge the values into a multiply. 2381 const SCEV *Scale = getConstant(Ty, Count); 2382 const SCEV *Mul = getMulExpr(Scale, Ops[i], SCEV::FlagAnyWrap, Depth + 1); 2383 if (Ops.size() == Count) 2384 return Mul; 2385 Ops[i] = Mul; 2386 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count); 2387 --i; e -= Count - 1; 2388 FoundMatch = true; 2389 } 2390 if (FoundMatch) 2391 return getAddExpr(Ops, OrigFlags, Depth + 1); 2392 2393 // Check for truncates. If all the operands are truncated from the same 2394 // type, see if factoring out the truncate would permit the result to be 2395 // folded. eg., n*trunc(x) + m*trunc(y) --> trunc(trunc(m)*x + trunc(n)*y) 2396 // if the contents of the resulting outer trunc fold to something simple. 2397 auto FindTruncSrcType = [&]() -> Type * { 2398 // We're ultimately looking to fold an addrec of truncs and muls of only 2399 // constants and truncs, so if we find any other types of SCEV 2400 // as operands of the addrec then we bail and return nullptr here. 2401 // Otherwise, we return the type of the operand of a trunc that we find. 2402 if (auto *T = dyn_cast<SCEVTruncateExpr>(Ops[Idx])) 2403 return T->getOperand()->getType(); 2404 if (const auto *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) { 2405 const auto *LastOp = Mul->getOperand(Mul->getNumOperands() - 1); 2406 if (const auto *T = dyn_cast<SCEVTruncateExpr>(LastOp)) 2407 return T->getOperand()->getType(); 2408 } 2409 return nullptr; 2410 }; 2411 if (auto *SrcType = FindTruncSrcType()) { 2412 SmallVector<const SCEV *, 8> LargeOps; 2413 bool Ok = true; 2414 // Check all the operands to see if they can be represented in the 2415 // source type of the truncate. 2416 for (unsigned i = 0, e = Ops.size(); i != e; ++i) { 2417 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) { 2418 if (T->getOperand()->getType() != SrcType) { 2419 Ok = false; 2420 break; 2421 } 2422 LargeOps.push_back(T->getOperand()); 2423 } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) { 2424 LargeOps.push_back(getAnyExtendExpr(C, SrcType)); 2425 } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) { 2426 SmallVector<const SCEV *, 8> LargeMulOps; 2427 for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) { 2428 if (const SCEVTruncateExpr *T = 2429 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) { 2430 if (T->getOperand()->getType() != SrcType) { 2431 Ok = false; 2432 break; 2433 } 2434 LargeMulOps.push_back(T->getOperand()); 2435 } else if (const auto *C = dyn_cast<SCEVConstant>(M->getOperand(j))) { 2436 LargeMulOps.push_back(getAnyExtendExpr(C, SrcType)); 2437 } else { 2438 Ok = false; 2439 break; 2440 } 2441 } 2442 if (Ok) 2443 LargeOps.push_back(getMulExpr(LargeMulOps, SCEV::FlagAnyWrap, Depth + 1)); 2444 } else { 2445 Ok = false; 2446 break; 2447 } 2448 } 2449 if (Ok) { 2450 // Evaluate the expression in the larger type. 2451 const SCEV *Fold = getAddExpr(LargeOps, SCEV::FlagAnyWrap, Depth + 1); 2452 // If it folds to something simple, use it. Otherwise, don't. 2453 if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold)) 2454 return getTruncateExpr(Fold, Ty); 2455 } 2456 } 2457 2458 // Skip past any other cast SCEVs. 2459 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr) 2460 ++Idx; 2461 2462 // If there are add operands they would be next. 2463 if (Idx < Ops.size()) { 2464 bool DeletedAdd = false; 2465 while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) { 2466 if (Ops.size() > AddOpsInlineThreshold || 2467 Add->getNumOperands() > AddOpsInlineThreshold) 2468 break; 2469 // If we have an add, expand the add operands onto the end of the operands 2470 // list. 2471 Ops.erase(Ops.begin()+Idx); 2472 Ops.append(Add->op_begin(), Add->op_end()); 2473 DeletedAdd = true; 2474 } 2475 2476 // If we deleted at least one add, we added operands to the end of the list, 2477 // and they are not necessarily sorted. Recurse to resort and resimplify 2478 // any operands we just acquired. 2479 if (DeletedAdd) 2480 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2481 } 2482 2483 // Skip over the add expression until we get to a multiply. 2484 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr) 2485 ++Idx; 2486 2487 // Check to see if there are any folding opportunities present with 2488 // operands multiplied by constant values. 2489 if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) { 2490 uint64_t BitWidth = getTypeSizeInBits(Ty); 2491 DenseMap<const SCEV *, APInt> M; 2492 SmallVector<const SCEV *, 8> NewOps; 2493 APInt AccumulatedConstant(BitWidth, 0); 2494 if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant, 2495 Ops.data(), Ops.size(), 2496 APInt(BitWidth, 1), *this)) { 2497 struct APIntCompare { 2498 bool operator()(const APInt &LHS, const APInt &RHS) const { 2499 return LHS.ult(RHS); 2500 } 2501 }; 2502 2503 // Some interesting folding opportunity is present, so its worthwhile to 2504 // re-generate the operands list. Group the operands by constant scale, 2505 // to avoid multiplying by the same constant scale multiple times. 2506 std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists; 2507 for (const SCEV *NewOp : NewOps) 2508 MulOpLists[M.find(NewOp)->second].push_back(NewOp); 2509 // Re-generate the operands list. 2510 Ops.clear(); 2511 if (AccumulatedConstant != 0) 2512 Ops.push_back(getConstant(AccumulatedConstant)); 2513 for (auto &MulOp : MulOpLists) 2514 if (MulOp.first != 0) 2515 Ops.push_back(getMulExpr( 2516 getConstant(MulOp.first), 2517 getAddExpr(MulOp.second, SCEV::FlagAnyWrap, Depth + 1), 2518 SCEV::FlagAnyWrap, Depth + 1)); 2519 if (Ops.empty()) 2520 return getZero(Ty); 2521 if (Ops.size() == 1) 2522 return Ops[0]; 2523 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2524 } 2525 } 2526 2527 // If we are adding something to a multiply expression, make sure the 2528 // something is not already an operand of the multiply. If so, merge it into 2529 // the multiply. 2530 for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) { 2531 const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]); 2532 for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) { 2533 const SCEV *MulOpSCEV = Mul->getOperand(MulOp); 2534 if (isa<SCEVConstant>(MulOpSCEV)) 2535 continue; 2536 for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp) 2537 if (MulOpSCEV == Ops[AddOp]) { 2538 // Fold W + X + (X * Y * Z) --> W + (X * ((Y*Z)+1)) 2539 const SCEV *InnerMul = Mul->getOperand(MulOp == 0); 2540 if (Mul->getNumOperands() != 2) { 2541 // If the multiply has more than two operands, we must get the 2542 // Y*Z term. 2543 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(), 2544 Mul->op_begin()+MulOp); 2545 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end()); 2546 InnerMul = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2547 } 2548 SmallVector<const SCEV *, 2> TwoOps = {getOne(Ty), InnerMul}; 2549 const SCEV *AddOne = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2550 const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV, 2551 SCEV::FlagAnyWrap, Depth + 1); 2552 if (Ops.size() == 2) return OuterMul; 2553 if (AddOp < Idx) { 2554 Ops.erase(Ops.begin()+AddOp); 2555 Ops.erase(Ops.begin()+Idx-1); 2556 } else { 2557 Ops.erase(Ops.begin()+Idx); 2558 Ops.erase(Ops.begin()+AddOp-1); 2559 } 2560 Ops.push_back(OuterMul); 2561 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2562 } 2563 2564 // Check this multiply against other multiplies being added together. 2565 for (unsigned OtherMulIdx = Idx+1; 2566 OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]); 2567 ++OtherMulIdx) { 2568 const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]); 2569 // If MulOp occurs in OtherMul, we can fold the two multiplies 2570 // together. 2571 for (unsigned OMulOp = 0, e = OtherMul->getNumOperands(); 2572 OMulOp != e; ++OMulOp) 2573 if (OtherMul->getOperand(OMulOp) == MulOpSCEV) { 2574 // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E)) 2575 const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0); 2576 if (Mul->getNumOperands() != 2) { 2577 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(), 2578 Mul->op_begin()+MulOp); 2579 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end()); 2580 InnerMul1 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2581 } 2582 const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0); 2583 if (OtherMul->getNumOperands() != 2) { 2584 SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(), 2585 OtherMul->op_begin()+OMulOp); 2586 MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end()); 2587 InnerMul2 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2588 } 2589 SmallVector<const SCEV *, 2> TwoOps = {InnerMul1, InnerMul2}; 2590 const SCEV *InnerMulSum = 2591 getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2592 const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum, 2593 SCEV::FlagAnyWrap, Depth + 1); 2594 if (Ops.size() == 2) return OuterMul; 2595 Ops.erase(Ops.begin()+Idx); 2596 Ops.erase(Ops.begin()+OtherMulIdx-1); 2597 Ops.push_back(OuterMul); 2598 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2599 } 2600 } 2601 } 2602 } 2603 2604 // If there are any add recurrences in the operands list, see if any other 2605 // added values are loop invariant. If so, we can fold them into the 2606 // recurrence. 2607 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr) 2608 ++Idx; 2609 2610 // Scan over all recurrences, trying to fold loop invariants into them. 2611 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) { 2612 // Scan all of the other operands to this add and add them to the vector if 2613 // they are loop invariant w.r.t. the recurrence. 2614 SmallVector<const SCEV *, 8> LIOps; 2615 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]); 2616 const Loop *AddRecLoop = AddRec->getLoop(); 2617 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 2618 if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) { 2619 LIOps.push_back(Ops[i]); 2620 Ops.erase(Ops.begin()+i); 2621 --i; --e; 2622 } 2623 2624 // If we found some loop invariants, fold them into the recurrence. 2625 if (!LIOps.empty()) { 2626 // Compute nowrap flags for the addition of the loop-invariant ops and 2627 // the addrec. Temporarily push it as an operand for that purpose. 2628 LIOps.push_back(AddRec); 2629 SCEV::NoWrapFlags Flags = ComputeFlags(LIOps); 2630 LIOps.pop_back(); 2631 2632 // NLI + LI + {Start,+,Step} --> NLI + {LI+Start,+,Step} 2633 LIOps.push_back(AddRec->getStart()); 2634 2635 SmallVector<const SCEV *, 4> AddRecOps(AddRec->operands()); 2636 // This follows from the fact that the no-wrap flags on the outer add 2637 // expression are applicable on the 0th iteration, when the add recurrence 2638 // will be equal to its start value. 2639 AddRecOps[0] = getAddExpr(LIOps, Flags, Depth + 1); 2640 2641 // Build the new addrec. Propagate the NUW and NSW flags if both the 2642 // outer add and the inner addrec are guaranteed to have no overflow. 2643 // Always propagate NW. 2644 Flags = AddRec->getNoWrapFlags(setFlags(Flags, SCEV::FlagNW)); 2645 const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop, Flags); 2646 2647 // If all of the other operands were loop invariant, we are done. 2648 if (Ops.size() == 1) return NewRec; 2649 2650 // Otherwise, add the folded AddRec by the non-invariant parts. 2651 for (unsigned i = 0;; ++i) 2652 if (Ops[i] == AddRec) { 2653 Ops[i] = NewRec; 2654 break; 2655 } 2656 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2657 } 2658 2659 // Okay, if there weren't any loop invariants to be folded, check to see if 2660 // there are multiple AddRec's with the same loop induction variable being 2661 // added together. If so, we can fold them. 2662 for (unsigned OtherIdx = Idx+1; 2663 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 2664 ++OtherIdx) { 2665 // We expect the AddRecExpr's to be sorted in reverse dominance order, 2666 // so that the 1st found AddRecExpr is dominated by all others. 2667 assert(DT.dominates( 2668 cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()->getHeader(), 2669 AddRec->getLoop()->getHeader()) && 2670 "AddRecExprs are not sorted in reverse dominance order?"); 2671 if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) { 2672 // Other + {A,+,B}<L> + {C,+,D}<L> --> Other + {A+C,+,B+D}<L> 2673 SmallVector<const SCEV *, 4> AddRecOps(AddRec->operands()); 2674 for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 2675 ++OtherIdx) { 2676 const auto *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]); 2677 if (OtherAddRec->getLoop() == AddRecLoop) { 2678 for (unsigned i = 0, e = OtherAddRec->getNumOperands(); 2679 i != e; ++i) { 2680 if (i >= AddRecOps.size()) { 2681 AddRecOps.append(OtherAddRec->op_begin()+i, 2682 OtherAddRec->op_end()); 2683 break; 2684 } 2685 SmallVector<const SCEV *, 2> TwoOps = { 2686 AddRecOps[i], OtherAddRec->getOperand(i)}; 2687 AddRecOps[i] = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2688 } 2689 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx; 2690 } 2691 } 2692 // Step size has changed, so we cannot guarantee no self-wraparound. 2693 Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop, SCEV::FlagAnyWrap); 2694 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2695 } 2696 } 2697 2698 // Otherwise couldn't fold anything into this recurrence. Move onto the 2699 // next one. 2700 } 2701 2702 // Okay, it looks like we really DO need an add expr. Check to see if we 2703 // already have one, otherwise create a new one. 2704 return getOrCreateAddExpr(Ops, ComputeFlags(Ops)); 2705 } 2706 2707 const SCEV * 2708 ScalarEvolution::getOrCreateAddExpr(ArrayRef<const SCEV *> Ops, 2709 SCEV::NoWrapFlags Flags) { 2710 FoldingSetNodeID ID; 2711 ID.AddInteger(scAddExpr); 2712 for (const SCEV *Op : Ops) 2713 ID.AddPointer(Op); 2714 void *IP = nullptr; 2715 SCEVAddExpr *S = 2716 static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2717 if (!S) { 2718 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2719 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2720 S = new (SCEVAllocator) 2721 SCEVAddExpr(ID.Intern(SCEVAllocator), O, Ops.size()); 2722 UniqueSCEVs.InsertNode(S, IP); 2723 addToLoopUseLists(S); 2724 } 2725 S->setNoWrapFlags(Flags); 2726 return S; 2727 } 2728 2729 const SCEV * 2730 ScalarEvolution::getOrCreateAddRecExpr(ArrayRef<const SCEV *> Ops, 2731 const Loop *L, SCEV::NoWrapFlags Flags) { 2732 FoldingSetNodeID ID; 2733 ID.AddInteger(scAddRecExpr); 2734 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 2735 ID.AddPointer(Ops[i]); 2736 ID.AddPointer(L); 2737 void *IP = nullptr; 2738 SCEVAddRecExpr *S = 2739 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2740 if (!S) { 2741 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2742 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2743 S = new (SCEVAllocator) 2744 SCEVAddRecExpr(ID.Intern(SCEVAllocator), O, Ops.size(), L); 2745 UniqueSCEVs.InsertNode(S, IP); 2746 addToLoopUseLists(S); 2747 } 2748 setNoWrapFlags(S, Flags); 2749 return S; 2750 } 2751 2752 const SCEV * 2753 ScalarEvolution::getOrCreateMulExpr(ArrayRef<const SCEV *> Ops, 2754 SCEV::NoWrapFlags Flags) { 2755 FoldingSetNodeID ID; 2756 ID.AddInteger(scMulExpr); 2757 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 2758 ID.AddPointer(Ops[i]); 2759 void *IP = nullptr; 2760 SCEVMulExpr *S = 2761 static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2762 if (!S) { 2763 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2764 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2765 S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator), 2766 O, Ops.size()); 2767 UniqueSCEVs.InsertNode(S, IP); 2768 addToLoopUseLists(S); 2769 } 2770 S->setNoWrapFlags(Flags); 2771 return S; 2772 } 2773 2774 static uint64_t umul_ov(uint64_t i, uint64_t j, bool &Overflow) { 2775 uint64_t k = i*j; 2776 if (j > 1 && k / j != i) Overflow = true; 2777 return k; 2778 } 2779 2780 /// Compute the result of "n choose k", the binomial coefficient. If an 2781 /// intermediate computation overflows, Overflow will be set and the return will 2782 /// be garbage. Overflow is not cleared on absence of overflow. 2783 static uint64_t Choose(uint64_t n, uint64_t k, bool &Overflow) { 2784 // We use the multiplicative formula: 2785 // n(n-1)(n-2)...(n-(k-1)) / k(k-1)(k-2)...1 . 2786 // At each iteration, we take the n-th term of the numeral and divide by the 2787 // (k-n)th term of the denominator. This division will always produce an 2788 // integral result, and helps reduce the chance of overflow in the 2789 // intermediate computations. However, we can still overflow even when the 2790 // final result would fit. 2791 2792 if (n == 0 || n == k) return 1; 2793 if (k > n) return 0; 2794 2795 if (k > n/2) 2796 k = n-k; 2797 2798 uint64_t r = 1; 2799 for (uint64_t i = 1; i <= k; ++i) { 2800 r = umul_ov(r, n-(i-1), Overflow); 2801 r /= i; 2802 } 2803 return r; 2804 } 2805 2806 /// Determine if any of the operands in this SCEV are a constant or if 2807 /// any of the add or multiply expressions in this SCEV contain a constant. 2808 static bool containsConstantInAddMulChain(const SCEV *StartExpr) { 2809 struct FindConstantInAddMulChain { 2810 bool FoundConstant = false; 2811 2812 bool follow(const SCEV *S) { 2813 FoundConstant |= isa<SCEVConstant>(S); 2814 return isa<SCEVAddExpr>(S) || isa<SCEVMulExpr>(S); 2815 } 2816 2817 bool isDone() const { 2818 return FoundConstant; 2819 } 2820 }; 2821 2822 FindConstantInAddMulChain F; 2823 SCEVTraversal<FindConstantInAddMulChain> ST(F); 2824 ST.visitAll(StartExpr); 2825 return F.FoundConstant; 2826 } 2827 2828 /// Get a canonical multiply expression, or something simpler if possible. 2829 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops, 2830 SCEV::NoWrapFlags OrigFlags, 2831 unsigned Depth) { 2832 assert(OrigFlags == maskFlags(OrigFlags, SCEV::FlagNUW | SCEV::FlagNSW) && 2833 "only nuw or nsw allowed"); 2834 assert(!Ops.empty() && "Cannot get empty mul!"); 2835 if (Ops.size() == 1) return Ops[0]; 2836 #ifndef NDEBUG 2837 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 2838 for (unsigned i = 1, e = Ops.size(); i != e; ++i) 2839 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 2840 "SCEVMulExpr operand types don't match!"); 2841 #endif 2842 2843 // Sort by complexity, this groups all similar expression types together. 2844 GroupByComplexity(Ops, &LI, DT); 2845 2846 // If there are any constants, fold them together. 2847 unsigned Idx = 0; 2848 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 2849 ++Idx; 2850 assert(Idx < Ops.size()); 2851 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 2852 // We found two constants, fold them together! 2853 Ops[0] = getConstant(LHSC->getAPInt() * RHSC->getAPInt()); 2854 if (Ops.size() == 2) return Ops[0]; 2855 Ops.erase(Ops.begin()+1); // Erase the folded element 2856 LHSC = cast<SCEVConstant>(Ops[0]); 2857 } 2858 2859 // If we have a multiply of zero, it will always be zero. 2860 if (LHSC->getValue()->isZero()) 2861 return LHSC; 2862 2863 // If we are left with a constant one being multiplied, strip it off. 2864 if (LHSC->getValue()->isOne()) { 2865 Ops.erase(Ops.begin()); 2866 --Idx; 2867 } 2868 2869 if (Ops.size() == 1) 2870 return Ops[0]; 2871 } 2872 2873 // Delay expensive flag strengthening until necessary. 2874 auto ComputeFlags = [this, OrigFlags](const ArrayRef<const SCEV *> Ops) { 2875 return StrengthenNoWrapFlags(this, scMulExpr, Ops, OrigFlags); 2876 }; 2877 2878 // Limit recursion calls depth. 2879 if (Depth > MaxArithDepth || hasHugeExpression(Ops)) 2880 return getOrCreateMulExpr(Ops, ComputeFlags(Ops)); 2881 2882 if (SCEV *S = std::get<0>(findExistingSCEVInCache(scMulExpr, Ops))) { 2883 // Don't strengthen flags if we have no new information. 2884 SCEVMulExpr *Mul = static_cast<SCEVMulExpr *>(S); 2885 if (Mul->getNoWrapFlags(OrigFlags) != OrigFlags) 2886 Mul->setNoWrapFlags(ComputeFlags(Ops)); 2887 return S; 2888 } 2889 2890 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 2891 if (Ops.size() == 2) { 2892 // C1*(C2+V) -> C1*C2 + C1*V 2893 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) 2894 // If any of Add's ops are Adds or Muls with a constant, apply this 2895 // transformation as well. 2896 // 2897 // TODO: There are some cases where this transformation is not 2898 // profitable; for example, Add = (C0 + X) * Y + Z. Maybe the scope of 2899 // this transformation should be narrowed down. 2900 if (Add->getNumOperands() == 2 && containsConstantInAddMulChain(Add)) 2901 return getAddExpr(getMulExpr(LHSC, Add->getOperand(0), 2902 SCEV::FlagAnyWrap, Depth + 1), 2903 getMulExpr(LHSC, Add->getOperand(1), 2904 SCEV::FlagAnyWrap, Depth + 1), 2905 SCEV::FlagAnyWrap, Depth + 1); 2906 2907 if (Ops[0]->isAllOnesValue()) { 2908 // If we have a mul by -1 of an add, try distributing the -1 among the 2909 // add operands. 2910 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) { 2911 SmallVector<const SCEV *, 4> NewOps; 2912 bool AnyFolded = false; 2913 for (const SCEV *AddOp : Add->operands()) { 2914 const SCEV *Mul = getMulExpr(Ops[0], AddOp, SCEV::FlagAnyWrap, 2915 Depth + 1); 2916 if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true; 2917 NewOps.push_back(Mul); 2918 } 2919 if (AnyFolded) 2920 return getAddExpr(NewOps, SCEV::FlagAnyWrap, Depth + 1); 2921 } else if (const auto *AddRec = dyn_cast<SCEVAddRecExpr>(Ops[1])) { 2922 // Negation preserves a recurrence's no self-wrap property. 2923 SmallVector<const SCEV *, 4> Operands; 2924 for (const SCEV *AddRecOp : AddRec->operands()) 2925 Operands.push_back(getMulExpr(Ops[0], AddRecOp, SCEV::FlagAnyWrap, 2926 Depth + 1)); 2927 2928 return getAddRecExpr(Operands, AddRec->getLoop(), 2929 AddRec->getNoWrapFlags(SCEV::FlagNW)); 2930 } 2931 } 2932 } 2933 } 2934 2935 // Skip over the add expression until we get to a multiply. 2936 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr) 2937 ++Idx; 2938 2939 // If there are mul operands inline them all into this expression. 2940 if (Idx < Ops.size()) { 2941 bool DeletedMul = false; 2942 while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) { 2943 if (Ops.size() > MulOpsInlineThreshold) 2944 break; 2945 // If we have an mul, expand the mul operands onto the end of the 2946 // operands list. 2947 Ops.erase(Ops.begin()+Idx); 2948 Ops.append(Mul->op_begin(), Mul->op_end()); 2949 DeletedMul = true; 2950 } 2951 2952 // If we deleted at least one mul, we added operands to the end of the 2953 // list, and they are not necessarily sorted. Recurse to resort and 2954 // resimplify any operands we just acquired. 2955 if (DeletedMul) 2956 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2957 } 2958 2959 // If there are any add recurrences in the operands list, see if any other 2960 // added values are loop invariant. If so, we can fold them into the 2961 // recurrence. 2962 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr) 2963 ++Idx; 2964 2965 // Scan over all recurrences, trying to fold loop invariants into them. 2966 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) { 2967 // Scan all of the other operands to this mul and add them to the vector 2968 // if they are loop invariant w.r.t. the recurrence. 2969 SmallVector<const SCEV *, 8> LIOps; 2970 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]); 2971 const Loop *AddRecLoop = AddRec->getLoop(); 2972 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 2973 if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) { 2974 LIOps.push_back(Ops[i]); 2975 Ops.erase(Ops.begin()+i); 2976 --i; --e; 2977 } 2978 2979 // If we found some loop invariants, fold them into the recurrence. 2980 if (!LIOps.empty()) { 2981 // NLI * LI * {Start,+,Step} --> NLI * {LI*Start,+,LI*Step} 2982 SmallVector<const SCEV *, 4> NewOps; 2983 NewOps.reserve(AddRec->getNumOperands()); 2984 const SCEV *Scale = getMulExpr(LIOps, SCEV::FlagAnyWrap, Depth + 1); 2985 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) 2986 NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i), 2987 SCEV::FlagAnyWrap, Depth + 1)); 2988 2989 // Build the new addrec. Propagate the NUW and NSW flags if both the 2990 // outer mul and the inner addrec are guaranteed to have no overflow. 2991 // 2992 // No self-wrap cannot be guaranteed after changing the step size, but 2993 // will be inferred if either NUW or NSW is true. 2994 SCEV::NoWrapFlags Flags = ComputeFlags({Scale, AddRec}); 2995 const SCEV *NewRec = getAddRecExpr( 2996 NewOps, AddRecLoop, AddRec->getNoWrapFlags(Flags)); 2997 2998 // If all of the other operands were loop invariant, we are done. 2999 if (Ops.size() == 1) return NewRec; 3000 3001 // Otherwise, multiply the folded AddRec by the non-invariant parts. 3002 for (unsigned i = 0;; ++i) 3003 if (Ops[i] == AddRec) { 3004 Ops[i] = NewRec; 3005 break; 3006 } 3007 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3008 } 3009 3010 // Okay, if there weren't any loop invariants to be folded, check to see 3011 // if there are multiple AddRec's with the same loop induction variable 3012 // being multiplied together. If so, we can fold them. 3013 3014 // {A1,+,A2,+,...,+,An}<L> * {B1,+,B2,+,...,+,Bn}<L> 3015 // = {x=1 in [ sum y=x..2x [ sum z=max(y-x, y-n)..min(x,n) [ 3016 // choose(x, 2x)*choose(2x-y, x-z)*A_{y-z}*B_z 3017 // ]]],+,...up to x=2n}. 3018 // Note that the arguments to choose() are always integers with values 3019 // known at compile time, never SCEV objects. 3020 // 3021 // The implementation avoids pointless extra computations when the two 3022 // addrec's are of different length (mathematically, it's equivalent to 3023 // an infinite stream of zeros on the right). 3024 bool OpsModified = false; 3025 for (unsigned OtherIdx = Idx+1; 3026 OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 3027 ++OtherIdx) { 3028 const SCEVAddRecExpr *OtherAddRec = 3029 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]); 3030 if (!OtherAddRec || OtherAddRec->getLoop() != AddRecLoop) 3031 continue; 3032 3033 // Limit max number of arguments to avoid creation of unreasonably big 3034 // SCEVAddRecs with very complex operands. 3035 if (AddRec->getNumOperands() + OtherAddRec->getNumOperands() - 1 > 3036 MaxAddRecSize || hasHugeExpression({AddRec, OtherAddRec})) 3037 continue; 3038 3039 bool Overflow = false; 3040 Type *Ty = AddRec->getType(); 3041 bool LargerThan64Bits = getTypeSizeInBits(Ty) > 64; 3042 SmallVector<const SCEV*, 7> AddRecOps; 3043 for (int x = 0, xe = AddRec->getNumOperands() + 3044 OtherAddRec->getNumOperands() - 1; x != xe && !Overflow; ++x) { 3045 SmallVector <const SCEV *, 7> SumOps; 3046 for (int y = x, ye = 2*x+1; y != ye && !Overflow; ++y) { 3047 uint64_t Coeff1 = Choose(x, 2*x - y, Overflow); 3048 for (int z = std::max(y-x, y-(int)AddRec->getNumOperands()+1), 3049 ze = std::min(x+1, (int)OtherAddRec->getNumOperands()); 3050 z < ze && !Overflow; ++z) { 3051 uint64_t Coeff2 = Choose(2*x - y, x-z, Overflow); 3052 uint64_t Coeff; 3053 if (LargerThan64Bits) 3054 Coeff = umul_ov(Coeff1, Coeff2, Overflow); 3055 else 3056 Coeff = Coeff1*Coeff2; 3057 const SCEV *CoeffTerm = getConstant(Ty, Coeff); 3058 const SCEV *Term1 = AddRec->getOperand(y-z); 3059 const SCEV *Term2 = OtherAddRec->getOperand(z); 3060 SumOps.push_back(getMulExpr(CoeffTerm, Term1, Term2, 3061 SCEV::FlagAnyWrap, Depth + 1)); 3062 } 3063 } 3064 if (SumOps.empty()) 3065 SumOps.push_back(getZero(Ty)); 3066 AddRecOps.push_back(getAddExpr(SumOps, SCEV::FlagAnyWrap, Depth + 1)); 3067 } 3068 if (!Overflow) { 3069 const SCEV *NewAddRec = getAddRecExpr(AddRecOps, AddRecLoop, 3070 SCEV::FlagAnyWrap); 3071 if (Ops.size() == 2) return NewAddRec; 3072 Ops[Idx] = NewAddRec; 3073 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx; 3074 OpsModified = true; 3075 AddRec = dyn_cast<SCEVAddRecExpr>(NewAddRec); 3076 if (!AddRec) 3077 break; 3078 } 3079 } 3080 if (OpsModified) 3081 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3082 3083 // Otherwise couldn't fold anything into this recurrence. Move onto the 3084 // next one. 3085 } 3086 3087 // Okay, it looks like we really DO need an mul expr. Check to see if we 3088 // already have one, otherwise create a new one. 3089 return getOrCreateMulExpr(Ops, ComputeFlags(Ops)); 3090 } 3091 3092 /// Represents an unsigned remainder expression based on unsigned division. 3093 const SCEV *ScalarEvolution::getURemExpr(const SCEV *LHS, 3094 const SCEV *RHS) { 3095 assert(getEffectiveSCEVType(LHS->getType()) == 3096 getEffectiveSCEVType(RHS->getType()) && 3097 "SCEVURemExpr operand types don't match!"); 3098 3099 // Short-circuit easy cases 3100 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 3101 // If constant is one, the result is trivial 3102 if (RHSC->getValue()->isOne()) 3103 return getZero(LHS->getType()); // X urem 1 --> 0 3104 3105 // If constant is a power of two, fold into a zext(trunc(LHS)). 3106 if (RHSC->getAPInt().isPowerOf2()) { 3107 Type *FullTy = LHS->getType(); 3108 Type *TruncTy = 3109 IntegerType::get(getContext(), RHSC->getAPInt().logBase2()); 3110 return getZeroExtendExpr(getTruncateExpr(LHS, TruncTy), FullTy); 3111 } 3112 } 3113 3114 // Fallback to %a == %x urem %y == %x -<nuw> ((%x udiv %y) *<nuw> %y) 3115 const SCEV *UDiv = getUDivExpr(LHS, RHS); 3116 const SCEV *Mult = getMulExpr(UDiv, RHS, SCEV::FlagNUW); 3117 return getMinusSCEV(LHS, Mult, SCEV::FlagNUW); 3118 } 3119 3120 /// Get a canonical unsigned division expression, or something simpler if 3121 /// possible. 3122 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS, 3123 const SCEV *RHS) { 3124 assert(getEffectiveSCEVType(LHS->getType()) == 3125 getEffectiveSCEVType(RHS->getType()) && 3126 "SCEVUDivExpr operand types don't match!"); 3127 3128 FoldingSetNodeID ID; 3129 ID.AddInteger(scUDivExpr); 3130 ID.AddPointer(LHS); 3131 ID.AddPointer(RHS); 3132 void *IP = nullptr; 3133 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 3134 return S; 3135 3136 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 3137 if (RHSC->getValue()->isOne()) 3138 return LHS; // X udiv 1 --> x 3139 // If the denominator is zero, the result of the udiv is undefined. Don't 3140 // try to analyze it, because the resolution chosen here may differ from 3141 // the resolution chosen in other parts of the compiler. 3142 if (!RHSC->getValue()->isZero()) { 3143 // Determine if the division can be folded into the operands of 3144 // its operands. 3145 // TODO: Generalize this to non-constants by using known-bits information. 3146 Type *Ty = LHS->getType(); 3147 unsigned LZ = RHSC->getAPInt().countLeadingZeros(); 3148 unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1; 3149 // For non-power-of-two values, effectively round the value up to the 3150 // nearest power of two. 3151 if (!RHSC->getAPInt().isPowerOf2()) 3152 ++MaxShiftAmt; 3153 IntegerType *ExtTy = 3154 IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt); 3155 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS)) 3156 if (const SCEVConstant *Step = 3157 dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this))) { 3158 // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded. 3159 const APInt &StepInt = Step->getAPInt(); 3160 const APInt &DivInt = RHSC->getAPInt(); 3161 if (!StepInt.urem(DivInt) && 3162 getZeroExtendExpr(AR, ExtTy) == 3163 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy), 3164 getZeroExtendExpr(Step, ExtTy), 3165 AR->getLoop(), SCEV::FlagAnyWrap)) { 3166 SmallVector<const SCEV *, 4> Operands; 3167 for (const SCEV *Op : AR->operands()) 3168 Operands.push_back(getUDivExpr(Op, RHS)); 3169 return getAddRecExpr(Operands, AR->getLoop(), SCEV::FlagNW); 3170 } 3171 /// Get a canonical UDivExpr for a recurrence. 3172 /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0. 3173 // We can currently only fold X%N if X is constant. 3174 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart()); 3175 if (StartC && !DivInt.urem(StepInt) && 3176 getZeroExtendExpr(AR, ExtTy) == 3177 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy), 3178 getZeroExtendExpr(Step, ExtTy), 3179 AR->getLoop(), SCEV::FlagAnyWrap)) { 3180 const APInt &StartInt = StartC->getAPInt(); 3181 const APInt &StartRem = StartInt.urem(StepInt); 3182 if (StartRem != 0) { 3183 const SCEV *NewLHS = 3184 getAddRecExpr(getConstant(StartInt - StartRem), Step, 3185 AR->getLoop(), SCEV::FlagNW); 3186 if (LHS != NewLHS) { 3187 LHS = NewLHS; 3188 3189 // Reset the ID to include the new LHS, and check if it is 3190 // already cached. 3191 ID.clear(); 3192 ID.AddInteger(scUDivExpr); 3193 ID.AddPointer(LHS); 3194 ID.AddPointer(RHS); 3195 IP = nullptr; 3196 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 3197 return S; 3198 } 3199 } 3200 } 3201 } 3202 // (A*B)/C --> A*(B/C) if safe and B/C can be folded. 3203 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) { 3204 SmallVector<const SCEV *, 4> Operands; 3205 for (const SCEV *Op : M->operands()) 3206 Operands.push_back(getZeroExtendExpr(Op, ExtTy)); 3207 if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands)) 3208 // Find an operand that's safely divisible. 3209 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) { 3210 const SCEV *Op = M->getOperand(i); 3211 const SCEV *Div = getUDivExpr(Op, RHSC); 3212 if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) { 3213 Operands = SmallVector<const SCEV *, 4>(M->operands()); 3214 Operands[i] = Div; 3215 return getMulExpr(Operands); 3216 } 3217 } 3218 } 3219 3220 // (A/B)/C --> A/(B*C) if safe and B*C can be folded. 3221 if (const SCEVUDivExpr *OtherDiv = dyn_cast<SCEVUDivExpr>(LHS)) { 3222 if (auto *DivisorConstant = 3223 dyn_cast<SCEVConstant>(OtherDiv->getRHS())) { 3224 bool Overflow = false; 3225 APInt NewRHS = 3226 DivisorConstant->getAPInt().umul_ov(RHSC->getAPInt(), Overflow); 3227 if (Overflow) { 3228 return getConstant(RHSC->getType(), 0, false); 3229 } 3230 return getUDivExpr(OtherDiv->getLHS(), getConstant(NewRHS)); 3231 } 3232 } 3233 3234 // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded. 3235 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) { 3236 SmallVector<const SCEV *, 4> Operands; 3237 for (const SCEV *Op : A->operands()) 3238 Operands.push_back(getZeroExtendExpr(Op, ExtTy)); 3239 if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) { 3240 Operands.clear(); 3241 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) { 3242 const SCEV *Op = getUDivExpr(A->getOperand(i), RHS); 3243 if (isa<SCEVUDivExpr>(Op) || 3244 getMulExpr(Op, RHS) != A->getOperand(i)) 3245 break; 3246 Operands.push_back(Op); 3247 } 3248 if (Operands.size() == A->getNumOperands()) 3249 return getAddExpr(Operands); 3250 } 3251 } 3252 3253 // Fold if both operands are constant. 3254 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) { 3255 Constant *LHSCV = LHSC->getValue(); 3256 Constant *RHSCV = RHSC->getValue(); 3257 return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV, 3258 RHSCV))); 3259 } 3260 } 3261 } 3262 3263 // The Insertion Point (IP) might be invalid by now (due to UniqueSCEVs 3264 // changes). Make sure we get a new one. 3265 IP = nullptr; 3266 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 3267 SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator), 3268 LHS, RHS); 3269 UniqueSCEVs.InsertNode(S, IP); 3270 addToLoopUseLists(S); 3271 return S; 3272 } 3273 3274 static const APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) { 3275 APInt A = C1->getAPInt().abs(); 3276 APInt B = C2->getAPInt().abs(); 3277 uint32_t ABW = A.getBitWidth(); 3278 uint32_t BBW = B.getBitWidth(); 3279 3280 if (ABW > BBW) 3281 B = B.zext(ABW); 3282 else if (ABW < BBW) 3283 A = A.zext(BBW); 3284 3285 return APIntOps::GreatestCommonDivisor(std::move(A), std::move(B)); 3286 } 3287 3288 /// Get a canonical unsigned division expression, or something simpler if 3289 /// possible. There is no representation for an exact udiv in SCEV IR, but we 3290 /// can attempt to remove factors from the LHS and RHS. We can't do this when 3291 /// it's not exact because the udiv may be clearing bits. 3292 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS, 3293 const SCEV *RHS) { 3294 // TODO: we could try to find factors in all sorts of things, but for now we 3295 // just deal with u/exact (multiply, constant). See SCEVDivision towards the 3296 // end of this file for inspiration. 3297 3298 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS); 3299 if (!Mul || !Mul->hasNoUnsignedWrap()) 3300 return getUDivExpr(LHS, RHS); 3301 3302 if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) { 3303 // If the mulexpr multiplies by a constant, then that constant must be the 3304 // first element of the mulexpr. 3305 if (const auto *LHSCst = dyn_cast<SCEVConstant>(Mul->getOperand(0))) { 3306 if (LHSCst == RHSCst) { 3307 SmallVector<const SCEV *, 2> Operands(drop_begin(Mul->operands())); 3308 return getMulExpr(Operands); 3309 } 3310 3311 // We can't just assume that LHSCst divides RHSCst cleanly, it could be 3312 // that there's a factor provided by one of the other terms. We need to 3313 // check. 3314 APInt Factor = gcd(LHSCst, RHSCst); 3315 if (!Factor.isIntN(1)) { 3316 LHSCst = 3317 cast<SCEVConstant>(getConstant(LHSCst->getAPInt().udiv(Factor))); 3318 RHSCst = 3319 cast<SCEVConstant>(getConstant(RHSCst->getAPInt().udiv(Factor))); 3320 SmallVector<const SCEV *, 2> Operands; 3321 Operands.push_back(LHSCst); 3322 Operands.append(Mul->op_begin() + 1, Mul->op_end()); 3323 LHS = getMulExpr(Operands); 3324 RHS = RHSCst; 3325 Mul = dyn_cast<SCEVMulExpr>(LHS); 3326 if (!Mul) 3327 return getUDivExactExpr(LHS, RHS); 3328 } 3329 } 3330 } 3331 3332 for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) { 3333 if (Mul->getOperand(i) == RHS) { 3334 SmallVector<const SCEV *, 2> Operands; 3335 Operands.append(Mul->op_begin(), Mul->op_begin() + i); 3336 Operands.append(Mul->op_begin() + i + 1, Mul->op_end()); 3337 return getMulExpr(Operands); 3338 } 3339 } 3340 3341 return getUDivExpr(LHS, RHS); 3342 } 3343 3344 /// Get an add recurrence expression for the specified loop. Simplify the 3345 /// expression as much as possible. 3346 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step, 3347 const Loop *L, 3348 SCEV::NoWrapFlags Flags) { 3349 SmallVector<const SCEV *, 4> Operands; 3350 Operands.push_back(Start); 3351 if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step)) 3352 if (StepChrec->getLoop() == L) { 3353 Operands.append(StepChrec->op_begin(), StepChrec->op_end()); 3354 return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW)); 3355 } 3356 3357 Operands.push_back(Step); 3358 return getAddRecExpr(Operands, L, Flags); 3359 } 3360 3361 /// Get an add recurrence expression for the specified loop. Simplify the 3362 /// expression as much as possible. 3363 const SCEV * 3364 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands, 3365 const Loop *L, SCEV::NoWrapFlags Flags) { 3366 if (Operands.size() == 1) return Operands[0]; 3367 #ifndef NDEBUG 3368 Type *ETy = getEffectiveSCEVType(Operands[0]->getType()); 3369 for (unsigned i = 1, e = Operands.size(); i != e; ++i) 3370 assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy && 3371 "SCEVAddRecExpr operand types don't match!"); 3372 for (unsigned i = 0, e = Operands.size(); i != e; ++i) 3373 assert(isLoopInvariant(Operands[i], L) && 3374 "SCEVAddRecExpr operand is not loop-invariant!"); 3375 #endif 3376 3377 if (Operands.back()->isZero()) { 3378 Operands.pop_back(); 3379 return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0} --> X 3380 } 3381 3382 // It's tempting to want to call getConstantMaxBackedgeTakenCount count here and 3383 // use that information to infer NUW and NSW flags. However, computing a 3384 // BE count requires calling getAddRecExpr, so we may not yet have a 3385 // meaningful BE count at this point (and if we don't, we'd be stuck 3386 // with a SCEVCouldNotCompute as the cached BE count). 3387 3388 Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags); 3389 3390 // Canonicalize nested AddRecs in by nesting them in order of loop depth. 3391 if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) { 3392 const Loop *NestedLoop = NestedAR->getLoop(); 3393 if (L->contains(NestedLoop) 3394 ? (L->getLoopDepth() < NestedLoop->getLoopDepth()) 3395 : (!NestedLoop->contains(L) && 3396 DT.dominates(L->getHeader(), NestedLoop->getHeader()))) { 3397 SmallVector<const SCEV *, 4> NestedOperands(NestedAR->operands()); 3398 Operands[0] = NestedAR->getStart(); 3399 // AddRecs require their operands be loop-invariant with respect to their 3400 // loops. Don't perform this transformation if it would break this 3401 // requirement. 3402 bool AllInvariant = all_of( 3403 Operands, [&](const SCEV *Op) { return isLoopInvariant(Op, L); }); 3404 3405 if (AllInvariant) { 3406 // Create a recurrence for the outer loop with the same step size. 3407 // 3408 // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the 3409 // inner recurrence has the same property. 3410 SCEV::NoWrapFlags OuterFlags = 3411 maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags()); 3412 3413 NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags); 3414 AllInvariant = all_of(NestedOperands, [&](const SCEV *Op) { 3415 return isLoopInvariant(Op, NestedLoop); 3416 }); 3417 3418 if (AllInvariant) { 3419 // Ok, both add recurrences are valid after the transformation. 3420 // 3421 // The inner recurrence keeps its NW flag but only keeps NUW/NSW if 3422 // the outer recurrence has the same property. 3423 SCEV::NoWrapFlags InnerFlags = 3424 maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags); 3425 return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags); 3426 } 3427 } 3428 // Reset Operands to its original state. 3429 Operands[0] = NestedAR; 3430 } 3431 } 3432 3433 // Okay, it looks like we really DO need an addrec expr. Check to see if we 3434 // already have one, otherwise create a new one. 3435 return getOrCreateAddRecExpr(Operands, L, Flags); 3436 } 3437 3438 const SCEV * 3439 ScalarEvolution::getGEPExpr(GEPOperator *GEP, 3440 const SmallVectorImpl<const SCEV *> &IndexExprs) { 3441 const SCEV *BaseExpr = getSCEV(GEP->getPointerOperand()); 3442 // getSCEV(Base)->getType() has the same address space as Base->getType() 3443 // because SCEV::getType() preserves the address space. 3444 Type *IntIdxTy = getEffectiveSCEVType(BaseExpr->getType()); 3445 // FIXME(PR23527): Don't blindly transfer the inbounds flag from the GEP 3446 // instruction to its SCEV, because the Instruction may be guarded by control 3447 // flow and the no-overflow bits may not be valid for the expression in any 3448 // context. This can be fixed similarly to how these flags are handled for 3449 // adds. 3450 SCEV::NoWrapFlags OffsetWrap = 3451 GEP->isInBounds() ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 3452 3453 Type *CurTy = GEP->getType(); 3454 bool FirstIter = true; 3455 SmallVector<const SCEV *, 4> Offsets; 3456 for (const SCEV *IndexExpr : IndexExprs) { 3457 // Compute the (potentially symbolic) offset in bytes for this index. 3458 if (StructType *STy = dyn_cast<StructType>(CurTy)) { 3459 // For a struct, add the member offset. 3460 ConstantInt *Index = cast<SCEVConstant>(IndexExpr)->getValue(); 3461 unsigned FieldNo = Index->getZExtValue(); 3462 const SCEV *FieldOffset = getOffsetOfExpr(IntIdxTy, STy, FieldNo); 3463 Offsets.push_back(FieldOffset); 3464 3465 // Update CurTy to the type of the field at Index. 3466 CurTy = STy->getTypeAtIndex(Index); 3467 } else { 3468 // Update CurTy to its element type. 3469 if (FirstIter) { 3470 assert(isa<PointerType>(CurTy) && 3471 "The first index of a GEP indexes a pointer"); 3472 CurTy = GEP->getSourceElementType(); 3473 FirstIter = false; 3474 } else { 3475 CurTy = GetElementPtrInst::getTypeAtIndex(CurTy, (uint64_t)0); 3476 } 3477 // For an array, add the element offset, explicitly scaled. 3478 const SCEV *ElementSize = getSizeOfExpr(IntIdxTy, CurTy); 3479 // Getelementptr indices are signed. 3480 IndexExpr = getTruncateOrSignExtend(IndexExpr, IntIdxTy); 3481 3482 // Multiply the index by the element size to compute the element offset. 3483 const SCEV *LocalOffset = getMulExpr(IndexExpr, ElementSize, OffsetWrap); 3484 Offsets.push_back(LocalOffset); 3485 } 3486 } 3487 3488 // Handle degenerate case of GEP without offsets. 3489 if (Offsets.empty()) 3490 return BaseExpr; 3491 3492 // Add the offsets together, assuming nsw if inbounds. 3493 const SCEV *Offset = getAddExpr(Offsets, OffsetWrap); 3494 // Add the base address and the offset. We cannot use the nsw flag, as the 3495 // base address is unsigned. However, if we know that the offset is 3496 // non-negative, we can use nuw. 3497 SCEV::NoWrapFlags BaseWrap = GEP->isInBounds() && isKnownNonNegative(Offset) 3498 ? SCEV::FlagNUW : SCEV::FlagAnyWrap; 3499 return getAddExpr(BaseExpr, Offset, BaseWrap); 3500 } 3501 3502 std::tuple<SCEV *, FoldingSetNodeID, void *> 3503 ScalarEvolution::findExistingSCEVInCache(SCEVTypes SCEVType, 3504 ArrayRef<const SCEV *> Ops) { 3505 FoldingSetNodeID ID; 3506 void *IP = nullptr; 3507 ID.AddInteger(SCEVType); 3508 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 3509 ID.AddPointer(Ops[i]); 3510 return std::tuple<SCEV *, FoldingSetNodeID, void *>( 3511 UniqueSCEVs.FindNodeOrInsertPos(ID, IP), std::move(ID), IP); 3512 } 3513 3514 const SCEV *ScalarEvolution::getAbsExpr(const SCEV *Op, bool IsNSW) { 3515 SCEV::NoWrapFlags Flags = IsNSW ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 3516 return getSMaxExpr(Op, getNegativeSCEV(Op, Flags)); 3517 } 3518 3519 const SCEV *ScalarEvolution::getMinMaxExpr(SCEVTypes Kind, 3520 SmallVectorImpl<const SCEV *> &Ops) { 3521 assert(!Ops.empty() && "Cannot get empty (u|s)(min|max)!"); 3522 if (Ops.size() == 1) return Ops[0]; 3523 #ifndef NDEBUG 3524 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 3525 for (unsigned i = 1, e = Ops.size(); i != e; ++i) 3526 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 3527 "Operand types don't match!"); 3528 #endif 3529 3530 bool IsSigned = Kind == scSMaxExpr || Kind == scSMinExpr; 3531 bool IsMax = Kind == scSMaxExpr || Kind == scUMaxExpr; 3532 3533 // Sort by complexity, this groups all similar expression types together. 3534 GroupByComplexity(Ops, &LI, DT); 3535 3536 // Check if we have created the same expression before. 3537 if (const SCEV *S = std::get<0>(findExistingSCEVInCache(Kind, Ops))) { 3538 return S; 3539 } 3540 3541 // If there are any constants, fold them together. 3542 unsigned Idx = 0; 3543 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 3544 ++Idx; 3545 assert(Idx < Ops.size()); 3546 auto FoldOp = [&](const APInt &LHS, const APInt &RHS) { 3547 if (Kind == scSMaxExpr) 3548 return APIntOps::smax(LHS, RHS); 3549 else if (Kind == scSMinExpr) 3550 return APIntOps::smin(LHS, RHS); 3551 else if (Kind == scUMaxExpr) 3552 return APIntOps::umax(LHS, RHS); 3553 else if (Kind == scUMinExpr) 3554 return APIntOps::umin(LHS, RHS); 3555 llvm_unreachable("Unknown SCEV min/max opcode"); 3556 }; 3557 3558 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 3559 // We found two constants, fold them together! 3560 ConstantInt *Fold = ConstantInt::get( 3561 getContext(), FoldOp(LHSC->getAPInt(), RHSC->getAPInt())); 3562 Ops[0] = getConstant(Fold); 3563 Ops.erase(Ops.begin()+1); // Erase the folded element 3564 if (Ops.size() == 1) return Ops[0]; 3565 LHSC = cast<SCEVConstant>(Ops[0]); 3566 } 3567 3568 bool IsMinV = LHSC->getValue()->isMinValue(IsSigned); 3569 bool IsMaxV = LHSC->getValue()->isMaxValue(IsSigned); 3570 3571 if (IsMax ? IsMinV : IsMaxV) { 3572 // If we are left with a constant minimum(/maximum)-int, strip it off. 3573 Ops.erase(Ops.begin()); 3574 --Idx; 3575 } else if (IsMax ? IsMaxV : IsMinV) { 3576 // If we have a max(/min) with a constant maximum(/minimum)-int, 3577 // it will always be the extremum. 3578 return LHSC; 3579 } 3580 3581 if (Ops.size() == 1) return Ops[0]; 3582 } 3583 3584 // Find the first operation of the same kind 3585 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < Kind) 3586 ++Idx; 3587 3588 // Check to see if one of the operands is of the same kind. If so, expand its 3589 // operands onto our operand list, and recurse to simplify. 3590 if (Idx < Ops.size()) { 3591 bool DeletedAny = false; 3592 while (Ops[Idx]->getSCEVType() == Kind) { 3593 const SCEVMinMaxExpr *SMME = cast<SCEVMinMaxExpr>(Ops[Idx]); 3594 Ops.erase(Ops.begin()+Idx); 3595 Ops.append(SMME->op_begin(), SMME->op_end()); 3596 DeletedAny = true; 3597 } 3598 3599 if (DeletedAny) 3600 return getMinMaxExpr(Kind, Ops); 3601 } 3602 3603 // Okay, check to see if the same value occurs in the operand list twice. If 3604 // so, delete one. Since we sorted the list, these values are required to 3605 // be adjacent. 3606 llvm::CmpInst::Predicate GEPred = 3607 IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 3608 llvm::CmpInst::Predicate LEPred = 3609 IsSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 3610 llvm::CmpInst::Predicate FirstPred = IsMax ? GEPred : LEPred; 3611 llvm::CmpInst::Predicate SecondPred = IsMax ? LEPred : GEPred; 3612 for (unsigned i = 0, e = Ops.size() - 1; i != e; ++i) { 3613 if (Ops[i] == Ops[i + 1] || 3614 isKnownViaNonRecursiveReasoning(FirstPred, Ops[i], Ops[i + 1])) { 3615 // X op Y op Y --> X op Y 3616 // X op Y --> X, if we know X, Y are ordered appropriately 3617 Ops.erase(Ops.begin() + i + 1, Ops.begin() + i + 2); 3618 --i; 3619 --e; 3620 } else if (isKnownViaNonRecursiveReasoning(SecondPred, Ops[i], 3621 Ops[i + 1])) { 3622 // X op Y --> Y, if we know X, Y are ordered appropriately 3623 Ops.erase(Ops.begin() + i, Ops.begin() + i + 1); 3624 --i; 3625 --e; 3626 } 3627 } 3628 3629 if (Ops.size() == 1) return Ops[0]; 3630 3631 assert(!Ops.empty() && "Reduced smax down to nothing!"); 3632 3633 // Okay, it looks like we really DO need an expr. Check to see if we 3634 // already have one, otherwise create a new one. 3635 const SCEV *ExistingSCEV; 3636 FoldingSetNodeID ID; 3637 void *IP; 3638 std::tie(ExistingSCEV, ID, IP) = findExistingSCEVInCache(Kind, Ops); 3639 if (ExistingSCEV) 3640 return ExistingSCEV; 3641 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 3642 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 3643 SCEV *S = new (SCEVAllocator) 3644 SCEVMinMaxExpr(ID.Intern(SCEVAllocator), Kind, O, Ops.size()); 3645 3646 UniqueSCEVs.InsertNode(S, IP); 3647 addToLoopUseLists(S); 3648 return S; 3649 } 3650 3651 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS, const SCEV *RHS) { 3652 SmallVector<const SCEV *, 2> Ops = {LHS, RHS}; 3653 return getSMaxExpr(Ops); 3654 } 3655 3656 const SCEV *ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) { 3657 return getMinMaxExpr(scSMaxExpr, Ops); 3658 } 3659 3660 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS, const SCEV *RHS) { 3661 SmallVector<const SCEV *, 2> Ops = {LHS, RHS}; 3662 return getUMaxExpr(Ops); 3663 } 3664 3665 const SCEV *ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) { 3666 return getMinMaxExpr(scUMaxExpr, Ops); 3667 } 3668 3669 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS, 3670 const SCEV *RHS) { 3671 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 3672 return getSMinExpr(Ops); 3673 } 3674 3675 const SCEV *ScalarEvolution::getSMinExpr(SmallVectorImpl<const SCEV *> &Ops) { 3676 return getMinMaxExpr(scSMinExpr, Ops); 3677 } 3678 3679 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS, 3680 const SCEV *RHS) { 3681 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 3682 return getUMinExpr(Ops); 3683 } 3684 3685 const SCEV *ScalarEvolution::getUMinExpr(SmallVectorImpl<const SCEV *> &Ops) { 3686 return getMinMaxExpr(scUMinExpr, Ops); 3687 } 3688 3689 const SCEV * 3690 ScalarEvolution::getSizeOfScalableVectorExpr(Type *IntTy, 3691 ScalableVectorType *ScalableTy) { 3692 Constant *NullPtr = Constant::getNullValue(ScalableTy->getPointerTo()); 3693 Constant *One = ConstantInt::get(IntTy, 1); 3694 Constant *GEP = ConstantExpr::getGetElementPtr(ScalableTy, NullPtr, One); 3695 // Note that the expression we created is the final expression, we don't 3696 // want to simplify it any further Also, if we call a normal getSCEV(), 3697 // we'll end up in an endless recursion. So just create an SCEVUnknown. 3698 return getUnknown(ConstantExpr::getPtrToInt(GEP, IntTy)); 3699 } 3700 3701 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) { 3702 if (auto *ScalableAllocTy = dyn_cast<ScalableVectorType>(AllocTy)) 3703 return getSizeOfScalableVectorExpr(IntTy, ScalableAllocTy); 3704 // We can bypass creating a target-independent constant expression and then 3705 // folding it back into a ConstantInt. This is just a compile-time 3706 // optimization. 3707 return getConstant(IntTy, getDataLayout().getTypeAllocSize(AllocTy)); 3708 } 3709 3710 const SCEV *ScalarEvolution::getStoreSizeOfExpr(Type *IntTy, Type *StoreTy) { 3711 if (auto *ScalableStoreTy = dyn_cast<ScalableVectorType>(StoreTy)) 3712 return getSizeOfScalableVectorExpr(IntTy, ScalableStoreTy); 3713 // We can bypass creating a target-independent constant expression and then 3714 // folding it back into a ConstantInt. This is just a compile-time 3715 // optimization. 3716 return getConstant(IntTy, getDataLayout().getTypeStoreSize(StoreTy)); 3717 } 3718 3719 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy, 3720 StructType *STy, 3721 unsigned FieldNo) { 3722 // We can bypass creating a target-independent constant expression and then 3723 // folding it back into a ConstantInt. This is just a compile-time 3724 // optimization. 3725 return getConstant( 3726 IntTy, getDataLayout().getStructLayout(STy)->getElementOffset(FieldNo)); 3727 } 3728 3729 const SCEV *ScalarEvolution::getUnknown(Value *V) { 3730 // Don't attempt to do anything other than create a SCEVUnknown object 3731 // here. createSCEV only calls getUnknown after checking for all other 3732 // interesting possibilities, and any other code that calls getUnknown 3733 // is doing so in order to hide a value from SCEV canonicalization. 3734 3735 FoldingSetNodeID ID; 3736 ID.AddInteger(scUnknown); 3737 ID.AddPointer(V); 3738 void *IP = nullptr; 3739 if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) { 3740 assert(cast<SCEVUnknown>(S)->getValue() == V && 3741 "Stale SCEVUnknown in uniquing map!"); 3742 return S; 3743 } 3744 SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this, 3745 FirstUnknown); 3746 FirstUnknown = cast<SCEVUnknown>(S); 3747 UniqueSCEVs.InsertNode(S, IP); 3748 return S; 3749 } 3750 3751 //===----------------------------------------------------------------------===// 3752 // Basic SCEV Analysis and PHI Idiom Recognition Code 3753 // 3754 3755 /// Test if values of the given type are analyzable within the SCEV 3756 /// framework. This primarily includes integer types, and it can optionally 3757 /// include pointer types if the ScalarEvolution class has access to 3758 /// target-specific information. 3759 bool ScalarEvolution::isSCEVable(Type *Ty) const { 3760 // Integers and pointers are always SCEVable. 3761 return Ty->isIntOrPtrTy(); 3762 } 3763 3764 /// Return the size in bits of the specified type, for which isSCEVable must 3765 /// return true. 3766 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const { 3767 assert(isSCEVable(Ty) && "Type is not SCEVable!"); 3768 if (Ty->isPointerTy()) 3769 return getDataLayout().getIndexTypeSizeInBits(Ty); 3770 return getDataLayout().getTypeSizeInBits(Ty); 3771 } 3772 3773 /// Return a type with the same bitwidth as the given type and which represents 3774 /// how SCEV will treat the given type, for which isSCEVable must return 3775 /// true. For pointer types, this is the pointer index sized integer type. 3776 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const { 3777 assert(isSCEVable(Ty) && "Type is not SCEVable!"); 3778 3779 if (Ty->isIntegerTy()) 3780 return Ty; 3781 3782 // The only other support type is pointer. 3783 assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!"); 3784 return getDataLayout().getIndexType(Ty); 3785 } 3786 3787 Type *ScalarEvolution::getWiderType(Type *T1, Type *T2) const { 3788 return getTypeSizeInBits(T1) >= getTypeSizeInBits(T2) ? T1 : T2; 3789 } 3790 3791 const SCEV *ScalarEvolution::getCouldNotCompute() { 3792 return CouldNotCompute.get(); 3793 } 3794 3795 bool ScalarEvolution::checkValidity(const SCEV *S) const { 3796 bool ContainsNulls = SCEVExprContains(S, [](const SCEV *S) { 3797 auto *SU = dyn_cast<SCEVUnknown>(S); 3798 return SU && SU->getValue() == nullptr; 3799 }); 3800 3801 return !ContainsNulls; 3802 } 3803 3804 bool ScalarEvolution::containsAddRecurrence(const SCEV *S) { 3805 HasRecMapType::iterator I = HasRecMap.find(S); 3806 if (I != HasRecMap.end()) 3807 return I->second; 3808 3809 bool FoundAddRec = 3810 SCEVExprContains(S, [](const SCEV *S) { return isa<SCEVAddRecExpr>(S); }); 3811 HasRecMap.insert({S, FoundAddRec}); 3812 return FoundAddRec; 3813 } 3814 3815 /// Try to split a SCEVAddExpr into a pair of {SCEV, ConstantInt}. 3816 /// If \p S is a SCEVAddExpr and is composed of a sub SCEV S' and an 3817 /// offset I, then return {S', I}, else return {\p S, nullptr}. 3818 static std::pair<const SCEV *, ConstantInt *> splitAddExpr(const SCEV *S) { 3819 const auto *Add = dyn_cast<SCEVAddExpr>(S); 3820 if (!Add) 3821 return {S, nullptr}; 3822 3823 if (Add->getNumOperands() != 2) 3824 return {S, nullptr}; 3825 3826 auto *ConstOp = dyn_cast<SCEVConstant>(Add->getOperand(0)); 3827 if (!ConstOp) 3828 return {S, nullptr}; 3829 3830 return {Add->getOperand(1), ConstOp->getValue()}; 3831 } 3832 3833 /// Return the ValueOffsetPair set for \p S. \p S can be represented 3834 /// by the value and offset from any ValueOffsetPair in the set. 3835 SetVector<ScalarEvolution::ValueOffsetPair> * 3836 ScalarEvolution::getSCEVValues(const SCEV *S) { 3837 ExprValueMapType::iterator SI = ExprValueMap.find_as(S); 3838 if (SI == ExprValueMap.end()) 3839 return nullptr; 3840 #ifndef NDEBUG 3841 if (VerifySCEVMap) { 3842 // Check there is no dangling Value in the set returned. 3843 for (const auto &VE : SI->second) 3844 assert(ValueExprMap.count(VE.first)); 3845 } 3846 #endif 3847 return &SI->second; 3848 } 3849 3850 /// Erase Value from ValueExprMap and ExprValueMap. ValueExprMap.erase(V) 3851 /// cannot be used separately. eraseValueFromMap should be used to remove 3852 /// V from ValueExprMap and ExprValueMap at the same time. 3853 void ScalarEvolution::eraseValueFromMap(Value *V) { 3854 ValueExprMapType::iterator I = ValueExprMap.find_as(V); 3855 if (I != ValueExprMap.end()) { 3856 const SCEV *S = I->second; 3857 // Remove {V, 0} from the set of ExprValueMap[S] 3858 if (SetVector<ValueOffsetPair> *SV = getSCEVValues(S)) 3859 SV->remove({V, nullptr}); 3860 3861 // Remove {V, Offset} from the set of ExprValueMap[Stripped] 3862 const SCEV *Stripped; 3863 ConstantInt *Offset; 3864 std::tie(Stripped, Offset) = splitAddExpr(S); 3865 if (Offset != nullptr) { 3866 if (SetVector<ValueOffsetPair> *SV = getSCEVValues(Stripped)) 3867 SV->remove({V, Offset}); 3868 } 3869 ValueExprMap.erase(V); 3870 } 3871 } 3872 3873 /// Check whether value has nuw/nsw/exact set but SCEV does not. 3874 /// TODO: In reality it is better to check the poison recursively 3875 /// but this is better than nothing. 3876 static bool SCEVLostPoisonFlags(const SCEV *S, const Value *V) { 3877 if (auto *I = dyn_cast<Instruction>(V)) { 3878 if (isa<OverflowingBinaryOperator>(I)) { 3879 if (auto *NS = dyn_cast<SCEVNAryExpr>(S)) { 3880 if (I->hasNoSignedWrap() && !NS->hasNoSignedWrap()) 3881 return true; 3882 if (I->hasNoUnsignedWrap() && !NS->hasNoUnsignedWrap()) 3883 return true; 3884 } 3885 } else if (isa<PossiblyExactOperator>(I) && I->isExact()) 3886 return true; 3887 } 3888 return false; 3889 } 3890 3891 /// Return an existing SCEV if it exists, otherwise analyze the expression and 3892 /// create a new one. 3893 const SCEV *ScalarEvolution::getSCEV(Value *V) { 3894 assert(isSCEVable(V->getType()) && "Value is not SCEVable!"); 3895 3896 const SCEV *S = getExistingSCEV(V); 3897 if (S == nullptr) { 3898 S = createSCEV(V); 3899 // During PHI resolution, it is possible to create two SCEVs for the same 3900 // V, so it is needed to double check whether V->S is inserted into 3901 // ValueExprMap before insert S->{V, 0} into ExprValueMap. 3902 std::pair<ValueExprMapType::iterator, bool> Pair = 3903 ValueExprMap.insert({SCEVCallbackVH(V, this), S}); 3904 if (Pair.second && !SCEVLostPoisonFlags(S, V)) { 3905 ExprValueMap[S].insert({V, nullptr}); 3906 3907 // If S == Stripped + Offset, add Stripped -> {V, Offset} into 3908 // ExprValueMap. 3909 const SCEV *Stripped = S; 3910 ConstantInt *Offset = nullptr; 3911 std::tie(Stripped, Offset) = splitAddExpr(S); 3912 // If stripped is SCEVUnknown, don't bother to save 3913 // Stripped -> {V, offset}. It doesn't simplify and sometimes even 3914 // increase the complexity of the expansion code. 3915 // If V is GetElementPtrInst, don't save Stripped -> {V, offset} 3916 // because it may generate add/sub instead of GEP in SCEV expansion. 3917 if (Offset != nullptr && !isa<SCEVUnknown>(Stripped) && 3918 !isa<GetElementPtrInst>(V)) 3919 ExprValueMap[Stripped].insert({V, Offset}); 3920 } 3921 } 3922 return S; 3923 } 3924 3925 const SCEV *ScalarEvolution::getExistingSCEV(Value *V) { 3926 assert(isSCEVable(V->getType()) && "Value is not SCEVable!"); 3927 3928 ValueExprMapType::iterator I = ValueExprMap.find_as(V); 3929 if (I != ValueExprMap.end()) { 3930 const SCEV *S = I->second; 3931 if (checkValidity(S)) 3932 return S; 3933 eraseValueFromMap(V); 3934 forgetMemoizedResults(S); 3935 } 3936 return nullptr; 3937 } 3938 3939 /// Return a SCEV corresponding to -V = -1*V 3940 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V, 3941 SCEV::NoWrapFlags Flags) { 3942 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V)) 3943 return getConstant( 3944 cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue()))); 3945 3946 Type *Ty = V->getType(); 3947 Ty = getEffectiveSCEVType(Ty); 3948 return getMulExpr(V, getMinusOne(Ty), Flags); 3949 } 3950 3951 /// If Expr computes ~A, return A else return nullptr 3952 static const SCEV *MatchNotExpr(const SCEV *Expr) { 3953 const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr); 3954 if (!Add || Add->getNumOperands() != 2 || 3955 !Add->getOperand(0)->isAllOnesValue()) 3956 return nullptr; 3957 3958 const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1)); 3959 if (!AddRHS || AddRHS->getNumOperands() != 2 || 3960 !AddRHS->getOperand(0)->isAllOnesValue()) 3961 return nullptr; 3962 3963 return AddRHS->getOperand(1); 3964 } 3965 3966 /// Return a SCEV corresponding to ~V = -1-V 3967 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) { 3968 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V)) 3969 return getConstant( 3970 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue()))); 3971 3972 // Fold ~(u|s)(min|max)(~x, ~y) to (u|s)(max|min)(x, y) 3973 if (const SCEVMinMaxExpr *MME = dyn_cast<SCEVMinMaxExpr>(V)) { 3974 auto MatchMinMaxNegation = [&](const SCEVMinMaxExpr *MME) { 3975 SmallVector<const SCEV *, 2> MatchedOperands; 3976 for (const SCEV *Operand : MME->operands()) { 3977 const SCEV *Matched = MatchNotExpr(Operand); 3978 if (!Matched) 3979 return (const SCEV *)nullptr; 3980 MatchedOperands.push_back(Matched); 3981 } 3982 return getMinMaxExpr(SCEVMinMaxExpr::negate(MME->getSCEVType()), 3983 MatchedOperands); 3984 }; 3985 if (const SCEV *Replaced = MatchMinMaxNegation(MME)) 3986 return Replaced; 3987 } 3988 3989 Type *Ty = V->getType(); 3990 Ty = getEffectiveSCEVType(Ty); 3991 return getMinusSCEV(getMinusOne(Ty), V); 3992 } 3993 3994 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS, 3995 SCEV::NoWrapFlags Flags, 3996 unsigned Depth) { 3997 // Fast path: X - X --> 0. 3998 if (LHS == RHS) 3999 return getZero(LHS->getType()); 4000 4001 // We represent LHS - RHS as LHS + (-1)*RHS. This transformation 4002 // makes it so that we cannot make much use of NUW. 4003 auto AddFlags = SCEV::FlagAnyWrap; 4004 const bool RHSIsNotMinSigned = 4005 !getSignedRangeMin(RHS).isMinSignedValue(); 4006 if (maskFlags(Flags, SCEV::FlagNSW) == SCEV::FlagNSW) { 4007 // Let M be the minimum representable signed value. Then (-1)*RHS 4008 // signed-wraps if and only if RHS is M. That can happen even for 4009 // a NSW subtraction because e.g. (-1)*M signed-wraps even though 4010 // -1 - M does not. So to transfer NSW from LHS - RHS to LHS + 4011 // (-1)*RHS, we need to prove that RHS != M. 4012 // 4013 // If LHS is non-negative and we know that LHS - RHS does not 4014 // signed-wrap, then RHS cannot be M. So we can rule out signed-wrap 4015 // either by proving that RHS > M or that LHS >= 0. 4016 if (RHSIsNotMinSigned || isKnownNonNegative(LHS)) { 4017 AddFlags = SCEV::FlagNSW; 4018 } 4019 } 4020 4021 // FIXME: Find a correct way to transfer NSW to (-1)*M when LHS - 4022 // RHS is NSW and LHS >= 0. 4023 // 4024 // The difficulty here is that the NSW flag may have been proven 4025 // relative to a loop that is to be found in a recurrence in LHS and 4026 // not in RHS. Applying NSW to (-1)*M may then let the NSW have a 4027 // larger scope than intended. 4028 auto NegFlags = RHSIsNotMinSigned ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 4029 4030 return getAddExpr(LHS, getNegativeSCEV(RHS, NegFlags), AddFlags, Depth); 4031 } 4032 4033 const SCEV *ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty, 4034 unsigned Depth) { 4035 Type *SrcTy = V->getType(); 4036 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4037 "Cannot truncate or zero extend with non-integer arguments!"); 4038 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4039 return V; // No conversion 4040 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty)) 4041 return getTruncateExpr(V, Ty, Depth); 4042 return getZeroExtendExpr(V, Ty, Depth); 4043 } 4044 4045 const SCEV *ScalarEvolution::getTruncateOrSignExtend(const SCEV *V, Type *Ty, 4046 unsigned Depth) { 4047 Type *SrcTy = V->getType(); 4048 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4049 "Cannot truncate or zero extend with non-integer arguments!"); 4050 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4051 return V; // No conversion 4052 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty)) 4053 return getTruncateExpr(V, Ty, Depth); 4054 return getSignExtendExpr(V, Ty, Depth); 4055 } 4056 4057 const SCEV * 4058 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) { 4059 Type *SrcTy = V->getType(); 4060 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4061 "Cannot noop or zero extend with non-integer arguments!"); 4062 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4063 "getNoopOrZeroExtend cannot truncate!"); 4064 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4065 return V; // No conversion 4066 return getZeroExtendExpr(V, Ty); 4067 } 4068 4069 const SCEV * 4070 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) { 4071 Type *SrcTy = V->getType(); 4072 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4073 "Cannot noop or sign extend with non-integer arguments!"); 4074 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4075 "getNoopOrSignExtend cannot truncate!"); 4076 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4077 return V; // No conversion 4078 return getSignExtendExpr(V, Ty); 4079 } 4080 4081 const SCEV * 4082 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) { 4083 Type *SrcTy = V->getType(); 4084 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4085 "Cannot noop or any extend with non-integer arguments!"); 4086 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4087 "getNoopOrAnyExtend cannot truncate!"); 4088 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4089 return V; // No conversion 4090 return getAnyExtendExpr(V, Ty); 4091 } 4092 4093 const SCEV * 4094 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) { 4095 Type *SrcTy = V->getType(); 4096 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4097 "Cannot truncate or noop with non-integer arguments!"); 4098 assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) && 4099 "getTruncateOrNoop cannot extend!"); 4100 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4101 return V; // No conversion 4102 return getTruncateExpr(V, Ty); 4103 } 4104 4105 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS, 4106 const SCEV *RHS) { 4107 const SCEV *PromotedLHS = LHS; 4108 const SCEV *PromotedRHS = RHS; 4109 4110 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType())) 4111 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType()); 4112 else 4113 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType()); 4114 4115 return getUMaxExpr(PromotedLHS, PromotedRHS); 4116 } 4117 4118 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS, 4119 const SCEV *RHS) { 4120 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 4121 return getUMinFromMismatchedTypes(Ops); 4122 } 4123 4124 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes( 4125 SmallVectorImpl<const SCEV *> &Ops) { 4126 assert(!Ops.empty() && "At least one operand must be!"); 4127 // Trivial case. 4128 if (Ops.size() == 1) 4129 return Ops[0]; 4130 4131 // Find the max type first. 4132 Type *MaxType = nullptr; 4133 for (auto *S : Ops) 4134 if (MaxType) 4135 MaxType = getWiderType(MaxType, S->getType()); 4136 else 4137 MaxType = S->getType(); 4138 assert(MaxType && "Failed to find maximum type!"); 4139 4140 // Extend all ops to max type. 4141 SmallVector<const SCEV *, 2> PromotedOps; 4142 for (auto *S : Ops) 4143 PromotedOps.push_back(getNoopOrZeroExtend(S, MaxType)); 4144 4145 // Generate umin. 4146 return getUMinExpr(PromotedOps); 4147 } 4148 4149 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) { 4150 // A pointer operand may evaluate to a nonpointer expression, such as null. 4151 if (!V->getType()->isPointerTy()) 4152 return V; 4153 4154 while (true) { 4155 if (const SCEVIntegralCastExpr *Cast = dyn_cast<SCEVIntegralCastExpr>(V)) { 4156 V = Cast->getOperand(); 4157 } else if (const SCEVNAryExpr *NAry = dyn_cast<SCEVNAryExpr>(V)) { 4158 const SCEV *PtrOp = nullptr; 4159 for (const SCEV *NAryOp : NAry->operands()) { 4160 if (NAryOp->getType()->isPointerTy()) { 4161 // Cannot find the base of an expression with multiple pointer ops. 4162 if (PtrOp) 4163 return V; 4164 PtrOp = NAryOp; 4165 } 4166 } 4167 if (!PtrOp) // All operands were non-pointer. 4168 return V; 4169 V = PtrOp; 4170 } else // Not something we can look further into. 4171 return V; 4172 } 4173 } 4174 4175 /// Push users of the given Instruction onto the given Worklist. 4176 static void 4177 PushDefUseChildren(Instruction *I, 4178 SmallVectorImpl<Instruction *> &Worklist) { 4179 // Push the def-use children onto the Worklist stack. 4180 for (User *U : I->users()) 4181 Worklist.push_back(cast<Instruction>(U)); 4182 } 4183 4184 void ScalarEvolution::forgetSymbolicName(Instruction *PN, const SCEV *SymName) { 4185 SmallVector<Instruction *, 16> Worklist; 4186 PushDefUseChildren(PN, Worklist); 4187 4188 SmallPtrSet<Instruction *, 8> Visited; 4189 Visited.insert(PN); 4190 while (!Worklist.empty()) { 4191 Instruction *I = Worklist.pop_back_val(); 4192 if (!Visited.insert(I).second) 4193 continue; 4194 4195 auto It = ValueExprMap.find_as(static_cast<Value *>(I)); 4196 if (It != ValueExprMap.end()) { 4197 const SCEV *Old = It->second; 4198 4199 // Short-circuit the def-use traversal if the symbolic name 4200 // ceases to appear in expressions. 4201 if (Old != SymName && !hasOperand(Old, SymName)) 4202 continue; 4203 4204 // SCEVUnknown for a PHI either means that it has an unrecognized 4205 // structure, it's a PHI that's in the progress of being computed 4206 // by createNodeForPHI, or it's a single-value PHI. In the first case, 4207 // additional loop trip count information isn't going to change anything. 4208 // In the second case, createNodeForPHI will perform the necessary 4209 // updates on its own when it gets to that point. In the third, we do 4210 // want to forget the SCEVUnknown. 4211 if (!isa<PHINode>(I) || 4212 !isa<SCEVUnknown>(Old) || 4213 (I != PN && Old == SymName)) { 4214 eraseValueFromMap(It->first); 4215 forgetMemoizedResults(Old); 4216 } 4217 } 4218 4219 PushDefUseChildren(I, Worklist); 4220 } 4221 } 4222 4223 namespace { 4224 4225 /// Takes SCEV S and Loop L. For each AddRec sub-expression, use its start 4226 /// expression in case its Loop is L. If it is not L then 4227 /// if IgnoreOtherLoops is true then use AddRec itself 4228 /// otherwise rewrite cannot be done. 4229 /// If SCEV contains non-invariant unknown SCEV rewrite cannot be done. 4230 class SCEVInitRewriter : public SCEVRewriteVisitor<SCEVInitRewriter> { 4231 public: 4232 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE, 4233 bool IgnoreOtherLoops = true) { 4234 SCEVInitRewriter Rewriter(L, SE); 4235 const SCEV *Result = Rewriter.visit(S); 4236 if (Rewriter.hasSeenLoopVariantSCEVUnknown()) 4237 return SE.getCouldNotCompute(); 4238 return Rewriter.hasSeenOtherLoops() && !IgnoreOtherLoops 4239 ? SE.getCouldNotCompute() 4240 : Result; 4241 } 4242 4243 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4244 if (!SE.isLoopInvariant(Expr, L)) 4245 SeenLoopVariantSCEVUnknown = true; 4246 return Expr; 4247 } 4248 4249 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4250 // Only re-write AddRecExprs for this loop. 4251 if (Expr->getLoop() == L) 4252 return Expr->getStart(); 4253 SeenOtherLoops = true; 4254 return Expr; 4255 } 4256 4257 bool hasSeenLoopVariantSCEVUnknown() { return SeenLoopVariantSCEVUnknown; } 4258 4259 bool hasSeenOtherLoops() { return SeenOtherLoops; } 4260 4261 private: 4262 explicit SCEVInitRewriter(const Loop *L, ScalarEvolution &SE) 4263 : SCEVRewriteVisitor(SE), L(L) {} 4264 4265 const Loop *L; 4266 bool SeenLoopVariantSCEVUnknown = false; 4267 bool SeenOtherLoops = false; 4268 }; 4269 4270 /// Takes SCEV S and Loop L. For each AddRec sub-expression, use its post 4271 /// increment expression in case its Loop is L. If it is not L then 4272 /// use AddRec itself. 4273 /// If SCEV contains non-invariant unknown SCEV rewrite cannot be done. 4274 class SCEVPostIncRewriter : public SCEVRewriteVisitor<SCEVPostIncRewriter> { 4275 public: 4276 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE) { 4277 SCEVPostIncRewriter Rewriter(L, SE); 4278 const SCEV *Result = Rewriter.visit(S); 4279 return Rewriter.hasSeenLoopVariantSCEVUnknown() 4280 ? SE.getCouldNotCompute() 4281 : Result; 4282 } 4283 4284 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4285 if (!SE.isLoopInvariant(Expr, L)) 4286 SeenLoopVariantSCEVUnknown = true; 4287 return Expr; 4288 } 4289 4290 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4291 // Only re-write AddRecExprs for this loop. 4292 if (Expr->getLoop() == L) 4293 return Expr->getPostIncExpr(SE); 4294 SeenOtherLoops = true; 4295 return Expr; 4296 } 4297 4298 bool hasSeenLoopVariantSCEVUnknown() { return SeenLoopVariantSCEVUnknown; } 4299 4300 bool hasSeenOtherLoops() { return SeenOtherLoops; } 4301 4302 private: 4303 explicit SCEVPostIncRewriter(const Loop *L, ScalarEvolution &SE) 4304 : SCEVRewriteVisitor(SE), L(L) {} 4305 4306 const Loop *L; 4307 bool SeenLoopVariantSCEVUnknown = false; 4308 bool SeenOtherLoops = false; 4309 }; 4310 4311 /// This class evaluates the compare condition by matching it against the 4312 /// condition of loop latch. If there is a match we assume a true value 4313 /// for the condition while building SCEV nodes. 4314 class SCEVBackedgeConditionFolder 4315 : public SCEVRewriteVisitor<SCEVBackedgeConditionFolder> { 4316 public: 4317 static const SCEV *rewrite(const SCEV *S, const Loop *L, 4318 ScalarEvolution &SE) { 4319 bool IsPosBECond = false; 4320 Value *BECond = nullptr; 4321 if (BasicBlock *Latch = L->getLoopLatch()) { 4322 BranchInst *BI = dyn_cast<BranchInst>(Latch->getTerminator()); 4323 if (BI && BI->isConditional()) { 4324 assert(BI->getSuccessor(0) != BI->getSuccessor(1) && 4325 "Both outgoing branches should not target same header!"); 4326 BECond = BI->getCondition(); 4327 IsPosBECond = BI->getSuccessor(0) == L->getHeader(); 4328 } else { 4329 return S; 4330 } 4331 } 4332 SCEVBackedgeConditionFolder Rewriter(L, BECond, IsPosBECond, SE); 4333 return Rewriter.visit(S); 4334 } 4335 4336 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4337 const SCEV *Result = Expr; 4338 bool InvariantF = SE.isLoopInvariant(Expr, L); 4339 4340 if (!InvariantF) { 4341 Instruction *I = cast<Instruction>(Expr->getValue()); 4342 switch (I->getOpcode()) { 4343 case Instruction::Select: { 4344 SelectInst *SI = cast<SelectInst>(I); 4345 Optional<const SCEV *> Res = 4346 compareWithBackedgeCondition(SI->getCondition()); 4347 if (Res.hasValue()) { 4348 bool IsOne = cast<SCEVConstant>(Res.getValue())->getValue()->isOne(); 4349 Result = SE.getSCEV(IsOne ? SI->getTrueValue() : SI->getFalseValue()); 4350 } 4351 break; 4352 } 4353 default: { 4354 Optional<const SCEV *> Res = compareWithBackedgeCondition(I); 4355 if (Res.hasValue()) 4356 Result = Res.getValue(); 4357 break; 4358 } 4359 } 4360 } 4361 return Result; 4362 } 4363 4364 private: 4365 explicit SCEVBackedgeConditionFolder(const Loop *L, Value *BECond, 4366 bool IsPosBECond, ScalarEvolution &SE) 4367 : SCEVRewriteVisitor(SE), L(L), BackedgeCond(BECond), 4368 IsPositiveBECond(IsPosBECond) {} 4369 4370 Optional<const SCEV *> compareWithBackedgeCondition(Value *IC); 4371 4372 const Loop *L; 4373 /// Loop back condition. 4374 Value *BackedgeCond = nullptr; 4375 /// Set to true if loop back is on positive branch condition. 4376 bool IsPositiveBECond; 4377 }; 4378 4379 Optional<const SCEV *> 4380 SCEVBackedgeConditionFolder::compareWithBackedgeCondition(Value *IC) { 4381 4382 // If value matches the backedge condition for loop latch, 4383 // then return a constant evolution node based on loopback 4384 // branch taken. 4385 if (BackedgeCond == IC) 4386 return IsPositiveBECond ? SE.getOne(Type::getInt1Ty(SE.getContext())) 4387 : SE.getZero(Type::getInt1Ty(SE.getContext())); 4388 return None; 4389 } 4390 4391 class SCEVShiftRewriter : public SCEVRewriteVisitor<SCEVShiftRewriter> { 4392 public: 4393 static const SCEV *rewrite(const SCEV *S, const Loop *L, 4394 ScalarEvolution &SE) { 4395 SCEVShiftRewriter Rewriter(L, SE); 4396 const SCEV *Result = Rewriter.visit(S); 4397 return Rewriter.isValid() ? Result : SE.getCouldNotCompute(); 4398 } 4399 4400 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4401 // Only allow AddRecExprs for this loop. 4402 if (!SE.isLoopInvariant(Expr, L)) 4403 Valid = false; 4404 return Expr; 4405 } 4406 4407 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4408 if (Expr->getLoop() == L && Expr->isAffine()) 4409 return SE.getMinusSCEV(Expr, Expr->getStepRecurrence(SE)); 4410 Valid = false; 4411 return Expr; 4412 } 4413 4414 bool isValid() { return Valid; } 4415 4416 private: 4417 explicit SCEVShiftRewriter(const Loop *L, ScalarEvolution &SE) 4418 : SCEVRewriteVisitor(SE), L(L) {} 4419 4420 const Loop *L; 4421 bool Valid = true; 4422 }; 4423 4424 } // end anonymous namespace 4425 4426 SCEV::NoWrapFlags 4427 ScalarEvolution::proveNoWrapViaConstantRanges(const SCEVAddRecExpr *AR) { 4428 if (!AR->isAffine()) 4429 return SCEV::FlagAnyWrap; 4430 4431 using OBO = OverflowingBinaryOperator; 4432 4433 SCEV::NoWrapFlags Result = SCEV::FlagAnyWrap; 4434 4435 if (!AR->hasNoSignedWrap()) { 4436 ConstantRange AddRecRange = getSignedRange(AR); 4437 ConstantRange IncRange = getSignedRange(AR->getStepRecurrence(*this)); 4438 4439 auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 4440 Instruction::Add, IncRange, OBO::NoSignedWrap); 4441 if (NSWRegion.contains(AddRecRange)) 4442 Result = ScalarEvolution::setFlags(Result, SCEV::FlagNSW); 4443 } 4444 4445 if (!AR->hasNoUnsignedWrap()) { 4446 ConstantRange AddRecRange = getUnsignedRange(AR); 4447 ConstantRange IncRange = getUnsignedRange(AR->getStepRecurrence(*this)); 4448 4449 auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 4450 Instruction::Add, IncRange, OBO::NoUnsignedWrap); 4451 if (NUWRegion.contains(AddRecRange)) 4452 Result = ScalarEvolution::setFlags(Result, SCEV::FlagNUW); 4453 } 4454 4455 return Result; 4456 } 4457 4458 SCEV::NoWrapFlags 4459 ScalarEvolution::proveNoSignedWrapViaInduction(const SCEVAddRecExpr *AR) { 4460 SCEV::NoWrapFlags Result = AR->getNoWrapFlags(); 4461 4462 if (AR->hasNoSignedWrap()) 4463 return Result; 4464 4465 if (!AR->isAffine()) 4466 return Result; 4467 4468 const SCEV *Step = AR->getStepRecurrence(*this); 4469 const Loop *L = AR->getLoop(); 4470 4471 // Check whether the backedge-taken count is SCEVCouldNotCompute. 4472 // Note that this serves two purposes: It filters out loops that are 4473 // simply not analyzable, and it covers the case where this code is 4474 // being called from within backedge-taken count analysis, such that 4475 // attempting to ask for the backedge-taken count would likely result 4476 // in infinite recursion. In the later case, the analysis code will 4477 // cope with a conservative value, and it will take care to purge 4478 // that value once it has finished. 4479 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 4480 4481 // Normally, in the cases we can prove no-overflow via a 4482 // backedge guarding condition, we can also compute a backedge 4483 // taken count for the loop. The exceptions are assumptions and 4484 // guards present in the loop -- SCEV is not great at exploiting 4485 // these to compute max backedge taken counts, but can still use 4486 // these to prove lack of overflow. Use this fact to avoid 4487 // doing extra work that may not pay off. 4488 4489 if (isa<SCEVCouldNotCompute>(MaxBECount) && !HasGuards && 4490 AC.assumptions().empty()) 4491 return Result; 4492 4493 // If the backedge is guarded by a comparison with the pre-inc value the 4494 // addrec is safe. Also, if the entry is guarded by a comparison with the 4495 // start value and the backedge is guarded by a comparison with the post-inc 4496 // value, the addrec is safe. 4497 ICmpInst::Predicate Pred; 4498 const SCEV *OverflowLimit = 4499 getSignedOverflowLimitForStep(Step, &Pred, this); 4500 if (OverflowLimit && 4501 (isLoopBackedgeGuardedByCond(L, Pred, AR, OverflowLimit) || 4502 isKnownOnEveryIteration(Pred, AR, OverflowLimit))) { 4503 Result = setFlags(Result, SCEV::FlagNSW); 4504 } 4505 return Result; 4506 } 4507 SCEV::NoWrapFlags 4508 ScalarEvolution::proveNoUnsignedWrapViaInduction(const SCEVAddRecExpr *AR) { 4509 SCEV::NoWrapFlags Result = AR->getNoWrapFlags(); 4510 4511 if (AR->hasNoUnsignedWrap()) 4512 return Result; 4513 4514 if (!AR->isAffine()) 4515 return Result; 4516 4517 const SCEV *Step = AR->getStepRecurrence(*this); 4518 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 4519 const Loop *L = AR->getLoop(); 4520 4521 // Check whether the backedge-taken count is SCEVCouldNotCompute. 4522 // Note that this serves two purposes: It filters out loops that are 4523 // simply not analyzable, and it covers the case where this code is 4524 // being called from within backedge-taken count analysis, such that 4525 // attempting to ask for the backedge-taken count would likely result 4526 // in infinite recursion. In the later case, the analysis code will 4527 // cope with a conservative value, and it will take care to purge 4528 // that value once it has finished. 4529 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 4530 4531 // Normally, in the cases we can prove no-overflow via a 4532 // backedge guarding condition, we can also compute a backedge 4533 // taken count for the loop. The exceptions are assumptions and 4534 // guards present in the loop -- SCEV is not great at exploiting 4535 // these to compute max backedge taken counts, but can still use 4536 // these to prove lack of overflow. Use this fact to avoid 4537 // doing extra work that may not pay off. 4538 4539 if (isa<SCEVCouldNotCompute>(MaxBECount) && !HasGuards && 4540 AC.assumptions().empty()) 4541 return Result; 4542 4543 // If the backedge is guarded by a comparison with the pre-inc value the 4544 // addrec is safe. Also, if the entry is guarded by a comparison with the 4545 // start value and the backedge is guarded by a comparison with the post-inc 4546 // value, the addrec is safe. 4547 if (isKnownPositive(Step)) { 4548 const SCEV *N = getConstant(APInt::getMinValue(BitWidth) - 4549 getUnsignedRangeMax(Step)); 4550 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) || 4551 isKnownOnEveryIteration(ICmpInst::ICMP_ULT, AR, N)) { 4552 Result = setFlags(Result, SCEV::FlagNUW); 4553 } 4554 } 4555 4556 return Result; 4557 } 4558 4559 namespace { 4560 4561 /// Represents an abstract binary operation. This may exist as a 4562 /// normal instruction or constant expression, or may have been 4563 /// derived from an expression tree. 4564 struct BinaryOp { 4565 unsigned Opcode; 4566 Value *LHS; 4567 Value *RHS; 4568 bool IsNSW = false; 4569 bool IsNUW = false; 4570 4571 /// Op is set if this BinaryOp corresponds to a concrete LLVM instruction or 4572 /// constant expression. 4573 Operator *Op = nullptr; 4574 4575 explicit BinaryOp(Operator *Op) 4576 : Opcode(Op->getOpcode()), LHS(Op->getOperand(0)), RHS(Op->getOperand(1)), 4577 Op(Op) { 4578 if (auto *OBO = dyn_cast<OverflowingBinaryOperator>(Op)) { 4579 IsNSW = OBO->hasNoSignedWrap(); 4580 IsNUW = OBO->hasNoUnsignedWrap(); 4581 } 4582 } 4583 4584 explicit BinaryOp(unsigned Opcode, Value *LHS, Value *RHS, bool IsNSW = false, 4585 bool IsNUW = false) 4586 : Opcode(Opcode), LHS(LHS), RHS(RHS), IsNSW(IsNSW), IsNUW(IsNUW) {} 4587 }; 4588 4589 } // end anonymous namespace 4590 4591 /// Try to map \p V into a BinaryOp, and return \c None on failure. 4592 static Optional<BinaryOp> MatchBinaryOp(Value *V, DominatorTree &DT) { 4593 auto *Op = dyn_cast<Operator>(V); 4594 if (!Op) 4595 return None; 4596 4597 // Implementation detail: all the cleverness here should happen without 4598 // creating new SCEV expressions -- our caller knowns tricks to avoid creating 4599 // SCEV expressions when possible, and we should not break that. 4600 4601 switch (Op->getOpcode()) { 4602 case Instruction::Add: 4603 case Instruction::Sub: 4604 case Instruction::Mul: 4605 case Instruction::UDiv: 4606 case Instruction::URem: 4607 case Instruction::And: 4608 case Instruction::Or: 4609 case Instruction::AShr: 4610 case Instruction::Shl: 4611 return BinaryOp(Op); 4612 4613 case Instruction::Xor: 4614 if (auto *RHSC = dyn_cast<ConstantInt>(Op->getOperand(1))) 4615 // If the RHS of the xor is a signmask, then this is just an add. 4616 // Instcombine turns add of signmask into xor as a strength reduction step. 4617 if (RHSC->getValue().isSignMask()) 4618 return BinaryOp(Instruction::Add, Op->getOperand(0), Op->getOperand(1)); 4619 return BinaryOp(Op); 4620 4621 case Instruction::LShr: 4622 // Turn logical shift right of a constant into a unsigned divide. 4623 if (ConstantInt *SA = dyn_cast<ConstantInt>(Op->getOperand(1))) { 4624 uint32_t BitWidth = cast<IntegerType>(Op->getType())->getBitWidth(); 4625 4626 // If the shift count is not less than the bitwidth, the result of 4627 // the shift is undefined. Don't try to analyze it, because the 4628 // resolution chosen here may differ from the resolution chosen in 4629 // other parts of the compiler. 4630 if (SA->getValue().ult(BitWidth)) { 4631 Constant *X = 4632 ConstantInt::get(SA->getContext(), 4633 APInt::getOneBitSet(BitWidth, SA->getZExtValue())); 4634 return BinaryOp(Instruction::UDiv, Op->getOperand(0), X); 4635 } 4636 } 4637 return BinaryOp(Op); 4638 4639 case Instruction::ExtractValue: { 4640 auto *EVI = cast<ExtractValueInst>(Op); 4641 if (EVI->getNumIndices() != 1 || EVI->getIndices()[0] != 0) 4642 break; 4643 4644 auto *WO = dyn_cast<WithOverflowInst>(EVI->getAggregateOperand()); 4645 if (!WO) 4646 break; 4647 4648 Instruction::BinaryOps BinOp = WO->getBinaryOp(); 4649 bool Signed = WO->isSigned(); 4650 // TODO: Should add nuw/nsw flags for mul as well. 4651 if (BinOp == Instruction::Mul || !isOverflowIntrinsicNoWrap(WO, DT)) 4652 return BinaryOp(BinOp, WO->getLHS(), WO->getRHS()); 4653 4654 // Now that we know that all uses of the arithmetic-result component of 4655 // CI are guarded by the overflow check, we can go ahead and pretend 4656 // that the arithmetic is non-overflowing. 4657 return BinaryOp(BinOp, WO->getLHS(), WO->getRHS(), 4658 /* IsNSW = */ Signed, /* IsNUW = */ !Signed); 4659 } 4660 4661 default: 4662 break; 4663 } 4664 4665 // Recognise intrinsic loop.decrement.reg, and as this has exactly the same 4666 // semantics as a Sub, return a binary sub expression. 4667 if (auto *II = dyn_cast<IntrinsicInst>(V)) 4668 if (II->getIntrinsicID() == Intrinsic::loop_decrement_reg) 4669 return BinaryOp(Instruction::Sub, II->getOperand(0), II->getOperand(1)); 4670 4671 return None; 4672 } 4673 4674 /// Helper function to createAddRecFromPHIWithCasts. We have a phi 4675 /// node whose symbolic (unknown) SCEV is \p SymbolicPHI, which is updated via 4676 /// the loop backedge by a SCEVAddExpr, possibly also with a few casts on the 4677 /// way. This function checks if \p Op, an operand of this SCEVAddExpr, 4678 /// follows one of the following patterns: 4679 /// Op == (SExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) 4680 /// Op == (ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) 4681 /// If the SCEV expression of \p Op conforms with one of the expected patterns 4682 /// we return the type of the truncation operation, and indicate whether the 4683 /// truncated type should be treated as signed/unsigned by setting 4684 /// \p Signed to true/false, respectively. 4685 static Type *isSimpleCastedPHI(const SCEV *Op, const SCEVUnknown *SymbolicPHI, 4686 bool &Signed, ScalarEvolution &SE) { 4687 // The case where Op == SymbolicPHI (that is, with no type conversions on 4688 // the way) is handled by the regular add recurrence creating logic and 4689 // would have already been triggered in createAddRecForPHI. Reaching it here 4690 // means that createAddRecFromPHI had failed for this PHI before (e.g., 4691 // because one of the other operands of the SCEVAddExpr updating this PHI is 4692 // not invariant). 4693 // 4694 // Here we look for the case where Op = (ext(trunc(SymbolicPHI))), and in 4695 // this case predicates that allow us to prove that Op == SymbolicPHI will 4696 // be added. 4697 if (Op == SymbolicPHI) 4698 return nullptr; 4699 4700 unsigned SourceBits = SE.getTypeSizeInBits(SymbolicPHI->getType()); 4701 unsigned NewBits = SE.getTypeSizeInBits(Op->getType()); 4702 if (SourceBits != NewBits) 4703 return nullptr; 4704 4705 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(Op); 4706 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(Op); 4707 if (!SExt && !ZExt) 4708 return nullptr; 4709 const SCEVTruncateExpr *Trunc = 4710 SExt ? dyn_cast<SCEVTruncateExpr>(SExt->getOperand()) 4711 : dyn_cast<SCEVTruncateExpr>(ZExt->getOperand()); 4712 if (!Trunc) 4713 return nullptr; 4714 const SCEV *X = Trunc->getOperand(); 4715 if (X != SymbolicPHI) 4716 return nullptr; 4717 Signed = SExt != nullptr; 4718 return Trunc->getType(); 4719 } 4720 4721 static const Loop *isIntegerLoopHeaderPHI(const PHINode *PN, LoopInfo &LI) { 4722 if (!PN->getType()->isIntegerTy()) 4723 return nullptr; 4724 const Loop *L = LI.getLoopFor(PN->getParent()); 4725 if (!L || L->getHeader() != PN->getParent()) 4726 return nullptr; 4727 return L; 4728 } 4729 4730 // Analyze \p SymbolicPHI, a SCEV expression of a phi node, and check if the 4731 // computation that updates the phi follows the following pattern: 4732 // (SExt/ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) + InvariantAccum 4733 // which correspond to a phi->trunc->sext/zext->add->phi update chain. 4734 // If so, try to see if it can be rewritten as an AddRecExpr under some 4735 // Predicates. If successful, return them as a pair. Also cache the results 4736 // of the analysis. 4737 // 4738 // Example usage scenario: 4739 // Say the Rewriter is called for the following SCEV: 4740 // 8 * ((sext i32 (trunc i64 %X to i32) to i64) + %Step) 4741 // where: 4742 // %X = phi i64 (%Start, %BEValue) 4743 // It will visitMul->visitAdd->visitSExt->visitTrunc->visitUnknown(%X), 4744 // and call this function with %SymbolicPHI = %X. 4745 // 4746 // The analysis will find that the value coming around the backedge has 4747 // the following SCEV: 4748 // BEValue = ((sext i32 (trunc i64 %X to i32) to i64) + %Step) 4749 // Upon concluding that this matches the desired pattern, the function 4750 // will return the pair {NewAddRec, SmallPredsVec} where: 4751 // NewAddRec = {%Start,+,%Step} 4752 // SmallPredsVec = {P1, P2, P3} as follows: 4753 // P1(WrapPred): AR: {trunc(%Start),+,(trunc %Step)}<nsw> Flags: <nssw> 4754 // P2(EqualPred): %Start == (sext i32 (trunc i64 %Start to i32) to i64) 4755 // P3(EqualPred): %Step == (sext i32 (trunc i64 %Step to i32) to i64) 4756 // The returned pair means that SymbolicPHI can be rewritten into NewAddRec 4757 // under the predicates {P1,P2,P3}. 4758 // This predicated rewrite will be cached in PredicatedSCEVRewrites: 4759 // PredicatedSCEVRewrites[{%X,L}] = {NewAddRec, {P1,P2,P3)} 4760 // 4761 // TODO's: 4762 // 4763 // 1) Extend the Induction descriptor to also support inductions that involve 4764 // casts: When needed (namely, when we are called in the context of the 4765 // vectorizer induction analysis), a Set of cast instructions will be 4766 // populated by this method, and provided back to isInductionPHI. This is 4767 // needed to allow the vectorizer to properly record them to be ignored by 4768 // the cost model and to avoid vectorizing them (otherwise these casts, 4769 // which are redundant under the runtime overflow checks, will be 4770 // vectorized, which can be costly). 4771 // 4772 // 2) Support additional induction/PHISCEV patterns: We also want to support 4773 // inductions where the sext-trunc / zext-trunc operations (partly) occur 4774 // after the induction update operation (the induction increment): 4775 // 4776 // (Trunc iy (SExt/ZExt ix (%SymbolicPHI + InvariantAccum) to iy) to ix) 4777 // which correspond to a phi->add->trunc->sext/zext->phi update chain. 4778 // 4779 // (Trunc iy ((SExt/ZExt ix (%SymbolicPhi) to iy) + InvariantAccum) to ix) 4780 // which correspond to a phi->trunc->add->sext/zext->phi update chain. 4781 // 4782 // 3) Outline common code with createAddRecFromPHI to avoid duplication. 4783 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 4784 ScalarEvolution::createAddRecFromPHIWithCastsImpl(const SCEVUnknown *SymbolicPHI) { 4785 SmallVector<const SCEVPredicate *, 3> Predicates; 4786 4787 // *** Part1: Analyze if we have a phi-with-cast pattern for which we can 4788 // return an AddRec expression under some predicate. 4789 4790 auto *PN = cast<PHINode>(SymbolicPHI->getValue()); 4791 const Loop *L = isIntegerLoopHeaderPHI(PN, LI); 4792 assert(L && "Expecting an integer loop header phi"); 4793 4794 // The loop may have multiple entrances or multiple exits; we can analyze 4795 // this phi as an addrec if it has a unique entry value and a unique 4796 // backedge value. 4797 Value *BEValueV = nullptr, *StartValueV = nullptr; 4798 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 4799 Value *V = PN->getIncomingValue(i); 4800 if (L->contains(PN->getIncomingBlock(i))) { 4801 if (!BEValueV) { 4802 BEValueV = V; 4803 } else if (BEValueV != V) { 4804 BEValueV = nullptr; 4805 break; 4806 } 4807 } else if (!StartValueV) { 4808 StartValueV = V; 4809 } else if (StartValueV != V) { 4810 StartValueV = nullptr; 4811 break; 4812 } 4813 } 4814 if (!BEValueV || !StartValueV) 4815 return None; 4816 4817 const SCEV *BEValue = getSCEV(BEValueV); 4818 4819 // If the value coming around the backedge is an add with the symbolic 4820 // value we just inserted, possibly with casts that we can ignore under 4821 // an appropriate runtime guard, then we found a simple induction variable! 4822 const auto *Add = dyn_cast<SCEVAddExpr>(BEValue); 4823 if (!Add) 4824 return None; 4825 4826 // If there is a single occurrence of the symbolic value, possibly 4827 // casted, replace it with a recurrence. 4828 unsigned FoundIndex = Add->getNumOperands(); 4829 Type *TruncTy = nullptr; 4830 bool Signed; 4831 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 4832 if ((TruncTy = 4833 isSimpleCastedPHI(Add->getOperand(i), SymbolicPHI, Signed, *this))) 4834 if (FoundIndex == e) { 4835 FoundIndex = i; 4836 break; 4837 } 4838 4839 if (FoundIndex == Add->getNumOperands()) 4840 return None; 4841 4842 // Create an add with everything but the specified operand. 4843 SmallVector<const SCEV *, 8> Ops; 4844 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 4845 if (i != FoundIndex) 4846 Ops.push_back(Add->getOperand(i)); 4847 const SCEV *Accum = getAddExpr(Ops); 4848 4849 // The runtime checks will not be valid if the step amount is 4850 // varying inside the loop. 4851 if (!isLoopInvariant(Accum, L)) 4852 return None; 4853 4854 // *** Part2: Create the predicates 4855 4856 // Analysis was successful: we have a phi-with-cast pattern for which we 4857 // can return an AddRec expression under the following predicates: 4858 // 4859 // P1: A Wrap predicate that guarantees that Trunc(Start) + i*Trunc(Accum) 4860 // fits within the truncated type (does not overflow) for i = 0 to n-1. 4861 // P2: An Equal predicate that guarantees that 4862 // Start = (Ext ix (Trunc iy (Start) to ix) to iy) 4863 // P3: An Equal predicate that guarantees that 4864 // Accum = (Ext ix (Trunc iy (Accum) to ix) to iy) 4865 // 4866 // As we next prove, the above predicates guarantee that: 4867 // Start + i*Accum = (Ext ix (Trunc iy ( Start + i*Accum ) to ix) to iy) 4868 // 4869 // 4870 // More formally, we want to prove that: 4871 // Expr(i+1) = Start + (i+1) * Accum 4872 // = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum 4873 // 4874 // Given that: 4875 // 1) Expr(0) = Start 4876 // 2) Expr(1) = Start + Accum 4877 // = (Ext ix (Trunc iy (Start) to ix) to iy) + Accum :: from P2 4878 // 3) Induction hypothesis (step i): 4879 // Expr(i) = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum 4880 // 4881 // Proof: 4882 // Expr(i+1) = 4883 // = Start + (i+1)*Accum 4884 // = (Start + i*Accum) + Accum 4885 // = Expr(i) + Accum 4886 // = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum + Accum 4887 // :: from step i 4888 // 4889 // = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy) + Accum + Accum 4890 // 4891 // = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy) 4892 // + (Ext ix (Trunc iy (Accum) to ix) to iy) 4893 // + Accum :: from P3 4894 // 4895 // = (Ext ix (Trunc iy ((Start + (i-1)*Accum) + Accum) to ix) to iy) 4896 // + Accum :: from P1: Ext(x)+Ext(y)=>Ext(x+y) 4897 // 4898 // = (Ext ix (Trunc iy (Start + i*Accum) to ix) to iy) + Accum 4899 // = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum 4900 // 4901 // By induction, the same applies to all iterations 1<=i<n: 4902 // 4903 4904 // Create a truncated addrec for which we will add a no overflow check (P1). 4905 const SCEV *StartVal = getSCEV(StartValueV); 4906 const SCEV *PHISCEV = 4907 getAddRecExpr(getTruncateExpr(StartVal, TruncTy), 4908 getTruncateExpr(Accum, TruncTy), L, SCEV::FlagAnyWrap); 4909 4910 // PHISCEV can be either a SCEVConstant or a SCEVAddRecExpr. 4911 // ex: If truncated Accum is 0 and StartVal is a constant, then PHISCEV 4912 // will be constant. 4913 // 4914 // If PHISCEV is a constant, then P1 degenerates into P2 or P3, so we don't 4915 // add P1. 4916 if (const auto *AR = dyn_cast<SCEVAddRecExpr>(PHISCEV)) { 4917 SCEVWrapPredicate::IncrementWrapFlags AddedFlags = 4918 Signed ? SCEVWrapPredicate::IncrementNSSW 4919 : SCEVWrapPredicate::IncrementNUSW; 4920 const SCEVPredicate *AddRecPred = getWrapPredicate(AR, AddedFlags); 4921 Predicates.push_back(AddRecPred); 4922 } 4923 4924 // Create the Equal Predicates P2,P3: 4925 4926 // It is possible that the predicates P2 and/or P3 are computable at 4927 // compile time due to StartVal and/or Accum being constants. 4928 // If either one is, then we can check that now and escape if either P2 4929 // or P3 is false. 4930 4931 // Construct the extended SCEV: (Ext ix (Trunc iy (Expr) to ix) to iy) 4932 // for each of StartVal and Accum 4933 auto getExtendedExpr = [&](const SCEV *Expr, 4934 bool CreateSignExtend) -> const SCEV * { 4935 assert(isLoopInvariant(Expr, L) && "Expr is expected to be invariant"); 4936 const SCEV *TruncatedExpr = getTruncateExpr(Expr, TruncTy); 4937 const SCEV *ExtendedExpr = 4938 CreateSignExtend ? getSignExtendExpr(TruncatedExpr, Expr->getType()) 4939 : getZeroExtendExpr(TruncatedExpr, Expr->getType()); 4940 return ExtendedExpr; 4941 }; 4942 4943 // Given: 4944 // ExtendedExpr = (Ext ix (Trunc iy (Expr) to ix) to iy 4945 // = getExtendedExpr(Expr) 4946 // Determine whether the predicate P: Expr == ExtendedExpr 4947 // is known to be false at compile time 4948 auto PredIsKnownFalse = [&](const SCEV *Expr, 4949 const SCEV *ExtendedExpr) -> bool { 4950 return Expr != ExtendedExpr && 4951 isKnownPredicate(ICmpInst::ICMP_NE, Expr, ExtendedExpr); 4952 }; 4953 4954 const SCEV *StartExtended = getExtendedExpr(StartVal, Signed); 4955 if (PredIsKnownFalse(StartVal, StartExtended)) { 4956 LLVM_DEBUG(dbgs() << "P2 is compile-time false\n";); 4957 return None; 4958 } 4959 4960 // The Step is always Signed (because the overflow checks are either 4961 // NSSW or NUSW) 4962 const SCEV *AccumExtended = getExtendedExpr(Accum, /*CreateSignExtend=*/true); 4963 if (PredIsKnownFalse(Accum, AccumExtended)) { 4964 LLVM_DEBUG(dbgs() << "P3 is compile-time false\n";); 4965 return None; 4966 } 4967 4968 auto AppendPredicate = [&](const SCEV *Expr, 4969 const SCEV *ExtendedExpr) -> void { 4970 if (Expr != ExtendedExpr && 4971 !isKnownPredicate(ICmpInst::ICMP_EQ, Expr, ExtendedExpr)) { 4972 const SCEVPredicate *Pred = getEqualPredicate(Expr, ExtendedExpr); 4973 LLVM_DEBUG(dbgs() << "Added Predicate: " << *Pred); 4974 Predicates.push_back(Pred); 4975 } 4976 }; 4977 4978 AppendPredicate(StartVal, StartExtended); 4979 AppendPredicate(Accum, AccumExtended); 4980 4981 // *** Part3: Predicates are ready. Now go ahead and create the new addrec in 4982 // which the casts had been folded away. The caller can rewrite SymbolicPHI 4983 // into NewAR if it will also add the runtime overflow checks specified in 4984 // Predicates. 4985 auto *NewAR = getAddRecExpr(StartVal, Accum, L, SCEV::FlagAnyWrap); 4986 4987 std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> PredRewrite = 4988 std::make_pair(NewAR, Predicates); 4989 // Remember the result of the analysis for this SCEV at this locayyytion. 4990 PredicatedSCEVRewrites[{SymbolicPHI, L}] = PredRewrite; 4991 return PredRewrite; 4992 } 4993 4994 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 4995 ScalarEvolution::createAddRecFromPHIWithCasts(const SCEVUnknown *SymbolicPHI) { 4996 auto *PN = cast<PHINode>(SymbolicPHI->getValue()); 4997 const Loop *L = isIntegerLoopHeaderPHI(PN, LI); 4998 if (!L) 4999 return None; 5000 5001 // Check to see if we already analyzed this PHI. 5002 auto I = PredicatedSCEVRewrites.find({SymbolicPHI, L}); 5003 if (I != PredicatedSCEVRewrites.end()) { 5004 std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> Rewrite = 5005 I->second; 5006 // Analysis was done before and failed to create an AddRec: 5007 if (Rewrite.first == SymbolicPHI) 5008 return None; 5009 // Analysis was done before and succeeded to create an AddRec under 5010 // a predicate: 5011 assert(isa<SCEVAddRecExpr>(Rewrite.first) && "Expected an AddRec"); 5012 assert(!(Rewrite.second).empty() && "Expected to find Predicates"); 5013 return Rewrite; 5014 } 5015 5016 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 5017 Rewrite = createAddRecFromPHIWithCastsImpl(SymbolicPHI); 5018 5019 // Record in the cache that the analysis failed 5020 if (!Rewrite) { 5021 SmallVector<const SCEVPredicate *, 3> Predicates; 5022 PredicatedSCEVRewrites[{SymbolicPHI, L}] = {SymbolicPHI, Predicates}; 5023 return None; 5024 } 5025 5026 return Rewrite; 5027 } 5028 5029 // FIXME: This utility is currently required because the Rewriter currently 5030 // does not rewrite this expression: 5031 // {0, +, (sext ix (trunc iy to ix) to iy)} 5032 // into {0, +, %step}, 5033 // even when the following Equal predicate exists: 5034 // "%step == (sext ix (trunc iy to ix) to iy)". 5035 bool PredicatedScalarEvolution::areAddRecsEqualWithPreds( 5036 const SCEVAddRecExpr *AR1, const SCEVAddRecExpr *AR2) const { 5037 if (AR1 == AR2) 5038 return true; 5039 5040 auto areExprsEqual = [&](const SCEV *Expr1, const SCEV *Expr2) -> bool { 5041 if (Expr1 != Expr2 && !Preds.implies(SE.getEqualPredicate(Expr1, Expr2)) && 5042 !Preds.implies(SE.getEqualPredicate(Expr2, Expr1))) 5043 return false; 5044 return true; 5045 }; 5046 5047 if (!areExprsEqual(AR1->getStart(), AR2->getStart()) || 5048 !areExprsEqual(AR1->getStepRecurrence(SE), AR2->getStepRecurrence(SE))) 5049 return false; 5050 return true; 5051 } 5052 5053 /// A helper function for createAddRecFromPHI to handle simple cases. 5054 /// 5055 /// This function tries to find an AddRec expression for the simplest (yet most 5056 /// common) cases: PN = PHI(Start, OP(Self, LoopInvariant)). 5057 /// If it fails, createAddRecFromPHI will use a more general, but slow, 5058 /// technique for finding the AddRec expression. 5059 const SCEV *ScalarEvolution::createSimpleAffineAddRec(PHINode *PN, 5060 Value *BEValueV, 5061 Value *StartValueV) { 5062 const Loop *L = LI.getLoopFor(PN->getParent()); 5063 assert(L && L->getHeader() == PN->getParent()); 5064 assert(BEValueV && StartValueV); 5065 5066 auto BO = MatchBinaryOp(BEValueV, DT); 5067 if (!BO) 5068 return nullptr; 5069 5070 if (BO->Opcode != Instruction::Add) 5071 return nullptr; 5072 5073 const SCEV *Accum = nullptr; 5074 if (BO->LHS == PN && L->isLoopInvariant(BO->RHS)) 5075 Accum = getSCEV(BO->RHS); 5076 else if (BO->RHS == PN && L->isLoopInvariant(BO->LHS)) 5077 Accum = getSCEV(BO->LHS); 5078 5079 if (!Accum) 5080 return nullptr; 5081 5082 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 5083 if (BO->IsNUW) 5084 Flags = setFlags(Flags, SCEV::FlagNUW); 5085 if (BO->IsNSW) 5086 Flags = setFlags(Flags, SCEV::FlagNSW); 5087 5088 const SCEV *StartVal = getSCEV(StartValueV); 5089 const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags); 5090 5091 ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV; 5092 5093 // We can add Flags to the post-inc expression only if we 5094 // know that it is *undefined behavior* for BEValueV to 5095 // overflow. 5096 if (auto *BEInst = dyn_cast<Instruction>(BEValueV)) 5097 if (isLoopInvariant(Accum, L) && isAddRecNeverPoison(BEInst, L)) 5098 (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags); 5099 5100 return PHISCEV; 5101 } 5102 5103 const SCEV *ScalarEvolution::createAddRecFromPHI(PHINode *PN) { 5104 const Loop *L = LI.getLoopFor(PN->getParent()); 5105 if (!L || L->getHeader() != PN->getParent()) 5106 return nullptr; 5107 5108 // The loop may have multiple entrances or multiple exits; we can analyze 5109 // this phi as an addrec if it has a unique entry value and a unique 5110 // backedge value. 5111 Value *BEValueV = nullptr, *StartValueV = nullptr; 5112 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 5113 Value *V = PN->getIncomingValue(i); 5114 if (L->contains(PN->getIncomingBlock(i))) { 5115 if (!BEValueV) { 5116 BEValueV = V; 5117 } else if (BEValueV != V) { 5118 BEValueV = nullptr; 5119 break; 5120 } 5121 } else if (!StartValueV) { 5122 StartValueV = V; 5123 } else if (StartValueV != V) { 5124 StartValueV = nullptr; 5125 break; 5126 } 5127 } 5128 if (!BEValueV || !StartValueV) 5129 return nullptr; 5130 5131 assert(ValueExprMap.find_as(PN) == ValueExprMap.end() && 5132 "PHI node already processed?"); 5133 5134 // First, try to find AddRec expression without creating a fictituos symbolic 5135 // value for PN. 5136 if (auto *S = createSimpleAffineAddRec(PN, BEValueV, StartValueV)) 5137 return S; 5138 5139 // Handle PHI node value symbolically. 5140 const SCEV *SymbolicName = getUnknown(PN); 5141 ValueExprMap.insert({SCEVCallbackVH(PN, this), SymbolicName}); 5142 5143 // Using this symbolic name for the PHI, analyze the value coming around 5144 // the back-edge. 5145 const SCEV *BEValue = getSCEV(BEValueV); 5146 5147 // NOTE: If BEValue is loop invariant, we know that the PHI node just 5148 // has a special value for the first iteration of the loop. 5149 5150 // If the value coming around the backedge is an add with the symbolic 5151 // value we just inserted, then we found a simple induction variable! 5152 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) { 5153 // If there is a single occurrence of the symbolic value, replace it 5154 // with a recurrence. 5155 unsigned FoundIndex = Add->getNumOperands(); 5156 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5157 if (Add->getOperand(i) == SymbolicName) 5158 if (FoundIndex == e) { 5159 FoundIndex = i; 5160 break; 5161 } 5162 5163 if (FoundIndex != Add->getNumOperands()) { 5164 // Create an add with everything but the specified operand. 5165 SmallVector<const SCEV *, 8> Ops; 5166 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5167 if (i != FoundIndex) 5168 Ops.push_back(SCEVBackedgeConditionFolder::rewrite(Add->getOperand(i), 5169 L, *this)); 5170 const SCEV *Accum = getAddExpr(Ops); 5171 5172 // This is not a valid addrec if the step amount is varying each 5173 // loop iteration, but is not itself an addrec in this loop. 5174 if (isLoopInvariant(Accum, L) || 5175 (isa<SCEVAddRecExpr>(Accum) && 5176 cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) { 5177 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 5178 5179 if (auto BO = MatchBinaryOp(BEValueV, DT)) { 5180 if (BO->Opcode == Instruction::Add && BO->LHS == PN) { 5181 if (BO->IsNUW) 5182 Flags = setFlags(Flags, SCEV::FlagNUW); 5183 if (BO->IsNSW) 5184 Flags = setFlags(Flags, SCEV::FlagNSW); 5185 } 5186 } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) { 5187 // If the increment is an inbounds GEP, then we know the address 5188 // space cannot be wrapped around. We cannot make any guarantee 5189 // about signed or unsigned overflow because pointers are 5190 // unsigned but we may have a negative index from the base 5191 // pointer. We can guarantee that no unsigned wrap occurs if the 5192 // indices form a positive value. 5193 if (GEP->isInBounds() && GEP->getOperand(0) == PN) { 5194 Flags = setFlags(Flags, SCEV::FlagNW); 5195 5196 const SCEV *Ptr = getSCEV(GEP->getPointerOperand()); 5197 if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr))) 5198 Flags = setFlags(Flags, SCEV::FlagNUW); 5199 } 5200 5201 // We cannot transfer nuw and nsw flags from subtraction 5202 // operations -- sub nuw X, Y is not the same as add nuw X, -Y 5203 // for instance. 5204 } 5205 5206 const SCEV *StartVal = getSCEV(StartValueV); 5207 const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags); 5208 5209 // Okay, for the entire analysis of this edge we assumed the PHI 5210 // to be symbolic. We now need to go back and purge all of the 5211 // entries for the scalars that use the symbolic expression. 5212 forgetSymbolicName(PN, SymbolicName); 5213 ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV; 5214 5215 // We can add Flags to the post-inc expression only if we 5216 // know that it is *undefined behavior* for BEValueV to 5217 // overflow. 5218 if (auto *BEInst = dyn_cast<Instruction>(BEValueV)) 5219 if (isLoopInvariant(Accum, L) && isAddRecNeverPoison(BEInst, L)) 5220 (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags); 5221 5222 return PHISCEV; 5223 } 5224 } 5225 } else { 5226 // Otherwise, this could be a loop like this: 5227 // i = 0; for (j = 1; ..; ++j) { .... i = j; } 5228 // In this case, j = {1,+,1} and BEValue is j. 5229 // Because the other in-value of i (0) fits the evolution of BEValue 5230 // i really is an addrec evolution. 5231 // 5232 // We can generalize this saying that i is the shifted value of BEValue 5233 // by one iteration: 5234 // PHI(f(0), f({1,+,1})) --> f({0,+,1}) 5235 const SCEV *Shifted = SCEVShiftRewriter::rewrite(BEValue, L, *this); 5236 const SCEV *Start = SCEVInitRewriter::rewrite(Shifted, L, *this, false); 5237 if (Shifted != getCouldNotCompute() && 5238 Start != getCouldNotCompute()) { 5239 const SCEV *StartVal = getSCEV(StartValueV); 5240 if (Start == StartVal) { 5241 // Okay, for the entire analysis of this edge we assumed the PHI 5242 // to be symbolic. We now need to go back and purge all of the 5243 // entries for the scalars that use the symbolic expression. 5244 forgetSymbolicName(PN, SymbolicName); 5245 ValueExprMap[SCEVCallbackVH(PN, this)] = Shifted; 5246 return Shifted; 5247 } 5248 } 5249 } 5250 5251 // Remove the temporary PHI node SCEV that has been inserted while intending 5252 // to create an AddRecExpr for this PHI node. We can not keep this temporary 5253 // as it will prevent later (possibly simpler) SCEV expressions to be added 5254 // to the ValueExprMap. 5255 eraseValueFromMap(PN); 5256 5257 return nullptr; 5258 } 5259 5260 // Checks if the SCEV S is available at BB. S is considered available at BB 5261 // if S can be materialized at BB without introducing a fault. 5262 static bool IsAvailableOnEntry(const Loop *L, DominatorTree &DT, const SCEV *S, 5263 BasicBlock *BB) { 5264 struct CheckAvailable { 5265 bool TraversalDone = false; 5266 bool Available = true; 5267 5268 const Loop *L = nullptr; // The loop BB is in (can be nullptr) 5269 BasicBlock *BB = nullptr; 5270 DominatorTree &DT; 5271 5272 CheckAvailable(const Loop *L, BasicBlock *BB, DominatorTree &DT) 5273 : L(L), BB(BB), DT(DT) {} 5274 5275 bool setUnavailable() { 5276 TraversalDone = true; 5277 Available = false; 5278 return false; 5279 } 5280 5281 bool follow(const SCEV *S) { 5282 switch (S->getSCEVType()) { 5283 case scConstant: 5284 case scPtrToInt: 5285 case scTruncate: 5286 case scZeroExtend: 5287 case scSignExtend: 5288 case scAddExpr: 5289 case scMulExpr: 5290 case scUMaxExpr: 5291 case scSMaxExpr: 5292 case scUMinExpr: 5293 case scSMinExpr: 5294 // These expressions are available if their operand(s) is/are. 5295 return true; 5296 5297 case scAddRecExpr: { 5298 // We allow add recurrences that are on the loop BB is in, or some 5299 // outer loop. This guarantees availability because the value of the 5300 // add recurrence at BB is simply the "current" value of the induction 5301 // variable. We can relax this in the future; for instance an add 5302 // recurrence on a sibling dominating loop is also available at BB. 5303 const auto *ARLoop = cast<SCEVAddRecExpr>(S)->getLoop(); 5304 if (L && (ARLoop == L || ARLoop->contains(L))) 5305 return true; 5306 5307 return setUnavailable(); 5308 } 5309 5310 case scUnknown: { 5311 // For SCEVUnknown, we check for simple dominance. 5312 const auto *SU = cast<SCEVUnknown>(S); 5313 Value *V = SU->getValue(); 5314 5315 if (isa<Argument>(V)) 5316 return false; 5317 5318 if (isa<Instruction>(V) && DT.dominates(cast<Instruction>(V), BB)) 5319 return false; 5320 5321 return setUnavailable(); 5322 } 5323 5324 case scUDivExpr: 5325 case scCouldNotCompute: 5326 // We do not try to smart about these at all. 5327 return setUnavailable(); 5328 } 5329 llvm_unreachable("Unknown SCEV kind!"); 5330 } 5331 5332 bool isDone() { return TraversalDone; } 5333 }; 5334 5335 CheckAvailable CA(L, BB, DT); 5336 SCEVTraversal<CheckAvailable> ST(CA); 5337 5338 ST.visitAll(S); 5339 return CA.Available; 5340 } 5341 5342 // Try to match a control flow sequence that branches out at BI and merges back 5343 // at Merge into a "C ? LHS : RHS" select pattern. Return true on a successful 5344 // match. 5345 static bool BrPHIToSelect(DominatorTree &DT, BranchInst *BI, PHINode *Merge, 5346 Value *&C, Value *&LHS, Value *&RHS) { 5347 C = BI->getCondition(); 5348 5349 BasicBlockEdge LeftEdge(BI->getParent(), BI->getSuccessor(0)); 5350 BasicBlockEdge RightEdge(BI->getParent(), BI->getSuccessor(1)); 5351 5352 if (!LeftEdge.isSingleEdge()) 5353 return false; 5354 5355 assert(RightEdge.isSingleEdge() && "Follows from LeftEdge.isSingleEdge()"); 5356 5357 Use &LeftUse = Merge->getOperandUse(0); 5358 Use &RightUse = Merge->getOperandUse(1); 5359 5360 if (DT.dominates(LeftEdge, LeftUse) && DT.dominates(RightEdge, RightUse)) { 5361 LHS = LeftUse; 5362 RHS = RightUse; 5363 return true; 5364 } 5365 5366 if (DT.dominates(LeftEdge, RightUse) && DT.dominates(RightEdge, LeftUse)) { 5367 LHS = RightUse; 5368 RHS = LeftUse; 5369 return true; 5370 } 5371 5372 return false; 5373 } 5374 5375 const SCEV *ScalarEvolution::createNodeFromSelectLikePHI(PHINode *PN) { 5376 auto IsReachable = 5377 [&](BasicBlock *BB) { return DT.isReachableFromEntry(BB); }; 5378 if (PN->getNumIncomingValues() == 2 && all_of(PN->blocks(), IsReachable)) { 5379 const Loop *L = LI.getLoopFor(PN->getParent()); 5380 5381 // We don't want to break LCSSA, even in a SCEV expression tree. 5382 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) 5383 if (LI.getLoopFor(PN->getIncomingBlock(i)) != L) 5384 return nullptr; 5385 5386 // Try to match 5387 // 5388 // br %cond, label %left, label %right 5389 // left: 5390 // br label %merge 5391 // right: 5392 // br label %merge 5393 // merge: 5394 // V = phi [ %x, %left ], [ %y, %right ] 5395 // 5396 // as "select %cond, %x, %y" 5397 5398 BasicBlock *IDom = DT[PN->getParent()]->getIDom()->getBlock(); 5399 assert(IDom && "At least the entry block should dominate PN"); 5400 5401 auto *BI = dyn_cast<BranchInst>(IDom->getTerminator()); 5402 Value *Cond = nullptr, *LHS = nullptr, *RHS = nullptr; 5403 5404 if (BI && BI->isConditional() && 5405 BrPHIToSelect(DT, BI, PN, Cond, LHS, RHS) && 5406 IsAvailableOnEntry(L, DT, getSCEV(LHS), PN->getParent()) && 5407 IsAvailableOnEntry(L, DT, getSCEV(RHS), PN->getParent())) 5408 return createNodeForSelectOrPHI(PN, Cond, LHS, RHS); 5409 } 5410 5411 return nullptr; 5412 } 5413 5414 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) { 5415 if (const SCEV *S = createAddRecFromPHI(PN)) 5416 return S; 5417 5418 if (const SCEV *S = createNodeFromSelectLikePHI(PN)) 5419 return S; 5420 5421 // If the PHI has a single incoming value, follow that value, unless the 5422 // PHI's incoming blocks are in a different loop, in which case doing so 5423 // risks breaking LCSSA form. Instcombine would normally zap these, but 5424 // it doesn't have DominatorTree information, so it may miss cases. 5425 if (Value *V = SimplifyInstruction(PN, {getDataLayout(), &TLI, &DT, &AC})) 5426 if (LI.replacementPreservesLCSSAForm(PN, V)) 5427 return getSCEV(V); 5428 5429 // If it's not a loop phi, we can't handle it yet. 5430 return getUnknown(PN); 5431 } 5432 5433 const SCEV *ScalarEvolution::createNodeForSelectOrPHI(Instruction *I, 5434 Value *Cond, 5435 Value *TrueVal, 5436 Value *FalseVal) { 5437 // Handle "constant" branch or select. This can occur for instance when a 5438 // loop pass transforms an inner loop and moves on to process the outer loop. 5439 if (auto *CI = dyn_cast<ConstantInt>(Cond)) 5440 return getSCEV(CI->isOne() ? TrueVal : FalseVal); 5441 5442 // Try to match some simple smax or umax patterns. 5443 auto *ICI = dyn_cast<ICmpInst>(Cond); 5444 if (!ICI) 5445 return getUnknown(I); 5446 5447 Value *LHS = ICI->getOperand(0); 5448 Value *RHS = ICI->getOperand(1); 5449 5450 switch (ICI->getPredicate()) { 5451 case ICmpInst::ICMP_SLT: 5452 case ICmpInst::ICMP_SLE: 5453 std::swap(LHS, RHS); 5454 LLVM_FALLTHROUGH; 5455 case ICmpInst::ICMP_SGT: 5456 case ICmpInst::ICMP_SGE: 5457 // a >s b ? a+x : b+x -> smax(a, b)+x 5458 // a >s b ? b+x : a+x -> smin(a, b)+x 5459 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) { 5460 const SCEV *LS = getNoopOrSignExtend(getSCEV(LHS), I->getType()); 5461 const SCEV *RS = getNoopOrSignExtend(getSCEV(RHS), I->getType()); 5462 const SCEV *LA = getSCEV(TrueVal); 5463 const SCEV *RA = getSCEV(FalseVal); 5464 const SCEV *LDiff = getMinusSCEV(LA, LS); 5465 const SCEV *RDiff = getMinusSCEV(RA, RS); 5466 if (LDiff == RDiff) 5467 return getAddExpr(getSMaxExpr(LS, RS), LDiff); 5468 LDiff = getMinusSCEV(LA, RS); 5469 RDiff = getMinusSCEV(RA, LS); 5470 if (LDiff == RDiff) 5471 return getAddExpr(getSMinExpr(LS, RS), LDiff); 5472 } 5473 break; 5474 case ICmpInst::ICMP_ULT: 5475 case ICmpInst::ICMP_ULE: 5476 std::swap(LHS, RHS); 5477 LLVM_FALLTHROUGH; 5478 case ICmpInst::ICMP_UGT: 5479 case ICmpInst::ICMP_UGE: 5480 // a >u b ? a+x : b+x -> umax(a, b)+x 5481 // a >u b ? b+x : a+x -> umin(a, b)+x 5482 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) { 5483 const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType()); 5484 const SCEV *RS = getNoopOrZeroExtend(getSCEV(RHS), I->getType()); 5485 const SCEV *LA = getSCEV(TrueVal); 5486 const SCEV *RA = getSCEV(FalseVal); 5487 const SCEV *LDiff = getMinusSCEV(LA, LS); 5488 const SCEV *RDiff = getMinusSCEV(RA, RS); 5489 if (LDiff == RDiff) 5490 return getAddExpr(getUMaxExpr(LS, RS), LDiff); 5491 LDiff = getMinusSCEV(LA, RS); 5492 RDiff = getMinusSCEV(RA, LS); 5493 if (LDiff == RDiff) 5494 return getAddExpr(getUMinExpr(LS, RS), LDiff); 5495 } 5496 break; 5497 case ICmpInst::ICMP_NE: 5498 // n != 0 ? n+x : 1+x -> umax(n, 1)+x 5499 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) && 5500 isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) { 5501 const SCEV *One = getOne(I->getType()); 5502 const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType()); 5503 const SCEV *LA = getSCEV(TrueVal); 5504 const SCEV *RA = getSCEV(FalseVal); 5505 const SCEV *LDiff = getMinusSCEV(LA, LS); 5506 const SCEV *RDiff = getMinusSCEV(RA, One); 5507 if (LDiff == RDiff) 5508 return getAddExpr(getUMaxExpr(One, LS), LDiff); 5509 } 5510 break; 5511 case ICmpInst::ICMP_EQ: 5512 // n == 0 ? 1+x : n+x -> umax(n, 1)+x 5513 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) && 5514 isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) { 5515 const SCEV *One = getOne(I->getType()); 5516 const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType()); 5517 const SCEV *LA = getSCEV(TrueVal); 5518 const SCEV *RA = getSCEV(FalseVal); 5519 const SCEV *LDiff = getMinusSCEV(LA, One); 5520 const SCEV *RDiff = getMinusSCEV(RA, LS); 5521 if (LDiff == RDiff) 5522 return getAddExpr(getUMaxExpr(One, LS), LDiff); 5523 } 5524 break; 5525 default: 5526 break; 5527 } 5528 5529 return getUnknown(I); 5530 } 5531 5532 /// Expand GEP instructions into add and multiply operations. This allows them 5533 /// to be analyzed by regular SCEV code. 5534 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) { 5535 // Don't attempt to analyze GEPs over unsized objects. 5536 if (!GEP->getSourceElementType()->isSized()) 5537 return getUnknown(GEP); 5538 5539 SmallVector<const SCEV *, 4> IndexExprs; 5540 for (auto Index = GEP->idx_begin(); Index != GEP->idx_end(); ++Index) 5541 IndexExprs.push_back(getSCEV(*Index)); 5542 return getGEPExpr(GEP, IndexExprs); 5543 } 5544 5545 uint32_t ScalarEvolution::GetMinTrailingZerosImpl(const SCEV *S) { 5546 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) 5547 return C->getAPInt().countTrailingZeros(); 5548 5549 if (const SCEVPtrToIntExpr *I = dyn_cast<SCEVPtrToIntExpr>(S)) 5550 return GetMinTrailingZeros(I->getOperand()); 5551 5552 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S)) 5553 return std::min(GetMinTrailingZeros(T->getOperand()), 5554 (uint32_t)getTypeSizeInBits(T->getType())); 5555 5556 if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) { 5557 uint32_t OpRes = GetMinTrailingZeros(E->getOperand()); 5558 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) 5559 ? getTypeSizeInBits(E->getType()) 5560 : OpRes; 5561 } 5562 5563 if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) { 5564 uint32_t OpRes = GetMinTrailingZeros(E->getOperand()); 5565 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) 5566 ? getTypeSizeInBits(E->getType()) 5567 : OpRes; 5568 } 5569 5570 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) { 5571 // The result is the min of all operands results. 5572 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0)); 5573 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i) 5574 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i))); 5575 return MinOpRes; 5576 } 5577 5578 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) { 5579 // The result is the sum of all operands results. 5580 uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0)); 5581 uint32_t BitWidth = getTypeSizeInBits(M->getType()); 5582 for (unsigned i = 1, e = M->getNumOperands(); 5583 SumOpRes != BitWidth && i != e; ++i) 5584 SumOpRes = 5585 std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)), BitWidth); 5586 return SumOpRes; 5587 } 5588 5589 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) { 5590 // The result is the min of all operands results. 5591 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0)); 5592 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i) 5593 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i))); 5594 return MinOpRes; 5595 } 5596 5597 if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) { 5598 // The result is the min of all operands results. 5599 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0)); 5600 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i) 5601 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i))); 5602 return MinOpRes; 5603 } 5604 5605 if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) { 5606 // The result is the min of all operands results. 5607 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0)); 5608 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i) 5609 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i))); 5610 return MinOpRes; 5611 } 5612 5613 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) { 5614 // For a SCEVUnknown, ask ValueTracking. 5615 KnownBits Known = computeKnownBits(U->getValue(), getDataLayout(), 0, &AC, nullptr, &DT); 5616 return Known.countMinTrailingZeros(); 5617 } 5618 5619 // SCEVUDivExpr 5620 return 0; 5621 } 5622 5623 uint32_t ScalarEvolution::GetMinTrailingZeros(const SCEV *S) { 5624 auto I = MinTrailingZerosCache.find(S); 5625 if (I != MinTrailingZerosCache.end()) 5626 return I->second; 5627 5628 uint32_t Result = GetMinTrailingZerosImpl(S); 5629 auto InsertPair = MinTrailingZerosCache.insert({S, Result}); 5630 assert(InsertPair.second && "Should insert a new key"); 5631 return InsertPair.first->second; 5632 } 5633 5634 /// Helper method to assign a range to V from metadata present in the IR. 5635 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) { 5636 if (Instruction *I = dyn_cast<Instruction>(V)) 5637 if (MDNode *MD = I->getMetadata(LLVMContext::MD_range)) 5638 return getConstantRangeFromMetadata(*MD); 5639 5640 return None; 5641 } 5642 5643 void ScalarEvolution::setNoWrapFlags(SCEVAddRecExpr *AddRec, 5644 SCEV::NoWrapFlags Flags) { 5645 if (AddRec->getNoWrapFlags(Flags) != Flags) { 5646 AddRec->setNoWrapFlags(Flags); 5647 UnsignedRanges.erase(AddRec); 5648 SignedRanges.erase(AddRec); 5649 } 5650 } 5651 5652 ConstantRange ScalarEvolution:: 5653 getRangeForUnknownRecurrence(const SCEVUnknown *U) { 5654 const DataLayout &DL = getDataLayout(); 5655 5656 unsigned BitWidth = getTypeSizeInBits(U->getType()); 5657 const ConstantRange FullSet(BitWidth, /*isFullSet=*/true); 5658 5659 // Match a simple recurrence of the form: <start, ShiftOp, Step>, and then 5660 // use information about the trip count to improve our available range. Note 5661 // that the trip count independent cases are already handled by known bits. 5662 // WARNING: The definition of recurrence used here is subtly different than 5663 // the one used by AddRec (and thus most of this file). Step is allowed to 5664 // be arbitrarily loop varying here, where AddRec allows only loop invariant 5665 // and other addrecs in the same loop (for non-affine addrecs). The code 5666 // below intentionally handles the case where step is not loop invariant. 5667 auto *P = dyn_cast<PHINode>(U->getValue()); 5668 if (!P) 5669 return FullSet; 5670 5671 // Make sure that no Phi input comes from an unreachable block. Otherwise, 5672 // even the values that are not available in these blocks may come from them, 5673 // and this leads to false-positive recurrence test. 5674 for (auto *Pred : predecessors(P->getParent())) 5675 if (!DT.isReachableFromEntry(Pred)) 5676 return FullSet; 5677 5678 BinaryOperator *BO; 5679 Value *Start, *Step; 5680 if (!matchSimpleRecurrence(P, BO, Start, Step)) 5681 return FullSet; 5682 5683 // If we found a recurrence in reachable code, we must be in a loop. Note 5684 // that BO might be in some subloop of L, and that's completely okay. 5685 auto *L = LI.getLoopFor(P->getParent()); 5686 assert(L && L->getHeader() == P->getParent()); 5687 if (!L->contains(BO->getParent())) 5688 // NOTE: This bailout should be an assert instead. However, asserting 5689 // the condition here exposes a case where LoopFusion is querying SCEV 5690 // with malformed loop information during the midst of the transform. 5691 // There doesn't appear to be an obvious fix, so for the moment bailout 5692 // until the caller issue can be fixed. PR49566 tracks the bug. 5693 return FullSet; 5694 5695 // TODO: Extend to other opcodes such as mul, and div 5696 switch (BO->getOpcode()) { 5697 default: 5698 return FullSet; 5699 case Instruction::AShr: 5700 case Instruction::LShr: 5701 case Instruction::Shl: 5702 break; 5703 }; 5704 5705 if (BO->getOperand(0) != P) 5706 // TODO: Handle the power function forms some day. 5707 return FullSet; 5708 5709 unsigned TC = getSmallConstantMaxTripCount(L); 5710 if (!TC || TC >= BitWidth) 5711 return FullSet; 5712 5713 auto KnownStart = computeKnownBits(Start, DL, 0, &AC, nullptr, &DT); 5714 auto KnownStep = computeKnownBits(Step, DL, 0, &AC, nullptr, &DT); 5715 assert(KnownStart.getBitWidth() == BitWidth && 5716 KnownStep.getBitWidth() == BitWidth); 5717 5718 // Compute total shift amount, being careful of overflow and bitwidths. 5719 auto MaxShiftAmt = KnownStep.getMaxValue(); 5720 APInt TCAP(BitWidth, TC-1); 5721 bool Overflow = false; 5722 auto TotalShift = MaxShiftAmt.umul_ov(TCAP, Overflow); 5723 if (Overflow) 5724 return FullSet; 5725 5726 switch (BO->getOpcode()) { 5727 default: 5728 llvm_unreachable("filtered out above"); 5729 case Instruction::AShr: { 5730 // For each ashr, three cases: 5731 // shift = 0 => unchanged value 5732 // saturation => 0 or -1 5733 // other => a value closer to zero (of the same sign) 5734 // Thus, the end value is closer to zero than the start. 5735 auto KnownEnd = KnownBits::ashr(KnownStart, 5736 KnownBits::makeConstant(TotalShift)); 5737 if (KnownStart.isNonNegative()) 5738 // Analogous to lshr (simply not yet canonicalized) 5739 return ConstantRange::getNonEmpty(KnownEnd.getMinValue(), 5740 KnownStart.getMaxValue() + 1); 5741 if (KnownStart.isNegative()) 5742 // End >=u Start && End <=s Start 5743 return ConstantRange::getNonEmpty(KnownStart.getMinValue(), 5744 KnownEnd.getMaxValue() + 1); 5745 break; 5746 } 5747 case Instruction::LShr: { 5748 // For each lshr, three cases: 5749 // shift = 0 => unchanged value 5750 // saturation => 0 5751 // other => a smaller positive number 5752 // Thus, the low end of the unsigned range is the last value produced. 5753 auto KnownEnd = KnownBits::lshr(KnownStart, 5754 KnownBits::makeConstant(TotalShift)); 5755 return ConstantRange::getNonEmpty(KnownEnd.getMinValue(), 5756 KnownStart.getMaxValue() + 1); 5757 } 5758 case Instruction::Shl: { 5759 // Iff no bits are shifted out, value increases on every shift. 5760 auto KnownEnd = KnownBits::shl(KnownStart, 5761 KnownBits::makeConstant(TotalShift)); 5762 if (TotalShift.ult(KnownStart.countMinLeadingZeros())) 5763 return ConstantRange(KnownStart.getMinValue(), 5764 KnownEnd.getMaxValue() + 1); 5765 break; 5766 } 5767 }; 5768 return FullSet; 5769 } 5770 5771 /// Determine the range for a particular SCEV. If SignHint is 5772 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges 5773 /// with a "cleaner" unsigned (resp. signed) representation. 5774 const ConstantRange & 5775 ScalarEvolution::getRangeRef(const SCEV *S, 5776 ScalarEvolution::RangeSignHint SignHint) { 5777 DenseMap<const SCEV *, ConstantRange> &Cache = 5778 SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges 5779 : SignedRanges; 5780 ConstantRange::PreferredRangeType RangeType = 5781 SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED 5782 ? ConstantRange::Unsigned : ConstantRange::Signed; 5783 5784 // See if we've computed this range already. 5785 DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S); 5786 if (I != Cache.end()) 5787 return I->second; 5788 5789 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) 5790 return setRange(C, SignHint, ConstantRange(C->getAPInt())); 5791 5792 unsigned BitWidth = getTypeSizeInBits(S->getType()); 5793 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true); 5794 using OBO = OverflowingBinaryOperator; 5795 5796 // If the value has known zeros, the maximum value will have those known zeros 5797 // as well. 5798 uint32_t TZ = GetMinTrailingZeros(S); 5799 if (TZ != 0) { 5800 if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) 5801 ConservativeResult = 5802 ConstantRange(APInt::getMinValue(BitWidth), 5803 APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1); 5804 else 5805 ConservativeResult = ConstantRange( 5806 APInt::getSignedMinValue(BitWidth), 5807 APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1); 5808 } 5809 5810 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) { 5811 ConstantRange X = getRangeRef(Add->getOperand(0), SignHint); 5812 unsigned WrapType = OBO::AnyWrap; 5813 if (Add->hasNoSignedWrap()) 5814 WrapType |= OBO::NoSignedWrap; 5815 if (Add->hasNoUnsignedWrap()) 5816 WrapType |= OBO::NoUnsignedWrap; 5817 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i) 5818 X = X.addWithNoWrap(getRangeRef(Add->getOperand(i), SignHint), 5819 WrapType, RangeType); 5820 return setRange(Add, SignHint, 5821 ConservativeResult.intersectWith(X, RangeType)); 5822 } 5823 5824 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) { 5825 ConstantRange X = getRangeRef(Mul->getOperand(0), SignHint); 5826 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i) 5827 X = X.multiply(getRangeRef(Mul->getOperand(i), SignHint)); 5828 return setRange(Mul, SignHint, 5829 ConservativeResult.intersectWith(X, RangeType)); 5830 } 5831 5832 if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) { 5833 ConstantRange X = getRangeRef(SMax->getOperand(0), SignHint); 5834 for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i) 5835 X = X.smax(getRangeRef(SMax->getOperand(i), SignHint)); 5836 return setRange(SMax, SignHint, 5837 ConservativeResult.intersectWith(X, RangeType)); 5838 } 5839 5840 if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) { 5841 ConstantRange X = getRangeRef(UMax->getOperand(0), SignHint); 5842 for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i) 5843 X = X.umax(getRangeRef(UMax->getOperand(i), SignHint)); 5844 return setRange(UMax, SignHint, 5845 ConservativeResult.intersectWith(X, RangeType)); 5846 } 5847 5848 if (const SCEVSMinExpr *SMin = dyn_cast<SCEVSMinExpr>(S)) { 5849 ConstantRange X = getRangeRef(SMin->getOperand(0), SignHint); 5850 for (unsigned i = 1, e = SMin->getNumOperands(); i != e; ++i) 5851 X = X.smin(getRangeRef(SMin->getOperand(i), SignHint)); 5852 return setRange(SMin, SignHint, 5853 ConservativeResult.intersectWith(X, RangeType)); 5854 } 5855 5856 if (const SCEVUMinExpr *UMin = dyn_cast<SCEVUMinExpr>(S)) { 5857 ConstantRange X = getRangeRef(UMin->getOperand(0), SignHint); 5858 for (unsigned i = 1, e = UMin->getNumOperands(); i != e; ++i) 5859 X = X.umin(getRangeRef(UMin->getOperand(i), SignHint)); 5860 return setRange(UMin, SignHint, 5861 ConservativeResult.intersectWith(X, RangeType)); 5862 } 5863 5864 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) { 5865 ConstantRange X = getRangeRef(UDiv->getLHS(), SignHint); 5866 ConstantRange Y = getRangeRef(UDiv->getRHS(), SignHint); 5867 return setRange(UDiv, SignHint, 5868 ConservativeResult.intersectWith(X.udiv(Y), RangeType)); 5869 } 5870 5871 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) { 5872 ConstantRange X = getRangeRef(ZExt->getOperand(), SignHint); 5873 return setRange(ZExt, SignHint, 5874 ConservativeResult.intersectWith(X.zeroExtend(BitWidth), 5875 RangeType)); 5876 } 5877 5878 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) { 5879 ConstantRange X = getRangeRef(SExt->getOperand(), SignHint); 5880 return setRange(SExt, SignHint, 5881 ConservativeResult.intersectWith(X.signExtend(BitWidth), 5882 RangeType)); 5883 } 5884 5885 if (const SCEVPtrToIntExpr *PtrToInt = dyn_cast<SCEVPtrToIntExpr>(S)) { 5886 ConstantRange X = getRangeRef(PtrToInt->getOperand(), SignHint); 5887 return setRange(PtrToInt, SignHint, X); 5888 } 5889 5890 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) { 5891 ConstantRange X = getRangeRef(Trunc->getOperand(), SignHint); 5892 return setRange(Trunc, SignHint, 5893 ConservativeResult.intersectWith(X.truncate(BitWidth), 5894 RangeType)); 5895 } 5896 5897 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) { 5898 // If there's no unsigned wrap, the value will never be less than its 5899 // initial value. 5900 if (AddRec->hasNoUnsignedWrap()) { 5901 APInt UnsignedMinValue = getUnsignedRangeMin(AddRec->getStart()); 5902 if (!UnsignedMinValue.isNullValue()) 5903 ConservativeResult = ConservativeResult.intersectWith( 5904 ConstantRange(UnsignedMinValue, APInt(BitWidth, 0)), RangeType); 5905 } 5906 5907 // If there's no signed wrap, and all the operands except initial value have 5908 // the same sign or zero, the value won't ever be: 5909 // 1: smaller than initial value if operands are non negative, 5910 // 2: bigger than initial value if operands are non positive. 5911 // For both cases, value can not cross signed min/max boundary. 5912 if (AddRec->hasNoSignedWrap()) { 5913 bool AllNonNeg = true; 5914 bool AllNonPos = true; 5915 for (unsigned i = 1, e = AddRec->getNumOperands(); i != e; ++i) { 5916 if (!isKnownNonNegative(AddRec->getOperand(i))) 5917 AllNonNeg = false; 5918 if (!isKnownNonPositive(AddRec->getOperand(i))) 5919 AllNonPos = false; 5920 } 5921 if (AllNonNeg) 5922 ConservativeResult = ConservativeResult.intersectWith( 5923 ConstantRange::getNonEmpty(getSignedRangeMin(AddRec->getStart()), 5924 APInt::getSignedMinValue(BitWidth)), 5925 RangeType); 5926 else if (AllNonPos) 5927 ConservativeResult = ConservativeResult.intersectWith( 5928 ConstantRange::getNonEmpty( 5929 APInt::getSignedMinValue(BitWidth), 5930 getSignedRangeMax(AddRec->getStart()) + 1), 5931 RangeType); 5932 } 5933 5934 // TODO: non-affine addrec 5935 if (AddRec->isAffine()) { 5936 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(AddRec->getLoop()); 5937 if (!isa<SCEVCouldNotCompute>(MaxBECount) && 5938 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) { 5939 auto RangeFromAffine = getRangeForAffineAR( 5940 AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount, 5941 BitWidth); 5942 ConservativeResult = 5943 ConservativeResult.intersectWith(RangeFromAffine, RangeType); 5944 5945 auto RangeFromFactoring = getRangeViaFactoring( 5946 AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount, 5947 BitWidth); 5948 ConservativeResult = 5949 ConservativeResult.intersectWith(RangeFromFactoring, RangeType); 5950 } 5951 5952 // Now try symbolic BE count and more powerful methods. 5953 if (UseExpensiveRangeSharpening) { 5954 const SCEV *SymbolicMaxBECount = 5955 getSymbolicMaxBackedgeTakenCount(AddRec->getLoop()); 5956 if (!isa<SCEVCouldNotCompute>(SymbolicMaxBECount) && 5957 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth && 5958 AddRec->hasNoSelfWrap()) { 5959 auto RangeFromAffineNew = getRangeForAffineNoSelfWrappingAR( 5960 AddRec, SymbolicMaxBECount, BitWidth, SignHint); 5961 ConservativeResult = 5962 ConservativeResult.intersectWith(RangeFromAffineNew, RangeType); 5963 } 5964 } 5965 } 5966 5967 return setRange(AddRec, SignHint, std::move(ConservativeResult)); 5968 } 5969 5970 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) { 5971 5972 // Check if the IR explicitly contains !range metadata. 5973 Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue()); 5974 if (MDRange.hasValue()) 5975 ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue(), 5976 RangeType); 5977 5978 // Use facts about recurrences in the underlying IR. Note that add 5979 // recurrences are AddRecExprs and thus don't hit this path. This 5980 // primarily handles shift recurrences. 5981 auto CR = getRangeForUnknownRecurrence(U); 5982 ConservativeResult = ConservativeResult.intersectWith(CR); 5983 5984 // See if ValueTracking can give us a useful range. 5985 const DataLayout &DL = getDataLayout(); 5986 KnownBits Known = computeKnownBits(U->getValue(), DL, 0, &AC, nullptr, &DT); 5987 if (Known.getBitWidth() != BitWidth) 5988 Known = Known.zextOrTrunc(BitWidth); 5989 5990 // ValueTracking may be able to compute a tighter result for the number of 5991 // sign bits than for the value of those sign bits. 5992 unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, &AC, nullptr, &DT); 5993 if (U->getType()->isPointerTy()) { 5994 // If the pointer size is larger than the index size type, this can cause 5995 // NS to be larger than BitWidth. So compensate for this. 5996 unsigned ptrSize = DL.getPointerTypeSizeInBits(U->getType()); 5997 int ptrIdxDiff = ptrSize - BitWidth; 5998 if (ptrIdxDiff > 0 && ptrSize > BitWidth && NS > (unsigned)ptrIdxDiff) 5999 NS -= ptrIdxDiff; 6000 } 6001 6002 if (NS > 1) { 6003 // If we know any of the sign bits, we know all of the sign bits. 6004 if (!Known.Zero.getHiBits(NS).isNullValue()) 6005 Known.Zero.setHighBits(NS); 6006 if (!Known.One.getHiBits(NS).isNullValue()) 6007 Known.One.setHighBits(NS); 6008 } 6009 6010 if (Known.getMinValue() != Known.getMaxValue() + 1) 6011 ConservativeResult = ConservativeResult.intersectWith( 6012 ConstantRange(Known.getMinValue(), Known.getMaxValue() + 1), 6013 RangeType); 6014 if (NS > 1) 6015 ConservativeResult = ConservativeResult.intersectWith( 6016 ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1), 6017 APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1), 6018 RangeType); 6019 6020 // A range of Phi is a subset of union of all ranges of its input. 6021 if (const PHINode *Phi = dyn_cast<PHINode>(U->getValue())) { 6022 // Make sure that we do not run over cycled Phis. 6023 if (PendingPhiRanges.insert(Phi).second) { 6024 ConstantRange RangeFromOps(BitWidth, /*isFullSet=*/false); 6025 for (auto &Op : Phi->operands()) { 6026 auto OpRange = getRangeRef(getSCEV(Op), SignHint); 6027 RangeFromOps = RangeFromOps.unionWith(OpRange); 6028 // No point to continue if we already have a full set. 6029 if (RangeFromOps.isFullSet()) 6030 break; 6031 } 6032 ConservativeResult = 6033 ConservativeResult.intersectWith(RangeFromOps, RangeType); 6034 bool Erased = PendingPhiRanges.erase(Phi); 6035 assert(Erased && "Failed to erase Phi properly?"); 6036 (void) Erased; 6037 } 6038 } 6039 6040 return setRange(U, SignHint, std::move(ConservativeResult)); 6041 } 6042 6043 return setRange(S, SignHint, std::move(ConservativeResult)); 6044 } 6045 6046 // Given a StartRange, Step and MaxBECount for an expression compute a range of 6047 // values that the expression can take. Initially, the expression has a value 6048 // from StartRange and then is changed by Step up to MaxBECount times. Signed 6049 // argument defines if we treat Step as signed or unsigned. 6050 static ConstantRange getRangeForAffineARHelper(APInt Step, 6051 const ConstantRange &StartRange, 6052 const APInt &MaxBECount, 6053 unsigned BitWidth, bool Signed) { 6054 // If either Step or MaxBECount is 0, then the expression won't change, and we 6055 // just need to return the initial range. 6056 if (Step == 0 || MaxBECount == 0) 6057 return StartRange; 6058 6059 // If we don't know anything about the initial value (i.e. StartRange is 6060 // FullRange), then we don't know anything about the final range either. 6061 // Return FullRange. 6062 if (StartRange.isFullSet()) 6063 return ConstantRange::getFull(BitWidth); 6064 6065 // If Step is signed and negative, then we use its absolute value, but we also 6066 // note that we're moving in the opposite direction. 6067 bool Descending = Signed && Step.isNegative(); 6068 6069 if (Signed) 6070 // This is correct even for INT_SMIN. Let's look at i8 to illustrate this: 6071 // abs(INT_SMIN) = abs(-128) = abs(0x80) = -0x80 = 0x80 = 128. 6072 // This equations hold true due to the well-defined wrap-around behavior of 6073 // APInt. 6074 Step = Step.abs(); 6075 6076 // Check if Offset is more than full span of BitWidth. If it is, the 6077 // expression is guaranteed to overflow. 6078 if (APInt::getMaxValue(StartRange.getBitWidth()).udiv(Step).ult(MaxBECount)) 6079 return ConstantRange::getFull(BitWidth); 6080 6081 // Offset is by how much the expression can change. Checks above guarantee no 6082 // overflow here. 6083 APInt Offset = Step * MaxBECount; 6084 6085 // Minimum value of the final range will match the minimal value of StartRange 6086 // if the expression is increasing and will be decreased by Offset otherwise. 6087 // Maximum value of the final range will match the maximal value of StartRange 6088 // if the expression is decreasing and will be increased by Offset otherwise. 6089 APInt StartLower = StartRange.getLower(); 6090 APInt StartUpper = StartRange.getUpper() - 1; 6091 APInt MovedBoundary = Descending ? (StartLower - std::move(Offset)) 6092 : (StartUpper + std::move(Offset)); 6093 6094 // It's possible that the new minimum/maximum value will fall into the initial 6095 // range (due to wrap around). This means that the expression can take any 6096 // value in this bitwidth, and we have to return full range. 6097 if (StartRange.contains(MovedBoundary)) 6098 return ConstantRange::getFull(BitWidth); 6099 6100 APInt NewLower = 6101 Descending ? std::move(MovedBoundary) : std::move(StartLower); 6102 APInt NewUpper = 6103 Descending ? std::move(StartUpper) : std::move(MovedBoundary); 6104 NewUpper += 1; 6105 6106 // No overflow detected, return [StartLower, StartUpper + Offset + 1) range. 6107 return ConstantRange::getNonEmpty(std::move(NewLower), std::move(NewUpper)); 6108 } 6109 6110 ConstantRange ScalarEvolution::getRangeForAffineAR(const SCEV *Start, 6111 const SCEV *Step, 6112 const SCEV *MaxBECount, 6113 unsigned BitWidth) { 6114 assert(!isa<SCEVCouldNotCompute>(MaxBECount) && 6115 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth && 6116 "Precondition!"); 6117 6118 MaxBECount = getNoopOrZeroExtend(MaxBECount, Start->getType()); 6119 APInt MaxBECountValue = getUnsignedRangeMax(MaxBECount); 6120 6121 // First, consider step signed. 6122 ConstantRange StartSRange = getSignedRange(Start); 6123 ConstantRange StepSRange = getSignedRange(Step); 6124 6125 // If Step can be both positive and negative, we need to find ranges for the 6126 // maximum absolute step values in both directions and union them. 6127 ConstantRange SR = 6128 getRangeForAffineARHelper(StepSRange.getSignedMin(), StartSRange, 6129 MaxBECountValue, BitWidth, /* Signed = */ true); 6130 SR = SR.unionWith(getRangeForAffineARHelper(StepSRange.getSignedMax(), 6131 StartSRange, MaxBECountValue, 6132 BitWidth, /* Signed = */ true)); 6133 6134 // Next, consider step unsigned. 6135 ConstantRange UR = getRangeForAffineARHelper( 6136 getUnsignedRangeMax(Step), getUnsignedRange(Start), 6137 MaxBECountValue, BitWidth, /* Signed = */ false); 6138 6139 // Finally, intersect signed and unsigned ranges. 6140 return SR.intersectWith(UR, ConstantRange::Smallest); 6141 } 6142 6143 ConstantRange ScalarEvolution::getRangeForAffineNoSelfWrappingAR( 6144 const SCEVAddRecExpr *AddRec, const SCEV *MaxBECount, unsigned BitWidth, 6145 ScalarEvolution::RangeSignHint SignHint) { 6146 assert(AddRec->isAffine() && "Non-affine AddRecs are not suppored!\n"); 6147 assert(AddRec->hasNoSelfWrap() && 6148 "This only works for non-self-wrapping AddRecs!"); 6149 const bool IsSigned = SignHint == HINT_RANGE_SIGNED; 6150 const SCEV *Step = AddRec->getStepRecurrence(*this); 6151 // Only deal with constant step to save compile time. 6152 if (!isa<SCEVConstant>(Step)) 6153 return ConstantRange::getFull(BitWidth); 6154 // Let's make sure that we can prove that we do not self-wrap during 6155 // MaxBECount iterations. We need this because MaxBECount is a maximum 6156 // iteration count estimate, and we might infer nw from some exit for which we 6157 // do not know max exit count (or any other side reasoning). 6158 // TODO: Turn into assert at some point. 6159 if (getTypeSizeInBits(MaxBECount->getType()) > 6160 getTypeSizeInBits(AddRec->getType())) 6161 return ConstantRange::getFull(BitWidth); 6162 MaxBECount = getNoopOrZeroExtend(MaxBECount, AddRec->getType()); 6163 const SCEV *RangeWidth = getMinusOne(AddRec->getType()); 6164 const SCEV *StepAbs = getUMinExpr(Step, getNegativeSCEV(Step)); 6165 const SCEV *MaxItersWithoutWrap = getUDivExpr(RangeWidth, StepAbs); 6166 if (!isKnownPredicateViaConstantRanges(ICmpInst::ICMP_ULE, MaxBECount, 6167 MaxItersWithoutWrap)) 6168 return ConstantRange::getFull(BitWidth); 6169 6170 ICmpInst::Predicate LEPred = 6171 IsSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 6172 ICmpInst::Predicate GEPred = 6173 IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 6174 const SCEV *End = AddRec->evaluateAtIteration(MaxBECount, *this); 6175 6176 // We know that there is no self-wrap. Let's take Start and End values and 6177 // look at all intermediate values V1, V2, ..., Vn that IndVar takes during 6178 // the iteration. They either lie inside the range [Min(Start, End), 6179 // Max(Start, End)] or outside it: 6180 // 6181 // Case 1: RangeMin ... Start V1 ... VN End ... RangeMax; 6182 // Case 2: RangeMin Vk ... V1 Start ... End Vn ... Vk + 1 RangeMax; 6183 // 6184 // No self wrap flag guarantees that the intermediate values cannot be BOTH 6185 // outside and inside the range [Min(Start, End), Max(Start, End)]. Using that 6186 // knowledge, let's try to prove that we are dealing with Case 1. It is so if 6187 // Start <= End and step is positive, or Start >= End and step is negative. 6188 const SCEV *Start = AddRec->getStart(); 6189 ConstantRange StartRange = getRangeRef(Start, SignHint); 6190 ConstantRange EndRange = getRangeRef(End, SignHint); 6191 ConstantRange RangeBetween = StartRange.unionWith(EndRange); 6192 // If they already cover full iteration space, we will know nothing useful 6193 // even if we prove what we want to prove. 6194 if (RangeBetween.isFullSet()) 6195 return RangeBetween; 6196 // Only deal with ranges that do not wrap (i.e. RangeMin < RangeMax). 6197 bool IsWrappedSet = IsSigned ? RangeBetween.isSignWrappedSet() 6198 : RangeBetween.isWrappedSet(); 6199 if (IsWrappedSet) 6200 return ConstantRange::getFull(BitWidth); 6201 6202 if (isKnownPositive(Step) && 6203 isKnownPredicateViaConstantRanges(LEPred, Start, End)) 6204 return RangeBetween; 6205 else if (isKnownNegative(Step) && 6206 isKnownPredicateViaConstantRanges(GEPred, Start, End)) 6207 return RangeBetween; 6208 return ConstantRange::getFull(BitWidth); 6209 } 6210 6211 ConstantRange ScalarEvolution::getRangeViaFactoring(const SCEV *Start, 6212 const SCEV *Step, 6213 const SCEV *MaxBECount, 6214 unsigned BitWidth) { 6215 // RangeOf({C?A:B,+,C?P:Q}) == RangeOf(C?{A,+,P}:{B,+,Q}) 6216 // == RangeOf({A,+,P}) union RangeOf({B,+,Q}) 6217 6218 struct SelectPattern { 6219 Value *Condition = nullptr; 6220 APInt TrueValue; 6221 APInt FalseValue; 6222 6223 explicit SelectPattern(ScalarEvolution &SE, unsigned BitWidth, 6224 const SCEV *S) { 6225 Optional<unsigned> CastOp; 6226 APInt Offset(BitWidth, 0); 6227 6228 assert(SE.getTypeSizeInBits(S->getType()) == BitWidth && 6229 "Should be!"); 6230 6231 // Peel off a constant offset: 6232 if (auto *SA = dyn_cast<SCEVAddExpr>(S)) { 6233 // In the future we could consider being smarter here and handle 6234 // {Start+Step,+,Step} too. 6235 if (SA->getNumOperands() != 2 || !isa<SCEVConstant>(SA->getOperand(0))) 6236 return; 6237 6238 Offset = cast<SCEVConstant>(SA->getOperand(0))->getAPInt(); 6239 S = SA->getOperand(1); 6240 } 6241 6242 // Peel off a cast operation 6243 if (auto *SCast = dyn_cast<SCEVIntegralCastExpr>(S)) { 6244 CastOp = SCast->getSCEVType(); 6245 S = SCast->getOperand(); 6246 } 6247 6248 using namespace llvm::PatternMatch; 6249 6250 auto *SU = dyn_cast<SCEVUnknown>(S); 6251 const APInt *TrueVal, *FalseVal; 6252 if (!SU || 6253 !match(SU->getValue(), m_Select(m_Value(Condition), m_APInt(TrueVal), 6254 m_APInt(FalseVal)))) { 6255 Condition = nullptr; 6256 return; 6257 } 6258 6259 TrueValue = *TrueVal; 6260 FalseValue = *FalseVal; 6261 6262 // Re-apply the cast we peeled off earlier 6263 if (CastOp.hasValue()) 6264 switch (*CastOp) { 6265 default: 6266 llvm_unreachable("Unknown SCEV cast type!"); 6267 6268 case scTruncate: 6269 TrueValue = TrueValue.trunc(BitWidth); 6270 FalseValue = FalseValue.trunc(BitWidth); 6271 break; 6272 case scZeroExtend: 6273 TrueValue = TrueValue.zext(BitWidth); 6274 FalseValue = FalseValue.zext(BitWidth); 6275 break; 6276 case scSignExtend: 6277 TrueValue = TrueValue.sext(BitWidth); 6278 FalseValue = FalseValue.sext(BitWidth); 6279 break; 6280 } 6281 6282 // Re-apply the constant offset we peeled off earlier 6283 TrueValue += Offset; 6284 FalseValue += Offset; 6285 } 6286 6287 bool isRecognized() { return Condition != nullptr; } 6288 }; 6289 6290 SelectPattern StartPattern(*this, BitWidth, Start); 6291 if (!StartPattern.isRecognized()) 6292 return ConstantRange::getFull(BitWidth); 6293 6294 SelectPattern StepPattern(*this, BitWidth, Step); 6295 if (!StepPattern.isRecognized()) 6296 return ConstantRange::getFull(BitWidth); 6297 6298 if (StartPattern.Condition != StepPattern.Condition) { 6299 // We don't handle this case today; but we could, by considering four 6300 // possibilities below instead of two. I'm not sure if there are cases where 6301 // that will help over what getRange already does, though. 6302 return ConstantRange::getFull(BitWidth); 6303 } 6304 6305 // NB! Calling ScalarEvolution::getConstant is fine, but we should not try to 6306 // construct arbitrary general SCEV expressions here. This function is called 6307 // from deep in the call stack, and calling getSCEV (on a sext instruction, 6308 // say) can end up caching a suboptimal value. 6309 6310 // FIXME: without the explicit `this` receiver below, MSVC errors out with 6311 // C2352 and C2512 (otherwise it isn't needed). 6312 6313 const SCEV *TrueStart = this->getConstant(StartPattern.TrueValue); 6314 const SCEV *TrueStep = this->getConstant(StepPattern.TrueValue); 6315 const SCEV *FalseStart = this->getConstant(StartPattern.FalseValue); 6316 const SCEV *FalseStep = this->getConstant(StepPattern.FalseValue); 6317 6318 ConstantRange TrueRange = 6319 this->getRangeForAffineAR(TrueStart, TrueStep, MaxBECount, BitWidth); 6320 ConstantRange FalseRange = 6321 this->getRangeForAffineAR(FalseStart, FalseStep, MaxBECount, BitWidth); 6322 6323 return TrueRange.unionWith(FalseRange); 6324 } 6325 6326 SCEV::NoWrapFlags ScalarEvolution::getNoWrapFlagsFromUB(const Value *V) { 6327 if (isa<ConstantExpr>(V)) return SCEV::FlagAnyWrap; 6328 const BinaryOperator *BinOp = cast<BinaryOperator>(V); 6329 6330 // Return early if there are no flags to propagate to the SCEV. 6331 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 6332 if (BinOp->hasNoUnsignedWrap()) 6333 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 6334 if (BinOp->hasNoSignedWrap()) 6335 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 6336 if (Flags == SCEV::FlagAnyWrap) 6337 return SCEV::FlagAnyWrap; 6338 6339 return isSCEVExprNeverPoison(BinOp) ? Flags : SCEV::FlagAnyWrap; 6340 } 6341 6342 bool ScalarEvolution::isSCEVExprNeverPoison(const Instruction *I) { 6343 // Here we check that I is in the header of the innermost loop containing I, 6344 // since we only deal with instructions in the loop header. The actual loop we 6345 // need to check later will come from an add recurrence, but getting that 6346 // requires computing the SCEV of the operands, which can be expensive. This 6347 // check we can do cheaply to rule out some cases early. 6348 Loop *InnermostContainingLoop = LI.getLoopFor(I->getParent()); 6349 if (InnermostContainingLoop == nullptr || 6350 InnermostContainingLoop->getHeader() != I->getParent()) 6351 return false; 6352 6353 // Only proceed if we can prove that I does not yield poison. 6354 if (!programUndefinedIfPoison(I)) 6355 return false; 6356 6357 // At this point we know that if I is executed, then it does not wrap 6358 // according to at least one of NSW or NUW. If I is not executed, then we do 6359 // not know if the calculation that I represents would wrap. Multiple 6360 // instructions can map to the same SCEV. If we apply NSW or NUW from I to 6361 // the SCEV, we must guarantee no wrapping for that SCEV also when it is 6362 // derived from other instructions that map to the same SCEV. We cannot make 6363 // that guarantee for cases where I is not executed. So we need to find the 6364 // loop that I is considered in relation to and prove that I is executed for 6365 // every iteration of that loop. That implies that the value that I 6366 // calculates does not wrap anywhere in the loop, so then we can apply the 6367 // flags to the SCEV. 6368 // 6369 // We check isLoopInvariant to disambiguate in case we are adding recurrences 6370 // from different loops, so that we know which loop to prove that I is 6371 // executed in. 6372 for (unsigned OpIndex = 0; OpIndex < I->getNumOperands(); ++OpIndex) { 6373 // I could be an extractvalue from a call to an overflow intrinsic. 6374 // TODO: We can do better here in some cases. 6375 if (!isSCEVable(I->getOperand(OpIndex)->getType())) 6376 return false; 6377 const SCEV *Op = getSCEV(I->getOperand(OpIndex)); 6378 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) { 6379 bool AllOtherOpsLoopInvariant = true; 6380 for (unsigned OtherOpIndex = 0; OtherOpIndex < I->getNumOperands(); 6381 ++OtherOpIndex) { 6382 if (OtherOpIndex != OpIndex) { 6383 const SCEV *OtherOp = getSCEV(I->getOperand(OtherOpIndex)); 6384 if (!isLoopInvariant(OtherOp, AddRec->getLoop())) { 6385 AllOtherOpsLoopInvariant = false; 6386 break; 6387 } 6388 } 6389 } 6390 if (AllOtherOpsLoopInvariant && 6391 isGuaranteedToExecuteForEveryIteration(I, AddRec->getLoop())) 6392 return true; 6393 } 6394 } 6395 return false; 6396 } 6397 6398 bool ScalarEvolution::isAddRecNeverPoison(const Instruction *I, const Loop *L) { 6399 // If we know that \c I can never be poison period, then that's enough. 6400 if (isSCEVExprNeverPoison(I)) 6401 return true; 6402 6403 // For an add recurrence specifically, we assume that infinite loops without 6404 // side effects are undefined behavior, and then reason as follows: 6405 // 6406 // If the add recurrence is poison in any iteration, it is poison on all 6407 // future iterations (since incrementing poison yields poison). If the result 6408 // of the add recurrence is fed into the loop latch condition and the loop 6409 // does not contain any throws or exiting blocks other than the latch, we now 6410 // have the ability to "choose" whether the backedge is taken or not (by 6411 // choosing a sufficiently evil value for the poison feeding into the branch) 6412 // for every iteration including and after the one in which \p I first became 6413 // poison. There are two possibilities (let's call the iteration in which \p 6414 // I first became poison as K): 6415 // 6416 // 1. In the set of iterations including and after K, the loop body executes 6417 // no side effects. In this case executing the backege an infinte number 6418 // of times will yield undefined behavior. 6419 // 6420 // 2. In the set of iterations including and after K, the loop body executes 6421 // at least one side effect. In this case, that specific instance of side 6422 // effect is control dependent on poison, which also yields undefined 6423 // behavior. 6424 6425 auto *ExitingBB = L->getExitingBlock(); 6426 auto *LatchBB = L->getLoopLatch(); 6427 if (!ExitingBB || !LatchBB || ExitingBB != LatchBB) 6428 return false; 6429 6430 SmallPtrSet<const Instruction *, 16> Pushed; 6431 SmallVector<const Instruction *, 8> PoisonStack; 6432 6433 // We start by assuming \c I, the post-inc add recurrence, is poison. Only 6434 // things that are known to be poison under that assumption go on the 6435 // PoisonStack. 6436 Pushed.insert(I); 6437 PoisonStack.push_back(I); 6438 6439 bool LatchControlDependentOnPoison = false; 6440 while (!PoisonStack.empty() && !LatchControlDependentOnPoison) { 6441 const Instruction *Poison = PoisonStack.pop_back_val(); 6442 6443 for (auto *PoisonUser : Poison->users()) { 6444 if (propagatesPoison(cast<Operator>(PoisonUser))) { 6445 if (Pushed.insert(cast<Instruction>(PoisonUser)).second) 6446 PoisonStack.push_back(cast<Instruction>(PoisonUser)); 6447 } else if (auto *BI = dyn_cast<BranchInst>(PoisonUser)) { 6448 assert(BI->isConditional() && "Only possibility!"); 6449 if (BI->getParent() == LatchBB) { 6450 LatchControlDependentOnPoison = true; 6451 break; 6452 } 6453 } 6454 } 6455 } 6456 6457 return LatchControlDependentOnPoison && loopHasNoAbnormalExits(L); 6458 } 6459 6460 ScalarEvolution::LoopProperties 6461 ScalarEvolution::getLoopProperties(const Loop *L) { 6462 using LoopProperties = ScalarEvolution::LoopProperties; 6463 6464 auto Itr = LoopPropertiesCache.find(L); 6465 if (Itr == LoopPropertiesCache.end()) { 6466 auto HasSideEffects = [](Instruction *I) { 6467 if (auto *SI = dyn_cast<StoreInst>(I)) 6468 return !SI->isSimple(); 6469 6470 return I->mayHaveSideEffects(); 6471 }; 6472 6473 LoopProperties LP = {/* HasNoAbnormalExits */ true, 6474 /*HasNoSideEffects*/ true}; 6475 6476 for (auto *BB : L->getBlocks()) 6477 for (auto &I : *BB) { 6478 if (!isGuaranteedToTransferExecutionToSuccessor(&I)) 6479 LP.HasNoAbnormalExits = false; 6480 if (HasSideEffects(&I)) 6481 LP.HasNoSideEffects = false; 6482 if (!LP.HasNoAbnormalExits && !LP.HasNoSideEffects) 6483 break; // We're already as pessimistic as we can get. 6484 } 6485 6486 auto InsertPair = LoopPropertiesCache.insert({L, LP}); 6487 assert(InsertPair.second && "We just checked!"); 6488 Itr = InsertPair.first; 6489 } 6490 6491 return Itr->second; 6492 } 6493 6494 const SCEV *ScalarEvolution::createSCEV(Value *V) { 6495 if (!isSCEVable(V->getType())) 6496 return getUnknown(V); 6497 6498 if (Instruction *I = dyn_cast<Instruction>(V)) { 6499 // Don't attempt to analyze instructions in blocks that aren't 6500 // reachable. Such instructions don't matter, and they aren't required 6501 // to obey basic rules for definitions dominating uses which this 6502 // analysis depends on. 6503 if (!DT.isReachableFromEntry(I->getParent())) 6504 return getUnknown(UndefValue::get(V->getType())); 6505 } else if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) 6506 return getConstant(CI); 6507 else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) 6508 return GA->isInterposable() ? getUnknown(V) : getSCEV(GA->getAliasee()); 6509 else if (!isa<ConstantExpr>(V)) 6510 return getUnknown(V); 6511 6512 Operator *U = cast<Operator>(V); 6513 if (auto BO = MatchBinaryOp(U, DT)) { 6514 switch (BO->Opcode) { 6515 case Instruction::Add: { 6516 // The simple thing to do would be to just call getSCEV on both operands 6517 // and call getAddExpr with the result. However if we're looking at a 6518 // bunch of things all added together, this can be quite inefficient, 6519 // because it leads to N-1 getAddExpr calls for N ultimate operands. 6520 // Instead, gather up all the operands and make a single getAddExpr call. 6521 // LLVM IR canonical form means we need only traverse the left operands. 6522 SmallVector<const SCEV *, 4> AddOps; 6523 do { 6524 if (BO->Op) { 6525 if (auto *OpSCEV = getExistingSCEV(BO->Op)) { 6526 AddOps.push_back(OpSCEV); 6527 break; 6528 } 6529 6530 // If a NUW or NSW flag can be applied to the SCEV for this 6531 // addition, then compute the SCEV for this addition by itself 6532 // with a separate call to getAddExpr. We need to do that 6533 // instead of pushing the operands of the addition onto AddOps, 6534 // since the flags are only known to apply to this particular 6535 // addition - they may not apply to other additions that can be 6536 // formed with operands from AddOps. 6537 const SCEV *RHS = getSCEV(BO->RHS); 6538 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op); 6539 if (Flags != SCEV::FlagAnyWrap) { 6540 const SCEV *LHS = getSCEV(BO->LHS); 6541 if (BO->Opcode == Instruction::Sub) 6542 AddOps.push_back(getMinusSCEV(LHS, RHS, Flags)); 6543 else 6544 AddOps.push_back(getAddExpr(LHS, RHS, Flags)); 6545 break; 6546 } 6547 } 6548 6549 if (BO->Opcode == Instruction::Sub) 6550 AddOps.push_back(getNegativeSCEV(getSCEV(BO->RHS))); 6551 else 6552 AddOps.push_back(getSCEV(BO->RHS)); 6553 6554 auto NewBO = MatchBinaryOp(BO->LHS, DT); 6555 if (!NewBO || (NewBO->Opcode != Instruction::Add && 6556 NewBO->Opcode != Instruction::Sub)) { 6557 AddOps.push_back(getSCEV(BO->LHS)); 6558 break; 6559 } 6560 BO = NewBO; 6561 } while (true); 6562 6563 return getAddExpr(AddOps); 6564 } 6565 6566 case Instruction::Mul: { 6567 SmallVector<const SCEV *, 4> MulOps; 6568 do { 6569 if (BO->Op) { 6570 if (auto *OpSCEV = getExistingSCEV(BO->Op)) { 6571 MulOps.push_back(OpSCEV); 6572 break; 6573 } 6574 6575 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op); 6576 if (Flags != SCEV::FlagAnyWrap) { 6577 MulOps.push_back( 6578 getMulExpr(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags)); 6579 break; 6580 } 6581 } 6582 6583 MulOps.push_back(getSCEV(BO->RHS)); 6584 auto NewBO = MatchBinaryOp(BO->LHS, DT); 6585 if (!NewBO || NewBO->Opcode != Instruction::Mul) { 6586 MulOps.push_back(getSCEV(BO->LHS)); 6587 break; 6588 } 6589 BO = NewBO; 6590 } while (true); 6591 6592 return getMulExpr(MulOps); 6593 } 6594 case Instruction::UDiv: 6595 return getUDivExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 6596 case Instruction::URem: 6597 return getURemExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 6598 case Instruction::Sub: { 6599 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 6600 if (BO->Op) 6601 Flags = getNoWrapFlagsFromUB(BO->Op); 6602 return getMinusSCEV(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags); 6603 } 6604 case Instruction::And: 6605 // For an expression like x&255 that merely masks off the high bits, 6606 // use zext(trunc(x)) as the SCEV expression. 6607 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 6608 if (CI->isZero()) 6609 return getSCEV(BO->RHS); 6610 if (CI->isMinusOne()) 6611 return getSCEV(BO->LHS); 6612 const APInt &A = CI->getValue(); 6613 6614 // Instcombine's ShrinkDemandedConstant may strip bits out of 6615 // constants, obscuring what would otherwise be a low-bits mask. 6616 // Use computeKnownBits to compute what ShrinkDemandedConstant 6617 // knew about to reconstruct a low-bits mask value. 6618 unsigned LZ = A.countLeadingZeros(); 6619 unsigned TZ = A.countTrailingZeros(); 6620 unsigned BitWidth = A.getBitWidth(); 6621 KnownBits Known(BitWidth); 6622 computeKnownBits(BO->LHS, Known, getDataLayout(), 6623 0, &AC, nullptr, &DT); 6624 6625 APInt EffectiveMask = 6626 APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ); 6627 if ((LZ != 0 || TZ != 0) && !((~A & ~Known.Zero) & EffectiveMask)) { 6628 const SCEV *MulCount = getConstant(APInt::getOneBitSet(BitWidth, TZ)); 6629 const SCEV *LHS = getSCEV(BO->LHS); 6630 const SCEV *ShiftedLHS = nullptr; 6631 if (auto *LHSMul = dyn_cast<SCEVMulExpr>(LHS)) { 6632 if (auto *OpC = dyn_cast<SCEVConstant>(LHSMul->getOperand(0))) { 6633 // For an expression like (x * 8) & 8, simplify the multiply. 6634 unsigned MulZeros = OpC->getAPInt().countTrailingZeros(); 6635 unsigned GCD = std::min(MulZeros, TZ); 6636 APInt DivAmt = APInt::getOneBitSet(BitWidth, TZ - GCD); 6637 SmallVector<const SCEV*, 4> MulOps; 6638 MulOps.push_back(getConstant(OpC->getAPInt().lshr(GCD))); 6639 MulOps.append(LHSMul->op_begin() + 1, LHSMul->op_end()); 6640 auto *NewMul = getMulExpr(MulOps, LHSMul->getNoWrapFlags()); 6641 ShiftedLHS = getUDivExpr(NewMul, getConstant(DivAmt)); 6642 } 6643 } 6644 if (!ShiftedLHS) 6645 ShiftedLHS = getUDivExpr(LHS, MulCount); 6646 return getMulExpr( 6647 getZeroExtendExpr( 6648 getTruncateExpr(ShiftedLHS, 6649 IntegerType::get(getContext(), BitWidth - LZ - TZ)), 6650 BO->LHS->getType()), 6651 MulCount); 6652 } 6653 } 6654 break; 6655 6656 case Instruction::Or: 6657 // If the RHS of the Or is a constant, we may have something like: 6658 // X*4+1 which got turned into X*4|1. Handle this as an Add so loop 6659 // optimizations will transparently handle this case. 6660 // 6661 // In order for this transformation to be safe, the LHS must be of the 6662 // form X*(2^n) and the Or constant must be less than 2^n. 6663 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 6664 const SCEV *LHS = getSCEV(BO->LHS); 6665 const APInt &CIVal = CI->getValue(); 6666 if (GetMinTrailingZeros(LHS) >= 6667 (CIVal.getBitWidth() - CIVal.countLeadingZeros())) { 6668 // Build a plain add SCEV. 6669 return getAddExpr(LHS, getSCEV(CI), 6670 (SCEV::NoWrapFlags)(SCEV::FlagNUW | SCEV::FlagNSW)); 6671 } 6672 } 6673 break; 6674 6675 case Instruction::Xor: 6676 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 6677 // If the RHS of xor is -1, then this is a not operation. 6678 if (CI->isMinusOne()) 6679 return getNotSCEV(getSCEV(BO->LHS)); 6680 6681 // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask. 6682 // This is a variant of the check for xor with -1, and it handles 6683 // the case where instcombine has trimmed non-demanded bits out 6684 // of an xor with -1. 6685 if (auto *LBO = dyn_cast<BinaryOperator>(BO->LHS)) 6686 if (ConstantInt *LCI = dyn_cast<ConstantInt>(LBO->getOperand(1))) 6687 if (LBO->getOpcode() == Instruction::And && 6688 LCI->getValue() == CI->getValue()) 6689 if (const SCEVZeroExtendExpr *Z = 6690 dyn_cast<SCEVZeroExtendExpr>(getSCEV(BO->LHS))) { 6691 Type *UTy = BO->LHS->getType(); 6692 const SCEV *Z0 = Z->getOperand(); 6693 Type *Z0Ty = Z0->getType(); 6694 unsigned Z0TySize = getTypeSizeInBits(Z0Ty); 6695 6696 // If C is a low-bits mask, the zero extend is serving to 6697 // mask off the high bits. Complement the operand and 6698 // re-apply the zext. 6699 if (CI->getValue().isMask(Z0TySize)) 6700 return getZeroExtendExpr(getNotSCEV(Z0), UTy); 6701 6702 // If C is a single bit, it may be in the sign-bit position 6703 // before the zero-extend. In this case, represent the xor 6704 // using an add, which is equivalent, and re-apply the zext. 6705 APInt Trunc = CI->getValue().trunc(Z0TySize); 6706 if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() && 6707 Trunc.isSignMask()) 6708 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)), 6709 UTy); 6710 } 6711 } 6712 break; 6713 6714 case Instruction::Shl: 6715 // Turn shift left of a constant amount into a multiply. 6716 if (ConstantInt *SA = dyn_cast<ConstantInt>(BO->RHS)) { 6717 uint32_t BitWidth = cast<IntegerType>(SA->getType())->getBitWidth(); 6718 6719 // If the shift count is not less than the bitwidth, the result of 6720 // the shift is undefined. Don't try to analyze it, because the 6721 // resolution chosen here may differ from the resolution chosen in 6722 // other parts of the compiler. 6723 if (SA->getValue().uge(BitWidth)) 6724 break; 6725 6726 // We can safely preserve the nuw flag in all cases. It's also safe to 6727 // turn a nuw nsw shl into a nuw nsw mul. However, nsw in isolation 6728 // requires special handling. It can be preserved as long as we're not 6729 // left shifting by bitwidth - 1. 6730 auto Flags = SCEV::FlagAnyWrap; 6731 if (BO->Op) { 6732 auto MulFlags = getNoWrapFlagsFromUB(BO->Op); 6733 if ((MulFlags & SCEV::FlagNSW) && 6734 ((MulFlags & SCEV::FlagNUW) || SA->getValue().ult(BitWidth - 1))) 6735 Flags = (SCEV::NoWrapFlags)(Flags | SCEV::FlagNSW); 6736 if (MulFlags & SCEV::FlagNUW) 6737 Flags = (SCEV::NoWrapFlags)(Flags | SCEV::FlagNUW); 6738 } 6739 6740 Constant *X = ConstantInt::get( 6741 getContext(), APInt::getOneBitSet(BitWidth, SA->getZExtValue())); 6742 return getMulExpr(getSCEV(BO->LHS), getSCEV(X), Flags); 6743 } 6744 break; 6745 6746 case Instruction::AShr: { 6747 // AShr X, C, where C is a constant. 6748 ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS); 6749 if (!CI) 6750 break; 6751 6752 Type *OuterTy = BO->LHS->getType(); 6753 uint64_t BitWidth = getTypeSizeInBits(OuterTy); 6754 // If the shift count is not less than the bitwidth, the result of 6755 // the shift is undefined. Don't try to analyze it, because the 6756 // resolution chosen here may differ from the resolution chosen in 6757 // other parts of the compiler. 6758 if (CI->getValue().uge(BitWidth)) 6759 break; 6760 6761 if (CI->isZero()) 6762 return getSCEV(BO->LHS); // shift by zero --> noop 6763 6764 uint64_t AShrAmt = CI->getZExtValue(); 6765 Type *TruncTy = IntegerType::get(getContext(), BitWidth - AShrAmt); 6766 6767 Operator *L = dyn_cast<Operator>(BO->LHS); 6768 if (L && L->getOpcode() == Instruction::Shl) { 6769 // X = Shl A, n 6770 // Y = AShr X, m 6771 // Both n and m are constant. 6772 6773 const SCEV *ShlOp0SCEV = getSCEV(L->getOperand(0)); 6774 if (L->getOperand(1) == BO->RHS) 6775 // For a two-shift sext-inreg, i.e. n = m, 6776 // use sext(trunc(x)) as the SCEV expression. 6777 return getSignExtendExpr( 6778 getTruncateExpr(ShlOp0SCEV, TruncTy), OuterTy); 6779 6780 ConstantInt *ShlAmtCI = dyn_cast<ConstantInt>(L->getOperand(1)); 6781 if (ShlAmtCI && ShlAmtCI->getValue().ult(BitWidth)) { 6782 uint64_t ShlAmt = ShlAmtCI->getZExtValue(); 6783 if (ShlAmt > AShrAmt) { 6784 // When n > m, use sext(mul(trunc(x), 2^(n-m)))) as the SCEV 6785 // expression. We already checked that ShlAmt < BitWidth, so 6786 // the multiplier, 1 << (ShlAmt - AShrAmt), fits into TruncTy as 6787 // ShlAmt - AShrAmt < Amt. 6788 APInt Mul = APInt::getOneBitSet(BitWidth - AShrAmt, 6789 ShlAmt - AShrAmt); 6790 return getSignExtendExpr( 6791 getMulExpr(getTruncateExpr(ShlOp0SCEV, TruncTy), 6792 getConstant(Mul)), OuterTy); 6793 } 6794 } 6795 } 6796 break; 6797 } 6798 } 6799 } 6800 6801 switch (U->getOpcode()) { 6802 case Instruction::Trunc: 6803 return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType()); 6804 6805 case Instruction::ZExt: 6806 return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType()); 6807 6808 case Instruction::SExt: 6809 if (auto BO = MatchBinaryOp(U->getOperand(0), DT)) { 6810 // The NSW flag of a subtract does not always survive the conversion to 6811 // A + (-1)*B. By pushing sign extension onto its operands we are much 6812 // more likely to preserve NSW and allow later AddRec optimisations. 6813 // 6814 // NOTE: This is effectively duplicating this logic from getSignExtend: 6815 // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw> 6816 // but by that point the NSW information has potentially been lost. 6817 if (BO->Opcode == Instruction::Sub && BO->IsNSW) { 6818 Type *Ty = U->getType(); 6819 auto *V1 = getSignExtendExpr(getSCEV(BO->LHS), Ty); 6820 auto *V2 = getSignExtendExpr(getSCEV(BO->RHS), Ty); 6821 return getMinusSCEV(V1, V2, SCEV::FlagNSW); 6822 } 6823 } 6824 return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType()); 6825 6826 case Instruction::BitCast: 6827 // BitCasts are no-op casts so we just eliminate the cast. 6828 if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType())) 6829 return getSCEV(U->getOperand(0)); 6830 break; 6831 6832 case Instruction::PtrToInt: { 6833 // Pointer to integer cast is straight-forward, so do model it. 6834 const SCEV *Op = getSCEV(U->getOperand(0)); 6835 Type *DstIntTy = U->getType(); 6836 // But only if effective SCEV (integer) type is wide enough to represent 6837 // all possible pointer values. 6838 const SCEV *IntOp = getPtrToIntExpr(Op, DstIntTy); 6839 if (isa<SCEVCouldNotCompute>(IntOp)) 6840 return getUnknown(V); 6841 return IntOp; 6842 } 6843 case Instruction::IntToPtr: 6844 // Just don't deal with inttoptr casts. 6845 return getUnknown(V); 6846 6847 case Instruction::SDiv: 6848 // If both operands are non-negative, this is just an udiv. 6849 if (isKnownNonNegative(getSCEV(U->getOperand(0))) && 6850 isKnownNonNegative(getSCEV(U->getOperand(1)))) 6851 return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1))); 6852 break; 6853 6854 case Instruction::SRem: 6855 // If both operands are non-negative, this is just an urem. 6856 if (isKnownNonNegative(getSCEV(U->getOperand(0))) && 6857 isKnownNonNegative(getSCEV(U->getOperand(1)))) 6858 return getURemExpr(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1))); 6859 break; 6860 6861 case Instruction::GetElementPtr: 6862 return createNodeForGEP(cast<GEPOperator>(U)); 6863 6864 case Instruction::PHI: 6865 return createNodeForPHI(cast<PHINode>(U)); 6866 6867 case Instruction::Select: 6868 // U can also be a select constant expr, which let fall through. Since 6869 // createNodeForSelect only works for a condition that is an `ICmpInst`, and 6870 // constant expressions cannot have instructions as operands, we'd have 6871 // returned getUnknown for a select constant expressions anyway. 6872 if (isa<Instruction>(U)) 6873 return createNodeForSelectOrPHI(cast<Instruction>(U), U->getOperand(0), 6874 U->getOperand(1), U->getOperand(2)); 6875 break; 6876 6877 case Instruction::Call: 6878 case Instruction::Invoke: 6879 if (Value *RV = cast<CallBase>(U)->getReturnedArgOperand()) 6880 return getSCEV(RV); 6881 6882 if (auto *II = dyn_cast<IntrinsicInst>(U)) { 6883 switch (II->getIntrinsicID()) { 6884 case Intrinsic::abs: 6885 return getAbsExpr( 6886 getSCEV(II->getArgOperand(0)), 6887 /*IsNSW=*/cast<ConstantInt>(II->getArgOperand(1))->isOne()); 6888 case Intrinsic::umax: 6889 return getUMaxExpr(getSCEV(II->getArgOperand(0)), 6890 getSCEV(II->getArgOperand(1))); 6891 case Intrinsic::umin: 6892 return getUMinExpr(getSCEV(II->getArgOperand(0)), 6893 getSCEV(II->getArgOperand(1))); 6894 case Intrinsic::smax: 6895 return getSMaxExpr(getSCEV(II->getArgOperand(0)), 6896 getSCEV(II->getArgOperand(1))); 6897 case Intrinsic::smin: 6898 return getSMinExpr(getSCEV(II->getArgOperand(0)), 6899 getSCEV(II->getArgOperand(1))); 6900 case Intrinsic::usub_sat: { 6901 const SCEV *X = getSCEV(II->getArgOperand(0)); 6902 const SCEV *Y = getSCEV(II->getArgOperand(1)); 6903 const SCEV *ClampedY = getUMinExpr(X, Y); 6904 return getMinusSCEV(X, ClampedY, SCEV::FlagNUW); 6905 } 6906 case Intrinsic::uadd_sat: { 6907 const SCEV *X = getSCEV(II->getArgOperand(0)); 6908 const SCEV *Y = getSCEV(II->getArgOperand(1)); 6909 const SCEV *ClampedX = getUMinExpr(X, getNotSCEV(Y)); 6910 return getAddExpr(ClampedX, Y, SCEV::FlagNUW); 6911 } 6912 case Intrinsic::start_loop_iterations: 6913 // A start_loop_iterations is just equivalent to the first operand for 6914 // SCEV purposes. 6915 return getSCEV(II->getArgOperand(0)); 6916 default: 6917 break; 6918 } 6919 } 6920 break; 6921 } 6922 6923 return getUnknown(V); 6924 } 6925 6926 //===----------------------------------------------------------------------===// 6927 // Iteration Count Computation Code 6928 // 6929 6930 static unsigned getConstantTripCount(const SCEVConstant *ExitCount) { 6931 if (!ExitCount) 6932 return 0; 6933 6934 ConstantInt *ExitConst = ExitCount->getValue(); 6935 6936 // Guard against huge trip counts. 6937 if (ExitConst->getValue().getActiveBits() > 32) 6938 return 0; 6939 6940 // In case of integer overflow, this returns 0, which is correct. 6941 return ((unsigned)ExitConst->getZExtValue()) + 1; 6942 } 6943 6944 unsigned ScalarEvolution::getSmallConstantTripCount(const Loop *L) { 6945 if (BasicBlock *ExitingBB = L->getExitingBlock()) 6946 return getSmallConstantTripCount(L, ExitingBB); 6947 6948 // No trip count information for multiple exits. 6949 return 0; 6950 } 6951 6952 unsigned 6953 ScalarEvolution::getSmallConstantTripCount(const Loop *L, 6954 const BasicBlock *ExitingBlock) { 6955 assert(ExitingBlock && "Must pass a non-null exiting block!"); 6956 assert(L->isLoopExiting(ExitingBlock) && 6957 "Exiting block must actually branch out of the loop!"); 6958 const SCEVConstant *ExitCount = 6959 dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock)); 6960 return getConstantTripCount(ExitCount); 6961 } 6962 6963 unsigned ScalarEvolution::getSmallConstantMaxTripCount(const Loop *L) { 6964 const auto *MaxExitCount = 6965 dyn_cast<SCEVConstant>(getConstantMaxBackedgeTakenCount(L)); 6966 return getConstantTripCount(MaxExitCount); 6967 } 6968 6969 unsigned ScalarEvolution::getSmallConstantTripMultiple(const Loop *L) { 6970 if (BasicBlock *ExitingBB = L->getExitingBlock()) 6971 return getSmallConstantTripMultiple(L, ExitingBB); 6972 6973 // No trip multiple information for multiple exits. 6974 return 0; 6975 } 6976 6977 /// Returns the largest constant divisor of the trip count of this loop as a 6978 /// normal unsigned value, if possible. This means that the actual trip count is 6979 /// always a multiple of the returned value (don't forget the trip count could 6980 /// very well be zero as well!). 6981 /// 6982 /// Returns 1 if the trip count is unknown or not guaranteed to be the 6983 /// multiple of a constant (which is also the case if the trip count is simply 6984 /// constant, use getSmallConstantTripCount for that case), Will also return 1 6985 /// if the trip count is very large (>= 2^32). 6986 /// 6987 /// As explained in the comments for getSmallConstantTripCount, this assumes 6988 /// that control exits the loop via ExitingBlock. 6989 unsigned 6990 ScalarEvolution::getSmallConstantTripMultiple(const Loop *L, 6991 const BasicBlock *ExitingBlock) { 6992 assert(ExitingBlock && "Must pass a non-null exiting block!"); 6993 assert(L->isLoopExiting(ExitingBlock) && 6994 "Exiting block must actually branch out of the loop!"); 6995 const SCEV *ExitCount = getExitCount(L, ExitingBlock); 6996 if (ExitCount == getCouldNotCompute()) 6997 return 1; 6998 6999 // Get the trip count from the BE count by adding 1. 7000 const SCEV *TCExpr = getAddExpr(ExitCount, getOne(ExitCount->getType())); 7001 7002 const SCEVConstant *TC = dyn_cast<SCEVConstant>(TCExpr); 7003 if (!TC) 7004 // Attempt to factor more general cases. Returns the greatest power of 7005 // two divisor. If overflow happens, the trip count expression is still 7006 // divisible by the greatest power of 2 divisor returned. 7007 return 1U << std::min((uint32_t)31, 7008 GetMinTrailingZeros(applyLoopGuards(TCExpr, L))); 7009 7010 ConstantInt *Result = TC->getValue(); 7011 7012 // Guard against huge trip counts (this requires checking 7013 // for zero to handle the case where the trip count == -1 and the 7014 // addition wraps). 7015 if (!Result || Result->getValue().getActiveBits() > 32 || 7016 Result->getValue().getActiveBits() == 0) 7017 return 1; 7018 7019 return (unsigned)Result->getZExtValue(); 7020 } 7021 7022 const SCEV *ScalarEvolution::getExitCount(const Loop *L, 7023 const BasicBlock *ExitingBlock, 7024 ExitCountKind Kind) { 7025 switch (Kind) { 7026 case Exact: 7027 case SymbolicMaximum: 7028 return getBackedgeTakenInfo(L).getExact(ExitingBlock, this); 7029 case ConstantMaximum: 7030 return getBackedgeTakenInfo(L).getConstantMax(ExitingBlock, this); 7031 }; 7032 llvm_unreachable("Invalid ExitCountKind!"); 7033 } 7034 7035 const SCEV * 7036 ScalarEvolution::getPredicatedBackedgeTakenCount(const Loop *L, 7037 SCEVUnionPredicate &Preds) { 7038 return getPredicatedBackedgeTakenInfo(L).getExact(L, this, &Preds); 7039 } 7040 7041 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L, 7042 ExitCountKind Kind) { 7043 switch (Kind) { 7044 case Exact: 7045 return getBackedgeTakenInfo(L).getExact(L, this); 7046 case ConstantMaximum: 7047 return getBackedgeTakenInfo(L).getConstantMax(this); 7048 case SymbolicMaximum: 7049 return getBackedgeTakenInfo(L).getSymbolicMax(L, this); 7050 }; 7051 llvm_unreachable("Invalid ExitCountKind!"); 7052 } 7053 7054 bool ScalarEvolution::isBackedgeTakenCountMaxOrZero(const Loop *L) { 7055 return getBackedgeTakenInfo(L).isConstantMaxOrZero(this); 7056 } 7057 7058 /// Push PHI nodes in the header of the given loop onto the given Worklist. 7059 static void 7060 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) { 7061 BasicBlock *Header = L->getHeader(); 7062 7063 // Push all Loop-header PHIs onto the Worklist stack. 7064 for (PHINode &PN : Header->phis()) 7065 Worklist.push_back(&PN); 7066 } 7067 7068 const ScalarEvolution::BackedgeTakenInfo & 7069 ScalarEvolution::getPredicatedBackedgeTakenInfo(const Loop *L) { 7070 auto &BTI = getBackedgeTakenInfo(L); 7071 if (BTI.hasFullInfo()) 7072 return BTI; 7073 7074 auto Pair = PredicatedBackedgeTakenCounts.insert({L, BackedgeTakenInfo()}); 7075 7076 if (!Pair.second) 7077 return Pair.first->second; 7078 7079 BackedgeTakenInfo Result = 7080 computeBackedgeTakenCount(L, /*AllowPredicates=*/true); 7081 7082 return PredicatedBackedgeTakenCounts.find(L)->second = std::move(Result); 7083 } 7084 7085 ScalarEvolution::BackedgeTakenInfo & 7086 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) { 7087 // Initially insert an invalid entry for this loop. If the insertion 7088 // succeeds, proceed to actually compute a backedge-taken count and 7089 // update the value. The temporary CouldNotCompute value tells SCEV 7090 // code elsewhere that it shouldn't attempt to request a new 7091 // backedge-taken count, which could result in infinite recursion. 7092 std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair = 7093 BackedgeTakenCounts.insert({L, BackedgeTakenInfo()}); 7094 if (!Pair.second) 7095 return Pair.first->second; 7096 7097 // computeBackedgeTakenCount may allocate memory for its result. Inserting it 7098 // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result 7099 // must be cleared in this scope. 7100 BackedgeTakenInfo Result = computeBackedgeTakenCount(L); 7101 7102 // In product build, there are no usage of statistic. 7103 (void)NumTripCountsComputed; 7104 (void)NumTripCountsNotComputed; 7105 #if LLVM_ENABLE_STATS || !defined(NDEBUG) 7106 const SCEV *BEExact = Result.getExact(L, this); 7107 if (BEExact != getCouldNotCompute()) { 7108 assert(isLoopInvariant(BEExact, L) && 7109 isLoopInvariant(Result.getConstantMax(this), L) && 7110 "Computed backedge-taken count isn't loop invariant for loop!"); 7111 ++NumTripCountsComputed; 7112 } else if (Result.getConstantMax(this) == getCouldNotCompute() && 7113 isa<PHINode>(L->getHeader()->begin())) { 7114 // Only count loops that have phi nodes as not being computable. 7115 ++NumTripCountsNotComputed; 7116 } 7117 #endif // LLVM_ENABLE_STATS || !defined(NDEBUG) 7118 7119 // Now that we know more about the trip count for this loop, forget any 7120 // existing SCEV values for PHI nodes in this loop since they are only 7121 // conservative estimates made without the benefit of trip count 7122 // information. This is similar to the code in forgetLoop, except that 7123 // it handles SCEVUnknown PHI nodes specially. 7124 if (Result.hasAnyInfo()) { 7125 SmallVector<Instruction *, 16> Worklist; 7126 PushLoopPHIs(L, Worklist); 7127 7128 SmallPtrSet<Instruction *, 8> Discovered; 7129 while (!Worklist.empty()) { 7130 Instruction *I = Worklist.pop_back_val(); 7131 7132 ValueExprMapType::iterator It = 7133 ValueExprMap.find_as(static_cast<Value *>(I)); 7134 if (It != ValueExprMap.end()) { 7135 const SCEV *Old = It->second; 7136 7137 // SCEVUnknown for a PHI either means that it has an unrecognized 7138 // structure, or it's a PHI that's in the progress of being computed 7139 // by createNodeForPHI. In the former case, additional loop trip 7140 // count information isn't going to change anything. In the later 7141 // case, createNodeForPHI will perform the necessary updates on its 7142 // own when it gets to that point. 7143 if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) { 7144 eraseValueFromMap(It->first); 7145 forgetMemoizedResults(Old); 7146 } 7147 if (PHINode *PN = dyn_cast<PHINode>(I)) 7148 ConstantEvolutionLoopExitValue.erase(PN); 7149 } 7150 7151 // Since we don't need to invalidate anything for correctness and we're 7152 // only invalidating to make SCEV's results more precise, we get to stop 7153 // early to avoid invalidating too much. This is especially important in 7154 // cases like: 7155 // 7156 // %v = f(pn0, pn1) // pn0 and pn1 used through some other phi node 7157 // loop0: 7158 // %pn0 = phi 7159 // ... 7160 // loop1: 7161 // %pn1 = phi 7162 // ... 7163 // 7164 // where both loop0 and loop1's backedge taken count uses the SCEV 7165 // expression for %v. If we don't have the early stop below then in cases 7166 // like the above, getBackedgeTakenInfo(loop1) will clear out the trip 7167 // count for loop0 and getBackedgeTakenInfo(loop0) will clear out the trip 7168 // count for loop1, effectively nullifying SCEV's trip count cache. 7169 for (auto *U : I->users()) 7170 if (auto *I = dyn_cast<Instruction>(U)) { 7171 auto *LoopForUser = LI.getLoopFor(I->getParent()); 7172 if (LoopForUser && L->contains(LoopForUser) && 7173 Discovered.insert(I).second) 7174 Worklist.push_back(I); 7175 } 7176 } 7177 } 7178 7179 // Re-lookup the insert position, since the call to 7180 // computeBackedgeTakenCount above could result in a 7181 // recusive call to getBackedgeTakenInfo (on a different 7182 // loop), which would invalidate the iterator computed 7183 // earlier. 7184 return BackedgeTakenCounts.find(L)->second = std::move(Result); 7185 } 7186 7187 void ScalarEvolution::forgetAllLoops() { 7188 // This method is intended to forget all info about loops. It should 7189 // invalidate caches as if the following happened: 7190 // - The trip counts of all loops have changed arbitrarily 7191 // - Every llvm::Value has been updated in place to produce a different 7192 // result. 7193 BackedgeTakenCounts.clear(); 7194 PredicatedBackedgeTakenCounts.clear(); 7195 LoopPropertiesCache.clear(); 7196 ConstantEvolutionLoopExitValue.clear(); 7197 ValueExprMap.clear(); 7198 ValuesAtScopes.clear(); 7199 LoopDispositions.clear(); 7200 BlockDispositions.clear(); 7201 UnsignedRanges.clear(); 7202 SignedRanges.clear(); 7203 ExprValueMap.clear(); 7204 HasRecMap.clear(); 7205 MinTrailingZerosCache.clear(); 7206 PredicatedSCEVRewrites.clear(); 7207 } 7208 7209 void ScalarEvolution::forgetLoop(const Loop *L) { 7210 // Drop any stored trip count value. 7211 auto RemoveLoopFromBackedgeMap = 7212 [](DenseMap<const Loop *, BackedgeTakenInfo> &Map, const Loop *L) { 7213 auto BTCPos = Map.find(L); 7214 if (BTCPos != Map.end()) { 7215 BTCPos->second.clear(); 7216 Map.erase(BTCPos); 7217 } 7218 }; 7219 7220 SmallVector<const Loop *, 16> LoopWorklist(1, L); 7221 SmallVector<Instruction *, 32> Worklist; 7222 SmallPtrSet<Instruction *, 16> Visited; 7223 7224 // Iterate over all the loops and sub-loops to drop SCEV information. 7225 while (!LoopWorklist.empty()) { 7226 auto *CurrL = LoopWorklist.pop_back_val(); 7227 7228 RemoveLoopFromBackedgeMap(BackedgeTakenCounts, CurrL); 7229 RemoveLoopFromBackedgeMap(PredicatedBackedgeTakenCounts, CurrL); 7230 7231 // Drop information about predicated SCEV rewrites for this loop. 7232 for (auto I = PredicatedSCEVRewrites.begin(); 7233 I != PredicatedSCEVRewrites.end();) { 7234 std::pair<const SCEV *, const Loop *> Entry = I->first; 7235 if (Entry.second == CurrL) 7236 PredicatedSCEVRewrites.erase(I++); 7237 else 7238 ++I; 7239 } 7240 7241 auto LoopUsersItr = LoopUsers.find(CurrL); 7242 if (LoopUsersItr != LoopUsers.end()) { 7243 for (auto *S : LoopUsersItr->second) 7244 forgetMemoizedResults(S); 7245 LoopUsers.erase(LoopUsersItr); 7246 } 7247 7248 // Drop information about expressions based on loop-header PHIs. 7249 PushLoopPHIs(CurrL, Worklist); 7250 7251 while (!Worklist.empty()) { 7252 Instruction *I = Worklist.pop_back_val(); 7253 if (!Visited.insert(I).second) 7254 continue; 7255 7256 ValueExprMapType::iterator It = 7257 ValueExprMap.find_as(static_cast<Value *>(I)); 7258 if (It != ValueExprMap.end()) { 7259 eraseValueFromMap(It->first); 7260 forgetMemoizedResults(It->second); 7261 if (PHINode *PN = dyn_cast<PHINode>(I)) 7262 ConstantEvolutionLoopExitValue.erase(PN); 7263 } 7264 7265 PushDefUseChildren(I, Worklist); 7266 } 7267 7268 LoopPropertiesCache.erase(CurrL); 7269 // Forget all contained loops too, to avoid dangling entries in the 7270 // ValuesAtScopes map. 7271 LoopWorklist.append(CurrL->begin(), CurrL->end()); 7272 } 7273 } 7274 7275 void ScalarEvolution::forgetTopmostLoop(const Loop *L) { 7276 while (Loop *Parent = L->getParentLoop()) 7277 L = Parent; 7278 forgetLoop(L); 7279 } 7280 7281 void ScalarEvolution::forgetValue(Value *V) { 7282 Instruction *I = dyn_cast<Instruction>(V); 7283 if (!I) return; 7284 7285 // Drop information about expressions based on loop-header PHIs. 7286 SmallVector<Instruction *, 16> Worklist; 7287 Worklist.push_back(I); 7288 7289 SmallPtrSet<Instruction *, 8> Visited; 7290 while (!Worklist.empty()) { 7291 I = Worklist.pop_back_val(); 7292 if (!Visited.insert(I).second) 7293 continue; 7294 7295 ValueExprMapType::iterator It = 7296 ValueExprMap.find_as(static_cast<Value *>(I)); 7297 if (It != ValueExprMap.end()) { 7298 eraseValueFromMap(It->first); 7299 forgetMemoizedResults(It->second); 7300 if (PHINode *PN = dyn_cast<PHINode>(I)) 7301 ConstantEvolutionLoopExitValue.erase(PN); 7302 } 7303 7304 PushDefUseChildren(I, Worklist); 7305 } 7306 } 7307 7308 void ScalarEvolution::forgetLoopDispositions(const Loop *L) { 7309 LoopDispositions.clear(); 7310 } 7311 7312 /// Get the exact loop backedge taken count considering all loop exits. A 7313 /// computable result can only be returned for loops with all exiting blocks 7314 /// dominating the latch. howFarToZero assumes that the limit of each loop test 7315 /// is never skipped. This is a valid assumption as long as the loop exits via 7316 /// that test. For precise results, it is the caller's responsibility to specify 7317 /// the relevant loop exiting block using getExact(ExitingBlock, SE). 7318 const SCEV * 7319 ScalarEvolution::BackedgeTakenInfo::getExact(const Loop *L, ScalarEvolution *SE, 7320 SCEVUnionPredicate *Preds) const { 7321 // If any exits were not computable, the loop is not computable. 7322 if (!isComplete() || ExitNotTaken.empty()) 7323 return SE->getCouldNotCompute(); 7324 7325 const BasicBlock *Latch = L->getLoopLatch(); 7326 // All exiting blocks we have collected must dominate the only backedge. 7327 if (!Latch) 7328 return SE->getCouldNotCompute(); 7329 7330 // All exiting blocks we have gathered dominate loop's latch, so exact trip 7331 // count is simply a minimum out of all these calculated exit counts. 7332 SmallVector<const SCEV *, 2> Ops; 7333 for (auto &ENT : ExitNotTaken) { 7334 const SCEV *BECount = ENT.ExactNotTaken; 7335 assert(BECount != SE->getCouldNotCompute() && "Bad exit SCEV!"); 7336 assert(SE->DT.dominates(ENT.ExitingBlock, Latch) && 7337 "We should only have known counts for exiting blocks that dominate " 7338 "latch!"); 7339 7340 Ops.push_back(BECount); 7341 7342 if (Preds && !ENT.hasAlwaysTruePredicate()) 7343 Preds->add(ENT.Predicate.get()); 7344 7345 assert((Preds || ENT.hasAlwaysTruePredicate()) && 7346 "Predicate should be always true!"); 7347 } 7348 7349 return SE->getUMinFromMismatchedTypes(Ops); 7350 } 7351 7352 /// Get the exact not taken count for this loop exit. 7353 const SCEV * 7354 ScalarEvolution::BackedgeTakenInfo::getExact(const BasicBlock *ExitingBlock, 7355 ScalarEvolution *SE) const { 7356 for (auto &ENT : ExitNotTaken) 7357 if (ENT.ExitingBlock == ExitingBlock && ENT.hasAlwaysTruePredicate()) 7358 return ENT.ExactNotTaken; 7359 7360 return SE->getCouldNotCompute(); 7361 } 7362 7363 const SCEV *ScalarEvolution::BackedgeTakenInfo::getConstantMax( 7364 const BasicBlock *ExitingBlock, ScalarEvolution *SE) const { 7365 for (auto &ENT : ExitNotTaken) 7366 if (ENT.ExitingBlock == ExitingBlock && ENT.hasAlwaysTruePredicate()) 7367 return ENT.MaxNotTaken; 7368 7369 return SE->getCouldNotCompute(); 7370 } 7371 7372 /// getConstantMax - Get the constant max backedge taken count for the loop. 7373 const SCEV * 7374 ScalarEvolution::BackedgeTakenInfo::getConstantMax(ScalarEvolution *SE) const { 7375 auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) { 7376 return !ENT.hasAlwaysTruePredicate(); 7377 }; 7378 7379 if (any_of(ExitNotTaken, PredicateNotAlwaysTrue) || !getConstantMax()) 7380 return SE->getCouldNotCompute(); 7381 7382 assert((isa<SCEVCouldNotCompute>(getConstantMax()) || 7383 isa<SCEVConstant>(getConstantMax())) && 7384 "No point in having a non-constant max backedge taken count!"); 7385 return getConstantMax(); 7386 } 7387 7388 const SCEV * 7389 ScalarEvolution::BackedgeTakenInfo::getSymbolicMax(const Loop *L, 7390 ScalarEvolution *SE) { 7391 if (!SymbolicMax) 7392 SymbolicMax = SE->computeSymbolicMaxBackedgeTakenCount(L); 7393 return SymbolicMax; 7394 } 7395 7396 bool ScalarEvolution::BackedgeTakenInfo::isConstantMaxOrZero( 7397 ScalarEvolution *SE) const { 7398 auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) { 7399 return !ENT.hasAlwaysTruePredicate(); 7400 }; 7401 return MaxOrZero && !any_of(ExitNotTaken, PredicateNotAlwaysTrue); 7402 } 7403 7404 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S, 7405 ScalarEvolution *SE) const { 7406 if (getConstantMax() && getConstantMax() != SE->getCouldNotCompute() && 7407 SE->hasOperand(getConstantMax(), S)) 7408 return true; 7409 7410 for (auto &ENT : ExitNotTaken) 7411 if (ENT.ExactNotTaken != SE->getCouldNotCompute() && 7412 SE->hasOperand(ENT.ExactNotTaken, S)) 7413 return true; 7414 7415 return false; 7416 } 7417 7418 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E) 7419 : ExactNotTaken(E), MaxNotTaken(E) { 7420 assert((isa<SCEVCouldNotCompute>(MaxNotTaken) || 7421 isa<SCEVConstant>(MaxNotTaken)) && 7422 "No point in having a non-constant max backedge taken count!"); 7423 } 7424 7425 ScalarEvolution::ExitLimit::ExitLimit( 7426 const SCEV *E, const SCEV *M, bool MaxOrZero, 7427 ArrayRef<const SmallPtrSetImpl<const SCEVPredicate *> *> PredSetList) 7428 : ExactNotTaken(E), MaxNotTaken(M), MaxOrZero(MaxOrZero) { 7429 assert((isa<SCEVCouldNotCompute>(ExactNotTaken) || 7430 !isa<SCEVCouldNotCompute>(MaxNotTaken)) && 7431 "Exact is not allowed to be less precise than Max"); 7432 assert((isa<SCEVCouldNotCompute>(MaxNotTaken) || 7433 isa<SCEVConstant>(MaxNotTaken)) && 7434 "No point in having a non-constant max backedge taken count!"); 7435 for (auto *PredSet : PredSetList) 7436 for (auto *P : *PredSet) 7437 addPredicate(P); 7438 } 7439 7440 ScalarEvolution::ExitLimit::ExitLimit( 7441 const SCEV *E, const SCEV *M, bool MaxOrZero, 7442 const SmallPtrSetImpl<const SCEVPredicate *> &PredSet) 7443 : ExitLimit(E, M, MaxOrZero, {&PredSet}) { 7444 assert((isa<SCEVCouldNotCompute>(MaxNotTaken) || 7445 isa<SCEVConstant>(MaxNotTaken)) && 7446 "No point in having a non-constant max backedge taken count!"); 7447 } 7448 7449 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E, const SCEV *M, 7450 bool MaxOrZero) 7451 : ExitLimit(E, M, MaxOrZero, None) { 7452 assert((isa<SCEVCouldNotCompute>(MaxNotTaken) || 7453 isa<SCEVConstant>(MaxNotTaken)) && 7454 "No point in having a non-constant max backedge taken count!"); 7455 } 7456 7457 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each 7458 /// computable exit into a persistent ExitNotTakenInfo array. 7459 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo( 7460 ArrayRef<ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo> ExitCounts, 7461 bool IsComplete, const SCEV *ConstantMax, bool MaxOrZero) 7462 : ConstantMax(ConstantMax), IsComplete(IsComplete), MaxOrZero(MaxOrZero) { 7463 using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo; 7464 7465 ExitNotTaken.reserve(ExitCounts.size()); 7466 std::transform( 7467 ExitCounts.begin(), ExitCounts.end(), std::back_inserter(ExitNotTaken), 7468 [&](const EdgeExitInfo &EEI) { 7469 BasicBlock *ExitBB = EEI.first; 7470 const ExitLimit &EL = EEI.second; 7471 if (EL.Predicates.empty()) 7472 return ExitNotTakenInfo(ExitBB, EL.ExactNotTaken, EL.MaxNotTaken, 7473 nullptr); 7474 7475 std::unique_ptr<SCEVUnionPredicate> Predicate(new SCEVUnionPredicate); 7476 for (auto *Pred : EL.Predicates) 7477 Predicate->add(Pred); 7478 7479 return ExitNotTakenInfo(ExitBB, EL.ExactNotTaken, EL.MaxNotTaken, 7480 std::move(Predicate)); 7481 }); 7482 assert((isa<SCEVCouldNotCompute>(ConstantMax) || 7483 isa<SCEVConstant>(ConstantMax)) && 7484 "No point in having a non-constant max backedge taken count!"); 7485 } 7486 7487 /// Invalidate this result and free the ExitNotTakenInfo array. 7488 void ScalarEvolution::BackedgeTakenInfo::clear() { 7489 ExitNotTaken.clear(); 7490 } 7491 7492 /// Compute the number of times the backedge of the specified loop will execute. 7493 ScalarEvolution::BackedgeTakenInfo 7494 ScalarEvolution::computeBackedgeTakenCount(const Loop *L, 7495 bool AllowPredicates) { 7496 SmallVector<BasicBlock *, 8> ExitingBlocks; 7497 L->getExitingBlocks(ExitingBlocks); 7498 7499 using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo; 7500 7501 SmallVector<EdgeExitInfo, 4> ExitCounts; 7502 bool CouldComputeBECount = true; 7503 BasicBlock *Latch = L->getLoopLatch(); // may be NULL. 7504 const SCEV *MustExitMaxBECount = nullptr; 7505 const SCEV *MayExitMaxBECount = nullptr; 7506 bool MustExitMaxOrZero = false; 7507 7508 // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts 7509 // and compute maxBECount. 7510 // Do a union of all the predicates here. 7511 for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) { 7512 BasicBlock *ExitBB = ExitingBlocks[i]; 7513 7514 // We canonicalize untaken exits to br (constant), ignore them so that 7515 // proving an exit untaken doesn't negatively impact our ability to reason 7516 // about the loop as whole. 7517 if (auto *BI = dyn_cast<BranchInst>(ExitBB->getTerminator())) 7518 if (auto *CI = dyn_cast<ConstantInt>(BI->getCondition())) { 7519 bool ExitIfTrue = !L->contains(BI->getSuccessor(0)); 7520 if ((ExitIfTrue && CI->isZero()) || (!ExitIfTrue && CI->isOne())) 7521 continue; 7522 } 7523 7524 ExitLimit EL = computeExitLimit(L, ExitBB, AllowPredicates); 7525 7526 assert((AllowPredicates || EL.Predicates.empty()) && 7527 "Predicated exit limit when predicates are not allowed!"); 7528 7529 // 1. For each exit that can be computed, add an entry to ExitCounts. 7530 // CouldComputeBECount is true only if all exits can be computed. 7531 if (EL.ExactNotTaken == getCouldNotCompute()) 7532 // We couldn't compute an exact value for this exit, so 7533 // we won't be able to compute an exact value for the loop. 7534 CouldComputeBECount = false; 7535 else 7536 ExitCounts.emplace_back(ExitBB, EL); 7537 7538 // 2. Derive the loop's MaxBECount from each exit's max number of 7539 // non-exiting iterations. Partition the loop exits into two kinds: 7540 // LoopMustExits and LoopMayExits. 7541 // 7542 // If the exit dominates the loop latch, it is a LoopMustExit otherwise it 7543 // is a LoopMayExit. If any computable LoopMustExit is found, then 7544 // MaxBECount is the minimum EL.MaxNotTaken of computable 7545 // LoopMustExits. Otherwise, MaxBECount is conservatively the maximum 7546 // EL.MaxNotTaken, where CouldNotCompute is considered greater than any 7547 // computable EL.MaxNotTaken. 7548 if (EL.MaxNotTaken != getCouldNotCompute() && Latch && 7549 DT.dominates(ExitBB, Latch)) { 7550 if (!MustExitMaxBECount) { 7551 MustExitMaxBECount = EL.MaxNotTaken; 7552 MustExitMaxOrZero = EL.MaxOrZero; 7553 } else { 7554 MustExitMaxBECount = 7555 getUMinFromMismatchedTypes(MustExitMaxBECount, EL.MaxNotTaken); 7556 } 7557 } else if (MayExitMaxBECount != getCouldNotCompute()) { 7558 if (!MayExitMaxBECount || EL.MaxNotTaken == getCouldNotCompute()) 7559 MayExitMaxBECount = EL.MaxNotTaken; 7560 else { 7561 MayExitMaxBECount = 7562 getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.MaxNotTaken); 7563 } 7564 } 7565 } 7566 const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount : 7567 (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute()); 7568 // The loop backedge will be taken the maximum or zero times if there's 7569 // a single exit that must be taken the maximum or zero times. 7570 bool MaxOrZero = (MustExitMaxOrZero && ExitingBlocks.size() == 1); 7571 return BackedgeTakenInfo(std::move(ExitCounts), CouldComputeBECount, 7572 MaxBECount, MaxOrZero); 7573 } 7574 7575 ScalarEvolution::ExitLimit 7576 ScalarEvolution::computeExitLimit(const Loop *L, BasicBlock *ExitingBlock, 7577 bool AllowPredicates) { 7578 assert(L->contains(ExitingBlock) && "Exit count for non-loop block?"); 7579 // If our exiting block does not dominate the latch, then its connection with 7580 // loop's exit limit may be far from trivial. 7581 const BasicBlock *Latch = L->getLoopLatch(); 7582 if (!Latch || !DT.dominates(ExitingBlock, Latch)) 7583 return getCouldNotCompute(); 7584 7585 bool IsOnlyExit = (L->getExitingBlock() != nullptr); 7586 Instruction *Term = ExitingBlock->getTerminator(); 7587 if (BranchInst *BI = dyn_cast<BranchInst>(Term)) { 7588 assert(BI->isConditional() && "If unconditional, it can't be in loop!"); 7589 bool ExitIfTrue = !L->contains(BI->getSuccessor(0)); 7590 assert(ExitIfTrue == L->contains(BI->getSuccessor(1)) && 7591 "It should have one successor in loop and one exit block!"); 7592 // Proceed to the next level to examine the exit condition expression. 7593 return computeExitLimitFromCond( 7594 L, BI->getCondition(), ExitIfTrue, 7595 /*ControlsExit=*/IsOnlyExit, AllowPredicates); 7596 } 7597 7598 if (SwitchInst *SI = dyn_cast<SwitchInst>(Term)) { 7599 // For switch, make sure that there is a single exit from the loop. 7600 BasicBlock *Exit = nullptr; 7601 for (auto *SBB : successors(ExitingBlock)) 7602 if (!L->contains(SBB)) { 7603 if (Exit) // Multiple exit successors. 7604 return getCouldNotCompute(); 7605 Exit = SBB; 7606 } 7607 assert(Exit && "Exiting block must have at least one exit"); 7608 return computeExitLimitFromSingleExitSwitch(L, SI, Exit, 7609 /*ControlsExit=*/IsOnlyExit); 7610 } 7611 7612 return getCouldNotCompute(); 7613 } 7614 7615 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCond( 7616 const Loop *L, Value *ExitCond, bool ExitIfTrue, 7617 bool ControlsExit, bool AllowPredicates) { 7618 ScalarEvolution::ExitLimitCacheTy Cache(L, ExitIfTrue, AllowPredicates); 7619 return computeExitLimitFromCondCached(Cache, L, ExitCond, ExitIfTrue, 7620 ControlsExit, AllowPredicates); 7621 } 7622 7623 Optional<ScalarEvolution::ExitLimit> 7624 ScalarEvolution::ExitLimitCache::find(const Loop *L, Value *ExitCond, 7625 bool ExitIfTrue, bool ControlsExit, 7626 bool AllowPredicates) { 7627 (void)this->L; 7628 (void)this->ExitIfTrue; 7629 (void)this->AllowPredicates; 7630 7631 assert(this->L == L && this->ExitIfTrue == ExitIfTrue && 7632 this->AllowPredicates == AllowPredicates && 7633 "Variance in assumed invariant key components!"); 7634 auto Itr = TripCountMap.find({ExitCond, ControlsExit}); 7635 if (Itr == TripCountMap.end()) 7636 return None; 7637 return Itr->second; 7638 } 7639 7640 void ScalarEvolution::ExitLimitCache::insert(const Loop *L, Value *ExitCond, 7641 bool ExitIfTrue, 7642 bool ControlsExit, 7643 bool AllowPredicates, 7644 const ExitLimit &EL) { 7645 assert(this->L == L && this->ExitIfTrue == ExitIfTrue && 7646 this->AllowPredicates == AllowPredicates && 7647 "Variance in assumed invariant key components!"); 7648 7649 auto InsertResult = TripCountMap.insert({{ExitCond, ControlsExit}, EL}); 7650 assert(InsertResult.second && "Expected successful insertion!"); 7651 (void)InsertResult; 7652 (void)ExitIfTrue; 7653 } 7654 7655 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondCached( 7656 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 7657 bool ControlsExit, bool AllowPredicates) { 7658 7659 if (auto MaybeEL = 7660 Cache.find(L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates)) 7661 return *MaybeEL; 7662 7663 ExitLimit EL = computeExitLimitFromCondImpl(Cache, L, ExitCond, ExitIfTrue, 7664 ControlsExit, AllowPredicates); 7665 Cache.insert(L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates, EL); 7666 return EL; 7667 } 7668 7669 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondImpl( 7670 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 7671 bool ControlsExit, bool AllowPredicates) { 7672 // Handle BinOp conditions (And, Or). 7673 if (auto LimitFromBinOp = computeExitLimitFromCondFromBinOp( 7674 Cache, L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates)) 7675 return *LimitFromBinOp; 7676 7677 // With an icmp, it may be feasible to compute an exact backedge-taken count. 7678 // Proceed to the next level to examine the icmp. 7679 if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond)) { 7680 ExitLimit EL = 7681 computeExitLimitFromICmp(L, ExitCondICmp, ExitIfTrue, ControlsExit); 7682 if (EL.hasFullInfo() || !AllowPredicates) 7683 return EL; 7684 7685 // Try again, but use SCEV predicates this time. 7686 return computeExitLimitFromICmp(L, ExitCondICmp, ExitIfTrue, ControlsExit, 7687 /*AllowPredicates=*/true); 7688 } 7689 7690 // Check for a constant condition. These are normally stripped out by 7691 // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to 7692 // preserve the CFG and is temporarily leaving constant conditions 7693 // in place. 7694 if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) { 7695 if (ExitIfTrue == !CI->getZExtValue()) 7696 // The backedge is always taken. 7697 return getCouldNotCompute(); 7698 else 7699 // The backedge is never taken. 7700 return getZero(CI->getType()); 7701 } 7702 7703 // If it's not an integer or pointer comparison then compute it the hard way. 7704 return computeExitCountExhaustively(L, ExitCond, ExitIfTrue); 7705 } 7706 7707 Optional<ScalarEvolution::ExitLimit> 7708 ScalarEvolution::computeExitLimitFromCondFromBinOp( 7709 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 7710 bool ControlsExit, bool AllowPredicates) { 7711 // Check if the controlling expression for this loop is an And or Or. 7712 Value *Op0, *Op1; 7713 bool IsAnd = false; 7714 if (match(ExitCond, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) 7715 IsAnd = true; 7716 else if (match(ExitCond, m_LogicalOr(m_Value(Op0), m_Value(Op1)))) 7717 IsAnd = false; 7718 else 7719 return None; 7720 7721 // EitherMayExit is true in these two cases: 7722 // br (and Op0 Op1), loop, exit 7723 // br (or Op0 Op1), exit, loop 7724 bool EitherMayExit = IsAnd ^ ExitIfTrue; 7725 ExitLimit EL0 = computeExitLimitFromCondCached(Cache, L, Op0, ExitIfTrue, 7726 ControlsExit && !EitherMayExit, 7727 AllowPredicates); 7728 ExitLimit EL1 = computeExitLimitFromCondCached(Cache, L, Op1, ExitIfTrue, 7729 ControlsExit && !EitherMayExit, 7730 AllowPredicates); 7731 7732 // Be robust against unsimplified IR for the form "op i1 X, NeutralElement" 7733 const Constant *NeutralElement = ConstantInt::get(ExitCond->getType(), IsAnd); 7734 if (isa<ConstantInt>(Op1)) 7735 return Op1 == NeutralElement ? EL0 : EL1; 7736 if (isa<ConstantInt>(Op0)) 7737 return Op0 == NeutralElement ? EL1 : EL0; 7738 7739 const SCEV *BECount = getCouldNotCompute(); 7740 const SCEV *MaxBECount = getCouldNotCompute(); 7741 if (EitherMayExit) { 7742 // Both conditions must be same for the loop to continue executing. 7743 // Choose the less conservative count. 7744 // If ExitCond is a short-circuit form (select), using 7745 // umin(EL0.ExactNotTaken, EL1.ExactNotTaken) is unsafe in general. 7746 // To see the detailed examples, please see 7747 // test/Analysis/ScalarEvolution/exit-count-select.ll 7748 bool PoisonSafe = isa<BinaryOperator>(ExitCond); 7749 if (!PoisonSafe) 7750 // Even if ExitCond is select, we can safely derive BECount using both 7751 // EL0 and EL1 in these cases: 7752 // (1) EL0.ExactNotTaken is non-zero 7753 // (2) EL1.ExactNotTaken is non-poison 7754 // (3) EL0.ExactNotTaken is zero (BECount should be simply zero and 7755 // it cannot be umin(0, ..)) 7756 // The PoisonSafe assignment below is simplified and the assertion after 7757 // BECount calculation fully guarantees the condition (3). 7758 PoisonSafe = isa<SCEVConstant>(EL0.ExactNotTaken) || 7759 isa<SCEVConstant>(EL1.ExactNotTaken); 7760 if (EL0.ExactNotTaken != getCouldNotCompute() && 7761 EL1.ExactNotTaken != getCouldNotCompute() && PoisonSafe) { 7762 BECount = 7763 getUMinFromMismatchedTypes(EL0.ExactNotTaken, EL1.ExactNotTaken); 7764 7765 // If EL0.ExactNotTaken was zero and ExitCond was a short-circuit form, 7766 // it should have been simplified to zero (see the condition (3) above) 7767 assert(!isa<BinaryOperator>(ExitCond) || !EL0.ExactNotTaken->isZero() || 7768 BECount->isZero()); 7769 } 7770 if (EL0.MaxNotTaken == getCouldNotCompute()) 7771 MaxBECount = EL1.MaxNotTaken; 7772 else if (EL1.MaxNotTaken == getCouldNotCompute()) 7773 MaxBECount = EL0.MaxNotTaken; 7774 else 7775 MaxBECount = getUMinFromMismatchedTypes(EL0.MaxNotTaken, EL1.MaxNotTaken); 7776 } else { 7777 // Both conditions must be same at the same time for the loop to exit. 7778 // For now, be conservative. 7779 if (EL0.ExactNotTaken == EL1.ExactNotTaken) 7780 BECount = EL0.ExactNotTaken; 7781 } 7782 7783 // There are cases (e.g. PR26207) where computeExitLimitFromCond is able 7784 // to be more aggressive when computing BECount than when computing 7785 // MaxBECount. In these cases it is possible for EL0.ExactNotTaken and 7786 // EL1.ExactNotTaken to match, but for EL0.MaxNotTaken and EL1.MaxNotTaken 7787 // to not. 7788 if (isa<SCEVCouldNotCompute>(MaxBECount) && 7789 !isa<SCEVCouldNotCompute>(BECount)) 7790 MaxBECount = getConstant(getUnsignedRangeMax(BECount)); 7791 7792 return ExitLimit(BECount, MaxBECount, false, 7793 { &EL0.Predicates, &EL1.Predicates }); 7794 } 7795 7796 ScalarEvolution::ExitLimit 7797 ScalarEvolution::computeExitLimitFromICmp(const Loop *L, 7798 ICmpInst *ExitCond, 7799 bool ExitIfTrue, 7800 bool ControlsExit, 7801 bool AllowPredicates) { 7802 // If the condition was exit on true, convert the condition to exit on false 7803 ICmpInst::Predicate Pred; 7804 if (!ExitIfTrue) 7805 Pred = ExitCond->getPredicate(); 7806 else 7807 Pred = ExitCond->getInversePredicate(); 7808 const ICmpInst::Predicate OriginalPred = Pred; 7809 7810 // Handle common loops like: for (X = "string"; *X; ++X) 7811 if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0))) 7812 if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) { 7813 ExitLimit ItCnt = 7814 computeLoadConstantCompareExitLimit(LI, RHS, L, Pred); 7815 if (ItCnt.hasAnyInfo()) 7816 return ItCnt; 7817 } 7818 7819 const SCEV *LHS = getSCEV(ExitCond->getOperand(0)); 7820 const SCEV *RHS = getSCEV(ExitCond->getOperand(1)); 7821 7822 // Try to evaluate any dependencies out of the loop. 7823 LHS = getSCEVAtScope(LHS, L); 7824 RHS = getSCEVAtScope(RHS, L); 7825 7826 // At this point, we would like to compute how many iterations of the 7827 // loop the predicate will return true for these inputs. 7828 if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) { 7829 // If there is a loop-invariant, force it into the RHS. 7830 std::swap(LHS, RHS); 7831 Pred = ICmpInst::getSwappedPredicate(Pred); 7832 } 7833 7834 // Simplify the operands before analyzing them. 7835 (void)SimplifyICmpOperands(Pred, LHS, RHS); 7836 7837 // If we have a comparison of a chrec against a constant, try to use value 7838 // ranges to answer this query. 7839 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) 7840 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS)) 7841 if (AddRec->getLoop() == L) { 7842 // Form the constant range. 7843 ConstantRange CompRange = 7844 ConstantRange::makeExactICmpRegion(Pred, RHSC->getAPInt()); 7845 7846 const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this); 7847 if (!isa<SCEVCouldNotCompute>(Ret)) return Ret; 7848 } 7849 7850 switch (Pred) { 7851 case ICmpInst::ICMP_NE: { // while (X != Y) 7852 // Convert to: while (X-Y != 0) 7853 ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit, 7854 AllowPredicates); 7855 if (EL.hasAnyInfo()) return EL; 7856 break; 7857 } 7858 case ICmpInst::ICMP_EQ: { // while (X == Y) 7859 // Convert to: while (X-Y == 0) 7860 ExitLimit EL = howFarToNonZero(getMinusSCEV(LHS, RHS), L); 7861 if (EL.hasAnyInfo()) return EL; 7862 break; 7863 } 7864 case ICmpInst::ICMP_SLT: 7865 case ICmpInst::ICMP_ULT: { // while (X < Y) 7866 bool IsSigned = Pred == ICmpInst::ICMP_SLT; 7867 ExitLimit EL = howManyLessThans(LHS, RHS, L, IsSigned, ControlsExit, 7868 AllowPredicates); 7869 if (EL.hasAnyInfo()) return EL; 7870 break; 7871 } 7872 case ICmpInst::ICMP_SGT: 7873 case ICmpInst::ICMP_UGT: { // while (X > Y) 7874 bool IsSigned = Pred == ICmpInst::ICMP_SGT; 7875 ExitLimit EL = 7876 howManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit, 7877 AllowPredicates); 7878 if (EL.hasAnyInfo()) return EL; 7879 break; 7880 } 7881 default: 7882 break; 7883 } 7884 7885 auto *ExhaustiveCount = 7886 computeExitCountExhaustively(L, ExitCond, ExitIfTrue); 7887 7888 if (!isa<SCEVCouldNotCompute>(ExhaustiveCount)) 7889 return ExhaustiveCount; 7890 7891 return computeShiftCompareExitLimit(ExitCond->getOperand(0), 7892 ExitCond->getOperand(1), L, OriginalPred); 7893 } 7894 7895 ScalarEvolution::ExitLimit 7896 ScalarEvolution::computeExitLimitFromSingleExitSwitch(const Loop *L, 7897 SwitchInst *Switch, 7898 BasicBlock *ExitingBlock, 7899 bool ControlsExit) { 7900 assert(!L->contains(ExitingBlock) && "Not an exiting block!"); 7901 7902 // Give up if the exit is the default dest of a switch. 7903 if (Switch->getDefaultDest() == ExitingBlock) 7904 return getCouldNotCompute(); 7905 7906 assert(L->contains(Switch->getDefaultDest()) && 7907 "Default case must not exit the loop!"); 7908 const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L); 7909 const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock)); 7910 7911 // while (X != Y) --> while (X-Y != 0) 7912 ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit); 7913 if (EL.hasAnyInfo()) 7914 return EL; 7915 7916 return getCouldNotCompute(); 7917 } 7918 7919 static ConstantInt * 7920 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C, 7921 ScalarEvolution &SE) { 7922 const SCEV *InVal = SE.getConstant(C); 7923 const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE); 7924 assert(isa<SCEVConstant>(Val) && 7925 "Evaluation of SCEV at constant didn't fold correctly?"); 7926 return cast<SCEVConstant>(Val)->getValue(); 7927 } 7928 7929 /// Given an exit condition of 'icmp op load X, cst', try to see if we can 7930 /// compute the backedge execution count. 7931 ScalarEvolution::ExitLimit 7932 ScalarEvolution::computeLoadConstantCompareExitLimit( 7933 LoadInst *LI, 7934 Constant *RHS, 7935 const Loop *L, 7936 ICmpInst::Predicate predicate) { 7937 if (LI->isVolatile()) return getCouldNotCompute(); 7938 7939 // Check to see if the loaded pointer is a getelementptr of a global. 7940 // TODO: Use SCEV instead of manually grubbing with GEPs. 7941 GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0)); 7942 if (!GEP) return getCouldNotCompute(); 7943 7944 // Make sure that it is really a constant global we are gepping, with an 7945 // initializer, and make sure the first IDX is really 0. 7946 GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)); 7947 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() || 7948 GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) || 7949 !cast<Constant>(GEP->getOperand(1))->isNullValue()) 7950 return getCouldNotCompute(); 7951 7952 // Okay, we allow one non-constant index into the GEP instruction. 7953 Value *VarIdx = nullptr; 7954 std::vector<Constant*> Indexes; 7955 unsigned VarIdxNum = 0; 7956 for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i) 7957 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) { 7958 Indexes.push_back(CI); 7959 } else if (!isa<ConstantInt>(GEP->getOperand(i))) { 7960 if (VarIdx) return getCouldNotCompute(); // Multiple non-constant idx's. 7961 VarIdx = GEP->getOperand(i); 7962 VarIdxNum = i-2; 7963 Indexes.push_back(nullptr); 7964 } 7965 7966 // Loop-invariant loads may be a byproduct of loop optimization. Skip them. 7967 if (!VarIdx) 7968 return getCouldNotCompute(); 7969 7970 // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant. 7971 // Check to see if X is a loop variant variable value now. 7972 const SCEV *Idx = getSCEV(VarIdx); 7973 Idx = getSCEVAtScope(Idx, L); 7974 7975 // We can only recognize very limited forms of loop index expressions, in 7976 // particular, only affine AddRec's like {C1,+,C2}<L>. 7977 const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx); 7978 if (!IdxExpr || IdxExpr->getLoop() != L || !IdxExpr->isAffine() || 7979 isLoopInvariant(IdxExpr, L) || 7980 !isa<SCEVConstant>(IdxExpr->getOperand(0)) || 7981 !isa<SCEVConstant>(IdxExpr->getOperand(1))) 7982 return getCouldNotCompute(); 7983 7984 unsigned MaxSteps = MaxBruteForceIterations; 7985 for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) { 7986 ConstantInt *ItCst = ConstantInt::get( 7987 cast<IntegerType>(IdxExpr->getType()), IterationNum); 7988 ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this); 7989 7990 // Form the GEP offset. 7991 Indexes[VarIdxNum] = Val; 7992 7993 Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(), 7994 Indexes); 7995 if (!Result) break; // Cannot compute! 7996 7997 // Evaluate the condition for this iteration. 7998 Result = ConstantExpr::getICmp(predicate, Result, RHS); 7999 if (!isa<ConstantInt>(Result)) break; // Couldn't decide for sure 8000 if (cast<ConstantInt>(Result)->getValue().isMinValue()) { 8001 ++NumArrayLenItCounts; 8002 return getConstant(ItCst); // Found terminating iteration! 8003 } 8004 } 8005 return getCouldNotCompute(); 8006 } 8007 8008 ScalarEvolution::ExitLimit ScalarEvolution::computeShiftCompareExitLimit( 8009 Value *LHS, Value *RHSV, const Loop *L, ICmpInst::Predicate Pred) { 8010 ConstantInt *RHS = dyn_cast<ConstantInt>(RHSV); 8011 if (!RHS) 8012 return getCouldNotCompute(); 8013 8014 const BasicBlock *Latch = L->getLoopLatch(); 8015 if (!Latch) 8016 return getCouldNotCompute(); 8017 8018 const BasicBlock *Predecessor = L->getLoopPredecessor(); 8019 if (!Predecessor) 8020 return getCouldNotCompute(); 8021 8022 // Return true if V is of the form "LHS `shift_op` <positive constant>". 8023 // Return LHS in OutLHS and shift_opt in OutOpCode. 8024 auto MatchPositiveShift = 8025 [](Value *V, Value *&OutLHS, Instruction::BinaryOps &OutOpCode) { 8026 8027 using namespace PatternMatch; 8028 8029 ConstantInt *ShiftAmt; 8030 if (match(V, m_LShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8031 OutOpCode = Instruction::LShr; 8032 else if (match(V, m_AShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8033 OutOpCode = Instruction::AShr; 8034 else if (match(V, m_Shl(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8035 OutOpCode = Instruction::Shl; 8036 else 8037 return false; 8038 8039 return ShiftAmt->getValue().isStrictlyPositive(); 8040 }; 8041 8042 // Recognize a "shift recurrence" either of the form %iv or of %iv.shifted in 8043 // 8044 // loop: 8045 // %iv = phi i32 [ %iv.shifted, %loop ], [ %val, %preheader ] 8046 // %iv.shifted = lshr i32 %iv, <positive constant> 8047 // 8048 // Return true on a successful match. Return the corresponding PHI node (%iv 8049 // above) in PNOut and the opcode of the shift operation in OpCodeOut. 8050 auto MatchShiftRecurrence = 8051 [&](Value *V, PHINode *&PNOut, Instruction::BinaryOps &OpCodeOut) { 8052 Optional<Instruction::BinaryOps> PostShiftOpCode; 8053 8054 { 8055 Instruction::BinaryOps OpC; 8056 Value *V; 8057 8058 // If we encounter a shift instruction, "peel off" the shift operation, 8059 // and remember that we did so. Later when we inspect %iv's backedge 8060 // value, we will make sure that the backedge value uses the same 8061 // operation. 8062 // 8063 // Note: the peeled shift operation does not have to be the same 8064 // instruction as the one feeding into the PHI's backedge value. We only 8065 // really care about it being the same *kind* of shift instruction -- 8066 // that's all that is required for our later inferences to hold. 8067 if (MatchPositiveShift(LHS, V, OpC)) { 8068 PostShiftOpCode = OpC; 8069 LHS = V; 8070 } 8071 } 8072 8073 PNOut = dyn_cast<PHINode>(LHS); 8074 if (!PNOut || PNOut->getParent() != L->getHeader()) 8075 return false; 8076 8077 Value *BEValue = PNOut->getIncomingValueForBlock(Latch); 8078 Value *OpLHS; 8079 8080 return 8081 // The backedge value for the PHI node must be a shift by a positive 8082 // amount 8083 MatchPositiveShift(BEValue, OpLHS, OpCodeOut) && 8084 8085 // of the PHI node itself 8086 OpLHS == PNOut && 8087 8088 // and the kind of shift should be match the kind of shift we peeled 8089 // off, if any. 8090 (!PostShiftOpCode.hasValue() || *PostShiftOpCode == OpCodeOut); 8091 }; 8092 8093 PHINode *PN; 8094 Instruction::BinaryOps OpCode; 8095 if (!MatchShiftRecurrence(LHS, PN, OpCode)) 8096 return getCouldNotCompute(); 8097 8098 const DataLayout &DL = getDataLayout(); 8099 8100 // The key rationale for this optimization is that for some kinds of shift 8101 // recurrences, the value of the recurrence "stabilizes" to either 0 or -1 8102 // within a finite number of iterations. If the condition guarding the 8103 // backedge (in the sense that the backedge is taken if the condition is true) 8104 // is false for the value the shift recurrence stabilizes to, then we know 8105 // that the backedge is taken only a finite number of times. 8106 8107 ConstantInt *StableValue = nullptr; 8108 switch (OpCode) { 8109 default: 8110 llvm_unreachable("Impossible case!"); 8111 8112 case Instruction::AShr: { 8113 // {K,ashr,<positive-constant>} stabilizes to signum(K) in at most 8114 // bitwidth(K) iterations. 8115 Value *FirstValue = PN->getIncomingValueForBlock(Predecessor); 8116 KnownBits Known = computeKnownBits(FirstValue, DL, 0, &AC, 8117 Predecessor->getTerminator(), &DT); 8118 auto *Ty = cast<IntegerType>(RHS->getType()); 8119 if (Known.isNonNegative()) 8120 StableValue = ConstantInt::get(Ty, 0); 8121 else if (Known.isNegative()) 8122 StableValue = ConstantInt::get(Ty, -1, true); 8123 else 8124 return getCouldNotCompute(); 8125 8126 break; 8127 } 8128 case Instruction::LShr: 8129 case Instruction::Shl: 8130 // Both {K,lshr,<positive-constant>} and {K,shl,<positive-constant>} 8131 // stabilize to 0 in at most bitwidth(K) iterations. 8132 StableValue = ConstantInt::get(cast<IntegerType>(RHS->getType()), 0); 8133 break; 8134 } 8135 8136 auto *Result = 8137 ConstantFoldCompareInstOperands(Pred, StableValue, RHS, DL, &TLI); 8138 assert(Result->getType()->isIntegerTy(1) && 8139 "Otherwise cannot be an operand to a branch instruction"); 8140 8141 if (Result->isZeroValue()) { 8142 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 8143 const SCEV *UpperBound = 8144 getConstant(getEffectiveSCEVType(RHS->getType()), BitWidth); 8145 return ExitLimit(getCouldNotCompute(), UpperBound, false); 8146 } 8147 8148 return getCouldNotCompute(); 8149 } 8150 8151 /// Return true if we can constant fold an instruction of the specified type, 8152 /// assuming that all operands were constants. 8153 static bool CanConstantFold(const Instruction *I) { 8154 if (isa<BinaryOperator>(I) || isa<CmpInst>(I) || 8155 isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) || 8156 isa<LoadInst>(I) || isa<ExtractValueInst>(I)) 8157 return true; 8158 8159 if (const CallInst *CI = dyn_cast<CallInst>(I)) 8160 if (const Function *F = CI->getCalledFunction()) 8161 return canConstantFoldCallTo(CI, F); 8162 return false; 8163 } 8164 8165 /// Determine whether this instruction can constant evolve within this loop 8166 /// assuming its operands can all constant evolve. 8167 static bool canConstantEvolve(Instruction *I, const Loop *L) { 8168 // An instruction outside of the loop can't be derived from a loop PHI. 8169 if (!L->contains(I)) return false; 8170 8171 if (isa<PHINode>(I)) { 8172 // We don't currently keep track of the control flow needed to evaluate 8173 // PHIs, so we cannot handle PHIs inside of loops. 8174 return L->getHeader() == I->getParent(); 8175 } 8176 8177 // If we won't be able to constant fold this expression even if the operands 8178 // are constants, bail early. 8179 return CanConstantFold(I); 8180 } 8181 8182 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by 8183 /// recursing through each instruction operand until reaching a loop header phi. 8184 static PHINode * 8185 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L, 8186 DenseMap<Instruction *, PHINode *> &PHIMap, 8187 unsigned Depth) { 8188 if (Depth > MaxConstantEvolvingDepth) 8189 return nullptr; 8190 8191 // Otherwise, we can evaluate this instruction if all of its operands are 8192 // constant or derived from a PHI node themselves. 8193 PHINode *PHI = nullptr; 8194 for (Value *Op : UseInst->operands()) { 8195 if (isa<Constant>(Op)) continue; 8196 8197 Instruction *OpInst = dyn_cast<Instruction>(Op); 8198 if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr; 8199 8200 PHINode *P = dyn_cast<PHINode>(OpInst); 8201 if (!P) 8202 // If this operand is already visited, reuse the prior result. 8203 // We may have P != PHI if this is the deepest point at which the 8204 // inconsistent paths meet. 8205 P = PHIMap.lookup(OpInst); 8206 if (!P) { 8207 // Recurse and memoize the results, whether a phi is found or not. 8208 // This recursive call invalidates pointers into PHIMap. 8209 P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap, Depth + 1); 8210 PHIMap[OpInst] = P; 8211 } 8212 if (!P) 8213 return nullptr; // Not evolving from PHI 8214 if (PHI && PHI != P) 8215 return nullptr; // Evolving from multiple different PHIs. 8216 PHI = P; 8217 } 8218 // This is a expression evolving from a constant PHI! 8219 return PHI; 8220 } 8221 8222 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node 8223 /// in the loop that V is derived from. We allow arbitrary operations along the 8224 /// way, but the operands of an operation must either be constants or a value 8225 /// derived from a constant PHI. If this expression does not fit with these 8226 /// constraints, return null. 8227 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) { 8228 Instruction *I = dyn_cast<Instruction>(V); 8229 if (!I || !canConstantEvolve(I, L)) return nullptr; 8230 8231 if (PHINode *PN = dyn_cast<PHINode>(I)) 8232 return PN; 8233 8234 // Record non-constant instructions contained by the loop. 8235 DenseMap<Instruction *, PHINode *> PHIMap; 8236 return getConstantEvolvingPHIOperands(I, L, PHIMap, 0); 8237 } 8238 8239 /// EvaluateExpression - Given an expression that passes the 8240 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node 8241 /// in the loop has the value PHIVal. If we can't fold this expression for some 8242 /// reason, return null. 8243 static Constant *EvaluateExpression(Value *V, const Loop *L, 8244 DenseMap<Instruction *, Constant *> &Vals, 8245 const DataLayout &DL, 8246 const TargetLibraryInfo *TLI) { 8247 // Convenient constant check, but redundant for recursive calls. 8248 if (Constant *C = dyn_cast<Constant>(V)) return C; 8249 Instruction *I = dyn_cast<Instruction>(V); 8250 if (!I) return nullptr; 8251 8252 if (Constant *C = Vals.lookup(I)) return C; 8253 8254 // An instruction inside the loop depends on a value outside the loop that we 8255 // weren't given a mapping for, or a value such as a call inside the loop. 8256 if (!canConstantEvolve(I, L)) return nullptr; 8257 8258 // An unmapped PHI can be due to a branch or another loop inside this loop, 8259 // or due to this not being the initial iteration through a loop where we 8260 // couldn't compute the evolution of this particular PHI last time. 8261 if (isa<PHINode>(I)) return nullptr; 8262 8263 std::vector<Constant*> Operands(I->getNumOperands()); 8264 8265 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) { 8266 Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i)); 8267 if (!Operand) { 8268 Operands[i] = dyn_cast<Constant>(I->getOperand(i)); 8269 if (!Operands[i]) return nullptr; 8270 continue; 8271 } 8272 Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI); 8273 Vals[Operand] = C; 8274 if (!C) return nullptr; 8275 Operands[i] = C; 8276 } 8277 8278 if (CmpInst *CI = dyn_cast<CmpInst>(I)) 8279 return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0], 8280 Operands[1], DL, TLI); 8281 if (LoadInst *LI = dyn_cast<LoadInst>(I)) { 8282 if (!LI->isVolatile()) 8283 return ConstantFoldLoadFromConstPtr(Operands[0], LI->getType(), DL); 8284 } 8285 return ConstantFoldInstOperands(I, Operands, DL, TLI); 8286 } 8287 8288 8289 // If every incoming value to PN except the one for BB is a specific Constant, 8290 // return that, else return nullptr. 8291 static Constant *getOtherIncomingValue(PHINode *PN, BasicBlock *BB) { 8292 Constant *IncomingVal = nullptr; 8293 8294 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 8295 if (PN->getIncomingBlock(i) == BB) 8296 continue; 8297 8298 auto *CurrentVal = dyn_cast<Constant>(PN->getIncomingValue(i)); 8299 if (!CurrentVal) 8300 return nullptr; 8301 8302 if (IncomingVal != CurrentVal) { 8303 if (IncomingVal) 8304 return nullptr; 8305 IncomingVal = CurrentVal; 8306 } 8307 } 8308 8309 return IncomingVal; 8310 } 8311 8312 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is 8313 /// in the header of its containing loop, we know the loop executes a 8314 /// constant number of times, and the PHI node is just a recurrence 8315 /// involving constants, fold it. 8316 Constant * 8317 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN, 8318 const APInt &BEs, 8319 const Loop *L) { 8320 auto I = ConstantEvolutionLoopExitValue.find(PN); 8321 if (I != ConstantEvolutionLoopExitValue.end()) 8322 return I->second; 8323 8324 if (BEs.ugt(MaxBruteForceIterations)) 8325 return ConstantEvolutionLoopExitValue[PN] = nullptr; // Not going to evaluate it. 8326 8327 Constant *&RetVal = ConstantEvolutionLoopExitValue[PN]; 8328 8329 DenseMap<Instruction *, Constant *> CurrentIterVals; 8330 BasicBlock *Header = L->getHeader(); 8331 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!"); 8332 8333 BasicBlock *Latch = L->getLoopLatch(); 8334 if (!Latch) 8335 return nullptr; 8336 8337 for (PHINode &PHI : Header->phis()) { 8338 if (auto *StartCST = getOtherIncomingValue(&PHI, Latch)) 8339 CurrentIterVals[&PHI] = StartCST; 8340 } 8341 if (!CurrentIterVals.count(PN)) 8342 return RetVal = nullptr; 8343 8344 Value *BEValue = PN->getIncomingValueForBlock(Latch); 8345 8346 // Execute the loop symbolically to determine the exit value. 8347 assert(BEs.getActiveBits() < CHAR_BIT * sizeof(unsigned) && 8348 "BEs is <= MaxBruteForceIterations which is an 'unsigned'!"); 8349 8350 unsigned NumIterations = BEs.getZExtValue(); // must be in range 8351 unsigned IterationNum = 0; 8352 const DataLayout &DL = getDataLayout(); 8353 for (; ; ++IterationNum) { 8354 if (IterationNum == NumIterations) 8355 return RetVal = CurrentIterVals[PN]; // Got exit value! 8356 8357 // Compute the value of the PHIs for the next iteration. 8358 // EvaluateExpression adds non-phi values to the CurrentIterVals map. 8359 DenseMap<Instruction *, Constant *> NextIterVals; 8360 Constant *NextPHI = 8361 EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 8362 if (!NextPHI) 8363 return nullptr; // Couldn't evaluate! 8364 NextIterVals[PN] = NextPHI; 8365 8366 bool StoppedEvolving = NextPHI == CurrentIterVals[PN]; 8367 8368 // Also evaluate the other PHI nodes. However, we don't get to stop if we 8369 // cease to be able to evaluate one of them or if they stop evolving, 8370 // because that doesn't necessarily prevent us from computing PN. 8371 SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute; 8372 for (const auto &I : CurrentIterVals) { 8373 PHINode *PHI = dyn_cast<PHINode>(I.first); 8374 if (!PHI || PHI == PN || PHI->getParent() != Header) continue; 8375 PHIsToCompute.emplace_back(PHI, I.second); 8376 } 8377 // We use two distinct loops because EvaluateExpression may invalidate any 8378 // iterators into CurrentIterVals. 8379 for (const auto &I : PHIsToCompute) { 8380 PHINode *PHI = I.first; 8381 Constant *&NextPHI = NextIterVals[PHI]; 8382 if (!NextPHI) { // Not already computed. 8383 Value *BEValue = PHI->getIncomingValueForBlock(Latch); 8384 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 8385 } 8386 if (NextPHI != I.second) 8387 StoppedEvolving = false; 8388 } 8389 8390 // If all entries in CurrentIterVals == NextIterVals then we can stop 8391 // iterating, the loop can't continue to change. 8392 if (StoppedEvolving) 8393 return RetVal = CurrentIterVals[PN]; 8394 8395 CurrentIterVals.swap(NextIterVals); 8396 } 8397 } 8398 8399 const SCEV *ScalarEvolution::computeExitCountExhaustively(const Loop *L, 8400 Value *Cond, 8401 bool ExitWhen) { 8402 PHINode *PN = getConstantEvolvingPHI(Cond, L); 8403 if (!PN) return getCouldNotCompute(); 8404 8405 // If the loop is canonicalized, the PHI will have exactly two entries. 8406 // That's the only form we support here. 8407 if (PN->getNumIncomingValues() != 2) return getCouldNotCompute(); 8408 8409 DenseMap<Instruction *, Constant *> CurrentIterVals; 8410 BasicBlock *Header = L->getHeader(); 8411 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!"); 8412 8413 BasicBlock *Latch = L->getLoopLatch(); 8414 assert(Latch && "Should follow from NumIncomingValues == 2!"); 8415 8416 for (PHINode &PHI : Header->phis()) { 8417 if (auto *StartCST = getOtherIncomingValue(&PHI, Latch)) 8418 CurrentIterVals[&PHI] = StartCST; 8419 } 8420 if (!CurrentIterVals.count(PN)) 8421 return getCouldNotCompute(); 8422 8423 // Okay, we find a PHI node that defines the trip count of this loop. Execute 8424 // the loop symbolically to determine when the condition gets a value of 8425 // "ExitWhen". 8426 unsigned MaxIterations = MaxBruteForceIterations; // Limit analysis. 8427 const DataLayout &DL = getDataLayout(); 8428 for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){ 8429 auto *CondVal = dyn_cast_or_null<ConstantInt>( 8430 EvaluateExpression(Cond, L, CurrentIterVals, DL, &TLI)); 8431 8432 // Couldn't symbolically evaluate. 8433 if (!CondVal) return getCouldNotCompute(); 8434 8435 if (CondVal->getValue() == uint64_t(ExitWhen)) { 8436 ++NumBruteForceTripCountsComputed; 8437 return getConstant(Type::getInt32Ty(getContext()), IterationNum); 8438 } 8439 8440 // Update all the PHI nodes for the next iteration. 8441 DenseMap<Instruction *, Constant *> NextIterVals; 8442 8443 // Create a list of which PHIs we need to compute. We want to do this before 8444 // calling EvaluateExpression on them because that may invalidate iterators 8445 // into CurrentIterVals. 8446 SmallVector<PHINode *, 8> PHIsToCompute; 8447 for (const auto &I : CurrentIterVals) { 8448 PHINode *PHI = dyn_cast<PHINode>(I.first); 8449 if (!PHI || PHI->getParent() != Header) continue; 8450 PHIsToCompute.push_back(PHI); 8451 } 8452 for (PHINode *PHI : PHIsToCompute) { 8453 Constant *&NextPHI = NextIterVals[PHI]; 8454 if (NextPHI) continue; // Already computed! 8455 8456 Value *BEValue = PHI->getIncomingValueForBlock(Latch); 8457 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 8458 } 8459 CurrentIterVals.swap(NextIterVals); 8460 } 8461 8462 // Too many iterations were needed to evaluate. 8463 return getCouldNotCompute(); 8464 } 8465 8466 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) { 8467 SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values = 8468 ValuesAtScopes[V]; 8469 // Check to see if we've folded this expression at this loop before. 8470 for (auto &LS : Values) 8471 if (LS.first == L) 8472 return LS.second ? LS.second : V; 8473 8474 Values.emplace_back(L, nullptr); 8475 8476 // Otherwise compute it. 8477 const SCEV *C = computeSCEVAtScope(V, L); 8478 for (auto &LS : reverse(ValuesAtScopes[V])) 8479 if (LS.first == L) { 8480 LS.second = C; 8481 break; 8482 } 8483 return C; 8484 } 8485 8486 /// This builds up a Constant using the ConstantExpr interface. That way, we 8487 /// will return Constants for objects which aren't represented by a 8488 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt. 8489 /// Returns NULL if the SCEV isn't representable as a Constant. 8490 static Constant *BuildConstantFromSCEV(const SCEV *V) { 8491 switch (V->getSCEVType()) { 8492 case scCouldNotCompute: 8493 case scAddRecExpr: 8494 return nullptr; 8495 case scConstant: 8496 return cast<SCEVConstant>(V)->getValue(); 8497 case scUnknown: 8498 return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue()); 8499 case scSignExtend: { 8500 const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V); 8501 if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand())) 8502 return ConstantExpr::getSExt(CastOp, SS->getType()); 8503 return nullptr; 8504 } 8505 case scZeroExtend: { 8506 const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V); 8507 if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand())) 8508 return ConstantExpr::getZExt(CastOp, SZ->getType()); 8509 return nullptr; 8510 } 8511 case scPtrToInt: { 8512 const SCEVPtrToIntExpr *P2I = cast<SCEVPtrToIntExpr>(V); 8513 if (Constant *CastOp = BuildConstantFromSCEV(P2I->getOperand())) 8514 return ConstantExpr::getPtrToInt(CastOp, P2I->getType()); 8515 8516 return nullptr; 8517 } 8518 case scTruncate: { 8519 const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V); 8520 if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand())) 8521 return ConstantExpr::getTrunc(CastOp, ST->getType()); 8522 return nullptr; 8523 } 8524 case scAddExpr: { 8525 const SCEVAddExpr *SA = cast<SCEVAddExpr>(V); 8526 if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) { 8527 if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) { 8528 unsigned AS = PTy->getAddressSpace(); 8529 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS); 8530 C = ConstantExpr::getBitCast(C, DestPtrTy); 8531 } 8532 for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) { 8533 Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i)); 8534 if (!C2) 8535 return nullptr; 8536 8537 // First pointer! 8538 if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) { 8539 unsigned AS = C2->getType()->getPointerAddressSpace(); 8540 std::swap(C, C2); 8541 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS); 8542 // The offsets have been converted to bytes. We can add bytes to an 8543 // i8* by GEP with the byte count in the first index. 8544 C = ConstantExpr::getBitCast(C, DestPtrTy); 8545 } 8546 8547 // Don't bother trying to sum two pointers. We probably can't 8548 // statically compute a load that results from it anyway. 8549 if (C2->getType()->isPointerTy()) 8550 return nullptr; 8551 8552 if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) { 8553 if (PTy->getElementType()->isStructTy()) 8554 C2 = ConstantExpr::getIntegerCast( 8555 C2, Type::getInt32Ty(C->getContext()), true); 8556 C = ConstantExpr::getGetElementPtr(PTy->getElementType(), C, C2); 8557 } else 8558 C = ConstantExpr::getAdd(C, C2); 8559 } 8560 return C; 8561 } 8562 return nullptr; 8563 } 8564 case scMulExpr: { 8565 const SCEVMulExpr *SM = cast<SCEVMulExpr>(V); 8566 if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) { 8567 // Don't bother with pointers at all. 8568 if (C->getType()->isPointerTy()) 8569 return nullptr; 8570 for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) { 8571 Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i)); 8572 if (!C2 || C2->getType()->isPointerTy()) 8573 return nullptr; 8574 C = ConstantExpr::getMul(C, C2); 8575 } 8576 return C; 8577 } 8578 return nullptr; 8579 } 8580 case scUDivExpr: { 8581 const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V); 8582 if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS())) 8583 if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS())) 8584 if (LHS->getType() == RHS->getType()) 8585 return ConstantExpr::getUDiv(LHS, RHS); 8586 return nullptr; 8587 } 8588 case scSMaxExpr: 8589 case scUMaxExpr: 8590 case scSMinExpr: 8591 case scUMinExpr: 8592 return nullptr; // TODO: smax, umax, smin, umax. 8593 } 8594 llvm_unreachable("Unknown SCEV kind!"); 8595 } 8596 8597 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) { 8598 if (isa<SCEVConstant>(V)) return V; 8599 8600 // If this instruction is evolved from a constant-evolving PHI, compute the 8601 // exit value from the loop without using SCEVs. 8602 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) { 8603 if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) { 8604 if (PHINode *PN = dyn_cast<PHINode>(I)) { 8605 const Loop *CurrLoop = this->LI[I->getParent()]; 8606 // Looking for loop exit value. 8607 if (CurrLoop && CurrLoop->getParentLoop() == L && 8608 PN->getParent() == CurrLoop->getHeader()) { 8609 // Okay, there is no closed form solution for the PHI node. Check 8610 // to see if the loop that contains it has a known backedge-taken 8611 // count. If so, we may be able to force computation of the exit 8612 // value. 8613 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(CurrLoop); 8614 // This trivial case can show up in some degenerate cases where 8615 // the incoming IR has not yet been fully simplified. 8616 if (BackedgeTakenCount->isZero()) { 8617 Value *InitValue = nullptr; 8618 bool MultipleInitValues = false; 8619 for (unsigned i = 0; i < PN->getNumIncomingValues(); i++) { 8620 if (!CurrLoop->contains(PN->getIncomingBlock(i))) { 8621 if (!InitValue) 8622 InitValue = PN->getIncomingValue(i); 8623 else if (InitValue != PN->getIncomingValue(i)) { 8624 MultipleInitValues = true; 8625 break; 8626 } 8627 } 8628 } 8629 if (!MultipleInitValues && InitValue) 8630 return getSCEV(InitValue); 8631 } 8632 // Do we have a loop invariant value flowing around the backedge 8633 // for a loop which must execute the backedge? 8634 if (!isa<SCEVCouldNotCompute>(BackedgeTakenCount) && 8635 isKnownPositive(BackedgeTakenCount) && 8636 PN->getNumIncomingValues() == 2) { 8637 8638 unsigned InLoopPred = 8639 CurrLoop->contains(PN->getIncomingBlock(0)) ? 0 : 1; 8640 Value *BackedgeVal = PN->getIncomingValue(InLoopPred); 8641 if (CurrLoop->isLoopInvariant(BackedgeVal)) 8642 return getSCEV(BackedgeVal); 8643 } 8644 if (auto *BTCC = dyn_cast<SCEVConstant>(BackedgeTakenCount)) { 8645 // Okay, we know how many times the containing loop executes. If 8646 // this is a constant evolving PHI node, get the final value at 8647 // the specified iteration number. 8648 Constant *RV = getConstantEvolutionLoopExitValue( 8649 PN, BTCC->getAPInt(), CurrLoop); 8650 if (RV) return getSCEV(RV); 8651 } 8652 } 8653 8654 // If there is a single-input Phi, evaluate it at our scope. If we can 8655 // prove that this replacement does not break LCSSA form, use new value. 8656 if (PN->getNumOperands() == 1) { 8657 const SCEV *Input = getSCEV(PN->getOperand(0)); 8658 const SCEV *InputAtScope = getSCEVAtScope(Input, L); 8659 // TODO: We can generalize it using LI.replacementPreservesLCSSAForm, 8660 // for the simplest case just support constants. 8661 if (isa<SCEVConstant>(InputAtScope)) return InputAtScope; 8662 } 8663 } 8664 8665 // Okay, this is an expression that we cannot symbolically evaluate 8666 // into a SCEV. Check to see if it's possible to symbolically evaluate 8667 // the arguments into constants, and if so, try to constant propagate the 8668 // result. This is particularly useful for computing loop exit values. 8669 if (CanConstantFold(I)) { 8670 SmallVector<Constant *, 4> Operands; 8671 bool MadeImprovement = false; 8672 for (Value *Op : I->operands()) { 8673 if (Constant *C = dyn_cast<Constant>(Op)) { 8674 Operands.push_back(C); 8675 continue; 8676 } 8677 8678 // If any of the operands is non-constant and if they are 8679 // non-integer and non-pointer, don't even try to analyze them 8680 // with scev techniques. 8681 if (!isSCEVable(Op->getType())) 8682 return V; 8683 8684 const SCEV *OrigV = getSCEV(Op); 8685 const SCEV *OpV = getSCEVAtScope(OrigV, L); 8686 MadeImprovement |= OrigV != OpV; 8687 8688 Constant *C = BuildConstantFromSCEV(OpV); 8689 if (!C) return V; 8690 if (C->getType() != Op->getType()) 8691 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false, 8692 Op->getType(), 8693 false), 8694 C, Op->getType()); 8695 Operands.push_back(C); 8696 } 8697 8698 // Check to see if getSCEVAtScope actually made an improvement. 8699 if (MadeImprovement) { 8700 Constant *C = nullptr; 8701 const DataLayout &DL = getDataLayout(); 8702 if (const CmpInst *CI = dyn_cast<CmpInst>(I)) 8703 C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0], 8704 Operands[1], DL, &TLI); 8705 else if (const LoadInst *Load = dyn_cast<LoadInst>(I)) { 8706 if (!Load->isVolatile()) 8707 C = ConstantFoldLoadFromConstPtr(Operands[0], Load->getType(), 8708 DL); 8709 } else 8710 C = ConstantFoldInstOperands(I, Operands, DL, &TLI); 8711 if (!C) return V; 8712 return getSCEV(C); 8713 } 8714 } 8715 } 8716 8717 // This is some other type of SCEVUnknown, just return it. 8718 return V; 8719 } 8720 8721 if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) { 8722 // Avoid performing the look-up in the common case where the specified 8723 // expression has no loop-variant portions. 8724 for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) { 8725 const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L); 8726 if (OpAtScope != Comm->getOperand(i)) { 8727 // Okay, at least one of these operands is loop variant but might be 8728 // foldable. Build a new instance of the folded commutative expression. 8729 SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(), 8730 Comm->op_begin()+i); 8731 NewOps.push_back(OpAtScope); 8732 8733 for (++i; i != e; ++i) { 8734 OpAtScope = getSCEVAtScope(Comm->getOperand(i), L); 8735 NewOps.push_back(OpAtScope); 8736 } 8737 if (isa<SCEVAddExpr>(Comm)) 8738 return getAddExpr(NewOps, Comm->getNoWrapFlags()); 8739 if (isa<SCEVMulExpr>(Comm)) 8740 return getMulExpr(NewOps, Comm->getNoWrapFlags()); 8741 if (isa<SCEVMinMaxExpr>(Comm)) 8742 return getMinMaxExpr(Comm->getSCEVType(), NewOps); 8743 llvm_unreachable("Unknown commutative SCEV type!"); 8744 } 8745 } 8746 // If we got here, all operands are loop invariant. 8747 return Comm; 8748 } 8749 8750 if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) { 8751 const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L); 8752 const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L); 8753 if (LHS == Div->getLHS() && RHS == Div->getRHS()) 8754 return Div; // must be loop invariant 8755 return getUDivExpr(LHS, RHS); 8756 } 8757 8758 // If this is a loop recurrence for a loop that does not contain L, then we 8759 // are dealing with the final value computed by the loop. 8760 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) { 8761 // First, attempt to evaluate each operand. 8762 // Avoid performing the look-up in the common case where the specified 8763 // expression has no loop-variant portions. 8764 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) { 8765 const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L); 8766 if (OpAtScope == AddRec->getOperand(i)) 8767 continue; 8768 8769 // Okay, at least one of these operands is loop variant but might be 8770 // foldable. Build a new instance of the folded commutative expression. 8771 SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(), 8772 AddRec->op_begin()+i); 8773 NewOps.push_back(OpAtScope); 8774 for (++i; i != e; ++i) 8775 NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L)); 8776 8777 const SCEV *FoldedRec = 8778 getAddRecExpr(NewOps, AddRec->getLoop(), 8779 AddRec->getNoWrapFlags(SCEV::FlagNW)); 8780 AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec); 8781 // The addrec may be folded to a nonrecurrence, for example, if the 8782 // induction variable is multiplied by zero after constant folding. Go 8783 // ahead and return the folded value. 8784 if (!AddRec) 8785 return FoldedRec; 8786 break; 8787 } 8788 8789 // If the scope is outside the addrec's loop, evaluate it by using the 8790 // loop exit value of the addrec. 8791 if (!AddRec->getLoop()->contains(L)) { 8792 // To evaluate this recurrence, we need to know how many times the AddRec 8793 // loop iterates. Compute this now. 8794 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop()); 8795 if (BackedgeTakenCount == getCouldNotCompute()) return AddRec; 8796 8797 // Then, evaluate the AddRec. 8798 return AddRec->evaluateAtIteration(BackedgeTakenCount, *this); 8799 } 8800 8801 return AddRec; 8802 } 8803 8804 if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) { 8805 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L); 8806 if (Op == Cast->getOperand()) 8807 return Cast; // must be loop invariant 8808 return getZeroExtendExpr(Op, Cast->getType()); 8809 } 8810 8811 if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) { 8812 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L); 8813 if (Op == Cast->getOperand()) 8814 return Cast; // must be loop invariant 8815 return getSignExtendExpr(Op, Cast->getType()); 8816 } 8817 8818 if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) { 8819 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L); 8820 if (Op == Cast->getOperand()) 8821 return Cast; // must be loop invariant 8822 return getTruncateExpr(Op, Cast->getType()); 8823 } 8824 8825 if (const SCEVPtrToIntExpr *Cast = dyn_cast<SCEVPtrToIntExpr>(V)) { 8826 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L); 8827 if (Op == Cast->getOperand()) 8828 return Cast; // must be loop invariant 8829 return getPtrToIntExpr(Op, Cast->getType()); 8830 } 8831 8832 llvm_unreachable("Unknown SCEV type!"); 8833 } 8834 8835 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) { 8836 return getSCEVAtScope(getSCEV(V), L); 8837 } 8838 8839 const SCEV *ScalarEvolution::stripInjectiveFunctions(const SCEV *S) const { 8840 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) 8841 return stripInjectiveFunctions(ZExt->getOperand()); 8842 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) 8843 return stripInjectiveFunctions(SExt->getOperand()); 8844 return S; 8845 } 8846 8847 /// Finds the minimum unsigned root of the following equation: 8848 /// 8849 /// A * X = B (mod N) 8850 /// 8851 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of 8852 /// A and B isn't important. 8853 /// 8854 /// If the equation does not have a solution, SCEVCouldNotCompute is returned. 8855 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const SCEV *B, 8856 ScalarEvolution &SE) { 8857 uint32_t BW = A.getBitWidth(); 8858 assert(BW == SE.getTypeSizeInBits(B->getType())); 8859 assert(A != 0 && "A must be non-zero."); 8860 8861 // 1. D = gcd(A, N) 8862 // 8863 // The gcd of A and N may have only one prime factor: 2. The number of 8864 // trailing zeros in A is its multiplicity 8865 uint32_t Mult2 = A.countTrailingZeros(); 8866 // D = 2^Mult2 8867 8868 // 2. Check if B is divisible by D. 8869 // 8870 // B is divisible by D if and only if the multiplicity of prime factor 2 for B 8871 // is not less than multiplicity of this prime factor for D. 8872 if (SE.GetMinTrailingZeros(B) < Mult2) 8873 return SE.getCouldNotCompute(); 8874 8875 // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic 8876 // modulo (N / D). 8877 // 8878 // If D == 1, (N / D) == N == 2^BW, so we need one extra bit to represent 8879 // (N / D) in general. The inverse itself always fits into BW bits, though, 8880 // so we immediately truncate it. 8881 APInt AD = A.lshr(Mult2).zext(BW + 1); // AD = A / D 8882 APInt Mod(BW + 1, 0); 8883 Mod.setBit(BW - Mult2); // Mod = N / D 8884 APInt I = AD.multiplicativeInverse(Mod).trunc(BW); 8885 8886 // 4. Compute the minimum unsigned root of the equation: 8887 // I * (B / D) mod (N / D) 8888 // To simplify the computation, we factor out the divide by D: 8889 // (I * B mod N) / D 8890 const SCEV *D = SE.getConstant(APInt::getOneBitSet(BW, Mult2)); 8891 return SE.getUDivExactExpr(SE.getMulExpr(B, SE.getConstant(I)), D); 8892 } 8893 8894 /// For a given quadratic addrec, generate coefficients of the corresponding 8895 /// quadratic equation, multiplied by a common value to ensure that they are 8896 /// integers. 8897 /// The returned value is a tuple { A, B, C, M, BitWidth }, where 8898 /// Ax^2 + Bx + C is the quadratic function, M is the value that A, B and C 8899 /// were multiplied by, and BitWidth is the bit width of the original addrec 8900 /// coefficients. 8901 /// This function returns None if the addrec coefficients are not compile- 8902 /// time constants. 8903 static Optional<std::tuple<APInt, APInt, APInt, APInt, unsigned>> 8904 GetQuadraticEquation(const SCEVAddRecExpr *AddRec) { 8905 assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!"); 8906 const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0)); 8907 const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1)); 8908 const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2)); 8909 LLVM_DEBUG(dbgs() << __func__ << ": analyzing quadratic addrec: " 8910 << *AddRec << '\n'); 8911 8912 // We currently can only solve this if the coefficients are constants. 8913 if (!LC || !MC || !NC) { 8914 LLVM_DEBUG(dbgs() << __func__ << ": coefficients are not constant\n"); 8915 return None; 8916 } 8917 8918 APInt L = LC->getAPInt(); 8919 APInt M = MC->getAPInt(); 8920 APInt N = NC->getAPInt(); 8921 assert(!N.isNullValue() && "This is not a quadratic addrec"); 8922 8923 unsigned BitWidth = LC->getAPInt().getBitWidth(); 8924 unsigned NewWidth = BitWidth + 1; 8925 LLVM_DEBUG(dbgs() << __func__ << ": addrec coeff bw: " 8926 << BitWidth << '\n'); 8927 // The sign-extension (as opposed to a zero-extension) here matches the 8928 // extension used in SolveQuadraticEquationWrap (with the same motivation). 8929 N = N.sext(NewWidth); 8930 M = M.sext(NewWidth); 8931 L = L.sext(NewWidth); 8932 8933 // The increments are M, M+N, M+2N, ..., so the accumulated values are 8934 // L+M, (L+M)+(M+N), (L+M)+(M+N)+(M+2N), ..., that is, 8935 // L+M, L+2M+N, L+3M+3N, ... 8936 // After n iterations the accumulated value Acc is L + nM + n(n-1)/2 N. 8937 // 8938 // The equation Acc = 0 is then 8939 // L + nM + n(n-1)/2 N = 0, or 2L + 2M n + n(n-1) N = 0. 8940 // In a quadratic form it becomes: 8941 // N n^2 + (2M-N) n + 2L = 0. 8942 8943 APInt A = N; 8944 APInt B = 2 * M - A; 8945 APInt C = 2 * L; 8946 APInt T = APInt(NewWidth, 2); 8947 LLVM_DEBUG(dbgs() << __func__ << ": equation " << A << "x^2 + " << B 8948 << "x + " << C << ", coeff bw: " << NewWidth 8949 << ", multiplied by " << T << '\n'); 8950 return std::make_tuple(A, B, C, T, BitWidth); 8951 } 8952 8953 /// Helper function to compare optional APInts: 8954 /// (a) if X and Y both exist, return min(X, Y), 8955 /// (b) if neither X nor Y exist, return None, 8956 /// (c) if exactly one of X and Y exists, return that value. 8957 static Optional<APInt> MinOptional(Optional<APInt> X, Optional<APInt> Y) { 8958 if (X.hasValue() && Y.hasValue()) { 8959 unsigned W = std::max(X->getBitWidth(), Y->getBitWidth()); 8960 APInt XW = X->sextOrSelf(W); 8961 APInt YW = Y->sextOrSelf(W); 8962 return XW.slt(YW) ? *X : *Y; 8963 } 8964 if (!X.hasValue() && !Y.hasValue()) 8965 return None; 8966 return X.hasValue() ? *X : *Y; 8967 } 8968 8969 /// Helper function to truncate an optional APInt to a given BitWidth. 8970 /// When solving addrec-related equations, it is preferable to return a value 8971 /// that has the same bit width as the original addrec's coefficients. If the 8972 /// solution fits in the original bit width, truncate it (except for i1). 8973 /// Returning a value of a different bit width may inhibit some optimizations. 8974 /// 8975 /// In general, a solution to a quadratic equation generated from an addrec 8976 /// may require BW+1 bits, where BW is the bit width of the addrec's 8977 /// coefficients. The reason is that the coefficients of the quadratic 8978 /// equation are BW+1 bits wide (to avoid truncation when converting from 8979 /// the addrec to the equation). 8980 static Optional<APInt> TruncIfPossible(Optional<APInt> X, unsigned BitWidth) { 8981 if (!X.hasValue()) 8982 return None; 8983 unsigned W = X->getBitWidth(); 8984 if (BitWidth > 1 && BitWidth < W && X->isIntN(BitWidth)) 8985 return X->trunc(BitWidth); 8986 return X; 8987 } 8988 8989 /// Let c(n) be the value of the quadratic chrec {L,+,M,+,N} after n 8990 /// iterations. The values L, M, N are assumed to be signed, and they 8991 /// should all have the same bit widths. 8992 /// Find the least n >= 0 such that c(n) = 0 in the arithmetic modulo 2^BW, 8993 /// where BW is the bit width of the addrec's coefficients. 8994 /// If the calculated value is a BW-bit integer (for BW > 1), it will be 8995 /// returned as such, otherwise the bit width of the returned value may 8996 /// be greater than BW. 8997 /// 8998 /// This function returns None if 8999 /// (a) the addrec coefficients are not constant, or 9000 /// (b) SolveQuadraticEquationWrap was unable to find a solution. For cases 9001 /// like x^2 = 5, no integer solutions exist, in other cases an integer 9002 /// solution may exist, but SolveQuadraticEquationWrap may fail to find it. 9003 static Optional<APInt> 9004 SolveQuadraticAddRecExact(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) { 9005 APInt A, B, C, M; 9006 unsigned BitWidth; 9007 auto T = GetQuadraticEquation(AddRec); 9008 if (!T.hasValue()) 9009 return None; 9010 9011 std::tie(A, B, C, M, BitWidth) = *T; 9012 LLVM_DEBUG(dbgs() << __func__ << ": solving for unsigned overflow\n"); 9013 Optional<APInt> X = APIntOps::SolveQuadraticEquationWrap(A, B, C, BitWidth+1); 9014 if (!X.hasValue()) 9015 return None; 9016 9017 ConstantInt *CX = ConstantInt::get(SE.getContext(), *X); 9018 ConstantInt *V = EvaluateConstantChrecAtConstant(AddRec, CX, SE); 9019 if (!V->isZero()) 9020 return None; 9021 9022 return TruncIfPossible(X, BitWidth); 9023 } 9024 9025 /// Let c(n) be the value of the quadratic chrec {0,+,M,+,N} after n 9026 /// iterations. The values M, N are assumed to be signed, and they 9027 /// should all have the same bit widths. 9028 /// Find the least n such that c(n) does not belong to the given range, 9029 /// while c(n-1) does. 9030 /// 9031 /// This function returns None if 9032 /// (a) the addrec coefficients are not constant, or 9033 /// (b) SolveQuadraticEquationWrap was unable to find a solution for the 9034 /// bounds of the range. 9035 static Optional<APInt> 9036 SolveQuadraticAddRecRange(const SCEVAddRecExpr *AddRec, 9037 const ConstantRange &Range, ScalarEvolution &SE) { 9038 assert(AddRec->getOperand(0)->isZero() && 9039 "Starting value of addrec should be 0"); 9040 LLVM_DEBUG(dbgs() << __func__ << ": solving boundary crossing for range " 9041 << Range << ", addrec " << *AddRec << '\n'); 9042 // This case is handled in getNumIterationsInRange. Here we can assume that 9043 // we start in the range. 9044 assert(Range.contains(APInt(SE.getTypeSizeInBits(AddRec->getType()), 0)) && 9045 "Addrec's initial value should be in range"); 9046 9047 APInt A, B, C, M; 9048 unsigned BitWidth; 9049 auto T = GetQuadraticEquation(AddRec); 9050 if (!T.hasValue()) 9051 return None; 9052 9053 // Be careful about the return value: there can be two reasons for not 9054 // returning an actual number. First, if no solutions to the equations 9055 // were found, and second, if the solutions don't leave the given range. 9056 // The first case means that the actual solution is "unknown", the second 9057 // means that it's known, but not valid. If the solution is unknown, we 9058 // cannot make any conclusions. 9059 // Return a pair: the optional solution and a flag indicating if the 9060 // solution was found. 9061 auto SolveForBoundary = [&](APInt Bound) -> std::pair<Optional<APInt>,bool> { 9062 // Solve for signed overflow and unsigned overflow, pick the lower 9063 // solution. 9064 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: checking boundary " 9065 << Bound << " (before multiplying by " << M << ")\n"); 9066 Bound *= M; // The quadratic equation multiplier. 9067 9068 Optional<APInt> SO = None; 9069 if (BitWidth > 1) { 9070 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: solving for " 9071 "signed overflow\n"); 9072 SO = APIntOps::SolveQuadraticEquationWrap(A, B, -Bound, BitWidth); 9073 } 9074 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: solving for " 9075 "unsigned overflow\n"); 9076 Optional<APInt> UO = APIntOps::SolveQuadraticEquationWrap(A, B, -Bound, 9077 BitWidth+1); 9078 9079 auto LeavesRange = [&] (const APInt &X) { 9080 ConstantInt *C0 = ConstantInt::get(SE.getContext(), X); 9081 ConstantInt *V0 = EvaluateConstantChrecAtConstant(AddRec, C0, SE); 9082 if (Range.contains(V0->getValue())) 9083 return false; 9084 // X should be at least 1, so X-1 is non-negative. 9085 ConstantInt *C1 = ConstantInt::get(SE.getContext(), X-1); 9086 ConstantInt *V1 = EvaluateConstantChrecAtConstant(AddRec, C1, SE); 9087 if (Range.contains(V1->getValue())) 9088 return true; 9089 return false; 9090 }; 9091 9092 // If SolveQuadraticEquationWrap returns None, it means that there can 9093 // be a solution, but the function failed to find it. We cannot treat it 9094 // as "no solution". 9095 if (!SO.hasValue() || !UO.hasValue()) 9096 return { None, false }; 9097 9098 // Check the smaller value first to see if it leaves the range. 9099 // At this point, both SO and UO must have values. 9100 Optional<APInt> Min = MinOptional(SO, UO); 9101 if (LeavesRange(*Min)) 9102 return { Min, true }; 9103 Optional<APInt> Max = Min == SO ? UO : SO; 9104 if (LeavesRange(*Max)) 9105 return { Max, true }; 9106 9107 // Solutions were found, but were eliminated, hence the "true". 9108 return { None, true }; 9109 }; 9110 9111 std::tie(A, B, C, M, BitWidth) = *T; 9112 // Lower bound is inclusive, subtract 1 to represent the exiting value. 9113 APInt Lower = Range.getLower().sextOrSelf(A.getBitWidth()) - 1; 9114 APInt Upper = Range.getUpper().sextOrSelf(A.getBitWidth()); 9115 auto SL = SolveForBoundary(Lower); 9116 auto SU = SolveForBoundary(Upper); 9117 // If any of the solutions was unknown, no meaninigful conclusions can 9118 // be made. 9119 if (!SL.second || !SU.second) 9120 return None; 9121 9122 // Claim: The correct solution is not some value between Min and Max. 9123 // 9124 // Justification: Assuming that Min and Max are different values, one of 9125 // them is when the first signed overflow happens, the other is when the 9126 // first unsigned overflow happens. Crossing the range boundary is only 9127 // possible via an overflow (treating 0 as a special case of it, modeling 9128 // an overflow as crossing k*2^W for some k). 9129 // 9130 // The interesting case here is when Min was eliminated as an invalid 9131 // solution, but Max was not. The argument is that if there was another 9132 // overflow between Min and Max, it would also have been eliminated if 9133 // it was considered. 9134 // 9135 // For a given boundary, it is possible to have two overflows of the same 9136 // type (signed/unsigned) without having the other type in between: this 9137 // can happen when the vertex of the parabola is between the iterations 9138 // corresponding to the overflows. This is only possible when the two 9139 // overflows cross k*2^W for the same k. In such case, if the second one 9140 // left the range (and was the first one to do so), the first overflow 9141 // would have to enter the range, which would mean that either we had left 9142 // the range before or that we started outside of it. Both of these cases 9143 // are contradictions. 9144 // 9145 // Claim: In the case where SolveForBoundary returns None, the correct 9146 // solution is not some value between the Max for this boundary and the 9147 // Min of the other boundary. 9148 // 9149 // Justification: Assume that we had such Max_A and Min_B corresponding 9150 // to range boundaries A and B and such that Max_A < Min_B. If there was 9151 // a solution between Max_A and Min_B, it would have to be caused by an 9152 // overflow corresponding to either A or B. It cannot correspond to B, 9153 // since Min_B is the first occurrence of such an overflow. If it 9154 // corresponded to A, it would have to be either a signed or an unsigned 9155 // overflow that is larger than both eliminated overflows for A. But 9156 // between the eliminated overflows and this overflow, the values would 9157 // cover the entire value space, thus crossing the other boundary, which 9158 // is a contradiction. 9159 9160 return TruncIfPossible(MinOptional(SL.first, SU.first), BitWidth); 9161 } 9162 9163 ScalarEvolution::ExitLimit 9164 ScalarEvolution::howFarToZero(const SCEV *V, const Loop *L, bool ControlsExit, 9165 bool AllowPredicates) { 9166 9167 // This is only used for loops with a "x != y" exit test. The exit condition 9168 // is now expressed as a single expression, V = x-y. So the exit test is 9169 // effectively V != 0. We know and take advantage of the fact that this 9170 // expression only being used in a comparison by zero context. 9171 9172 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 9173 // If the value is a constant 9174 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) { 9175 // If the value is already zero, the branch will execute zero times. 9176 if (C->getValue()->isZero()) return C; 9177 return getCouldNotCompute(); // Otherwise it will loop infinitely. 9178 } 9179 9180 const SCEVAddRecExpr *AddRec = 9181 dyn_cast<SCEVAddRecExpr>(stripInjectiveFunctions(V)); 9182 9183 if (!AddRec && AllowPredicates) 9184 // Try to make this an AddRec using runtime tests, in the first X 9185 // iterations of this loop, where X is the SCEV expression found by the 9186 // algorithm below. 9187 AddRec = convertSCEVToAddRecWithPredicates(V, L, Predicates); 9188 9189 if (!AddRec || AddRec->getLoop() != L) 9190 return getCouldNotCompute(); 9191 9192 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of 9193 // the quadratic equation to solve it. 9194 if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) { 9195 // We can only use this value if the chrec ends up with an exact zero 9196 // value at this index. When solving for "X*X != 5", for example, we 9197 // should not accept a root of 2. 9198 if (auto S = SolveQuadraticAddRecExact(AddRec, *this)) { 9199 const auto *R = cast<SCEVConstant>(getConstant(S.getValue())); 9200 return ExitLimit(R, R, false, Predicates); 9201 } 9202 return getCouldNotCompute(); 9203 } 9204 9205 // Otherwise we can only handle this if it is affine. 9206 if (!AddRec->isAffine()) 9207 return getCouldNotCompute(); 9208 9209 // If this is an affine expression, the execution count of this branch is 9210 // the minimum unsigned root of the following equation: 9211 // 9212 // Start + Step*N = 0 (mod 2^BW) 9213 // 9214 // equivalent to: 9215 // 9216 // Step*N = -Start (mod 2^BW) 9217 // 9218 // where BW is the common bit width of Start and Step. 9219 9220 // Get the initial value for the loop. 9221 const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop()); 9222 const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop()); 9223 9224 // For now we handle only constant steps. 9225 // 9226 // TODO: Handle a nonconstant Step given AddRec<NUW>. If the 9227 // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap 9228 // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step. 9229 // We have not yet seen any such cases. 9230 const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step); 9231 if (!StepC || StepC->getValue()->isZero()) 9232 return getCouldNotCompute(); 9233 9234 // For positive steps (counting up until unsigned overflow): 9235 // N = -Start/Step (as unsigned) 9236 // For negative steps (counting down to zero): 9237 // N = Start/-Step 9238 // First compute the unsigned distance from zero in the direction of Step. 9239 bool CountDown = StepC->getAPInt().isNegative(); 9240 const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start); 9241 9242 // Handle unitary steps, which cannot wraparound. 9243 // 1*N = -Start; -1*N = Start (mod 2^BW), so: 9244 // N = Distance (as unsigned) 9245 if (StepC->getValue()->isOne() || StepC->getValue()->isMinusOne()) { 9246 APInt MaxBECount = getUnsignedRangeMax(applyLoopGuards(Distance, L)); 9247 APInt MaxBECountBase = getUnsignedRangeMax(Distance); 9248 if (MaxBECountBase.ult(MaxBECount)) 9249 MaxBECount = MaxBECountBase; 9250 9251 // When a loop like "for (int i = 0; i != n; ++i) { /* body */ }" is rotated, 9252 // we end up with a loop whose backedge-taken count is n - 1. Detect this 9253 // case, and see if we can improve the bound. 9254 // 9255 // Explicitly handling this here is necessary because getUnsignedRange 9256 // isn't context-sensitive; it doesn't know that we only care about the 9257 // range inside the loop. 9258 const SCEV *Zero = getZero(Distance->getType()); 9259 const SCEV *One = getOne(Distance->getType()); 9260 const SCEV *DistancePlusOne = getAddExpr(Distance, One); 9261 if (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_NE, DistancePlusOne, Zero)) { 9262 // If Distance + 1 doesn't overflow, we can compute the maximum distance 9263 // as "unsigned_max(Distance + 1) - 1". 9264 ConstantRange CR = getUnsignedRange(DistancePlusOne); 9265 MaxBECount = APIntOps::umin(MaxBECount, CR.getUnsignedMax() - 1); 9266 } 9267 return ExitLimit(Distance, getConstant(MaxBECount), false, Predicates); 9268 } 9269 9270 // If the condition controls loop exit (the loop exits only if the expression 9271 // is true) and the addition is no-wrap we can use unsigned divide to 9272 // compute the backedge count. In this case, the step may not divide the 9273 // distance, but we don't care because if the condition is "missed" the loop 9274 // will have undefined behavior due to wrapping. 9275 if (ControlsExit && AddRec->hasNoSelfWrap() && 9276 loopHasNoAbnormalExits(AddRec->getLoop())) { 9277 const SCEV *Exact = 9278 getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step); 9279 const SCEV *Max = 9280 Exact == getCouldNotCompute() 9281 ? Exact 9282 : getConstant(getUnsignedRangeMax(Exact)); 9283 return ExitLimit(Exact, Max, false, Predicates); 9284 } 9285 9286 // Solve the general equation. 9287 const SCEV *E = SolveLinEquationWithOverflow(StepC->getAPInt(), 9288 getNegativeSCEV(Start), *this); 9289 const SCEV *M = E == getCouldNotCompute() 9290 ? E 9291 : getConstant(getUnsignedRangeMax(E)); 9292 return ExitLimit(E, M, false, Predicates); 9293 } 9294 9295 ScalarEvolution::ExitLimit 9296 ScalarEvolution::howFarToNonZero(const SCEV *V, const Loop *L) { 9297 // Loops that look like: while (X == 0) are very strange indeed. We don't 9298 // handle them yet except for the trivial case. This could be expanded in the 9299 // future as needed. 9300 9301 // If the value is a constant, check to see if it is known to be non-zero 9302 // already. If so, the backedge will execute zero times. 9303 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) { 9304 if (!C->getValue()->isZero()) 9305 return getZero(C->getType()); 9306 return getCouldNotCompute(); // Otherwise it will loop infinitely. 9307 } 9308 9309 // We could implement others, but I really doubt anyone writes loops like 9310 // this, and if they did, they would already be constant folded. 9311 return getCouldNotCompute(); 9312 } 9313 9314 std::pair<const BasicBlock *, const BasicBlock *> 9315 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(const BasicBlock *BB) 9316 const { 9317 // If the block has a unique predecessor, then there is no path from the 9318 // predecessor to the block that does not go through the direct edge 9319 // from the predecessor to the block. 9320 if (const BasicBlock *Pred = BB->getSinglePredecessor()) 9321 return {Pred, BB}; 9322 9323 // A loop's header is defined to be a block that dominates the loop. 9324 // If the header has a unique predecessor outside the loop, it must be 9325 // a block that has exactly one successor that can reach the loop. 9326 if (const Loop *L = LI.getLoopFor(BB)) 9327 return {L->getLoopPredecessor(), L->getHeader()}; 9328 9329 return {nullptr, nullptr}; 9330 } 9331 9332 /// SCEV structural equivalence is usually sufficient for testing whether two 9333 /// expressions are equal, however for the purposes of looking for a condition 9334 /// guarding a loop, it can be useful to be a little more general, since a 9335 /// front-end may have replicated the controlling expression. 9336 static bool HasSameValue(const SCEV *A, const SCEV *B) { 9337 // Quick check to see if they are the same SCEV. 9338 if (A == B) return true; 9339 9340 auto ComputesEqualValues = [](const Instruction *A, const Instruction *B) { 9341 // Not all instructions that are "identical" compute the same value. For 9342 // instance, two distinct alloca instructions allocating the same type are 9343 // identical and do not read memory; but compute distinct values. 9344 return A->isIdenticalTo(B) && (isa<BinaryOperator>(A) || isa<GetElementPtrInst>(A)); 9345 }; 9346 9347 // Otherwise, if they're both SCEVUnknown, it's possible that they hold 9348 // two different instructions with the same value. Check for this case. 9349 if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A)) 9350 if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B)) 9351 if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue())) 9352 if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue())) 9353 if (ComputesEqualValues(AI, BI)) 9354 return true; 9355 9356 // Otherwise assume they may have a different value. 9357 return false; 9358 } 9359 9360 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred, 9361 const SCEV *&LHS, const SCEV *&RHS, 9362 unsigned Depth) { 9363 bool Changed = false; 9364 // Simplifies ICMP to trivial true or false by turning it into '0 == 0' or 9365 // '0 != 0'. 9366 auto TrivialCase = [&](bool TriviallyTrue) { 9367 LHS = RHS = getConstant(ConstantInt::getFalse(getContext())); 9368 Pred = TriviallyTrue ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE; 9369 return true; 9370 }; 9371 // If we hit the max recursion limit bail out. 9372 if (Depth >= 3) 9373 return false; 9374 9375 // Canonicalize a constant to the right side. 9376 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) { 9377 // Check for both operands constant. 9378 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 9379 if (ConstantExpr::getICmp(Pred, 9380 LHSC->getValue(), 9381 RHSC->getValue())->isNullValue()) 9382 return TrivialCase(false); 9383 else 9384 return TrivialCase(true); 9385 } 9386 // Otherwise swap the operands to put the constant on the right. 9387 std::swap(LHS, RHS); 9388 Pred = ICmpInst::getSwappedPredicate(Pred); 9389 Changed = true; 9390 } 9391 9392 // If we're comparing an addrec with a value which is loop-invariant in the 9393 // addrec's loop, put the addrec on the left. Also make a dominance check, 9394 // as both operands could be addrecs loop-invariant in each other's loop. 9395 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) { 9396 const Loop *L = AR->getLoop(); 9397 if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) { 9398 std::swap(LHS, RHS); 9399 Pred = ICmpInst::getSwappedPredicate(Pred); 9400 Changed = true; 9401 } 9402 } 9403 9404 // If there's a constant operand, canonicalize comparisons with boundary 9405 // cases, and canonicalize *-or-equal comparisons to regular comparisons. 9406 if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) { 9407 const APInt &RA = RC->getAPInt(); 9408 9409 bool SimplifiedByConstantRange = false; 9410 9411 if (!ICmpInst::isEquality(Pred)) { 9412 ConstantRange ExactCR = ConstantRange::makeExactICmpRegion(Pred, RA); 9413 if (ExactCR.isFullSet()) 9414 return TrivialCase(true); 9415 else if (ExactCR.isEmptySet()) 9416 return TrivialCase(false); 9417 9418 APInt NewRHS; 9419 CmpInst::Predicate NewPred; 9420 if (ExactCR.getEquivalentICmp(NewPred, NewRHS) && 9421 ICmpInst::isEquality(NewPred)) { 9422 // We were able to convert an inequality to an equality. 9423 Pred = NewPred; 9424 RHS = getConstant(NewRHS); 9425 Changed = SimplifiedByConstantRange = true; 9426 } 9427 } 9428 9429 if (!SimplifiedByConstantRange) { 9430 switch (Pred) { 9431 default: 9432 break; 9433 case ICmpInst::ICMP_EQ: 9434 case ICmpInst::ICMP_NE: 9435 // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b. 9436 if (!RA) 9437 if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS)) 9438 if (const SCEVMulExpr *ME = 9439 dyn_cast<SCEVMulExpr>(AE->getOperand(0))) 9440 if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 && 9441 ME->getOperand(0)->isAllOnesValue()) { 9442 RHS = AE->getOperand(1); 9443 LHS = ME->getOperand(1); 9444 Changed = true; 9445 } 9446 break; 9447 9448 9449 // The "Should have been caught earlier!" messages refer to the fact 9450 // that the ExactCR.isFullSet() or ExactCR.isEmptySet() check above 9451 // should have fired on the corresponding cases, and canonicalized the 9452 // check to trivial case. 9453 9454 case ICmpInst::ICMP_UGE: 9455 assert(!RA.isMinValue() && "Should have been caught earlier!"); 9456 Pred = ICmpInst::ICMP_UGT; 9457 RHS = getConstant(RA - 1); 9458 Changed = true; 9459 break; 9460 case ICmpInst::ICMP_ULE: 9461 assert(!RA.isMaxValue() && "Should have been caught earlier!"); 9462 Pred = ICmpInst::ICMP_ULT; 9463 RHS = getConstant(RA + 1); 9464 Changed = true; 9465 break; 9466 case ICmpInst::ICMP_SGE: 9467 assert(!RA.isMinSignedValue() && "Should have been caught earlier!"); 9468 Pred = ICmpInst::ICMP_SGT; 9469 RHS = getConstant(RA - 1); 9470 Changed = true; 9471 break; 9472 case ICmpInst::ICMP_SLE: 9473 assert(!RA.isMaxSignedValue() && "Should have been caught earlier!"); 9474 Pred = ICmpInst::ICMP_SLT; 9475 RHS = getConstant(RA + 1); 9476 Changed = true; 9477 break; 9478 } 9479 } 9480 } 9481 9482 // Check for obvious equality. 9483 if (HasSameValue(LHS, RHS)) { 9484 if (ICmpInst::isTrueWhenEqual(Pred)) 9485 return TrivialCase(true); 9486 if (ICmpInst::isFalseWhenEqual(Pred)) 9487 return TrivialCase(false); 9488 } 9489 9490 // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by 9491 // adding or subtracting 1 from one of the operands. 9492 switch (Pred) { 9493 case ICmpInst::ICMP_SLE: 9494 if (!getSignedRangeMax(RHS).isMaxSignedValue()) { 9495 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS, 9496 SCEV::FlagNSW); 9497 Pred = ICmpInst::ICMP_SLT; 9498 Changed = true; 9499 } else if (!getSignedRangeMin(LHS).isMinSignedValue()) { 9500 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS, 9501 SCEV::FlagNSW); 9502 Pred = ICmpInst::ICMP_SLT; 9503 Changed = true; 9504 } 9505 break; 9506 case ICmpInst::ICMP_SGE: 9507 if (!getSignedRangeMin(RHS).isMinSignedValue()) { 9508 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS, 9509 SCEV::FlagNSW); 9510 Pred = ICmpInst::ICMP_SGT; 9511 Changed = true; 9512 } else if (!getSignedRangeMax(LHS).isMaxSignedValue()) { 9513 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS, 9514 SCEV::FlagNSW); 9515 Pred = ICmpInst::ICMP_SGT; 9516 Changed = true; 9517 } 9518 break; 9519 case ICmpInst::ICMP_ULE: 9520 if (!getUnsignedRangeMax(RHS).isMaxValue()) { 9521 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS, 9522 SCEV::FlagNUW); 9523 Pred = ICmpInst::ICMP_ULT; 9524 Changed = true; 9525 } else if (!getUnsignedRangeMin(LHS).isMinValue()) { 9526 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS); 9527 Pred = ICmpInst::ICMP_ULT; 9528 Changed = true; 9529 } 9530 break; 9531 case ICmpInst::ICMP_UGE: 9532 if (!getUnsignedRangeMin(RHS).isMinValue()) { 9533 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS); 9534 Pred = ICmpInst::ICMP_UGT; 9535 Changed = true; 9536 } else if (!getUnsignedRangeMax(LHS).isMaxValue()) { 9537 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS, 9538 SCEV::FlagNUW); 9539 Pred = ICmpInst::ICMP_UGT; 9540 Changed = true; 9541 } 9542 break; 9543 default: 9544 break; 9545 } 9546 9547 // TODO: More simplifications are possible here. 9548 9549 // Recursively simplify until we either hit a recursion limit or nothing 9550 // changes. 9551 if (Changed) 9552 return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1); 9553 9554 return Changed; 9555 } 9556 9557 bool ScalarEvolution::isKnownNegative(const SCEV *S) { 9558 return getSignedRangeMax(S).isNegative(); 9559 } 9560 9561 bool ScalarEvolution::isKnownPositive(const SCEV *S) { 9562 return getSignedRangeMin(S).isStrictlyPositive(); 9563 } 9564 9565 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) { 9566 return !getSignedRangeMin(S).isNegative(); 9567 } 9568 9569 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) { 9570 return !getSignedRangeMax(S).isStrictlyPositive(); 9571 } 9572 9573 bool ScalarEvolution::isKnownNonZero(const SCEV *S) { 9574 return isKnownNegative(S) || isKnownPositive(S); 9575 } 9576 9577 std::pair<const SCEV *, const SCEV *> 9578 ScalarEvolution::SplitIntoInitAndPostInc(const Loop *L, const SCEV *S) { 9579 // Compute SCEV on entry of loop L. 9580 const SCEV *Start = SCEVInitRewriter::rewrite(S, L, *this); 9581 if (Start == getCouldNotCompute()) 9582 return { Start, Start }; 9583 // Compute post increment SCEV for loop L. 9584 const SCEV *PostInc = SCEVPostIncRewriter::rewrite(S, L, *this); 9585 assert(PostInc != getCouldNotCompute() && "Unexpected could not compute"); 9586 return { Start, PostInc }; 9587 } 9588 9589 bool ScalarEvolution::isKnownViaInduction(ICmpInst::Predicate Pred, 9590 const SCEV *LHS, const SCEV *RHS) { 9591 // First collect all loops. 9592 SmallPtrSet<const Loop *, 8> LoopsUsed; 9593 getUsedLoops(LHS, LoopsUsed); 9594 getUsedLoops(RHS, LoopsUsed); 9595 9596 if (LoopsUsed.empty()) 9597 return false; 9598 9599 // Domination relationship must be a linear order on collected loops. 9600 #ifndef NDEBUG 9601 for (auto *L1 : LoopsUsed) 9602 for (auto *L2 : LoopsUsed) 9603 assert((DT.dominates(L1->getHeader(), L2->getHeader()) || 9604 DT.dominates(L2->getHeader(), L1->getHeader())) && 9605 "Domination relationship is not a linear order"); 9606 #endif 9607 9608 const Loop *MDL = 9609 *std::max_element(LoopsUsed.begin(), LoopsUsed.end(), 9610 [&](const Loop *L1, const Loop *L2) { 9611 return DT.properlyDominates(L1->getHeader(), L2->getHeader()); 9612 }); 9613 9614 // Get init and post increment value for LHS. 9615 auto SplitLHS = SplitIntoInitAndPostInc(MDL, LHS); 9616 // if LHS contains unknown non-invariant SCEV then bail out. 9617 if (SplitLHS.first == getCouldNotCompute()) 9618 return false; 9619 assert (SplitLHS.second != getCouldNotCompute() && "Unexpected CNC"); 9620 // Get init and post increment value for RHS. 9621 auto SplitRHS = SplitIntoInitAndPostInc(MDL, RHS); 9622 // if RHS contains unknown non-invariant SCEV then bail out. 9623 if (SplitRHS.first == getCouldNotCompute()) 9624 return false; 9625 assert (SplitRHS.second != getCouldNotCompute() && "Unexpected CNC"); 9626 // It is possible that init SCEV contains an invariant load but it does 9627 // not dominate MDL and is not available at MDL loop entry, so we should 9628 // check it here. 9629 if (!isAvailableAtLoopEntry(SplitLHS.first, MDL) || 9630 !isAvailableAtLoopEntry(SplitRHS.first, MDL)) 9631 return false; 9632 9633 // It seems backedge guard check is faster than entry one so in some cases 9634 // it can speed up whole estimation by short circuit 9635 return isLoopBackedgeGuardedByCond(MDL, Pred, SplitLHS.second, 9636 SplitRHS.second) && 9637 isLoopEntryGuardedByCond(MDL, Pred, SplitLHS.first, SplitRHS.first); 9638 } 9639 9640 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred, 9641 const SCEV *LHS, const SCEV *RHS) { 9642 // Canonicalize the inputs first. 9643 (void)SimplifyICmpOperands(Pred, LHS, RHS); 9644 9645 if (isKnownViaInduction(Pred, LHS, RHS)) 9646 return true; 9647 9648 if (isKnownPredicateViaSplitting(Pred, LHS, RHS)) 9649 return true; 9650 9651 // Otherwise see what can be done with some simple reasoning. 9652 return isKnownViaNonRecursiveReasoning(Pred, LHS, RHS); 9653 } 9654 9655 Optional<bool> ScalarEvolution::evaluatePredicate(ICmpInst::Predicate Pred, 9656 const SCEV *LHS, 9657 const SCEV *RHS) { 9658 if (isKnownPredicate(Pred, LHS, RHS)) 9659 return true; 9660 else if (isKnownPredicate(ICmpInst::getInversePredicate(Pred), LHS, RHS)) 9661 return false; 9662 return None; 9663 } 9664 9665 bool ScalarEvolution::isKnownPredicateAt(ICmpInst::Predicate Pred, 9666 const SCEV *LHS, const SCEV *RHS, 9667 const Instruction *Context) { 9668 // TODO: Analyze guards and assumes from Context's block. 9669 return isKnownPredicate(Pred, LHS, RHS) || 9670 isBasicBlockEntryGuardedByCond(Context->getParent(), Pred, LHS, RHS); 9671 } 9672 9673 Optional<bool> 9674 ScalarEvolution::evaluatePredicateAt(ICmpInst::Predicate Pred, const SCEV *LHS, 9675 const SCEV *RHS, 9676 const Instruction *Context) { 9677 Optional<bool> KnownWithoutContext = evaluatePredicate(Pred, LHS, RHS); 9678 if (KnownWithoutContext) 9679 return KnownWithoutContext; 9680 9681 if (isBasicBlockEntryGuardedByCond(Context->getParent(), Pred, LHS, RHS)) 9682 return true; 9683 else if (isBasicBlockEntryGuardedByCond(Context->getParent(), 9684 ICmpInst::getInversePredicate(Pred), 9685 LHS, RHS)) 9686 return false; 9687 return None; 9688 } 9689 9690 bool ScalarEvolution::isKnownOnEveryIteration(ICmpInst::Predicate Pred, 9691 const SCEVAddRecExpr *LHS, 9692 const SCEV *RHS) { 9693 const Loop *L = LHS->getLoop(); 9694 return isLoopEntryGuardedByCond(L, Pred, LHS->getStart(), RHS) && 9695 isLoopBackedgeGuardedByCond(L, Pred, LHS->getPostIncExpr(*this), RHS); 9696 } 9697 9698 Optional<ScalarEvolution::MonotonicPredicateType> 9699 ScalarEvolution::getMonotonicPredicateType(const SCEVAddRecExpr *LHS, 9700 ICmpInst::Predicate Pred) { 9701 auto Result = getMonotonicPredicateTypeImpl(LHS, Pred); 9702 9703 #ifndef NDEBUG 9704 // Verify an invariant: inverting the predicate should turn a monotonically 9705 // increasing change to a monotonically decreasing one, and vice versa. 9706 if (Result) { 9707 auto ResultSwapped = 9708 getMonotonicPredicateTypeImpl(LHS, ICmpInst::getSwappedPredicate(Pred)); 9709 9710 assert(ResultSwapped.hasValue() && "should be able to analyze both!"); 9711 assert(ResultSwapped.getValue() != Result.getValue() && 9712 "monotonicity should flip as we flip the predicate"); 9713 } 9714 #endif 9715 9716 return Result; 9717 } 9718 9719 Optional<ScalarEvolution::MonotonicPredicateType> 9720 ScalarEvolution::getMonotonicPredicateTypeImpl(const SCEVAddRecExpr *LHS, 9721 ICmpInst::Predicate Pred) { 9722 // A zero step value for LHS means the induction variable is essentially a 9723 // loop invariant value. We don't really depend on the predicate actually 9724 // flipping from false to true (for increasing predicates, and the other way 9725 // around for decreasing predicates), all we care about is that *if* the 9726 // predicate changes then it only changes from false to true. 9727 // 9728 // A zero step value in itself is not very useful, but there may be places 9729 // where SCEV can prove X >= 0 but not prove X > 0, so it is helpful to be 9730 // as general as possible. 9731 9732 // Only handle LE/LT/GE/GT predicates. 9733 if (!ICmpInst::isRelational(Pred)) 9734 return None; 9735 9736 bool IsGreater = ICmpInst::isGE(Pred) || ICmpInst::isGT(Pred); 9737 assert((IsGreater || ICmpInst::isLE(Pred) || ICmpInst::isLT(Pred)) && 9738 "Should be greater or less!"); 9739 9740 // Check that AR does not wrap. 9741 if (ICmpInst::isUnsigned(Pred)) { 9742 if (!LHS->hasNoUnsignedWrap()) 9743 return None; 9744 return IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 9745 } else { 9746 assert(ICmpInst::isSigned(Pred) && 9747 "Relational predicate is either signed or unsigned!"); 9748 if (!LHS->hasNoSignedWrap()) 9749 return None; 9750 9751 const SCEV *Step = LHS->getStepRecurrence(*this); 9752 9753 if (isKnownNonNegative(Step)) 9754 return IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 9755 9756 if (isKnownNonPositive(Step)) 9757 return !IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 9758 9759 return None; 9760 } 9761 } 9762 9763 Optional<ScalarEvolution::LoopInvariantPredicate> 9764 ScalarEvolution::getLoopInvariantPredicate(ICmpInst::Predicate Pred, 9765 const SCEV *LHS, const SCEV *RHS, 9766 const Loop *L) { 9767 9768 // If there is a loop-invariant, force it into the RHS, otherwise bail out. 9769 if (!isLoopInvariant(RHS, L)) { 9770 if (!isLoopInvariant(LHS, L)) 9771 return None; 9772 9773 std::swap(LHS, RHS); 9774 Pred = ICmpInst::getSwappedPredicate(Pred); 9775 } 9776 9777 const SCEVAddRecExpr *ArLHS = dyn_cast<SCEVAddRecExpr>(LHS); 9778 if (!ArLHS || ArLHS->getLoop() != L) 9779 return None; 9780 9781 auto MonotonicType = getMonotonicPredicateType(ArLHS, Pred); 9782 if (!MonotonicType) 9783 return None; 9784 // If the predicate "ArLHS `Pred` RHS" monotonically increases from false to 9785 // true as the loop iterates, and the backedge is control dependent on 9786 // "ArLHS `Pred` RHS" == true then we can reason as follows: 9787 // 9788 // * if the predicate was false in the first iteration then the predicate 9789 // is never evaluated again, since the loop exits without taking the 9790 // backedge. 9791 // * if the predicate was true in the first iteration then it will 9792 // continue to be true for all future iterations since it is 9793 // monotonically increasing. 9794 // 9795 // For both the above possibilities, we can replace the loop varying 9796 // predicate with its value on the first iteration of the loop (which is 9797 // loop invariant). 9798 // 9799 // A similar reasoning applies for a monotonically decreasing predicate, by 9800 // replacing true with false and false with true in the above two bullets. 9801 bool Increasing = *MonotonicType == ScalarEvolution::MonotonicallyIncreasing; 9802 auto P = Increasing ? Pred : ICmpInst::getInversePredicate(Pred); 9803 9804 if (!isLoopBackedgeGuardedByCond(L, P, LHS, RHS)) 9805 return None; 9806 9807 return ScalarEvolution::LoopInvariantPredicate(Pred, ArLHS->getStart(), RHS); 9808 } 9809 9810 Optional<ScalarEvolution::LoopInvariantPredicate> 9811 ScalarEvolution::getLoopInvariantExitCondDuringFirstIterations( 9812 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, const Loop *L, 9813 const Instruction *Context, const SCEV *MaxIter) { 9814 // Try to prove the following set of facts: 9815 // - The predicate is monotonic in the iteration space. 9816 // - If the check does not fail on the 1st iteration: 9817 // - No overflow will happen during first MaxIter iterations; 9818 // - It will not fail on the MaxIter'th iteration. 9819 // If the check does fail on the 1st iteration, we leave the loop and no 9820 // other checks matter. 9821 9822 // If there is a loop-invariant, force it into the RHS, otherwise bail out. 9823 if (!isLoopInvariant(RHS, L)) { 9824 if (!isLoopInvariant(LHS, L)) 9825 return None; 9826 9827 std::swap(LHS, RHS); 9828 Pred = ICmpInst::getSwappedPredicate(Pred); 9829 } 9830 9831 auto *AR = dyn_cast<SCEVAddRecExpr>(LHS); 9832 if (!AR || AR->getLoop() != L) 9833 return None; 9834 9835 // The predicate must be relational (i.e. <, <=, >=, >). 9836 if (!ICmpInst::isRelational(Pred)) 9837 return None; 9838 9839 // TODO: Support steps other than +/- 1. 9840 const SCEV *Step = AR->getStepRecurrence(*this); 9841 auto *One = getOne(Step->getType()); 9842 auto *MinusOne = getNegativeSCEV(One); 9843 if (Step != One && Step != MinusOne) 9844 return None; 9845 9846 // Type mismatch here means that MaxIter is potentially larger than max 9847 // unsigned value in start type, which mean we cannot prove no wrap for the 9848 // indvar. 9849 if (AR->getType() != MaxIter->getType()) 9850 return None; 9851 9852 // Value of IV on suggested last iteration. 9853 const SCEV *Last = AR->evaluateAtIteration(MaxIter, *this); 9854 // Does it still meet the requirement? 9855 if (!isLoopBackedgeGuardedByCond(L, Pred, Last, RHS)) 9856 return None; 9857 // Because step is +/- 1 and MaxIter has same type as Start (i.e. it does 9858 // not exceed max unsigned value of this type), this effectively proves 9859 // that there is no wrap during the iteration. To prove that there is no 9860 // signed/unsigned wrap, we need to check that 9861 // Start <= Last for step = 1 or Start >= Last for step = -1. 9862 ICmpInst::Predicate NoOverflowPred = 9863 CmpInst::isSigned(Pred) ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 9864 if (Step == MinusOne) 9865 NoOverflowPred = CmpInst::getSwappedPredicate(NoOverflowPred); 9866 const SCEV *Start = AR->getStart(); 9867 if (!isKnownPredicateAt(NoOverflowPred, Start, Last, Context)) 9868 return None; 9869 9870 // Everything is fine. 9871 return ScalarEvolution::LoopInvariantPredicate(Pred, Start, RHS); 9872 } 9873 9874 bool ScalarEvolution::isKnownPredicateViaConstantRanges( 9875 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) { 9876 if (HasSameValue(LHS, RHS)) 9877 return ICmpInst::isTrueWhenEqual(Pred); 9878 9879 // This code is split out from isKnownPredicate because it is called from 9880 // within isLoopEntryGuardedByCond. 9881 9882 auto CheckRanges = [&](const ConstantRange &RangeLHS, 9883 const ConstantRange &RangeRHS) { 9884 return RangeLHS.icmp(Pred, RangeRHS); 9885 }; 9886 9887 // The check at the top of the function catches the case where the values are 9888 // known to be equal. 9889 if (Pred == CmpInst::ICMP_EQ) 9890 return false; 9891 9892 if (Pred == CmpInst::ICMP_NE) 9893 return CheckRanges(getSignedRange(LHS), getSignedRange(RHS)) || 9894 CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS)) || 9895 isKnownNonZero(getMinusSCEV(LHS, RHS)); 9896 9897 if (CmpInst::isSigned(Pred)) 9898 return CheckRanges(getSignedRange(LHS), getSignedRange(RHS)); 9899 9900 return CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS)); 9901 } 9902 9903 bool ScalarEvolution::isKnownPredicateViaNoOverflow(ICmpInst::Predicate Pred, 9904 const SCEV *LHS, 9905 const SCEV *RHS) { 9906 // Match Result to (X + Y)<ExpectedFlags> where Y is a constant integer. 9907 // Return Y via OutY. 9908 auto MatchBinaryAddToConst = 9909 [this](const SCEV *Result, const SCEV *X, APInt &OutY, 9910 SCEV::NoWrapFlags ExpectedFlags) { 9911 const SCEV *NonConstOp, *ConstOp; 9912 SCEV::NoWrapFlags FlagsPresent; 9913 9914 if (!splitBinaryAdd(Result, ConstOp, NonConstOp, FlagsPresent) || 9915 !isa<SCEVConstant>(ConstOp) || NonConstOp != X) 9916 return false; 9917 9918 OutY = cast<SCEVConstant>(ConstOp)->getAPInt(); 9919 return (FlagsPresent & ExpectedFlags) == ExpectedFlags; 9920 }; 9921 9922 APInt C; 9923 9924 switch (Pred) { 9925 default: 9926 break; 9927 9928 case ICmpInst::ICMP_SGE: 9929 std::swap(LHS, RHS); 9930 LLVM_FALLTHROUGH; 9931 case ICmpInst::ICMP_SLE: 9932 // X s<= (X + C)<nsw> if C >= 0 9933 if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNSW) && C.isNonNegative()) 9934 return true; 9935 9936 // (X + C)<nsw> s<= X if C <= 0 9937 if (MatchBinaryAddToConst(LHS, RHS, C, SCEV::FlagNSW) && 9938 !C.isStrictlyPositive()) 9939 return true; 9940 break; 9941 9942 case ICmpInst::ICMP_SGT: 9943 std::swap(LHS, RHS); 9944 LLVM_FALLTHROUGH; 9945 case ICmpInst::ICMP_SLT: 9946 // X s< (X + C)<nsw> if C > 0 9947 if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNSW) && 9948 C.isStrictlyPositive()) 9949 return true; 9950 9951 // (X + C)<nsw> s< X if C < 0 9952 if (MatchBinaryAddToConst(LHS, RHS, C, SCEV::FlagNSW) && C.isNegative()) 9953 return true; 9954 break; 9955 9956 case ICmpInst::ICMP_UGE: 9957 std::swap(LHS, RHS); 9958 LLVM_FALLTHROUGH; 9959 case ICmpInst::ICMP_ULE: 9960 // X u<= (X + C)<nuw> for any C 9961 if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNUW)) 9962 return true; 9963 break; 9964 9965 case ICmpInst::ICMP_UGT: 9966 std::swap(LHS, RHS); 9967 LLVM_FALLTHROUGH; 9968 case ICmpInst::ICMP_ULT: 9969 // X u< (X + C)<nuw> if C != 0 9970 if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNUW) && !C.isNullValue()) 9971 return true; 9972 break; 9973 } 9974 9975 return false; 9976 } 9977 9978 bool ScalarEvolution::isKnownPredicateViaSplitting(ICmpInst::Predicate Pred, 9979 const SCEV *LHS, 9980 const SCEV *RHS) { 9981 if (Pred != ICmpInst::ICMP_ULT || ProvingSplitPredicate) 9982 return false; 9983 9984 // Allowing arbitrary number of activations of isKnownPredicateViaSplitting on 9985 // the stack can result in exponential time complexity. 9986 SaveAndRestore<bool> Restore(ProvingSplitPredicate, true); 9987 9988 // If L >= 0 then I `ult` L <=> I >= 0 && I `slt` L 9989 // 9990 // To prove L >= 0 we use isKnownNonNegative whereas to prove I >= 0 we use 9991 // isKnownPredicate. isKnownPredicate is more powerful, but also more 9992 // expensive; and using isKnownNonNegative(RHS) is sufficient for most of the 9993 // interesting cases seen in practice. We can consider "upgrading" L >= 0 to 9994 // use isKnownPredicate later if needed. 9995 return isKnownNonNegative(RHS) && 9996 isKnownPredicate(CmpInst::ICMP_SGE, LHS, getZero(LHS->getType())) && 9997 isKnownPredicate(CmpInst::ICMP_SLT, LHS, RHS); 9998 } 9999 10000 bool ScalarEvolution::isImpliedViaGuard(const BasicBlock *BB, 10001 ICmpInst::Predicate Pred, 10002 const SCEV *LHS, const SCEV *RHS) { 10003 // No need to even try if we know the module has no guards. 10004 if (!HasGuards) 10005 return false; 10006 10007 return any_of(*BB, [&](const Instruction &I) { 10008 using namespace llvm::PatternMatch; 10009 10010 Value *Condition; 10011 return match(&I, m_Intrinsic<Intrinsic::experimental_guard>( 10012 m_Value(Condition))) && 10013 isImpliedCond(Pred, LHS, RHS, Condition, false); 10014 }); 10015 } 10016 10017 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is 10018 /// protected by a conditional between LHS and RHS. This is used to 10019 /// to eliminate casts. 10020 bool 10021 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L, 10022 ICmpInst::Predicate Pred, 10023 const SCEV *LHS, const SCEV *RHS) { 10024 // Interpret a null as meaning no loop, where there is obviously no guard 10025 // (interprocedural conditions notwithstanding). 10026 if (!L) return true; 10027 10028 if (VerifyIR) 10029 assert(!verifyFunction(*L->getHeader()->getParent(), &dbgs()) && 10030 "This cannot be done on broken IR!"); 10031 10032 10033 if (isKnownViaNonRecursiveReasoning(Pred, LHS, RHS)) 10034 return true; 10035 10036 BasicBlock *Latch = L->getLoopLatch(); 10037 if (!Latch) 10038 return false; 10039 10040 BranchInst *LoopContinuePredicate = 10041 dyn_cast<BranchInst>(Latch->getTerminator()); 10042 if (LoopContinuePredicate && LoopContinuePredicate->isConditional() && 10043 isImpliedCond(Pred, LHS, RHS, 10044 LoopContinuePredicate->getCondition(), 10045 LoopContinuePredicate->getSuccessor(0) != L->getHeader())) 10046 return true; 10047 10048 // We don't want more than one activation of the following loops on the stack 10049 // -- that can lead to O(n!) time complexity. 10050 if (WalkingBEDominatingConds) 10051 return false; 10052 10053 SaveAndRestore<bool> ClearOnExit(WalkingBEDominatingConds, true); 10054 10055 // See if we can exploit a trip count to prove the predicate. 10056 const auto &BETakenInfo = getBackedgeTakenInfo(L); 10057 const SCEV *LatchBECount = BETakenInfo.getExact(Latch, this); 10058 if (LatchBECount != getCouldNotCompute()) { 10059 // We know that Latch branches back to the loop header exactly 10060 // LatchBECount times. This means the backdege condition at Latch is 10061 // equivalent to "{0,+,1} u< LatchBECount". 10062 Type *Ty = LatchBECount->getType(); 10063 auto NoWrapFlags = SCEV::NoWrapFlags(SCEV::FlagNUW | SCEV::FlagNW); 10064 const SCEV *LoopCounter = 10065 getAddRecExpr(getZero(Ty), getOne(Ty), L, NoWrapFlags); 10066 if (isImpliedCond(Pred, LHS, RHS, ICmpInst::ICMP_ULT, LoopCounter, 10067 LatchBECount)) 10068 return true; 10069 } 10070 10071 // Check conditions due to any @llvm.assume intrinsics. 10072 for (auto &AssumeVH : AC.assumptions()) { 10073 if (!AssumeVH) 10074 continue; 10075 auto *CI = cast<CallInst>(AssumeVH); 10076 if (!DT.dominates(CI, Latch->getTerminator())) 10077 continue; 10078 10079 if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false)) 10080 return true; 10081 } 10082 10083 // If the loop is not reachable from the entry block, we risk running into an 10084 // infinite loop as we walk up into the dom tree. These loops do not matter 10085 // anyway, so we just return a conservative answer when we see them. 10086 if (!DT.isReachableFromEntry(L->getHeader())) 10087 return false; 10088 10089 if (isImpliedViaGuard(Latch, Pred, LHS, RHS)) 10090 return true; 10091 10092 for (DomTreeNode *DTN = DT[Latch], *HeaderDTN = DT[L->getHeader()]; 10093 DTN != HeaderDTN; DTN = DTN->getIDom()) { 10094 assert(DTN && "should reach the loop header before reaching the root!"); 10095 10096 BasicBlock *BB = DTN->getBlock(); 10097 if (isImpliedViaGuard(BB, Pred, LHS, RHS)) 10098 return true; 10099 10100 BasicBlock *PBB = BB->getSinglePredecessor(); 10101 if (!PBB) 10102 continue; 10103 10104 BranchInst *ContinuePredicate = dyn_cast<BranchInst>(PBB->getTerminator()); 10105 if (!ContinuePredicate || !ContinuePredicate->isConditional()) 10106 continue; 10107 10108 Value *Condition = ContinuePredicate->getCondition(); 10109 10110 // If we have an edge `E` within the loop body that dominates the only 10111 // latch, the condition guarding `E` also guards the backedge. This 10112 // reasoning works only for loops with a single latch. 10113 10114 BasicBlockEdge DominatingEdge(PBB, BB); 10115 if (DominatingEdge.isSingleEdge()) { 10116 // We're constructively (and conservatively) enumerating edges within the 10117 // loop body that dominate the latch. The dominator tree better agree 10118 // with us on this: 10119 assert(DT.dominates(DominatingEdge, Latch) && "should be!"); 10120 10121 if (isImpliedCond(Pred, LHS, RHS, Condition, 10122 BB != ContinuePredicate->getSuccessor(0))) 10123 return true; 10124 } 10125 } 10126 10127 return false; 10128 } 10129 10130 bool ScalarEvolution::isBasicBlockEntryGuardedByCond(const BasicBlock *BB, 10131 ICmpInst::Predicate Pred, 10132 const SCEV *LHS, 10133 const SCEV *RHS) { 10134 if (VerifyIR) 10135 assert(!verifyFunction(*BB->getParent(), &dbgs()) && 10136 "This cannot be done on broken IR!"); 10137 10138 // If we cannot prove strict comparison (e.g. a > b), maybe we can prove 10139 // the facts (a >= b && a != b) separately. A typical situation is when the 10140 // non-strict comparison is known from ranges and non-equality is known from 10141 // dominating predicates. If we are proving strict comparison, we always try 10142 // to prove non-equality and non-strict comparison separately. 10143 auto NonStrictPredicate = ICmpInst::getNonStrictPredicate(Pred); 10144 const bool ProvingStrictComparison = (Pred != NonStrictPredicate); 10145 bool ProvedNonStrictComparison = false; 10146 bool ProvedNonEquality = false; 10147 10148 auto SplitAndProve = 10149 [&](std::function<bool(ICmpInst::Predicate)> Fn) -> bool { 10150 if (!ProvedNonStrictComparison) 10151 ProvedNonStrictComparison = Fn(NonStrictPredicate); 10152 if (!ProvedNonEquality) 10153 ProvedNonEquality = Fn(ICmpInst::ICMP_NE); 10154 if (ProvedNonStrictComparison && ProvedNonEquality) 10155 return true; 10156 return false; 10157 }; 10158 10159 if (ProvingStrictComparison) { 10160 auto ProofFn = [&](ICmpInst::Predicate P) { 10161 return isKnownViaNonRecursiveReasoning(P, LHS, RHS); 10162 }; 10163 if (SplitAndProve(ProofFn)) 10164 return true; 10165 } 10166 10167 // Try to prove (Pred, LHS, RHS) using isImpliedViaGuard. 10168 auto ProveViaGuard = [&](const BasicBlock *Block) { 10169 if (isImpliedViaGuard(Block, Pred, LHS, RHS)) 10170 return true; 10171 if (ProvingStrictComparison) { 10172 auto ProofFn = [&](ICmpInst::Predicate P) { 10173 return isImpliedViaGuard(Block, P, LHS, RHS); 10174 }; 10175 if (SplitAndProve(ProofFn)) 10176 return true; 10177 } 10178 return false; 10179 }; 10180 10181 // Try to prove (Pred, LHS, RHS) using isImpliedCond. 10182 auto ProveViaCond = [&](const Value *Condition, bool Inverse) { 10183 const Instruction *Context = &BB->front(); 10184 if (isImpliedCond(Pred, LHS, RHS, Condition, Inverse, Context)) 10185 return true; 10186 if (ProvingStrictComparison) { 10187 auto ProofFn = [&](ICmpInst::Predicate P) { 10188 return isImpliedCond(P, LHS, RHS, Condition, Inverse, Context); 10189 }; 10190 if (SplitAndProve(ProofFn)) 10191 return true; 10192 } 10193 return false; 10194 }; 10195 10196 // Starting at the block's predecessor, climb up the predecessor chain, as long 10197 // as there are predecessors that can be found that have unique successors 10198 // leading to the original block. 10199 const Loop *ContainingLoop = LI.getLoopFor(BB); 10200 const BasicBlock *PredBB; 10201 if (ContainingLoop && ContainingLoop->getHeader() == BB) 10202 PredBB = ContainingLoop->getLoopPredecessor(); 10203 else 10204 PredBB = BB->getSinglePredecessor(); 10205 for (std::pair<const BasicBlock *, const BasicBlock *> Pair(PredBB, BB); 10206 Pair.first; Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) { 10207 if (ProveViaGuard(Pair.first)) 10208 return true; 10209 10210 const BranchInst *LoopEntryPredicate = 10211 dyn_cast<BranchInst>(Pair.first->getTerminator()); 10212 if (!LoopEntryPredicate || 10213 LoopEntryPredicate->isUnconditional()) 10214 continue; 10215 10216 if (ProveViaCond(LoopEntryPredicate->getCondition(), 10217 LoopEntryPredicate->getSuccessor(0) != Pair.second)) 10218 return true; 10219 } 10220 10221 // Check conditions due to any @llvm.assume intrinsics. 10222 for (auto &AssumeVH : AC.assumptions()) { 10223 if (!AssumeVH) 10224 continue; 10225 auto *CI = cast<CallInst>(AssumeVH); 10226 if (!DT.dominates(CI, BB)) 10227 continue; 10228 10229 if (ProveViaCond(CI->getArgOperand(0), false)) 10230 return true; 10231 } 10232 10233 return false; 10234 } 10235 10236 bool ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L, 10237 ICmpInst::Predicate Pred, 10238 const SCEV *LHS, 10239 const SCEV *RHS) { 10240 // Interpret a null as meaning no loop, where there is obviously no guard 10241 // (interprocedural conditions notwithstanding). 10242 if (!L) 10243 return false; 10244 10245 // Both LHS and RHS must be available at loop entry. 10246 assert(isAvailableAtLoopEntry(LHS, L) && 10247 "LHS is not available at Loop Entry"); 10248 assert(isAvailableAtLoopEntry(RHS, L) && 10249 "RHS is not available at Loop Entry"); 10250 10251 if (isKnownViaNonRecursiveReasoning(Pred, LHS, RHS)) 10252 return true; 10253 10254 return isBasicBlockEntryGuardedByCond(L->getHeader(), Pred, LHS, RHS); 10255 } 10256 10257 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS, 10258 const SCEV *RHS, 10259 const Value *FoundCondValue, bool Inverse, 10260 const Instruction *Context) { 10261 // False conditions implies anything. Do not bother analyzing it further. 10262 if (FoundCondValue == 10263 ConstantInt::getBool(FoundCondValue->getContext(), Inverse)) 10264 return true; 10265 10266 if (!PendingLoopPredicates.insert(FoundCondValue).second) 10267 return false; 10268 10269 auto ClearOnExit = 10270 make_scope_exit([&]() { PendingLoopPredicates.erase(FoundCondValue); }); 10271 10272 // Recursively handle And and Or conditions. 10273 const Value *Op0, *Op1; 10274 if (match(FoundCondValue, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) { 10275 if (!Inverse) 10276 return isImpliedCond(Pred, LHS, RHS, Op0, Inverse, Context) || 10277 isImpliedCond(Pred, LHS, RHS, Op1, Inverse, Context); 10278 } else if (match(FoundCondValue, m_LogicalOr(m_Value(Op0), m_Value(Op1)))) { 10279 if (Inverse) 10280 return isImpliedCond(Pred, LHS, RHS, Op0, Inverse, Context) || 10281 isImpliedCond(Pred, LHS, RHS, Op1, Inverse, Context); 10282 } 10283 10284 const ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue); 10285 if (!ICI) return false; 10286 10287 // Now that we found a conditional branch that dominates the loop or controls 10288 // the loop latch. Check to see if it is the comparison we are looking for. 10289 ICmpInst::Predicate FoundPred; 10290 if (Inverse) 10291 FoundPred = ICI->getInversePredicate(); 10292 else 10293 FoundPred = ICI->getPredicate(); 10294 10295 const SCEV *FoundLHS = getSCEV(ICI->getOperand(0)); 10296 const SCEV *FoundRHS = getSCEV(ICI->getOperand(1)); 10297 10298 return isImpliedCond(Pred, LHS, RHS, FoundPred, FoundLHS, FoundRHS, Context); 10299 } 10300 10301 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS, 10302 const SCEV *RHS, 10303 ICmpInst::Predicate FoundPred, 10304 const SCEV *FoundLHS, const SCEV *FoundRHS, 10305 const Instruction *Context) { 10306 // Balance the types. 10307 if (getTypeSizeInBits(LHS->getType()) < 10308 getTypeSizeInBits(FoundLHS->getType())) { 10309 // For unsigned and equality predicates, try to prove that both found 10310 // operands fit into narrow unsigned range. If so, try to prove facts in 10311 // narrow types. 10312 if (!CmpInst::isSigned(FoundPred)) { 10313 auto *NarrowType = LHS->getType(); 10314 auto *WideType = FoundLHS->getType(); 10315 auto BitWidth = getTypeSizeInBits(NarrowType); 10316 const SCEV *MaxValue = getZeroExtendExpr( 10317 getConstant(APInt::getMaxValue(BitWidth)), WideType); 10318 if (isKnownPredicate(ICmpInst::ICMP_ULE, FoundLHS, MaxValue) && 10319 isKnownPredicate(ICmpInst::ICMP_ULE, FoundRHS, MaxValue)) { 10320 const SCEV *TruncFoundLHS = getTruncateExpr(FoundLHS, NarrowType); 10321 const SCEV *TruncFoundRHS = getTruncateExpr(FoundRHS, NarrowType); 10322 if (isImpliedCondBalancedTypes(Pred, LHS, RHS, FoundPred, TruncFoundLHS, 10323 TruncFoundRHS, Context)) 10324 return true; 10325 } 10326 } 10327 10328 if (CmpInst::isSigned(Pred)) { 10329 LHS = getSignExtendExpr(LHS, FoundLHS->getType()); 10330 RHS = getSignExtendExpr(RHS, FoundLHS->getType()); 10331 } else { 10332 LHS = getZeroExtendExpr(LHS, FoundLHS->getType()); 10333 RHS = getZeroExtendExpr(RHS, FoundLHS->getType()); 10334 } 10335 } else if (getTypeSizeInBits(LHS->getType()) > 10336 getTypeSizeInBits(FoundLHS->getType())) { 10337 if (CmpInst::isSigned(FoundPred)) { 10338 FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType()); 10339 FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType()); 10340 } else { 10341 FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType()); 10342 FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType()); 10343 } 10344 } 10345 return isImpliedCondBalancedTypes(Pred, LHS, RHS, FoundPred, FoundLHS, 10346 FoundRHS, Context); 10347 } 10348 10349 bool ScalarEvolution::isImpliedCondBalancedTypes( 10350 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 10351 ICmpInst::Predicate FoundPred, const SCEV *FoundLHS, const SCEV *FoundRHS, 10352 const Instruction *Context) { 10353 assert(getTypeSizeInBits(LHS->getType()) == 10354 getTypeSizeInBits(FoundLHS->getType()) && 10355 "Types should be balanced!"); 10356 // Canonicalize the query to match the way instcombine will have 10357 // canonicalized the comparison. 10358 if (SimplifyICmpOperands(Pred, LHS, RHS)) 10359 if (LHS == RHS) 10360 return CmpInst::isTrueWhenEqual(Pred); 10361 if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS)) 10362 if (FoundLHS == FoundRHS) 10363 return CmpInst::isFalseWhenEqual(FoundPred); 10364 10365 // Check to see if we can make the LHS or RHS match. 10366 if (LHS == FoundRHS || RHS == FoundLHS) { 10367 if (isa<SCEVConstant>(RHS)) { 10368 std::swap(FoundLHS, FoundRHS); 10369 FoundPred = ICmpInst::getSwappedPredicate(FoundPred); 10370 } else { 10371 std::swap(LHS, RHS); 10372 Pred = ICmpInst::getSwappedPredicate(Pred); 10373 } 10374 } 10375 10376 // Check whether the found predicate is the same as the desired predicate. 10377 if (FoundPred == Pred) 10378 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, Context); 10379 10380 // Check whether swapping the found predicate makes it the same as the 10381 // desired predicate. 10382 if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) { 10383 // We can write the implication 10384 // 0. LHS Pred RHS <- FoundLHS SwapPred FoundRHS 10385 // using one of the following ways: 10386 // 1. LHS Pred RHS <- FoundRHS Pred FoundLHS 10387 // 2. RHS SwapPred LHS <- FoundLHS SwapPred FoundRHS 10388 // 3. LHS Pred RHS <- ~FoundLHS Pred ~FoundRHS 10389 // 4. ~LHS SwapPred ~RHS <- FoundLHS SwapPred FoundRHS 10390 // Forms 1. and 2. require swapping the operands of one condition. Don't 10391 // do this if it would break canonical constant/addrec ordering. 10392 if (!isa<SCEVConstant>(RHS) && !isa<SCEVAddRecExpr>(LHS)) 10393 return isImpliedCondOperands(FoundPred, RHS, LHS, FoundLHS, FoundRHS, 10394 Context); 10395 if (!isa<SCEVConstant>(FoundRHS) && !isa<SCEVAddRecExpr>(FoundLHS)) 10396 return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS, Context); 10397 10398 // There's no clear preference between forms 3. and 4., try both. 10399 return isImpliedCondOperands(FoundPred, getNotSCEV(LHS), getNotSCEV(RHS), 10400 FoundLHS, FoundRHS, Context) || 10401 isImpliedCondOperands(Pred, LHS, RHS, getNotSCEV(FoundLHS), 10402 getNotSCEV(FoundRHS), Context); 10403 } 10404 10405 // Unsigned comparison is the same as signed comparison when both the operands 10406 // are non-negative. 10407 if (CmpInst::isUnsigned(FoundPred) && 10408 CmpInst::getSignedPredicate(FoundPred) == Pred && 10409 isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS)) 10410 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, Context); 10411 10412 // Check if we can make progress by sharpening ranges. 10413 if (FoundPred == ICmpInst::ICMP_NE && 10414 (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) { 10415 10416 const SCEVConstant *C = nullptr; 10417 const SCEV *V = nullptr; 10418 10419 if (isa<SCEVConstant>(FoundLHS)) { 10420 C = cast<SCEVConstant>(FoundLHS); 10421 V = FoundRHS; 10422 } else { 10423 C = cast<SCEVConstant>(FoundRHS); 10424 V = FoundLHS; 10425 } 10426 10427 // The guarding predicate tells us that C != V. If the known range 10428 // of V is [C, t), we can sharpen the range to [C + 1, t). The 10429 // range we consider has to correspond to same signedness as the 10430 // predicate we're interested in folding. 10431 10432 APInt Min = ICmpInst::isSigned(Pred) ? 10433 getSignedRangeMin(V) : getUnsignedRangeMin(V); 10434 10435 if (Min == C->getAPInt()) { 10436 // Given (V >= Min && V != Min) we conclude V >= (Min + 1). 10437 // This is true even if (Min + 1) wraps around -- in case of 10438 // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)). 10439 10440 APInt SharperMin = Min + 1; 10441 10442 switch (Pred) { 10443 case ICmpInst::ICMP_SGE: 10444 case ICmpInst::ICMP_UGE: 10445 // We know V `Pred` SharperMin. If this implies LHS `Pred` 10446 // RHS, we're done. 10447 if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(SharperMin), 10448 Context)) 10449 return true; 10450 LLVM_FALLTHROUGH; 10451 10452 case ICmpInst::ICMP_SGT: 10453 case ICmpInst::ICMP_UGT: 10454 // We know from the range information that (V `Pred` Min || 10455 // V == Min). We know from the guarding condition that !(V 10456 // == Min). This gives us 10457 // 10458 // V `Pred` Min || V == Min && !(V == Min) 10459 // => V `Pred` Min 10460 // 10461 // If V `Pred` Min implies LHS `Pred` RHS, we're done. 10462 10463 if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min), 10464 Context)) 10465 return true; 10466 break; 10467 10468 // `LHS < RHS` and `LHS <= RHS` are handled in the same way as `RHS > LHS` and `RHS >= LHS` respectively. 10469 case ICmpInst::ICMP_SLE: 10470 case ICmpInst::ICMP_ULE: 10471 if (isImpliedCondOperands(CmpInst::getSwappedPredicate(Pred), RHS, 10472 LHS, V, getConstant(SharperMin), Context)) 10473 return true; 10474 LLVM_FALLTHROUGH; 10475 10476 case ICmpInst::ICMP_SLT: 10477 case ICmpInst::ICMP_ULT: 10478 if (isImpliedCondOperands(CmpInst::getSwappedPredicate(Pred), RHS, 10479 LHS, V, getConstant(Min), Context)) 10480 return true; 10481 break; 10482 10483 default: 10484 // No change 10485 break; 10486 } 10487 } 10488 } 10489 10490 // Check whether the actual condition is beyond sufficient. 10491 if (FoundPred == ICmpInst::ICMP_EQ) 10492 if (ICmpInst::isTrueWhenEqual(Pred)) 10493 if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, Context)) 10494 return true; 10495 if (Pred == ICmpInst::ICMP_NE) 10496 if (!ICmpInst::isTrueWhenEqual(FoundPred)) 10497 if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS, 10498 Context)) 10499 return true; 10500 10501 // Otherwise assume the worst. 10502 return false; 10503 } 10504 10505 bool ScalarEvolution::splitBinaryAdd(const SCEV *Expr, 10506 const SCEV *&L, const SCEV *&R, 10507 SCEV::NoWrapFlags &Flags) { 10508 const auto *AE = dyn_cast<SCEVAddExpr>(Expr); 10509 if (!AE || AE->getNumOperands() != 2) 10510 return false; 10511 10512 L = AE->getOperand(0); 10513 R = AE->getOperand(1); 10514 Flags = AE->getNoWrapFlags(); 10515 return true; 10516 } 10517 10518 Optional<APInt> ScalarEvolution::computeConstantDifference(const SCEV *More, 10519 const SCEV *Less) { 10520 // We avoid subtracting expressions here because this function is usually 10521 // fairly deep in the call stack (i.e. is called many times). 10522 10523 // X - X = 0. 10524 if (More == Less) 10525 return APInt(getTypeSizeInBits(More->getType()), 0); 10526 10527 if (isa<SCEVAddRecExpr>(Less) && isa<SCEVAddRecExpr>(More)) { 10528 const auto *LAR = cast<SCEVAddRecExpr>(Less); 10529 const auto *MAR = cast<SCEVAddRecExpr>(More); 10530 10531 if (LAR->getLoop() != MAR->getLoop()) 10532 return None; 10533 10534 // We look at affine expressions only; not for correctness but to keep 10535 // getStepRecurrence cheap. 10536 if (!LAR->isAffine() || !MAR->isAffine()) 10537 return None; 10538 10539 if (LAR->getStepRecurrence(*this) != MAR->getStepRecurrence(*this)) 10540 return None; 10541 10542 Less = LAR->getStart(); 10543 More = MAR->getStart(); 10544 10545 // fall through 10546 } 10547 10548 if (isa<SCEVConstant>(Less) && isa<SCEVConstant>(More)) { 10549 const auto &M = cast<SCEVConstant>(More)->getAPInt(); 10550 const auto &L = cast<SCEVConstant>(Less)->getAPInt(); 10551 return M - L; 10552 } 10553 10554 SCEV::NoWrapFlags Flags; 10555 const SCEV *LLess = nullptr, *RLess = nullptr; 10556 const SCEV *LMore = nullptr, *RMore = nullptr; 10557 const SCEVConstant *C1 = nullptr, *C2 = nullptr; 10558 // Compare (X + C1) vs X. 10559 if (splitBinaryAdd(Less, LLess, RLess, Flags)) 10560 if ((C1 = dyn_cast<SCEVConstant>(LLess))) 10561 if (RLess == More) 10562 return -(C1->getAPInt()); 10563 10564 // Compare X vs (X + C2). 10565 if (splitBinaryAdd(More, LMore, RMore, Flags)) 10566 if ((C2 = dyn_cast<SCEVConstant>(LMore))) 10567 if (RMore == Less) 10568 return C2->getAPInt(); 10569 10570 // Compare (X + C1) vs (X + C2). 10571 if (C1 && C2 && RLess == RMore) 10572 return C2->getAPInt() - C1->getAPInt(); 10573 10574 return None; 10575 } 10576 10577 bool ScalarEvolution::isImpliedCondOperandsViaAddRecStart( 10578 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 10579 const SCEV *FoundLHS, const SCEV *FoundRHS, const Instruction *Context) { 10580 // Try to recognize the following pattern: 10581 // 10582 // FoundRHS = ... 10583 // ... 10584 // loop: 10585 // FoundLHS = {Start,+,W} 10586 // context_bb: // Basic block from the same loop 10587 // known(Pred, FoundLHS, FoundRHS) 10588 // 10589 // If some predicate is known in the context of a loop, it is also known on 10590 // each iteration of this loop, including the first iteration. Therefore, in 10591 // this case, `FoundLHS Pred FoundRHS` implies `Start Pred FoundRHS`. Try to 10592 // prove the original pred using this fact. 10593 if (!Context) 10594 return false; 10595 const BasicBlock *ContextBB = Context->getParent(); 10596 // Make sure AR varies in the context block. 10597 if (auto *AR = dyn_cast<SCEVAddRecExpr>(FoundLHS)) { 10598 const Loop *L = AR->getLoop(); 10599 // Make sure that context belongs to the loop and executes on 1st iteration 10600 // (if it ever executes at all). 10601 if (!L->contains(ContextBB) || !DT.dominates(ContextBB, L->getLoopLatch())) 10602 return false; 10603 if (!isAvailableAtLoopEntry(FoundRHS, AR->getLoop())) 10604 return false; 10605 return isImpliedCondOperands(Pred, LHS, RHS, AR->getStart(), FoundRHS); 10606 } 10607 10608 if (auto *AR = dyn_cast<SCEVAddRecExpr>(FoundRHS)) { 10609 const Loop *L = AR->getLoop(); 10610 // Make sure that context belongs to the loop and executes on 1st iteration 10611 // (if it ever executes at all). 10612 if (!L->contains(ContextBB) || !DT.dominates(ContextBB, L->getLoopLatch())) 10613 return false; 10614 if (!isAvailableAtLoopEntry(FoundLHS, AR->getLoop())) 10615 return false; 10616 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, AR->getStart()); 10617 } 10618 10619 return false; 10620 } 10621 10622 bool ScalarEvolution::isImpliedCondOperandsViaNoOverflow( 10623 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 10624 const SCEV *FoundLHS, const SCEV *FoundRHS) { 10625 if (Pred != CmpInst::ICMP_SLT && Pred != CmpInst::ICMP_ULT) 10626 return false; 10627 10628 const auto *AddRecLHS = dyn_cast<SCEVAddRecExpr>(LHS); 10629 if (!AddRecLHS) 10630 return false; 10631 10632 const auto *AddRecFoundLHS = dyn_cast<SCEVAddRecExpr>(FoundLHS); 10633 if (!AddRecFoundLHS) 10634 return false; 10635 10636 // We'd like to let SCEV reason about control dependencies, so we constrain 10637 // both the inequalities to be about add recurrences on the same loop. This 10638 // way we can use isLoopEntryGuardedByCond later. 10639 10640 const Loop *L = AddRecFoundLHS->getLoop(); 10641 if (L != AddRecLHS->getLoop()) 10642 return false; 10643 10644 // FoundLHS u< FoundRHS u< -C => (FoundLHS + C) u< (FoundRHS + C) ... (1) 10645 // 10646 // FoundLHS s< FoundRHS s< INT_MIN - C => (FoundLHS + C) s< (FoundRHS + C) 10647 // ... (2) 10648 // 10649 // Informal proof for (2), assuming (1) [*]: 10650 // 10651 // We'll also assume (A s< B) <=> ((A + INT_MIN) u< (B + INT_MIN)) ... (3)[**] 10652 // 10653 // Then 10654 // 10655 // FoundLHS s< FoundRHS s< INT_MIN - C 10656 // <=> (FoundLHS + INT_MIN) u< (FoundRHS + INT_MIN) u< -C [ using (3) ] 10657 // <=> (FoundLHS + INT_MIN + C) u< (FoundRHS + INT_MIN + C) [ using (1) ] 10658 // <=> (FoundLHS + INT_MIN + C + INT_MIN) s< 10659 // (FoundRHS + INT_MIN + C + INT_MIN) [ using (3) ] 10660 // <=> FoundLHS + C s< FoundRHS + C 10661 // 10662 // [*]: (1) can be proved by ruling out overflow. 10663 // 10664 // [**]: This can be proved by analyzing all the four possibilities: 10665 // (A s< 0, B s< 0), (A s< 0, B s>= 0), (A s>= 0, B s< 0) and 10666 // (A s>= 0, B s>= 0). 10667 // 10668 // Note: 10669 // Despite (2), "FoundRHS s< INT_MIN - C" does not mean that "FoundRHS + C" 10670 // will not sign underflow. For instance, say FoundLHS = (i8 -128), FoundRHS 10671 // = (i8 -127) and C = (i8 -100). Then INT_MIN - C = (i8 -28), and FoundRHS 10672 // s< (INT_MIN - C). Lack of sign overflow / underflow in "FoundRHS + C" is 10673 // neither necessary nor sufficient to prove "(FoundLHS + C) s< (FoundRHS + 10674 // C)". 10675 10676 Optional<APInt> LDiff = computeConstantDifference(LHS, FoundLHS); 10677 Optional<APInt> RDiff = computeConstantDifference(RHS, FoundRHS); 10678 if (!LDiff || !RDiff || *LDiff != *RDiff) 10679 return false; 10680 10681 if (LDiff->isMinValue()) 10682 return true; 10683 10684 APInt FoundRHSLimit; 10685 10686 if (Pred == CmpInst::ICMP_ULT) { 10687 FoundRHSLimit = -(*RDiff); 10688 } else { 10689 assert(Pred == CmpInst::ICMP_SLT && "Checked above!"); 10690 FoundRHSLimit = APInt::getSignedMinValue(getTypeSizeInBits(RHS->getType())) - *RDiff; 10691 } 10692 10693 // Try to prove (1) or (2), as needed. 10694 return isAvailableAtLoopEntry(FoundRHS, L) && 10695 isLoopEntryGuardedByCond(L, Pred, FoundRHS, 10696 getConstant(FoundRHSLimit)); 10697 } 10698 10699 bool ScalarEvolution::isImpliedViaMerge(ICmpInst::Predicate Pred, 10700 const SCEV *LHS, const SCEV *RHS, 10701 const SCEV *FoundLHS, 10702 const SCEV *FoundRHS, unsigned Depth) { 10703 const PHINode *LPhi = nullptr, *RPhi = nullptr; 10704 10705 auto ClearOnExit = make_scope_exit([&]() { 10706 if (LPhi) { 10707 bool Erased = PendingMerges.erase(LPhi); 10708 assert(Erased && "Failed to erase LPhi!"); 10709 (void)Erased; 10710 } 10711 if (RPhi) { 10712 bool Erased = PendingMerges.erase(RPhi); 10713 assert(Erased && "Failed to erase RPhi!"); 10714 (void)Erased; 10715 } 10716 }); 10717 10718 // Find respective Phis and check that they are not being pending. 10719 if (const SCEVUnknown *LU = dyn_cast<SCEVUnknown>(LHS)) 10720 if (auto *Phi = dyn_cast<PHINode>(LU->getValue())) { 10721 if (!PendingMerges.insert(Phi).second) 10722 return false; 10723 LPhi = Phi; 10724 } 10725 if (const SCEVUnknown *RU = dyn_cast<SCEVUnknown>(RHS)) 10726 if (auto *Phi = dyn_cast<PHINode>(RU->getValue())) { 10727 // If we detect a loop of Phi nodes being processed by this method, for 10728 // example: 10729 // 10730 // %a = phi i32 [ %some1, %preheader ], [ %b, %latch ] 10731 // %b = phi i32 [ %some2, %preheader ], [ %a, %latch ] 10732 // 10733 // we don't want to deal with a case that complex, so return conservative 10734 // answer false. 10735 if (!PendingMerges.insert(Phi).second) 10736 return false; 10737 RPhi = Phi; 10738 } 10739 10740 // If none of LHS, RHS is a Phi, nothing to do here. 10741 if (!LPhi && !RPhi) 10742 return false; 10743 10744 // If there is a SCEVUnknown Phi we are interested in, make it left. 10745 if (!LPhi) { 10746 std::swap(LHS, RHS); 10747 std::swap(FoundLHS, FoundRHS); 10748 std::swap(LPhi, RPhi); 10749 Pred = ICmpInst::getSwappedPredicate(Pred); 10750 } 10751 10752 assert(LPhi && "LPhi should definitely be a SCEVUnknown Phi!"); 10753 const BasicBlock *LBB = LPhi->getParent(); 10754 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS); 10755 10756 auto ProvedEasily = [&](const SCEV *S1, const SCEV *S2) { 10757 return isKnownViaNonRecursiveReasoning(Pred, S1, S2) || 10758 isImpliedCondOperandsViaRanges(Pred, S1, S2, FoundLHS, FoundRHS) || 10759 isImpliedViaOperations(Pred, S1, S2, FoundLHS, FoundRHS, Depth); 10760 }; 10761 10762 if (RPhi && RPhi->getParent() == LBB) { 10763 // Case one: RHS is also a SCEVUnknown Phi from the same basic block. 10764 // If we compare two Phis from the same block, and for each entry block 10765 // the predicate is true for incoming values from this block, then the 10766 // predicate is also true for the Phis. 10767 for (const BasicBlock *IncBB : predecessors(LBB)) { 10768 const SCEV *L = getSCEV(LPhi->getIncomingValueForBlock(IncBB)); 10769 const SCEV *R = getSCEV(RPhi->getIncomingValueForBlock(IncBB)); 10770 if (!ProvedEasily(L, R)) 10771 return false; 10772 } 10773 } else if (RAR && RAR->getLoop()->getHeader() == LBB) { 10774 // Case two: RHS is also a Phi from the same basic block, and it is an 10775 // AddRec. It means that there is a loop which has both AddRec and Unknown 10776 // PHIs, for it we can compare incoming values of AddRec from above the loop 10777 // and latch with their respective incoming values of LPhi. 10778 // TODO: Generalize to handle loops with many inputs in a header. 10779 if (LPhi->getNumIncomingValues() != 2) return false; 10780 10781 auto *RLoop = RAR->getLoop(); 10782 auto *Predecessor = RLoop->getLoopPredecessor(); 10783 assert(Predecessor && "Loop with AddRec with no predecessor?"); 10784 const SCEV *L1 = getSCEV(LPhi->getIncomingValueForBlock(Predecessor)); 10785 if (!ProvedEasily(L1, RAR->getStart())) 10786 return false; 10787 auto *Latch = RLoop->getLoopLatch(); 10788 assert(Latch && "Loop with AddRec with no latch?"); 10789 const SCEV *L2 = getSCEV(LPhi->getIncomingValueForBlock(Latch)); 10790 if (!ProvedEasily(L2, RAR->getPostIncExpr(*this))) 10791 return false; 10792 } else { 10793 // In all other cases go over inputs of LHS and compare each of them to RHS, 10794 // the predicate is true for (LHS, RHS) if it is true for all such pairs. 10795 // At this point RHS is either a non-Phi, or it is a Phi from some block 10796 // different from LBB. 10797 for (const BasicBlock *IncBB : predecessors(LBB)) { 10798 // Check that RHS is available in this block. 10799 if (!dominates(RHS, IncBB)) 10800 return false; 10801 const SCEV *L = getSCEV(LPhi->getIncomingValueForBlock(IncBB)); 10802 if (!ProvedEasily(L, RHS)) 10803 return false; 10804 } 10805 } 10806 return true; 10807 } 10808 10809 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred, 10810 const SCEV *LHS, const SCEV *RHS, 10811 const SCEV *FoundLHS, 10812 const SCEV *FoundRHS, 10813 const Instruction *Context) { 10814 if (isImpliedCondOperandsViaRanges(Pred, LHS, RHS, FoundLHS, FoundRHS)) 10815 return true; 10816 10817 if (isImpliedCondOperandsViaNoOverflow(Pred, LHS, RHS, FoundLHS, FoundRHS)) 10818 return true; 10819 10820 if (isImpliedCondOperandsViaAddRecStart(Pred, LHS, RHS, FoundLHS, FoundRHS, 10821 Context)) 10822 return true; 10823 10824 return isImpliedCondOperandsHelper(Pred, LHS, RHS, 10825 FoundLHS, FoundRHS); 10826 } 10827 10828 /// Is MaybeMinMaxExpr an (U|S)(Min|Max) of Candidate and some other values? 10829 template <typename MinMaxExprType> 10830 static bool IsMinMaxConsistingOf(const SCEV *MaybeMinMaxExpr, 10831 const SCEV *Candidate) { 10832 const MinMaxExprType *MinMaxExpr = dyn_cast<MinMaxExprType>(MaybeMinMaxExpr); 10833 if (!MinMaxExpr) 10834 return false; 10835 10836 return is_contained(MinMaxExpr->operands(), Candidate); 10837 } 10838 10839 static bool IsKnownPredicateViaAddRecStart(ScalarEvolution &SE, 10840 ICmpInst::Predicate Pred, 10841 const SCEV *LHS, const SCEV *RHS) { 10842 // If both sides are affine addrecs for the same loop, with equal 10843 // steps, and we know the recurrences don't wrap, then we only 10844 // need to check the predicate on the starting values. 10845 10846 if (!ICmpInst::isRelational(Pred)) 10847 return false; 10848 10849 const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS); 10850 if (!LAR) 10851 return false; 10852 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS); 10853 if (!RAR) 10854 return false; 10855 if (LAR->getLoop() != RAR->getLoop()) 10856 return false; 10857 if (!LAR->isAffine() || !RAR->isAffine()) 10858 return false; 10859 10860 if (LAR->getStepRecurrence(SE) != RAR->getStepRecurrence(SE)) 10861 return false; 10862 10863 SCEV::NoWrapFlags NW = ICmpInst::isSigned(Pred) ? 10864 SCEV::FlagNSW : SCEV::FlagNUW; 10865 if (!LAR->getNoWrapFlags(NW) || !RAR->getNoWrapFlags(NW)) 10866 return false; 10867 10868 return SE.isKnownPredicate(Pred, LAR->getStart(), RAR->getStart()); 10869 } 10870 10871 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max 10872 /// expression? 10873 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE, 10874 ICmpInst::Predicate Pred, 10875 const SCEV *LHS, const SCEV *RHS) { 10876 switch (Pred) { 10877 default: 10878 return false; 10879 10880 case ICmpInst::ICMP_SGE: 10881 std::swap(LHS, RHS); 10882 LLVM_FALLTHROUGH; 10883 case ICmpInst::ICMP_SLE: 10884 return 10885 // min(A, ...) <= A 10886 IsMinMaxConsistingOf<SCEVSMinExpr>(LHS, RHS) || 10887 // A <= max(A, ...) 10888 IsMinMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS); 10889 10890 case ICmpInst::ICMP_UGE: 10891 std::swap(LHS, RHS); 10892 LLVM_FALLTHROUGH; 10893 case ICmpInst::ICMP_ULE: 10894 return 10895 // min(A, ...) <= A 10896 IsMinMaxConsistingOf<SCEVUMinExpr>(LHS, RHS) || 10897 // A <= max(A, ...) 10898 IsMinMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS); 10899 } 10900 10901 llvm_unreachable("covered switch fell through?!"); 10902 } 10903 10904 bool ScalarEvolution::isImpliedViaOperations(ICmpInst::Predicate Pred, 10905 const SCEV *LHS, const SCEV *RHS, 10906 const SCEV *FoundLHS, 10907 const SCEV *FoundRHS, 10908 unsigned Depth) { 10909 assert(getTypeSizeInBits(LHS->getType()) == 10910 getTypeSizeInBits(RHS->getType()) && 10911 "LHS and RHS have different sizes?"); 10912 assert(getTypeSizeInBits(FoundLHS->getType()) == 10913 getTypeSizeInBits(FoundRHS->getType()) && 10914 "FoundLHS and FoundRHS have different sizes?"); 10915 // We want to avoid hurting the compile time with analysis of too big trees. 10916 if (Depth > MaxSCEVOperationsImplicationDepth) 10917 return false; 10918 10919 // We only want to work with GT comparison so far. 10920 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_SLT) { 10921 Pred = CmpInst::getSwappedPredicate(Pred); 10922 std::swap(LHS, RHS); 10923 std::swap(FoundLHS, FoundRHS); 10924 } 10925 10926 // For unsigned, try to reduce it to corresponding signed comparison. 10927 if (Pred == ICmpInst::ICMP_UGT) 10928 // We can replace unsigned predicate with its signed counterpart if all 10929 // involved values are non-negative. 10930 // TODO: We could have better support for unsigned. 10931 if (isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS)) { 10932 // Knowing that both FoundLHS and FoundRHS are non-negative, and knowing 10933 // FoundLHS >u FoundRHS, we also know that FoundLHS >s FoundRHS. Let us 10934 // use this fact to prove that LHS and RHS are non-negative. 10935 const SCEV *MinusOne = getMinusOne(LHS->getType()); 10936 if (isImpliedCondOperands(ICmpInst::ICMP_SGT, LHS, MinusOne, FoundLHS, 10937 FoundRHS) && 10938 isImpliedCondOperands(ICmpInst::ICMP_SGT, RHS, MinusOne, FoundLHS, 10939 FoundRHS)) 10940 Pred = ICmpInst::ICMP_SGT; 10941 } 10942 10943 if (Pred != ICmpInst::ICMP_SGT) 10944 return false; 10945 10946 auto GetOpFromSExt = [&](const SCEV *S) { 10947 if (auto *Ext = dyn_cast<SCEVSignExtendExpr>(S)) 10948 return Ext->getOperand(); 10949 // TODO: If S is a SCEVConstant then you can cheaply "strip" the sext off 10950 // the constant in some cases. 10951 return S; 10952 }; 10953 10954 // Acquire values from extensions. 10955 auto *OrigLHS = LHS; 10956 auto *OrigFoundLHS = FoundLHS; 10957 LHS = GetOpFromSExt(LHS); 10958 FoundLHS = GetOpFromSExt(FoundLHS); 10959 10960 // Is the SGT predicate can be proved trivially or using the found context. 10961 auto IsSGTViaContext = [&](const SCEV *S1, const SCEV *S2) { 10962 return isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGT, S1, S2) || 10963 isImpliedViaOperations(ICmpInst::ICMP_SGT, S1, S2, OrigFoundLHS, 10964 FoundRHS, Depth + 1); 10965 }; 10966 10967 if (auto *LHSAddExpr = dyn_cast<SCEVAddExpr>(LHS)) { 10968 // We want to avoid creation of any new non-constant SCEV. Since we are 10969 // going to compare the operands to RHS, we should be certain that we don't 10970 // need any size extensions for this. So let's decline all cases when the 10971 // sizes of types of LHS and RHS do not match. 10972 // TODO: Maybe try to get RHS from sext to catch more cases? 10973 if (getTypeSizeInBits(LHS->getType()) != getTypeSizeInBits(RHS->getType())) 10974 return false; 10975 10976 // Should not overflow. 10977 if (!LHSAddExpr->hasNoSignedWrap()) 10978 return false; 10979 10980 auto *LL = LHSAddExpr->getOperand(0); 10981 auto *LR = LHSAddExpr->getOperand(1); 10982 auto *MinusOne = getMinusOne(RHS->getType()); 10983 10984 // Checks that S1 >= 0 && S2 > RHS, trivially or using the found context. 10985 auto IsSumGreaterThanRHS = [&](const SCEV *S1, const SCEV *S2) { 10986 return IsSGTViaContext(S1, MinusOne) && IsSGTViaContext(S2, RHS); 10987 }; 10988 // Try to prove the following rule: 10989 // (LHS = LL + LR) && (LL >= 0) && (LR > RHS) => (LHS > RHS). 10990 // (LHS = LL + LR) && (LR >= 0) && (LL > RHS) => (LHS > RHS). 10991 if (IsSumGreaterThanRHS(LL, LR) || IsSumGreaterThanRHS(LR, LL)) 10992 return true; 10993 } else if (auto *LHSUnknownExpr = dyn_cast<SCEVUnknown>(LHS)) { 10994 Value *LL, *LR; 10995 // FIXME: Once we have SDiv implemented, we can get rid of this matching. 10996 10997 using namespace llvm::PatternMatch; 10998 10999 if (match(LHSUnknownExpr->getValue(), m_SDiv(m_Value(LL), m_Value(LR)))) { 11000 // Rules for division. 11001 // We are going to perform some comparisons with Denominator and its 11002 // derivative expressions. In general case, creating a SCEV for it may 11003 // lead to a complex analysis of the entire graph, and in particular it 11004 // can request trip count recalculation for the same loop. This would 11005 // cache as SCEVCouldNotCompute to avoid the infinite recursion. To avoid 11006 // this, we only want to create SCEVs that are constants in this section. 11007 // So we bail if Denominator is not a constant. 11008 if (!isa<ConstantInt>(LR)) 11009 return false; 11010 11011 auto *Denominator = cast<SCEVConstant>(getSCEV(LR)); 11012 11013 // We want to make sure that LHS = FoundLHS / Denominator. If it is so, 11014 // then a SCEV for the numerator already exists and matches with FoundLHS. 11015 auto *Numerator = getExistingSCEV(LL); 11016 if (!Numerator || Numerator->getType() != FoundLHS->getType()) 11017 return false; 11018 11019 // Make sure that the numerator matches with FoundLHS and the denominator 11020 // is positive. 11021 if (!HasSameValue(Numerator, FoundLHS) || !isKnownPositive(Denominator)) 11022 return false; 11023 11024 auto *DTy = Denominator->getType(); 11025 auto *FRHSTy = FoundRHS->getType(); 11026 if (DTy->isPointerTy() != FRHSTy->isPointerTy()) 11027 // One of types is a pointer and another one is not. We cannot extend 11028 // them properly to a wider type, so let us just reject this case. 11029 // TODO: Usage of getEffectiveSCEVType for DTy, FRHSTy etc should help 11030 // to avoid this check. 11031 return false; 11032 11033 // Given that: 11034 // FoundLHS > FoundRHS, LHS = FoundLHS / Denominator, Denominator > 0. 11035 auto *WTy = getWiderType(DTy, FRHSTy); 11036 auto *DenominatorExt = getNoopOrSignExtend(Denominator, WTy); 11037 auto *FoundRHSExt = getNoopOrSignExtend(FoundRHS, WTy); 11038 11039 // Try to prove the following rule: 11040 // (FoundRHS > Denominator - 2) && (RHS <= 0) => (LHS > RHS). 11041 // For example, given that FoundLHS > 2. It means that FoundLHS is at 11042 // least 3. If we divide it by Denominator < 4, we will have at least 1. 11043 auto *DenomMinusTwo = getMinusSCEV(DenominatorExt, getConstant(WTy, 2)); 11044 if (isKnownNonPositive(RHS) && 11045 IsSGTViaContext(FoundRHSExt, DenomMinusTwo)) 11046 return true; 11047 11048 // Try to prove the following rule: 11049 // (FoundRHS > -1 - Denominator) && (RHS < 0) => (LHS > RHS). 11050 // For example, given that FoundLHS > -3. Then FoundLHS is at least -2. 11051 // If we divide it by Denominator > 2, then: 11052 // 1. If FoundLHS is negative, then the result is 0. 11053 // 2. If FoundLHS is non-negative, then the result is non-negative. 11054 // Anyways, the result is non-negative. 11055 auto *MinusOne = getMinusOne(WTy); 11056 auto *NegDenomMinusOne = getMinusSCEV(MinusOne, DenominatorExt); 11057 if (isKnownNegative(RHS) && 11058 IsSGTViaContext(FoundRHSExt, NegDenomMinusOne)) 11059 return true; 11060 } 11061 } 11062 11063 // If our expression contained SCEVUnknown Phis, and we split it down and now 11064 // need to prove something for them, try to prove the predicate for every 11065 // possible incoming values of those Phis. 11066 if (isImpliedViaMerge(Pred, OrigLHS, RHS, OrigFoundLHS, FoundRHS, Depth + 1)) 11067 return true; 11068 11069 return false; 11070 } 11071 11072 static bool isKnownPredicateExtendIdiom(ICmpInst::Predicate Pred, 11073 const SCEV *LHS, const SCEV *RHS) { 11074 // zext x u<= sext x, sext x s<= zext x 11075 switch (Pred) { 11076 case ICmpInst::ICMP_SGE: 11077 std::swap(LHS, RHS); 11078 LLVM_FALLTHROUGH; 11079 case ICmpInst::ICMP_SLE: { 11080 // If operand >=s 0 then ZExt == SExt. If operand <s 0 then SExt <s ZExt. 11081 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(LHS); 11082 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(RHS); 11083 if (SExt && ZExt && SExt->getOperand() == ZExt->getOperand()) 11084 return true; 11085 break; 11086 } 11087 case ICmpInst::ICMP_UGE: 11088 std::swap(LHS, RHS); 11089 LLVM_FALLTHROUGH; 11090 case ICmpInst::ICMP_ULE: { 11091 // If operand >=s 0 then ZExt == SExt. If operand <s 0 then ZExt <u SExt. 11092 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(LHS); 11093 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(RHS); 11094 if (SExt && ZExt && SExt->getOperand() == ZExt->getOperand()) 11095 return true; 11096 break; 11097 } 11098 default: 11099 break; 11100 }; 11101 return false; 11102 } 11103 11104 bool 11105 ScalarEvolution::isKnownViaNonRecursiveReasoning(ICmpInst::Predicate Pred, 11106 const SCEV *LHS, const SCEV *RHS) { 11107 return isKnownPredicateExtendIdiom(Pred, LHS, RHS) || 11108 isKnownPredicateViaConstantRanges(Pred, LHS, RHS) || 11109 IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS) || 11110 IsKnownPredicateViaAddRecStart(*this, Pred, LHS, RHS) || 11111 isKnownPredicateViaNoOverflow(Pred, LHS, RHS); 11112 } 11113 11114 bool 11115 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred, 11116 const SCEV *LHS, const SCEV *RHS, 11117 const SCEV *FoundLHS, 11118 const SCEV *FoundRHS) { 11119 switch (Pred) { 11120 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!"); 11121 case ICmpInst::ICMP_EQ: 11122 case ICmpInst::ICMP_NE: 11123 if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS)) 11124 return true; 11125 break; 11126 case ICmpInst::ICMP_SLT: 11127 case ICmpInst::ICMP_SLE: 11128 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SLE, LHS, FoundLHS) && 11129 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGE, RHS, FoundRHS)) 11130 return true; 11131 break; 11132 case ICmpInst::ICMP_SGT: 11133 case ICmpInst::ICMP_SGE: 11134 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGE, LHS, FoundLHS) && 11135 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SLE, RHS, FoundRHS)) 11136 return true; 11137 break; 11138 case ICmpInst::ICMP_ULT: 11139 case ICmpInst::ICMP_ULE: 11140 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, LHS, FoundLHS) && 11141 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_UGE, RHS, FoundRHS)) 11142 return true; 11143 break; 11144 case ICmpInst::ICMP_UGT: 11145 case ICmpInst::ICMP_UGE: 11146 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_UGE, LHS, FoundLHS) && 11147 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, RHS, FoundRHS)) 11148 return true; 11149 break; 11150 } 11151 11152 // Maybe it can be proved via operations? 11153 if (isImpliedViaOperations(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11154 return true; 11155 11156 return false; 11157 } 11158 11159 bool ScalarEvolution::isImpliedCondOperandsViaRanges(ICmpInst::Predicate Pred, 11160 const SCEV *LHS, 11161 const SCEV *RHS, 11162 const SCEV *FoundLHS, 11163 const SCEV *FoundRHS) { 11164 if (!isa<SCEVConstant>(RHS) || !isa<SCEVConstant>(FoundRHS)) 11165 // The restriction on `FoundRHS` be lifted easily -- it exists only to 11166 // reduce the compile time impact of this optimization. 11167 return false; 11168 11169 Optional<APInt> Addend = computeConstantDifference(LHS, FoundLHS); 11170 if (!Addend) 11171 return false; 11172 11173 const APInt &ConstFoundRHS = cast<SCEVConstant>(FoundRHS)->getAPInt(); 11174 11175 // `FoundLHSRange` is the range we know `FoundLHS` to be in by virtue of the 11176 // antecedent "`FoundLHS` `Pred` `FoundRHS`". 11177 ConstantRange FoundLHSRange = 11178 ConstantRange::makeAllowedICmpRegion(Pred, ConstFoundRHS); 11179 11180 // Since `LHS` is `FoundLHS` + `Addend`, we can compute a range for `LHS`: 11181 ConstantRange LHSRange = FoundLHSRange.add(ConstantRange(*Addend)); 11182 11183 // We can also compute the range of values for `LHS` that satisfy the 11184 // consequent, "`LHS` `Pred` `RHS`": 11185 const APInt &ConstRHS = cast<SCEVConstant>(RHS)->getAPInt(); 11186 // The antecedent implies the consequent if every value of `LHS` that 11187 // satisfies the antecedent also satisfies the consequent. 11188 return LHSRange.icmp(Pred, ConstRHS); 11189 } 11190 11191 bool ScalarEvolution::doesIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride, 11192 bool IsSigned, bool NoWrap) { 11193 assert(isKnownPositive(Stride) && "Positive stride expected!"); 11194 11195 if (NoWrap) return false; 11196 11197 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 11198 const SCEV *One = getOne(Stride->getType()); 11199 11200 if (IsSigned) { 11201 APInt MaxRHS = getSignedRangeMax(RHS); 11202 APInt MaxValue = APInt::getSignedMaxValue(BitWidth); 11203 APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One)); 11204 11205 // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow! 11206 return (std::move(MaxValue) - MaxStrideMinusOne).slt(MaxRHS); 11207 } 11208 11209 APInt MaxRHS = getUnsignedRangeMax(RHS); 11210 APInt MaxValue = APInt::getMaxValue(BitWidth); 11211 APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One)); 11212 11213 // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow! 11214 return (std::move(MaxValue) - MaxStrideMinusOne).ult(MaxRHS); 11215 } 11216 11217 bool ScalarEvolution::doesIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride, 11218 bool IsSigned, bool NoWrap) { 11219 if (NoWrap) return false; 11220 11221 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 11222 const SCEV *One = getOne(Stride->getType()); 11223 11224 if (IsSigned) { 11225 APInt MinRHS = getSignedRangeMin(RHS); 11226 APInt MinValue = APInt::getSignedMinValue(BitWidth); 11227 APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One)); 11228 11229 // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow! 11230 return (std::move(MinValue) + MaxStrideMinusOne).sgt(MinRHS); 11231 } 11232 11233 APInt MinRHS = getUnsignedRangeMin(RHS); 11234 APInt MinValue = APInt::getMinValue(BitWidth); 11235 APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One)); 11236 11237 // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow! 11238 return (std::move(MinValue) + MaxStrideMinusOne).ugt(MinRHS); 11239 } 11240 11241 const SCEV *ScalarEvolution::computeBECount(const SCEV *Delta, const SCEV *Step, 11242 bool Equality) { 11243 const SCEV *One = getOne(Step->getType()); 11244 Delta = Equality ? getAddExpr(Delta, Step) 11245 : getAddExpr(Delta, getMinusSCEV(Step, One)); 11246 return getUDivExpr(Delta, Step); 11247 } 11248 11249 const SCEV *ScalarEvolution::computeMaxBECountForLT(const SCEV *Start, 11250 const SCEV *Stride, 11251 const SCEV *End, 11252 unsigned BitWidth, 11253 bool IsSigned) { 11254 11255 assert(!isKnownNonPositive(Stride) && 11256 "Stride is expected strictly positive!"); 11257 // Calculate the maximum backedge count based on the range of values 11258 // permitted by Start, End, and Stride. 11259 const SCEV *MaxBECount; 11260 APInt MinStart = 11261 IsSigned ? getSignedRangeMin(Start) : getUnsignedRangeMin(Start); 11262 11263 APInt StrideForMaxBECount = 11264 IsSigned ? getSignedRangeMin(Stride) : getUnsignedRangeMin(Stride); 11265 11266 // We already know that the stride is positive, so we paper over conservatism 11267 // in our range computation by forcing StrideForMaxBECount to be at least one. 11268 // In theory this is unnecessary, but we expect MaxBECount to be a 11269 // SCEVConstant, and (udiv <constant> 0) is not constant folded by SCEV (there 11270 // is nothing to constant fold it to). 11271 APInt One(BitWidth, 1, IsSigned); 11272 StrideForMaxBECount = APIntOps::smax(One, StrideForMaxBECount); 11273 11274 APInt MaxValue = IsSigned ? APInt::getSignedMaxValue(BitWidth) 11275 : APInt::getMaxValue(BitWidth); 11276 APInt Limit = MaxValue - (StrideForMaxBECount - 1); 11277 11278 // Although End can be a MAX expression we estimate MaxEnd considering only 11279 // the case End = RHS of the loop termination condition. This is safe because 11280 // in the other case (End - Start) is zero, leading to a zero maximum backedge 11281 // taken count. 11282 APInt MaxEnd = IsSigned ? APIntOps::smin(getSignedRangeMax(End), Limit) 11283 : APIntOps::umin(getUnsignedRangeMax(End), Limit); 11284 11285 MaxBECount = computeBECount(getConstant(MaxEnd - MinStart) /* Delta */, 11286 getConstant(StrideForMaxBECount) /* Step */, 11287 false /* Equality */); 11288 11289 return MaxBECount; 11290 } 11291 11292 ScalarEvolution::ExitLimit 11293 ScalarEvolution::howManyLessThans(const SCEV *LHS, const SCEV *RHS, 11294 const Loop *L, bool IsSigned, 11295 bool ControlsExit, bool AllowPredicates) { 11296 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 11297 11298 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS); 11299 bool PredicatedIV = false; 11300 11301 if (!IV && AllowPredicates) { 11302 // Try to make this an AddRec using runtime tests, in the first X 11303 // iterations of this loop, where X is the SCEV expression found by the 11304 // algorithm below. 11305 IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates); 11306 PredicatedIV = true; 11307 } 11308 11309 // Avoid weird loops 11310 if (!IV || IV->getLoop() != L || !IV->isAffine()) 11311 return getCouldNotCompute(); 11312 11313 bool NoWrap = ControlsExit && 11314 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW); 11315 11316 const SCEV *Stride = IV->getStepRecurrence(*this); 11317 11318 bool PositiveStride = isKnownPositive(Stride); 11319 11320 // Avoid negative or zero stride values. 11321 if (!PositiveStride) { 11322 // We can compute the correct backedge taken count for loops with unknown 11323 // strides if we can prove that the loop is not an infinite loop with side 11324 // effects. Here's the loop structure we are trying to handle - 11325 // 11326 // i = start 11327 // do { 11328 // A[i] = i; 11329 // i += s; 11330 // } while (i < end); 11331 // 11332 // The backedge taken count for such loops is evaluated as - 11333 // (max(end, start + stride) - start - 1) /u stride 11334 // 11335 // The additional preconditions that we need to check to prove correctness 11336 // of the above formula is as follows - 11337 // 11338 // a) IV is either nuw or nsw depending upon signedness (indicated by the 11339 // NoWrap flag). 11340 // b) loop is single exit with no side effects. 11341 // 11342 // 11343 // Precondition a) implies that if the stride is negative, this is a single 11344 // trip loop. The backedge taken count formula reduces to zero in this case. 11345 // 11346 // Precondition b) implies that the unknown stride cannot be zero otherwise 11347 // we have UB. 11348 // 11349 // The positive stride case is the same as isKnownPositive(Stride) returning 11350 // true (original behavior of the function). 11351 // 11352 // We want to make sure that the stride is truly unknown as there are edge 11353 // cases where ScalarEvolution propagates no wrap flags to the 11354 // post-increment/decrement IV even though the increment/decrement operation 11355 // itself is wrapping. The computed backedge taken count may be wrong in 11356 // such cases. This is prevented by checking that the stride is not known to 11357 // be either positive or non-positive. For example, no wrap flags are 11358 // propagated to the post-increment IV of this loop with a trip count of 2 - 11359 // 11360 // unsigned char i; 11361 // for(i=127; i<128; i+=129) 11362 // A[i] = i; 11363 // 11364 if (PredicatedIV || !NoWrap || isKnownNonPositive(Stride) || 11365 !loopHasNoSideEffects(L)) 11366 return getCouldNotCompute(); 11367 } else if (!Stride->isOne() && 11368 doesIVOverflowOnLT(RHS, Stride, IsSigned, NoWrap)) 11369 // Avoid proven overflow cases: this will ensure that the backedge taken 11370 // count will not generate any unsigned overflow. Relaxed no-overflow 11371 // conditions exploit NoWrapFlags, allowing to optimize in presence of 11372 // undefined behaviors like the case of C language. 11373 return getCouldNotCompute(); 11374 11375 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT 11376 : ICmpInst::ICMP_ULT; 11377 const SCEV *Start = IV->getStart(); 11378 const SCEV *End = RHS; 11379 // When the RHS is not invariant, we do not know the end bound of the loop and 11380 // cannot calculate the ExactBECount needed by ExitLimit. However, we can 11381 // calculate the MaxBECount, given the start, stride and max value for the end 11382 // bound of the loop (RHS), and the fact that IV does not overflow (which is 11383 // checked above). 11384 if (!isLoopInvariant(RHS, L)) { 11385 const SCEV *MaxBECount = computeMaxBECountForLT( 11386 Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned); 11387 return ExitLimit(getCouldNotCompute() /* ExactNotTaken */, MaxBECount, 11388 false /*MaxOrZero*/, Predicates); 11389 } 11390 // If the backedge is taken at least once, then it will be taken 11391 // (End-Start)/Stride times (rounded up to a multiple of Stride), where Start 11392 // is the LHS value of the less-than comparison the first time it is evaluated 11393 // and End is the RHS. 11394 const SCEV *BECountIfBackedgeTaken = 11395 computeBECount(getMinusSCEV(End, Start), Stride, false); 11396 // If the loop entry is guarded by the result of the backedge test of the 11397 // first loop iteration, then we know the backedge will be taken at least 11398 // once and so the backedge taken count is as above. If not then we use the 11399 // expression (max(End,Start)-Start)/Stride to describe the backedge count, 11400 // as if the backedge is taken at least once max(End,Start) is End and so the 11401 // result is as above, and if not max(End,Start) is Start so we get a backedge 11402 // count of zero. 11403 const SCEV *BECount; 11404 if (isLoopEntryGuardedByCond(L, Cond, getMinusSCEV(Start, Stride), RHS)) 11405 BECount = BECountIfBackedgeTaken; 11406 else { 11407 // If we know that RHS >= Start in the context of loop, then we know that 11408 // max(RHS, Start) = RHS at this point. 11409 if (isLoopEntryGuardedByCond( 11410 L, IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE, RHS, Start)) 11411 End = RHS; 11412 else 11413 End = IsSigned ? getSMaxExpr(RHS, Start) : getUMaxExpr(RHS, Start); 11414 BECount = computeBECount(getMinusSCEV(End, Start), Stride, false); 11415 } 11416 11417 const SCEV *MaxBECount; 11418 bool MaxOrZero = false; 11419 if (isa<SCEVConstant>(BECount)) 11420 MaxBECount = BECount; 11421 else if (isa<SCEVConstant>(BECountIfBackedgeTaken)) { 11422 // If we know exactly how many times the backedge will be taken if it's 11423 // taken at least once, then the backedge count will either be that or 11424 // zero. 11425 MaxBECount = BECountIfBackedgeTaken; 11426 MaxOrZero = true; 11427 } else { 11428 MaxBECount = computeMaxBECountForLT( 11429 Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned); 11430 } 11431 11432 if (isa<SCEVCouldNotCompute>(MaxBECount) && 11433 !isa<SCEVCouldNotCompute>(BECount)) 11434 MaxBECount = getConstant(getUnsignedRangeMax(BECount)); 11435 11436 return ExitLimit(BECount, MaxBECount, MaxOrZero, Predicates); 11437 } 11438 11439 ScalarEvolution::ExitLimit 11440 ScalarEvolution::howManyGreaterThans(const SCEV *LHS, const SCEV *RHS, 11441 const Loop *L, bool IsSigned, 11442 bool ControlsExit, bool AllowPredicates) { 11443 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 11444 // We handle only IV > Invariant 11445 if (!isLoopInvariant(RHS, L)) 11446 return getCouldNotCompute(); 11447 11448 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS); 11449 if (!IV && AllowPredicates) 11450 // Try to make this an AddRec using runtime tests, in the first X 11451 // iterations of this loop, where X is the SCEV expression found by the 11452 // algorithm below. 11453 IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates); 11454 11455 // Avoid weird loops 11456 if (!IV || IV->getLoop() != L || !IV->isAffine()) 11457 return getCouldNotCompute(); 11458 11459 bool NoWrap = ControlsExit && 11460 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW); 11461 11462 const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this)); 11463 11464 // Avoid negative or zero stride values 11465 if (!isKnownPositive(Stride)) 11466 return getCouldNotCompute(); 11467 11468 // Avoid proven overflow cases: this will ensure that the backedge taken count 11469 // will not generate any unsigned overflow. Relaxed no-overflow conditions 11470 // exploit NoWrapFlags, allowing to optimize in presence of undefined 11471 // behaviors like the case of C language. 11472 if (!Stride->isOne() && doesIVOverflowOnGT(RHS, Stride, IsSigned, NoWrap)) 11473 return getCouldNotCompute(); 11474 11475 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT 11476 : ICmpInst::ICMP_UGT; 11477 11478 const SCEV *Start = IV->getStart(); 11479 const SCEV *End = RHS; 11480 if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS)) { 11481 // If we know that Start >= RHS in the context of loop, then we know that 11482 // min(RHS, Start) = RHS at this point. 11483 if (isLoopEntryGuardedByCond( 11484 L, IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE, Start, RHS)) 11485 End = RHS; 11486 else 11487 End = IsSigned ? getSMinExpr(RHS, Start) : getUMinExpr(RHS, Start); 11488 } 11489 11490 const SCEV *BECount = computeBECount(getMinusSCEV(Start, End), Stride, false); 11491 11492 APInt MaxStart = IsSigned ? getSignedRangeMax(Start) 11493 : getUnsignedRangeMax(Start); 11494 11495 APInt MinStride = IsSigned ? getSignedRangeMin(Stride) 11496 : getUnsignedRangeMin(Stride); 11497 11498 unsigned BitWidth = getTypeSizeInBits(LHS->getType()); 11499 APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1) 11500 : APInt::getMinValue(BitWidth) + (MinStride - 1); 11501 11502 // Although End can be a MIN expression we estimate MinEnd considering only 11503 // the case End = RHS. This is safe because in the other case (Start - End) 11504 // is zero, leading to a zero maximum backedge taken count. 11505 APInt MinEnd = 11506 IsSigned ? APIntOps::smax(getSignedRangeMin(RHS), Limit) 11507 : APIntOps::umax(getUnsignedRangeMin(RHS), Limit); 11508 11509 const SCEV *MaxBECount = isa<SCEVConstant>(BECount) 11510 ? BECount 11511 : computeBECount(getConstant(MaxStart - MinEnd), 11512 getConstant(MinStride), false); 11513 11514 if (isa<SCEVCouldNotCompute>(MaxBECount)) 11515 MaxBECount = BECount; 11516 11517 return ExitLimit(BECount, MaxBECount, false, Predicates); 11518 } 11519 11520 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(const ConstantRange &Range, 11521 ScalarEvolution &SE) const { 11522 if (Range.isFullSet()) // Infinite loop. 11523 return SE.getCouldNotCompute(); 11524 11525 // If the start is a non-zero constant, shift the range to simplify things. 11526 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart())) 11527 if (!SC->getValue()->isZero()) { 11528 SmallVector<const SCEV *, 4> Operands(operands()); 11529 Operands[0] = SE.getZero(SC->getType()); 11530 const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(), 11531 getNoWrapFlags(FlagNW)); 11532 if (const auto *ShiftedAddRec = dyn_cast<SCEVAddRecExpr>(Shifted)) 11533 return ShiftedAddRec->getNumIterationsInRange( 11534 Range.subtract(SC->getAPInt()), SE); 11535 // This is strange and shouldn't happen. 11536 return SE.getCouldNotCompute(); 11537 } 11538 11539 // The only time we can solve this is when we have all constant indices. 11540 // Otherwise, we cannot determine the overflow conditions. 11541 if (any_of(operands(), [](const SCEV *Op) { return !isa<SCEVConstant>(Op); })) 11542 return SE.getCouldNotCompute(); 11543 11544 // Okay at this point we know that all elements of the chrec are constants and 11545 // that the start element is zero. 11546 11547 // First check to see if the range contains zero. If not, the first 11548 // iteration exits. 11549 unsigned BitWidth = SE.getTypeSizeInBits(getType()); 11550 if (!Range.contains(APInt(BitWidth, 0))) 11551 return SE.getZero(getType()); 11552 11553 if (isAffine()) { 11554 // If this is an affine expression then we have this situation: 11555 // Solve {0,+,A} in Range === Ax in Range 11556 11557 // We know that zero is in the range. If A is positive then we know that 11558 // the upper value of the range must be the first possible exit value. 11559 // If A is negative then the lower of the range is the last possible loop 11560 // value. Also note that we already checked for a full range. 11561 APInt A = cast<SCEVConstant>(getOperand(1))->getAPInt(); 11562 APInt End = A.sge(1) ? (Range.getUpper() - 1) : Range.getLower(); 11563 11564 // The exit value should be (End+A)/A. 11565 APInt ExitVal = (End + A).udiv(A); 11566 ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal); 11567 11568 // Evaluate at the exit value. If we really did fall out of the valid 11569 // range, then we computed our trip count, otherwise wrap around or other 11570 // things must have happened. 11571 ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE); 11572 if (Range.contains(Val->getValue())) 11573 return SE.getCouldNotCompute(); // Something strange happened 11574 11575 // Ensure that the previous value is in the range. This is a sanity check. 11576 assert(Range.contains( 11577 EvaluateConstantChrecAtConstant(this, 11578 ConstantInt::get(SE.getContext(), ExitVal - 1), SE)->getValue()) && 11579 "Linear scev computation is off in a bad way!"); 11580 return SE.getConstant(ExitValue); 11581 } 11582 11583 if (isQuadratic()) { 11584 if (auto S = SolveQuadraticAddRecRange(this, Range, SE)) 11585 return SE.getConstant(S.getValue()); 11586 } 11587 11588 return SE.getCouldNotCompute(); 11589 } 11590 11591 const SCEVAddRecExpr * 11592 SCEVAddRecExpr::getPostIncExpr(ScalarEvolution &SE) const { 11593 assert(getNumOperands() > 1 && "AddRec with zero step?"); 11594 // There is a temptation to just call getAddExpr(this, getStepRecurrence(SE)), 11595 // but in this case we cannot guarantee that the value returned will be an 11596 // AddRec because SCEV does not have a fixed point where it stops 11597 // simplification: it is legal to return ({rec1} + {rec2}). For example, it 11598 // may happen if we reach arithmetic depth limit while simplifying. So we 11599 // construct the returned value explicitly. 11600 SmallVector<const SCEV *, 3> Ops; 11601 // If this is {A,+,B,+,C,...,+,N}, then its step is {B,+,C,+,...,+,N}, and 11602 // (this + Step) is {A+B,+,B+C,+...,+,N}. 11603 for (unsigned i = 0, e = getNumOperands() - 1; i < e; ++i) 11604 Ops.push_back(SE.getAddExpr(getOperand(i), getOperand(i + 1))); 11605 // We know that the last operand is not a constant zero (otherwise it would 11606 // have been popped out earlier). This guarantees us that if the result has 11607 // the same last operand, then it will also not be popped out, meaning that 11608 // the returned value will be an AddRec. 11609 const SCEV *Last = getOperand(getNumOperands() - 1); 11610 assert(!Last->isZero() && "Recurrency with zero step?"); 11611 Ops.push_back(Last); 11612 return cast<SCEVAddRecExpr>(SE.getAddRecExpr(Ops, getLoop(), 11613 SCEV::FlagAnyWrap)); 11614 } 11615 11616 // Return true when S contains at least an undef value. 11617 static inline bool containsUndefs(const SCEV *S) { 11618 return SCEVExprContains(S, [](const SCEV *S) { 11619 if (const auto *SU = dyn_cast<SCEVUnknown>(S)) 11620 return isa<UndefValue>(SU->getValue()); 11621 return false; 11622 }); 11623 } 11624 11625 namespace { 11626 11627 // Collect all steps of SCEV expressions. 11628 struct SCEVCollectStrides { 11629 ScalarEvolution &SE; 11630 SmallVectorImpl<const SCEV *> &Strides; 11631 11632 SCEVCollectStrides(ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &S) 11633 : SE(SE), Strides(S) {} 11634 11635 bool follow(const SCEV *S) { 11636 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) 11637 Strides.push_back(AR->getStepRecurrence(SE)); 11638 return true; 11639 } 11640 11641 bool isDone() const { return false; } 11642 }; 11643 11644 // Collect all SCEVUnknown and SCEVMulExpr expressions. 11645 struct SCEVCollectTerms { 11646 SmallVectorImpl<const SCEV *> &Terms; 11647 11648 SCEVCollectTerms(SmallVectorImpl<const SCEV *> &T) : Terms(T) {} 11649 11650 bool follow(const SCEV *S) { 11651 if (isa<SCEVUnknown>(S) || isa<SCEVMulExpr>(S) || 11652 isa<SCEVSignExtendExpr>(S)) { 11653 if (!containsUndefs(S)) 11654 Terms.push_back(S); 11655 11656 // Stop recursion: once we collected a term, do not walk its operands. 11657 return false; 11658 } 11659 11660 // Keep looking. 11661 return true; 11662 } 11663 11664 bool isDone() const { return false; } 11665 }; 11666 11667 // Check if a SCEV contains an AddRecExpr. 11668 struct SCEVHasAddRec { 11669 bool &ContainsAddRec; 11670 11671 SCEVHasAddRec(bool &ContainsAddRec) : ContainsAddRec(ContainsAddRec) { 11672 ContainsAddRec = false; 11673 } 11674 11675 bool follow(const SCEV *S) { 11676 if (isa<SCEVAddRecExpr>(S)) { 11677 ContainsAddRec = true; 11678 11679 // Stop recursion: once we collected a term, do not walk its operands. 11680 return false; 11681 } 11682 11683 // Keep looking. 11684 return true; 11685 } 11686 11687 bool isDone() const { return false; } 11688 }; 11689 11690 // Find factors that are multiplied with an expression that (possibly as a 11691 // subexpression) contains an AddRecExpr. In the expression: 11692 // 11693 // 8 * (100 + %p * %q * (%a + {0, +, 1}_loop)) 11694 // 11695 // "%p * %q" are factors multiplied by the expression "(%a + {0, +, 1}_loop)" 11696 // that contains the AddRec {0, +, 1}_loop. %p * %q are likely to be array size 11697 // parameters as they form a product with an induction variable. 11698 // 11699 // This collector expects all array size parameters to be in the same MulExpr. 11700 // It might be necessary to later add support for collecting parameters that are 11701 // spread over different nested MulExpr. 11702 struct SCEVCollectAddRecMultiplies { 11703 SmallVectorImpl<const SCEV *> &Terms; 11704 ScalarEvolution &SE; 11705 11706 SCEVCollectAddRecMultiplies(SmallVectorImpl<const SCEV *> &T, ScalarEvolution &SE) 11707 : Terms(T), SE(SE) {} 11708 11709 bool follow(const SCEV *S) { 11710 if (auto *Mul = dyn_cast<SCEVMulExpr>(S)) { 11711 bool HasAddRec = false; 11712 SmallVector<const SCEV *, 0> Operands; 11713 for (auto Op : Mul->operands()) { 11714 const SCEVUnknown *Unknown = dyn_cast<SCEVUnknown>(Op); 11715 if (Unknown && !isa<CallInst>(Unknown->getValue())) { 11716 Operands.push_back(Op); 11717 } else if (Unknown) { 11718 HasAddRec = true; 11719 } else { 11720 bool ContainsAddRec = false; 11721 SCEVHasAddRec ContiansAddRec(ContainsAddRec); 11722 visitAll(Op, ContiansAddRec); 11723 HasAddRec |= ContainsAddRec; 11724 } 11725 } 11726 if (Operands.size() == 0) 11727 return true; 11728 11729 if (!HasAddRec) 11730 return false; 11731 11732 Terms.push_back(SE.getMulExpr(Operands)); 11733 // Stop recursion: once we collected a term, do not walk its operands. 11734 return false; 11735 } 11736 11737 // Keep looking. 11738 return true; 11739 } 11740 11741 bool isDone() const { return false; } 11742 }; 11743 11744 } // end anonymous namespace 11745 11746 /// Find parametric terms in this SCEVAddRecExpr. We first for parameters in 11747 /// two places: 11748 /// 1) The strides of AddRec expressions. 11749 /// 2) Unknowns that are multiplied with AddRec expressions. 11750 void ScalarEvolution::collectParametricTerms(const SCEV *Expr, 11751 SmallVectorImpl<const SCEV *> &Terms) { 11752 SmallVector<const SCEV *, 4> Strides; 11753 SCEVCollectStrides StrideCollector(*this, Strides); 11754 visitAll(Expr, StrideCollector); 11755 11756 LLVM_DEBUG({ 11757 dbgs() << "Strides:\n"; 11758 for (const SCEV *S : Strides) 11759 dbgs() << *S << "\n"; 11760 }); 11761 11762 for (const SCEV *S : Strides) { 11763 SCEVCollectTerms TermCollector(Terms); 11764 visitAll(S, TermCollector); 11765 } 11766 11767 LLVM_DEBUG({ 11768 dbgs() << "Terms:\n"; 11769 for (const SCEV *T : Terms) 11770 dbgs() << *T << "\n"; 11771 }); 11772 11773 SCEVCollectAddRecMultiplies MulCollector(Terms, *this); 11774 visitAll(Expr, MulCollector); 11775 } 11776 11777 static bool findArrayDimensionsRec(ScalarEvolution &SE, 11778 SmallVectorImpl<const SCEV *> &Terms, 11779 SmallVectorImpl<const SCEV *> &Sizes) { 11780 int Last = Terms.size() - 1; 11781 const SCEV *Step = Terms[Last]; 11782 11783 // End of recursion. 11784 if (Last == 0) { 11785 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Step)) { 11786 SmallVector<const SCEV *, 2> Qs; 11787 for (const SCEV *Op : M->operands()) 11788 if (!isa<SCEVConstant>(Op)) 11789 Qs.push_back(Op); 11790 11791 Step = SE.getMulExpr(Qs); 11792 } 11793 11794 Sizes.push_back(Step); 11795 return true; 11796 } 11797 11798 for (const SCEV *&Term : Terms) { 11799 // Normalize the terms before the next call to findArrayDimensionsRec. 11800 const SCEV *Q, *R; 11801 SCEVDivision::divide(SE, Term, Step, &Q, &R); 11802 11803 // Bail out when GCD does not evenly divide one of the terms. 11804 if (!R->isZero()) 11805 return false; 11806 11807 Term = Q; 11808 } 11809 11810 // Remove all SCEVConstants. 11811 erase_if(Terms, [](const SCEV *E) { return isa<SCEVConstant>(E); }); 11812 11813 if (Terms.size() > 0) 11814 if (!findArrayDimensionsRec(SE, Terms, Sizes)) 11815 return false; 11816 11817 Sizes.push_back(Step); 11818 return true; 11819 } 11820 11821 // Returns true when one of the SCEVs of Terms contains a SCEVUnknown parameter. 11822 static inline bool containsParameters(SmallVectorImpl<const SCEV *> &Terms) { 11823 for (const SCEV *T : Terms) 11824 if (SCEVExprContains(T, [](const SCEV *S) { return isa<SCEVUnknown>(S); })) 11825 return true; 11826 11827 return false; 11828 } 11829 11830 // Return the number of product terms in S. 11831 static inline int numberOfTerms(const SCEV *S) { 11832 if (const SCEVMulExpr *Expr = dyn_cast<SCEVMulExpr>(S)) 11833 return Expr->getNumOperands(); 11834 return 1; 11835 } 11836 11837 static const SCEV *removeConstantFactors(ScalarEvolution &SE, const SCEV *T) { 11838 if (isa<SCEVConstant>(T)) 11839 return nullptr; 11840 11841 if (isa<SCEVUnknown>(T)) 11842 return T; 11843 11844 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(T)) { 11845 SmallVector<const SCEV *, 2> Factors; 11846 for (const SCEV *Op : M->operands()) 11847 if (!isa<SCEVConstant>(Op)) 11848 Factors.push_back(Op); 11849 11850 return SE.getMulExpr(Factors); 11851 } 11852 11853 return T; 11854 } 11855 11856 /// Return the size of an element read or written by Inst. 11857 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) { 11858 Type *Ty; 11859 if (StoreInst *Store = dyn_cast<StoreInst>(Inst)) 11860 Ty = Store->getValueOperand()->getType(); 11861 else if (LoadInst *Load = dyn_cast<LoadInst>(Inst)) 11862 Ty = Load->getType(); 11863 else 11864 return nullptr; 11865 11866 Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty)); 11867 return getSizeOfExpr(ETy, Ty); 11868 } 11869 11870 void ScalarEvolution::findArrayDimensions(SmallVectorImpl<const SCEV *> &Terms, 11871 SmallVectorImpl<const SCEV *> &Sizes, 11872 const SCEV *ElementSize) { 11873 if (Terms.size() < 1 || !ElementSize) 11874 return; 11875 11876 // Early return when Terms do not contain parameters: we do not delinearize 11877 // non parametric SCEVs. 11878 if (!containsParameters(Terms)) 11879 return; 11880 11881 LLVM_DEBUG({ 11882 dbgs() << "Terms:\n"; 11883 for (const SCEV *T : Terms) 11884 dbgs() << *T << "\n"; 11885 }); 11886 11887 // Remove duplicates. 11888 array_pod_sort(Terms.begin(), Terms.end()); 11889 Terms.erase(std::unique(Terms.begin(), Terms.end()), Terms.end()); 11890 11891 // Put larger terms first. 11892 llvm::sort(Terms, [](const SCEV *LHS, const SCEV *RHS) { 11893 return numberOfTerms(LHS) > numberOfTerms(RHS); 11894 }); 11895 11896 // Try to divide all terms by the element size. If term is not divisible by 11897 // element size, proceed with the original term. 11898 for (const SCEV *&Term : Terms) { 11899 const SCEV *Q, *R; 11900 SCEVDivision::divide(*this, Term, ElementSize, &Q, &R); 11901 if (!Q->isZero()) 11902 Term = Q; 11903 } 11904 11905 SmallVector<const SCEV *, 4> NewTerms; 11906 11907 // Remove constant factors. 11908 for (const SCEV *T : Terms) 11909 if (const SCEV *NewT = removeConstantFactors(*this, T)) 11910 NewTerms.push_back(NewT); 11911 11912 LLVM_DEBUG({ 11913 dbgs() << "Terms after sorting:\n"; 11914 for (const SCEV *T : NewTerms) 11915 dbgs() << *T << "\n"; 11916 }); 11917 11918 if (NewTerms.empty() || !findArrayDimensionsRec(*this, NewTerms, Sizes)) { 11919 Sizes.clear(); 11920 return; 11921 } 11922 11923 // The last element to be pushed into Sizes is the size of an element. 11924 Sizes.push_back(ElementSize); 11925 11926 LLVM_DEBUG({ 11927 dbgs() << "Sizes:\n"; 11928 for (const SCEV *S : Sizes) 11929 dbgs() << *S << "\n"; 11930 }); 11931 } 11932 11933 void ScalarEvolution::computeAccessFunctions( 11934 const SCEV *Expr, SmallVectorImpl<const SCEV *> &Subscripts, 11935 SmallVectorImpl<const SCEV *> &Sizes) { 11936 // Early exit in case this SCEV is not an affine multivariate function. 11937 if (Sizes.empty()) 11938 return; 11939 11940 if (auto *AR = dyn_cast<SCEVAddRecExpr>(Expr)) 11941 if (!AR->isAffine()) 11942 return; 11943 11944 const SCEV *Res = Expr; 11945 int Last = Sizes.size() - 1; 11946 for (int i = Last; i >= 0; i--) { 11947 const SCEV *Q, *R; 11948 SCEVDivision::divide(*this, Res, Sizes[i], &Q, &R); 11949 11950 LLVM_DEBUG({ 11951 dbgs() << "Res: " << *Res << "\n"; 11952 dbgs() << "Sizes[i]: " << *Sizes[i] << "\n"; 11953 dbgs() << "Res divided by Sizes[i]:\n"; 11954 dbgs() << "Quotient: " << *Q << "\n"; 11955 dbgs() << "Remainder: " << *R << "\n"; 11956 }); 11957 11958 Res = Q; 11959 11960 // Do not record the last subscript corresponding to the size of elements in 11961 // the array. 11962 if (i == Last) { 11963 11964 // Bail out if the remainder is too complex. 11965 if (isa<SCEVAddRecExpr>(R)) { 11966 Subscripts.clear(); 11967 Sizes.clear(); 11968 return; 11969 } 11970 11971 continue; 11972 } 11973 11974 // Record the access function for the current subscript. 11975 Subscripts.push_back(R); 11976 } 11977 11978 // Also push in last position the remainder of the last division: it will be 11979 // the access function of the innermost dimension. 11980 Subscripts.push_back(Res); 11981 11982 std::reverse(Subscripts.begin(), Subscripts.end()); 11983 11984 LLVM_DEBUG({ 11985 dbgs() << "Subscripts:\n"; 11986 for (const SCEV *S : Subscripts) 11987 dbgs() << *S << "\n"; 11988 }); 11989 } 11990 11991 /// Splits the SCEV into two vectors of SCEVs representing the subscripts and 11992 /// sizes of an array access. Returns the remainder of the delinearization that 11993 /// is the offset start of the array. The SCEV->delinearize algorithm computes 11994 /// the multiples of SCEV coefficients: that is a pattern matching of sub 11995 /// expressions in the stride and base of a SCEV corresponding to the 11996 /// computation of a GCD (greatest common divisor) of base and stride. When 11997 /// SCEV->delinearize fails, it returns the SCEV unchanged. 11998 /// 11999 /// For example: when analyzing the memory access A[i][j][k] in this loop nest 12000 /// 12001 /// void foo(long n, long m, long o, double A[n][m][o]) { 12002 /// 12003 /// for (long i = 0; i < n; i++) 12004 /// for (long j = 0; j < m; j++) 12005 /// for (long k = 0; k < o; k++) 12006 /// A[i][j][k] = 1.0; 12007 /// } 12008 /// 12009 /// the delinearization input is the following AddRec SCEV: 12010 /// 12011 /// AddRec: {{{%A,+,(8 * %m * %o)}<%for.i>,+,(8 * %o)}<%for.j>,+,8}<%for.k> 12012 /// 12013 /// From this SCEV, we are able to say that the base offset of the access is %A 12014 /// because it appears as an offset that does not divide any of the strides in 12015 /// the loops: 12016 /// 12017 /// CHECK: Base offset: %A 12018 /// 12019 /// and then SCEV->delinearize determines the size of some of the dimensions of 12020 /// the array as these are the multiples by which the strides are happening: 12021 /// 12022 /// CHECK: ArrayDecl[UnknownSize][%m][%o] with elements of sizeof(double) bytes. 12023 /// 12024 /// Note that the outermost dimension remains of UnknownSize because there are 12025 /// no strides that would help identifying the size of the last dimension: when 12026 /// the array has been statically allocated, one could compute the size of that 12027 /// dimension by dividing the overall size of the array by the size of the known 12028 /// dimensions: %m * %o * 8. 12029 /// 12030 /// Finally delinearize provides the access functions for the array reference 12031 /// that does correspond to A[i][j][k] of the above C testcase: 12032 /// 12033 /// CHECK: ArrayRef[{0,+,1}<%for.i>][{0,+,1}<%for.j>][{0,+,1}<%for.k>] 12034 /// 12035 /// The testcases are checking the output of a function pass: 12036 /// DelinearizationPass that walks through all loads and stores of a function 12037 /// asking for the SCEV of the memory access with respect to all enclosing 12038 /// loops, calling SCEV->delinearize on that and printing the results. 12039 void ScalarEvolution::delinearize(const SCEV *Expr, 12040 SmallVectorImpl<const SCEV *> &Subscripts, 12041 SmallVectorImpl<const SCEV *> &Sizes, 12042 const SCEV *ElementSize) { 12043 // First step: collect parametric terms. 12044 SmallVector<const SCEV *, 4> Terms; 12045 collectParametricTerms(Expr, Terms); 12046 12047 if (Terms.empty()) 12048 return; 12049 12050 // Second step: find subscript sizes. 12051 findArrayDimensions(Terms, Sizes, ElementSize); 12052 12053 if (Sizes.empty()) 12054 return; 12055 12056 // Third step: compute the access functions for each subscript. 12057 computeAccessFunctions(Expr, Subscripts, Sizes); 12058 12059 if (Subscripts.empty()) 12060 return; 12061 12062 LLVM_DEBUG({ 12063 dbgs() << "succeeded to delinearize " << *Expr << "\n"; 12064 dbgs() << "ArrayDecl[UnknownSize]"; 12065 for (const SCEV *S : Sizes) 12066 dbgs() << "[" << *S << "]"; 12067 12068 dbgs() << "\nArrayRef"; 12069 for (const SCEV *S : Subscripts) 12070 dbgs() << "[" << *S << "]"; 12071 dbgs() << "\n"; 12072 }); 12073 } 12074 12075 bool ScalarEvolution::getIndexExpressionsFromGEP( 12076 const GetElementPtrInst *GEP, SmallVectorImpl<const SCEV *> &Subscripts, 12077 SmallVectorImpl<int> &Sizes) { 12078 assert(Subscripts.empty() && Sizes.empty() && 12079 "Expected output lists to be empty on entry to this function."); 12080 assert(GEP && "getIndexExpressionsFromGEP called with a null GEP"); 12081 Type *Ty = GEP->getPointerOperandType(); 12082 bool DroppedFirstDim = false; 12083 for (unsigned i = 1; i < GEP->getNumOperands(); i++) { 12084 const SCEV *Expr = getSCEV(GEP->getOperand(i)); 12085 if (i == 1) { 12086 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) { 12087 Ty = PtrTy->getElementType(); 12088 } else if (auto *ArrayTy = dyn_cast<ArrayType>(Ty)) { 12089 Ty = ArrayTy->getElementType(); 12090 } else { 12091 Subscripts.clear(); 12092 Sizes.clear(); 12093 return false; 12094 } 12095 if (auto *Const = dyn_cast<SCEVConstant>(Expr)) 12096 if (Const->getValue()->isZero()) { 12097 DroppedFirstDim = true; 12098 continue; 12099 } 12100 Subscripts.push_back(Expr); 12101 continue; 12102 } 12103 12104 auto *ArrayTy = dyn_cast<ArrayType>(Ty); 12105 if (!ArrayTy) { 12106 Subscripts.clear(); 12107 Sizes.clear(); 12108 return false; 12109 } 12110 12111 Subscripts.push_back(Expr); 12112 if (!(DroppedFirstDim && i == 2)) 12113 Sizes.push_back(ArrayTy->getNumElements()); 12114 12115 Ty = ArrayTy->getElementType(); 12116 } 12117 return !Subscripts.empty(); 12118 } 12119 12120 //===----------------------------------------------------------------------===// 12121 // SCEVCallbackVH Class Implementation 12122 //===----------------------------------------------------------------------===// 12123 12124 void ScalarEvolution::SCEVCallbackVH::deleted() { 12125 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!"); 12126 if (PHINode *PN = dyn_cast<PHINode>(getValPtr())) 12127 SE->ConstantEvolutionLoopExitValue.erase(PN); 12128 SE->eraseValueFromMap(getValPtr()); 12129 // this now dangles! 12130 } 12131 12132 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) { 12133 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!"); 12134 12135 // Forget all the expressions associated with users of the old value, 12136 // so that future queries will recompute the expressions using the new 12137 // value. 12138 Value *Old = getValPtr(); 12139 SmallVector<User *, 16> Worklist(Old->users()); 12140 SmallPtrSet<User *, 8> Visited; 12141 while (!Worklist.empty()) { 12142 User *U = Worklist.pop_back_val(); 12143 // Deleting the Old value will cause this to dangle. Postpone 12144 // that until everything else is done. 12145 if (U == Old) 12146 continue; 12147 if (!Visited.insert(U).second) 12148 continue; 12149 if (PHINode *PN = dyn_cast<PHINode>(U)) 12150 SE->ConstantEvolutionLoopExitValue.erase(PN); 12151 SE->eraseValueFromMap(U); 12152 llvm::append_range(Worklist, U->users()); 12153 } 12154 // Delete the Old value. 12155 if (PHINode *PN = dyn_cast<PHINode>(Old)) 12156 SE->ConstantEvolutionLoopExitValue.erase(PN); 12157 SE->eraseValueFromMap(Old); 12158 // this now dangles! 12159 } 12160 12161 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se) 12162 : CallbackVH(V), SE(se) {} 12163 12164 //===----------------------------------------------------------------------===// 12165 // ScalarEvolution Class Implementation 12166 //===----------------------------------------------------------------------===// 12167 12168 ScalarEvolution::ScalarEvolution(Function &F, TargetLibraryInfo &TLI, 12169 AssumptionCache &AC, DominatorTree &DT, 12170 LoopInfo &LI) 12171 : F(F), TLI(TLI), AC(AC), DT(DT), LI(LI), 12172 CouldNotCompute(new SCEVCouldNotCompute()), ValuesAtScopes(64), 12173 LoopDispositions(64), BlockDispositions(64) { 12174 // To use guards for proving predicates, we need to scan every instruction in 12175 // relevant basic blocks, and not just terminators. Doing this is a waste of 12176 // time if the IR does not actually contain any calls to 12177 // @llvm.experimental.guard, so do a quick check and remember this beforehand. 12178 // 12179 // This pessimizes the case where a pass that preserves ScalarEvolution wants 12180 // to _add_ guards to the module when there weren't any before, and wants 12181 // ScalarEvolution to optimize based on those guards. For now we prefer to be 12182 // efficient in lieu of being smart in that rather obscure case. 12183 12184 auto *GuardDecl = F.getParent()->getFunction( 12185 Intrinsic::getName(Intrinsic::experimental_guard)); 12186 HasGuards = GuardDecl && !GuardDecl->use_empty(); 12187 } 12188 12189 ScalarEvolution::ScalarEvolution(ScalarEvolution &&Arg) 12190 : F(Arg.F), HasGuards(Arg.HasGuards), TLI(Arg.TLI), AC(Arg.AC), DT(Arg.DT), 12191 LI(Arg.LI), CouldNotCompute(std::move(Arg.CouldNotCompute)), 12192 ValueExprMap(std::move(Arg.ValueExprMap)), 12193 PendingLoopPredicates(std::move(Arg.PendingLoopPredicates)), 12194 PendingPhiRanges(std::move(Arg.PendingPhiRanges)), 12195 PendingMerges(std::move(Arg.PendingMerges)), 12196 MinTrailingZerosCache(std::move(Arg.MinTrailingZerosCache)), 12197 BackedgeTakenCounts(std::move(Arg.BackedgeTakenCounts)), 12198 PredicatedBackedgeTakenCounts( 12199 std::move(Arg.PredicatedBackedgeTakenCounts)), 12200 ConstantEvolutionLoopExitValue( 12201 std::move(Arg.ConstantEvolutionLoopExitValue)), 12202 ValuesAtScopes(std::move(Arg.ValuesAtScopes)), 12203 LoopDispositions(std::move(Arg.LoopDispositions)), 12204 LoopPropertiesCache(std::move(Arg.LoopPropertiesCache)), 12205 BlockDispositions(std::move(Arg.BlockDispositions)), 12206 UnsignedRanges(std::move(Arg.UnsignedRanges)), 12207 SignedRanges(std::move(Arg.SignedRanges)), 12208 UniqueSCEVs(std::move(Arg.UniqueSCEVs)), 12209 UniquePreds(std::move(Arg.UniquePreds)), 12210 SCEVAllocator(std::move(Arg.SCEVAllocator)), 12211 LoopUsers(std::move(Arg.LoopUsers)), 12212 PredicatedSCEVRewrites(std::move(Arg.PredicatedSCEVRewrites)), 12213 FirstUnknown(Arg.FirstUnknown) { 12214 Arg.FirstUnknown = nullptr; 12215 } 12216 12217 ScalarEvolution::~ScalarEvolution() { 12218 // Iterate through all the SCEVUnknown instances and call their 12219 // destructors, so that they release their references to their values. 12220 for (SCEVUnknown *U = FirstUnknown; U;) { 12221 SCEVUnknown *Tmp = U; 12222 U = U->Next; 12223 Tmp->~SCEVUnknown(); 12224 } 12225 FirstUnknown = nullptr; 12226 12227 ExprValueMap.clear(); 12228 ValueExprMap.clear(); 12229 HasRecMap.clear(); 12230 12231 // Free any extra memory created for ExitNotTakenInfo in the unlikely event 12232 // that a loop had multiple computable exits. 12233 for (auto &BTCI : BackedgeTakenCounts) 12234 BTCI.second.clear(); 12235 for (auto &BTCI : PredicatedBackedgeTakenCounts) 12236 BTCI.second.clear(); 12237 12238 assert(PendingLoopPredicates.empty() && "isImpliedCond garbage"); 12239 assert(PendingPhiRanges.empty() && "getRangeRef garbage"); 12240 assert(PendingMerges.empty() && "isImpliedViaMerge garbage"); 12241 assert(!WalkingBEDominatingConds && "isLoopBackedgeGuardedByCond garbage!"); 12242 assert(!ProvingSplitPredicate && "ProvingSplitPredicate garbage!"); 12243 } 12244 12245 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) { 12246 return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L)); 12247 } 12248 12249 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE, 12250 const Loop *L) { 12251 // Print all inner loops first 12252 for (Loop *I : *L) 12253 PrintLoopInfo(OS, SE, I); 12254 12255 OS << "Loop "; 12256 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12257 OS << ": "; 12258 12259 SmallVector<BasicBlock *, 8> ExitingBlocks; 12260 L->getExitingBlocks(ExitingBlocks); 12261 if (ExitingBlocks.size() != 1) 12262 OS << "<multiple exits> "; 12263 12264 if (SE->hasLoopInvariantBackedgeTakenCount(L)) 12265 OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L) << "\n"; 12266 else 12267 OS << "Unpredictable backedge-taken count.\n"; 12268 12269 if (ExitingBlocks.size() > 1) 12270 for (BasicBlock *ExitingBlock : ExitingBlocks) { 12271 OS << " exit count for " << ExitingBlock->getName() << ": " 12272 << *SE->getExitCount(L, ExitingBlock) << "\n"; 12273 } 12274 12275 OS << "Loop "; 12276 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12277 OS << ": "; 12278 12279 if (!isa<SCEVCouldNotCompute>(SE->getConstantMaxBackedgeTakenCount(L))) { 12280 OS << "max backedge-taken count is " << *SE->getConstantMaxBackedgeTakenCount(L); 12281 if (SE->isBackedgeTakenCountMaxOrZero(L)) 12282 OS << ", actual taken count either this or zero."; 12283 } else { 12284 OS << "Unpredictable max backedge-taken count. "; 12285 } 12286 12287 OS << "\n" 12288 "Loop "; 12289 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12290 OS << ": "; 12291 12292 SCEVUnionPredicate Pred; 12293 auto PBT = SE->getPredicatedBackedgeTakenCount(L, Pred); 12294 if (!isa<SCEVCouldNotCompute>(PBT)) { 12295 OS << "Predicated backedge-taken count is " << *PBT << "\n"; 12296 OS << " Predicates:\n"; 12297 Pred.print(OS, 4); 12298 } else { 12299 OS << "Unpredictable predicated backedge-taken count. "; 12300 } 12301 OS << "\n"; 12302 12303 if (SE->hasLoopInvariantBackedgeTakenCount(L)) { 12304 OS << "Loop "; 12305 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12306 OS << ": "; 12307 OS << "Trip multiple is " << SE->getSmallConstantTripMultiple(L) << "\n"; 12308 } 12309 } 12310 12311 static StringRef loopDispositionToStr(ScalarEvolution::LoopDisposition LD) { 12312 switch (LD) { 12313 case ScalarEvolution::LoopVariant: 12314 return "Variant"; 12315 case ScalarEvolution::LoopInvariant: 12316 return "Invariant"; 12317 case ScalarEvolution::LoopComputable: 12318 return "Computable"; 12319 } 12320 llvm_unreachable("Unknown ScalarEvolution::LoopDisposition kind!"); 12321 } 12322 12323 void ScalarEvolution::print(raw_ostream &OS) const { 12324 // ScalarEvolution's implementation of the print method is to print 12325 // out SCEV values of all instructions that are interesting. Doing 12326 // this potentially causes it to create new SCEV objects though, 12327 // which technically conflicts with the const qualifier. This isn't 12328 // observable from outside the class though, so casting away the 12329 // const isn't dangerous. 12330 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this); 12331 12332 if (ClassifyExpressions) { 12333 OS << "Classifying expressions for: "; 12334 F.printAsOperand(OS, /*PrintType=*/false); 12335 OS << "\n"; 12336 for (Instruction &I : instructions(F)) 12337 if (isSCEVable(I.getType()) && !isa<CmpInst>(I)) { 12338 OS << I << '\n'; 12339 OS << " --> "; 12340 const SCEV *SV = SE.getSCEV(&I); 12341 SV->print(OS); 12342 if (!isa<SCEVCouldNotCompute>(SV)) { 12343 OS << " U: "; 12344 SE.getUnsignedRange(SV).print(OS); 12345 OS << " S: "; 12346 SE.getSignedRange(SV).print(OS); 12347 } 12348 12349 const Loop *L = LI.getLoopFor(I.getParent()); 12350 12351 const SCEV *AtUse = SE.getSCEVAtScope(SV, L); 12352 if (AtUse != SV) { 12353 OS << " --> "; 12354 AtUse->print(OS); 12355 if (!isa<SCEVCouldNotCompute>(AtUse)) { 12356 OS << " U: "; 12357 SE.getUnsignedRange(AtUse).print(OS); 12358 OS << " S: "; 12359 SE.getSignedRange(AtUse).print(OS); 12360 } 12361 } 12362 12363 if (L) { 12364 OS << "\t\t" "Exits: "; 12365 const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop()); 12366 if (!SE.isLoopInvariant(ExitValue, L)) { 12367 OS << "<<Unknown>>"; 12368 } else { 12369 OS << *ExitValue; 12370 } 12371 12372 bool First = true; 12373 for (auto *Iter = L; Iter; Iter = Iter->getParentLoop()) { 12374 if (First) { 12375 OS << "\t\t" "LoopDispositions: { "; 12376 First = false; 12377 } else { 12378 OS << ", "; 12379 } 12380 12381 Iter->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12382 OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, Iter)); 12383 } 12384 12385 for (auto *InnerL : depth_first(L)) { 12386 if (InnerL == L) 12387 continue; 12388 if (First) { 12389 OS << "\t\t" "LoopDispositions: { "; 12390 First = false; 12391 } else { 12392 OS << ", "; 12393 } 12394 12395 InnerL->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12396 OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, InnerL)); 12397 } 12398 12399 OS << " }"; 12400 } 12401 12402 OS << "\n"; 12403 } 12404 } 12405 12406 OS << "Determining loop execution counts for: "; 12407 F.printAsOperand(OS, /*PrintType=*/false); 12408 OS << "\n"; 12409 for (Loop *I : LI) 12410 PrintLoopInfo(OS, &SE, I); 12411 } 12412 12413 ScalarEvolution::LoopDisposition 12414 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) { 12415 auto &Values = LoopDispositions[S]; 12416 for (auto &V : Values) { 12417 if (V.getPointer() == L) 12418 return V.getInt(); 12419 } 12420 Values.emplace_back(L, LoopVariant); 12421 LoopDisposition D = computeLoopDisposition(S, L); 12422 auto &Values2 = LoopDispositions[S]; 12423 for (auto &V : make_range(Values2.rbegin(), Values2.rend())) { 12424 if (V.getPointer() == L) { 12425 V.setInt(D); 12426 break; 12427 } 12428 } 12429 return D; 12430 } 12431 12432 ScalarEvolution::LoopDisposition 12433 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) { 12434 switch (S->getSCEVType()) { 12435 case scConstant: 12436 return LoopInvariant; 12437 case scPtrToInt: 12438 case scTruncate: 12439 case scZeroExtend: 12440 case scSignExtend: 12441 return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L); 12442 case scAddRecExpr: { 12443 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S); 12444 12445 // If L is the addrec's loop, it's computable. 12446 if (AR->getLoop() == L) 12447 return LoopComputable; 12448 12449 // Add recurrences are never invariant in the function-body (null loop). 12450 if (!L) 12451 return LoopVariant; 12452 12453 // Everything that is not defined at loop entry is variant. 12454 if (DT.dominates(L->getHeader(), AR->getLoop()->getHeader())) 12455 return LoopVariant; 12456 assert(!L->contains(AR->getLoop()) && "Containing loop's header does not" 12457 " dominate the contained loop's header?"); 12458 12459 // This recurrence is invariant w.r.t. L if AR's loop contains L. 12460 if (AR->getLoop()->contains(L)) 12461 return LoopInvariant; 12462 12463 // This recurrence is variant w.r.t. L if any of its operands 12464 // are variant. 12465 for (auto *Op : AR->operands()) 12466 if (!isLoopInvariant(Op, L)) 12467 return LoopVariant; 12468 12469 // Otherwise it's loop-invariant. 12470 return LoopInvariant; 12471 } 12472 case scAddExpr: 12473 case scMulExpr: 12474 case scUMaxExpr: 12475 case scSMaxExpr: 12476 case scUMinExpr: 12477 case scSMinExpr: { 12478 bool HasVarying = false; 12479 for (auto *Op : cast<SCEVNAryExpr>(S)->operands()) { 12480 LoopDisposition D = getLoopDisposition(Op, L); 12481 if (D == LoopVariant) 12482 return LoopVariant; 12483 if (D == LoopComputable) 12484 HasVarying = true; 12485 } 12486 return HasVarying ? LoopComputable : LoopInvariant; 12487 } 12488 case scUDivExpr: { 12489 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S); 12490 LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L); 12491 if (LD == LoopVariant) 12492 return LoopVariant; 12493 LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L); 12494 if (RD == LoopVariant) 12495 return LoopVariant; 12496 return (LD == LoopInvariant && RD == LoopInvariant) ? 12497 LoopInvariant : LoopComputable; 12498 } 12499 case scUnknown: 12500 // All non-instruction values are loop invariant. All instructions are loop 12501 // invariant if they are not contained in the specified loop. 12502 // Instructions are never considered invariant in the function body 12503 // (null loop) because they are defined within the "loop". 12504 if (auto *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) 12505 return (L && !L->contains(I)) ? LoopInvariant : LoopVariant; 12506 return LoopInvariant; 12507 case scCouldNotCompute: 12508 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 12509 } 12510 llvm_unreachable("Unknown SCEV kind!"); 12511 } 12512 12513 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) { 12514 return getLoopDisposition(S, L) == LoopInvariant; 12515 } 12516 12517 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) { 12518 return getLoopDisposition(S, L) == LoopComputable; 12519 } 12520 12521 ScalarEvolution::BlockDisposition 12522 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) { 12523 auto &Values = BlockDispositions[S]; 12524 for (auto &V : Values) { 12525 if (V.getPointer() == BB) 12526 return V.getInt(); 12527 } 12528 Values.emplace_back(BB, DoesNotDominateBlock); 12529 BlockDisposition D = computeBlockDisposition(S, BB); 12530 auto &Values2 = BlockDispositions[S]; 12531 for (auto &V : make_range(Values2.rbegin(), Values2.rend())) { 12532 if (V.getPointer() == BB) { 12533 V.setInt(D); 12534 break; 12535 } 12536 } 12537 return D; 12538 } 12539 12540 ScalarEvolution::BlockDisposition 12541 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) { 12542 switch (S->getSCEVType()) { 12543 case scConstant: 12544 return ProperlyDominatesBlock; 12545 case scPtrToInt: 12546 case scTruncate: 12547 case scZeroExtend: 12548 case scSignExtend: 12549 return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB); 12550 case scAddRecExpr: { 12551 // This uses a "dominates" query instead of "properly dominates" query 12552 // to test for proper dominance too, because the instruction which 12553 // produces the addrec's value is a PHI, and a PHI effectively properly 12554 // dominates its entire containing block. 12555 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S); 12556 if (!DT.dominates(AR->getLoop()->getHeader(), BB)) 12557 return DoesNotDominateBlock; 12558 12559 // Fall through into SCEVNAryExpr handling. 12560 LLVM_FALLTHROUGH; 12561 } 12562 case scAddExpr: 12563 case scMulExpr: 12564 case scUMaxExpr: 12565 case scSMaxExpr: 12566 case scUMinExpr: 12567 case scSMinExpr: { 12568 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S); 12569 bool Proper = true; 12570 for (const SCEV *NAryOp : NAry->operands()) { 12571 BlockDisposition D = getBlockDisposition(NAryOp, BB); 12572 if (D == DoesNotDominateBlock) 12573 return DoesNotDominateBlock; 12574 if (D == DominatesBlock) 12575 Proper = false; 12576 } 12577 return Proper ? ProperlyDominatesBlock : DominatesBlock; 12578 } 12579 case scUDivExpr: { 12580 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S); 12581 const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS(); 12582 BlockDisposition LD = getBlockDisposition(LHS, BB); 12583 if (LD == DoesNotDominateBlock) 12584 return DoesNotDominateBlock; 12585 BlockDisposition RD = getBlockDisposition(RHS, BB); 12586 if (RD == DoesNotDominateBlock) 12587 return DoesNotDominateBlock; 12588 return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ? 12589 ProperlyDominatesBlock : DominatesBlock; 12590 } 12591 case scUnknown: 12592 if (Instruction *I = 12593 dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) { 12594 if (I->getParent() == BB) 12595 return DominatesBlock; 12596 if (DT.properlyDominates(I->getParent(), BB)) 12597 return ProperlyDominatesBlock; 12598 return DoesNotDominateBlock; 12599 } 12600 return ProperlyDominatesBlock; 12601 case scCouldNotCompute: 12602 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 12603 } 12604 llvm_unreachable("Unknown SCEV kind!"); 12605 } 12606 12607 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) { 12608 return getBlockDisposition(S, BB) >= DominatesBlock; 12609 } 12610 12611 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) { 12612 return getBlockDisposition(S, BB) == ProperlyDominatesBlock; 12613 } 12614 12615 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const { 12616 return SCEVExprContains(S, [&](const SCEV *Expr) { return Expr == Op; }); 12617 } 12618 12619 bool ScalarEvolution::ExitLimit::hasOperand(const SCEV *S) const { 12620 auto IsS = [&](const SCEV *X) { return S == X; }; 12621 auto ContainsS = [&](const SCEV *X) { 12622 return !isa<SCEVCouldNotCompute>(X) && SCEVExprContains(X, IsS); 12623 }; 12624 return ContainsS(ExactNotTaken) || ContainsS(MaxNotTaken); 12625 } 12626 12627 void 12628 ScalarEvolution::forgetMemoizedResults(const SCEV *S) { 12629 ValuesAtScopes.erase(S); 12630 LoopDispositions.erase(S); 12631 BlockDispositions.erase(S); 12632 UnsignedRanges.erase(S); 12633 SignedRanges.erase(S); 12634 ExprValueMap.erase(S); 12635 HasRecMap.erase(S); 12636 MinTrailingZerosCache.erase(S); 12637 12638 for (auto I = PredicatedSCEVRewrites.begin(); 12639 I != PredicatedSCEVRewrites.end();) { 12640 std::pair<const SCEV *, const Loop *> Entry = I->first; 12641 if (Entry.first == S) 12642 PredicatedSCEVRewrites.erase(I++); 12643 else 12644 ++I; 12645 } 12646 12647 auto RemoveSCEVFromBackedgeMap = 12648 [S, this](DenseMap<const Loop *, BackedgeTakenInfo> &Map) { 12649 for (auto I = Map.begin(), E = Map.end(); I != E;) { 12650 BackedgeTakenInfo &BEInfo = I->second; 12651 if (BEInfo.hasOperand(S, this)) { 12652 BEInfo.clear(); 12653 Map.erase(I++); 12654 } else 12655 ++I; 12656 } 12657 }; 12658 12659 RemoveSCEVFromBackedgeMap(BackedgeTakenCounts); 12660 RemoveSCEVFromBackedgeMap(PredicatedBackedgeTakenCounts); 12661 } 12662 12663 void 12664 ScalarEvolution::getUsedLoops(const SCEV *S, 12665 SmallPtrSetImpl<const Loop *> &LoopsUsed) { 12666 struct FindUsedLoops { 12667 FindUsedLoops(SmallPtrSetImpl<const Loop *> &LoopsUsed) 12668 : LoopsUsed(LoopsUsed) {} 12669 SmallPtrSetImpl<const Loop *> &LoopsUsed; 12670 bool follow(const SCEV *S) { 12671 if (auto *AR = dyn_cast<SCEVAddRecExpr>(S)) 12672 LoopsUsed.insert(AR->getLoop()); 12673 return true; 12674 } 12675 12676 bool isDone() const { return false; } 12677 }; 12678 12679 FindUsedLoops F(LoopsUsed); 12680 SCEVTraversal<FindUsedLoops>(F).visitAll(S); 12681 } 12682 12683 void ScalarEvolution::addToLoopUseLists(const SCEV *S) { 12684 SmallPtrSet<const Loop *, 8> LoopsUsed; 12685 getUsedLoops(S, LoopsUsed); 12686 for (auto *L : LoopsUsed) 12687 LoopUsers[L].push_back(S); 12688 } 12689 12690 void ScalarEvolution::verify() const { 12691 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this); 12692 ScalarEvolution SE2(F, TLI, AC, DT, LI); 12693 12694 SmallVector<Loop *, 8> LoopStack(LI.begin(), LI.end()); 12695 12696 // Map's SCEV expressions from one ScalarEvolution "universe" to another. 12697 struct SCEVMapper : public SCEVRewriteVisitor<SCEVMapper> { 12698 SCEVMapper(ScalarEvolution &SE) : SCEVRewriteVisitor<SCEVMapper>(SE) {} 12699 12700 const SCEV *visitConstant(const SCEVConstant *Constant) { 12701 return SE.getConstant(Constant->getAPInt()); 12702 } 12703 12704 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 12705 return SE.getUnknown(Expr->getValue()); 12706 } 12707 12708 const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) { 12709 return SE.getCouldNotCompute(); 12710 } 12711 }; 12712 12713 SCEVMapper SCM(SE2); 12714 12715 while (!LoopStack.empty()) { 12716 auto *L = LoopStack.pop_back_val(); 12717 llvm::append_range(LoopStack, *L); 12718 12719 auto *CurBECount = SCM.visit( 12720 const_cast<ScalarEvolution *>(this)->getBackedgeTakenCount(L)); 12721 auto *NewBECount = SE2.getBackedgeTakenCount(L); 12722 12723 if (CurBECount == SE2.getCouldNotCompute() || 12724 NewBECount == SE2.getCouldNotCompute()) { 12725 // NB! This situation is legal, but is very suspicious -- whatever pass 12726 // change the loop to make a trip count go from could not compute to 12727 // computable or vice-versa *should have* invalidated SCEV. However, we 12728 // choose not to assert here (for now) since we don't want false 12729 // positives. 12730 continue; 12731 } 12732 12733 if (containsUndefs(CurBECount) || containsUndefs(NewBECount)) { 12734 // SCEV treats "undef" as an unknown but consistent value (i.e. it does 12735 // not propagate undef aggressively). This means we can (and do) fail 12736 // verification in cases where a transform makes the trip count of a loop 12737 // go from "undef" to "undef+1" (say). The transform is fine, since in 12738 // both cases the loop iterates "undef" times, but SCEV thinks we 12739 // increased the trip count of the loop by 1 incorrectly. 12740 continue; 12741 } 12742 12743 if (SE.getTypeSizeInBits(CurBECount->getType()) > 12744 SE.getTypeSizeInBits(NewBECount->getType())) 12745 NewBECount = SE2.getZeroExtendExpr(NewBECount, CurBECount->getType()); 12746 else if (SE.getTypeSizeInBits(CurBECount->getType()) < 12747 SE.getTypeSizeInBits(NewBECount->getType())) 12748 CurBECount = SE2.getZeroExtendExpr(CurBECount, NewBECount->getType()); 12749 12750 const SCEV *Delta = SE2.getMinusSCEV(CurBECount, NewBECount); 12751 12752 // Unless VerifySCEVStrict is set, we only compare constant deltas. 12753 if ((VerifySCEVStrict || isa<SCEVConstant>(Delta)) && !Delta->isZero()) { 12754 dbgs() << "Trip Count for " << *L << " Changed!\n"; 12755 dbgs() << "Old: " << *CurBECount << "\n"; 12756 dbgs() << "New: " << *NewBECount << "\n"; 12757 dbgs() << "Delta: " << *Delta << "\n"; 12758 std::abort(); 12759 } 12760 } 12761 12762 // Collect all valid loops currently in LoopInfo. 12763 SmallPtrSet<Loop *, 32> ValidLoops; 12764 SmallVector<Loop *, 32> Worklist(LI.begin(), LI.end()); 12765 while (!Worklist.empty()) { 12766 Loop *L = Worklist.pop_back_val(); 12767 if (ValidLoops.contains(L)) 12768 continue; 12769 ValidLoops.insert(L); 12770 Worklist.append(L->begin(), L->end()); 12771 } 12772 // Check for SCEV expressions referencing invalid/deleted loops. 12773 for (auto &KV : ValueExprMap) { 12774 auto *AR = dyn_cast<SCEVAddRecExpr>(KV.second); 12775 if (!AR) 12776 continue; 12777 assert(ValidLoops.contains(AR->getLoop()) && 12778 "AddRec references invalid loop"); 12779 } 12780 } 12781 12782 bool ScalarEvolution::invalidate( 12783 Function &F, const PreservedAnalyses &PA, 12784 FunctionAnalysisManager::Invalidator &Inv) { 12785 // Invalidate the ScalarEvolution object whenever it isn't preserved or one 12786 // of its dependencies is invalidated. 12787 auto PAC = PA.getChecker<ScalarEvolutionAnalysis>(); 12788 return !(PAC.preserved() || PAC.preservedSet<AllAnalysesOn<Function>>()) || 12789 Inv.invalidate<AssumptionAnalysis>(F, PA) || 12790 Inv.invalidate<DominatorTreeAnalysis>(F, PA) || 12791 Inv.invalidate<LoopAnalysis>(F, PA); 12792 } 12793 12794 AnalysisKey ScalarEvolutionAnalysis::Key; 12795 12796 ScalarEvolution ScalarEvolutionAnalysis::run(Function &F, 12797 FunctionAnalysisManager &AM) { 12798 return ScalarEvolution(F, AM.getResult<TargetLibraryAnalysis>(F), 12799 AM.getResult<AssumptionAnalysis>(F), 12800 AM.getResult<DominatorTreeAnalysis>(F), 12801 AM.getResult<LoopAnalysis>(F)); 12802 } 12803 12804 PreservedAnalyses 12805 ScalarEvolutionVerifierPass::run(Function &F, FunctionAnalysisManager &AM) { 12806 AM.getResult<ScalarEvolutionAnalysis>(F).verify(); 12807 return PreservedAnalyses::all(); 12808 } 12809 12810 PreservedAnalyses 12811 ScalarEvolutionPrinterPass::run(Function &F, FunctionAnalysisManager &AM) { 12812 // For compatibility with opt's -analyze feature under legacy pass manager 12813 // which was not ported to NPM. This keeps tests using 12814 // update_analyze_test_checks.py working. 12815 OS << "Printing analysis 'Scalar Evolution Analysis' for function '" 12816 << F.getName() << "':\n"; 12817 AM.getResult<ScalarEvolutionAnalysis>(F).print(OS); 12818 return PreservedAnalyses::all(); 12819 } 12820 12821 INITIALIZE_PASS_BEGIN(ScalarEvolutionWrapperPass, "scalar-evolution", 12822 "Scalar Evolution Analysis", false, true) 12823 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 12824 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass) 12825 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 12826 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass) 12827 INITIALIZE_PASS_END(ScalarEvolutionWrapperPass, "scalar-evolution", 12828 "Scalar Evolution Analysis", false, true) 12829 12830 char ScalarEvolutionWrapperPass::ID = 0; 12831 12832 ScalarEvolutionWrapperPass::ScalarEvolutionWrapperPass() : FunctionPass(ID) { 12833 initializeScalarEvolutionWrapperPassPass(*PassRegistry::getPassRegistry()); 12834 } 12835 12836 bool ScalarEvolutionWrapperPass::runOnFunction(Function &F) { 12837 SE.reset(new ScalarEvolution( 12838 F, getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(F), 12839 getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F), 12840 getAnalysis<DominatorTreeWrapperPass>().getDomTree(), 12841 getAnalysis<LoopInfoWrapperPass>().getLoopInfo())); 12842 return false; 12843 } 12844 12845 void ScalarEvolutionWrapperPass::releaseMemory() { SE.reset(); } 12846 12847 void ScalarEvolutionWrapperPass::print(raw_ostream &OS, const Module *) const { 12848 SE->print(OS); 12849 } 12850 12851 void ScalarEvolutionWrapperPass::verifyAnalysis() const { 12852 if (!VerifySCEV) 12853 return; 12854 12855 SE->verify(); 12856 } 12857 12858 void ScalarEvolutionWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const { 12859 AU.setPreservesAll(); 12860 AU.addRequiredTransitive<AssumptionCacheTracker>(); 12861 AU.addRequiredTransitive<LoopInfoWrapperPass>(); 12862 AU.addRequiredTransitive<DominatorTreeWrapperPass>(); 12863 AU.addRequiredTransitive<TargetLibraryInfoWrapperPass>(); 12864 } 12865 12866 const SCEVPredicate *ScalarEvolution::getEqualPredicate(const SCEV *LHS, 12867 const SCEV *RHS) { 12868 FoldingSetNodeID ID; 12869 assert(LHS->getType() == RHS->getType() && 12870 "Type mismatch between LHS and RHS"); 12871 // Unique this node based on the arguments 12872 ID.AddInteger(SCEVPredicate::P_Equal); 12873 ID.AddPointer(LHS); 12874 ID.AddPointer(RHS); 12875 void *IP = nullptr; 12876 if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP)) 12877 return S; 12878 SCEVEqualPredicate *Eq = new (SCEVAllocator) 12879 SCEVEqualPredicate(ID.Intern(SCEVAllocator), LHS, RHS); 12880 UniquePreds.InsertNode(Eq, IP); 12881 return Eq; 12882 } 12883 12884 const SCEVPredicate *ScalarEvolution::getWrapPredicate( 12885 const SCEVAddRecExpr *AR, 12886 SCEVWrapPredicate::IncrementWrapFlags AddedFlags) { 12887 FoldingSetNodeID ID; 12888 // Unique this node based on the arguments 12889 ID.AddInteger(SCEVPredicate::P_Wrap); 12890 ID.AddPointer(AR); 12891 ID.AddInteger(AddedFlags); 12892 void *IP = nullptr; 12893 if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP)) 12894 return S; 12895 auto *OF = new (SCEVAllocator) 12896 SCEVWrapPredicate(ID.Intern(SCEVAllocator), AR, AddedFlags); 12897 UniquePreds.InsertNode(OF, IP); 12898 return OF; 12899 } 12900 12901 namespace { 12902 12903 class SCEVPredicateRewriter : public SCEVRewriteVisitor<SCEVPredicateRewriter> { 12904 public: 12905 12906 /// Rewrites \p S in the context of a loop L and the SCEV predication 12907 /// infrastructure. 12908 /// 12909 /// If \p Pred is non-null, the SCEV expression is rewritten to respect the 12910 /// equivalences present in \p Pred. 12911 /// 12912 /// If \p NewPreds is non-null, rewrite is free to add further predicates to 12913 /// \p NewPreds such that the result will be an AddRecExpr. 12914 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE, 12915 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds, 12916 SCEVUnionPredicate *Pred) { 12917 SCEVPredicateRewriter Rewriter(L, SE, NewPreds, Pred); 12918 return Rewriter.visit(S); 12919 } 12920 12921 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 12922 if (Pred) { 12923 auto ExprPreds = Pred->getPredicatesForExpr(Expr); 12924 for (auto *Pred : ExprPreds) 12925 if (const auto *IPred = dyn_cast<SCEVEqualPredicate>(Pred)) 12926 if (IPred->getLHS() == Expr) 12927 return IPred->getRHS(); 12928 } 12929 return convertToAddRecWithPreds(Expr); 12930 } 12931 12932 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) { 12933 const SCEV *Operand = visit(Expr->getOperand()); 12934 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand); 12935 if (AR && AR->getLoop() == L && AR->isAffine()) { 12936 // This couldn't be folded because the operand didn't have the nuw 12937 // flag. Add the nusw flag as an assumption that we could make. 12938 const SCEV *Step = AR->getStepRecurrence(SE); 12939 Type *Ty = Expr->getType(); 12940 if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNUSW)) 12941 return SE.getAddRecExpr(SE.getZeroExtendExpr(AR->getStart(), Ty), 12942 SE.getSignExtendExpr(Step, Ty), L, 12943 AR->getNoWrapFlags()); 12944 } 12945 return SE.getZeroExtendExpr(Operand, Expr->getType()); 12946 } 12947 12948 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) { 12949 const SCEV *Operand = visit(Expr->getOperand()); 12950 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand); 12951 if (AR && AR->getLoop() == L && AR->isAffine()) { 12952 // This couldn't be folded because the operand didn't have the nsw 12953 // flag. Add the nssw flag as an assumption that we could make. 12954 const SCEV *Step = AR->getStepRecurrence(SE); 12955 Type *Ty = Expr->getType(); 12956 if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNSSW)) 12957 return SE.getAddRecExpr(SE.getSignExtendExpr(AR->getStart(), Ty), 12958 SE.getSignExtendExpr(Step, Ty), L, 12959 AR->getNoWrapFlags()); 12960 } 12961 return SE.getSignExtendExpr(Operand, Expr->getType()); 12962 } 12963 12964 private: 12965 explicit SCEVPredicateRewriter(const Loop *L, ScalarEvolution &SE, 12966 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds, 12967 SCEVUnionPredicate *Pred) 12968 : SCEVRewriteVisitor(SE), NewPreds(NewPreds), Pred(Pred), L(L) {} 12969 12970 bool addOverflowAssumption(const SCEVPredicate *P) { 12971 if (!NewPreds) { 12972 // Check if we've already made this assumption. 12973 return Pred && Pred->implies(P); 12974 } 12975 NewPreds->insert(P); 12976 return true; 12977 } 12978 12979 bool addOverflowAssumption(const SCEVAddRecExpr *AR, 12980 SCEVWrapPredicate::IncrementWrapFlags AddedFlags) { 12981 auto *A = SE.getWrapPredicate(AR, AddedFlags); 12982 return addOverflowAssumption(A); 12983 } 12984 12985 // If \p Expr represents a PHINode, we try to see if it can be represented 12986 // as an AddRec, possibly under a predicate (PHISCEVPred). If it is possible 12987 // to add this predicate as a runtime overflow check, we return the AddRec. 12988 // If \p Expr does not meet these conditions (is not a PHI node, or we 12989 // couldn't create an AddRec for it, or couldn't add the predicate), we just 12990 // return \p Expr. 12991 const SCEV *convertToAddRecWithPreds(const SCEVUnknown *Expr) { 12992 if (!isa<PHINode>(Expr->getValue())) 12993 return Expr; 12994 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 12995 PredicatedRewrite = SE.createAddRecFromPHIWithCasts(Expr); 12996 if (!PredicatedRewrite) 12997 return Expr; 12998 for (auto *P : PredicatedRewrite->second){ 12999 // Wrap predicates from outer loops are not supported. 13000 if (auto *WP = dyn_cast<const SCEVWrapPredicate>(P)) { 13001 auto *AR = cast<const SCEVAddRecExpr>(WP->getExpr()); 13002 if (L != AR->getLoop()) 13003 return Expr; 13004 } 13005 if (!addOverflowAssumption(P)) 13006 return Expr; 13007 } 13008 return PredicatedRewrite->first; 13009 } 13010 13011 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds; 13012 SCEVUnionPredicate *Pred; 13013 const Loop *L; 13014 }; 13015 13016 } // end anonymous namespace 13017 13018 const SCEV *ScalarEvolution::rewriteUsingPredicate(const SCEV *S, const Loop *L, 13019 SCEVUnionPredicate &Preds) { 13020 return SCEVPredicateRewriter::rewrite(S, L, *this, nullptr, &Preds); 13021 } 13022 13023 const SCEVAddRecExpr *ScalarEvolution::convertSCEVToAddRecWithPredicates( 13024 const SCEV *S, const Loop *L, 13025 SmallPtrSetImpl<const SCEVPredicate *> &Preds) { 13026 SmallPtrSet<const SCEVPredicate *, 4> TransformPreds; 13027 S = SCEVPredicateRewriter::rewrite(S, L, *this, &TransformPreds, nullptr); 13028 auto *AddRec = dyn_cast<SCEVAddRecExpr>(S); 13029 13030 if (!AddRec) 13031 return nullptr; 13032 13033 // Since the transformation was successful, we can now transfer the SCEV 13034 // predicates. 13035 for (auto *P : TransformPreds) 13036 Preds.insert(P); 13037 13038 return AddRec; 13039 } 13040 13041 /// SCEV predicates 13042 SCEVPredicate::SCEVPredicate(const FoldingSetNodeIDRef ID, 13043 SCEVPredicateKind Kind) 13044 : FastID(ID), Kind(Kind) {} 13045 13046 SCEVEqualPredicate::SCEVEqualPredicate(const FoldingSetNodeIDRef ID, 13047 const SCEV *LHS, const SCEV *RHS) 13048 : SCEVPredicate(ID, P_Equal), LHS(LHS), RHS(RHS) { 13049 assert(LHS->getType() == RHS->getType() && "LHS and RHS types don't match"); 13050 assert(LHS != RHS && "LHS and RHS are the same SCEV"); 13051 } 13052 13053 bool SCEVEqualPredicate::implies(const SCEVPredicate *N) const { 13054 const auto *Op = dyn_cast<SCEVEqualPredicate>(N); 13055 13056 if (!Op) 13057 return false; 13058 13059 return Op->LHS == LHS && Op->RHS == RHS; 13060 } 13061 13062 bool SCEVEqualPredicate::isAlwaysTrue() const { return false; } 13063 13064 const SCEV *SCEVEqualPredicate::getExpr() const { return LHS; } 13065 13066 void SCEVEqualPredicate::print(raw_ostream &OS, unsigned Depth) const { 13067 OS.indent(Depth) << "Equal predicate: " << *LHS << " == " << *RHS << "\n"; 13068 } 13069 13070 SCEVWrapPredicate::SCEVWrapPredicate(const FoldingSetNodeIDRef ID, 13071 const SCEVAddRecExpr *AR, 13072 IncrementWrapFlags Flags) 13073 : SCEVPredicate(ID, P_Wrap), AR(AR), Flags(Flags) {} 13074 13075 const SCEV *SCEVWrapPredicate::getExpr() const { return AR; } 13076 13077 bool SCEVWrapPredicate::implies(const SCEVPredicate *N) const { 13078 const auto *Op = dyn_cast<SCEVWrapPredicate>(N); 13079 13080 return Op && Op->AR == AR && setFlags(Flags, Op->Flags) == Flags; 13081 } 13082 13083 bool SCEVWrapPredicate::isAlwaysTrue() const { 13084 SCEV::NoWrapFlags ScevFlags = AR->getNoWrapFlags(); 13085 IncrementWrapFlags IFlags = Flags; 13086 13087 if (ScalarEvolution::setFlags(ScevFlags, SCEV::FlagNSW) == ScevFlags) 13088 IFlags = clearFlags(IFlags, IncrementNSSW); 13089 13090 return IFlags == IncrementAnyWrap; 13091 } 13092 13093 void SCEVWrapPredicate::print(raw_ostream &OS, unsigned Depth) const { 13094 OS.indent(Depth) << *getExpr() << " Added Flags: "; 13095 if (SCEVWrapPredicate::IncrementNUSW & getFlags()) 13096 OS << "<nusw>"; 13097 if (SCEVWrapPredicate::IncrementNSSW & getFlags()) 13098 OS << "<nssw>"; 13099 OS << "\n"; 13100 } 13101 13102 SCEVWrapPredicate::IncrementWrapFlags 13103 SCEVWrapPredicate::getImpliedFlags(const SCEVAddRecExpr *AR, 13104 ScalarEvolution &SE) { 13105 IncrementWrapFlags ImpliedFlags = IncrementAnyWrap; 13106 SCEV::NoWrapFlags StaticFlags = AR->getNoWrapFlags(); 13107 13108 // We can safely transfer the NSW flag as NSSW. 13109 if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNSW) == StaticFlags) 13110 ImpliedFlags = IncrementNSSW; 13111 13112 if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNUW) == StaticFlags) { 13113 // If the increment is positive, the SCEV NUW flag will also imply the 13114 // WrapPredicate NUSW flag. 13115 if (const auto *Step = dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE))) 13116 if (Step->getValue()->getValue().isNonNegative()) 13117 ImpliedFlags = setFlags(ImpliedFlags, IncrementNUSW); 13118 } 13119 13120 return ImpliedFlags; 13121 } 13122 13123 /// Union predicates don't get cached so create a dummy set ID for it. 13124 SCEVUnionPredicate::SCEVUnionPredicate() 13125 : SCEVPredicate(FoldingSetNodeIDRef(nullptr, 0), P_Union) {} 13126 13127 bool SCEVUnionPredicate::isAlwaysTrue() const { 13128 return all_of(Preds, 13129 [](const SCEVPredicate *I) { return I->isAlwaysTrue(); }); 13130 } 13131 13132 ArrayRef<const SCEVPredicate *> 13133 SCEVUnionPredicate::getPredicatesForExpr(const SCEV *Expr) { 13134 auto I = SCEVToPreds.find(Expr); 13135 if (I == SCEVToPreds.end()) 13136 return ArrayRef<const SCEVPredicate *>(); 13137 return I->second; 13138 } 13139 13140 bool SCEVUnionPredicate::implies(const SCEVPredicate *N) const { 13141 if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N)) 13142 return all_of(Set->Preds, 13143 [this](const SCEVPredicate *I) { return this->implies(I); }); 13144 13145 auto ScevPredsIt = SCEVToPreds.find(N->getExpr()); 13146 if (ScevPredsIt == SCEVToPreds.end()) 13147 return false; 13148 auto &SCEVPreds = ScevPredsIt->second; 13149 13150 return any_of(SCEVPreds, 13151 [N](const SCEVPredicate *I) { return I->implies(N); }); 13152 } 13153 13154 const SCEV *SCEVUnionPredicate::getExpr() const { return nullptr; } 13155 13156 void SCEVUnionPredicate::print(raw_ostream &OS, unsigned Depth) const { 13157 for (auto Pred : Preds) 13158 Pred->print(OS, Depth); 13159 } 13160 13161 void SCEVUnionPredicate::add(const SCEVPredicate *N) { 13162 if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N)) { 13163 for (auto Pred : Set->Preds) 13164 add(Pred); 13165 return; 13166 } 13167 13168 if (implies(N)) 13169 return; 13170 13171 const SCEV *Key = N->getExpr(); 13172 assert(Key && "Only SCEVUnionPredicate doesn't have an " 13173 " associated expression!"); 13174 13175 SCEVToPreds[Key].push_back(N); 13176 Preds.push_back(N); 13177 } 13178 13179 PredicatedScalarEvolution::PredicatedScalarEvolution(ScalarEvolution &SE, 13180 Loop &L) 13181 : SE(SE), L(L) {} 13182 13183 const SCEV *PredicatedScalarEvolution::getSCEV(Value *V) { 13184 const SCEV *Expr = SE.getSCEV(V); 13185 RewriteEntry &Entry = RewriteMap[Expr]; 13186 13187 // If we already have an entry and the version matches, return it. 13188 if (Entry.second && Generation == Entry.first) 13189 return Entry.second; 13190 13191 // We found an entry but it's stale. Rewrite the stale entry 13192 // according to the current predicate. 13193 if (Entry.second) 13194 Expr = Entry.second; 13195 13196 const SCEV *NewSCEV = SE.rewriteUsingPredicate(Expr, &L, Preds); 13197 Entry = {Generation, NewSCEV}; 13198 13199 return NewSCEV; 13200 } 13201 13202 const SCEV *PredicatedScalarEvolution::getBackedgeTakenCount() { 13203 if (!BackedgeCount) { 13204 SCEVUnionPredicate BackedgePred; 13205 BackedgeCount = SE.getPredicatedBackedgeTakenCount(&L, BackedgePred); 13206 addPredicate(BackedgePred); 13207 } 13208 return BackedgeCount; 13209 } 13210 13211 void PredicatedScalarEvolution::addPredicate(const SCEVPredicate &Pred) { 13212 if (Preds.implies(&Pred)) 13213 return; 13214 Preds.add(&Pred); 13215 updateGeneration(); 13216 } 13217 13218 const SCEVUnionPredicate &PredicatedScalarEvolution::getUnionPredicate() const { 13219 return Preds; 13220 } 13221 13222 void PredicatedScalarEvolution::updateGeneration() { 13223 // If the generation number wrapped recompute everything. 13224 if (++Generation == 0) { 13225 for (auto &II : RewriteMap) { 13226 const SCEV *Rewritten = II.second.second; 13227 II.second = {Generation, SE.rewriteUsingPredicate(Rewritten, &L, Preds)}; 13228 } 13229 } 13230 } 13231 13232 void PredicatedScalarEvolution::setNoOverflow( 13233 Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) { 13234 const SCEV *Expr = getSCEV(V); 13235 const auto *AR = cast<SCEVAddRecExpr>(Expr); 13236 13237 auto ImpliedFlags = SCEVWrapPredicate::getImpliedFlags(AR, SE); 13238 13239 // Clear the statically implied flags. 13240 Flags = SCEVWrapPredicate::clearFlags(Flags, ImpliedFlags); 13241 addPredicate(*SE.getWrapPredicate(AR, Flags)); 13242 13243 auto II = FlagsMap.insert({V, Flags}); 13244 if (!II.second) 13245 II.first->second = SCEVWrapPredicate::setFlags(Flags, II.first->second); 13246 } 13247 13248 bool PredicatedScalarEvolution::hasNoOverflow( 13249 Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) { 13250 const SCEV *Expr = getSCEV(V); 13251 const auto *AR = cast<SCEVAddRecExpr>(Expr); 13252 13253 Flags = SCEVWrapPredicate::clearFlags( 13254 Flags, SCEVWrapPredicate::getImpliedFlags(AR, SE)); 13255 13256 auto II = FlagsMap.find(V); 13257 13258 if (II != FlagsMap.end()) 13259 Flags = SCEVWrapPredicate::clearFlags(Flags, II->second); 13260 13261 return Flags == SCEVWrapPredicate::IncrementAnyWrap; 13262 } 13263 13264 const SCEVAddRecExpr *PredicatedScalarEvolution::getAsAddRec(Value *V) { 13265 const SCEV *Expr = this->getSCEV(V); 13266 SmallPtrSet<const SCEVPredicate *, 4> NewPreds; 13267 auto *New = SE.convertSCEVToAddRecWithPredicates(Expr, &L, NewPreds); 13268 13269 if (!New) 13270 return nullptr; 13271 13272 for (auto *P : NewPreds) 13273 Preds.add(P); 13274 13275 updateGeneration(); 13276 RewriteMap[SE.getSCEV(V)] = {Generation, New}; 13277 return New; 13278 } 13279 13280 PredicatedScalarEvolution::PredicatedScalarEvolution( 13281 const PredicatedScalarEvolution &Init) 13282 : RewriteMap(Init.RewriteMap), SE(Init.SE), L(Init.L), Preds(Init.Preds), 13283 Generation(Init.Generation), BackedgeCount(Init.BackedgeCount) { 13284 for (auto I : Init.FlagsMap) 13285 FlagsMap.insert(I); 13286 } 13287 13288 void PredicatedScalarEvolution::print(raw_ostream &OS, unsigned Depth) const { 13289 // For each block. 13290 for (auto *BB : L.getBlocks()) 13291 for (auto &I : *BB) { 13292 if (!SE.isSCEVable(I.getType())) 13293 continue; 13294 13295 auto *Expr = SE.getSCEV(&I); 13296 auto II = RewriteMap.find(Expr); 13297 13298 if (II == RewriteMap.end()) 13299 continue; 13300 13301 // Don't print things that are not interesting. 13302 if (II->second.second == Expr) 13303 continue; 13304 13305 OS.indent(Depth) << "[PSE]" << I << ":\n"; 13306 OS.indent(Depth + 2) << *Expr << "\n"; 13307 OS.indent(Depth + 2) << "--> " << *II->second.second << "\n"; 13308 } 13309 } 13310 13311 // Match the mathematical pattern A - (A / B) * B, where A and B can be 13312 // arbitrary expressions. Also match zext (trunc A to iB) to iY, which is used 13313 // for URem with constant power-of-2 second operands. 13314 // It's not always easy, as A and B can be folded (imagine A is X / 2, and B is 13315 // 4, A / B becomes X / 8). 13316 bool ScalarEvolution::matchURem(const SCEV *Expr, const SCEV *&LHS, 13317 const SCEV *&RHS) { 13318 // Try to match 'zext (trunc A to iB) to iY', which is used 13319 // for URem with constant power-of-2 second operands. Make sure the size of 13320 // the operand A matches the size of the whole expressions. 13321 if (const auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(Expr)) 13322 if (const auto *Trunc = dyn_cast<SCEVTruncateExpr>(ZExt->getOperand(0))) { 13323 LHS = Trunc->getOperand(); 13324 // Bail out if the type of the LHS is larger than the type of the 13325 // expression for now. 13326 if (getTypeSizeInBits(LHS->getType()) > 13327 getTypeSizeInBits(Expr->getType())) 13328 return false; 13329 if (LHS->getType() != Expr->getType()) 13330 LHS = getZeroExtendExpr(LHS, Expr->getType()); 13331 RHS = getConstant(APInt(getTypeSizeInBits(Expr->getType()), 1) 13332 << getTypeSizeInBits(Trunc->getType())); 13333 return true; 13334 } 13335 const auto *Add = dyn_cast<SCEVAddExpr>(Expr); 13336 if (Add == nullptr || Add->getNumOperands() != 2) 13337 return false; 13338 13339 const SCEV *A = Add->getOperand(1); 13340 const auto *Mul = dyn_cast<SCEVMulExpr>(Add->getOperand(0)); 13341 13342 if (Mul == nullptr) 13343 return false; 13344 13345 const auto MatchURemWithDivisor = [&](const SCEV *B) { 13346 // (SomeExpr + (-(SomeExpr / B) * B)). 13347 if (Expr == getURemExpr(A, B)) { 13348 LHS = A; 13349 RHS = B; 13350 return true; 13351 } 13352 return false; 13353 }; 13354 13355 // (SomeExpr + (-1 * (SomeExpr / B) * B)). 13356 if (Mul->getNumOperands() == 3 && isa<SCEVConstant>(Mul->getOperand(0))) 13357 return MatchURemWithDivisor(Mul->getOperand(1)) || 13358 MatchURemWithDivisor(Mul->getOperand(2)); 13359 13360 // (SomeExpr + ((-SomeExpr / B) * B)) or (SomeExpr + ((SomeExpr / B) * -B)). 13361 if (Mul->getNumOperands() == 2) 13362 return MatchURemWithDivisor(Mul->getOperand(1)) || 13363 MatchURemWithDivisor(Mul->getOperand(0)) || 13364 MatchURemWithDivisor(getNegativeSCEV(Mul->getOperand(1))) || 13365 MatchURemWithDivisor(getNegativeSCEV(Mul->getOperand(0))); 13366 return false; 13367 } 13368 13369 const SCEV * 13370 ScalarEvolution::computeSymbolicMaxBackedgeTakenCount(const Loop *L) { 13371 SmallVector<BasicBlock*, 16> ExitingBlocks; 13372 L->getExitingBlocks(ExitingBlocks); 13373 13374 // Form an expression for the maximum exit count possible for this loop. We 13375 // merge the max and exact information to approximate a version of 13376 // getConstantMaxBackedgeTakenCount which isn't restricted to just constants. 13377 SmallVector<const SCEV*, 4> ExitCounts; 13378 for (BasicBlock *ExitingBB : ExitingBlocks) { 13379 const SCEV *ExitCount = getExitCount(L, ExitingBB); 13380 if (isa<SCEVCouldNotCompute>(ExitCount)) 13381 ExitCount = getExitCount(L, ExitingBB, 13382 ScalarEvolution::ConstantMaximum); 13383 if (!isa<SCEVCouldNotCompute>(ExitCount)) { 13384 assert(DT.dominates(ExitingBB, L->getLoopLatch()) && 13385 "We should only have known counts for exiting blocks that " 13386 "dominate latch!"); 13387 ExitCounts.push_back(ExitCount); 13388 } 13389 } 13390 if (ExitCounts.empty()) 13391 return getCouldNotCompute(); 13392 return getUMinFromMismatchedTypes(ExitCounts); 13393 } 13394 13395 /// This rewriter is similar to SCEVParameterRewriter (it replaces SCEVUnknown 13396 /// components following the Map (Value -> SCEV)), but skips AddRecExpr because 13397 /// we cannot guarantee that the replacement is loop invariant in the loop of 13398 /// the AddRec. 13399 class SCEVLoopGuardRewriter : public SCEVRewriteVisitor<SCEVLoopGuardRewriter> { 13400 ValueToSCEVMapTy ⤅ 13401 13402 public: 13403 SCEVLoopGuardRewriter(ScalarEvolution &SE, ValueToSCEVMapTy &M) 13404 : SCEVRewriteVisitor(SE), Map(M) {} 13405 13406 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { return Expr; } 13407 13408 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 13409 auto I = Map.find(Expr->getValue()); 13410 if (I == Map.end()) 13411 return Expr; 13412 return I->second; 13413 } 13414 }; 13415 13416 const SCEV *ScalarEvolution::applyLoopGuards(const SCEV *Expr, const Loop *L) { 13417 auto CollectCondition = [&](ICmpInst::Predicate Predicate, const SCEV *LHS, 13418 const SCEV *RHS, ValueToSCEVMapTy &RewriteMap) { 13419 // If we have LHS == 0, check if LHS is computing a property of some unknown 13420 // SCEV %v which we can rewrite %v to express explicitly. 13421 const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS); 13422 if (Predicate == CmpInst::ICMP_EQ && RHSC && 13423 RHSC->getValue()->isNullValue()) { 13424 // If LHS is A % B, i.e. A % B == 0, rewrite A to (A /u B) * B to 13425 // explicitly express that. 13426 const SCEV *URemLHS = nullptr; 13427 const SCEV *URemRHS = nullptr; 13428 if (matchURem(LHS, URemLHS, URemRHS)) { 13429 if (const SCEVUnknown *LHSUnknown = dyn_cast<SCEVUnknown>(URemLHS)) { 13430 Value *V = LHSUnknown->getValue(); 13431 auto Multiple = 13432 getMulExpr(getUDivExpr(URemLHS, URemRHS), URemRHS, 13433 (SCEV::NoWrapFlags)(SCEV::FlagNUW | SCEV::FlagNSW)); 13434 RewriteMap[V] = Multiple; 13435 return; 13436 } 13437 } 13438 } 13439 13440 if (!isa<SCEVUnknown>(LHS)) { 13441 std::swap(LHS, RHS); 13442 Predicate = CmpInst::getSwappedPredicate(Predicate); 13443 } 13444 13445 // For now, limit to conditions that provide information about unknown 13446 // expressions. 13447 auto *LHSUnknown = dyn_cast<SCEVUnknown>(LHS); 13448 if (!LHSUnknown) 13449 return; 13450 13451 // Check whether LHS has already been rewritten. In that case we want to 13452 // chain further rewrites onto the already rewritten value. 13453 auto I = RewriteMap.find(LHSUnknown->getValue()); 13454 const SCEV *RewrittenLHS = I != RewriteMap.end() ? I->second : LHS; 13455 13456 // TODO: use information from more predicates. 13457 switch (Predicate) { 13458 case CmpInst::ICMP_ULT: 13459 if (!containsAddRecurrence(RHS)) 13460 RewriteMap[LHSUnknown->getValue()] = getUMinExpr( 13461 RewrittenLHS, getMinusSCEV(RHS, getOne(RHS->getType()))); 13462 break; 13463 case CmpInst::ICMP_ULE: 13464 if (!containsAddRecurrence(RHS)) 13465 RewriteMap[LHSUnknown->getValue()] = getUMinExpr(RewrittenLHS, RHS); 13466 break; 13467 case CmpInst::ICMP_UGT: 13468 if (!containsAddRecurrence(RHS)) 13469 RewriteMap[LHSUnknown->getValue()] = 13470 getUMaxExpr(RewrittenLHS, getAddExpr(RHS, getOne(RHS->getType()))); 13471 break; 13472 case CmpInst::ICMP_UGE: 13473 if (!containsAddRecurrence(RHS)) 13474 RewriteMap[LHSUnknown->getValue()] = getUMaxExpr(RewrittenLHS, RHS); 13475 break; 13476 case CmpInst::ICMP_EQ: 13477 if (isa<SCEVConstant>(RHS)) 13478 RewriteMap[LHSUnknown->getValue()] = RHS; 13479 break; 13480 case CmpInst::ICMP_NE: 13481 if (isa<SCEVConstant>(RHS) && 13482 cast<SCEVConstant>(RHS)->getValue()->isNullValue()) 13483 RewriteMap[LHSUnknown->getValue()] = 13484 getUMaxExpr(RewrittenLHS, getOne(RHS->getType())); 13485 break; 13486 default: 13487 break; 13488 } 13489 }; 13490 // Starting at the loop predecessor, climb up the predecessor chain, as long 13491 // as there are predecessors that can be found that have unique successors 13492 // leading to the original header. 13493 // TODO: share this logic with isLoopEntryGuardedByCond. 13494 ValueToSCEVMapTy RewriteMap; 13495 for (std::pair<const BasicBlock *, const BasicBlock *> Pair( 13496 L->getLoopPredecessor(), L->getHeader()); 13497 Pair.first; Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) { 13498 13499 const BranchInst *LoopEntryPredicate = 13500 dyn_cast<BranchInst>(Pair.first->getTerminator()); 13501 if (!LoopEntryPredicate || LoopEntryPredicate->isUnconditional()) 13502 continue; 13503 13504 // TODO: use information from more complex conditions, e.g. AND expressions. 13505 auto *Cmp = dyn_cast<ICmpInst>(LoopEntryPredicate->getCondition()); 13506 if (!Cmp) 13507 continue; 13508 13509 auto Predicate = Cmp->getPredicate(); 13510 if (LoopEntryPredicate->getSuccessor(1) == Pair.second) 13511 Predicate = CmpInst::getInversePredicate(Predicate); 13512 CollectCondition(Predicate, getSCEV(Cmp->getOperand(0)), 13513 getSCEV(Cmp->getOperand(1)), RewriteMap); 13514 } 13515 13516 // Also collect information from assumptions dominating the loop. 13517 for (auto &AssumeVH : AC.assumptions()) { 13518 if (!AssumeVH) 13519 continue; 13520 auto *AssumeI = cast<CallInst>(AssumeVH); 13521 auto *Cmp = dyn_cast<ICmpInst>(AssumeI->getOperand(0)); 13522 if (!Cmp || !DT.dominates(AssumeI, L->getHeader())) 13523 continue; 13524 CollectCondition(Cmp->getPredicate(), getSCEV(Cmp->getOperand(0)), 13525 getSCEV(Cmp->getOperand(1)), RewriteMap); 13526 } 13527 13528 if (RewriteMap.empty()) 13529 return Expr; 13530 SCEVLoopGuardRewriter Rewriter(*this, RewriteMap); 13531 return Rewriter.visit(Expr); 13532 } 13533