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(NumTripCountsComputed, 143 "Number of loops with predictable loop counts"); 144 STATISTIC(NumTripCountsNotComputed, 145 "Number of loops without predictable loop counts"); 146 STATISTIC(NumBruteForceTripCountsComputed, 147 "Number of loops with trip counts computed by force"); 148 149 static cl::opt<unsigned> 150 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden, 151 cl::ZeroOrMore, 152 cl::desc("Maximum number of iterations SCEV will " 153 "symbolically execute a constant " 154 "derived loop"), 155 cl::init(100)); 156 157 // FIXME: Enable this with EXPENSIVE_CHECKS when the test suite is clean. 158 static cl::opt<bool> VerifySCEV( 159 "verify-scev", cl::Hidden, 160 cl::desc("Verify ScalarEvolution's backedge taken counts (slow)")); 161 static cl::opt<bool> VerifySCEVStrict( 162 "verify-scev-strict", cl::Hidden, 163 cl::desc("Enable stricter verification with -verify-scev is passed")); 164 static cl::opt<bool> 165 VerifySCEVMap("verify-scev-maps", cl::Hidden, 166 cl::desc("Verify no dangling value in ScalarEvolution's " 167 "ExprValueMap (slow)")); 168 169 static cl::opt<bool> VerifyIR( 170 "scev-verify-ir", cl::Hidden, 171 cl::desc("Verify IR correctness when making sensitive SCEV queries (slow)"), 172 cl::init(false)); 173 174 static cl::opt<unsigned> MulOpsInlineThreshold( 175 "scev-mulops-inline-threshold", cl::Hidden, 176 cl::desc("Threshold for inlining multiplication operands into a SCEV"), 177 cl::init(32)); 178 179 static cl::opt<unsigned> AddOpsInlineThreshold( 180 "scev-addops-inline-threshold", cl::Hidden, 181 cl::desc("Threshold for inlining addition operands into a SCEV"), 182 cl::init(500)); 183 184 static cl::opt<unsigned> MaxSCEVCompareDepth( 185 "scalar-evolution-max-scev-compare-depth", cl::Hidden, 186 cl::desc("Maximum depth of recursive SCEV complexity comparisons"), 187 cl::init(32)); 188 189 static cl::opt<unsigned> MaxSCEVOperationsImplicationDepth( 190 "scalar-evolution-max-scev-operations-implication-depth", cl::Hidden, 191 cl::desc("Maximum depth of recursive SCEV operations implication analysis"), 192 cl::init(2)); 193 194 static cl::opt<unsigned> MaxValueCompareDepth( 195 "scalar-evolution-max-value-compare-depth", cl::Hidden, 196 cl::desc("Maximum depth of recursive value complexity comparisons"), 197 cl::init(2)); 198 199 static cl::opt<unsigned> 200 MaxArithDepth("scalar-evolution-max-arith-depth", cl::Hidden, 201 cl::desc("Maximum depth of recursive arithmetics"), 202 cl::init(32)); 203 204 static cl::opt<unsigned> MaxConstantEvolvingDepth( 205 "scalar-evolution-max-constant-evolving-depth", cl::Hidden, 206 cl::desc("Maximum depth of recursive constant evolving"), cl::init(32)); 207 208 static cl::opt<unsigned> 209 MaxCastDepth("scalar-evolution-max-cast-depth", cl::Hidden, 210 cl::desc("Maximum depth of recursive SExt/ZExt/Trunc"), 211 cl::init(8)); 212 213 static cl::opt<unsigned> 214 MaxAddRecSize("scalar-evolution-max-add-rec-size", cl::Hidden, 215 cl::desc("Max coefficients in AddRec during evolving"), 216 cl::init(8)); 217 218 static cl::opt<unsigned> 219 HugeExprThreshold("scalar-evolution-huge-expr-threshold", cl::Hidden, 220 cl::desc("Size of the expression which is considered huge"), 221 cl::init(4096)); 222 223 static cl::opt<bool> 224 ClassifyExpressions("scalar-evolution-classify-expressions", 225 cl::Hidden, cl::init(true), 226 cl::desc("When printing analysis, include information on every instruction")); 227 228 static cl::opt<bool> UseExpensiveRangeSharpening( 229 "scalar-evolution-use-expensive-range-sharpening", cl::Hidden, 230 cl::init(false), 231 cl::desc("Use more powerful methods of sharpening expression ranges. May " 232 "be costly in terms of compile time")); 233 234 //===----------------------------------------------------------------------===// 235 // SCEV class definitions 236 //===----------------------------------------------------------------------===// 237 238 //===----------------------------------------------------------------------===// 239 // Implementation of the SCEV class. 240 // 241 242 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 243 LLVM_DUMP_METHOD void SCEV::dump() const { 244 print(dbgs()); 245 dbgs() << '\n'; 246 } 247 #endif 248 249 void SCEV::print(raw_ostream &OS) const { 250 switch (getSCEVType()) { 251 case scConstant: 252 cast<SCEVConstant>(this)->getValue()->printAsOperand(OS, false); 253 return; 254 case scPtrToInt: { 255 const SCEVPtrToIntExpr *PtrToInt = cast<SCEVPtrToIntExpr>(this); 256 const SCEV *Op = PtrToInt->getOperand(); 257 OS << "(ptrtoint " << *Op->getType() << " " << *Op << " to " 258 << *PtrToInt->getType() << ")"; 259 return; 260 } 261 case scTruncate: { 262 const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this); 263 const SCEV *Op = Trunc->getOperand(); 264 OS << "(trunc " << *Op->getType() << " " << *Op << " to " 265 << *Trunc->getType() << ")"; 266 return; 267 } 268 case scZeroExtend: { 269 const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this); 270 const SCEV *Op = ZExt->getOperand(); 271 OS << "(zext " << *Op->getType() << " " << *Op << " to " 272 << *ZExt->getType() << ")"; 273 return; 274 } 275 case scSignExtend: { 276 const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this); 277 const SCEV *Op = SExt->getOperand(); 278 OS << "(sext " << *Op->getType() << " " << *Op << " to " 279 << *SExt->getType() << ")"; 280 return; 281 } 282 case scAddRecExpr: { 283 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this); 284 OS << "{" << *AR->getOperand(0); 285 for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i) 286 OS << ",+," << *AR->getOperand(i); 287 OS << "}<"; 288 if (AR->hasNoUnsignedWrap()) 289 OS << "nuw><"; 290 if (AR->hasNoSignedWrap()) 291 OS << "nsw><"; 292 if (AR->hasNoSelfWrap() && 293 !AR->getNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW))) 294 OS << "nw><"; 295 AR->getLoop()->getHeader()->printAsOperand(OS, /*PrintType=*/false); 296 OS << ">"; 297 return; 298 } 299 case scAddExpr: 300 case scMulExpr: 301 case scUMaxExpr: 302 case scSMaxExpr: 303 case scUMinExpr: 304 case scSMinExpr: 305 case scSequentialUMinExpr: { 306 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this); 307 const char *OpStr = nullptr; 308 switch (NAry->getSCEVType()) { 309 case scAddExpr: OpStr = " + "; break; 310 case scMulExpr: OpStr = " * "; break; 311 case scUMaxExpr: OpStr = " umax "; break; 312 case scSMaxExpr: OpStr = " smax "; break; 313 case scUMinExpr: 314 OpStr = " umin "; 315 break; 316 case scSMinExpr: 317 OpStr = " smin "; 318 break; 319 case scSequentialUMinExpr: 320 OpStr = " umin_seq "; 321 break; 322 default: 323 llvm_unreachable("There are no other nary expression types."); 324 } 325 OS << "("; 326 ListSeparator LS(OpStr); 327 for (const SCEV *Op : NAry->operands()) 328 OS << LS << *Op; 329 OS << ")"; 330 switch (NAry->getSCEVType()) { 331 case scAddExpr: 332 case scMulExpr: 333 if (NAry->hasNoUnsignedWrap()) 334 OS << "<nuw>"; 335 if (NAry->hasNoSignedWrap()) 336 OS << "<nsw>"; 337 break; 338 default: 339 // Nothing to print for other nary expressions. 340 break; 341 } 342 return; 343 } 344 case scUDivExpr: { 345 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this); 346 OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")"; 347 return; 348 } 349 case scUnknown: { 350 const SCEVUnknown *U = cast<SCEVUnknown>(this); 351 Type *AllocTy; 352 if (U->isSizeOf(AllocTy)) { 353 OS << "sizeof(" << *AllocTy << ")"; 354 return; 355 } 356 if (U->isAlignOf(AllocTy)) { 357 OS << "alignof(" << *AllocTy << ")"; 358 return; 359 } 360 361 Type *CTy; 362 Constant *FieldNo; 363 if (U->isOffsetOf(CTy, FieldNo)) { 364 OS << "offsetof(" << *CTy << ", "; 365 FieldNo->printAsOperand(OS, false); 366 OS << ")"; 367 return; 368 } 369 370 // Otherwise just print it normally. 371 U->getValue()->printAsOperand(OS, false); 372 return; 373 } 374 case scCouldNotCompute: 375 OS << "***COULDNOTCOMPUTE***"; 376 return; 377 } 378 llvm_unreachable("Unknown SCEV kind!"); 379 } 380 381 Type *SCEV::getType() const { 382 switch (getSCEVType()) { 383 case scConstant: 384 return cast<SCEVConstant>(this)->getType(); 385 case scPtrToInt: 386 case scTruncate: 387 case scZeroExtend: 388 case scSignExtend: 389 return cast<SCEVCastExpr>(this)->getType(); 390 case scAddRecExpr: 391 return cast<SCEVAddRecExpr>(this)->getType(); 392 case scMulExpr: 393 return cast<SCEVMulExpr>(this)->getType(); 394 case scUMaxExpr: 395 case scSMaxExpr: 396 case scUMinExpr: 397 case scSMinExpr: 398 return cast<SCEVMinMaxExpr>(this)->getType(); 399 case scSequentialUMinExpr: 400 return cast<SCEVSequentialMinMaxExpr>(this)->getType(); 401 case scAddExpr: 402 return cast<SCEVAddExpr>(this)->getType(); 403 case scUDivExpr: 404 return cast<SCEVUDivExpr>(this)->getType(); 405 case scUnknown: 406 return cast<SCEVUnknown>(this)->getType(); 407 case scCouldNotCompute: 408 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 409 } 410 llvm_unreachable("Unknown SCEV kind!"); 411 } 412 413 bool SCEV::isZero() const { 414 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 415 return SC->getValue()->isZero(); 416 return false; 417 } 418 419 bool SCEV::isOne() const { 420 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 421 return SC->getValue()->isOne(); 422 return false; 423 } 424 425 bool SCEV::isAllOnesValue() const { 426 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 427 return SC->getValue()->isMinusOne(); 428 return false; 429 } 430 431 bool SCEV::isNonConstantNegative() const { 432 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(this); 433 if (!Mul) return false; 434 435 // If there is a constant factor, it will be first. 436 const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0)); 437 if (!SC) return false; 438 439 // Return true if the value is negative, this matches things like (-42 * V). 440 return SC->getAPInt().isNegative(); 441 } 442 443 SCEVCouldNotCompute::SCEVCouldNotCompute() : 444 SCEV(FoldingSetNodeIDRef(), scCouldNotCompute, 0) {} 445 446 bool SCEVCouldNotCompute::classof(const SCEV *S) { 447 return S->getSCEVType() == scCouldNotCompute; 448 } 449 450 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) { 451 FoldingSetNodeID ID; 452 ID.AddInteger(scConstant); 453 ID.AddPointer(V); 454 void *IP = nullptr; 455 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 456 SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V); 457 UniqueSCEVs.InsertNode(S, IP); 458 return S; 459 } 460 461 const SCEV *ScalarEvolution::getConstant(const APInt &Val) { 462 return getConstant(ConstantInt::get(getContext(), Val)); 463 } 464 465 const SCEV * 466 ScalarEvolution::getConstant(Type *Ty, uint64_t V, bool isSigned) { 467 IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty)); 468 return getConstant(ConstantInt::get(ITy, V, isSigned)); 469 } 470 471 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID, SCEVTypes SCEVTy, 472 const SCEV *op, Type *ty) 473 : SCEV(ID, SCEVTy, computeExpressionSize(op)), Ty(ty) { 474 Operands[0] = op; 475 } 476 477 SCEVPtrToIntExpr::SCEVPtrToIntExpr(const FoldingSetNodeIDRef ID, const SCEV *Op, 478 Type *ITy) 479 : SCEVCastExpr(ID, scPtrToInt, Op, ITy) { 480 assert(getOperand()->getType()->isPointerTy() && Ty->isIntegerTy() && 481 "Must be a non-bit-width-changing pointer-to-integer cast!"); 482 } 483 484 SCEVIntegralCastExpr::SCEVIntegralCastExpr(const FoldingSetNodeIDRef ID, 485 SCEVTypes SCEVTy, const SCEV *op, 486 Type *ty) 487 : SCEVCastExpr(ID, SCEVTy, op, ty) {} 488 489 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID, const SCEV *op, 490 Type *ty) 491 : SCEVIntegralCastExpr(ID, scTruncate, op, ty) { 492 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 493 "Cannot truncate non-integer value!"); 494 } 495 496 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID, 497 const SCEV *op, Type *ty) 498 : SCEVIntegralCastExpr(ID, scZeroExtend, op, ty) { 499 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 500 "Cannot zero extend non-integer value!"); 501 } 502 503 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID, 504 const SCEV *op, Type *ty) 505 : SCEVIntegralCastExpr(ID, scSignExtend, op, ty) { 506 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 507 "Cannot sign extend non-integer value!"); 508 } 509 510 void SCEVUnknown::deleted() { 511 // Clear this SCEVUnknown from various maps. 512 SE->forgetMemoizedResults(this); 513 514 // Remove this SCEVUnknown from the uniquing map. 515 SE->UniqueSCEVs.RemoveNode(this); 516 517 // Release the value. 518 setValPtr(nullptr); 519 } 520 521 void SCEVUnknown::allUsesReplacedWith(Value *New) { 522 // Remove this SCEVUnknown from the uniquing map. 523 SE->UniqueSCEVs.RemoveNode(this); 524 525 // Update this SCEVUnknown to point to the new value. This is needed 526 // because there may still be outstanding SCEVs which still point to 527 // this SCEVUnknown. 528 setValPtr(New); 529 } 530 531 bool SCEVUnknown::isSizeOf(Type *&AllocTy) const { 532 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 533 if (VCE->getOpcode() == Instruction::PtrToInt) 534 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 535 if (CE->getOpcode() == Instruction::GetElementPtr && 536 CE->getOperand(0)->isNullValue() && 537 CE->getNumOperands() == 2) 538 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1))) 539 if (CI->isOne()) { 540 AllocTy = cast<GEPOperator>(CE)->getSourceElementType(); 541 return true; 542 } 543 544 return false; 545 } 546 547 bool SCEVUnknown::isAlignOf(Type *&AllocTy) const { 548 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 549 if (VCE->getOpcode() == Instruction::PtrToInt) 550 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 551 if (CE->getOpcode() == Instruction::GetElementPtr && 552 CE->getOperand(0)->isNullValue()) { 553 Type *Ty = cast<GEPOperator>(CE)->getSourceElementType(); 554 if (StructType *STy = dyn_cast<StructType>(Ty)) 555 if (!STy->isPacked() && 556 CE->getNumOperands() == 3 && 557 CE->getOperand(1)->isNullValue()) { 558 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2))) 559 if (CI->isOne() && 560 STy->getNumElements() == 2 && 561 STy->getElementType(0)->isIntegerTy(1)) { 562 AllocTy = STy->getElementType(1); 563 return true; 564 } 565 } 566 } 567 568 return false; 569 } 570 571 bool SCEVUnknown::isOffsetOf(Type *&CTy, Constant *&FieldNo) const { 572 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 573 if (VCE->getOpcode() == Instruction::PtrToInt) 574 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 575 if (CE->getOpcode() == Instruction::GetElementPtr && 576 CE->getNumOperands() == 3 && 577 CE->getOperand(0)->isNullValue() && 578 CE->getOperand(1)->isNullValue()) { 579 Type *Ty = cast<GEPOperator>(CE)->getSourceElementType(); 580 // Ignore vector types here so that ScalarEvolutionExpander doesn't 581 // emit getelementptrs that index into vectors. 582 if (Ty->isStructTy() || Ty->isArrayTy()) { 583 CTy = Ty; 584 FieldNo = CE->getOperand(2); 585 return true; 586 } 587 } 588 589 return false; 590 } 591 592 //===----------------------------------------------------------------------===// 593 // SCEV Utilities 594 //===----------------------------------------------------------------------===// 595 596 /// Compare the two values \p LV and \p RV in terms of their "complexity" where 597 /// "complexity" is a partial (and somewhat ad-hoc) relation used to order 598 /// operands in SCEV expressions. \p EqCache is a set of pairs of values that 599 /// have been previously deemed to be "equally complex" by this routine. It is 600 /// intended to avoid exponential time complexity in cases like: 601 /// 602 /// %a = f(%x, %y) 603 /// %b = f(%a, %a) 604 /// %c = f(%b, %b) 605 /// 606 /// %d = f(%x, %y) 607 /// %e = f(%d, %d) 608 /// %f = f(%e, %e) 609 /// 610 /// CompareValueComplexity(%f, %c) 611 /// 612 /// Since we do not continue running this routine on expression trees once we 613 /// have seen unequal values, there is no need to track them in the cache. 614 static int 615 CompareValueComplexity(EquivalenceClasses<const Value *> &EqCacheValue, 616 const LoopInfo *const LI, Value *LV, Value *RV, 617 unsigned Depth) { 618 if (Depth > MaxValueCompareDepth || EqCacheValue.isEquivalent(LV, RV)) 619 return 0; 620 621 // Order pointer values after integer values. This helps SCEVExpander form 622 // GEPs. 623 bool LIsPointer = LV->getType()->isPointerTy(), 624 RIsPointer = RV->getType()->isPointerTy(); 625 if (LIsPointer != RIsPointer) 626 return (int)LIsPointer - (int)RIsPointer; 627 628 // Compare getValueID values. 629 unsigned LID = LV->getValueID(), RID = RV->getValueID(); 630 if (LID != RID) 631 return (int)LID - (int)RID; 632 633 // Sort arguments by their position. 634 if (const auto *LA = dyn_cast<Argument>(LV)) { 635 const auto *RA = cast<Argument>(RV); 636 unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo(); 637 return (int)LArgNo - (int)RArgNo; 638 } 639 640 if (const auto *LGV = dyn_cast<GlobalValue>(LV)) { 641 const auto *RGV = cast<GlobalValue>(RV); 642 643 const auto IsGVNameSemantic = [&](const GlobalValue *GV) { 644 auto LT = GV->getLinkage(); 645 return !(GlobalValue::isPrivateLinkage(LT) || 646 GlobalValue::isInternalLinkage(LT)); 647 }; 648 649 // Use the names to distinguish the two values, but only if the 650 // names are semantically important. 651 if (IsGVNameSemantic(LGV) && IsGVNameSemantic(RGV)) 652 return LGV->getName().compare(RGV->getName()); 653 } 654 655 // For instructions, compare their loop depth, and their operand count. This 656 // is pretty loose. 657 if (const auto *LInst = dyn_cast<Instruction>(LV)) { 658 const auto *RInst = cast<Instruction>(RV); 659 660 // Compare loop depths. 661 const BasicBlock *LParent = LInst->getParent(), 662 *RParent = RInst->getParent(); 663 if (LParent != RParent) { 664 unsigned LDepth = LI->getLoopDepth(LParent), 665 RDepth = LI->getLoopDepth(RParent); 666 if (LDepth != RDepth) 667 return (int)LDepth - (int)RDepth; 668 } 669 670 // Compare the number of operands. 671 unsigned LNumOps = LInst->getNumOperands(), 672 RNumOps = RInst->getNumOperands(); 673 if (LNumOps != RNumOps) 674 return (int)LNumOps - (int)RNumOps; 675 676 for (unsigned Idx : seq(0u, LNumOps)) { 677 int Result = 678 CompareValueComplexity(EqCacheValue, LI, LInst->getOperand(Idx), 679 RInst->getOperand(Idx), Depth + 1); 680 if (Result != 0) 681 return Result; 682 } 683 } 684 685 EqCacheValue.unionSets(LV, RV); 686 return 0; 687 } 688 689 // Return negative, zero, or positive, if LHS is less than, equal to, or greater 690 // than RHS, respectively. A three-way result allows recursive comparisons to be 691 // more efficient. 692 // If the max analysis depth was reached, return None, assuming we do not know 693 // if they are equivalent for sure. 694 static Optional<int> 695 CompareSCEVComplexity(EquivalenceClasses<const SCEV *> &EqCacheSCEV, 696 EquivalenceClasses<const Value *> &EqCacheValue, 697 const LoopInfo *const LI, const SCEV *LHS, 698 const SCEV *RHS, DominatorTree &DT, unsigned Depth = 0) { 699 // Fast-path: SCEVs are uniqued so we can do a quick equality check. 700 if (LHS == RHS) 701 return 0; 702 703 // Primarily, sort the SCEVs by their getSCEVType(). 704 SCEVTypes LType = LHS->getSCEVType(), RType = RHS->getSCEVType(); 705 if (LType != RType) 706 return (int)LType - (int)RType; 707 708 if (EqCacheSCEV.isEquivalent(LHS, RHS)) 709 return 0; 710 711 if (Depth > MaxSCEVCompareDepth) 712 return None; 713 714 // Aside from the getSCEVType() ordering, the particular ordering 715 // isn't very important except that it's beneficial to be consistent, 716 // so that (a + b) and (b + a) don't end up as different expressions. 717 switch (LType) { 718 case scUnknown: { 719 const SCEVUnknown *LU = cast<SCEVUnknown>(LHS); 720 const SCEVUnknown *RU = cast<SCEVUnknown>(RHS); 721 722 int X = CompareValueComplexity(EqCacheValue, LI, LU->getValue(), 723 RU->getValue(), Depth + 1); 724 if (X == 0) 725 EqCacheSCEV.unionSets(LHS, RHS); 726 return X; 727 } 728 729 case scConstant: { 730 const SCEVConstant *LC = cast<SCEVConstant>(LHS); 731 const SCEVConstant *RC = cast<SCEVConstant>(RHS); 732 733 // Compare constant values. 734 const APInt &LA = LC->getAPInt(); 735 const APInt &RA = RC->getAPInt(); 736 unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth(); 737 if (LBitWidth != RBitWidth) 738 return (int)LBitWidth - (int)RBitWidth; 739 return LA.ult(RA) ? -1 : 1; 740 } 741 742 case scAddRecExpr: { 743 const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS); 744 const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS); 745 746 // There is always a dominance between two recs that are used by one SCEV, 747 // so we can safely sort recs by loop header dominance. We require such 748 // order in getAddExpr. 749 const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop(); 750 if (LLoop != RLoop) { 751 const BasicBlock *LHead = LLoop->getHeader(), *RHead = RLoop->getHeader(); 752 assert(LHead != RHead && "Two loops share the same header?"); 753 if (DT.dominates(LHead, RHead)) 754 return 1; 755 else 756 assert(DT.dominates(RHead, LHead) && 757 "No dominance between recurrences used by one SCEV?"); 758 return -1; 759 } 760 761 // Addrec complexity grows with operand count. 762 unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands(); 763 if (LNumOps != RNumOps) 764 return (int)LNumOps - (int)RNumOps; 765 766 // Lexicographically compare. 767 for (unsigned i = 0; i != LNumOps; ++i) { 768 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, 769 LA->getOperand(i), RA->getOperand(i), DT, 770 Depth + 1); 771 if (X != 0) 772 return X; 773 } 774 EqCacheSCEV.unionSets(LHS, RHS); 775 return 0; 776 } 777 778 case scAddExpr: 779 case scMulExpr: 780 case scSMaxExpr: 781 case scUMaxExpr: 782 case scSMinExpr: 783 case scUMinExpr: 784 case scSequentialUMinExpr: { 785 const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS); 786 const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS); 787 788 // Lexicographically compare n-ary expressions. 789 unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands(); 790 if (LNumOps != RNumOps) 791 return (int)LNumOps - (int)RNumOps; 792 793 for (unsigned i = 0; i != LNumOps; ++i) { 794 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, 795 LC->getOperand(i), RC->getOperand(i), DT, 796 Depth + 1); 797 if (X != 0) 798 return X; 799 } 800 EqCacheSCEV.unionSets(LHS, RHS); 801 return 0; 802 } 803 804 case scUDivExpr: { 805 const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS); 806 const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS); 807 808 // Lexicographically compare udiv expressions. 809 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getLHS(), 810 RC->getLHS(), DT, Depth + 1); 811 if (X != 0) 812 return X; 813 X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getRHS(), 814 RC->getRHS(), DT, Depth + 1); 815 if (X == 0) 816 EqCacheSCEV.unionSets(LHS, RHS); 817 return X; 818 } 819 820 case scPtrToInt: 821 case scTruncate: 822 case scZeroExtend: 823 case scSignExtend: { 824 const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS); 825 const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS); 826 827 // Compare cast expressions by operand. 828 auto X = 829 CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getOperand(), 830 RC->getOperand(), DT, Depth + 1); 831 if (X == 0) 832 EqCacheSCEV.unionSets(LHS, RHS); 833 return X; 834 } 835 836 case scCouldNotCompute: 837 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 838 } 839 llvm_unreachable("Unknown SCEV kind!"); 840 } 841 842 /// Given a list of SCEV objects, order them by their complexity, and group 843 /// objects of the same complexity together by value. When this routine is 844 /// finished, we know that any duplicates in the vector are consecutive and that 845 /// complexity is monotonically increasing. 846 /// 847 /// Note that we go take special precautions to ensure that we get deterministic 848 /// results from this routine. In other words, we don't want the results of 849 /// this to depend on where the addresses of various SCEV objects happened to 850 /// land in memory. 851 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops, 852 LoopInfo *LI, DominatorTree &DT) { 853 if (Ops.size() < 2) return; // Noop 854 855 EquivalenceClasses<const SCEV *> EqCacheSCEV; 856 EquivalenceClasses<const Value *> EqCacheValue; 857 858 // Whether LHS has provably less complexity than RHS. 859 auto IsLessComplex = [&](const SCEV *LHS, const SCEV *RHS) { 860 auto Complexity = 861 CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LHS, RHS, DT); 862 return Complexity && *Complexity < 0; 863 }; 864 if (Ops.size() == 2) { 865 // This is the common case, which also happens to be trivially simple. 866 // Special case it. 867 const SCEV *&LHS = Ops[0], *&RHS = Ops[1]; 868 if (IsLessComplex(RHS, LHS)) 869 std::swap(LHS, RHS); 870 return; 871 } 872 873 // Do the rough sort by complexity. 874 llvm::stable_sort(Ops, [&](const SCEV *LHS, const SCEV *RHS) { 875 return IsLessComplex(LHS, RHS); 876 }); 877 878 // Now that we are sorted by complexity, group elements of the same 879 // complexity. Note that this is, at worst, N^2, but the vector is likely to 880 // be extremely short in practice. Note that we take this approach because we 881 // do not want to depend on the addresses of the objects we are grouping. 882 for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) { 883 const SCEV *S = Ops[i]; 884 unsigned Complexity = S->getSCEVType(); 885 886 // If there are any objects of the same complexity and same value as this 887 // one, group them. 888 for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) { 889 if (Ops[j] == S) { // Found a duplicate. 890 // Move it to immediately after i'th element. 891 std::swap(Ops[i+1], Ops[j]); 892 ++i; // no need to rescan it. 893 if (i == e-2) return; // Done! 894 } 895 } 896 } 897 } 898 899 /// Returns true if \p Ops contains a huge SCEV (the subtree of S contains at 900 /// least HugeExprThreshold nodes). 901 static bool hasHugeExpression(ArrayRef<const SCEV *> Ops) { 902 return any_of(Ops, [](const SCEV *S) { 903 return S->getExpressionSize() >= HugeExprThreshold; 904 }); 905 } 906 907 //===----------------------------------------------------------------------===// 908 // Simple SCEV method implementations 909 //===----------------------------------------------------------------------===// 910 911 /// Compute BC(It, K). The result has width W. Assume, K > 0. 912 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K, 913 ScalarEvolution &SE, 914 Type *ResultTy) { 915 // Handle the simplest case efficiently. 916 if (K == 1) 917 return SE.getTruncateOrZeroExtend(It, ResultTy); 918 919 // We are using the following formula for BC(It, K): 920 // 921 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K! 922 // 923 // Suppose, W is the bitwidth of the return value. We must be prepared for 924 // overflow. Hence, we must assure that the result of our computation is 925 // equal to the accurate one modulo 2^W. Unfortunately, division isn't 926 // safe in modular arithmetic. 927 // 928 // However, this code doesn't use exactly that formula; the formula it uses 929 // is something like the following, where T is the number of factors of 2 in 930 // K! (i.e. trailing zeros in the binary representation of K!), and ^ is 931 // exponentiation: 932 // 933 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T) 934 // 935 // This formula is trivially equivalent to the previous formula. However, 936 // this formula can be implemented much more efficiently. The trick is that 937 // K! / 2^T is odd, and exact division by an odd number *is* safe in modular 938 // arithmetic. To do exact division in modular arithmetic, all we have 939 // to do is multiply by the inverse. Therefore, this step can be done at 940 // width W. 941 // 942 // The next issue is how to safely do the division by 2^T. The way this 943 // is done is by doing the multiplication step at a width of at least W + T 944 // bits. This way, the bottom W+T bits of the product are accurate. Then, 945 // when we perform the division by 2^T (which is equivalent to a right shift 946 // by T), the bottom W bits are accurate. Extra bits are okay; they'll get 947 // truncated out after the division by 2^T. 948 // 949 // In comparison to just directly using the first formula, this technique 950 // is much more efficient; using the first formula requires W * K bits, 951 // but this formula less than W + K bits. Also, the first formula requires 952 // a division step, whereas this formula only requires multiplies and shifts. 953 // 954 // It doesn't matter whether the subtraction step is done in the calculation 955 // width or the input iteration count's width; if the subtraction overflows, 956 // the result must be zero anyway. We prefer here to do it in the width of 957 // the induction variable because it helps a lot for certain cases; CodeGen 958 // isn't smart enough to ignore the overflow, which leads to much less 959 // efficient code if the width of the subtraction is wider than the native 960 // register width. 961 // 962 // (It's possible to not widen at all by pulling out factors of 2 before 963 // the multiplication; for example, K=2 can be calculated as 964 // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires 965 // extra arithmetic, so it's not an obvious win, and it gets 966 // much more complicated for K > 3.) 967 968 // Protection from insane SCEVs; this bound is conservative, 969 // but it probably doesn't matter. 970 if (K > 1000) 971 return SE.getCouldNotCompute(); 972 973 unsigned W = SE.getTypeSizeInBits(ResultTy); 974 975 // Calculate K! / 2^T and T; we divide out the factors of two before 976 // multiplying for calculating K! / 2^T to avoid overflow. 977 // Other overflow doesn't matter because we only care about the bottom 978 // W bits of the result. 979 APInt OddFactorial(W, 1); 980 unsigned T = 1; 981 for (unsigned i = 3; i <= K; ++i) { 982 APInt Mult(W, i); 983 unsigned TwoFactors = Mult.countTrailingZeros(); 984 T += TwoFactors; 985 Mult.lshrInPlace(TwoFactors); 986 OddFactorial *= Mult; 987 } 988 989 // We need at least W + T bits for the multiplication step 990 unsigned CalculationBits = W + T; 991 992 // Calculate 2^T, at width T+W. 993 APInt DivFactor = APInt::getOneBitSet(CalculationBits, T); 994 995 // Calculate the multiplicative inverse of K! / 2^T; 996 // this multiplication factor will perform the exact division by 997 // K! / 2^T. 998 APInt Mod = APInt::getSignedMinValue(W+1); 999 APInt MultiplyFactor = OddFactorial.zext(W+1); 1000 MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod); 1001 MultiplyFactor = MultiplyFactor.trunc(W); 1002 1003 // Calculate the product, at width T+W 1004 IntegerType *CalculationTy = IntegerType::get(SE.getContext(), 1005 CalculationBits); 1006 const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy); 1007 for (unsigned i = 1; i != K; ++i) { 1008 const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i)); 1009 Dividend = SE.getMulExpr(Dividend, 1010 SE.getTruncateOrZeroExtend(S, CalculationTy)); 1011 } 1012 1013 // Divide by 2^T 1014 const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor)); 1015 1016 // Truncate the result, and divide by K! / 2^T. 1017 1018 return SE.getMulExpr(SE.getConstant(MultiplyFactor), 1019 SE.getTruncateOrZeroExtend(DivResult, ResultTy)); 1020 } 1021 1022 /// Return the value of this chain of recurrences at the specified iteration 1023 /// number. We can evaluate this recurrence by multiplying each element in the 1024 /// chain by the binomial coefficient corresponding to it. In other words, we 1025 /// can evaluate {A,+,B,+,C,+,D} as: 1026 /// 1027 /// A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3) 1028 /// 1029 /// where BC(It, k) stands for binomial coefficient. 1030 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It, 1031 ScalarEvolution &SE) const { 1032 return evaluateAtIteration(makeArrayRef(op_begin(), op_end()), It, SE); 1033 } 1034 1035 const SCEV * 1036 SCEVAddRecExpr::evaluateAtIteration(ArrayRef<const SCEV *> Operands, 1037 const SCEV *It, ScalarEvolution &SE) { 1038 assert(Operands.size() > 0); 1039 const SCEV *Result = Operands[0]; 1040 for (unsigned i = 1, e = Operands.size(); i != e; ++i) { 1041 // The computation is correct in the face of overflow provided that the 1042 // multiplication is performed _after_ the evaluation of the binomial 1043 // coefficient. 1044 const SCEV *Coeff = BinomialCoefficient(It, i, SE, Result->getType()); 1045 if (isa<SCEVCouldNotCompute>(Coeff)) 1046 return Coeff; 1047 1048 Result = SE.getAddExpr(Result, SE.getMulExpr(Operands[i], Coeff)); 1049 } 1050 return Result; 1051 } 1052 1053 //===----------------------------------------------------------------------===// 1054 // SCEV Expression folder implementations 1055 //===----------------------------------------------------------------------===// 1056 1057 const SCEV *ScalarEvolution::getLosslessPtrToIntExpr(const SCEV *Op, 1058 unsigned Depth) { 1059 assert(Depth <= 1 && 1060 "getLosslessPtrToIntExpr() should self-recurse at most once."); 1061 1062 // We could be called with an integer-typed operands during SCEV rewrites. 1063 // Since the operand is an integer already, just perform zext/trunc/self cast. 1064 if (!Op->getType()->isPointerTy()) 1065 return Op; 1066 1067 // What would be an ID for such a SCEV cast expression? 1068 FoldingSetNodeID ID; 1069 ID.AddInteger(scPtrToInt); 1070 ID.AddPointer(Op); 1071 1072 void *IP = nullptr; 1073 1074 // Is there already an expression for such a cast? 1075 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 1076 return S; 1077 1078 // It isn't legal for optimizations to construct new ptrtoint expressions 1079 // for non-integral pointers. 1080 if (getDataLayout().isNonIntegralPointerType(Op->getType())) 1081 return getCouldNotCompute(); 1082 1083 Type *IntPtrTy = getDataLayout().getIntPtrType(Op->getType()); 1084 1085 // We can only trivially model ptrtoint if SCEV's effective (integer) type 1086 // is sufficiently wide to represent all possible pointer values. 1087 // We could theoretically teach SCEV to truncate wider pointers, but 1088 // that isn't implemented for now. 1089 if (getDataLayout().getTypeSizeInBits(getEffectiveSCEVType(Op->getType())) != 1090 getDataLayout().getTypeSizeInBits(IntPtrTy)) 1091 return getCouldNotCompute(); 1092 1093 // If not, is this expression something we can't reduce any further? 1094 if (auto *U = dyn_cast<SCEVUnknown>(Op)) { 1095 // Perform some basic constant folding. If the operand of the ptr2int cast 1096 // is a null pointer, don't create a ptr2int SCEV expression (that will be 1097 // left as-is), but produce a zero constant. 1098 // NOTE: We could handle a more general case, but lack motivational cases. 1099 if (isa<ConstantPointerNull>(U->getValue())) 1100 return getZero(IntPtrTy); 1101 1102 // Create an explicit cast node. 1103 // We can reuse the existing insert position since if we get here, 1104 // we won't have made any changes which would invalidate it. 1105 SCEV *S = new (SCEVAllocator) 1106 SCEVPtrToIntExpr(ID.Intern(SCEVAllocator), Op, IntPtrTy); 1107 UniqueSCEVs.InsertNode(S, IP); 1108 registerUser(S, Op); 1109 return S; 1110 } 1111 1112 assert(Depth == 0 && "getLosslessPtrToIntExpr() should not self-recurse for " 1113 "non-SCEVUnknown's."); 1114 1115 // Otherwise, we've got some expression that is more complex than just a 1116 // single SCEVUnknown. But we don't want to have a SCEVPtrToIntExpr of an 1117 // arbitrary expression, we want to have SCEVPtrToIntExpr of an SCEVUnknown 1118 // only, and the expressions must otherwise be integer-typed. 1119 // So sink the cast down to the SCEVUnknown's. 1120 1121 /// The SCEVPtrToIntSinkingRewriter takes a scalar evolution expression, 1122 /// which computes a pointer-typed value, and rewrites the whole expression 1123 /// tree so that *all* the computations are done on integers, and the only 1124 /// pointer-typed operands in the expression are SCEVUnknown. 1125 class SCEVPtrToIntSinkingRewriter 1126 : public SCEVRewriteVisitor<SCEVPtrToIntSinkingRewriter> { 1127 using Base = SCEVRewriteVisitor<SCEVPtrToIntSinkingRewriter>; 1128 1129 public: 1130 SCEVPtrToIntSinkingRewriter(ScalarEvolution &SE) : SCEVRewriteVisitor(SE) {} 1131 1132 static const SCEV *rewrite(const SCEV *Scev, ScalarEvolution &SE) { 1133 SCEVPtrToIntSinkingRewriter Rewriter(SE); 1134 return Rewriter.visit(Scev); 1135 } 1136 1137 const SCEV *visit(const SCEV *S) { 1138 Type *STy = S->getType(); 1139 // If the expression is not pointer-typed, just keep it as-is. 1140 if (!STy->isPointerTy()) 1141 return S; 1142 // Else, recursively sink the cast down into it. 1143 return Base::visit(S); 1144 } 1145 1146 const SCEV *visitAddExpr(const SCEVAddExpr *Expr) { 1147 SmallVector<const SCEV *, 2> Operands; 1148 bool Changed = false; 1149 for (auto *Op : Expr->operands()) { 1150 Operands.push_back(visit(Op)); 1151 Changed |= Op != Operands.back(); 1152 } 1153 return !Changed ? Expr : SE.getAddExpr(Operands, Expr->getNoWrapFlags()); 1154 } 1155 1156 const SCEV *visitMulExpr(const SCEVMulExpr *Expr) { 1157 SmallVector<const SCEV *, 2> Operands; 1158 bool Changed = false; 1159 for (auto *Op : Expr->operands()) { 1160 Operands.push_back(visit(Op)); 1161 Changed |= Op != Operands.back(); 1162 } 1163 return !Changed ? Expr : SE.getMulExpr(Operands, Expr->getNoWrapFlags()); 1164 } 1165 1166 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 1167 assert(Expr->getType()->isPointerTy() && 1168 "Should only reach pointer-typed SCEVUnknown's."); 1169 return SE.getLosslessPtrToIntExpr(Expr, /*Depth=*/1); 1170 } 1171 }; 1172 1173 // And actually perform the cast sinking. 1174 const SCEV *IntOp = SCEVPtrToIntSinkingRewriter::rewrite(Op, *this); 1175 assert(IntOp->getType()->isIntegerTy() && 1176 "We must have succeeded in sinking the cast, " 1177 "and ending up with an integer-typed expression!"); 1178 return IntOp; 1179 } 1180 1181 const SCEV *ScalarEvolution::getPtrToIntExpr(const SCEV *Op, Type *Ty) { 1182 assert(Ty->isIntegerTy() && "Target type must be an integer type!"); 1183 1184 const SCEV *IntOp = getLosslessPtrToIntExpr(Op); 1185 if (isa<SCEVCouldNotCompute>(IntOp)) 1186 return IntOp; 1187 1188 return getTruncateOrZeroExtend(IntOp, Ty); 1189 } 1190 1191 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op, Type *Ty, 1192 unsigned Depth) { 1193 assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) && 1194 "This is not a truncating conversion!"); 1195 assert(isSCEVable(Ty) && 1196 "This is not a conversion to a SCEVable type!"); 1197 assert(!Op->getType()->isPointerTy() && "Can't truncate pointer!"); 1198 Ty = getEffectiveSCEVType(Ty); 1199 1200 FoldingSetNodeID ID; 1201 ID.AddInteger(scTruncate); 1202 ID.AddPointer(Op); 1203 ID.AddPointer(Ty); 1204 void *IP = nullptr; 1205 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1206 1207 // Fold if the operand is constant. 1208 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1209 return getConstant( 1210 cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(), Ty))); 1211 1212 // trunc(trunc(x)) --> trunc(x) 1213 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) 1214 return getTruncateExpr(ST->getOperand(), Ty, Depth + 1); 1215 1216 // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing 1217 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op)) 1218 return getTruncateOrSignExtend(SS->getOperand(), Ty, Depth + 1); 1219 1220 // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing 1221 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1222 return getTruncateOrZeroExtend(SZ->getOperand(), Ty, Depth + 1); 1223 1224 if (Depth > MaxCastDepth) { 1225 SCEV *S = 1226 new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator), Op, Ty); 1227 UniqueSCEVs.InsertNode(S, IP); 1228 registerUser(S, Op); 1229 return S; 1230 } 1231 1232 // trunc(x1 + ... + xN) --> trunc(x1) + ... + trunc(xN) and 1233 // trunc(x1 * ... * xN) --> trunc(x1) * ... * trunc(xN), 1234 // if after transforming we have at most one truncate, not counting truncates 1235 // that replace other casts. 1236 if (isa<SCEVAddExpr>(Op) || isa<SCEVMulExpr>(Op)) { 1237 auto *CommOp = cast<SCEVCommutativeExpr>(Op); 1238 SmallVector<const SCEV *, 4> Operands; 1239 unsigned numTruncs = 0; 1240 for (unsigned i = 0, e = CommOp->getNumOperands(); i != e && numTruncs < 2; 1241 ++i) { 1242 const SCEV *S = getTruncateExpr(CommOp->getOperand(i), Ty, Depth + 1); 1243 if (!isa<SCEVIntegralCastExpr>(CommOp->getOperand(i)) && 1244 isa<SCEVTruncateExpr>(S)) 1245 numTruncs++; 1246 Operands.push_back(S); 1247 } 1248 if (numTruncs < 2) { 1249 if (isa<SCEVAddExpr>(Op)) 1250 return getAddExpr(Operands); 1251 else if (isa<SCEVMulExpr>(Op)) 1252 return getMulExpr(Operands); 1253 else 1254 llvm_unreachable("Unexpected SCEV type for Op."); 1255 } 1256 // Although we checked in the beginning that ID is not in the cache, it is 1257 // possible that during recursion and different modification ID was inserted 1258 // into the cache. So if we find it, just return it. 1259 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 1260 return S; 1261 } 1262 1263 // If the input value is a chrec scev, truncate the chrec's operands. 1264 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) { 1265 SmallVector<const SCEV *, 4> Operands; 1266 for (const SCEV *Op : AddRec->operands()) 1267 Operands.push_back(getTruncateExpr(Op, Ty, Depth + 1)); 1268 return getAddRecExpr(Operands, AddRec->getLoop(), SCEV::FlagAnyWrap); 1269 } 1270 1271 // Return zero if truncating to known zeros. 1272 uint32_t MinTrailingZeros = GetMinTrailingZeros(Op); 1273 if (MinTrailingZeros >= getTypeSizeInBits(Ty)) 1274 return getZero(Ty); 1275 1276 // The cast wasn't folded; create an explicit cast node. We can reuse 1277 // the existing insert position since if we get here, we won't have 1278 // made any changes which would invalidate it. 1279 SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator), 1280 Op, Ty); 1281 UniqueSCEVs.InsertNode(S, IP); 1282 registerUser(S, Op); 1283 return S; 1284 } 1285 1286 // Get the limit of a recurrence such that incrementing by Step cannot cause 1287 // signed overflow as long as the value of the recurrence within the 1288 // loop does not exceed this limit before incrementing. 1289 static const SCEV *getSignedOverflowLimitForStep(const SCEV *Step, 1290 ICmpInst::Predicate *Pred, 1291 ScalarEvolution *SE) { 1292 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType()); 1293 if (SE->isKnownPositive(Step)) { 1294 *Pred = ICmpInst::ICMP_SLT; 1295 return SE->getConstant(APInt::getSignedMinValue(BitWidth) - 1296 SE->getSignedRangeMax(Step)); 1297 } 1298 if (SE->isKnownNegative(Step)) { 1299 *Pred = ICmpInst::ICMP_SGT; 1300 return SE->getConstant(APInt::getSignedMaxValue(BitWidth) - 1301 SE->getSignedRangeMin(Step)); 1302 } 1303 return nullptr; 1304 } 1305 1306 // Get the limit of a recurrence such that incrementing by Step cannot cause 1307 // unsigned overflow as long as the value of the recurrence within the loop does 1308 // not exceed this limit before incrementing. 1309 static const SCEV *getUnsignedOverflowLimitForStep(const SCEV *Step, 1310 ICmpInst::Predicate *Pred, 1311 ScalarEvolution *SE) { 1312 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType()); 1313 *Pred = ICmpInst::ICMP_ULT; 1314 1315 return SE->getConstant(APInt::getMinValue(BitWidth) - 1316 SE->getUnsignedRangeMax(Step)); 1317 } 1318 1319 namespace { 1320 1321 struct ExtendOpTraitsBase { 1322 typedef const SCEV *(ScalarEvolution::*GetExtendExprTy)(const SCEV *, Type *, 1323 unsigned); 1324 }; 1325 1326 // Used to make code generic over signed and unsigned overflow. 1327 template <typename ExtendOp> struct ExtendOpTraits { 1328 // Members present: 1329 // 1330 // static const SCEV::NoWrapFlags WrapType; 1331 // 1332 // static const ExtendOpTraitsBase::GetExtendExprTy GetExtendExpr; 1333 // 1334 // static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1335 // ICmpInst::Predicate *Pred, 1336 // ScalarEvolution *SE); 1337 }; 1338 1339 template <> 1340 struct ExtendOpTraits<SCEVSignExtendExpr> : public ExtendOpTraitsBase { 1341 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNSW; 1342 1343 static const GetExtendExprTy GetExtendExpr; 1344 1345 static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1346 ICmpInst::Predicate *Pred, 1347 ScalarEvolution *SE) { 1348 return getSignedOverflowLimitForStep(Step, Pred, SE); 1349 } 1350 }; 1351 1352 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits< 1353 SCEVSignExtendExpr>::GetExtendExpr = &ScalarEvolution::getSignExtendExpr; 1354 1355 template <> 1356 struct ExtendOpTraits<SCEVZeroExtendExpr> : public ExtendOpTraitsBase { 1357 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNUW; 1358 1359 static const GetExtendExprTy GetExtendExpr; 1360 1361 static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1362 ICmpInst::Predicate *Pred, 1363 ScalarEvolution *SE) { 1364 return getUnsignedOverflowLimitForStep(Step, Pred, SE); 1365 } 1366 }; 1367 1368 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits< 1369 SCEVZeroExtendExpr>::GetExtendExpr = &ScalarEvolution::getZeroExtendExpr; 1370 1371 } // end anonymous namespace 1372 1373 // The recurrence AR has been shown to have no signed/unsigned wrap or something 1374 // close to it. Typically, if we can prove NSW/NUW for AR, then we can just as 1375 // easily prove NSW/NUW for its preincrement or postincrement sibling. This 1376 // allows normalizing a sign/zero extended AddRec as such: {sext/zext(Step + 1377 // Start),+,Step} => {(Step + sext/zext(Start),+,Step} As a result, the 1378 // expression "Step + sext/zext(PreIncAR)" is congruent with 1379 // "sext/zext(PostIncAR)" 1380 template <typename ExtendOpTy> 1381 static const SCEV *getPreStartForExtend(const SCEVAddRecExpr *AR, Type *Ty, 1382 ScalarEvolution *SE, unsigned Depth) { 1383 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType; 1384 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr; 1385 1386 const Loop *L = AR->getLoop(); 1387 const SCEV *Start = AR->getStart(); 1388 const SCEV *Step = AR->getStepRecurrence(*SE); 1389 1390 // Check for a simple looking step prior to loop entry. 1391 const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Start); 1392 if (!SA) 1393 return nullptr; 1394 1395 // Create an AddExpr for "PreStart" after subtracting Step. Full SCEV 1396 // subtraction is expensive. For this purpose, perform a quick and dirty 1397 // difference, by checking for Step in the operand list. 1398 SmallVector<const SCEV *, 4> DiffOps; 1399 for (const SCEV *Op : SA->operands()) 1400 if (Op != Step) 1401 DiffOps.push_back(Op); 1402 1403 if (DiffOps.size() == SA->getNumOperands()) 1404 return nullptr; 1405 1406 // Try to prove `WrapType` (SCEV::FlagNSW or SCEV::FlagNUW) on `PreStart` + 1407 // `Step`: 1408 1409 // 1. NSW/NUW flags on the step increment. 1410 auto PreStartFlags = 1411 ScalarEvolution::maskFlags(SA->getNoWrapFlags(), SCEV::FlagNUW); 1412 const SCEV *PreStart = SE->getAddExpr(DiffOps, PreStartFlags); 1413 const SCEVAddRecExpr *PreAR = dyn_cast<SCEVAddRecExpr>( 1414 SE->getAddRecExpr(PreStart, Step, L, SCEV::FlagAnyWrap)); 1415 1416 // "{S,+,X} is <nsw>/<nuw>" and "the backedge is taken at least once" implies 1417 // "S+X does not sign/unsign-overflow". 1418 // 1419 1420 const SCEV *BECount = SE->getBackedgeTakenCount(L); 1421 if (PreAR && PreAR->getNoWrapFlags(WrapType) && 1422 !isa<SCEVCouldNotCompute>(BECount) && SE->isKnownPositive(BECount)) 1423 return PreStart; 1424 1425 // 2. Direct overflow check on the step operation's expression. 1426 unsigned BitWidth = SE->getTypeSizeInBits(AR->getType()); 1427 Type *WideTy = IntegerType::get(SE->getContext(), BitWidth * 2); 1428 const SCEV *OperandExtendedStart = 1429 SE->getAddExpr((SE->*GetExtendExpr)(PreStart, WideTy, Depth), 1430 (SE->*GetExtendExpr)(Step, WideTy, Depth)); 1431 if ((SE->*GetExtendExpr)(Start, WideTy, Depth) == OperandExtendedStart) { 1432 if (PreAR && AR->getNoWrapFlags(WrapType)) { 1433 // If we know `AR` == {`PreStart`+`Step`,+,`Step`} is `WrapType` (FlagNSW 1434 // or FlagNUW) and that `PreStart` + `Step` is `WrapType` too, then 1435 // `PreAR` == {`PreStart`,+,`Step`} is also `WrapType`. Cache this fact. 1436 SE->setNoWrapFlags(const_cast<SCEVAddRecExpr *>(PreAR), WrapType); 1437 } 1438 return PreStart; 1439 } 1440 1441 // 3. Loop precondition. 1442 ICmpInst::Predicate Pred; 1443 const SCEV *OverflowLimit = 1444 ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(Step, &Pred, SE); 1445 1446 if (OverflowLimit && 1447 SE->isLoopEntryGuardedByCond(L, Pred, PreStart, OverflowLimit)) 1448 return PreStart; 1449 1450 return nullptr; 1451 } 1452 1453 // Get the normalized zero or sign extended expression for this AddRec's Start. 1454 template <typename ExtendOpTy> 1455 static const SCEV *getExtendAddRecStart(const SCEVAddRecExpr *AR, Type *Ty, 1456 ScalarEvolution *SE, 1457 unsigned Depth) { 1458 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr; 1459 1460 const SCEV *PreStart = getPreStartForExtend<ExtendOpTy>(AR, Ty, SE, Depth); 1461 if (!PreStart) 1462 return (SE->*GetExtendExpr)(AR->getStart(), Ty, Depth); 1463 1464 return SE->getAddExpr((SE->*GetExtendExpr)(AR->getStepRecurrence(*SE), Ty, 1465 Depth), 1466 (SE->*GetExtendExpr)(PreStart, Ty, Depth)); 1467 } 1468 1469 // Try to prove away overflow by looking at "nearby" add recurrences. A 1470 // motivating example for this rule: if we know `{0,+,4}` is `ult` `-1` and it 1471 // does not itself wrap then we can conclude that `{1,+,4}` is `nuw`. 1472 // 1473 // Formally: 1474 // 1475 // {S,+,X} == {S-T,+,X} + T 1476 // => Ext({S,+,X}) == Ext({S-T,+,X} + T) 1477 // 1478 // If ({S-T,+,X} + T) does not overflow ... (1) 1479 // 1480 // RHS == Ext({S-T,+,X} + T) == Ext({S-T,+,X}) + Ext(T) 1481 // 1482 // If {S-T,+,X} does not overflow ... (2) 1483 // 1484 // RHS == Ext({S-T,+,X}) + Ext(T) == {Ext(S-T),+,Ext(X)} + Ext(T) 1485 // == {Ext(S-T)+Ext(T),+,Ext(X)} 1486 // 1487 // If (S-T)+T does not overflow ... (3) 1488 // 1489 // RHS == {Ext(S-T)+Ext(T),+,Ext(X)} == {Ext(S-T+T),+,Ext(X)} 1490 // == {Ext(S),+,Ext(X)} == LHS 1491 // 1492 // Thus, if (1), (2) and (3) are true for some T, then 1493 // Ext({S,+,X}) == {Ext(S),+,Ext(X)} 1494 // 1495 // (3) is implied by (1) -- "(S-T)+T does not overflow" is simply "({S-T,+,X}+T) 1496 // does not overflow" restricted to the 0th iteration. Therefore we only need 1497 // to check for (1) and (2). 1498 // 1499 // In the current context, S is `Start`, X is `Step`, Ext is `ExtendOpTy` and T 1500 // is `Delta` (defined below). 1501 template <typename ExtendOpTy> 1502 bool ScalarEvolution::proveNoWrapByVaryingStart(const SCEV *Start, 1503 const SCEV *Step, 1504 const Loop *L) { 1505 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType; 1506 1507 // We restrict `Start` to a constant to prevent SCEV from spending too much 1508 // time here. It is correct (but more expensive) to continue with a 1509 // non-constant `Start` and do a general SCEV subtraction to compute 1510 // `PreStart` below. 1511 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start); 1512 if (!StartC) 1513 return false; 1514 1515 APInt StartAI = StartC->getAPInt(); 1516 1517 for (unsigned Delta : {-2, -1, 1, 2}) { 1518 const SCEV *PreStart = getConstant(StartAI - Delta); 1519 1520 FoldingSetNodeID ID; 1521 ID.AddInteger(scAddRecExpr); 1522 ID.AddPointer(PreStart); 1523 ID.AddPointer(Step); 1524 ID.AddPointer(L); 1525 void *IP = nullptr; 1526 const auto *PreAR = 1527 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 1528 1529 // Give up if we don't already have the add recurrence we need because 1530 // actually constructing an add recurrence is relatively expensive. 1531 if (PreAR && PreAR->getNoWrapFlags(WrapType)) { // proves (2) 1532 const SCEV *DeltaS = getConstant(StartC->getType(), Delta); 1533 ICmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE; 1534 const SCEV *Limit = ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep( 1535 DeltaS, &Pred, this); 1536 if (Limit && isKnownPredicate(Pred, PreAR, Limit)) // proves (1) 1537 return true; 1538 } 1539 } 1540 1541 return false; 1542 } 1543 1544 // Finds an integer D for an expression (C + x + y + ...) such that the top 1545 // level addition in (D + (C - D + x + y + ...)) would not wrap (signed or 1546 // unsigned) and the number of trailing zeros of (C - D + x + y + ...) is 1547 // maximized, where C is the \p ConstantTerm, x, y, ... are arbitrary SCEVs, and 1548 // the (C + x + y + ...) expression is \p WholeAddExpr. 1549 static APInt extractConstantWithoutWrapping(ScalarEvolution &SE, 1550 const SCEVConstant *ConstantTerm, 1551 const SCEVAddExpr *WholeAddExpr) { 1552 const APInt &C = ConstantTerm->getAPInt(); 1553 const unsigned BitWidth = C.getBitWidth(); 1554 // Find number of trailing zeros of (x + y + ...) w/o the C first: 1555 uint32_t TZ = BitWidth; 1556 for (unsigned I = 1, E = WholeAddExpr->getNumOperands(); I < E && TZ; ++I) 1557 TZ = std::min(TZ, SE.GetMinTrailingZeros(WholeAddExpr->getOperand(I))); 1558 if (TZ) { 1559 // Set D to be as many least significant bits of C as possible while still 1560 // guaranteeing that adding D to (C - D + x + y + ...) won't cause a wrap: 1561 return TZ < BitWidth ? C.trunc(TZ).zext(BitWidth) : C; 1562 } 1563 return APInt(BitWidth, 0); 1564 } 1565 1566 // Finds an integer D for an affine AddRec expression {C,+,x} such that the top 1567 // level addition in (D + {C-D,+,x}) would not wrap (signed or unsigned) and the 1568 // number of trailing zeros of (C - D + x * n) is maximized, where C is the \p 1569 // ConstantStart, x is an arbitrary \p Step, and n is the loop trip count. 1570 static APInt extractConstantWithoutWrapping(ScalarEvolution &SE, 1571 const APInt &ConstantStart, 1572 const SCEV *Step) { 1573 const unsigned BitWidth = ConstantStart.getBitWidth(); 1574 const uint32_t TZ = SE.GetMinTrailingZeros(Step); 1575 if (TZ) 1576 return TZ < BitWidth ? ConstantStart.trunc(TZ).zext(BitWidth) 1577 : ConstantStart; 1578 return APInt(BitWidth, 0); 1579 } 1580 1581 const SCEV * 1582 ScalarEvolution::getZeroExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) { 1583 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 1584 "This is not an extending conversion!"); 1585 assert(isSCEVable(Ty) && 1586 "This is not a conversion to a SCEVable type!"); 1587 assert(!Op->getType()->isPointerTy() && "Can't extend pointer!"); 1588 Ty = getEffectiveSCEVType(Ty); 1589 1590 // Fold if the operand is constant. 1591 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1592 return getConstant( 1593 cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(), Ty))); 1594 1595 // zext(zext(x)) --> zext(x) 1596 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1597 return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1); 1598 1599 // Before doing any expensive analysis, check to see if we've already 1600 // computed a SCEV for this Op and Ty. 1601 FoldingSetNodeID ID; 1602 ID.AddInteger(scZeroExtend); 1603 ID.AddPointer(Op); 1604 ID.AddPointer(Ty); 1605 void *IP = nullptr; 1606 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1607 if (Depth > MaxCastDepth) { 1608 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator), 1609 Op, Ty); 1610 UniqueSCEVs.InsertNode(S, IP); 1611 registerUser(S, Op); 1612 return S; 1613 } 1614 1615 // zext(trunc(x)) --> zext(x) or x or trunc(x) 1616 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) { 1617 // It's possible the bits taken off by the truncate were all zero bits. If 1618 // so, we should be able to simplify this further. 1619 const SCEV *X = ST->getOperand(); 1620 ConstantRange CR = getUnsignedRange(X); 1621 unsigned TruncBits = getTypeSizeInBits(ST->getType()); 1622 unsigned NewBits = getTypeSizeInBits(Ty); 1623 if (CR.truncate(TruncBits).zeroExtend(NewBits).contains( 1624 CR.zextOrTrunc(NewBits))) 1625 return getTruncateOrZeroExtend(X, Ty, Depth); 1626 } 1627 1628 // If the input value is a chrec scev, and we can prove that the value 1629 // did not overflow the old, smaller, value, we can zero extend all of the 1630 // operands (often constants). This allows analysis of something like 1631 // this: for (unsigned char X = 0; X < 100; ++X) { int Y = X; } 1632 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) 1633 if (AR->isAffine()) { 1634 const SCEV *Start = AR->getStart(); 1635 const SCEV *Step = AR->getStepRecurrence(*this); 1636 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 1637 const Loop *L = AR->getLoop(); 1638 1639 if (!AR->hasNoUnsignedWrap()) { 1640 auto NewFlags = proveNoWrapViaConstantRanges(AR); 1641 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1642 } 1643 1644 // If we have special knowledge that this addrec won't overflow, 1645 // we don't need to do any further analysis. 1646 if (AR->hasNoUnsignedWrap()) 1647 return getAddRecExpr( 1648 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1), 1649 getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 1650 1651 // Check whether the backedge-taken count is SCEVCouldNotCompute. 1652 // Note that this serves two purposes: It filters out loops that are 1653 // simply not analyzable, and it covers the case where this code is 1654 // being called from within backedge-taken count analysis, such that 1655 // attempting to ask for the backedge-taken count would likely result 1656 // in infinite recursion. In the later case, the analysis code will 1657 // cope with a conservative value, and it will take care to purge 1658 // that value once it has finished. 1659 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 1660 if (!isa<SCEVCouldNotCompute>(MaxBECount)) { 1661 // Manually compute the final value for AR, checking for overflow. 1662 1663 // Check whether the backedge-taken count can be losslessly casted to 1664 // the addrec's type. The count is always unsigned. 1665 const SCEV *CastedMaxBECount = 1666 getTruncateOrZeroExtend(MaxBECount, Start->getType(), Depth); 1667 const SCEV *RecastedMaxBECount = getTruncateOrZeroExtend( 1668 CastedMaxBECount, MaxBECount->getType(), Depth); 1669 if (MaxBECount == RecastedMaxBECount) { 1670 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2); 1671 // Check whether Start+Step*MaxBECount has no unsigned overflow. 1672 const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step, 1673 SCEV::FlagAnyWrap, Depth + 1); 1674 const SCEV *ZAdd = getZeroExtendExpr(getAddExpr(Start, ZMul, 1675 SCEV::FlagAnyWrap, 1676 Depth + 1), 1677 WideTy, Depth + 1); 1678 const SCEV *WideStart = getZeroExtendExpr(Start, WideTy, Depth + 1); 1679 const SCEV *WideMaxBECount = 1680 getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1); 1681 const SCEV *OperandExtendedAdd = 1682 getAddExpr(WideStart, 1683 getMulExpr(WideMaxBECount, 1684 getZeroExtendExpr(Step, WideTy, Depth + 1), 1685 SCEV::FlagAnyWrap, Depth + 1), 1686 SCEV::FlagAnyWrap, Depth + 1); 1687 if (ZAdd == OperandExtendedAdd) { 1688 // Cache knowledge of AR NUW, which is propagated to this AddRec. 1689 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNUW); 1690 // Return the expression with the addrec on the outside. 1691 return getAddRecExpr( 1692 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1693 Depth + 1), 1694 getZeroExtendExpr(Step, Ty, Depth + 1), L, 1695 AR->getNoWrapFlags()); 1696 } 1697 // Similar to above, only this time treat the step value as signed. 1698 // This covers loops that count down. 1699 OperandExtendedAdd = 1700 getAddExpr(WideStart, 1701 getMulExpr(WideMaxBECount, 1702 getSignExtendExpr(Step, WideTy, Depth + 1), 1703 SCEV::FlagAnyWrap, Depth + 1), 1704 SCEV::FlagAnyWrap, Depth + 1); 1705 if (ZAdd == OperandExtendedAdd) { 1706 // Cache knowledge of AR NW, which is propagated to this AddRec. 1707 // Negative step causes unsigned wrap, but it still can't self-wrap. 1708 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 1709 // Return the expression with the addrec on the outside. 1710 return getAddRecExpr( 1711 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1712 Depth + 1), 1713 getSignExtendExpr(Step, Ty, Depth + 1), L, 1714 AR->getNoWrapFlags()); 1715 } 1716 } 1717 } 1718 1719 // Normally, in the cases we can prove no-overflow via a 1720 // backedge guarding condition, we can also compute a backedge 1721 // taken count for the loop. The exceptions are assumptions and 1722 // guards present in the loop -- SCEV is not great at exploiting 1723 // these to compute max backedge taken counts, but can still use 1724 // these to prove lack of overflow. Use this fact to avoid 1725 // doing extra work that may not pay off. 1726 if (!isa<SCEVCouldNotCompute>(MaxBECount) || HasGuards || 1727 !AC.assumptions().empty()) { 1728 1729 auto NewFlags = proveNoUnsignedWrapViaInduction(AR); 1730 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1731 if (AR->hasNoUnsignedWrap()) { 1732 // Same as nuw case above - duplicated here to avoid a compile time 1733 // issue. It's not clear that the order of checks does matter, but 1734 // it's one of two issue possible causes for a change which was 1735 // reverted. Be conservative for the moment. 1736 return getAddRecExpr( 1737 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1738 Depth + 1), 1739 getZeroExtendExpr(Step, Ty, Depth + 1), L, 1740 AR->getNoWrapFlags()); 1741 } 1742 1743 // For a negative step, we can extend the operands iff doing so only 1744 // traverses values in the range zext([0,UINT_MAX]). 1745 if (isKnownNegative(Step)) { 1746 const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) - 1747 getSignedRangeMin(Step)); 1748 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) || 1749 isKnownOnEveryIteration(ICmpInst::ICMP_UGT, AR, N)) { 1750 // Cache knowledge of AR NW, which is propagated to this 1751 // AddRec. Negative step causes unsigned wrap, but it 1752 // still can't self-wrap. 1753 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 1754 // Return the expression with the addrec on the outside. 1755 return getAddRecExpr( 1756 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1757 Depth + 1), 1758 getSignExtendExpr(Step, Ty, Depth + 1), L, 1759 AR->getNoWrapFlags()); 1760 } 1761 } 1762 } 1763 1764 // zext({C,+,Step}) --> (zext(D) + zext({C-D,+,Step}))<nuw><nsw> 1765 // if D + (C - D + Step * n) could be proven to not unsigned wrap 1766 // where D maximizes the number of trailing zeros of (C - D + Step * n) 1767 if (const auto *SC = dyn_cast<SCEVConstant>(Start)) { 1768 const APInt &C = SC->getAPInt(); 1769 const APInt &D = extractConstantWithoutWrapping(*this, C, Step); 1770 if (D != 0) { 1771 const SCEV *SZExtD = getZeroExtendExpr(getConstant(D), Ty, Depth); 1772 const SCEV *SResidual = 1773 getAddRecExpr(getConstant(C - D), Step, L, AR->getNoWrapFlags()); 1774 const SCEV *SZExtR = getZeroExtendExpr(SResidual, Ty, Depth + 1); 1775 return getAddExpr(SZExtD, SZExtR, 1776 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1777 Depth + 1); 1778 } 1779 } 1780 1781 if (proveNoWrapByVaryingStart<SCEVZeroExtendExpr>(Start, Step, L)) { 1782 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNUW); 1783 return getAddRecExpr( 1784 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1), 1785 getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 1786 } 1787 } 1788 1789 // zext(A % B) --> zext(A) % zext(B) 1790 { 1791 const SCEV *LHS; 1792 const SCEV *RHS; 1793 if (matchURem(Op, LHS, RHS)) 1794 return getURemExpr(getZeroExtendExpr(LHS, Ty, Depth + 1), 1795 getZeroExtendExpr(RHS, Ty, Depth + 1)); 1796 } 1797 1798 // zext(A / B) --> zext(A) / zext(B). 1799 if (auto *Div = dyn_cast<SCEVUDivExpr>(Op)) 1800 return getUDivExpr(getZeroExtendExpr(Div->getLHS(), Ty, Depth + 1), 1801 getZeroExtendExpr(Div->getRHS(), Ty, Depth + 1)); 1802 1803 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) { 1804 // zext((A + B + ...)<nuw>) --> (zext(A) + zext(B) + ...)<nuw> 1805 if (SA->hasNoUnsignedWrap()) { 1806 // If the addition does not unsign overflow then we can, by definition, 1807 // commute the zero extension with the addition operation. 1808 SmallVector<const SCEV *, 4> Ops; 1809 for (const auto *Op : SA->operands()) 1810 Ops.push_back(getZeroExtendExpr(Op, Ty, Depth + 1)); 1811 return getAddExpr(Ops, SCEV::FlagNUW, Depth + 1); 1812 } 1813 1814 // zext(C + x + y + ...) --> (zext(D) + zext((C - D) + x + y + ...)) 1815 // if D + (C - D + x + y + ...) could be proven to not unsigned wrap 1816 // where D maximizes the number of trailing zeros of (C - D + x + y + ...) 1817 // 1818 // Often address arithmetics contain expressions like 1819 // (zext (add (shl X, C1), C2)), for instance, (zext (5 + (4 * X))). 1820 // This transformation is useful while proving that such expressions are 1821 // equal or differ by a small constant amount, see LoadStoreVectorizer pass. 1822 if (const auto *SC = dyn_cast<SCEVConstant>(SA->getOperand(0))) { 1823 const APInt &D = extractConstantWithoutWrapping(*this, SC, SA); 1824 if (D != 0) { 1825 const SCEV *SZExtD = getZeroExtendExpr(getConstant(D), Ty, Depth); 1826 const SCEV *SResidual = 1827 getAddExpr(getConstant(-D), SA, SCEV::FlagAnyWrap, Depth); 1828 const SCEV *SZExtR = getZeroExtendExpr(SResidual, Ty, Depth + 1); 1829 return getAddExpr(SZExtD, SZExtR, 1830 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1831 Depth + 1); 1832 } 1833 } 1834 } 1835 1836 if (auto *SM = dyn_cast<SCEVMulExpr>(Op)) { 1837 // zext((A * B * ...)<nuw>) --> (zext(A) * zext(B) * ...)<nuw> 1838 if (SM->hasNoUnsignedWrap()) { 1839 // If the multiply does not unsign overflow then we can, by definition, 1840 // commute the zero extension with the multiply operation. 1841 SmallVector<const SCEV *, 4> Ops; 1842 for (const auto *Op : SM->operands()) 1843 Ops.push_back(getZeroExtendExpr(Op, Ty, Depth + 1)); 1844 return getMulExpr(Ops, SCEV::FlagNUW, Depth + 1); 1845 } 1846 1847 // zext(2^K * (trunc X to iN)) to iM -> 1848 // 2^K * (zext(trunc X to i{N-K}) to iM)<nuw> 1849 // 1850 // Proof: 1851 // 1852 // zext(2^K * (trunc X to iN)) to iM 1853 // = zext((trunc X to iN) << K) to iM 1854 // = zext((trunc X to i{N-K}) << K)<nuw> to iM 1855 // (because shl removes the top K bits) 1856 // = zext((2^K * (trunc X to i{N-K}))<nuw>) to iM 1857 // = (2^K * (zext(trunc X to i{N-K}) to iM))<nuw>. 1858 // 1859 if (SM->getNumOperands() == 2) 1860 if (auto *MulLHS = dyn_cast<SCEVConstant>(SM->getOperand(0))) 1861 if (MulLHS->getAPInt().isPowerOf2()) 1862 if (auto *TruncRHS = dyn_cast<SCEVTruncateExpr>(SM->getOperand(1))) { 1863 int NewTruncBits = getTypeSizeInBits(TruncRHS->getType()) - 1864 MulLHS->getAPInt().logBase2(); 1865 Type *NewTruncTy = IntegerType::get(getContext(), NewTruncBits); 1866 return getMulExpr( 1867 getZeroExtendExpr(MulLHS, Ty), 1868 getZeroExtendExpr( 1869 getTruncateExpr(TruncRHS->getOperand(), NewTruncTy), Ty), 1870 SCEV::FlagNUW, Depth + 1); 1871 } 1872 } 1873 1874 // The cast wasn't folded; create an explicit cast node. 1875 // Recompute the insert position, as it may have been invalidated. 1876 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1877 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator), 1878 Op, Ty); 1879 UniqueSCEVs.InsertNode(S, IP); 1880 registerUser(S, Op); 1881 return S; 1882 } 1883 1884 const SCEV * 1885 ScalarEvolution::getSignExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) { 1886 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 1887 "This is not an extending conversion!"); 1888 assert(isSCEVable(Ty) && 1889 "This is not a conversion to a SCEVable type!"); 1890 assert(!Op->getType()->isPointerTy() && "Can't extend pointer!"); 1891 Ty = getEffectiveSCEVType(Ty); 1892 1893 // Fold if the operand is constant. 1894 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1895 return getConstant( 1896 cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(), Ty))); 1897 1898 // sext(sext(x)) --> sext(x) 1899 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op)) 1900 return getSignExtendExpr(SS->getOperand(), Ty, Depth + 1); 1901 1902 // sext(zext(x)) --> zext(x) 1903 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1904 return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1); 1905 1906 // Before doing any expensive analysis, check to see if we've already 1907 // computed a SCEV for this Op and Ty. 1908 FoldingSetNodeID ID; 1909 ID.AddInteger(scSignExtend); 1910 ID.AddPointer(Op); 1911 ID.AddPointer(Ty); 1912 void *IP = nullptr; 1913 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1914 // Limit recursion depth. 1915 if (Depth > MaxCastDepth) { 1916 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator), 1917 Op, Ty); 1918 UniqueSCEVs.InsertNode(S, IP); 1919 registerUser(S, Op); 1920 return S; 1921 } 1922 1923 // sext(trunc(x)) --> sext(x) or x or trunc(x) 1924 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) { 1925 // It's possible the bits taken off by the truncate were all sign bits. If 1926 // so, we should be able to simplify this further. 1927 const SCEV *X = ST->getOperand(); 1928 ConstantRange CR = getSignedRange(X); 1929 unsigned TruncBits = getTypeSizeInBits(ST->getType()); 1930 unsigned NewBits = getTypeSizeInBits(Ty); 1931 if (CR.truncate(TruncBits).signExtend(NewBits).contains( 1932 CR.sextOrTrunc(NewBits))) 1933 return getTruncateOrSignExtend(X, Ty, Depth); 1934 } 1935 1936 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) { 1937 // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw> 1938 if (SA->hasNoSignedWrap()) { 1939 // If the addition does not sign overflow then we can, by definition, 1940 // commute the sign extension with the addition operation. 1941 SmallVector<const SCEV *, 4> Ops; 1942 for (const auto *Op : SA->operands()) 1943 Ops.push_back(getSignExtendExpr(Op, Ty, Depth + 1)); 1944 return getAddExpr(Ops, SCEV::FlagNSW, Depth + 1); 1945 } 1946 1947 // sext(C + x + y + ...) --> (sext(D) + sext((C - D) + x + y + ...)) 1948 // if D + (C - D + x + y + ...) could be proven to not signed wrap 1949 // where D maximizes the number of trailing zeros of (C - D + x + y + ...) 1950 // 1951 // For instance, this will bring two seemingly different expressions: 1952 // 1 + sext(5 + 20 * %x + 24 * %y) and 1953 // sext(6 + 20 * %x + 24 * %y) 1954 // to the same form: 1955 // 2 + sext(4 + 20 * %x + 24 * %y) 1956 if (const auto *SC = dyn_cast<SCEVConstant>(SA->getOperand(0))) { 1957 const APInt &D = extractConstantWithoutWrapping(*this, SC, SA); 1958 if (D != 0) { 1959 const SCEV *SSExtD = getSignExtendExpr(getConstant(D), Ty, Depth); 1960 const SCEV *SResidual = 1961 getAddExpr(getConstant(-D), SA, SCEV::FlagAnyWrap, Depth); 1962 const SCEV *SSExtR = getSignExtendExpr(SResidual, Ty, Depth + 1); 1963 return getAddExpr(SSExtD, SSExtR, 1964 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1965 Depth + 1); 1966 } 1967 } 1968 } 1969 // If the input value is a chrec scev, and we can prove that the value 1970 // did not overflow the old, smaller, value, we can sign extend all of the 1971 // operands (often constants). This allows analysis of something like 1972 // this: for (signed char X = 0; X < 100; ++X) { int Y = X; } 1973 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) 1974 if (AR->isAffine()) { 1975 const SCEV *Start = AR->getStart(); 1976 const SCEV *Step = AR->getStepRecurrence(*this); 1977 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 1978 const Loop *L = AR->getLoop(); 1979 1980 if (!AR->hasNoSignedWrap()) { 1981 auto NewFlags = proveNoWrapViaConstantRanges(AR); 1982 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1983 } 1984 1985 // If we have special knowledge that this addrec won't overflow, 1986 // we don't need to do any further analysis. 1987 if (AR->hasNoSignedWrap()) 1988 return getAddRecExpr( 1989 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 1990 getSignExtendExpr(Step, Ty, Depth + 1), L, SCEV::FlagNSW); 1991 1992 // Check whether the backedge-taken count is SCEVCouldNotCompute. 1993 // Note that this serves two purposes: It filters out loops that are 1994 // simply not analyzable, and it covers the case where this code is 1995 // being called from within backedge-taken count analysis, such that 1996 // attempting to ask for the backedge-taken count would likely result 1997 // in infinite recursion. In the later case, the analysis code will 1998 // cope with a conservative value, and it will take care to purge 1999 // that value once it has finished. 2000 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 2001 if (!isa<SCEVCouldNotCompute>(MaxBECount)) { 2002 // Manually compute the final value for AR, checking for 2003 // overflow. 2004 2005 // Check whether the backedge-taken count can be losslessly casted to 2006 // the addrec's type. The count is always unsigned. 2007 const SCEV *CastedMaxBECount = 2008 getTruncateOrZeroExtend(MaxBECount, Start->getType(), Depth); 2009 const SCEV *RecastedMaxBECount = getTruncateOrZeroExtend( 2010 CastedMaxBECount, MaxBECount->getType(), Depth); 2011 if (MaxBECount == RecastedMaxBECount) { 2012 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2); 2013 // Check whether Start+Step*MaxBECount has no signed overflow. 2014 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step, 2015 SCEV::FlagAnyWrap, Depth + 1); 2016 const SCEV *SAdd = getSignExtendExpr(getAddExpr(Start, SMul, 2017 SCEV::FlagAnyWrap, 2018 Depth + 1), 2019 WideTy, Depth + 1); 2020 const SCEV *WideStart = getSignExtendExpr(Start, WideTy, Depth + 1); 2021 const SCEV *WideMaxBECount = 2022 getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1); 2023 const SCEV *OperandExtendedAdd = 2024 getAddExpr(WideStart, 2025 getMulExpr(WideMaxBECount, 2026 getSignExtendExpr(Step, WideTy, Depth + 1), 2027 SCEV::FlagAnyWrap, Depth + 1), 2028 SCEV::FlagAnyWrap, Depth + 1); 2029 if (SAdd == OperandExtendedAdd) { 2030 // Cache knowledge of AR NSW, which is propagated to this AddRec. 2031 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNSW); 2032 // Return the expression with the addrec on the outside. 2033 return getAddRecExpr( 2034 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, 2035 Depth + 1), 2036 getSignExtendExpr(Step, Ty, Depth + 1), L, 2037 AR->getNoWrapFlags()); 2038 } 2039 // Similar to above, only this time treat the step value as unsigned. 2040 // This covers loops that count up with an unsigned step. 2041 OperandExtendedAdd = 2042 getAddExpr(WideStart, 2043 getMulExpr(WideMaxBECount, 2044 getZeroExtendExpr(Step, WideTy, Depth + 1), 2045 SCEV::FlagAnyWrap, Depth + 1), 2046 SCEV::FlagAnyWrap, Depth + 1); 2047 if (SAdd == OperandExtendedAdd) { 2048 // If AR wraps around then 2049 // 2050 // abs(Step) * MaxBECount > unsigned-max(AR->getType()) 2051 // => SAdd != OperandExtendedAdd 2052 // 2053 // Thus (AR is not NW => SAdd != OperandExtendedAdd) <=> 2054 // (SAdd == OperandExtendedAdd => AR is NW) 2055 2056 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 2057 2058 // Return the expression with the addrec on the outside. 2059 return getAddRecExpr( 2060 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, 2061 Depth + 1), 2062 getZeroExtendExpr(Step, Ty, Depth + 1), L, 2063 AR->getNoWrapFlags()); 2064 } 2065 } 2066 } 2067 2068 auto NewFlags = proveNoSignedWrapViaInduction(AR); 2069 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 2070 if (AR->hasNoSignedWrap()) { 2071 // Same as nsw case above - duplicated here to avoid a compile time 2072 // issue. It's not clear that the order of checks does matter, but 2073 // it's one of two issue possible causes for a change which was 2074 // reverted. Be conservative for the moment. 2075 return getAddRecExpr( 2076 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 2077 getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 2078 } 2079 2080 // sext({C,+,Step}) --> (sext(D) + sext({C-D,+,Step}))<nuw><nsw> 2081 // if D + (C - D + Step * n) could be proven to not signed wrap 2082 // where D maximizes the number of trailing zeros of (C - D + Step * n) 2083 if (const auto *SC = dyn_cast<SCEVConstant>(Start)) { 2084 const APInt &C = SC->getAPInt(); 2085 const APInt &D = extractConstantWithoutWrapping(*this, C, Step); 2086 if (D != 0) { 2087 const SCEV *SSExtD = getSignExtendExpr(getConstant(D), Ty, Depth); 2088 const SCEV *SResidual = 2089 getAddRecExpr(getConstant(C - D), Step, L, AR->getNoWrapFlags()); 2090 const SCEV *SSExtR = getSignExtendExpr(SResidual, Ty, Depth + 1); 2091 return getAddExpr(SSExtD, SSExtR, 2092 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 2093 Depth + 1); 2094 } 2095 } 2096 2097 if (proveNoWrapByVaryingStart<SCEVSignExtendExpr>(Start, Step, L)) { 2098 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNSW); 2099 return getAddRecExpr( 2100 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 2101 getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 2102 } 2103 } 2104 2105 // If the input value is provably positive and we could not simplify 2106 // away the sext build a zext instead. 2107 if (isKnownNonNegative(Op)) 2108 return getZeroExtendExpr(Op, Ty, Depth + 1); 2109 2110 // The cast wasn't folded; create an explicit cast node. 2111 // Recompute the insert position, as it may have been invalidated. 2112 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 2113 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator), 2114 Op, Ty); 2115 UniqueSCEVs.InsertNode(S, IP); 2116 registerUser(S, { Op }); 2117 return S; 2118 } 2119 2120 const SCEV *ScalarEvolution::getCastExpr(SCEVTypes Kind, const SCEV *Op, 2121 Type *Ty) { 2122 switch (Kind) { 2123 case scTruncate: 2124 return getTruncateExpr(Op, Ty); 2125 case scZeroExtend: 2126 return getZeroExtendExpr(Op, Ty); 2127 case scSignExtend: 2128 return getSignExtendExpr(Op, Ty); 2129 case scPtrToInt: 2130 return getPtrToIntExpr(Op, Ty); 2131 default: 2132 llvm_unreachable("Not a SCEV cast expression!"); 2133 } 2134 } 2135 2136 /// getAnyExtendExpr - Return a SCEV for the given operand extended with 2137 /// unspecified bits out to the given type. 2138 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op, 2139 Type *Ty) { 2140 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 2141 "This is not an extending conversion!"); 2142 assert(isSCEVable(Ty) && 2143 "This is not a conversion to a SCEVable type!"); 2144 Ty = getEffectiveSCEVType(Ty); 2145 2146 // Sign-extend negative constants. 2147 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 2148 if (SC->getAPInt().isNegative()) 2149 return getSignExtendExpr(Op, Ty); 2150 2151 // Peel off a truncate cast. 2152 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) { 2153 const SCEV *NewOp = T->getOperand(); 2154 if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty)) 2155 return getAnyExtendExpr(NewOp, Ty); 2156 return getTruncateOrNoop(NewOp, Ty); 2157 } 2158 2159 // Next try a zext cast. If the cast is folded, use it. 2160 const SCEV *ZExt = getZeroExtendExpr(Op, Ty); 2161 if (!isa<SCEVZeroExtendExpr>(ZExt)) 2162 return ZExt; 2163 2164 // Next try a sext cast. If the cast is folded, use it. 2165 const SCEV *SExt = getSignExtendExpr(Op, Ty); 2166 if (!isa<SCEVSignExtendExpr>(SExt)) 2167 return SExt; 2168 2169 // Force the cast to be folded into the operands of an addrec. 2170 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) { 2171 SmallVector<const SCEV *, 4> Ops; 2172 for (const SCEV *Op : AR->operands()) 2173 Ops.push_back(getAnyExtendExpr(Op, Ty)); 2174 return getAddRecExpr(Ops, AR->getLoop(), SCEV::FlagNW); 2175 } 2176 2177 // If the expression is obviously signed, use the sext cast value. 2178 if (isa<SCEVSMaxExpr>(Op)) 2179 return SExt; 2180 2181 // Absent any other information, use the zext cast value. 2182 return ZExt; 2183 } 2184 2185 /// Process the given Ops list, which is a list of operands to be added under 2186 /// the given scale, update the given map. This is a helper function for 2187 /// getAddRecExpr. As an example of what it does, given a sequence of operands 2188 /// that would form an add expression like this: 2189 /// 2190 /// m + n + 13 + (A * (o + p + (B * (q + m + 29)))) + r + (-1 * r) 2191 /// 2192 /// where A and B are constants, update the map with these values: 2193 /// 2194 /// (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0) 2195 /// 2196 /// and add 13 + A*B*29 to AccumulatedConstant. 2197 /// This will allow getAddRecExpr to produce this: 2198 /// 2199 /// 13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B) 2200 /// 2201 /// This form often exposes folding opportunities that are hidden in 2202 /// the original operand list. 2203 /// 2204 /// Return true iff it appears that any interesting folding opportunities 2205 /// may be exposed. This helps getAddRecExpr short-circuit extra work in 2206 /// the common case where no interesting opportunities are present, and 2207 /// is also used as a check to avoid infinite recursion. 2208 static bool 2209 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M, 2210 SmallVectorImpl<const SCEV *> &NewOps, 2211 APInt &AccumulatedConstant, 2212 const SCEV *const *Ops, size_t NumOperands, 2213 const APInt &Scale, 2214 ScalarEvolution &SE) { 2215 bool Interesting = false; 2216 2217 // Iterate over the add operands. They are sorted, with constants first. 2218 unsigned i = 0; 2219 while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) { 2220 ++i; 2221 // Pull a buried constant out to the outside. 2222 if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero()) 2223 Interesting = true; 2224 AccumulatedConstant += Scale * C->getAPInt(); 2225 } 2226 2227 // Next comes everything else. We're especially interested in multiplies 2228 // here, but they're in the middle, so just visit the rest with one loop. 2229 for (; i != NumOperands; ++i) { 2230 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]); 2231 if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) { 2232 APInt NewScale = 2233 Scale * cast<SCEVConstant>(Mul->getOperand(0))->getAPInt(); 2234 if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) { 2235 // A multiplication of a constant with another add; recurse. 2236 const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1)); 2237 Interesting |= 2238 CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant, 2239 Add->op_begin(), Add->getNumOperands(), 2240 NewScale, SE); 2241 } else { 2242 // A multiplication of a constant with some other value. Update 2243 // the map. 2244 SmallVector<const SCEV *, 4> MulOps(drop_begin(Mul->operands())); 2245 const SCEV *Key = SE.getMulExpr(MulOps); 2246 auto Pair = M.insert({Key, NewScale}); 2247 if (Pair.second) { 2248 NewOps.push_back(Pair.first->first); 2249 } else { 2250 Pair.first->second += NewScale; 2251 // The map already had an entry for this value, which may indicate 2252 // a folding opportunity. 2253 Interesting = true; 2254 } 2255 } 2256 } else { 2257 // An ordinary operand. Update the map. 2258 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair = 2259 M.insert({Ops[i], Scale}); 2260 if (Pair.second) { 2261 NewOps.push_back(Pair.first->first); 2262 } else { 2263 Pair.first->second += Scale; 2264 // The map already had an entry for this value, which may indicate 2265 // a folding opportunity. 2266 Interesting = true; 2267 } 2268 } 2269 } 2270 2271 return Interesting; 2272 } 2273 2274 bool ScalarEvolution::willNotOverflow(Instruction::BinaryOps BinOp, bool Signed, 2275 const SCEV *LHS, const SCEV *RHS) { 2276 const SCEV *(ScalarEvolution::*Operation)(const SCEV *, const SCEV *, 2277 SCEV::NoWrapFlags, unsigned); 2278 switch (BinOp) { 2279 default: 2280 llvm_unreachable("Unsupported binary op"); 2281 case Instruction::Add: 2282 Operation = &ScalarEvolution::getAddExpr; 2283 break; 2284 case Instruction::Sub: 2285 Operation = &ScalarEvolution::getMinusSCEV; 2286 break; 2287 case Instruction::Mul: 2288 Operation = &ScalarEvolution::getMulExpr; 2289 break; 2290 } 2291 2292 const SCEV *(ScalarEvolution::*Extension)(const SCEV *, Type *, unsigned) = 2293 Signed ? &ScalarEvolution::getSignExtendExpr 2294 : &ScalarEvolution::getZeroExtendExpr; 2295 2296 // Check ext(LHS op RHS) == ext(LHS) op ext(RHS) 2297 auto *NarrowTy = cast<IntegerType>(LHS->getType()); 2298 auto *WideTy = 2299 IntegerType::get(NarrowTy->getContext(), NarrowTy->getBitWidth() * 2); 2300 2301 const SCEV *A = (this->*Extension)( 2302 (this->*Operation)(LHS, RHS, SCEV::FlagAnyWrap, 0), WideTy, 0); 2303 const SCEV *B = (this->*Operation)((this->*Extension)(LHS, WideTy, 0), 2304 (this->*Extension)(RHS, WideTy, 0), 2305 SCEV::FlagAnyWrap, 0); 2306 return A == B; 2307 } 2308 2309 std::pair<SCEV::NoWrapFlags, bool /*Deduced*/> 2310 ScalarEvolution::getStrengthenedNoWrapFlagsFromBinOp( 2311 const OverflowingBinaryOperator *OBO) { 2312 SCEV::NoWrapFlags Flags = SCEV::NoWrapFlags::FlagAnyWrap; 2313 2314 if (OBO->hasNoUnsignedWrap()) 2315 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2316 if (OBO->hasNoSignedWrap()) 2317 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 2318 2319 bool Deduced = false; 2320 2321 if (OBO->hasNoUnsignedWrap() && OBO->hasNoSignedWrap()) 2322 return {Flags, Deduced}; 2323 2324 if (OBO->getOpcode() != Instruction::Add && 2325 OBO->getOpcode() != Instruction::Sub && 2326 OBO->getOpcode() != Instruction::Mul) 2327 return {Flags, Deduced}; 2328 2329 const SCEV *LHS = getSCEV(OBO->getOperand(0)); 2330 const SCEV *RHS = getSCEV(OBO->getOperand(1)); 2331 2332 if (!OBO->hasNoUnsignedWrap() && 2333 willNotOverflow((Instruction::BinaryOps)OBO->getOpcode(), 2334 /* Signed */ false, LHS, RHS)) { 2335 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2336 Deduced = true; 2337 } 2338 2339 if (!OBO->hasNoSignedWrap() && 2340 willNotOverflow((Instruction::BinaryOps)OBO->getOpcode(), 2341 /* Signed */ true, LHS, RHS)) { 2342 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 2343 Deduced = true; 2344 } 2345 2346 return {Flags, Deduced}; 2347 } 2348 2349 // We're trying to construct a SCEV of type `Type' with `Ops' as operands and 2350 // `OldFlags' as can't-wrap behavior. Infer a more aggressive set of 2351 // can't-overflow flags for the operation if possible. 2352 static SCEV::NoWrapFlags 2353 StrengthenNoWrapFlags(ScalarEvolution *SE, SCEVTypes Type, 2354 const ArrayRef<const SCEV *> Ops, 2355 SCEV::NoWrapFlags Flags) { 2356 using namespace std::placeholders; 2357 2358 using OBO = OverflowingBinaryOperator; 2359 2360 bool CanAnalyze = 2361 Type == scAddExpr || Type == scAddRecExpr || Type == scMulExpr; 2362 (void)CanAnalyze; 2363 assert(CanAnalyze && "don't call from other places!"); 2364 2365 int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW; 2366 SCEV::NoWrapFlags SignOrUnsignWrap = 2367 ScalarEvolution::maskFlags(Flags, SignOrUnsignMask); 2368 2369 // If FlagNSW is true and all the operands are non-negative, infer FlagNUW. 2370 auto IsKnownNonNegative = [&](const SCEV *S) { 2371 return SE->isKnownNonNegative(S); 2372 }; 2373 2374 if (SignOrUnsignWrap == SCEV::FlagNSW && all_of(Ops, IsKnownNonNegative)) 2375 Flags = 2376 ScalarEvolution::setFlags(Flags, (SCEV::NoWrapFlags)SignOrUnsignMask); 2377 2378 SignOrUnsignWrap = ScalarEvolution::maskFlags(Flags, SignOrUnsignMask); 2379 2380 if (SignOrUnsignWrap != SignOrUnsignMask && 2381 (Type == scAddExpr || Type == scMulExpr) && Ops.size() == 2 && 2382 isa<SCEVConstant>(Ops[0])) { 2383 2384 auto Opcode = [&] { 2385 switch (Type) { 2386 case scAddExpr: 2387 return Instruction::Add; 2388 case scMulExpr: 2389 return Instruction::Mul; 2390 default: 2391 llvm_unreachable("Unexpected SCEV op."); 2392 } 2393 }(); 2394 2395 const APInt &C = cast<SCEVConstant>(Ops[0])->getAPInt(); 2396 2397 // (A <opcode> C) --> (A <opcode> C)<nsw> if the op doesn't sign overflow. 2398 if (!(SignOrUnsignWrap & SCEV::FlagNSW)) { 2399 auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 2400 Opcode, C, OBO::NoSignedWrap); 2401 if (NSWRegion.contains(SE->getSignedRange(Ops[1]))) 2402 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 2403 } 2404 2405 // (A <opcode> C) --> (A <opcode> C)<nuw> if the op doesn't unsign overflow. 2406 if (!(SignOrUnsignWrap & SCEV::FlagNUW)) { 2407 auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 2408 Opcode, C, OBO::NoUnsignedWrap); 2409 if (NUWRegion.contains(SE->getUnsignedRange(Ops[1]))) 2410 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2411 } 2412 } 2413 2414 // <0,+,nonnegative><nw> is also nuw 2415 // TODO: Add corresponding nsw case 2416 if (Type == scAddRecExpr && ScalarEvolution::hasFlags(Flags, SCEV::FlagNW) && 2417 !ScalarEvolution::hasFlags(Flags, SCEV::FlagNUW) && Ops.size() == 2 && 2418 Ops[0]->isZero() && IsKnownNonNegative(Ops[1])) 2419 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2420 2421 // both (udiv X, Y) * Y and Y * (udiv X, Y) are always NUW 2422 if (Type == scMulExpr && !ScalarEvolution::hasFlags(Flags, SCEV::FlagNUW) && 2423 Ops.size() == 2) { 2424 if (auto *UDiv = dyn_cast<SCEVUDivExpr>(Ops[0])) 2425 if (UDiv->getOperand(1) == Ops[1]) 2426 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2427 if (auto *UDiv = dyn_cast<SCEVUDivExpr>(Ops[1])) 2428 if (UDiv->getOperand(1) == Ops[0]) 2429 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2430 } 2431 2432 return Flags; 2433 } 2434 2435 bool ScalarEvolution::isAvailableAtLoopEntry(const SCEV *S, const Loop *L) { 2436 return isLoopInvariant(S, L) && properlyDominates(S, L->getHeader()); 2437 } 2438 2439 /// Get a canonical add expression, or something simpler if possible. 2440 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops, 2441 SCEV::NoWrapFlags OrigFlags, 2442 unsigned Depth) { 2443 assert(!(OrigFlags & ~(SCEV::FlagNUW | SCEV::FlagNSW)) && 2444 "only nuw or nsw allowed"); 2445 assert(!Ops.empty() && "Cannot get empty add!"); 2446 if (Ops.size() == 1) return Ops[0]; 2447 #ifndef NDEBUG 2448 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 2449 for (unsigned i = 1, e = Ops.size(); i != e; ++i) 2450 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 2451 "SCEVAddExpr operand types don't match!"); 2452 unsigned NumPtrs = count_if( 2453 Ops, [](const SCEV *Op) { return Op->getType()->isPointerTy(); }); 2454 assert(NumPtrs <= 1 && "add has at most one pointer operand"); 2455 #endif 2456 2457 // Sort by complexity, this groups all similar expression types together. 2458 GroupByComplexity(Ops, &LI, DT); 2459 2460 // If there are any constants, fold them together. 2461 unsigned Idx = 0; 2462 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 2463 ++Idx; 2464 assert(Idx < Ops.size()); 2465 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 2466 // We found two constants, fold them together! 2467 Ops[0] = getConstant(LHSC->getAPInt() + RHSC->getAPInt()); 2468 if (Ops.size() == 2) return Ops[0]; 2469 Ops.erase(Ops.begin()+1); // Erase the folded element 2470 LHSC = cast<SCEVConstant>(Ops[0]); 2471 } 2472 2473 // If we are left with a constant zero being added, strip it off. 2474 if (LHSC->getValue()->isZero()) { 2475 Ops.erase(Ops.begin()); 2476 --Idx; 2477 } 2478 2479 if (Ops.size() == 1) return Ops[0]; 2480 } 2481 2482 // Delay expensive flag strengthening until necessary. 2483 auto ComputeFlags = [this, OrigFlags](const ArrayRef<const SCEV *> Ops) { 2484 return StrengthenNoWrapFlags(this, scAddExpr, Ops, OrigFlags); 2485 }; 2486 2487 // Limit recursion calls depth. 2488 if (Depth > MaxArithDepth || hasHugeExpression(Ops)) 2489 return getOrCreateAddExpr(Ops, ComputeFlags(Ops)); 2490 2491 if (SCEV *S = findExistingSCEVInCache(scAddExpr, Ops)) { 2492 // Don't strengthen flags if we have no new information. 2493 SCEVAddExpr *Add = static_cast<SCEVAddExpr *>(S); 2494 if (Add->getNoWrapFlags(OrigFlags) != OrigFlags) 2495 Add->setNoWrapFlags(ComputeFlags(Ops)); 2496 return S; 2497 } 2498 2499 // Okay, check to see if the same value occurs in the operand list more than 2500 // once. If so, merge them together into an multiply expression. Since we 2501 // sorted the list, these values are required to be adjacent. 2502 Type *Ty = Ops[0]->getType(); 2503 bool FoundMatch = false; 2504 for (unsigned i = 0, e = Ops.size(); i != e-1; ++i) 2505 if (Ops[i] == Ops[i+1]) { // X + Y + Y --> X + Y*2 2506 // Scan ahead to count how many equal operands there are. 2507 unsigned Count = 2; 2508 while (i+Count != e && Ops[i+Count] == Ops[i]) 2509 ++Count; 2510 // Merge the values into a multiply. 2511 const SCEV *Scale = getConstant(Ty, Count); 2512 const SCEV *Mul = getMulExpr(Scale, Ops[i], SCEV::FlagAnyWrap, Depth + 1); 2513 if (Ops.size() == Count) 2514 return Mul; 2515 Ops[i] = Mul; 2516 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count); 2517 --i; e -= Count - 1; 2518 FoundMatch = true; 2519 } 2520 if (FoundMatch) 2521 return getAddExpr(Ops, OrigFlags, Depth + 1); 2522 2523 // Check for truncates. If all the operands are truncated from the same 2524 // type, see if factoring out the truncate would permit the result to be 2525 // folded. eg., n*trunc(x) + m*trunc(y) --> trunc(trunc(m)*x + trunc(n)*y) 2526 // if the contents of the resulting outer trunc fold to something simple. 2527 auto FindTruncSrcType = [&]() -> Type * { 2528 // We're ultimately looking to fold an addrec of truncs and muls of only 2529 // constants and truncs, so if we find any other types of SCEV 2530 // as operands of the addrec then we bail and return nullptr here. 2531 // Otherwise, we return the type of the operand of a trunc that we find. 2532 if (auto *T = dyn_cast<SCEVTruncateExpr>(Ops[Idx])) 2533 return T->getOperand()->getType(); 2534 if (const auto *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) { 2535 const auto *LastOp = Mul->getOperand(Mul->getNumOperands() - 1); 2536 if (const auto *T = dyn_cast<SCEVTruncateExpr>(LastOp)) 2537 return T->getOperand()->getType(); 2538 } 2539 return nullptr; 2540 }; 2541 if (auto *SrcType = FindTruncSrcType()) { 2542 SmallVector<const SCEV *, 8> LargeOps; 2543 bool Ok = true; 2544 // Check all the operands to see if they can be represented in the 2545 // source type of the truncate. 2546 for (unsigned i = 0, e = Ops.size(); i != e; ++i) { 2547 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) { 2548 if (T->getOperand()->getType() != SrcType) { 2549 Ok = false; 2550 break; 2551 } 2552 LargeOps.push_back(T->getOperand()); 2553 } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) { 2554 LargeOps.push_back(getAnyExtendExpr(C, SrcType)); 2555 } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) { 2556 SmallVector<const SCEV *, 8> LargeMulOps; 2557 for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) { 2558 if (const SCEVTruncateExpr *T = 2559 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) { 2560 if (T->getOperand()->getType() != SrcType) { 2561 Ok = false; 2562 break; 2563 } 2564 LargeMulOps.push_back(T->getOperand()); 2565 } else if (const auto *C = dyn_cast<SCEVConstant>(M->getOperand(j))) { 2566 LargeMulOps.push_back(getAnyExtendExpr(C, SrcType)); 2567 } else { 2568 Ok = false; 2569 break; 2570 } 2571 } 2572 if (Ok) 2573 LargeOps.push_back(getMulExpr(LargeMulOps, SCEV::FlagAnyWrap, Depth + 1)); 2574 } else { 2575 Ok = false; 2576 break; 2577 } 2578 } 2579 if (Ok) { 2580 // Evaluate the expression in the larger type. 2581 const SCEV *Fold = getAddExpr(LargeOps, SCEV::FlagAnyWrap, Depth + 1); 2582 // If it folds to something simple, use it. Otherwise, don't. 2583 if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold)) 2584 return getTruncateExpr(Fold, Ty); 2585 } 2586 } 2587 2588 if (Ops.size() == 2) { 2589 // Check if we have an expression of the form ((X + C1) - C2), where C1 and 2590 // C2 can be folded in a way that allows retaining wrapping flags of (X + 2591 // C1). 2592 const SCEV *A = Ops[0]; 2593 const SCEV *B = Ops[1]; 2594 auto *AddExpr = dyn_cast<SCEVAddExpr>(B); 2595 auto *C = dyn_cast<SCEVConstant>(A); 2596 if (AddExpr && C && isa<SCEVConstant>(AddExpr->getOperand(0))) { 2597 auto C1 = cast<SCEVConstant>(AddExpr->getOperand(0))->getAPInt(); 2598 auto C2 = C->getAPInt(); 2599 SCEV::NoWrapFlags PreservedFlags = SCEV::FlagAnyWrap; 2600 2601 APInt ConstAdd = C1 + C2; 2602 auto AddFlags = AddExpr->getNoWrapFlags(); 2603 // Adding a smaller constant is NUW if the original AddExpr was NUW. 2604 if (ScalarEvolution::hasFlags(AddFlags, SCEV::FlagNUW) && 2605 ConstAdd.ule(C1)) { 2606 PreservedFlags = 2607 ScalarEvolution::setFlags(PreservedFlags, SCEV::FlagNUW); 2608 } 2609 2610 // Adding a constant with the same sign and small magnitude is NSW, if the 2611 // original AddExpr was NSW. 2612 if (ScalarEvolution::hasFlags(AddFlags, SCEV::FlagNSW) && 2613 C1.isSignBitSet() == ConstAdd.isSignBitSet() && 2614 ConstAdd.abs().ule(C1.abs())) { 2615 PreservedFlags = 2616 ScalarEvolution::setFlags(PreservedFlags, SCEV::FlagNSW); 2617 } 2618 2619 if (PreservedFlags != SCEV::FlagAnyWrap) { 2620 SmallVector<const SCEV *, 4> NewOps(AddExpr->operands()); 2621 NewOps[0] = getConstant(ConstAdd); 2622 return getAddExpr(NewOps, PreservedFlags); 2623 } 2624 } 2625 } 2626 2627 // Canonicalize (-1 * urem X, Y) + X --> (Y * X/Y) 2628 if (Ops.size() == 2) { 2629 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[0]); 2630 if (Mul && Mul->getNumOperands() == 2 && 2631 Mul->getOperand(0)->isAllOnesValue()) { 2632 const SCEV *X; 2633 const SCEV *Y; 2634 if (matchURem(Mul->getOperand(1), X, Y) && X == Ops[1]) { 2635 return getMulExpr(Y, getUDivExpr(X, Y)); 2636 } 2637 } 2638 } 2639 2640 // Skip past any other cast SCEVs. 2641 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr) 2642 ++Idx; 2643 2644 // If there are add operands they would be next. 2645 if (Idx < Ops.size()) { 2646 bool DeletedAdd = false; 2647 // If the original flags and all inlined SCEVAddExprs are NUW, use the 2648 // common NUW flag for expression after inlining. Other flags cannot be 2649 // preserved, because they may depend on the original order of operations. 2650 SCEV::NoWrapFlags CommonFlags = maskFlags(OrigFlags, SCEV::FlagNUW); 2651 while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) { 2652 if (Ops.size() > AddOpsInlineThreshold || 2653 Add->getNumOperands() > AddOpsInlineThreshold) 2654 break; 2655 // If we have an add, expand the add operands onto the end of the operands 2656 // list. 2657 Ops.erase(Ops.begin()+Idx); 2658 Ops.append(Add->op_begin(), Add->op_end()); 2659 DeletedAdd = true; 2660 CommonFlags = maskFlags(CommonFlags, Add->getNoWrapFlags()); 2661 } 2662 2663 // If we deleted at least one add, we added operands to the end of the list, 2664 // and they are not necessarily sorted. Recurse to resort and resimplify 2665 // any operands we just acquired. 2666 if (DeletedAdd) 2667 return getAddExpr(Ops, CommonFlags, Depth + 1); 2668 } 2669 2670 // Skip over the add expression until we get to a multiply. 2671 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr) 2672 ++Idx; 2673 2674 // Check to see if there are any folding opportunities present with 2675 // operands multiplied by constant values. 2676 if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) { 2677 uint64_t BitWidth = getTypeSizeInBits(Ty); 2678 DenseMap<const SCEV *, APInt> M; 2679 SmallVector<const SCEV *, 8> NewOps; 2680 APInt AccumulatedConstant(BitWidth, 0); 2681 if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant, 2682 Ops.data(), Ops.size(), 2683 APInt(BitWidth, 1), *this)) { 2684 struct APIntCompare { 2685 bool operator()(const APInt &LHS, const APInt &RHS) const { 2686 return LHS.ult(RHS); 2687 } 2688 }; 2689 2690 // Some interesting folding opportunity is present, so its worthwhile to 2691 // re-generate the operands list. Group the operands by constant scale, 2692 // to avoid multiplying by the same constant scale multiple times. 2693 std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists; 2694 for (const SCEV *NewOp : NewOps) 2695 MulOpLists[M.find(NewOp)->second].push_back(NewOp); 2696 // Re-generate the operands list. 2697 Ops.clear(); 2698 if (AccumulatedConstant != 0) 2699 Ops.push_back(getConstant(AccumulatedConstant)); 2700 for (auto &MulOp : MulOpLists) { 2701 if (MulOp.first == 1) { 2702 Ops.push_back(getAddExpr(MulOp.second, SCEV::FlagAnyWrap, Depth + 1)); 2703 } else if (MulOp.first != 0) { 2704 Ops.push_back(getMulExpr( 2705 getConstant(MulOp.first), 2706 getAddExpr(MulOp.second, SCEV::FlagAnyWrap, Depth + 1), 2707 SCEV::FlagAnyWrap, Depth + 1)); 2708 } 2709 } 2710 if (Ops.empty()) 2711 return getZero(Ty); 2712 if (Ops.size() == 1) 2713 return Ops[0]; 2714 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2715 } 2716 } 2717 2718 // If we are adding something to a multiply expression, make sure the 2719 // something is not already an operand of the multiply. If so, merge it into 2720 // the multiply. 2721 for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) { 2722 const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]); 2723 for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) { 2724 const SCEV *MulOpSCEV = Mul->getOperand(MulOp); 2725 if (isa<SCEVConstant>(MulOpSCEV)) 2726 continue; 2727 for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp) 2728 if (MulOpSCEV == Ops[AddOp]) { 2729 // Fold W + X + (X * Y * Z) --> W + (X * ((Y*Z)+1)) 2730 const SCEV *InnerMul = Mul->getOperand(MulOp == 0); 2731 if (Mul->getNumOperands() != 2) { 2732 // If the multiply has more than two operands, we must get the 2733 // Y*Z term. 2734 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(), 2735 Mul->op_begin()+MulOp); 2736 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end()); 2737 InnerMul = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2738 } 2739 SmallVector<const SCEV *, 2> TwoOps = {getOne(Ty), InnerMul}; 2740 const SCEV *AddOne = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2741 const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV, 2742 SCEV::FlagAnyWrap, Depth + 1); 2743 if (Ops.size() == 2) return OuterMul; 2744 if (AddOp < Idx) { 2745 Ops.erase(Ops.begin()+AddOp); 2746 Ops.erase(Ops.begin()+Idx-1); 2747 } else { 2748 Ops.erase(Ops.begin()+Idx); 2749 Ops.erase(Ops.begin()+AddOp-1); 2750 } 2751 Ops.push_back(OuterMul); 2752 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2753 } 2754 2755 // Check this multiply against other multiplies being added together. 2756 for (unsigned OtherMulIdx = Idx+1; 2757 OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]); 2758 ++OtherMulIdx) { 2759 const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]); 2760 // If MulOp occurs in OtherMul, we can fold the two multiplies 2761 // together. 2762 for (unsigned OMulOp = 0, e = OtherMul->getNumOperands(); 2763 OMulOp != e; ++OMulOp) 2764 if (OtherMul->getOperand(OMulOp) == MulOpSCEV) { 2765 // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E)) 2766 const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0); 2767 if (Mul->getNumOperands() != 2) { 2768 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(), 2769 Mul->op_begin()+MulOp); 2770 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end()); 2771 InnerMul1 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2772 } 2773 const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0); 2774 if (OtherMul->getNumOperands() != 2) { 2775 SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(), 2776 OtherMul->op_begin()+OMulOp); 2777 MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end()); 2778 InnerMul2 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2779 } 2780 SmallVector<const SCEV *, 2> TwoOps = {InnerMul1, InnerMul2}; 2781 const SCEV *InnerMulSum = 2782 getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2783 const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum, 2784 SCEV::FlagAnyWrap, Depth + 1); 2785 if (Ops.size() == 2) return OuterMul; 2786 Ops.erase(Ops.begin()+Idx); 2787 Ops.erase(Ops.begin()+OtherMulIdx-1); 2788 Ops.push_back(OuterMul); 2789 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2790 } 2791 } 2792 } 2793 } 2794 2795 // If there are any add recurrences in the operands list, see if any other 2796 // added values are loop invariant. If so, we can fold them into the 2797 // recurrence. 2798 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr) 2799 ++Idx; 2800 2801 // Scan over all recurrences, trying to fold loop invariants into them. 2802 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) { 2803 // Scan all of the other operands to this add and add them to the vector if 2804 // they are loop invariant w.r.t. the recurrence. 2805 SmallVector<const SCEV *, 8> LIOps; 2806 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]); 2807 const Loop *AddRecLoop = AddRec->getLoop(); 2808 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 2809 if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) { 2810 LIOps.push_back(Ops[i]); 2811 Ops.erase(Ops.begin()+i); 2812 --i; --e; 2813 } 2814 2815 // If we found some loop invariants, fold them into the recurrence. 2816 if (!LIOps.empty()) { 2817 // Compute nowrap flags for the addition of the loop-invariant ops and 2818 // the addrec. Temporarily push it as an operand for that purpose. These 2819 // flags are valid in the scope of the addrec only. 2820 LIOps.push_back(AddRec); 2821 SCEV::NoWrapFlags Flags = ComputeFlags(LIOps); 2822 LIOps.pop_back(); 2823 2824 // NLI + LI + {Start,+,Step} --> NLI + {LI+Start,+,Step} 2825 LIOps.push_back(AddRec->getStart()); 2826 2827 SmallVector<const SCEV *, 4> AddRecOps(AddRec->operands()); 2828 2829 // It is not in general safe to propagate flags valid on an add within 2830 // the addrec scope to one outside it. We must prove that the inner 2831 // scope is guaranteed to execute if the outer one does to be able to 2832 // safely propagate. We know the program is undefined if poison is 2833 // produced on the inner scoped addrec. We also know that *for this use* 2834 // the outer scoped add can't overflow (because of the flags we just 2835 // computed for the inner scoped add) without the program being undefined. 2836 // Proving that entry to the outer scope neccesitates entry to the inner 2837 // scope, thus proves the program undefined if the flags would be violated 2838 // in the outer scope. 2839 SCEV::NoWrapFlags AddFlags = Flags; 2840 if (AddFlags != SCEV::FlagAnyWrap) { 2841 auto *DefI = getDefiningScopeBound(LIOps); 2842 auto *ReachI = &*AddRecLoop->getHeader()->begin(); 2843 if (!isGuaranteedToTransferExecutionTo(DefI, ReachI)) 2844 AddFlags = SCEV::FlagAnyWrap; 2845 } 2846 AddRecOps[0] = getAddExpr(LIOps, AddFlags, Depth + 1); 2847 2848 // Build the new addrec. Propagate the NUW and NSW flags if both the 2849 // outer add and the inner addrec are guaranteed to have no overflow. 2850 // Always propagate NW. 2851 Flags = AddRec->getNoWrapFlags(setFlags(Flags, SCEV::FlagNW)); 2852 const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop, Flags); 2853 2854 // If all of the other operands were loop invariant, we are done. 2855 if (Ops.size() == 1) return NewRec; 2856 2857 // Otherwise, add the folded AddRec by the non-invariant parts. 2858 for (unsigned i = 0;; ++i) 2859 if (Ops[i] == AddRec) { 2860 Ops[i] = NewRec; 2861 break; 2862 } 2863 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2864 } 2865 2866 // Okay, if there weren't any loop invariants to be folded, check to see if 2867 // there are multiple AddRec's with the same loop induction variable being 2868 // added together. If so, we can fold them. 2869 for (unsigned OtherIdx = Idx+1; 2870 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 2871 ++OtherIdx) { 2872 // We expect the AddRecExpr's to be sorted in reverse dominance order, 2873 // so that the 1st found AddRecExpr is dominated by all others. 2874 assert(DT.dominates( 2875 cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()->getHeader(), 2876 AddRec->getLoop()->getHeader()) && 2877 "AddRecExprs are not sorted in reverse dominance order?"); 2878 if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) { 2879 // Other + {A,+,B}<L> + {C,+,D}<L> --> Other + {A+C,+,B+D}<L> 2880 SmallVector<const SCEV *, 4> AddRecOps(AddRec->operands()); 2881 for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 2882 ++OtherIdx) { 2883 const auto *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]); 2884 if (OtherAddRec->getLoop() == AddRecLoop) { 2885 for (unsigned i = 0, e = OtherAddRec->getNumOperands(); 2886 i != e; ++i) { 2887 if (i >= AddRecOps.size()) { 2888 AddRecOps.append(OtherAddRec->op_begin()+i, 2889 OtherAddRec->op_end()); 2890 break; 2891 } 2892 SmallVector<const SCEV *, 2> TwoOps = { 2893 AddRecOps[i], OtherAddRec->getOperand(i)}; 2894 AddRecOps[i] = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2895 } 2896 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx; 2897 } 2898 } 2899 // Step size has changed, so we cannot guarantee no self-wraparound. 2900 Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop, SCEV::FlagAnyWrap); 2901 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2902 } 2903 } 2904 2905 // Otherwise couldn't fold anything into this recurrence. Move onto the 2906 // next one. 2907 } 2908 2909 // Okay, it looks like we really DO need an add expr. Check to see if we 2910 // already have one, otherwise create a new one. 2911 return getOrCreateAddExpr(Ops, ComputeFlags(Ops)); 2912 } 2913 2914 const SCEV * 2915 ScalarEvolution::getOrCreateAddExpr(ArrayRef<const SCEV *> Ops, 2916 SCEV::NoWrapFlags Flags) { 2917 FoldingSetNodeID ID; 2918 ID.AddInteger(scAddExpr); 2919 for (const SCEV *Op : Ops) 2920 ID.AddPointer(Op); 2921 void *IP = nullptr; 2922 SCEVAddExpr *S = 2923 static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2924 if (!S) { 2925 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2926 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2927 S = new (SCEVAllocator) 2928 SCEVAddExpr(ID.Intern(SCEVAllocator), O, Ops.size()); 2929 UniqueSCEVs.InsertNode(S, IP); 2930 registerUser(S, Ops); 2931 } 2932 S->setNoWrapFlags(Flags); 2933 return S; 2934 } 2935 2936 const SCEV * 2937 ScalarEvolution::getOrCreateAddRecExpr(ArrayRef<const SCEV *> Ops, 2938 const Loop *L, SCEV::NoWrapFlags Flags) { 2939 FoldingSetNodeID ID; 2940 ID.AddInteger(scAddRecExpr); 2941 for (const SCEV *Op : Ops) 2942 ID.AddPointer(Op); 2943 ID.AddPointer(L); 2944 void *IP = nullptr; 2945 SCEVAddRecExpr *S = 2946 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2947 if (!S) { 2948 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2949 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2950 S = new (SCEVAllocator) 2951 SCEVAddRecExpr(ID.Intern(SCEVAllocator), O, Ops.size(), L); 2952 UniqueSCEVs.InsertNode(S, IP); 2953 LoopUsers[L].push_back(S); 2954 registerUser(S, Ops); 2955 } 2956 setNoWrapFlags(S, Flags); 2957 return S; 2958 } 2959 2960 const SCEV * 2961 ScalarEvolution::getOrCreateMulExpr(ArrayRef<const SCEV *> Ops, 2962 SCEV::NoWrapFlags Flags) { 2963 FoldingSetNodeID ID; 2964 ID.AddInteger(scMulExpr); 2965 for (const SCEV *Op : Ops) 2966 ID.AddPointer(Op); 2967 void *IP = nullptr; 2968 SCEVMulExpr *S = 2969 static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2970 if (!S) { 2971 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2972 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2973 S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator), 2974 O, Ops.size()); 2975 UniqueSCEVs.InsertNode(S, IP); 2976 registerUser(S, Ops); 2977 } 2978 S->setNoWrapFlags(Flags); 2979 return S; 2980 } 2981 2982 static uint64_t umul_ov(uint64_t i, uint64_t j, bool &Overflow) { 2983 uint64_t k = i*j; 2984 if (j > 1 && k / j != i) Overflow = true; 2985 return k; 2986 } 2987 2988 /// Compute the result of "n choose k", the binomial coefficient. If an 2989 /// intermediate computation overflows, Overflow will be set and the return will 2990 /// be garbage. Overflow is not cleared on absence of overflow. 2991 static uint64_t Choose(uint64_t n, uint64_t k, bool &Overflow) { 2992 // We use the multiplicative formula: 2993 // n(n-1)(n-2)...(n-(k-1)) / k(k-1)(k-2)...1 . 2994 // At each iteration, we take the n-th term of the numeral and divide by the 2995 // (k-n)th term of the denominator. This division will always produce an 2996 // integral result, and helps reduce the chance of overflow in the 2997 // intermediate computations. However, we can still overflow even when the 2998 // final result would fit. 2999 3000 if (n == 0 || n == k) return 1; 3001 if (k > n) return 0; 3002 3003 if (k > n/2) 3004 k = n-k; 3005 3006 uint64_t r = 1; 3007 for (uint64_t i = 1; i <= k; ++i) { 3008 r = umul_ov(r, n-(i-1), Overflow); 3009 r /= i; 3010 } 3011 return r; 3012 } 3013 3014 /// Determine if any of the operands in this SCEV are a constant or if 3015 /// any of the add or multiply expressions in this SCEV contain a constant. 3016 static bool containsConstantInAddMulChain(const SCEV *StartExpr) { 3017 struct FindConstantInAddMulChain { 3018 bool FoundConstant = false; 3019 3020 bool follow(const SCEV *S) { 3021 FoundConstant |= isa<SCEVConstant>(S); 3022 return isa<SCEVAddExpr>(S) || isa<SCEVMulExpr>(S); 3023 } 3024 3025 bool isDone() const { 3026 return FoundConstant; 3027 } 3028 }; 3029 3030 FindConstantInAddMulChain F; 3031 SCEVTraversal<FindConstantInAddMulChain> ST(F); 3032 ST.visitAll(StartExpr); 3033 return F.FoundConstant; 3034 } 3035 3036 /// Get a canonical multiply expression, or something simpler if possible. 3037 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops, 3038 SCEV::NoWrapFlags OrigFlags, 3039 unsigned Depth) { 3040 assert(OrigFlags == maskFlags(OrigFlags, SCEV::FlagNUW | SCEV::FlagNSW) && 3041 "only nuw or nsw allowed"); 3042 assert(!Ops.empty() && "Cannot get empty mul!"); 3043 if (Ops.size() == 1) return Ops[0]; 3044 #ifndef NDEBUG 3045 Type *ETy = Ops[0]->getType(); 3046 assert(!ETy->isPointerTy()); 3047 for (unsigned i = 1, e = Ops.size(); i != e; ++i) 3048 assert(Ops[i]->getType() == ETy && 3049 "SCEVMulExpr operand types don't match!"); 3050 #endif 3051 3052 // Sort by complexity, this groups all similar expression types together. 3053 GroupByComplexity(Ops, &LI, DT); 3054 3055 // If there are any constants, fold them together. 3056 unsigned Idx = 0; 3057 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 3058 ++Idx; 3059 assert(Idx < Ops.size()); 3060 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 3061 // We found two constants, fold them together! 3062 Ops[0] = getConstant(LHSC->getAPInt() * RHSC->getAPInt()); 3063 if (Ops.size() == 2) return Ops[0]; 3064 Ops.erase(Ops.begin()+1); // Erase the folded element 3065 LHSC = cast<SCEVConstant>(Ops[0]); 3066 } 3067 3068 // If we have a multiply of zero, it will always be zero. 3069 if (LHSC->getValue()->isZero()) 3070 return LHSC; 3071 3072 // If we are left with a constant one being multiplied, strip it off. 3073 if (LHSC->getValue()->isOne()) { 3074 Ops.erase(Ops.begin()); 3075 --Idx; 3076 } 3077 3078 if (Ops.size() == 1) 3079 return Ops[0]; 3080 } 3081 3082 // Delay expensive flag strengthening until necessary. 3083 auto ComputeFlags = [this, OrigFlags](const ArrayRef<const SCEV *> Ops) { 3084 return StrengthenNoWrapFlags(this, scMulExpr, Ops, OrigFlags); 3085 }; 3086 3087 // Limit recursion calls depth. 3088 if (Depth > MaxArithDepth || hasHugeExpression(Ops)) 3089 return getOrCreateMulExpr(Ops, ComputeFlags(Ops)); 3090 3091 if (SCEV *S = findExistingSCEVInCache(scMulExpr, Ops)) { 3092 // Don't strengthen flags if we have no new information. 3093 SCEVMulExpr *Mul = static_cast<SCEVMulExpr *>(S); 3094 if (Mul->getNoWrapFlags(OrigFlags) != OrigFlags) 3095 Mul->setNoWrapFlags(ComputeFlags(Ops)); 3096 return S; 3097 } 3098 3099 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 3100 if (Ops.size() == 2) { 3101 // C1*(C2+V) -> C1*C2 + C1*V 3102 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) 3103 // If any of Add's ops are Adds or Muls with a constant, apply this 3104 // transformation as well. 3105 // 3106 // TODO: There are some cases where this transformation is not 3107 // profitable; for example, Add = (C0 + X) * Y + Z. Maybe the scope of 3108 // this transformation should be narrowed down. 3109 if (Add->getNumOperands() == 2 && containsConstantInAddMulChain(Add)) 3110 return getAddExpr(getMulExpr(LHSC, Add->getOperand(0), 3111 SCEV::FlagAnyWrap, Depth + 1), 3112 getMulExpr(LHSC, Add->getOperand(1), 3113 SCEV::FlagAnyWrap, Depth + 1), 3114 SCEV::FlagAnyWrap, Depth + 1); 3115 3116 if (Ops[0]->isAllOnesValue()) { 3117 // If we have a mul by -1 of an add, try distributing the -1 among the 3118 // add operands. 3119 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) { 3120 SmallVector<const SCEV *, 4> NewOps; 3121 bool AnyFolded = false; 3122 for (const SCEV *AddOp : Add->operands()) { 3123 const SCEV *Mul = getMulExpr(Ops[0], AddOp, SCEV::FlagAnyWrap, 3124 Depth + 1); 3125 if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true; 3126 NewOps.push_back(Mul); 3127 } 3128 if (AnyFolded) 3129 return getAddExpr(NewOps, SCEV::FlagAnyWrap, Depth + 1); 3130 } else if (const auto *AddRec = dyn_cast<SCEVAddRecExpr>(Ops[1])) { 3131 // Negation preserves a recurrence's no self-wrap property. 3132 SmallVector<const SCEV *, 4> Operands; 3133 for (const SCEV *AddRecOp : AddRec->operands()) 3134 Operands.push_back(getMulExpr(Ops[0], AddRecOp, SCEV::FlagAnyWrap, 3135 Depth + 1)); 3136 3137 return getAddRecExpr(Operands, AddRec->getLoop(), 3138 AddRec->getNoWrapFlags(SCEV::FlagNW)); 3139 } 3140 } 3141 } 3142 } 3143 3144 // Skip over the add expression until we get to a multiply. 3145 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr) 3146 ++Idx; 3147 3148 // If there are mul operands inline them all into this expression. 3149 if (Idx < Ops.size()) { 3150 bool DeletedMul = false; 3151 while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) { 3152 if (Ops.size() > MulOpsInlineThreshold) 3153 break; 3154 // If we have an mul, expand the mul operands onto the end of the 3155 // operands list. 3156 Ops.erase(Ops.begin()+Idx); 3157 Ops.append(Mul->op_begin(), Mul->op_end()); 3158 DeletedMul = true; 3159 } 3160 3161 // If we deleted at least one mul, we added operands to the end of the 3162 // list, and they are not necessarily sorted. Recurse to resort and 3163 // resimplify any operands we just acquired. 3164 if (DeletedMul) 3165 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3166 } 3167 3168 // If there are any add recurrences in the operands list, see if any other 3169 // added values are loop invariant. If so, we can fold them into the 3170 // recurrence. 3171 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr) 3172 ++Idx; 3173 3174 // Scan over all recurrences, trying to fold loop invariants into them. 3175 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) { 3176 // Scan all of the other operands to this mul and add them to the vector 3177 // if they are loop invariant w.r.t. the recurrence. 3178 SmallVector<const SCEV *, 8> LIOps; 3179 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]); 3180 const Loop *AddRecLoop = AddRec->getLoop(); 3181 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 3182 if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) { 3183 LIOps.push_back(Ops[i]); 3184 Ops.erase(Ops.begin()+i); 3185 --i; --e; 3186 } 3187 3188 // If we found some loop invariants, fold them into the recurrence. 3189 if (!LIOps.empty()) { 3190 // NLI * LI * {Start,+,Step} --> NLI * {LI*Start,+,LI*Step} 3191 SmallVector<const SCEV *, 4> NewOps; 3192 NewOps.reserve(AddRec->getNumOperands()); 3193 const SCEV *Scale = getMulExpr(LIOps, SCEV::FlagAnyWrap, Depth + 1); 3194 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) 3195 NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i), 3196 SCEV::FlagAnyWrap, Depth + 1)); 3197 3198 // Build the new addrec. Propagate the NUW and NSW flags if both the 3199 // outer mul and the inner addrec are guaranteed to have no overflow. 3200 // 3201 // No self-wrap cannot be guaranteed after changing the step size, but 3202 // will be inferred if either NUW or NSW is true. 3203 SCEV::NoWrapFlags Flags = ComputeFlags({Scale, AddRec}); 3204 const SCEV *NewRec = getAddRecExpr( 3205 NewOps, AddRecLoop, AddRec->getNoWrapFlags(Flags)); 3206 3207 // If all of the other operands were loop invariant, we are done. 3208 if (Ops.size() == 1) return NewRec; 3209 3210 // Otherwise, multiply the folded AddRec by the non-invariant parts. 3211 for (unsigned i = 0;; ++i) 3212 if (Ops[i] == AddRec) { 3213 Ops[i] = NewRec; 3214 break; 3215 } 3216 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3217 } 3218 3219 // Okay, if there weren't any loop invariants to be folded, check to see 3220 // if there are multiple AddRec's with the same loop induction variable 3221 // being multiplied together. If so, we can fold them. 3222 3223 // {A1,+,A2,+,...,+,An}<L> * {B1,+,B2,+,...,+,Bn}<L> 3224 // = {x=1 in [ sum y=x..2x [ sum z=max(y-x, y-n)..min(x,n) [ 3225 // choose(x, 2x)*choose(2x-y, x-z)*A_{y-z}*B_z 3226 // ]]],+,...up to x=2n}. 3227 // Note that the arguments to choose() are always integers with values 3228 // known at compile time, never SCEV objects. 3229 // 3230 // The implementation avoids pointless extra computations when the two 3231 // addrec's are of different length (mathematically, it's equivalent to 3232 // an infinite stream of zeros on the right). 3233 bool OpsModified = false; 3234 for (unsigned OtherIdx = Idx+1; 3235 OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 3236 ++OtherIdx) { 3237 const SCEVAddRecExpr *OtherAddRec = 3238 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]); 3239 if (!OtherAddRec || OtherAddRec->getLoop() != AddRecLoop) 3240 continue; 3241 3242 // Limit max number of arguments to avoid creation of unreasonably big 3243 // SCEVAddRecs with very complex operands. 3244 if (AddRec->getNumOperands() + OtherAddRec->getNumOperands() - 1 > 3245 MaxAddRecSize || hasHugeExpression({AddRec, OtherAddRec})) 3246 continue; 3247 3248 bool Overflow = false; 3249 Type *Ty = AddRec->getType(); 3250 bool LargerThan64Bits = getTypeSizeInBits(Ty) > 64; 3251 SmallVector<const SCEV*, 7> AddRecOps; 3252 for (int x = 0, xe = AddRec->getNumOperands() + 3253 OtherAddRec->getNumOperands() - 1; x != xe && !Overflow; ++x) { 3254 SmallVector <const SCEV *, 7> SumOps; 3255 for (int y = x, ye = 2*x+1; y != ye && !Overflow; ++y) { 3256 uint64_t Coeff1 = Choose(x, 2*x - y, Overflow); 3257 for (int z = std::max(y-x, y-(int)AddRec->getNumOperands()+1), 3258 ze = std::min(x+1, (int)OtherAddRec->getNumOperands()); 3259 z < ze && !Overflow; ++z) { 3260 uint64_t Coeff2 = Choose(2*x - y, x-z, Overflow); 3261 uint64_t Coeff; 3262 if (LargerThan64Bits) 3263 Coeff = umul_ov(Coeff1, Coeff2, Overflow); 3264 else 3265 Coeff = Coeff1*Coeff2; 3266 const SCEV *CoeffTerm = getConstant(Ty, Coeff); 3267 const SCEV *Term1 = AddRec->getOperand(y-z); 3268 const SCEV *Term2 = OtherAddRec->getOperand(z); 3269 SumOps.push_back(getMulExpr(CoeffTerm, Term1, Term2, 3270 SCEV::FlagAnyWrap, Depth + 1)); 3271 } 3272 } 3273 if (SumOps.empty()) 3274 SumOps.push_back(getZero(Ty)); 3275 AddRecOps.push_back(getAddExpr(SumOps, SCEV::FlagAnyWrap, Depth + 1)); 3276 } 3277 if (!Overflow) { 3278 const SCEV *NewAddRec = getAddRecExpr(AddRecOps, AddRecLoop, 3279 SCEV::FlagAnyWrap); 3280 if (Ops.size() == 2) return NewAddRec; 3281 Ops[Idx] = NewAddRec; 3282 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx; 3283 OpsModified = true; 3284 AddRec = dyn_cast<SCEVAddRecExpr>(NewAddRec); 3285 if (!AddRec) 3286 break; 3287 } 3288 } 3289 if (OpsModified) 3290 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3291 3292 // Otherwise couldn't fold anything into this recurrence. Move onto the 3293 // next one. 3294 } 3295 3296 // Okay, it looks like we really DO need an mul expr. Check to see if we 3297 // already have one, otherwise create a new one. 3298 return getOrCreateMulExpr(Ops, ComputeFlags(Ops)); 3299 } 3300 3301 /// Represents an unsigned remainder expression based on unsigned division. 3302 const SCEV *ScalarEvolution::getURemExpr(const SCEV *LHS, 3303 const SCEV *RHS) { 3304 assert(getEffectiveSCEVType(LHS->getType()) == 3305 getEffectiveSCEVType(RHS->getType()) && 3306 "SCEVURemExpr operand types don't match!"); 3307 3308 // Short-circuit easy cases 3309 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 3310 // If constant is one, the result is trivial 3311 if (RHSC->getValue()->isOne()) 3312 return getZero(LHS->getType()); // X urem 1 --> 0 3313 3314 // If constant is a power of two, fold into a zext(trunc(LHS)). 3315 if (RHSC->getAPInt().isPowerOf2()) { 3316 Type *FullTy = LHS->getType(); 3317 Type *TruncTy = 3318 IntegerType::get(getContext(), RHSC->getAPInt().logBase2()); 3319 return getZeroExtendExpr(getTruncateExpr(LHS, TruncTy), FullTy); 3320 } 3321 } 3322 3323 // Fallback to %a == %x urem %y == %x -<nuw> ((%x udiv %y) *<nuw> %y) 3324 const SCEV *UDiv = getUDivExpr(LHS, RHS); 3325 const SCEV *Mult = getMulExpr(UDiv, RHS, SCEV::FlagNUW); 3326 return getMinusSCEV(LHS, Mult, SCEV::FlagNUW); 3327 } 3328 3329 /// Get a canonical unsigned division expression, or something simpler if 3330 /// possible. 3331 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS, 3332 const SCEV *RHS) { 3333 assert(!LHS->getType()->isPointerTy() && 3334 "SCEVUDivExpr operand can't be pointer!"); 3335 assert(LHS->getType() == RHS->getType() && 3336 "SCEVUDivExpr operand types don't match!"); 3337 3338 FoldingSetNodeID ID; 3339 ID.AddInteger(scUDivExpr); 3340 ID.AddPointer(LHS); 3341 ID.AddPointer(RHS); 3342 void *IP = nullptr; 3343 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 3344 return S; 3345 3346 // 0 udiv Y == 0 3347 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) 3348 if (LHSC->getValue()->isZero()) 3349 return LHS; 3350 3351 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 3352 if (RHSC->getValue()->isOne()) 3353 return LHS; // X udiv 1 --> x 3354 // If the denominator is zero, the result of the udiv is undefined. Don't 3355 // try to analyze it, because the resolution chosen here may differ from 3356 // the resolution chosen in other parts of the compiler. 3357 if (!RHSC->getValue()->isZero()) { 3358 // Determine if the division can be folded into the operands of 3359 // its operands. 3360 // TODO: Generalize this to non-constants by using known-bits information. 3361 Type *Ty = LHS->getType(); 3362 unsigned LZ = RHSC->getAPInt().countLeadingZeros(); 3363 unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1; 3364 // For non-power-of-two values, effectively round the value up to the 3365 // nearest power of two. 3366 if (!RHSC->getAPInt().isPowerOf2()) 3367 ++MaxShiftAmt; 3368 IntegerType *ExtTy = 3369 IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt); 3370 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS)) 3371 if (const SCEVConstant *Step = 3372 dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this))) { 3373 // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded. 3374 const APInt &StepInt = Step->getAPInt(); 3375 const APInt &DivInt = RHSC->getAPInt(); 3376 if (!StepInt.urem(DivInt) && 3377 getZeroExtendExpr(AR, ExtTy) == 3378 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy), 3379 getZeroExtendExpr(Step, ExtTy), 3380 AR->getLoop(), SCEV::FlagAnyWrap)) { 3381 SmallVector<const SCEV *, 4> Operands; 3382 for (const SCEV *Op : AR->operands()) 3383 Operands.push_back(getUDivExpr(Op, RHS)); 3384 return getAddRecExpr(Operands, AR->getLoop(), SCEV::FlagNW); 3385 } 3386 /// Get a canonical UDivExpr for a recurrence. 3387 /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0. 3388 // We can currently only fold X%N if X is constant. 3389 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart()); 3390 if (StartC && !DivInt.urem(StepInt) && 3391 getZeroExtendExpr(AR, ExtTy) == 3392 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy), 3393 getZeroExtendExpr(Step, ExtTy), 3394 AR->getLoop(), SCEV::FlagAnyWrap)) { 3395 const APInt &StartInt = StartC->getAPInt(); 3396 const APInt &StartRem = StartInt.urem(StepInt); 3397 if (StartRem != 0) { 3398 const SCEV *NewLHS = 3399 getAddRecExpr(getConstant(StartInt - StartRem), Step, 3400 AR->getLoop(), SCEV::FlagNW); 3401 if (LHS != NewLHS) { 3402 LHS = NewLHS; 3403 3404 // Reset the ID to include the new LHS, and check if it is 3405 // already cached. 3406 ID.clear(); 3407 ID.AddInteger(scUDivExpr); 3408 ID.AddPointer(LHS); 3409 ID.AddPointer(RHS); 3410 IP = nullptr; 3411 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 3412 return S; 3413 } 3414 } 3415 } 3416 } 3417 // (A*B)/C --> A*(B/C) if safe and B/C can be folded. 3418 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) { 3419 SmallVector<const SCEV *, 4> Operands; 3420 for (const SCEV *Op : M->operands()) 3421 Operands.push_back(getZeroExtendExpr(Op, ExtTy)); 3422 if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands)) 3423 // Find an operand that's safely divisible. 3424 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) { 3425 const SCEV *Op = M->getOperand(i); 3426 const SCEV *Div = getUDivExpr(Op, RHSC); 3427 if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) { 3428 Operands = SmallVector<const SCEV *, 4>(M->operands()); 3429 Operands[i] = Div; 3430 return getMulExpr(Operands); 3431 } 3432 } 3433 } 3434 3435 // (A/B)/C --> A/(B*C) if safe and B*C can be folded. 3436 if (const SCEVUDivExpr *OtherDiv = dyn_cast<SCEVUDivExpr>(LHS)) { 3437 if (auto *DivisorConstant = 3438 dyn_cast<SCEVConstant>(OtherDiv->getRHS())) { 3439 bool Overflow = false; 3440 APInt NewRHS = 3441 DivisorConstant->getAPInt().umul_ov(RHSC->getAPInt(), Overflow); 3442 if (Overflow) { 3443 return getConstant(RHSC->getType(), 0, false); 3444 } 3445 return getUDivExpr(OtherDiv->getLHS(), getConstant(NewRHS)); 3446 } 3447 } 3448 3449 // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded. 3450 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) { 3451 SmallVector<const SCEV *, 4> Operands; 3452 for (const SCEV *Op : A->operands()) 3453 Operands.push_back(getZeroExtendExpr(Op, ExtTy)); 3454 if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) { 3455 Operands.clear(); 3456 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) { 3457 const SCEV *Op = getUDivExpr(A->getOperand(i), RHS); 3458 if (isa<SCEVUDivExpr>(Op) || 3459 getMulExpr(Op, RHS) != A->getOperand(i)) 3460 break; 3461 Operands.push_back(Op); 3462 } 3463 if (Operands.size() == A->getNumOperands()) 3464 return getAddExpr(Operands); 3465 } 3466 } 3467 3468 // Fold if both operands are constant. 3469 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) { 3470 Constant *LHSCV = LHSC->getValue(); 3471 Constant *RHSCV = RHSC->getValue(); 3472 return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV, 3473 RHSCV))); 3474 } 3475 } 3476 } 3477 3478 // The Insertion Point (IP) might be invalid by now (due to UniqueSCEVs 3479 // changes). Make sure we get a new one. 3480 IP = nullptr; 3481 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 3482 SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator), 3483 LHS, RHS); 3484 UniqueSCEVs.InsertNode(S, IP); 3485 registerUser(S, {LHS, RHS}); 3486 return S; 3487 } 3488 3489 APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) { 3490 APInt A = C1->getAPInt().abs(); 3491 APInt B = C2->getAPInt().abs(); 3492 uint32_t ABW = A.getBitWidth(); 3493 uint32_t BBW = B.getBitWidth(); 3494 3495 if (ABW > BBW) 3496 B = B.zext(ABW); 3497 else if (ABW < BBW) 3498 A = A.zext(BBW); 3499 3500 return APIntOps::GreatestCommonDivisor(std::move(A), std::move(B)); 3501 } 3502 3503 /// Get a canonical unsigned division expression, or something simpler if 3504 /// possible. There is no representation for an exact udiv in SCEV IR, but we 3505 /// can attempt to remove factors from the LHS and RHS. We can't do this when 3506 /// it's not exact because the udiv may be clearing bits. 3507 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS, 3508 const SCEV *RHS) { 3509 // TODO: we could try to find factors in all sorts of things, but for now we 3510 // just deal with u/exact (multiply, constant). See SCEVDivision towards the 3511 // end of this file for inspiration. 3512 3513 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS); 3514 if (!Mul || !Mul->hasNoUnsignedWrap()) 3515 return getUDivExpr(LHS, RHS); 3516 3517 if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) { 3518 // If the mulexpr multiplies by a constant, then that constant must be the 3519 // first element of the mulexpr. 3520 if (const auto *LHSCst = dyn_cast<SCEVConstant>(Mul->getOperand(0))) { 3521 if (LHSCst == RHSCst) { 3522 SmallVector<const SCEV *, 2> Operands(drop_begin(Mul->operands())); 3523 return getMulExpr(Operands); 3524 } 3525 3526 // We can't just assume that LHSCst divides RHSCst cleanly, it could be 3527 // that there's a factor provided by one of the other terms. We need to 3528 // check. 3529 APInt Factor = gcd(LHSCst, RHSCst); 3530 if (!Factor.isIntN(1)) { 3531 LHSCst = 3532 cast<SCEVConstant>(getConstant(LHSCst->getAPInt().udiv(Factor))); 3533 RHSCst = 3534 cast<SCEVConstant>(getConstant(RHSCst->getAPInt().udiv(Factor))); 3535 SmallVector<const SCEV *, 2> Operands; 3536 Operands.push_back(LHSCst); 3537 Operands.append(Mul->op_begin() + 1, Mul->op_end()); 3538 LHS = getMulExpr(Operands); 3539 RHS = RHSCst; 3540 Mul = dyn_cast<SCEVMulExpr>(LHS); 3541 if (!Mul) 3542 return getUDivExactExpr(LHS, RHS); 3543 } 3544 } 3545 } 3546 3547 for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) { 3548 if (Mul->getOperand(i) == RHS) { 3549 SmallVector<const SCEV *, 2> Operands; 3550 Operands.append(Mul->op_begin(), Mul->op_begin() + i); 3551 Operands.append(Mul->op_begin() + i + 1, Mul->op_end()); 3552 return getMulExpr(Operands); 3553 } 3554 } 3555 3556 return getUDivExpr(LHS, RHS); 3557 } 3558 3559 /// Get an add recurrence expression for the specified loop. Simplify the 3560 /// expression as much as possible. 3561 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step, 3562 const Loop *L, 3563 SCEV::NoWrapFlags Flags) { 3564 SmallVector<const SCEV *, 4> Operands; 3565 Operands.push_back(Start); 3566 if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step)) 3567 if (StepChrec->getLoop() == L) { 3568 Operands.append(StepChrec->op_begin(), StepChrec->op_end()); 3569 return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW)); 3570 } 3571 3572 Operands.push_back(Step); 3573 return getAddRecExpr(Operands, L, Flags); 3574 } 3575 3576 /// Get an add recurrence expression for the specified loop. Simplify the 3577 /// expression as much as possible. 3578 const SCEV * 3579 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands, 3580 const Loop *L, SCEV::NoWrapFlags Flags) { 3581 if (Operands.size() == 1) return Operands[0]; 3582 #ifndef NDEBUG 3583 Type *ETy = getEffectiveSCEVType(Operands[0]->getType()); 3584 for (unsigned i = 1, e = Operands.size(); i != e; ++i) { 3585 assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy && 3586 "SCEVAddRecExpr operand types don't match!"); 3587 assert(!Operands[i]->getType()->isPointerTy() && "Step must be integer"); 3588 } 3589 for (unsigned i = 0, e = Operands.size(); i != e; ++i) 3590 assert(isLoopInvariant(Operands[i], L) && 3591 "SCEVAddRecExpr operand is not loop-invariant!"); 3592 #endif 3593 3594 if (Operands.back()->isZero()) { 3595 Operands.pop_back(); 3596 return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0} --> X 3597 } 3598 3599 // It's tempting to want to call getConstantMaxBackedgeTakenCount count here and 3600 // use that information to infer NUW and NSW flags. However, computing a 3601 // BE count requires calling getAddRecExpr, so we may not yet have a 3602 // meaningful BE count at this point (and if we don't, we'd be stuck 3603 // with a SCEVCouldNotCompute as the cached BE count). 3604 3605 Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags); 3606 3607 // Canonicalize nested AddRecs in by nesting them in order of loop depth. 3608 if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) { 3609 const Loop *NestedLoop = NestedAR->getLoop(); 3610 if (L->contains(NestedLoop) 3611 ? (L->getLoopDepth() < NestedLoop->getLoopDepth()) 3612 : (!NestedLoop->contains(L) && 3613 DT.dominates(L->getHeader(), NestedLoop->getHeader()))) { 3614 SmallVector<const SCEV *, 4> NestedOperands(NestedAR->operands()); 3615 Operands[0] = NestedAR->getStart(); 3616 // AddRecs require their operands be loop-invariant with respect to their 3617 // loops. Don't perform this transformation if it would break this 3618 // requirement. 3619 bool AllInvariant = all_of( 3620 Operands, [&](const SCEV *Op) { return isLoopInvariant(Op, L); }); 3621 3622 if (AllInvariant) { 3623 // Create a recurrence for the outer loop with the same step size. 3624 // 3625 // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the 3626 // inner recurrence has the same property. 3627 SCEV::NoWrapFlags OuterFlags = 3628 maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags()); 3629 3630 NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags); 3631 AllInvariant = all_of(NestedOperands, [&](const SCEV *Op) { 3632 return isLoopInvariant(Op, NestedLoop); 3633 }); 3634 3635 if (AllInvariant) { 3636 // Ok, both add recurrences are valid after the transformation. 3637 // 3638 // The inner recurrence keeps its NW flag but only keeps NUW/NSW if 3639 // the outer recurrence has the same property. 3640 SCEV::NoWrapFlags InnerFlags = 3641 maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags); 3642 return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags); 3643 } 3644 } 3645 // Reset Operands to its original state. 3646 Operands[0] = NestedAR; 3647 } 3648 } 3649 3650 // Okay, it looks like we really DO need an addrec expr. Check to see if we 3651 // already have one, otherwise create a new one. 3652 return getOrCreateAddRecExpr(Operands, L, Flags); 3653 } 3654 3655 const SCEV * 3656 ScalarEvolution::getGEPExpr(GEPOperator *GEP, 3657 const SmallVectorImpl<const SCEV *> &IndexExprs) { 3658 const SCEV *BaseExpr = getSCEV(GEP->getPointerOperand()); 3659 // getSCEV(Base)->getType() has the same address space as Base->getType() 3660 // because SCEV::getType() preserves the address space. 3661 Type *IntIdxTy = getEffectiveSCEVType(BaseExpr->getType()); 3662 const bool AssumeInBoundsFlags = [&]() { 3663 if (!GEP->isInBounds()) 3664 return false; 3665 3666 // We'd like to propagate flags from the IR to the corresponding SCEV nodes, 3667 // but to do that, we have to ensure that said flag is valid in the entire 3668 // defined scope of the SCEV. 3669 auto *GEPI = dyn_cast<Instruction>(GEP); 3670 // TODO: non-instructions have global scope. We might be able to prove 3671 // some global scope cases 3672 return GEPI && isSCEVExprNeverPoison(GEPI); 3673 }(); 3674 3675 SCEV::NoWrapFlags OffsetWrap = 3676 AssumeInBoundsFlags ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 3677 3678 Type *CurTy = GEP->getType(); 3679 bool FirstIter = true; 3680 SmallVector<const SCEV *, 4> Offsets; 3681 for (const SCEV *IndexExpr : IndexExprs) { 3682 // Compute the (potentially symbolic) offset in bytes for this index. 3683 if (StructType *STy = dyn_cast<StructType>(CurTy)) { 3684 // For a struct, add the member offset. 3685 ConstantInt *Index = cast<SCEVConstant>(IndexExpr)->getValue(); 3686 unsigned FieldNo = Index->getZExtValue(); 3687 const SCEV *FieldOffset = getOffsetOfExpr(IntIdxTy, STy, FieldNo); 3688 Offsets.push_back(FieldOffset); 3689 3690 // Update CurTy to the type of the field at Index. 3691 CurTy = STy->getTypeAtIndex(Index); 3692 } else { 3693 // Update CurTy to its element type. 3694 if (FirstIter) { 3695 assert(isa<PointerType>(CurTy) && 3696 "The first index of a GEP indexes a pointer"); 3697 CurTy = GEP->getSourceElementType(); 3698 FirstIter = false; 3699 } else { 3700 CurTy = GetElementPtrInst::getTypeAtIndex(CurTy, (uint64_t)0); 3701 } 3702 // For an array, add the element offset, explicitly scaled. 3703 const SCEV *ElementSize = getSizeOfExpr(IntIdxTy, CurTy); 3704 // Getelementptr indices are signed. 3705 IndexExpr = getTruncateOrSignExtend(IndexExpr, IntIdxTy); 3706 3707 // Multiply the index by the element size to compute the element offset. 3708 const SCEV *LocalOffset = getMulExpr(IndexExpr, ElementSize, OffsetWrap); 3709 Offsets.push_back(LocalOffset); 3710 } 3711 } 3712 3713 // Handle degenerate case of GEP without offsets. 3714 if (Offsets.empty()) 3715 return BaseExpr; 3716 3717 // Add the offsets together, assuming nsw if inbounds. 3718 const SCEV *Offset = getAddExpr(Offsets, OffsetWrap); 3719 // Add the base address and the offset. We cannot use the nsw flag, as the 3720 // base address is unsigned. However, if we know that the offset is 3721 // non-negative, we can use nuw. 3722 SCEV::NoWrapFlags BaseWrap = AssumeInBoundsFlags && isKnownNonNegative(Offset) 3723 ? SCEV::FlagNUW : SCEV::FlagAnyWrap; 3724 auto *GEPExpr = getAddExpr(BaseExpr, Offset, BaseWrap); 3725 assert(BaseExpr->getType() == GEPExpr->getType() && 3726 "GEP should not change type mid-flight."); 3727 return GEPExpr; 3728 } 3729 3730 SCEV *ScalarEvolution::findExistingSCEVInCache(SCEVTypes SCEVType, 3731 ArrayRef<const SCEV *> Ops) { 3732 FoldingSetNodeID ID; 3733 ID.AddInteger(SCEVType); 3734 for (const SCEV *Op : Ops) 3735 ID.AddPointer(Op); 3736 void *IP = nullptr; 3737 return UniqueSCEVs.FindNodeOrInsertPos(ID, IP); 3738 } 3739 3740 const SCEV *ScalarEvolution::getAbsExpr(const SCEV *Op, bool IsNSW) { 3741 SCEV::NoWrapFlags Flags = IsNSW ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 3742 return getSMaxExpr(Op, getNegativeSCEV(Op, Flags)); 3743 } 3744 3745 const SCEV *ScalarEvolution::getMinMaxExpr(SCEVTypes Kind, 3746 SmallVectorImpl<const SCEV *> &Ops) { 3747 assert(SCEVMinMaxExpr::isMinMaxType(Kind) && "Not a SCEVMinMaxExpr!"); 3748 assert(!Ops.empty() && "Cannot get empty (u|s)(min|max)!"); 3749 if (Ops.size() == 1) return Ops[0]; 3750 #ifndef NDEBUG 3751 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 3752 for (unsigned i = 1, e = Ops.size(); i != e; ++i) { 3753 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 3754 "Operand types don't match!"); 3755 assert(Ops[0]->getType()->isPointerTy() == 3756 Ops[i]->getType()->isPointerTy() && 3757 "min/max should be consistently pointerish"); 3758 } 3759 #endif 3760 3761 bool IsSigned = Kind == scSMaxExpr || Kind == scSMinExpr; 3762 bool IsMax = Kind == scSMaxExpr || Kind == scUMaxExpr; 3763 3764 // Sort by complexity, this groups all similar expression types together. 3765 GroupByComplexity(Ops, &LI, DT); 3766 3767 // Check if we have created the same expression before. 3768 if (const SCEV *S = findExistingSCEVInCache(Kind, Ops)) { 3769 return S; 3770 } 3771 3772 // If there are any constants, fold them together. 3773 unsigned Idx = 0; 3774 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 3775 ++Idx; 3776 assert(Idx < Ops.size()); 3777 auto FoldOp = [&](const APInt &LHS, const APInt &RHS) { 3778 if (Kind == scSMaxExpr) 3779 return APIntOps::smax(LHS, RHS); 3780 else if (Kind == scSMinExpr) 3781 return APIntOps::smin(LHS, RHS); 3782 else if (Kind == scUMaxExpr) 3783 return APIntOps::umax(LHS, RHS); 3784 else if (Kind == scUMinExpr) 3785 return APIntOps::umin(LHS, RHS); 3786 llvm_unreachable("Unknown SCEV min/max opcode"); 3787 }; 3788 3789 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 3790 // We found two constants, fold them together! 3791 ConstantInt *Fold = ConstantInt::get( 3792 getContext(), FoldOp(LHSC->getAPInt(), RHSC->getAPInt())); 3793 Ops[0] = getConstant(Fold); 3794 Ops.erase(Ops.begin()+1); // Erase the folded element 3795 if (Ops.size() == 1) return Ops[0]; 3796 LHSC = cast<SCEVConstant>(Ops[0]); 3797 } 3798 3799 bool IsMinV = LHSC->getValue()->isMinValue(IsSigned); 3800 bool IsMaxV = LHSC->getValue()->isMaxValue(IsSigned); 3801 3802 if (IsMax ? IsMinV : IsMaxV) { 3803 // If we are left with a constant minimum(/maximum)-int, strip it off. 3804 Ops.erase(Ops.begin()); 3805 --Idx; 3806 } else if (IsMax ? IsMaxV : IsMinV) { 3807 // If we have a max(/min) with a constant maximum(/minimum)-int, 3808 // it will always be the extremum. 3809 return LHSC; 3810 } 3811 3812 if (Ops.size() == 1) return Ops[0]; 3813 } 3814 3815 // Find the first operation of the same kind 3816 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < Kind) 3817 ++Idx; 3818 3819 // Check to see if one of the operands is of the same kind. If so, expand its 3820 // operands onto our operand list, and recurse to simplify. 3821 if (Idx < Ops.size()) { 3822 bool DeletedAny = false; 3823 while (Ops[Idx]->getSCEVType() == Kind) { 3824 const SCEVMinMaxExpr *SMME = cast<SCEVMinMaxExpr>(Ops[Idx]); 3825 Ops.erase(Ops.begin()+Idx); 3826 Ops.append(SMME->op_begin(), SMME->op_end()); 3827 DeletedAny = true; 3828 } 3829 3830 if (DeletedAny) 3831 return getMinMaxExpr(Kind, Ops); 3832 } 3833 3834 // Okay, check to see if the same value occurs in the operand list twice. If 3835 // so, delete one. Since we sorted the list, these values are required to 3836 // be adjacent. 3837 llvm::CmpInst::Predicate GEPred = 3838 IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 3839 llvm::CmpInst::Predicate LEPred = 3840 IsSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 3841 llvm::CmpInst::Predicate FirstPred = IsMax ? GEPred : LEPred; 3842 llvm::CmpInst::Predicate SecondPred = IsMax ? LEPred : GEPred; 3843 for (unsigned i = 0, e = Ops.size() - 1; i != e; ++i) { 3844 if (Ops[i] == Ops[i + 1] || 3845 isKnownViaNonRecursiveReasoning(FirstPred, Ops[i], Ops[i + 1])) { 3846 // X op Y op Y --> X op Y 3847 // X op Y --> X, if we know X, Y are ordered appropriately 3848 Ops.erase(Ops.begin() + i + 1, Ops.begin() + i + 2); 3849 --i; 3850 --e; 3851 } else if (isKnownViaNonRecursiveReasoning(SecondPred, Ops[i], 3852 Ops[i + 1])) { 3853 // X op Y --> Y, if we know X, Y are ordered appropriately 3854 Ops.erase(Ops.begin() + i, Ops.begin() + i + 1); 3855 --i; 3856 --e; 3857 } 3858 } 3859 3860 if (Ops.size() == 1) return Ops[0]; 3861 3862 assert(!Ops.empty() && "Reduced smax down to nothing!"); 3863 3864 // Okay, it looks like we really DO need an expr. Check to see if we 3865 // already have one, otherwise create a new one. 3866 FoldingSetNodeID ID; 3867 ID.AddInteger(Kind); 3868 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 3869 ID.AddPointer(Ops[i]); 3870 void *IP = nullptr; 3871 const SCEV *ExistingSCEV = UniqueSCEVs.FindNodeOrInsertPos(ID, IP); 3872 if (ExistingSCEV) 3873 return ExistingSCEV; 3874 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 3875 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 3876 SCEV *S = new (SCEVAllocator) 3877 SCEVMinMaxExpr(ID.Intern(SCEVAllocator), Kind, O, Ops.size()); 3878 3879 UniqueSCEVs.InsertNode(S, IP); 3880 registerUser(S, Ops); 3881 return S; 3882 } 3883 3884 namespace { 3885 3886 class SCEVSequentialMinMaxDeduplicatingVisitor final 3887 : public SCEVVisitor<SCEVSequentialMinMaxDeduplicatingVisitor, 3888 Optional<const SCEV *>> { 3889 using RetVal = Optional<const SCEV *>; 3890 using Base = SCEVVisitor<SCEVSequentialMinMaxDeduplicatingVisitor, RetVal>; 3891 3892 ScalarEvolution &SE; 3893 const SCEVTypes RootKind; // Must be a sequential min/max expression. 3894 const SCEVTypes NonSequentialRootKind; // Non-sequential variant of RootKind. 3895 SmallPtrSet<const SCEV *, 16> SeenOps; 3896 3897 bool canRecurseInto(SCEVTypes Kind) const { 3898 // We can only recurse into the SCEV expression of the same effective type 3899 // as the type of our root SCEV expression. 3900 return RootKind == Kind || NonSequentialRootKind == Kind; 3901 }; 3902 3903 RetVal visitAnyMinMaxExpr(const SCEV *S) { 3904 assert((isa<SCEVMinMaxExpr>(S) || isa<SCEVSequentialMinMaxExpr>(S)) && 3905 "Only for min/max expressions."); 3906 SCEVTypes Kind = S->getSCEVType(); 3907 3908 if (!canRecurseInto(Kind)) 3909 return S; 3910 3911 auto *NAry = cast<SCEVNAryExpr>(S); 3912 SmallVector<const SCEV *> NewOps; 3913 bool Changed = 3914 visit(Kind, makeArrayRef(NAry->op_begin(), NAry->op_end()), NewOps); 3915 3916 if (!Changed) 3917 return S; 3918 if (NewOps.empty()) 3919 return None; 3920 3921 return isa<SCEVSequentialMinMaxExpr>(S) 3922 ? SE.getSequentialMinMaxExpr(Kind, NewOps) 3923 : SE.getMinMaxExpr(Kind, NewOps); 3924 } 3925 3926 RetVal visit(const SCEV *S) { 3927 // Has the whole operand been seen already? 3928 if (!SeenOps.insert(S).second) 3929 return None; 3930 return Base::visit(S); 3931 } 3932 3933 public: 3934 SCEVSequentialMinMaxDeduplicatingVisitor(ScalarEvolution &SE, 3935 SCEVTypes RootKind) 3936 : SE(SE), RootKind(RootKind), 3937 NonSequentialRootKind( 3938 SCEVSequentialMinMaxExpr::getEquivalentNonSequentialSCEVType( 3939 RootKind)) {} 3940 3941 bool /*Changed*/ visit(SCEVTypes Kind, ArrayRef<const SCEV *> OrigOps, 3942 SmallVectorImpl<const SCEV *> &NewOps) { 3943 bool Changed = false; 3944 SmallVector<const SCEV *> Ops; 3945 Ops.reserve(OrigOps.size()); 3946 3947 for (const SCEV *Op : OrigOps) { 3948 RetVal NewOp = visit(Op); 3949 if (NewOp != Op) 3950 Changed = true; 3951 if (NewOp) 3952 Ops.emplace_back(*NewOp); 3953 } 3954 3955 if (Changed) 3956 NewOps = std::move(Ops); 3957 return Changed; 3958 } 3959 3960 RetVal visitConstant(const SCEVConstant *Constant) { return Constant; } 3961 3962 RetVal visitPtrToIntExpr(const SCEVPtrToIntExpr *Expr) { return Expr; } 3963 3964 RetVal visitTruncateExpr(const SCEVTruncateExpr *Expr) { return Expr; } 3965 3966 RetVal visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) { return Expr; } 3967 3968 RetVal visitSignExtendExpr(const SCEVSignExtendExpr *Expr) { return Expr; } 3969 3970 RetVal visitAddExpr(const SCEVAddExpr *Expr) { return Expr; } 3971 3972 RetVal visitMulExpr(const SCEVMulExpr *Expr) { return Expr; } 3973 3974 RetVal visitUDivExpr(const SCEVUDivExpr *Expr) { return Expr; } 3975 3976 RetVal visitAddRecExpr(const SCEVAddRecExpr *Expr) { return Expr; } 3977 3978 RetVal visitSMaxExpr(const SCEVSMaxExpr *Expr) { 3979 return visitAnyMinMaxExpr(Expr); 3980 } 3981 3982 RetVal visitUMaxExpr(const SCEVUMaxExpr *Expr) { 3983 return visitAnyMinMaxExpr(Expr); 3984 } 3985 3986 RetVal visitSMinExpr(const SCEVSMinExpr *Expr) { 3987 return visitAnyMinMaxExpr(Expr); 3988 } 3989 3990 RetVal visitUMinExpr(const SCEVUMinExpr *Expr) { 3991 return visitAnyMinMaxExpr(Expr); 3992 } 3993 3994 RetVal visitSequentialUMinExpr(const SCEVSequentialUMinExpr *Expr) { 3995 return visitAnyMinMaxExpr(Expr); 3996 } 3997 3998 RetVal visitUnknown(const SCEVUnknown *Expr) { return Expr; } 3999 4000 RetVal visitCouldNotCompute(const SCEVCouldNotCompute *Expr) { return Expr; } 4001 }; 4002 4003 } // namespace 4004 4005 const SCEV * 4006 ScalarEvolution::getSequentialMinMaxExpr(SCEVTypes Kind, 4007 SmallVectorImpl<const SCEV *> &Ops) { 4008 assert(SCEVSequentialMinMaxExpr::isSequentialMinMaxType(Kind) && 4009 "Not a SCEVSequentialMinMaxExpr!"); 4010 assert(!Ops.empty() && "Cannot get empty (u|s)(min|max)!"); 4011 if (Ops.size() == 1) 4012 return Ops[0]; 4013 if (Ops.size() == 2 && 4014 any_of(Ops, [](const SCEV *Op) { return isa<SCEVConstant>(Op); })) 4015 return getMinMaxExpr( 4016 SCEVSequentialMinMaxExpr::getEquivalentNonSequentialSCEVType(Kind), 4017 Ops); 4018 #ifndef NDEBUG 4019 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 4020 for (unsigned i = 1, e = Ops.size(); i != e; ++i) { 4021 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 4022 "Operand types don't match!"); 4023 assert(Ops[0]->getType()->isPointerTy() == 4024 Ops[i]->getType()->isPointerTy() && 4025 "min/max should be consistently pointerish"); 4026 } 4027 #endif 4028 4029 // Note that SCEVSequentialMinMaxExpr is *NOT* commutative, 4030 // so we can *NOT* do any kind of sorting of the expressions! 4031 4032 // Check if we have created the same expression before. 4033 if (const SCEV *S = findExistingSCEVInCache(Kind, Ops)) 4034 return S; 4035 4036 // FIXME: there are *some* simplifications that we can do here. 4037 4038 // Keep only the first instance of an operand. 4039 { 4040 SCEVSequentialMinMaxDeduplicatingVisitor Deduplicator(*this, Kind); 4041 bool Changed = Deduplicator.visit(Kind, Ops, Ops); 4042 if (Changed) 4043 return getSequentialMinMaxExpr(Kind, Ops); 4044 } 4045 4046 // Check to see if one of the operands is of the same kind. If so, expand its 4047 // operands onto our operand list, and recurse to simplify. 4048 { 4049 unsigned Idx = 0; 4050 bool DeletedAny = false; 4051 while (Idx < Ops.size()) { 4052 if (Ops[Idx]->getSCEVType() != Kind) { 4053 ++Idx; 4054 continue; 4055 } 4056 const auto *SMME = cast<SCEVSequentialMinMaxExpr>(Ops[Idx]); 4057 Ops.erase(Ops.begin() + Idx); 4058 Ops.insert(Ops.begin() + Idx, SMME->op_begin(), SMME->op_end()); 4059 DeletedAny = true; 4060 } 4061 4062 if (DeletedAny) 4063 return getSequentialMinMaxExpr(Kind, Ops); 4064 } 4065 4066 // Okay, it looks like we really DO need an expr. Check to see if we 4067 // already have one, otherwise create a new one. 4068 FoldingSetNodeID ID; 4069 ID.AddInteger(Kind); 4070 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 4071 ID.AddPointer(Ops[i]); 4072 void *IP = nullptr; 4073 const SCEV *ExistingSCEV = UniqueSCEVs.FindNodeOrInsertPos(ID, IP); 4074 if (ExistingSCEV) 4075 return ExistingSCEV; 4076 4077 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 4078 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 4079 SCEV *S = new (SCEVAllocator) 4080 SCEVSequentialMinMaxExpr(ID.Intern(SCEVAllocator), Kind, O, Ops.size()); 4081 4082 UniqueSCEVs.InsertNode(S, IP); 4083 registerUser(S, Ops); 4084 return S; 4085 } 4086 4087 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS, const SCEV *RHS) { 4088 SmallVector<const SCEV *, 2> Ops = {LHS, RHS}; 4089 return getSMaxExpr(Ops); 4090 } 4091 4092 const SCEV *ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) { 4093 return getMinMaxExpr(scSMaxExpr, Ops); 4094 } 4095 4096 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS, const SCEV *RHS) { 4097 SmallVector<const SCEV *, 2> Ops = {LHS, RHS}; 4098 return getUMaxExpr(Ops); 4099 } 4100 4101 const SCEV *ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) { 4102 return getMinMaxExpr(scUMaxExpr, Ops); 4103 } 4104 4105 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS, 4106 const SCEV *RHS) { 4107 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 4108 return getSMinExpr(Ops); 4109 } 4110 4111 const SCEV *ScalarEvolution::getSMinExpr(SmallVectorImpl<const SCEV *> &Ops) { 4112 return getMinMaxExpr(scSMinExpr, Ops); 4113 } 4114 4115 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS, const SCEV *RHS, 4116 bool Sequential) { 4117 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 4118 return getUMinExpr(Ops, Sequential); 4119 } 4120 4121 const SCEV *ScalarEvolution::getUMinExpr(SmallVectorImpl<const SCEV *> &Ops, 4122 bool Sequential) { 4123 return Sequential ? getSequentialMinMaxExpr(scSequentialUMinExpr, Ops) 4124 : getMinMaxExpr(scUMinExpr, Ops); 4125 } 4126 4127 const SCEV * 4128 ScalarEvolution::getSizeOfScalableVectorExpr(Type *IntTy, 4129 ScalableVectorType *ScalableTy) { 4130 Constant *NullPtr = Constant::getNullValue(ScalableTy->getPointerTo()); 4131 Constant *One = ConstantInt::get(IntTy, 1); 4132 Constant *GEP = ConstantExpr::getGetElementPtr(ScalableTy, NullPtr, One); 4133 // Note that the expression we created is the final expression, we don't 4134 // want to simplify it any further Also, if we call a normal getSCEV(), 4135 // we'll end up in an endless recursion. So just create an SCEVUnknown. 4136 return getUnknown(ConstantExpr::getPtrToInt(GEP, IntTy)); 4137 } 4138 4139 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) { 4140 if (auto *ScalableAllocTy = dyn_cast<ScalableVectorType>(AllocTy)) 4141 return getSizeOfScalableVectorExpr(IntTy, ScalableAllocTy); 4142 // We can bypass creating a target-independent constant expression and then 4143 // folding it back into a ConstantInt. This is just a compile-time 4144 // optimization. 4145 return getConstant(IntTy, getDataLayout().getTypeAllocSize(AllocTy)); 4146 } 4147 4148 const SCEV *ScalarEvolution::getStoreSizeOfExpr(Type *IntTy, Type *StoreTy) { 4149 if (auto *ScalableStoreTy = dyn_cast<ScalableVectorType>(StoreTy)) 4150 return getSizeOfScalableVectorExpr(IntTy, ScalableStoreTy); 4151 // We can bypass creating a target-independent constant expression and then 4152 // folding it back into a ConstantInt. This is just a compile-time 4153 // optimization. 4154 return getConstant(IntTy, getDataLayout().getTypeStoreSize(StoreTy)); 4155 } 4156 4157 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy, 4158 StructType *STy, 4159 unsigned FieldNo) { 4160 // We can bypass creating a target-independent constant expression and then 4161 // folding it back into a ConstantInt. This is just a compile-time 4162 // optimization. 4163 return getConstant( 4164 IntTy, getDataLayout().getStructLayout(STy)->getElementOffset(FieldNo)); 4165 } 4166 4167 const SCEV *ScalarEvolution::getUnknown(Value *V) { 4168 // Don't attempt to do anything other than create a SCEVUnknown object 4169 // here. createSCEV only calls getUnknown after checking for all other 4170 // interesting possibilities, and any other code that calls getUnknown 4171 // is doing so in order to hide a value from SCEV canonicalization. 4172 4173 FoldingSetNodeID ID; 4174 ID.AddInteger(scUnknown); 4175 ID.AddPointer(V); 4176 void *IP = nullptr; 4177 if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) { 4178 assert(cast<SCEVUnknown>(S)->getValue() == V && 4179 "Stale SCEVUnknown in uniquing map!"); 4180 return S; 4181 } 4182 SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this, 4183 FirstUnknown); 4184 FirstUnknown = cast<SCEVUnknown>(S); 4185 UniqueSCEVs.InsertNode(S, IP); 4186 return S; 4187 } 4188 4189 //===----------------------------------------------------------------------===// 4190 // Basic SCEV Analysis and PHI Idiom Recognition Code 4191 // 4192 4193 /// Test if values of the given type are analyzable within the SCEV 4194 /// framework. This primarily includes integer types, and it can optionally 4195 /// include pointer types if the ScalarEvolution class has access to 4196 /// target-specific information. 4197 bool ScalarEvolution::isSCEVable(Type *Ty) const { 4198 // Integers and pointers are always SCEVable. 4199 return Ty->isIntOrPtrTy(); 4200 } 4201 4202 /// Return the size in bits of the specified type, for which isSCEVable must 4203 /// return true. 4204 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const { 4205 assert(isSCEVable(Ty) && "Type is not SCEVable!"); 4206 if (Ty->isPointerTy()) 4207 return getDataLayout().getIndexTypeSizeInBits(Ty); 4208 return getDataLayout().getTypeSizeInBits(Ty); 4209 } 4210 4211 /// Return a type with the same bitwidth as the given type and which represents 4212 /// how SCEV will treat the given type, for which isSCEVable must return 4213 /// true. For pointer types, this is the pointer index sized integer type. 4214 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const { 4215 assert(isSCEVable(Ty) && "Type is not SCEVable!"); 4216 4217 if (Ty->isIntegerTy()) 4218 return Ty; 4219 4220 // The only other support type is pointer. 4221 assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!"); 4222 return getDataLayout().getIndexType(Ty); 4223 } 4224 4225 Type *ScalarEvolution::getWiderType(Type *T1, Type *T2) const { 4226 return getTypeSizeInBits(T1) >= getTypeSizeInBits(T2) ? T1 : T2; 4227 } 4228 4229 bool ScalarEvolution::instructionCouldExistWitthOperands(const SCEV *A, 4230 const SCEV *B) { 4231 /// For a valid use point to exist, the defining scope of one operand 4232 /// must dominate the other. 4233 bool PreciseA, PreciseB; 4234 auto *ScopeA = getDefiningScopeBound({A}, PreciseA); 4235 auto *ScopeB = getDefiningScopeBound({B}, PreciseB); 4236 if (!PreciseA || !PreciseB) 4237 // Can't tell. 4238 return false; 4239 return (ScopeA == ScopeB) || DT.dominates(ScopeA, ScopeB) || 4240 DT.dominates(ScopeB, ScopeA); 4241 } 4242 4243 4244 const SCEV *ScalarEvolution::getCouldNotCompute() { 4245 return CouldNotCompute.get(); 4246 } 4247 4248 bool ScalarEvolution::checkValidity(const SCEV *S) const { 4249 bool ContainsNulls = SCEVExprContains(S, [](const SCEV *S) { 4250 auto *SU = dyn_cast<SCEVUnknown>(S); 4251 return SU && SU->getValue() == nullptr; 4252 }); 4253 4254 return !ContainsNulls; 4255 } 4256 4257 bool ScalarEvolution::containsAddRecurrence(const SCEV *S) { 4258 HasRecMapType::iterator I = HasRecMap.find(S); 4259 if (I != HasRecMap.end()) 4260 return I->second; 4261 4262 bool FoundAddRec = 4263 SCEVExprContains(S, [](const SCEV *S) { return isa<SCEVAddRecExpr>(S); }); 4264 HasRecMap.insert({S, FoundAddRec}); 4265 return FoundAddRec; 4266 } 4267 4268 /// Try to split a SCEVAddExpr into a pair of {SCEV, ConstantInt}. 4269 /// If \p S is a SCEVAddExpr and is composed of a sub SCEV S' and an 4270 /// offset I, then return {S', I}, else return {\p S, nullptr}. 4271 static std::pair<const SCEV *, ConstantInt *> splitAddExpr(const SCEV *S) { 4272 const auto *Add = dyn_cast<SCEVAddExpr>(S); 4273 if (!Add) 4274 return {S, nullptr}; 4275 4276 if (Add->getNumOperands() != 2) 4277 return {S, nullptr}; 4278 4279 auto *ConstOp = dyn_cast<SCEVConstant>(Add->getOperand(0)); 4280 if (!ConstOp) 4281 return {S, nullptr}; 4282 4283 return {Add->getOperand(1), ConstOp->getValue()}; 4284 } 4285 4286 /// Return the ValueOffsetPair set for \p S. \p S can be represented 4287 /// by the value and offset from any ValueOffsetPair in the set. 4288 ScalarEvolution::ValueOffsetPairSetVector * 4289 ScalarEvolution::getSCEVValues(const SCEV *S) { 4290 ExprValueMapType::iterator SI = ExprValueMap.find_as(S); 4291 if (SI == ExprValueMap.end()) 4292 return nullptr; 4293 #ifndef NDEBUG 4294 if (VerifySCEVMap) { 4295 // Check there is no dangling Value in the set returned. 4296 for (const auto &VE : SI->second) 4297 assert(ValueExprMap.count(VE.first)); 4298 } 4299 #endif 4300 return &SI->second; 4301 } 4302 4303 /// Erase Value from ValueExprMap and ExprValueMap. ValueExprMap.erase(V) 4304 /// cannot be used separately. eraseValueFromMap should be used to remove 4305 /// V from ValueExprMap and ExprValueMap at the same time. 4306 void ScalarEvolution::eraseValueFromMap(Value *V) { 4307 ValueExprMapType::iterator I = ValueExprMap.find_as(V); 4308 if (I != ValueExprMap.end()) { 4309 const SCEV *S = I->second; 4310 // Remove {V, 0} from the set of ExprValueMap[S] 4311 if (auto *SV = getSCEVValues(S)) 4312 SV->remove({V, nullptr}); 4313 4314 // Remove {V, Offset} from the set of ExprValueMap[Stripped] 4315 const SCEV *Stripped; 4316 ConstantInt *Offset; 4317 std::tie(Stripped, Offset) = splitAddExpr(S); 4318 if (Offset != nullptr) { 4319 if (auto *SV = getSCEVValues(Stripped)) 4320 SV->remove({V, Offset}); 4321 } 4322 ValueExprMap.erase(V); 4323 } 4324 } 4325 4326 void ScalarEvolution::insertValueToMap(Value *V, const SCEV *S) { 4327 // A recursive query may have already computed the SCEV. It should be 4328 // equivalent, but may not necessarily be exactly the same, e.g. due to lazily 4329 // inferred nowrap flags. 4330 auto It = ValueExprMap.find_as(V); 4331 if (It == ValueExprMap.end()) { 4332 ValueExprMap.insert({SCEVCallbackVH(V, this), S}); 4333 ExprValueMap[S].insert({V, nullptr}); 4334 } 4335 } 4336 4337 /// Return an existing SCEV if it exists, otherwise analyze the expression and 4338 /// create a new one. 4339 const SCEV *ScalarEvolution::getSCEV(Value *V) { 4340 assert(isSCEVable(V->getType()) && "Value is not SCEVable!"); 4341 4342 const SCEV *S = getExistingSCEV(V); 4343 if (S == nullptr) { 4344 S = createSCEV(V); 4345 // During PHI resolution, it is possible to create two SCEVs for the same 4346 // V, so it is needed to double check whether V->S is inserted into 4347 // ValueExprMap before insert S->{V, 0} into ExprValueMap. 4348 std::pair<ValueExprMapType::iterator, bool> Pair = 4349 ValueExprMap.insert({SCEVCallbackVH(V, this), S}); 4350 if (Pair.second) { 4351 ExprValueMap[S].insert({V, nullptr}); 4352 4353 // If S == Stripped + Offset, add Stripped -> {V, Offset} into 4354 // ExprValueMap. 4355 const SCEV *Stripped = S; 4356 ConstantInt *Offset = nullptr; 4357 std::tie(Stripped, Offset) = splitAddExpr(S); 4358 // If stripped is SCEVUnknown, don't bother to save 4359 // Stripped -> {V, offset}. It doesn't simplify and sometimes even 4360 // increase the complexity of the expansion code. 4361 // If V is GetElementPtrInst, don't save Stripped -> {V, offset} 4362 // because it may generate add/sub instead of GEP in SCEV expansion. 4363 if (Offset != nullptr && !isa<SCEVUnknown>(Stripped) && 4364 !isa<GetElementPtrInst>(V)) 4365 ExprValueMap[Stripped].insert({V, Offset}); 4366 } 4367 } 4368 return S; 4369 } 4370 4371 const SCEV *ScalarEvolution::getExistingSCEV(Value *V) { 4372 assert(isSCEVable(V->getType()) && "Value is not SCEVable!"); 4373 4374 ValueExprMapType::iterator I = ValueExprMap.find_as(V); 4375 if (I != ValueExprMap.end()) { 4376 const SCEV *S = I->second; 4377 assert(checkValidity(S) && 4378 "existing SCEV has not been properly invalidated"); 4379 return S; 4380 } 4381 return nullptr; 4382 } 4383 4384 /// Return a SCEV corresponding to -V = -1*V 4385 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V, 4386 SCEV::NoWrapFlags Flags) { 4387 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V)) 4388 return getConstant( 4389 cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue()))); 4390 4391 Type *Ty = V->getType(); 4392 Ty = getEffectiveSCEVType(Ty); 4393 return getMulExpr(V, getMinusOne(Ty), Flags); 4394 } 4395 4396 /// If Expr computes ~A, return A else return nullptr 4397 static const SCEV *MatchNotExpr(const SCEV *Expr) { 4398 const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr); 4399 if (!Add || Add->getNumOperands() != 2 || 4400 !Add->getOperand(0)->isAllOnesValue()) 4401 return nullptr; 4402 4403 const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1)); 4404 if (!AddRHS || AddRHS->getNumOperands() != 2 || 4405 !AddRHS->getOperand(0)->isAllOnesValue()) 4406 return nullptr; 4407 4408 return AddRHS->getOperand(1); 4409 } 4410 4411 /// Return a SCEV corresponding to ~V = -1-V 4412 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) { 4413 assert(!V->getType()->isPointerTy() && "Can't negate pointer"); 4414 4415 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V)) 4416 return getConstant( 4417 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue()))); 4418 4419 // Fold ~(u|s)(min|max)(~x, ~y) to (u|s)(max|min)(x, y) 4420 if (const SCEVMinMaxExpr *MME = dyn_cast<SCEVMinMaxExpr>(V)) { 4421 auto MatchMinMaxNegation = [&](const SCEVMinMaxExpr *MME) { 4422 SmallVector<const SCEV *, 2> MatchedOperands; 4423 for (const SCEV *Operand : MME->operands()) { 4424 const SCEV *Matched = MatchNotExpr(Operand); 4425 if (!Matched) 4426 return (const SCEV *)nullptr; 4427 MatchedOperands.push_back(Matched); 4428 } 4429 return getMinMaxExpr(SCEVMinMaxExpr::negate(MME->getSCEVType()), 4430 MatchedOperands); 4431 }; 4432 if (const SCEV *Replaced = MatchMinMaxNegation(MME)) 4433 return Replaced; 4434 } 4435 4436 Type *Ty = V->getType(); 4437 Ty = getEffectiveSCEVType(Ty); 4438 return getMinusSCEV(getMinusOne(Ty), V); 4439 } 4440 4441 const SCEV *ScalarEvolution::removePointerBase(const SCEV *P) { 4442 assert(P->getType()->isPointerTy()); 4443 4444 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(P)) { 4445 // The base of an AddRec is the first operand. 4446 SmallVector<const SCEV *> Ops{AddRec->operands()}; 4447 Ops[0] = removePointerBase(Ops[0]); 4448 // Don't try to transfer nowrap flags for now. We could in some cases 4449 // (for example, if pointer operand of the AddRec is a SCEVUnknown). 4450 return getAddRecExpr(Ops, AddRec->getLoop(), SCEV::FlagAnyWrap); 4451 } 4452 if (auto *Add = dyn_cast<SCEVAddExpr>(P)) { 4453 // The base of an Add is the pointer operand. 4454 SmallVector<const SCEV *> Ops{Add->operands()}; 4455 const SCEV **PtrOp = nullptr; 4456 for (const SCEV *&AddOp : Ops) { 4457 if (AddOp->getType()->isPointerTy()) { 4458 assert(!PtrOp && "Cannot have multiple pointer ops"); 4459 PtrOp = &AddOp; 4460 } 4461 } 4462 *PtrOp = removePointerBase(*PtrOp); 4463 // Don't try to transfer nowrap flags for now. We could in some cases 4464 // (for example, if the pointer operand of the Add is a SCEVUnknown). 4465 return getAddExpr(Ops); 4466 } 4467 // Any other expression must be a pointer base. 4468 return getZero(P->getType()); 4469 } 4470 4471 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS, 4472 SCEV::NoWrapFlags Flags, 4473 unsigned Depth) { 4474 // Fast path: X - X --> 0. 4475 if (LHS == RHS) 4476 return getZero(LHS->getType()); 4477 4478 // If we subtract two pointers with different pointer bases, bail. 4479 // Eventually, we're going to add an assertion to getMulExpr that we 4480 // can't multiply by a pointer. 4481 if (RHS->getType()->isPointerTy()) { 4482 if (!LHS->getType()->isPointerTy() || 4483 getPointerBase(LHS) != getPointerBase(RHS)) 4484 return getCouldNotCompute(); 4485 LHS = removePointerBase(LHS); 4486 RHS = removePointerBase(RHS); 4487 } 4488 4489 // We represent LHS - RHS as LHS + (-1)*RHS. This transformation 4490 // makes it so that we cannot make much use of NUW. 4491 auto AddFlags = SCEV::FlagAnyWrap; 4492 const bool RHSIsNotMinSigned = 4493 !getSignedRangeMin(RHS).isMinSignedValue(); 4494 if (hasFlags(Flags, SCEV::FlagNSW)) { 4495 // Let M be the minimum representable signed value. Then (-1)*RHS 4496 // signed-wraps if and only if RHS is M. That can happen even for 4497 // a NSW subtraction because e.g. (-1)*M signed-wraps even though 4498 // -1 - M does not. So to transfer NSW from LHS - RHS to LHS + 4499 // (-1)*RHS, we need to prove that RHS != M. 4500 // 4501 // If LHS is non-negative and we know that LHS - RHS does not 4502 // signed-wrap, then RHS cannot be M. So we can rule out signed-wrap 4503 // either by proving that RHS > M or that LHS >= 0. 4504 if (RHSIsNotMinSigned || isKnownNonNegative(LHS)) { 4505 AddFlags = SCEV::FlagNSW; 4506 } 4507 } 4508 4509 // FIXME: Find a correct way to transfer NSW to (-1)*M when LHS - 4510 // RHS is NSW and LHS >= 0. 4511 // 4512 // The difficulty here is that the NSW flag may have been proven 4513 // relative to a loop that is to be found in a recurrence in LHS and 4514 // not in RHS. Applying NSW to (-1)*M may then let the NSW have a 4515 // larger scope than intended. 4516 auto NegFlags = RHSIsNotMinSigned ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 4517 4518 return getAddExpr(LHS, getNegativeSCEV(RHS, NegFlags), AddFlags, Depth); 4519 } 4520 4521 const SCEV *ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty, 4522 unsigned Depth) { 4523 Type *SrcTy = V->getType(); 4524 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4525 "Cannot truncate or zero extend with non-integer arguments!"); 4526 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4527 return V; // No conversion 4528 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty)) 4529 return getTruncateExpr(V, Ty, Depth); 4530 return getZeroExtendExpr(V, Ty, Depth); 4531 } 4532 4533 const SCEV *ScalarEvolution::getTruncateOrSignExtend(const SCEV *V, Type *Ty, 4534 unsigned Depth) { 4535 Type *SrcTy = V->getType(); 4536 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4537 "Cannot truncate or zero extend with non-integer arguments!"); 4538 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4539 return V; // No conversion 4540 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty)) 4541 return getTruncateExpr(V, Ty, Depth); 4542 return getSignExtendExpr(V, Ty, Depth); 4543 } 4544 4545 const SCEV * 4546 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) { 4547 Type *SrcTy = V->getType(); 4548 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4549 "Cannot noop or zero extend with non-integer arguments!"); 4550 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4551 "getNoopOrZeroExtend cannot truncate!"); 4552 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4553 return V; // No conversion 4554 return getZeroExtendExpr(V, Ty); 4555 } 4556 4557 const SCEV * 4558 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) { 4559 Type *SrcTy = V->getType(); 4560 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4561 "Cannot noop or sign extend with non-integer arguments!"); 4562 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4563 "getNoopOrSignExtend cannot truncate!"); 4564 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4565 return V; // No conversion 4566 return getSignExtendExpr(V, Ty); 4567 } 4568 4569 const SCEV * 4570 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) { 4571 Type *SrcTy = V->getType(); 4572 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4573 "Cannot noop or any extend with non-integer arguments!"); 4574 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4575 "getNoopOrAnyExtend cannot truncate!"); 4576 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4577 return V; // No conversion 4578 return getAnyExtendExpr(V, Ty); 4579 } 4580 4581 const SCEV * 4582 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) { 4583 Type *SrcTy = V->getType(); 4584 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4585 "Cannot truncate or noop with non-integer arguments!"); 4586 assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) && 4587 "getTruncateOrNoop cannot extend!"); 4588 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4589 return V; // No conversion 4590 return getTruncateExpr(V, Ty); 4591 } 4592 4593 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS, 4594 const SCEV *RHS) { 4595 const SCEV *PromotedLHS = LHS; 4596 const SCEV *PromotedRHS = RHS; 4597 4598 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType())) 4599 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType()); 4600 else 4601 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType()); 4602 4603 return getUMaxExpr(PromotedLHS, PromotedRHS); 4604 } 4605 4606 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS, 4607 const SCEV *RHS, 4608 bool Sequential) { 4609 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 4610 return getUMinFromMismatchedTypes(Ops, Sequential); 4611 } 4612 4613 const SCEV * 4614 ScalarEvolution::getUMinFromMismatchedTypes(SmallVectorImpl<const SCEV *> &Ops, 4615 bool Sequential) { 4616 assert(!Ops.empty() && "At least one operand must be!"); 4617 // Trivial case. 4618 if (Ops.size() == 1) 4619 return Ops[0]; 4620 4621 // Find the max type first. 4622 Type *MaxType = nullptr; 4623 for (auto *S : Ops) 4624 if (MaxType) 4625 MaxType = getWiderType(MaxType, S->getType()); 4626 else 4627 MaxType = S->getType(); 4628 assert(MaxType && "Failed to find maximum type!"); 4629 4630 // Extend all ops to max type. 4631 SmallVector<const SCEV *, 2> PromotedOps; 4632 for (auto *S : Ops) 4633 PromotedOps.push_back(getNoopOrZeroExtend(S, MaxType)); 4634 4635 // Generate umin. 4636 return getUMinExpr(PromotedOps, Sequential); 4637 } 4638 4639 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) { 4640 // A pointer operand may evaluate to a nonpointer expression, such as null. 4641 if (!V->getType()->isPointerTy()) 4642 return V; 4643 4644 while (true) { 4645 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(V)) { 4646 V = AddRec->getStart(); 4647 } else if (auto *Add = dyn_cast<SCEVAddExpr>(V)) { 4648 const SCEV *PtrOp = nullptr; 4649 for (const SCEV *AddOp : Add->operands()) { 4650 if (AddOp->getType()->isPointerTy()) { 4651 assert(!PtrOp && "Cannot have multiple pointer ops"); 4652 PtrOp = AddOp; 4653 } 4654 } 4655 assert(PtrOp && "Must have pointer op"); 4656 V = PtrOp; 4657 } else // Not something we can look further into. 4658 return V; 4659 } 4660 } 4661 4662 /// Push users of the given Instruction onto the given Worklist. 4663 static void PushDefUseChildren(Instruction *I, 4664 SmallVectorImpl<Instruction *> &Worklist, 4665 SmallPtrSetImpl<Instruction *> &Visited) { 4666 // Push the def-use children onto the Worklist stack. 4667 for (User *U : I->users()) { 4668 auto *UserInsn = cast<Instruction>(U); 4669 if (Visited.insert(UserInsn).second) 4670 Worklist.push_back(UserInsn); 4671 } 4672 } 4673 4674 namespace { 4675 4676 /// Takes SCEV S and Loop L. For each AddRec sub-expression, use its start 4677 /// expression in case its Loop is L. If it is not L then 4678 /// if IgnoreOtherLoops is true then use AddRec itself 4679 /// otherwise rewrite cannot be done. 4680 /// If SCEV contains non-invariant unknown SCEV rewrite cannot be done. 4681 class SCEVInitRewriter : public SCEVRewriteVisitor<SCEVInitRewriter> { 4682 public: 4683 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE, 4684 bool IgnoreOtherLoops = true) { 4685 SCEVInitRewriter Rewriter(L, SE); 4686 const SCEV *Result = Rewriter.visit(S); 4687 if (Rewriter.hasSeenLoopVariantSCEVUnknown()) 4688 return SE.getCouldNotCompute(); 4689 return Rewriter.hasSeenOtherLoops() && !IgnoreOtherLoops 4690 ? SE.getCouldNotCompute() 4691 : Result; 4692 } 4693 4694 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4695 if (!SE.isLoopInvariant(Expr, L)) 4696 SeenLoopVariantSCEVUnknown = true; 4697 return Expr; 4698 } 4699 4700 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4701 // Only re-write AddRecExprs for this loop. 4702 if (Expr->getLoop() == L) 4703 return Expr->getStart(); 4704 SeenOtherLoops = true; 4705 return Expr; 4706 } 4707 4708 bool hasSeenLoopVariantSCEVUnknown() { return SeenLoopVariantSCEVUnknown; } 4709 4710 bool hasSeenOtherLoops() { return SeenOtherLoops; } 4711 4712 private: 4713 explicit SCEVInitRewriter(const Loop *L, ScalarEvolution &SE) 4714 : SCEVRewriteVisitor(SE), L(L) {} 4715 4716 const Loop *L; 4717 bool SeenLoopVariantSCEVUnknown = false; 4718 bool SeenOtherLoops = false; 4719 }; 4720 4721 /// Takes SCEV S and Loop L. For each AddRec sub-expression, use its post 4722 /// increment expression in case its Loop is L. If it is not L then 4723 /// use AddRec itself. 4724 /// If SCEV contains non-invariant unknown SCEV rewrite cannot be done. 4725 class SCEVPostIncRewriter : public SCEVRewriteVisitor<SCEVPostIncRewriter> { 4726 public: 4727 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE) { 4728 SCEVPostIncRewriter Rewriter(L, SE); 4729 const SCEV *Result = Rewriter.visit(S); 4730 return Rewriter.hasSeenLoopVariantSCEVUnknown() 4731 ? SE.getCouldNotCompute() 4732 : Result; 4733 } 4734 4735 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4736 if (!SE.isLoopInvariant(Expr, L)) 4737 SeenLoopVariantSCEVUnknown = true; 4738 return Expr; 4739 } 4740 4741 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4742 // Only re-write AddRecExprs for this loop. 4743 if (Expr->getLoop() == L) 4744 return Expr->getPostIncExpr(SE); 4745 SeenOtherLoops = true; 4746 return Expr; 4747 } 4748 4749 bool hasSeenLoopVariantSCEVUnknown() { return SeenLoopVariantSCEVUnknown; } 4750 4751 bool hasSeenOtherLoops() { return SeenOtherLoops; } 4752 4753 private: 4754 explicit SCEVPostIncRewriter(const Loop *L, ScalarEvolution &SE) 4755 : SCEVRewriteVisitor(SE), L(L) {} 4756 4757 const Loop *L; 4758 bool SeenLoopVariantSCEVUnknown = false; 4759 bool SeenOtherLoops = false; 4760 }; 4761 4762 /// This class evaluates the compare condition by matching it against the 4763 /// condition of loop latch. If there is a match we assume a true value 4764 /// for the condition while building SCEV nodes. 4765 class SCEVBackedgeConditionFolder 4766 : public SCEVRewriteVisitor<SCEVBackedgeConditionFolder> { 4767 public: 4768 static const SCEV *rewrite(const SCEV *S, const Loop *L, 4769 ScalarEvolution &SE) { 4770 bool IsPosBECond = false; 4771 Value *BECond = nullptr; 4772 if (BasicBlock *Latch = L->getLoopLatch()) { 4773 BranchInst *BI = dyn_cast<BranchInst>(Latch->getTerminator()); 4774 if (BI && BI->isConditional()) { 4775 assert(BI->getSuccessor(0) != BI->getSuccessor(1) && 4776 "Both outgoing branches should not target same header!"); 4777 BECond = BI->getCondition(); 4778 IsPosBECond = BI->getSuccessor(0) == L->getHeader(); 4779 } else { 4780 return S; 4781 } 4782 } 4783 SCEVBackedgeConditionFolder Rewriter(L, BECond, IsPosBECond, SE); 4784 return Rewriter.visit(S); 4785 } 4786 4787 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4788 const SCEV *Result = Expr; 4789 bool InvariantF = SE.isLoopInvariant(Expr, L); 4790 4791 if (!InvariantF) { 4792 Instruction *I = cast<Instruction>(Expr->getValue()); 4793 switch (I->getOpcode()) { 4794 case Instruction::Select: { 4795 SelectInst *SI = cast<SelectInst>(I); 4796 Optional<const SCEV *> Res = 4797 compareWithBackedgeCondition(SI->getCondition()); 4798 if (Res.hasValue()) { 4799 bool IsOne = cast<SCEVConstant>(Res.getValue())->getValue()->isOne(); 4800 Result = SE.getSCEV(IsOne ? SI->getTrueValue() : SI->getFalseValue()); 4801 } 4802 break; 4803 } 4804 default: { 4805 Optional<const SCEV *> Res = compareWithBackedgeCondition(I); 4806 if (Res.hasValue()) 4807 Result = Res.getValue(); 4808 break; 4809 } 4810 } 4811 } 4812 return Result; 4813 } 4814 4815 private: 4816 explicit SCEVBackedgeConditionFolder(const Loop *L, Value *BECond, 4817 bool IsPosBECond, ScalarEvolution &SE) 4818 : SCEVRewriteVisitor(SE), L(L), BackedgeCond(BECond), 4819 IsPositiveBECond(IsPosBECond) {} 4820 4821 Optional<const SCEV *> compareWithBackedgeCondition(Value *IC); 4822 4823 const Loop *L; 4824 /// Loop back condition. 4825 Value *BackedgeCond = nullptr; 4826 /// Set to true if loop back is on positive branch condition. 4827 bool IsPositiveBECond; 4828 }; 4829 4830 Optional<const SCEV *> 4831 SCEVBackedgeConditionFolder::compareWithBackedgeCondition(Value *IC) { 4832 4833 // If value matches the backedge condition for loop latch, 4834 // then return a constant evolution node based on loopback 4835 // branch taken. 4836 if (BackedgeCond == IC) 4837 return IsPositiveBECond ? SE.getOne(Type::getInt1Ty(SE.getContext())) 4838 : SE.getZero(Type::getInt1Ty(SE.getContext())); 4839 return None; 4840 } 4841 4842 class SCEVShiftRewriter : public SCEVRewriteVisitor<SCEVShiftRewriter> { 4843 public: 4844 static const SCEV *rewrite(const SCEV *S, const Loop *L, 4845 ScalarEvolution &SE) { 4846 SCEVShiftRewriter Rewriter(L, SE); 4847 const SCEV *Result = Rewriter.visit(S); 4848 return Rewriter.isValid() ? Result : SE.getCouldNotCompute(); 4849 } 4850 4851 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4852 // Only allow AddRecExprs for this loop. 4853 if (!SE.isLoopInvariant(Expr, L)) 4854 Valid = false; 4855 return Expr; 4856 } 4857 4858 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4859 if (Expr->getLoop() == L && Expr->isAffine()) 4860 return SE.getMinusSCEV(Expr, Expr->getStepRecurrence(SE)); 4861 Valid = false; 4862 return Expr; 4863 } 4864 4865 bool isValid() { return Valid; } 4866 4867 private: 4868 explicit SCEVShiftRewriter(const Loop *L, ScalarEvolution &SE) 4869 : SCEVRewriteVisitor(SE), L(L) {} 4870 4871 const Loop *L; 4872 bool Valid = true; 4873 }; 4874 4875 } // end anonymous namespace 4876 4877 SCEV::NoWrapFlags 4878 ScalarEvolution::proveNoWrapViaConstantRanges(const SCEVAddRecExpr *AR) { 4879 if (!AR->isAffine()) 4880 return SCEV::FlagAnyWrap; 4881 4882 using OBO = OverflowingBinaryOperator; 4883 4884 SCEV::NoWrapFlags Result = SCEV::FlagAnyWrap; 4885 4886 if (!AR->hasNoSignedWrap()) { 4887 ConstantRange AddRecRange = getSignedRange(AR); 4888 ConstantRange IncRange = getSignedRange(AR->getStepRecurrence(*this)); 4889 4890 auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 4891 Instruction::Add, IncRange, OBO::NoSignedWrap); 4892 if (NSWRegion.contains(AddRecRange)) 4893 Result = ScalarEvolution::setFlags(Result, SCEV::FlagNSW); 4894 } 4895 4896 if (!AR->hasNoUnsignedWrap()) { 4897 ConstantRange AddRecRange = getUnsignedRange(AR); 4898 ConstantRange IncRange = getUnsignedRange(AR->getStepRecurrence(*this)); 4899 4900 auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 4901 Instruction::Add, IncRange, OBO::NoUnsignedWrap); 4902 if (NUWRegion.contains(AddRecRange)) 4903 Result = ScalarEvolution::setFlags(Result, SCEV::FlagNUW); 4904 } 4905 4906 return Result; 4907 } 4908 4909 SCEV::NoWrapFlags 4910 ScalarEvolution::proveNoSignedWrapViaInduction(const SCEVAddRecExpr *AR) { 4911 SCEV::NoWrapFlags Result = AR->getNoWrapFlags(); 4912 4913 if (AR->hasNoSignedWrap()) 4914 return Result; 4915 4916 if (!AR->isAffine()) 4917 return Result; 4918 4919 const SCEV *Step = AR->getStepRecurrence(*this); 4920 const Loop *L = AR->getLoop(); 4921 4922 // Check whether the backedge-taken count is SCEVCouldNotCompute. 4923 // Note that this serves two purposes: It filters out loops that are 4924 // simply not analyzable, and it covers the case where this code is 4925 // being called from within backedge-taken count analysis, such that 4926 // attempting to ask for the backedge-taken count would likely result 4927 // in infinite recursion. In the later case, the analysis code will 4928 // cope with a conservative value, and it will take care to purge 4929 // that value once it has finished. 4930 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 4931 4932 // Normally, in the cases we can prove no-overflow via a 4933 // backedge guarding condition, we can also compute a backedge 4934 // taken count for the loop. The exceptions are assumptions and 4935 // guards present in the loop -- SCEV is not great at exploiting 4936 // these to compute max backedge taken counts, but can still use 4937 // these to prove lack of overflow. Use this fact to avoid 4938 // doing extra work that may not pay off. 4939 4940 if (isa<SCEVCouldNotCompute>(MaxBECount) && !HasGuards && 4941 AC.assumptions().empty()) 4942 return Result; 4943 4944 // If the backedge is guarded by a comparison with the pre-inc value the 4945 // addrec is safe. Also, if the entry is guarded by a comparison with the 4946 // start value and the backedge is guarded by a comparison with the post-inc 4947 // value, the addrec is safe. 4948 ICmpInst::Predicate Pred; 4949 const SCEV *OverflowLimit = 4950 getSignedOverflowLimitForStep(Step, &Pred, this); 4951 if (OverflowLimit && 4952 (isLoopBackedgeGuardedByCond(L, Pred, AR, OverflowLimit) || 4953 isKnownOnEveryIteration(Pred, AR, OverflowLimit))) { 4954 Result = setFlags(Result, SCEV::FlagNSW); 4955 } 4956 return Result; 4957 } 4958 SCEV::NoWrapFlags 4959 ScalarEvolution::proveNoUnsignedWrapViaInduction(const SCEVAddRecExpr *AR) { 4960 SCEV::NoWrapFlags Result = AR->getNoWrapFlags(); 4961 4962 if (AR->hasNoUnsignedWrap()) 4963 return Result; 4964 4965 if (!AR->isAffine()) 4966 return Result; 4967 4968 const SCEV *Step = AR->getStepRecurrence(*this); 4969 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 4970 const Loop *L = AR->getLoop(); 4971 4972 // Check whether the backedge-taken count is SCEVCouldNotCompute. 4973 // Note that this serves two purposes: It filters out loops that are 4974 // simply not analyzable, and it covers the case where this code is 4975 // being called from within backedge-taken count analysis, such that 4976 // attempting to ask for the backedge-taken count would likely result 4977 // in infinite recursion. In the later case, the analysis code will 4978 // cope with a conservative value, and it will take care to purge 4979 // that value once it has finished. 4980 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 4981 4982 // Normally, in the cases we can prove no-overflow via a 4983 // backedge guarding condition, we can also compute a backedge 4984 // taken count for the loop. The exceptions are assumptions and 4985 // guards present in the loop -- SCEV is not great at exploiting 4986 // these to compute max backedge taken counts, but can still use 4987 // these to prove lack of overflow. Use this fact to avoid 4988 // doing extra work that may not pay off. 4989 4990 if (isa<SCEVCouldNotCompute>(MaxBECount) && !HasGuards && 4991 AC.assumptions().empty()) 4992 return Result; 4993 4994 // If the backedge is guarded by a comparison with the pre-inc value the 4995 // addrec is safe. Also, if the entry is guarded by a comparison with the 4996 // start value and the backedge is guarded by a comparison with the post-inc 4997 // value, the addrec is safe. 4998 if (isKnownPositive(Step)) { 4999 const SCEV *N = getConstant(APInt::getMinValue(BitWidth) - 5000 getUnsignedRangeMax(Step)); 5001 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) || 5002 isKnownOnEveryIteration(ICmpInst::ICMP_ULT, AR, N)) { 5003 Result = setFlags(Result, SCEV::FlagNUW); 5004 } 5005 } 5006 5007 return Result; 5008 } 5009 5010 namespace { 5011 5012 /// Represents an abstract binary operation. This may exist as a 5013 /// normal instruction or constant expression, or may have been 5014 /// derived from an expression tree. 5015 struct BinaryOp { 5016 unsigned Opcode; 5017 Value *LHS; 5018 Value *RHS; 5019 bool IsNSW = false; 5020 bool IsNUW = false; 5021 5022 /// Op is set if this BinaryOp corresponds to a concrete LLVM instruction or 5023 /// constant expression. 5024 Operator *Op = nullptr; 5025 5026 explicit BinaryOp(Operator *Op) 5027 : Opcode(Op->getOpcode()), LHS(Op->getOperand(0)), RHS(Op->getOperand(1)), 5028 Op(Op) { 5029 if (auto *OBO = dyn_cast<OverflowingBinaryOperator>(Op)) { 5030 IsNSW = OBO->hasNoSignedWrap(); 5031 IsNUW = OBO->hasNoUnsignedWrap(); 5032 } 5033 } 5034 5035 explicit BinaryOp(unsigned Opcode, Value *LHS, Value *RHS, bool IsNSW = false, 5036 bool IsNUW = false) 5037 : Opcode(Opcode), LHS(LHS), RHS(RHS), IsNSW(IsNSW), IsNUW(IsNUW) {} 5038 }; 5039 5040 } // end anonymous namespace 5041 5042 /// Try to map \p V into a BinaryOp, and return \c None on failure. 5043 static Optional<BinaryOp> MatchBinaryOp(Value *V, DominatorTree &DT) { 5044 auto *Op = dyn_cast<Operator>(V); 5045 if (!Op) 5046 return None; 5047 5048 // Implementation detail: all the cleverness here should happen without 5049 // creating new SCEV expressions -- our caller knowns tricks to avoid creating 5050 // SCEV expressions when possible, and we should not break that. 5051 5052 switch (Op->getOpcode()) { 5053 case Instruction::Add: 5054 case Instruction::Sub: 5055 case Instruction::Mul: 5056 case Instruction::UDiv: 5057 case Instruction::URem: 5058 case Instruction::And: 5059 case Instruction::Or: 5060 case Instruction::AShr: 5061 case Instruction::Shl: 5062 return BinaryOp(Op); 5063 5064 case Instruction::Xor: 5065 if (auto *RHSC = dyn_cast<ConstantInt>(Op->getOperand(1))) 5066 // If the RHS of the xor is a signmask, then this is just an add. 5067 // Instcombine turns add of signmask into xor as a strength reduction step. 5068 if (RHSC->getValue().isSignMask()) 5069 return BinaryOp(Instruction::Add, Op->getOperand(0), Op->getOperand(1)); 5070 // Binary `xor` is a bit-wise `add`. 5071 if (V->getType()->isIntegerTy(1)) 5072 return BinaryOp(Instruction::Add, Op->getOperand(0), Op->getOperand(1)); 5073 return BinaryOp(Op); 5074 5075 case Instruction::LShr: 5076 // Turn logical shift right of a constant into a unsigned divide. 5077 if (ConstantInt *SA = dyn_cast<ConstantInt>(Op->getOperand(1))) { 5078 uint32_t BitWidth = cast<IntegerType>(Op->getType())->getBitWidth(); 5079 5080 // If the shift count is not less than the bitwidth, the result of 5081 // the shift is undefined. Don't try to analyze it, because the 5082 // resolution chosen here may differ from the resolution chosen in 5083 // other parts of the compiler. 5084 if (SA->getValue().ult(BitWidth)) { 5085 Constant *X = 5086 ConstantInt::get(SA->getContext(), 5087 APInt::getOneBitSet(BitWidth, SA->getZExtValue())); 5088 return BinaryOp(Instruction::UDiv, Op->getOperand(0), X); 5089 } 5090 } 5091 return BinaryOp(Op); 5092 5093 case Instruction::ExtractValue: { 5094 auto *EVI = cast<ExtractValueInst>(Op); 5095 if (EVI->getNumIndices() != 1 || EVI->getIndices()[0] != 0) 5096 break; 5097 5098 auto *WO = dyn_cast<WithOverflowInst>(EVI->getAggregateOperand()); 5099 if (!WO) 5100 break; 5101 5102 Instruction::BinaryOps BinOp = WO->getBinaryOp(); 5103 bool Signed = WO->isSigned(); 5104 // TODO: Should add nuw/nsw flags for mul as well. 5105 if (BinOp == Instruction::Mul || !isOverflowIntrinsicNoWrap(WO, DT)) 5106 return BinaryOp(BinOp, WO->getLHS(), WO->getRHS()); 5107 5108 // Now that we know that all uses of the arithmetic-result component of 5109 // CI are guarded by the overflow check, we can go ahead and pretend 5110 // that the arithmetic is non-overflowing. 5111 return BinaryOp(BinOp, WO->getLHS(), WO->getRHS(), 5112 /* IsNSW = */ Signed, /* IsNUW = */ !Signed); 5113 } 5114 5115 default: 5116 break; 5117 } 5118 5119 // Recognise intrinsic loop.decrement.reg, and as this has exactly the same 5120 // semantics as a Sub, return a binary sub expression. 5121 if (auto *II = dyn_cast<IntrinsicInst>(V)) 5122 if (II->getIntrinsicID() == Intrinsic::loop_decrement_reg) 5123 return BinaryOp(Instruction::Sub, II->getOperand(0), II->getOperand(1)); 5124 5125 return None; 5126 } 5127 5128 /// Helper function to createAddRecFromPHIWithCasts. We have a phi 5129 /// node whose symbolic (unknown) SCEV is \p SymbolicPHI, which is updated via 5130 /// the loop backedge by a SCEVAddExpr, possibly also with a few casts on the 5131 /// way. This function checks if \p Op, an operand of this SCEVAddExpr, 5132 /// follows one of the following patterns: 5133 /// Op == (SExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) 5134 /// Op == (ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) 5135 /// If the SCEV expression of \p Op conforms with one of the expected patterns 5136 /// we return the type of the truncation operation, and indicate whether the 5137 /// truncated type should be treated as signed/unsigned by setting 5138 /// \p Signed to true/false, respectively. 5139 static Type *isSimpleCastedPHI(const SCEV *Op, const SCEVUnknown *SymbolicPHI, 5140 bool &Signed, ScalarEvolution &SE) { 5141 // The case where Op == SymbolicPHI (that is, with no type conversions on 5142 // the way) is handled by the regular add recurrence creating logic and 5143 // would have already been triggered in createAddRecForPHI. Reaching it here 5144 // means that createAddRecFromPHI had failed for this PHI before (e.g., 5145 // because one of the other operands of the SCEVAddExpr updating this PHI is 5146 // not invariant). 5147 // 5148 // Here we look for the case where Op = (ext(trunc(SymbolicPHI))), and in 5149 // this case predicates that allow us to prove that Op == SymbolicPHI will 5150 // be added. 5151 if (Op == SymbolicPHI) 5152 return nullptr; 5153 5154 unsigned SourceBits = SE.getTypeSizeInBits(SymbolicPHI->getType()); 5155 unsigned NewBits = SE.getTypeSizeInBits(Op->getType()); 5156 if (SourceBits != NewBits) 5157 return nullptr; 5158 5159 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(Op); 5160 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(Op); 5161 if (!SExt && !ZExt) 5162 return nullptr; 5163 const SCEVTruncateExpr *Trunc = 5164 SExt ? dyn_cast<SCEVTruncateExpr>(SExt->getOperand()) 5165 : dyn_cast<SCEVTruncateExpr>(ZExt->getOperand()); 5166 if (!Trunc) 5167 return nullptr; 5168 const SCEV *X = Trunc->getOperand(); 5169 if (X != SymbolicPHI) 5170 return nullptr; 5171 Signed = SExt != nullptr; 5172 return Trunc->getType(); 5173 } 5174 5175 static const Loop *isIntegerLoopHeaderPHI(const PHINode *PN, LoopInfo &LI) { 5176 if (!PN->getType()->isIntegerTy()) 5177 return nullptr; 5178 const Loop *L = LI.getLoopFor(PN->getParent()); 5179 if (!L || L->getHeader() != PN->getParent()) 5180 return nullptr; 5181 return L; 5182 } 5183 5184 // Analyze \p SymbolicPHI, a SCEV expression of a phi node, and check if the 5185 // computation that updates the phi follows the following pattern: 5186 // (SExt/ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) + InvariantAccum 5187 // which correspond to a phi->trunc->sext/zext->add->phi update chain. 5188 // If so, try to see if it can be rewritten as an AddRecExpr under some 5189 // Predicates. If successful, return them as a pair. Also cache the results 5190 // of the analysis. 5191 // 5192 // Example usage scenario: 5193 // Say the Rewriter is called for the following SCEV: 5194 // 8 * ((sext i32 (trunc i64 %X to i32) to i64) + %Step) 5195 // where: 5196 // %X = phi i64 (%Start, %BEValue) 5197 // It will visitMul->visitAdd->visitSExt->visitTrunc->visitUnknown(%X), 5198 // and call this function with %SymbolicPHI = %X. 5199 // 5200 // The analysis will find that the value coming around the backedge has 5201 // the following SCEV: 5202 // BEValue = ((sext i32 (trunc i64 %X to i32) to i64) + %Step) 5203 // Upon concluding that this matches the desired pattern, the function 5204 // will return the pair {NewAddRec, SmallPredsVec} where: 5205 // NewAddRec = {%Start,+,%Step} 5206 // SmallPredsVec = {P1, P2, P3} as follows: 5207 // P1(WrapPred): AR: {trunc(%Start),+,(trunc %Step)}<nsw> Flags: <nssw> 5208 // P2(EqualPred): %Start == (sext i32 (trunc i64 %Start to i32) to i64) 5209 // P3(EqualPred): %Step == (sext i32 (trunc i64 %Step to i32) to i64) 5210 // The returned pair means that SymbolicPHI can be rewritten into NewAddRec 5211 // under the predicates {P1,P2,P3}. 5212 // This predicated rewrite will be cached in PredicatedSCEVRewrites: 5213 // PredicatedSCEVRewrites[{%X,L}] = {NewAddRec, {P1,P2,P3)} 5214 // 5215 // TODO's: 5216 // 5217 // 1) Extend the Induction descriptor to also support inductions that involve 5218 // casts: When needed (namely, when we are called in the context of the 5219 // vectorizer induction analysis), a Set of cast instructions will be 5220 // populated by this method, and provided back to isInductionPHI. This is 5221 // needed to allow the vectorizer to properly record them to be ignored by 5222 // the cost model and to avoid vectorizing them (otherwise these casts, 5223 // which are redundant under the runtime overflow checks, will be 5224 // vectorized, which can be costly). 5225 // 5226 // 2) Support additional induction/PHISCEV patterns: We also want to support 5227 // inductions where the sext-trunc / zext-trunc operations (partly) occur 5228 // after the induction update operation (the induction increment): 5229 // 5230 // (Trunc iy (SExt/ZExt ix (%SymbolicPHI + InvariantAccum) to iy) to ix) 5231 // which correspond to a phi->add->trunc->sext/zext->phi update chain. 5232 // 5233 // (Trunc iy ((SExt/ZExt ix (%SymbolicPhi) to iy) + InvariantAccum) to ix) 5234 // which correspond to a phi->trunc->add->sext/zext->phi update chain. 5235 // 5236 // 3) Outline common code with createAddRecFromPHI to avoid duplication. 5237 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 5238 ScalarEvolution::createAddRecFromPHIWithCastsImpl(const SCEVUnknown *SymbolicPHI) { 5239 SmallVector<const SCEVPredicate *, 3> Predicates; 5240 5241 // *** Part1: Analyze if we have a phi-with-cast pattern for which we can 5242 // return an AddRec expression under some predicate. 5243 5244 auto *PN = cast<PHINode>(SymbolicPHI->getValue()); 5245 const Loop *L = isIntegerLoopHeaderPHI(PN, LI); 5246 assert(L && "Expecting an integer loop header phi"); 5247 5248 // The loop may have multiple entrances or multiple exits; we can analyze 5249 // this phi as an addrec if it has a unique entry value and a unique 5250 // backedge value. 5251 Value *BEValueV = nullptr, *StartValueV = nullptr; 5252 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 5253 Value *V = PN->getIncomingValue(i); 5254 if (L->contains(PN->getIncomingBlock(i))) { 5255 if (!BEValueV) { 5256 BEValueV = V; 5257 } else if (BEValueV != V) { 5258 BEValueV = nullptr; 5259 break; 5260 } 5261 } else if (!StartValueV) { 5262 StartValueV = V; 5263 } else if (StartValueV != V) { 5264 StartValueV = nullptr; 5265 break; 5266 } 5267 } 5268 if (!BEValueV || !StartValueV) 5269 return None; 5270 5271 const SCEV *BEValue = getSCEV(BEValueV); 5272 5273 // If the value coming around the backedge is an add with the symbolic 5274 // value we just inserted, possibly with casts that we can ignore under 5275 // an appropriate runtime guard, then we found a simple induction variable! 5276 const auto *Add = dyn_cast<SCEVAddExpr>(BEValue); 5277 if (!Add) 5278 return None; 5279 5280 // If there is a single occurrence of the symbolic value, possibly 5281 // casted, replace it with a recurrence. 5282 unsigned FoundIndex = Add->getNumOperands(); 5283 Type *TruncTy = nullptr; 5284 bool Signed; 5285 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5286 if ((TruncTy = 5287 isSimpleCastedPHI(Add->getOperand(i), SymbolicPHI, Signed, *this))) 5288 if (FoundIndex == e) { 5289 FoundIndex = i; 5290 break; 5291 } 5292 5293 if (FoundIndex == Add->getNumOperands()) 5294 return None; 5295 5296 // Create an add with everything but the specified operand. 5297 SmallVector<const SCEV *, 8> Ops; 5298 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5299 if (i != FoundIndex) 5300 Ops.push_back(Add->getOperand(i)); 5301 const SCEV *Accum = getAddExpr(Ops); 5302 5303 // The runtime checks will not be valid if the step amount is 5304 // varying inside the loop. 5305 if (!isLoopInvariant(Accum, L)) 5306 return None; 5307 5308 // *** Part2: Create the predicates 5309 5310 // Analysis was successful: we have a phi-with-cast pattern for which we 5311 // can return an AddRec expression under the following predicates: 5312 // 5313 // P1: A Wrap predicate that guarantees that Trunc(Start) + i*Trunc(Accum) 5314 // fits within the truncated type (does not overflow) for i = 0 to n-1. 5315 // P2: An Equal predicate that guarantees that 5316 // Start = (Ext ix (Trunc iy (Start) to ix) to iy) 5317 // P3: An Equal predicate that guarantees that 5318 // Accum = (Ext ix (Trunc iy (Accum) to ix) to iy) 5319 // 5320 // As we next prove, the above predicates guarantee that: 5321 // Start + i*Accum = (Ext ix (Trunc iy ( Start + i*Accum ) to ix) to iy) 5322 // 5323 // 5324 // More formally, we want to prove that: 5325 // Expr(i+1) = Start + (i+1) * Accum 5326 // = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum 5327 // 5328 // Given that: 5329 // 1) Expr(0) = Start 5330 // 2) Expr(1) = Start + Accum 5331 // = (Ext ix (Trunc iy (Start) to ix) to iy) + Accum :: from P2 5332 // 3) Induction hypothesis (step i): 5333 // Expr(i) = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum 5334 // 5335 // Proof: 5336 // Expr(i+1) = 5337 // = Start + (i+1)*Accum 5338 // = (Start + i*Accum) + Accum 5339 // = Expr(i) + Accum 5340 // = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum + Accum 5341 // :: from step i 5342 // 5343 // = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy) + Accum + Accum 5344 // 5345 // = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy) 5346 // + (Ext ix (Trunc iy (Accum) to ix) to iy) 5347 // + Accum :: from P3 5348 // 5349 // = (Ext ix (Trunc iy ((Start + (i-1)*Accum) + Accum) to ix) to iy) 5350 // + Accum :: from P1: Ext(x)+Ext(y)=>Ext(x+y) 5351 // 5352 // = (Ext ix (Trunc iy (Start + i*Accum) to ix) to iy) + Accum 5353 // = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum 5354 // 5355 // By induction, the same applies to all iterations 1<=i<n: 5356 // 5357 5358 // Create a truncated addrec for which we will add a no overflow check (P1). 5359 const SCEV *StartVal = getSCEV(StartValueV); 5360 const SCEV *PHISCEV = 5361 getAddRecExpr(getTruncateExpr(StartVal, TruncTy), 5362 getTruncateExpr(Accum, TruncTy), L, SCEV::FlagAnyWrap); 5363 5364 // PHISCEV can be either a SCEVConstant or a SCEVAddRecExpr. 5365 // ex: If truncated Accum is 0 and StartVal is a constant, then PHISCEV 5366 // will be constant. 5367 // 5368 // If PHISCEV is a constant, then P1 degenerates into P2 or P3, so we don't 5369 // add P1. 5370 if (const auto *AR = dyn_cast<SCEVAddRecExpr>(PHISCEV)) { 5371 SCEVWrapPredicate::IncrementWrapFlags AddedFlags = 5372 Signed ? SCEVWrapPredicate::IncrementNSSW 5373 : SCEVWrapPredicate::IncrementNUSW; 5374 const SCEVPredicate *AddRecPred = getWrapPredicate(AR, AddedFlags); 5375 Predicates.push_back(AddRecPred); 5376 } 5377 5378 // Create the Equal Predicates P2,P3: 5379 5380 // It is possible that the predicates P2 and/or P3 are computable at 5381 // compile time due to StartVal and/or Accum being constants. 5382 // If either one is, then we can check that now and escape if either P2 5383 // or P3 is false. 5384 5385 // Construct the extended SCEV: (Ext ix (Trunc iy (Expr) to ix) to iy) 5386 // for each of StartVal and Accum 5387 auto getExtendedExpr = [&](const SCEV *Expr, 5388 bool CreateSignExtend) -> const SCEV * { 5389 assert(isLoopInvariant(Expr, L) && "Expr is expected to be invariant"); 5390 const SCEV *TruncatedExpr = getTruncateExpr(Expr, TruncTy); 5391 const SCEV *ExtendedExpr = 5392 CreateSignExtend ? getSignExtendExpr(TruncatedExpr, Expr->getType()) 5393 : getZeroExtendExpr(TruncatedExpr, Expr->getType()); 5394 return ExtendedExpr; 5395 }; 5396 5397 // Given: 5398 // ExtendedExpr = (Ext ix (Trunc iy (Expr) to ix) to iy 5399 // = getExtendedExpr(Expr) 5400 // Determine whether the predicate P: Expr == ExtendedExpr 5401 // is known to be false at compile time 5402 auto PredIsKnownFalse = [&](const SCEV *Expr, 5403 const SCEV *ExtendedExpr) -> bool { 5404 return Expr != ExtendedExpr && 5405 isKnownPredicate(ICmpInst::ICMP_NE, Expr, ExtendedExpr); 5406 }; 5407 5408 const SCEV *StartExtended = getExtendedExpr(StartVal, Signed); 5409 if (PredIsKnownFalse(StartVal, StartExtended)) { 5410 LLVM_DEBUG(dbgs() << "P2 is compile-time false\n";); 5411 return None; 5412 } 5413 5414 // The Step is always Signed (because the overflow checks are either 5415 // NSSW or NUSW) 5416 const SCEV *AccumExtended = getExtendedExpr(Accum, /*CreateSignExtend=*/true); 5417 if (PredIsKnownFalse(Accum, AccumExtended)) { 5418 LLVM_DEBUG(dbgs() << "P3 is compile-time false\n";); 5419 return None; 5420 } 5421 5422 auto AppendPredicate = [&](const SCEV *Expr, 5423 const SCEV *ExtendedExpr) -> void { 5424 if (Expr != ExtendedExpr && 5425 !isKnownPredicate(ICmpInst::ICMP_EQ, Expr, ExtendedExpr)) { 5426 const SCEVPredicate *Pred = getEqualPredicate(Expr, ExtendedExpr); 5427 LLVM_DEBUG(dbgs() << "Added Predicate: " << *Pred); 5428 Predicates.push_back(Pred); 5429 } 5430 }; 5431 5432 AppendPredicate(StartVal, StartExtended); 5433 AppendPredicate(Accum, AccumExtended); 5434 5435 // *** Part3: Predicates are ready. Now go ahead and create the new addrec in 5436 // which the casts had been folded away. The caller can rewrite SymbolicPHI 5437 // into NewAR if it will also add the runtime overflow checks specified in 5438 // Predicates. 5439 auto *NewAR = getAddRecExpr(StartVal, Accum, L, SCEV::FlagAnyWrap); 5440 5441 std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> PredRewrite = 5442 std::make_pair(NewAR, Predicates); 5443 // Remember the result of the analysis for this SCEV at this locayyytion. 5444 PredicatedSCEVRewrites[{SymbolicPHI, L}] = PredRewrite; 5445 return PredRewrite; 5446 } 5447 5448 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 5449 ScalarEvolution::createAddRecFromPHIWithCasts(const SCEVUnknown *SymbolicPHI) { 5450 auto *PN = cast<PHINode>(SymbolicPHI->getValue()); 5451 const Loop *L = isIntegerLoopHeaderPHI(PN, LI); 5452 if (!L) 5453 return None; 5454 5455 // Check to see if we already analyzed this PHI. 5456 auto I = PredicatedSCEVRewrites.find({SymbolicPHI, L}); 5457 if (I != PredicatedSCEVRewrites.end()) { 5458 std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> Rewrite = 5459 I->second; 5460 // Analysis was done before and failed to create an AddRec: 5461 if (Rewrite.first == SymbolicPHI) 5462 return None; 5463 // Analysis was done before and succeeded to create an AddRec under 5464 // a predicate: 5465 assert(isa<SCEVAddRecExpr>(Rewrite.first) && "Expected an AddRec"); 5466 assert(!(Rewrite.second).empty() && "Expected to find Predicates"); 5467 return Rewrite; 5468 } 5469 5470 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 5471 Rewrite = createAddRecFromPHIWithCastsImpl(SymbolicPHI); 5472 5473 // Record in the cache that the analysis failed 5474 if (!Rewrite) { 5475 SmallVector<const SCEVPredicate *, 3> Predicates; 5476 PredicatedSCEVRewrites[{SymbolicPHI, L}] = {SymbolicPHI, Predicates}; 5477 return None; 5478 } 5479 5480 return Rewrite; 5481 } 5482 5483 // FIXME: This utility is currently required because the Rewriter currently 5484 // does not rewrite this expression: 5485 // {0, +, (sext ix (trunc iy to ix) to iy)} 5486 // into {0, +, %step}, 5487 // even when the following Equal predicate exists: 5488 // "%step == (sext ix (trunc iy to ix) to iy)". 5489 bool PredicatedScalarEvolution::areAddRecsEqualWithPreds( 5490 const SCEVAddRecExpr *AR1, const SCEVAddRecExpr *AR2) const { 5491 if (AR1 == AR2) 5492 return true; 5493 5494 auto areExprsEqual = [&](const SCEV *Expr1, const SCEV *Expr2) -> bool { 5495 if (Expr1 != Expr2 && !Preds->implies(SE.getEqualPredicate(Expr1, Expr2)) && 5496 !Preds->implies(SE.getEqualPredicate(Expr2, Expr1))) 5497 return false; 5498 return true; 5499 }; 5500 5501 if (!areExprsEqual(AR1->getStart(), AR2->getStart()) || 5502 !areExprsEqual(AR1->getStepRecurrence(SE), AR2->getStepRecurrence(SE))) 5503 return false; 5504 return true; 5505 } 5506 5507 /// A helper function for createAddRecFromPHI to handle simple cases. 5508 /// 5509 /// This function tries to find an AddRec expression for the simplest (yet most 5510 /// common) cases: PN = PHI(Start, OP(Self, LoopInvariant)). 5511 /// If it fails, createAddRecFromPHI will use a more general, but slow, 5512 /// technique for finding the AddRec expression. 5513 const SCEV *ScalarEvolution::createSimpleAffineAddRec(PHINode *PN, 5514 Value *BEValueV, 5515 Value *StartValueV) { 5516 const Loop *L = LI.getLoopFor(PN->getParent()); 5517 assert(L && L->getHeader() == PN->getParent()); 5518 assert(BEValueV && StartValueV); 5519 5520 auto BO = MatchBinaryOp(BEValueV, DT); 5521 if (!BO) 5522 return nullptr; 5523 5524 if (BO->Opcode != Instruction::Add) 5525 return nullptr; 5526 5527 const SCEV *Accum = nullptr; 5528 if (BO->LHS == PN && L->isLoopInvariant(BO->RHS)) 5529 Accum = getSCEV(BO->RHS); 5530 else if (BO->RHS == PN && L->isLoopInvariant(BO->LHS)) 5531 Accum = getSCEV(BO->LHS); 5532 5533 if (!Accum) 5534 return nullptr; 5535 5536 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 5537 if (BO->IsNUW) 5538 Flags = setFlags(Flags, SCEV::FlagNUW); 5539 if (BO->IsNSW) 5540 Flags = setFlags(Flags, SCEV::FlagNSW); 5541 5542 const SCEV *StartVal = getSCEV(StartValueV); 5543 const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags); 5544 insertValueToMap(PN, PHISCEV); 5545 5546 // We can add Flags to the post-inc expression only if we 5547 // know that it is *undefined behavior* for BEValueV to 5548 // overflow. 5549 if (auto *BEInst = dyn_cast<Instruction>(BEValueV)) { 5550 assert(isLoopInvariant(Accum, L) && 5551 "Accum is defined outside L, but is not invariant?"); 5552 if (isAddRecNeverPoison(BEInst, L)) 5553 (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags); 5554 } 5555 5556 return PHISCEV; 5557 } 5558 5559 const SCEV *ScalarEvolution::createAddRecFromPHI(PHINode *PN) { 5560 const Loop *L = LI.getLoopFor(PN->getParent()); 5561 if (!L || L->getHeader() != PN->getParent()) 5562 return nullptr; 5563 5564 // The loop may have multiple entrances or multiple exits; we can analyze 5565 // this phi as an addrec if it has a unique entry value and a unique 5566 // backedge value. 5567 Value *BEValueV = nullptr, *StartValueV = nullptr; 5568 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 5569 Value *V = PN->getIncomingValue(i); 5570 if (L->contains(PN->getIncomingBlock(i))) { 5571 if (!BEValueV) { 5572 BEValueV = V; 5573 } else if (BEValueV != V) { 5574 BEValueV = nullptr; 5575 break; 5576 } 5577 } else if (!StartValueV) { 5578 StartValueV = V; 5579 } else if (StartValueV != V) { 5580 StartValueV = nullptr; 5581 break; 5582 } 5583 } 5584 if (!BEValueV || !StartValueV) 5585 return nullptr; 5586 5587 assert(ValueExprMap.find_as(PN) == ValueExprMap.end() && 5588 "PHI node already processed?"); 5589 5590 // First, try to find AddRec expression without creating a fictituos symbolic 5591 // value for PN. 5592 if (auto *S = createSimpleAffineAddRec(PN, BEValueV, StartValueV)) 5593 return S; 5594 5595 // Handle PHI node value symbolically. 5596 const SCEV *SymbolicName = getUnknown(PN); 5597 insertValueToMap(PN, SymbolicName); 5598 5599 // Using this symbolic name for the PHI, analyze the value coming around 5600 // the back-edge. 5601 const SCEV *BEValue = getSCEV(BEValueV); 5602 5603 // NOTE: If BEValue is loop invariant, we know that the PHI node just 5604 // has a special value for the first iteration of the loop. 5605 5606 // If the value coming around the backedge is an add with the symbolic 5607 // value we just inserted, then we found a simple induction variable! 5608 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) { 5609 // If there is a single occurrence of the symbolic value, replace it 5610 // with a recurrence. 5611 unsigned FoundIndex = Add->getNumOperands(); 5612 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5613 if (Add->getOperand(i) == SymbolicName) 5614 if (FoundIndex == e) { 5615 FoundIndex = i; 5616 break; 5617 } 5618 5619 if (FoundIndex != Add->getNumOperands()) { 5620 // Create an add with everything but the specified operand. 5621 SmallVector<const SCEV *, 8> Ops; 5622 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5623 if (i != FoundIndex) 5624 Ops.push_back(SCEVBackedgeConditionFolder::rewrite(Add->getOperand(i), 5625 L, *this)); 5626 const SCEV *Accum = getAddExpr(Ops); 5627 5628 // This is not a valid addrec if the step amount is varying each 5629 // loop iteration, but is not itself an addrec in this loop. 5630 if (isLoopInvariant(Accum, L) || 5631 (isa<SCEVAddRecExpr>(Accum) && 5632 cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) { 5633 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 5634 5635 if (auto BO = MatchBinaryOp(BEValueV, DT)) { 5636 if (BO->Opcode == Instruction::Add && BO->LHS == PN) { 5637 if (BO->IsNUW) 5638 Flags = setFlags(Flags, SCEV::FlagNUW); 5639 if (BO->IsNSW) 5640 Flags = setFlags(Flags, SCEV::FlagNSW); 5641 } 5642 } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) { 5643 // If the increment is an inbounds GEP, then we know the address 5644 // space cannot be wrapped around. We cannot make any guarantee 5645 // about signed or unsigned overflow because pointers are 5646 // unsigned but we may have a negative index from the base 5647 // pointer. We can guarantee that no unsigned wrap occurs if the 5648 // indices form a positive value. 5649 if (GEP->isInBounds() && GEP->getOperand(0) == PN) { 5650 Flags = setFlags(Flags, SCEV::FlagNW); 5651 5652 const SCEV *Ptr = getSCEV(GEP->getPointerOperand()); 5653 if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr))) 5654 Flags = setFlags(Flags, SCEV::FlagNUW); 5655 } 5656 5657 // We cannot transfer nuw and nsw flags from subtraction 5658 // operations -- sub nuw X, Y is not the same as add nuw X, -Y 5659 // for instance. 5660 } 5661 5662 const SCEV *StartVal = getSCEV(StartValueV); 5663 const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags); 5664 5665 // Okay, for the entire analysis of this edge we assumed the PHI 5666 // to be symbolic. We now need to go back and purge all of the 5667 // entries for the scalars that use the symbolic expression. 5668 forgetMemoizedResults(SymbolicName); 5669 insertValueToMap(PN, PHISCEV); 5670 5671 // We can add Flags to the post-inc expression only if we 5672 // know that it is *undefined behavior* for BEValueV to 5673 // overflow. 5674 if (auto *BEInst = dyn_cast<Instruction>(BEValueV)) 5675 if (isLoopInvariant(Accum, L) && isAddRecNeverPoison(BEInst, L)) 5676 (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags); 5677 5678 return PHISCEV; 5679 } 5680 } 5681 } else { 5682 // Otherwise, this could be a loop like this: 5683 // i = 0; for (j = 1; ..; ++j) { .... i = j; } 5684 // In this case, j = {1,+,1} and BEValue is j. 5685 // Because the other in-value of i (0) fits the evolution of BEValue 5686 // i really is an addrec evolution. 5687 // 5688 // We can generalize this saying that i is the shifted value of BEValue 5689 // by one iteration: 5690 // PHI(f(0), f({1,+,1})) --> f({0,+,1}) 5691 const SCEV *Shifted = SCEVShiftRewriter::rewrite(BEValue, L, *this); 5692 const SCEV *Start = SCEVInitRewriter::rewrite(Shifted, L, *this, false); 5693 if (Shifted != getCouldNotCompute() && 5694 Start != getCouldNotCompute()) { 5695 const SCEV *StartVal = getSCEV(StartValueV); 5696 if (Start == StartVal) { 5697 // Okay, for the entire analysis of this edge we assumed the PHI 5698 // to be symbolic. We now need to go back and purge all of the 5699 // entries for the scalars that use the symbolic expression. 5700 forgetMemoizedResults(SymbolicName); 5701 insertValueToMap(PN, Shifted); 5702 return Shifted; 5703 } 5704 } 5705 } 5706 5707 // Remove the temporary PHI node SCEV that has been inserted while intending 5708 // to create an AddRecExpr for this PHI node. We can not keep this temporary 5709 // as it will prevent later (possibly simpler) SCEV expressions to be added 5710 // to the ValueExprMap. 5711 eraseValueFromMap(PN); 5712 5713 return nullptr; 5714 } 5715 5716 // Checks if the SCEV S is available at BB. S is considered available at BB 5717 // if S can be materialized at BB without introducing a fault. 5718 static bool IsAvailableOnEntry(const Loop *L, DominatorTree &DT, const SCEV *S, 5719 BasicBlock *BB) { 5720 struct CheckAvailable { 5721 bool TraversalDone = false; 5722 bool Available = true; 5723 5724 const Loop *L = nullptr; // The loop BB is in (can be nullptr) 5725 BasicBlock *BB = nullptr; 5726 DominatorTree &DT; 5727 5728 CheckAvailable(const Loop *L, BasicBlock *BB, DominatorTree &DT) 5729 : L(L), BB(BB), DT(DT) {} 5730 5731 bool setUnavailable() { 5732 TraversalDone = true; 5733 Available = false; 5734 return false; 5735 } 5736 5737 bool follow(const SCEV *S) { 5738 switch (S->getSCEVType()) { 5739 case scConstant: 5740 case scPtrToInt: 5741 case scTruncate: 5742 case scZeroExtend: 5743 case scSignExtend: 5744 case scAddExpr: 5745 case scMulExpr: 5746 case scUMaxExpr: 5747 case scSMaxExpr: 5748 case scUMinExpr: 5749 case scSMinExpr: 5750 case scSequentialUMinExpr: 5751 // These expressions are available if their operand(s) is/are. 5752 return true; 5753 5754 case scAddRecExpr: { 5755 // We allow add recurrences that are on the loop BB is in, or some 5756 // outer loop. This guarantees availability because the value of the 5757 // add recurrence at BB is simply the "current" value of the induction 5758 // variable. We can relax this in the future; for instance an add 5759 // recurrence on a sibling dominating loop is also available at BB. 5760 const auto *ARLoop = cast<SCEVAddRecExpr>(S)->getLoop(); 5761 if (L && (ARLoop == L || ARLoop->contains(L))) 5762 return true; 5763 5764 return setUnavailable(); 5765 } 5766 5767 case scUnknown: { 5768 // For SCEVUnknown, we check for simple dominance. 5769 const auto *SU = cast<SCEVUnknown>(S); 5770 Value *V = SU->getValue(); 5771 5772 if (isa<Argument>(V)) 5773 return false; 5774 5775 if (isa<Instruction>(V) && DT.dominates(cast<Instruction>(V), BB)) 5776 return false; 5777 5778 return setUnavailable(); 5779 } 5780 5781 case scUDivExpr: 5782 case scCouldNotCompute: 5783 // We do not try to smart about these at all. 5784 return setUnavailable(); 5785 } 5786 llvm_unreachable("Unknown SCEV kind!"); 5787 } 5788 5789 bool isDone() { return TraversalDone; } 5790 }; 5791 5792 CheckAvailable CA(L, BB, DT); 5793 SCEVTraversal<CheckAvailable> ST(CA); 5794 5795 ST.visitAll(S); 5796 return CA.Available; 5797 } 5798 5799 // Try to match a control flow sequence that branches out at BI and merges back 5800 // at Merge into a "C ? LHS : RHS" select pattern. Return true on a successful 5801 // match. 5802 static bool BrPHIToSelect(DominatorTree &DT, BranchInst *BI, PHINode *Merge, 5803 Value *&C, Value *&LHS, Value *&RHS) { 5804 C = BI->getCondition(); 5805 5806 BasicBlockEdge LeftEdge(BI->getParent(), BI->getSuccessor(0)); 5807 BasicBlockEdge RightEdge(BI->getParent(), BI->getSuccessor(1)); 5808 5809 if (!LeftEdge.isSingleEdge()) 5810 return false; 5811 5812 assert(RightEdge.isSingleEdge() && "Follows from LeftEdge.isSingleEdge()"); 5813 5814 Use &LeftUse = Merge->getOperandUse(0); 5815 Use &RightUse = Merge->getOperandUse(1); 5816 5817 if (DT.dominates(LeftEdge, LeftUse) && DT.dominates(RightEdge, RightUse)) { 5818 LHS = LeftUse; 5819 RHS = RightUse; 5820 return true; 5821 } 5822 5823 if (DT.dominates(LeftEdge, RightUse) && DT.dominates(RightEdge, LeftUse)) { 5824 LHS = RightUse; 5825 RHS = LeftUse; 5826 return true; 5827 } 5828 5829 return false; 5830 } 5831 5832 const SCEV *ScalarEvolution::createNodeFromSelectLikePHI(PHINode *PN) { 5833 auto IsReachable = 5834 [&](BasicBlock *BB) { return DT.isReachableFromEntry(BB); }; 5835 if (PN->getNumIncomingValues() == 2 && all_of(PN->blocks(), IsReachable)) { 5836 const Loop *L = LI.getLoopFor(PN->getParent()); 5837 5838 // We don't want to break LCSSA, even in a SCEV expression tree. 5839 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) 5840 if (LI.getLoopFor(PN->getIncomingBlock(i)) != L) 5841 return nullptr; 5842 5843 // Try to match 5844 // 5845 // br %cond, label %left, label %right 5846 // left: 5847 // br label %merge 5848 // right: 5849 // br label %merge 5850 // merge: 5851 // V = phi [ %x, %left ], [ %y, %right ] 5852 // 5853 // as "select %cond, %x, %y" 5854 5855 BasicBlock *IDom = DT[PN->getParent()]->getIDom()->getBlock(); 5856 assert(IDom && "At least the entry block should dominate PN"); 5857 5858 auto *BI = dyn_cast<BranchInst>(IDom->getTerminator()); 5859 Value *Cond = nullptr, *LHS = nullptr, *RHS = nullptr; 5860 5861 if (BI && BI->isConditional() && 5862 BrPHIToSelect(DT, BI, PN, Cond, LHS, RHS) && 5863 IsAvailableOnEntry(L, DT, getSCEV(LHS), PN->getParent()) && 5864 IsAvailableOnEntry(L, DT, getSCEV(RHS), PN->getParent())) 5865 return createNodeForSelectOrPHI(PN, Cond, LHS, RHS); 5866 } 5867 5868 return nullptr; 5869 } 5870 5871 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) { 5872 if (const SCEV *S = createAddRecFromPHI(PN)) 5873 return S; 5874 5875 if (const SCEV *S = createNodeFromSelectLikePHI(PN)) 5876 return S; 5877 5878 // If the PHI has a single incoming value, follow that value, unless the 5879 // PHI's incoming blocks are in a different loop, in which case doing so 5880 // risks breaking LCSSA form. Instcombine would normally zap these, but 5881 // it doesn't have DominatorTree information, so it may miss cases. 5882 if (Value *V = SimplifyInstruction(PN, {getDataLayout(), &TLI, &DT, &AC})) 5883 if (LI.replacementPreservesLCSSAForm(PN, V)) 5884 return getSCEV(V); 5885 5886 // If it's not a loop phi, we can't handle it yet. 5887 return getUnknown(PN); 5888 } 5889 5890 bool SCEVMinMaxExprContains(const SCEV *Root, const SCEV *OperandToFind, 5891 SCEVTypes RootKind) { 5892 struct FindClosure { 5893 const SCEV *OperandToFind; 5894 const SCEVTypes RootKind; // Must be a sequential min/max expression. 5895 const SCEVTypes NonSequentialRootKind; // Non-seq variant of RootKind. 5896 5897 bool Found = false; 5898 5899 bool canRecurseInto(SCEVTypes Kind) const { 5900 // We can only recurse into the SCEV expression of the same effective type 5901 // as the type of our root SCEV expression, and into zero-extensions. 5902 return RootKind == Kind || NonSequentialRootKind == Kind || 5903 scZeroExtend == Kind; 5904 }; 5905 5906 FindClosure(const SCEV *OperandToFind, SCEVTypes RootKind) 5907 : OperandToFind(OperandToFind), RootKind(RootKind), 5908 NonSequentialRootKind( 5909 SCEVSequentialMinMaxExpr::getEquivalentNonSequentialSCEVType( 5910 RootKind)) {} 5911 5912 bool follow(const SCEV *S) { 5913 Found = S == OperandToFind; 5914 5915 return !isDone() && canRecurseInto(S->getSCEVType()); 5916 } 5917 5918 bool isDone() const { return Found; } 5919 }; 5920 5921 FindClosure FC(OperandToFind, RootKind); 5922 visitAll(Root, FC); 5923 return FC.Found; 5924 } 5925 5926 const SCEV *ScalarEvolution::createNodeForSelectOrPHIInstWithICmpInstCond( 5927 Instruction *I, ICmpInst *Cond, Value *TrueVal, Value *FalseVal) { 5928 // Try to match some simple smax or umax patterns. 5929 auto *ICI = Cond; 5930 5931 Value *LHS = ICI->getOperand(0); 5932 Value *RHS = ICI->getOperand(1); 5933 5934 switch (ICI->getPredicate()) { 5935 case ICmpInst::ICMP_SLT: 5936 case ICmpInst::ICMP_SLE: 5937 case ICmpInst::ICMP_ULT: 5938 case ICmpInst::ICMP_ULE: 5939 std::swap(LHS, RHS); 5940 LLVM_FALLTHROUGH; 5941 case ICmpInst::ICMP_SGT: 5942 case ICmpInst::ICMP_SGE: 5943 case ICmpInst::ICMP_UGT: 5944 case ICmpInst::ICMP_UGE: 5945 // a > b ? a+x : b+x -> max(a, b)+x 5946 // a > b ? b+x : a+x -> min(a, b)+x 5947 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) { 5948 bool Signed = ICI->isSigned(); 5949 const SCEV *LA = getSCEV(TrueVal); 5950 const SCEV *RA = getSCEV(FalseVal); 5951 const SCEV *LS = getSCEV(LHS); 5952 const SCEV *RS = getSCEV(RHS); 5953 if (LA->getType()->isPointerTy()) { 5954 // FIXME: Handle cases where LS/RS are pointers not equal to LA/RA. 5955 // Need to make sure we can't produce weird expressions involving 5956 // negated pointers. 5957 if (LA == LS && RA == RS) 5958 return Signed ? getSMaxExpr(LS, RS) : getUMaxExpr(LS, RS); 5959 if (LA == RS && RA == LS) 5960 return Signed ? getSMinExpr(LS, RS) : getUMinExpr(LS, RS); 5961 } 5962 auto CoerceOperand = [&](const SCEV *Op) -> const SCEV * { 5963 if (Op->getType()->isPointerTy()) { 5964 Op = getLosslessPtrToIntExpr(Op); 5965 if (isa<SCEVCouldNotCompute>(Op)) 5966 return Op; 5967 } 5968 if (Signed) 5969 Op = getNoopOrSignExtend(Op, I->getType()); 5970 else 5971 Op = getNoopOrZeroExtend(Op, I->getType()); 5972 return Op; 5973 }; 5974 LS = CoerceOperand(LS); 5975 RS = CoerceOperand(RS); 5976 if (isa<SCEVCouldNotCompute>(LS) || isa<SCEVCouldNotCompute>(RS)) 5977 break; 5978 const SCEV *LDiff = getMinusSCEV(LA, LS); 5979 const SCEV *RDiff = getMinusSCEV(RA, RS); 5980 if (LDiff == RDiff) 5981 return getAddExpr(Signed ? getSMaxExpr(LS, RS) : getUMaxExpr(LS, RS), 5982 LDiff); 5983 LDiff = getMinusSCEV(LA, RS); 5984 RDiff = getMinusSCEV(RA, LS); 5985 if (LDiff == RDiff) 5986 return getAddExpr(Signed ? getSMinExpr(LS, RS) : getUMinExpr(LS, RS), 5987 LDiff); 5988 } 5989 break; 5990 case ICmpInst::ICMP_NE: 5991 // x != 0 ? x+y : C+y -> x == 0 ? C+y : x+y 5992 std::swap(TrueVal, FalseVal); 5993 LLVM_FALLTHROUGH; 5994 case ICmpInst::ICMP_EQ: 5995 // x == 0 ? C+y : x+y -> umax(x, C)+y iff C u<= 1 5996 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) && 5997 isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) { 5998 const SCEV *X = getNoopOrZeroExtend(getSCEV(LHS), I->getType()); 5999 const SCEV *TrueValExpr = getSCEV(TrueVal); // C+y 6000 const SCEV *FalseValExpr = getSCEV(FalseVal); // x+y 6001 const SCEV *Y = getMinusSCEV(FalseValExpr, X); // y = (x+y)-x 6002 const SCEV *C = getMinusSCEV(TrueValExpr, Y); // C = (C+y)-y 6003 if (isa<SCEVConstant>(C) && cast<SCEVConstant>(C)->getAPInt().ule(1)) 6004 return getAddExpr(getUMaxExpr(X, C), Y); 6005 } 6006 // x == 0 ? 0 : umin (..., x, ...) -> umin_seq(x, umin (...)) 6007 // x == 0 ? 0 : umin_seq(..., x, ...) -> umin_seq(x, umin_seq(...)) 6008 // x == 0 ? 0 : umin (..., umin_seq(..., x, ...), ...) 6009 // -> umin_seq(x, umin (..., umin_seq(...), ...)) 6010 if (isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero() && 6011 isa<ConstantInt>(TrueVal) && cast<ConstantInt>(TrueVal)->isZero()) { 6012 const SCEV *X = getSCEV(LHS); 6013 while (auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(X)) 6014 X = ZExt->getOperand(); 6015 if (getTypeSizeInBits(X->getType()) <= getTypeSizeInBits(I->getType())) { 6016 const SCEV *FalseValExpr = getSCEV(FalseVal); 6017 if (SCEVMinMaxExprContains(FalseValExpr, X, scSequentialUMinExpr)) 6018 return getUMinExpr(getNoopOrZeroExtend(X, I->getType()), FalseValExpr, 6019 /*Sequential=*/true); 6020 } 6021 } 6022 break; 6023 default: 6024 break; 6025 } 6026 6027 return getUnknown(I); 6028 } 6029 6030 const SCEV *ScalarEvolution::createNodeForSelectOrPHIViaUMinSeq( 6031 Value *V, Value *Cond, Value *TrueVal, Value *FalseVal) { 6032 // For now, only deal with i1-typed `select`s. 6033 if (!V->getType()->isIntegerTy(1) || !Cond->getType()->isIntegerTy(1) || 6034 !TrueVal->getType()->isIntegerTy(1) || 6035 !FalseVal->getType()->isIntegerTy(1)) 6036 return getUnknown(V); 6037 6038 // i1 cond ? i1 x : i1 C --> C + (i1 cond ? (i1 x - i1 C) : i1 0) 6039 // --> C + (umin_seq cond, x - C) 6040 // 6041 // i1 cond ? i1 C : i1 x --> C + (i1 cond ? i1 0 : (i1 x - i1 C)) 6042 // --> C + (i1 ~cond ? (i1 x - i1 C) : i1 0) 6043 // --> C + (umin_seq ~cond, x - C) 6044 if (isa<ConstantInt>(TrueVal) || isa<ConstantInt>(FalseVal)) { 6045 const SCEV *CondExpr = getSCEV(Cond); 6046 const SCEV *TrueExpr = getSCEV(TrueVal); 6047 const SCEV *FalseExpr = getSCEV(FalseVal); 6048 const SCEV *X, *C; 6049 if (isa<ConstantInt>(TrueVal)) { 6050 CondExpr = getNotSCEV(CondExpr); 6051 X = FalseExpr; 6052 C = TrueExpr; 6053 } else { 6054 X = TrueExpr; 6055 C = FalseExpr; 6056 } 6057 return getAddExpr( 6058 C, getUMinExpr(CondExpr, getMinusSCEV(X, C), /*Sequential=*/true)); 6059 } 6060 6061 return getUnknown(V); 6062 } 6063 6064 const SCEV *ScalarEvolution::createNodeForSelectOrPHI(Value *V, Value *Cond, 6065 Value *TrueVal, 6066 Value *FalseVal) { 6067 // Handle "constant" branch or select. This can occur for instance when a 6068 // loop pass transforms an inner loop and moves on to process the outer loop. 6069 if (auto *CI = dyn_cast<ConstantInt>(Cond)) 6070 return getSCEV(CI->isOne() ? TrueVal : FalseVal); 6071 6072 if (auto *I = dyn_cast<Instruction>(V)) { 6073 if (auto *ICI = dyn_cast<ICmpInst>(Cond)) { 6074 const SCEV *S = createNodeForSelectOrPHIInstWithICmpInstCond( 6075 I, ICI, TrueVal, FalseVal); 6076 if (!isa<SCEVUnknown>(S)) 6077 return S; 6078 } 6079 } 6080 6081 return createNodeForSelectOrPHIViaUMinSeq(V, Cond, TrueVal, FalseVal); 6082 } 6083 6084 /// Expand GEP instructions into add and multiply operations. This allows them 6085 /// to be analyzed by regular SCEV code. 6086 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) { 6087 // Don't attempt to analyze GEPs over unsized objects. 6088 if (!GEP->getSourceElementType()->isSized()) 6089 return getUnknown(GEP); 6090 6091 SmallVector<const SCEV *, 4> IndexExprs; 6092 for (Value *Index : GEP->indices()) 6093 IndexExprs.push_back(getSCEV(Index)); 6094 return getGEPExpr(GEP, IndexExprs); 6095 } 6096 6097 uint32_t ScalarEvolution::GetMinTrailingZerosImpl(const SCEV *S) { 6098 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) 6099 return C->getAPInt().countTrailingZeros(); 6100 6101 if (const SCEVPtrToIntExpr *I = dyn_cast<SCEVPtrToIntExpr>(S)) 6102 return GetMinTrailingZeros(I->getOperand()); 6103 6104 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S)) 6105 return std::min(GetMinTrailingZeros(T->getOperand()), 6106 (uint32_t)getTypeSizeInBits(T->getType())); 6107 6108 if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) { 6109 uint32_t OpRes = GetMinTrailingZeros(E->getOperand()); 6110 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) 6111 ? getTypeSizeInBits(E->getType()) 6112 : OpRes; 6113 } 6114 6115 if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) { 6116 uint32_t OpRes = GetMinTrailingZeros(E->getOperand()); 6117 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) 6118 ? getTypeSizeInBits(E->getType()) 6119 : OpRes; 6120 } 6121 6122 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) { 6123 // The result is the min of all operands results. 6124 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0)); 6125 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i) 6126 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i))); 6127 return MinOpRes; 6128 } 6129 6130 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) { 6131 // The result is the sum of all operands results. 6132 uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0)); 6133 uint32_t BitWidth = getTypeSizeInBits(M->getType()); 6134 for (unsigned i = 1, e = M->getNumOperands(); 6135 SumOpRes != BitWidth && i != e; ++i) 6136 SumOpRes = 6137 std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)), BitWidth); 6138 return SumOpRes; 6139 } 6140 6141 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) { 6142 // The result is the min of all operands results. 6143 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0)); 6144 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i) 6145 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i))); 6146 return MinOpRes; 6147 } 6148 6149 if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) { 6150 // The result is the min of all operands results. 6151 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0)); 6152 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i) 6153 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i))); 6154 return MinOpRes; 6155 } 6156 6157 if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) { 6158 // The result is the min of all operands results. 6159 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0)); 6160 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i) 6161 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i))); 6162 return MinOpRes; 6163 } 6164 6165 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) { 6166 // For a SCEVUnknown, ask ValueTracking. 6167 KnownBits Known = computeKnownBits(U->getValue(), getDataLayout(), 0, &AC, nullptr, &DT); 6168 return Known.countMinTrailingZeros(); 6169 } 6170 6171 // SCEVUDivExpr 6172 return 0; 6173 } 6174 6175 uint32_t ScalarEvolution::GetMinTrailingZeros(const SCEV *S) { 6176 auto I = MinTrailingZerosCache.find(S); 6177 if (I != MinTrailingZerosCache.end()) 6178 return I->second; 6179 6180 uint32_t Result = GetMinTrailingZerosImpl(S); 6181 auto InsertPair = MinTrailingZerosCache.insert({S, Result}); 6182 assert(InsertPair.second && "Should insert a new key"); 6183 return InsertPair.first->second; 6184 } 6185 6186 /// Helper method to assign a range to V from metadata present in the IR. 6187 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) { 6188 if (Instruction *I = dyn_cast<Instruction>(V)) 6189 if (MDNode *MD = I->getMetadata(LLVMContext::MD_range)) 6190 return getConstantRangeFromMetadata(*MD); 6191 6192 return None; 6193 } 6194 6195 void ScalarEvolution::setNoWrapFlags(SCEVAddRecExpr *AddRec, 6196 SCEV::NoWrapFlags Flags) { 6197 if (AddRec->getNoWrapFlags(Flags) != Flags) { 6198 AddRec->setNoWrapFlags(Flags); 6199 UnsignedRanges.erase(AddRec); 6200 SignedRanges.erase(AddRec); 6201 } 6202 } 6203 6204 ConstantRange ScalarEvolution:: 6205 getRangeForUnknownRecurrence(const SCEVUnknown *U) { 6206 const DataLayout &DL = getDataLayout(); 6207 6208 unsigned BitWidth = getTypeSizeInBits(U->getType()); 6209 const ConstantRange FullSet(BitWidth, /*isFullSet=*/true); 6210 6211 // Match a simple recurrence of the form: <start, ShiftOp, Step>, and then 6212 // use information about the trip count to improve our available range. Note 6213 // that the trip count independent cases are already handled by known bits. 6214 // WARNING: The definition of recurrence used here is subtly different than 6215 // the one used by AddRec (and thus most of this file). Step is allowed to 6216 // be arbitrarily loop varying here, where AddRec allows only loop invariant 6217 // and other addrecs in the same loop (for non-affine addrecs). The code 6218 // below intentionally handles the case where step is not loop invariant. 6219 auto *P = dyn_cast<PHINode>(U->getValue()); 6220 if (!P) 6221 return FullSet; 6222 6223 // Make sure that no Phi input comes from an unreachable block. Otherwise, 6224 // even the values that are not available in these blocks may come from them, 6225 // and this leads to false-positive recurrence test. 6226 for (auto *Pred : predecessors(P->getParent())) 6227 if (!DT.isReachableFromEntry(Pred)) 6228 return FullSet; 6229 6230 BinaryOperator *BO; 6231 Value *Start, *Step; 6232 if (!matchSimpleRecurrence(P, BO, Start, Step)) 6233 return FullSet; 6234 6235 // If we found a recurrence in reachable code, we must be in a loop. Note 6236 // that BO might be in some subloop of L, and that's completely okay. 6237 auto *L = LI.getLoopFor(P->getParent()); 6238 assert(L && L->getHeader() == P->getParent()); 6239 if (!L->contains(BO->getParent())) 6240 // NOTE: This bailout should be an assert instead. However, asserting 6241 // the condition here exposes a case where LoopFusion is querying SCEV 6242 // with malformed loop information during the midst of the transform. 6243 // There doesn't appear to be an obvious fix, so for the moment bailout 6244 // until the caller issue can be fixed. PR49566 tracks the bug. 6245 return FullSet; 6246 6247 // TODO: Extend to other opcodes such as mul, and div 6248 switch (BO->getOpcode()) { 6249 default: 6250 return FullSet; 6251 case Instruction::AShr: 6252 case Instruction::LShr: 6253 case Instruction::Shl: 6254 break; 6255 }; 6256 6257 if (BO->getOperand(0) != P) 6258 // TODO: Handle the power function forms some day. 6259 return FullSet; 6260 6261 unsigned TC = getSmallConstantMaxTripCount(L); 6262 if (!TC || TC >= BitWidth) 6263 return FullSet; 6264 6265 auto KnownStart = computeKnownBits(Start, DL, 0, &AC, nullptr, &DT); 6266 auto KnownStep = computeKnownBits(Step, DL, 0, &AC, nullptr, &DT); 6267 assert(KnownStart.getBitWidth() == BitWidth && 6268 KnownStep.getBitWidth() == BitWidth); 6269 6270 // Compute total shift amount, being careful of overflow and bitwidths. 6271 auto MaxShiftAmt = KnownStep.getMaxValue(); 6272 APInt TCAP(BitWidth, TC-1); 6273 bool Overflow = false; 6274 auto TotalShift = MaxShiftAmt.umul_ov(TCAP, Overflow); 6275 if (Overflow) 6276 return FullSet; 6277 6278 switch (BO->getOpcode()) { 6279 default: 6280 llvm_unreachable("filtered out above"); 6281 case Instruction::AShr: { 6282 // For each ashr, three cases: 6283 // shift = 0 => unchanged value 6284 // saturation => 0 or -1 6285 // other => a value closer to zero (of the same sign) 6286 // Thus, the end value is closer to zero than the start. 6287 auto KnownEnd = KnownBits::ashr(KnownStart, 6288 KnownBits::makeConstant(TotalShift)); 6289 if (KnownStart.isNonNegative()) 6290 // Analogous to lshr (simply not yet canonicalized) 6291 return ConstantRange::getNonEmpty(KnownEnd.getMinValue(), 6292 KnownStart.getMaxValue() + 1); 6293 if (KnownStart.isNegative()) 6294 // End >=u Start && End <=s Start 6295 return ConstantRange::getNonEmpty(KnownStart.getMinValue(), 6296 KnownEnd.getMaxValue() + 1); 6297 break; 6298 } 6299 case Instruction::LShr: { 6300 // For each lshr, three cases: 6301 // shift = 0 => unchanged value 6302 // saturation => 0 6303 // other => a smaller positive number 6304 // Thus, the low end of the unsigned range is the last value produced. 6305 auto KnownEnd = KnownBits::lshr(KnownStart, 6306 KnownBits::makeConstant(TotalShift)); 6307 return ConstantRange::getNonEmpty(KnownEnd.getMinValue(), 6308 KnownStart.getMaxValue() + 1); 6309 } 6310 case Instruction::Shl: { 6311 // Iff no bits are shifted out, value increases on every shift. 6312 auto KnownEnd = KnownBits::shl(KnownStart, 6313 KnownBits::makeConstant(TotalShift)); 6314 if (TotalShift.ult(KnownStart.countMinLeadingZeros())) 6315 return ConstantRange(KnownStart.getMinValue(), 6316 KnownEnd.getMaxValue() + 1); 6317 break; 6318 } 6319 }; 6320 return FullSet; 6321 } 6322 6323 /// Determine the range for a particular SCEV. If SignHint is 6324 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges 6325 /// with a "cleaner" unsigned (resp. signed) representation. 6326 const ConstantRange & 6327 ScalarEvolution::getRangeRef(const SCEV *S, 6328 ScalarEvolution::RangeSignHint SignHint) { 6329 DenseMap<const SCEV *, ConstantRange> &Cache = 6330 SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges 6331 : SignedRanges; 6332 ConstantRange::PreferredRangeType RangeType = 6333 SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED 6334 ? ConstantRange::Unsigned : ConstantRange::Signed; 6335 6336 // See if we've computed this range already. 6337 DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S); 6338 if (I != Cache.end()) 6339 return I->second; 6340 6341 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) 6342 return setRange(C, SignHint, ConstantRange(C->getAPInt())); 6343 6344 unsigned BitWidth = getTypeSizeInBits(S->getType()); 6345 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true); 6346 using OBO = OverflowingBinaryOperator; 6347 6348 // If the value has known zeros, the maximum value will have those known zeros 6349 // as well. 6350 uint32_t TZ = GetMinTrailingZeros(S); 6351 if (TZ != 0) { 6352 if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) 6353 ConservativeResult = 6354 ConstantRange(APInt::getMinValue(BitWidth), 6355 APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1); 6356 else 6357 ConservativeResult = ConstantRange( 6358 APInt::getSignedMinValue(BitWidth), 6359 APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1); 6360 } 6361 6362 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) { 6363 ConstantRange X = getRangeRef(Add->getOperand(0), SignHint); 6364 unsigned WrapType = OBO::AnyWrap; 6365 if (Add->hasNoSignedWrap()) 6366 WrapType |= OBO::NoSignedWrap; 6367 if (Add->hasNoUnsignedWrap()) 6368 WrapType |= OBO::NoUnsignedWrap; 6369 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i) 6370 X = X.addWithNoWrap(getRangeRef(Add->getOperand(i), SignHint), 6371 WrapType, RangeType); 6372 return setRange(Add, SignHint, 6373 ConservativeResult.intersectWith(X, RangeType)); 6374 } 6375 6376 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) { 6377 ConstantRange X = getRangeRef(Mul->getOperand(0), SignHint); 6378 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i) 6379 X = X.multiply(getRangeRef(Mul->getOperand(i), SignHint)); 6380 return setRange(Mul, SignHint, 6381 ConservativeResult.intersectWith(X, RangeType)); 6382 } 6383 6384 if (isa<SCEVMinMaxExpr>(S) || isa<SCEVSequentialMinMaxExpr>(S)) { 6385 Intrinsic::ID ID; 6386 switch (S->getSCEVType()) { 6387 case scUMaxExpr: 6388 ID = Intrinsic::umax; 6389 break; 6390 case scSMaxExpr: 6391 ID = Intrinsic::smax; 6392 break; 6393 case scUMinExpr: 6394 case scSequentialUMinExpr: 6395 ID = Intrinsic::umin; 6396 break; 6397 case scSMinExpr: 6398 ID = Intrinsic::smin; 6399 break; 6400 default: 6401 llvm_unreachable("Unknown SCEVMinMaxExpr/SCEVSequentialMinMaxExpr."); 6402 } 6403 6404 const auto *NAry = cast<SCEVNAryExpr>(S); 6405 ConstantRange X = getRangeRef(NAry->getOperand(0), SignHint); 6406 for (unsigned i = 1, e = NAry->getNumOperands(); i != e; ++i) 6407 X = X.intrinsic(ID, {X, getRangeRef(NAry->getOperand(i), SignHint)}); 6408 return setRange(S, SignHint, 6409 ConservativeResult.intersectWith(X, RangeType)); 6410 } 6411 6412 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) { 6413 ConstantRange X = getRangeRef(UDiv->getLHS(), SignHint); 6414 ConstantRange Y = getRangeRef(UDiv->getRHS(), SignHint); 6415 return setRange(UDiv, SignHint, 6416 ConservativeResult.intersectWith(X.udiv(Y), RangeType)); 6417 } 6418 6419 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) { 6420 ConstantRange X = getRangeRef(ZExt->getOperand(), SignHint); 6421 return setRange(ZExt, SignHint, 6422 ConservativeResult.intersectWith(X.zeroExtend(BitWidth), 6423 RangeType)); 6424 } 6425 6426 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) { 6427 ConstantRange X = getRangeRef(SExt->getOperand(), SignHint); 6428 return setRange(SExt, SignHint, 6429 ConservativeResult.intersectWith(X.signExtend(BitWidth), 6430 RangeType)); 6431 } 6432 6433 if (const SCEVPtrToIntExpr *PtrToInt = dyn_cast<SCEVPtrToIntExpr>(S)) { 6434 ConstantRange X = getRangeRef(PtrToInt->getOperand(), SignHint); 6435 return setRange(PtrToInt, SignHint, X); 6436 } 6437 6438 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) { 6439 ConstantRange X = getRangeRef(Trunc->getOperand(), SignHint); 6440 return setRange(Trunc, SignHint, 6441 ConservativeResult.intersectWith(X.truncate(BitWidth), 6442 RangeType)); 6443 } 6444 6445 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) { 6446 // If there's no unsigned wrap, the value will never be less than its 6447 // initial value. 6448 if (AddRec->hasNoUnsignedWrap()) { 6449 APInt UnsignedMinValue = getUnsignedRangeMin(AddRec->getStart()); 6450 if (!UnsignedMinValue.isZero()) 6451 ConservativeResult = ConservativeResult.intersectWith( 6452 ConstantRange(UnsignedMinValue, APInt(BitWidth, 0)), RangeType); 6453 } 6454 6455 // If there's no signed wrap, and all the operands except initial value have 6456 // the same sign or zero, the value won't ever be: 6457 // 1: smaller than initial value if operands are non negative, 6458 // 2: bigger than initial value if operands are non positive. 6459 // For both cases, value can not cross signed min/max boundary. 6460 if (AddRec->hasNoSignedWrap()) { 6461 bool AllNonNeg = true; 6462 bool AllNonPos = true; 6463 for (unsigned i = 1, e = AddRec->getNumOperands(); i != e; ++i) { 6464 if (!isKnownNonNegative(AddRec->getOperand(i))) 6465 AllNonNeg = false; 6466 if (!isKnownNonPositive(AddRec->getOperand(i))) 6467 AllNonPos = false; 6468 } 6469 if (AllNonNeg) 6470 ConservativeResult = ConservativeResult.intersectWith( 6471 ConstantRange::getNonEmpty(getSignedRangeMin(AddRec->getStart()), 6472 APInt::getSignedMinValue(BitWidth)), 6473 RangeType); 6474 else if (AllNonPos) 6475 ConservativeResult = ConservativeResult.intersectWith( 6476 ConstantRange::getNonEmpty( 6477 APInt::getSignedMinValue(BitWidth), 6478 getSignedRangeMax(AddRec->getStart()) + 1), 6479 RangeType); 6480 } 6481 6482 // TODO: non-affine addrec 6483 if (AddRec->isAffine()) { 6484 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(AddRec->getLoop()); 6485 if (!isa<SCEVCouldNotCompute>(MaxBECount) && 6486 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) { 6487 auto RangeFromAffine = getRangeForAffineAR( 6488 AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount, 6489 BitWidth); 6490 ConservativeResult = 6491 ConservativeResult.intersectWith(RangeFromAffine, RangeType); 6492 6493 auto RangeFromFactoring = getRangeViaFactoring( 6494 AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount, 6495 BitWidth); 6496 ConservativeResult = 6497 ConservativeResult.intersectWith(RangeFromFactoring, RangeType); 6498 } 6499 6500 // Now try symbolic BE count and more powerful methods. 6501 if (UseExpensiveRangeSharpening) { 6502 const SCEV *SymbolicMaxBECount = 6503 getSymbolicMaxBackedgeTakenCount(AddRec->getLoop()); 6504 if (!isa<SCEVCouldNotCompute>(SymbolicMaxBECount) && 6505 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth && 6506 AddRec->hasNoSelfWrap()) { 6507 auto RangeFromAffineNew = getRangeForAffineNoSelfWrappingAR( 6508 AddRec, SymbolicMaxBECount, BitWidth, SignHint); 6509 ConservativeResult = 6510 ConservativeResult.intersectWith(RangeFromAffineNew, RangeType); 6511 } 6512 } 6513 } 6514 6515 return setRange(AddRec, SignHint, std::move(ConservativeResult)); 6516 } 6517 6518 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) { 6519 6520 // Check if the IR explicitly contains !range metadata. 6521 Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue()); 6522 if (MDRange.hasValue()) 6523 ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue(), 6524 RangeType); 6525 6526 // Use facts about recurrences in the underlying IR. Note that add 6527 // recurrences are AddRecExprs and thus don't hit this path. This 6528 // primarily handles shift recurrences. 6529 auto CR = getRangeForUnknownRecurrence(U); 6530 ConservativeResult = ConservativeResult.intersectWith(CR); 6531 6532 // See if ValueTracking can give us a useful range. 6533 const DataLayout &DL = getDataLayout(); 6534 KnownBits Known = computeKnownBits(U->getValue(), DL, 0, &AC, nullptr, &DT); 6535 if (Known.getBitWidth() != BitWidth) 6536 Known = Known.zextOrTrunc(BitWidth); 6537 6538 // ValueTracking may be able to compute a tighter result for the number of 6539 // sign bits than for the value of those sign bits. 6540 unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, &AC, nullptr, &DT); 6541 if (U->getType()->isPointerTy()) { 6542 // If the pointer size is larger than the index size type, this can cause 6543 // NS to be larger than BitWidth. So compensate for this. 6544 unsigned ptrSize = DL.getPointerTypeSizeInBits(U->getType()); 6545 int ptrIdxDiff = ptrSize - BitWidth; 6546 if (ptrIdxDiff > 0 && ptrSize > BitWidth && NS > (unsigned)ptrIdxDiff) 6547 NS -= ptrIdxDiff; 6548 } 6549 6550 if (NS > 1) { 6551 // If we know any of the sign bits, we know all of the sign bits. 6552 if (!Known.Zero.getHiBits(NS).isZero()) 6553 Known.Zero.setHighBits(NS); 6554 if (!Known.One.getHiBits(NS).isZero()) 6555 Known.One.setHighBits(NS); 6556 } 6557 6558 if (Known.getMinValue() != Known.getMaxValue() + 1) 6559 ConservativeResult = ConservativeResult.intersectWith( 6560 ConstantRange(Known.getMinValue(), Known.getMaxValue() + 1), 6561 RangeType); 6562 if (NS > 1) 6563 ConservativeResult = ConservativeResult.intersectWith( 6564 ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1), 6565 APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1), 6566 RangeType); 6567 6568 // A range of Phi is a subset of union of all ranges of its input. 6569 if (const PHINode *Phi = dyn_cast<PHINode>(U->getValue())) { 6570 // Make sure that we do not run over cycled Phis. 6571 if (PendingPhiRanges.insert(Phi).second) { 6572 ConstantRange RangeFromOps(BitWidth, /*isFullSet=*/false); 6573 for (auto &Op : Phi->operands()) { 6574 auto OpRange = getRangeRef(getSCEV(Op), SignHint); 6575 RangeFromOps = RangeFromOps.unionWith(OpRange); 6576 // No point to continue if we already have a full set. 6577 if (RangeFromOps.isFullSet()) 6578 break; 6579 } 6580 ConservativeResult = 6581 ConservativeResult.intersectWith(RangeFromOps, RangeType); 6582 bool Erased = PendingPhiRanges.erase(Phi); 6583 assert(Erased && "Failed to erase Phi properly?"); 6584 (void) Erased; 6585 } 6586 } 6587 6588 return setRange(U, SignHint, std::move(ConservativeResult)); 6589 } 6590 6591 return setRange(S, SignHint, std::move(ConservativeResult)); 6592 } 6593 6594 // Given a StartRange, Step and MaxBECount for an expression compute a range of 6595 // values that the expression can take. Initially, the expression has a value 6596 // from StartRange and then is changed by Step up to MaxBECount times. Signed 6597 // argument defines if we treat Step as signed or unsigned. 6598 static ConstantRange getRangeForAffineARHelper(APInt Step, 6599 const ConstantRange &StartRange, 6600 const APInt &MaxBECount, 6601 unsigned BitWidth, bool Signed) { 6602 // If either Step or MaxBECount is 0, then the expression won't change, and we 6603 // just need to return the initial range. 6604 if (Step == 0 || MaxBECount == 0) 6605 return StartRange; 6606 6607 // If we don't know anything about the initial value (i.e. StartRange is 6608 // FullRange), then we don't know anything about the final range either. 6609 // Return FullRange. 6610 if (StartRange.isFullSet()) 6611 return ConstantRange::getFull(BitWidth); 6612 6613 // If Step is signed and negative, then we use its absolute value, but we also 6614 // note that we're moving in the opposite direction. 6615 bool Descending = Signed && Step.isNegative(); 6616 6617 if (Signed) 6618 // This is correct even for INT_SMIN. Let's look at i8 to illustrate this: 6619 // abs(INT_SMIN) = abs(-128) = abs(0x80) = -0x80 = 0x80 = 128. 6620 // This equations hold true due to the well-defined wrap-around behavior of 6621 // APInt. 6622 Step = Step.abs(); 6623 6624 // Check if Offset is more than full span of BitWidth. If it is, the 6625 // expression is guaranteed to overflow. 6626 if (APInt::getMaxValue(StartRange.getBitWidth()).udiv(Step).ult(MaxBECount)) 6627 return ConstantRange::getFull(BitWidth); 6628 6629 // Offset is by how much the expression can change. Checks above guarantee no 6630 // overflow here. 6631 APInt Offset = Step * MaxBECount; 6632 6633 // Minimum value of the final range will match the minimal value of StartRange 6634 // if the expression is increasing and will be decreased by Offset otherwise. 6635 // Maximum value of the final range will match the maximal value of StartRange 6636 // if the expression is decreasing and will be increased by Offset otherwise. 6637 APInt StartLower = StartRange.getLower(); 6638 APInt StartUpper = StartRange.getUpper() - 1; 6639 APInt MovedBoundary = Descending ? (StartLower - std::move(Offset)) 6640 : (StartUpper + std::move(Offset)); 6641 6642 // It's possible that the new minimum/maximum value will fall into the initial 6643 // range (due to wrap around). This means that the expression can take any 6644 // value in this bitwidth, and we have to return full range. 6645 if (StartRange.contains(MovedBoundary)) 6646 return ConstantRange::getFull(BitWidth); 6647 6648 APInt NewLower = 6649 Descending ? std::move(MovedBoundary) : std::move(StartLower); 6650 APInt NewUpper = 6651 Descending ? std::move(StartUpper) : std::move(MovedBoundary); 6652 NewUpper += 1; 6653 6654 // No overflow detected, return [StartLower, StartUpper + Offset + 1) range. 6655 return ConstantRange::getNonEmpty(std::move(NewLower), std::move(NewUpper)); 6656 } 6657 6658 ConstantRange ScalarEvolution::getRangeForAffineAR(const SCEV *Start, 6659 const SCEV *Step, 6660 const SCEV *MaxBECount, 6661 unsigned BitWidth) { 6662 assert(!isa<SCEVCouldNotCompute>(MaxBECount) && 6663 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth && 6664 "Precondition!"); 6665 6666 MaxBECount = getNoopOrZeroExtend(MaxBECount, Start->getType()); 6667 APInt MaxBECountValue = getUnsignedRangeMax(MaxBECount); 6668 6669 // First, consider step signed. 6670 ConstantRange StartSRange = getSignedRange(Start); 6671 ConstantRange StepSRange = getSignedRange(Step); 6672 6673 // If Step can be both positive and negative, we need to find ranges for the 6674 // maximum absolute step values in both directions and union them. 6675 ConstantRange SR = 6676 getRangeForAffineARHelper(StepSRange.getSignedMin(), StartSRange, 6677 MaxBECountValue, BitWidth, /* Signed = */ true); 6678 SR = SR.unionWith(getRangeForAffineARHelper(StepSRange.getSignedMax(), 6679 StartSRange, MaxBECountValue, 6680 BitWidth, /* Signed = */ true)); 6681 6682 // Next, consider step unsigned. 6683 ConstantRange UR = getRangeForAffineARHelper( 6684 getUnsignedRangeMax(Step), getUnsignedRange(Start), 6685 MaxBECountValue, BitWidth, /* Signed = */ false); 6686 6687 // Finally, intersect signed and unsigned ranges. 6688 return SR.intersectWith(UR, ConstantRange::Smallest); 6689 } 6690 6691 ConstantRange ScalarEvolution::getRangeForAffineNoSelfWrappingAR( 6692 const SCEVAddRecExpr *AddRec, const SCEV *MaxBECount, unsigned BitWidth, 6693 ScalarEvolution::RangeSignHint SignHint) { 6694 assert(AddRec->isAffine() && "Non-affine AddRecs are not suppored!\n"); 6695 assert(AddRec->hasNoSelfWrap() && 6696 "This only works for non-self-wrapping AddRecs!"); 6697 const bool IsSigned = SignHint == HINT_RANGE_SIGNED; 6698 const SCEV *Step = AddRec->getStepRecurrence(*this); 6699 // Only deal with constant step to save compile time. 6700 if (!isa<SCEVConstant>(Step)) 6701 return ConstantRange::getFull(BitWidth); 6702 // Let's make sure that we can prove that we do not self-wrap during 6703 // MaxBECount iterations. We need this because MaxBECount is a maximum 6704 // iteration count estimate, and we might infer nw from some exit for which we 6705 // do not know max exit count (or any other side reasoning). 6706 // TODO: Turn into assert at some point. 6707 if (getTypeSizeInBits(MaxBECount->getType()) > 6708 getTypeSizeInBits(AddRec->getType())) 6709 return ConstantRange::getFull(BitWidth); 6710 MaxBECount = getNoopOrZeroExtend(MaxBECount, AddRec->getType()); 6711 const SCEV *RangeWidth = getMinusOne(AddRec->getType()); 6712 const SCEV *StepAbs = getUMinExpr(Step, getNegativeSCEV(Step)); 6713 const SCEV *MaxItersWithoutWrap = getUDivExpr(RangeWidth, StepAbs); 6714 if (!isKnownPredicateViaConstantRanges(ICmpInst::ICMP_ULE, MaxBECount, 6715 MaxItersWithoutWrap)) 6716 return ConstantRange::getFull(BitWidth); 6717 6718 ICmpInst::Predicate LEPred = 6719 IsSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 6720 ICmpInst::Predicate GEPred = 6721 IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 6722 const SCEV *End = AddRec->evaluateAtIteration(MaxBECount, *this); 6723 6724 // We know that there is no self-wrap. Let's take Start and End values and 6725 // look at all intermediate values V1, V2, ..., Vn that IndVar takes during 6726 // the iteration. They either lie inside the range [Min(Start, End), 6727 // Max(Start, End)] or outside it: 6728 // 6729 // Case 1: RangeMin ... Start V1 ... VN End ... RangeMax; 6730 // Case 2: RangeMin Vk ... V1 Start ... End Vn ... Vk + 1 RangeMax; 6731 // 6732 // No self wrap flag guarantees that the intermediate values cannot be BOTH 6733 // outside and inside the range [Min(Start, End), Max(Start, End)]. Using that 6734 // knowledge, let's try to prove that we are dealing with Case 1. It is so if 6735 // Start <= End and step is positive, or Start >= End and step is negative. 6736 const SCEV *Start = AddRec->getStart(); 6737 ConstantRange StartRange = getRangeRef(Start, SignHint); 6738 ConstantRange EndRange = getRangeRef(End, SignHint); 6739 ConstantRange RangeBetween = StartRange.unionWith(EndRange); 6740 // If they already cover full iteration space, we will know nothing useful 6741 // even if we prove what we want to prove. 6742 if (RangeBetween.isFullSet()) 6743 return RangeBetween; 6744 // Only deal with ranges that do not wrap (i.e. RangeMin < RangeMax). 6745 bool IsWrappedSet = IsSigned ? RangeBetween.isSignWrappedSet() 6746 : RangeBetween.isWrappedSet(); 6747 if (IsWrappedSet) 6748 return ConstantRange::getFull(BitWidth); 6749 6750 if (isKnownPositive(Step) && 6751 isKnownPredicateViaConstantRanges(LEPred, Start, End)) 6752 return RangeBetween; 6753 else if (isKnownNegative(Step) && 6754 isKnownPredicateViaConstantRanges(GEPred, Start, End)) 6755 return RangeBetween; 6756 return ConstantRange::getFull(BitWidth); 6757 } 6758 6759 ConstantRange ScalarEvolution::getRangeViaFactoring(const SCEV *Start, 6760 const SCEV *Step, 6761 const SCEV *MaxBECount, 6762 unsigned BitWidth) { 6763 // RangeOf({C?A:B,+,C?P:Q}) == RangeOf(C?{A,+,P}:{B,+,Q}) 6764 // == RangeOf({A,+,P}) union RangeOf({B,+,Q}) 6765 6766 struct SelectPattern { 6767 Value *Condition = nullptr; 6768 APInt TrueValue; 6769 APInt FalseValue; 6770 6771 explicit SelectPattern(ScalarEvolution &SE, unsigned BitWidth, 6772 const SCEV *S) { 6773 Optional<unsigned> CastOp; 6774 APInt Offset(BitWidth, 0); 6775 6776 assert(SE.getTypeSizeInBits(S->getType()) == BitWidth && 6777 "Should be!"); 6778 6779 // Peel off a constant offset: 6780 if (auto *SA = dyn_cast<SCEVAddExpr>(S)) { 6781 // In the future we could consider being smarter here and handle 6782 // {Start+Step,+,Step} too. 6783 if (SA->getNumOperands() != 2 || !isa<SCEVConstant>(SA->getOperand(0))) 6784 return; 6785 6786 Offset = cast<SCEVConstant>(SA->getOperand(0))->getAPInt(); 6787 S = SA->getOperand(1); 6788 } 6789 6790 // Peel off a cast operation 6791 if (auto *SCast = dyn_cast<SCEVIntegralCastExpr>(S)) { 6792 CastOp = SCast->getSCEVType(); 6793 S = SCast->getOperand(); 6794 } 6795 6796 using namespace llvm::PatternMatch; 6797 6798 auto *SU = dyn_cast<SCEVUnknown>(S); 6799 const APInt *TrueVal, *FalseVal; 6800 if (!SU || 6801 !match(SU->getValue(), m_Select(m_Value(Condition), m_APInt(TrueVal), 6802 m_APInt(FalseVal)))) { 6803 Condition = nullptr; 6804 return; 6805 } 6806 6807 TrueValue = *TrueVal; 6808 FalseValue = *FalseVal; 6809 6810 // Re-apply the cast we peeled off earlier 6811 if (CastOp.hasValue()) 6812 switch (*CastOp) { 6813 default: 6814 llvm_unreachable("Unknown SCEV cast type!"); 6815 6816 case scTruncate: 6817 TrueValue = TrueValue.trunc(BitWidth); 6818 FalseValue = FalseValue.trunc(BitWidth); 6819 break; 6820 case scZeroExtend: 6821 TrueValue = TrueValue.zext(BitWidth); 6822 FalseValue = FalseValue.zext(BitWidth); 6823 break; 6824 case scSignExtend: 6825 TrueValue = TrueValue.sext(BitWidth); 6826 FalseValue = FalseValue.sext(BitWidth); 6827 break; 6828 } 6829 6830 // Re-apply the constant offset we peeled off earlier 6831 TrueValue += Offset; 6832 FalseValue += Offset; 6833 } 6834 6835 bool isRecognized() { return Condition != nullptr; } 6836 }; 6837 6838 SelectPattern StartPattern(*this, BitWidth, Start); 6839 if (!StartPattern.isRecognized()) 6840 return ConstantRange::getFull(BitWidth); 6841 6842 SelectPattern StepPattern(*this, BitWidth, Step); 6843 if (!StepPattern.isRecognized()) 6844 return ConstantRange::getFull(BitWidth); 6845 6846 if (StartPattern.Condition != StepPattern.Condition) { 6847 // We don't handle this case today; but we could, by considering four 6848 // possibilities below instead of two. I'm not sure if there are cases where 6849 // that will help over what getRange already does, though. 6850 return ConstantRange::getFull(BitWidth); 6851 } 6852 6853 // NB! Calling ScalarEvolution::getConstant is fine, but we should not try to 6854 // construct arbitrary general SCEV expressions here. This function is called 6855 // from deep in the call stack, and calling getSCEV (on a sext instruction, 6856 // say) can end up caching a suboptimal value. 6857 6858 // FIXME: without the explicit `this` receiver below, MSVC errors out with 6859 // C2352 and C2512 (otherwise it isn't needed). 6860 6861 const SCEV *TrueStart = this->getConstant(StartPattern.TrueValue); 6862 const SCEV *TrueStep = this->getConstant(StepPattern.TrueValue); 6863 const SCEV *FalseStart = this->getConstant(StartPattern.FalseValue); 6864 const SCEV *FalseStep = this->getConstant(StepPattern.FalseValue); 6865 6866 ConstantRange TrueRange = 6867 this->getRangeForAffineAR(TrueStart, TrueStep, MaxBECount, BitWidth); 6868 ConstantRange FalseRange = 6869 this->getRangeForAffineAR(FalseStart, FalseStep, MaxBECount, BitWidth); 6870 6871 return TrueRange.unionWith(FalseRange); 6872 } 6873 6874 SCEV::NoWrapFlags ScalarEvolution::getNoWrapFlagsFromUB(const Value *V) { 6875 if (isa<ConstantExpr>(V)) return SCEV::FlagAnyWrap; 6876 const BinaryOperator *BinOp = cast<BinaryOperator>(V); 6877 6878 // Return early if there are no flags to propagate to the SCEV. 6879 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 6880 if (BinOp->hasNoUnsignedWrap()) 6881 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 6882 if (BinOp->hasNoSignedWrap()) 6883 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 6884 if (Flags == SCEV::FlagAnyWrap) 6885 return SCEV::FlagAnyWrap; 6886 6887 return isSCEVExprNeverPoison(BinOp) ? Flags : SCEV::FlagAnyWrap; 6888 } 6889 6890 const Instruction * 6891 ScalarEvolution::getNonTrivialDefiningScopeBound(const SCEV *S) { 6892 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(S)) 6893 return &*AddRec->getLoop()->getHeader()->begin(); 6894 if (auto *U = dyn_cast<SCEVUnknown>(S)) 6895 if (auto *I = dyn_cast<Instruction>(U->getValue())) 6896 return I; 6897 return nullptr; 6898 } 6899 6900 /// Fills \p Ops with unique operands of \p S, if it has operands. If not, 6901 /// \p Ops remains unmodified. 6902 static void collectUniqueOps(const SCEV *S, 6903 SmallVectorImpl<const SCEV *> &Ops) { 6904 SmallPtrSet<const SCEV *, 4> Unique; 6905 auto InsertUnique = [&](const SCEV *S) { 6906 if (Unique.insert(S).second) 6907 Ops.push_back(S); 6908 }; 6909 if (auto *S2 = dyn_cast<SCEVCastExpr>(S)) 6910 for (auto *Op : S2->operands()) 6911 InsertUnique(Op); 6912 else if (auto *S2 = dyn_cast<SCEVNAryExpr>(S)) 6913 for (auto *Op : S2->operands()) 6914 InsertUnique(Op); 6915 else if (auto *S2 = dyn_cast<SCEVUDivExpr>(S)) 6916 for (auto *Op : S2->operands()) 6917 InsertUnique(Op); 6918 } 6919 6920 const Instruction * 6921 ScalarEvolution::getDefiningScopeBound(ArrayRef<const SCEV *> Ops, 6922 bool &Precise) { 6923 Precise = true; 6924 // Do a bounded search of the def relation of the requested SCEVs. 6925 SmallSet<const SCEV *, 16> Visited; 6926 SmallVector<const SCEV *> Worklist; 6927 auto pushOp = [&](const SCEV *S) { 6928 if (!Visited.insert(S).second) 6929 return; 6930 // Threshold of 30 here is arbitrary. 6931 if (Visited.size() > 30) { 6932 Precise = false; 6933 return; 6934 } 6935 Worklist.push_back(S); 6936 }; 6937 6938 for (auto *S : Ops) 6939 pushOp(S); 6940 6941 const Instruction *Bound = nullptr; 6942 while (!Worklist.empty()) { 6943 auto *S = Worklist.pop_back_val(); 6944 if (auto *DefI = getNonTrivialDefiningScopeBound(S)) { 6945 if (!Bound || DT.dominates(Bound, DefI)) 6946 Bound = DefI; 6947 } else { 6948 SmallVector<const SCEV *, 4> Ops; 6949 collectUniqueOps(S, Ops); 6950 for (auto *Op : Ops) 6951 pushOp(Op); 6952 } 6953 } 6954 return Bound ? Bound : &*F.getEntryBlock().begin(); 6955 } 6956 6957 const Instruction * 6958 ScalarEvolution::getDefiningScopeBound(ArrayRef<const SCEV *> Ops) { 6959 bool Discard; 6960 return getDefiningScopeBound(Ops, Discard); 6961 } 6962 6963 bool ScalarEvolution::isGuaranteedToTransferExecutionTo(const Instruction *A, 6964 const Instruction *B) { 6965 if (A->getParent() == B->getParent() && 6966 isGuaranteedToTransferExecutionToSuccessor(A->getIterator(), 6967 B->getIterator())) 6968 return true; 6969 6970 auto *BLoop = LI.getLoopFor(B->getParent()); 6971 if (BLoop && BLoop->getHeader() == B->getParent() && 6972 BLoop->getLoopPreheader() == A->getParent() && 6973 isGuaranteedToTransferExecutionToSuccessor(A->getIterator(), 6974 A->getParent()->end()) && 6975 isGuaranteedToTransferExecutionToSuccessor(B->getParent()->begin(), 6976 B->getIterator())) 6977 return true; 6978 return false; 6979 } 6980 6981 6982 bool ScalarEvolution::isSCEVExprNeverPoison(const Instruction *I) { 6983 // Only proceed if we can prove that I does not yield poison. 6984 if (!programUndefinedIfPoison(I)) 6985 return false; 6986 6987 // At this point we know that if I is executed, then it does not wrap 6988 // according to at least one of NSW or NUW. If I is not executed, then we do 6989 // not know if the calculation that I represents would wrap. Multiple 6990 // instructions can map to the same SCEV. If we apply NSW or NUW from I to 6991 // the SCEV, we must guarantee no wrapping for that SCEV also when it is 6992 // derived from other instructions that map to the same SCEV. We cannot make 6993 // that guarantee for cases where I is not executed. So we need to find a 6994 // upper bound on the defining scope for the SCEV, and prove that I is 6995 // executed every time we enter that scope. When the bounding scope is a 6996 // loop (the common case), this is equivalent to proving I executes on every 6997 // iteration of that loop. 6998 SmallVector<const SCEV *> SCEVOps; 6999 for (const Use &Op : I->operands()) { 7000 // I could be an extractvalue from a call to an overflow intrinsic. 7001 // TODO: We can do better here in some cases. 7002 if (isSCEVable(Op->getType())) 7003 SCEVOps.push_back(getSCEV(Op)); 7004 } 7005 auto *DefI = getDefiningScopeBound(SCEVOps); 7006 return isGuaranteedToTransferExecutionTo(DefI, I); 7007 } 7008 7009 bool ScalarEvolution::isAddRecNeverPoison(const Instruction *I, const Loop *L) { 7010 // If we know that \c I can never be poison period, then that's enough. 7011 if (isSCEVExprNeverPoison(I)) 7012 return true; 7013 7014 // For an add recurrence specifically, we assume that infinite loops without 7015 // side effects are undefined behavior, and then reason as follows: 7016 // 7017 // If the add recurrence is poison in any iteration, it is poison on all 7018 // future iterations (since incrementing poison yields poison). If the result 7019 // of the add recurrence is fed into the loop latch condition and the loop 7020 // does not contain any throws or exiting blocks other than the latch, we now 7021 // have the ability to "choose" whether the backedge is taken or not (by 7022 // choosing a sufficiently evil value for the poison feeding into the branch) 7023 // for every iteration including and after the one in which \p I first became 7024 // poison. There are two possibilities (let's call the iteration in which \p 7025 // I first became poison as K): 7026 // 7027 // 1. In the set of iterations including and after K, the loop body executes 7028 // no side effects. In this case executing the backege an infinte number 7029 // of times will yield undefined behavior. 7030 // 7031 // 2. In the set of iterations including and after K, the loop body executes 7032 // at least one side effect. In this case, that specific instance of side 7033 // effect is control dependent on poison, which also yields undefined 7034 // behavior. 7035 7036 auto *ExitingBB = L->getExitingBlock(); 7037 auto *LatchBB = L->getLoopLatch(); 7038 if (!ExitingBB || !LatchBB || ExitingBB != LatchBB) 7039 return false; 7040 7041 SmallPtrSet<const Instruction *, 16> Pushed; 7042 SmallVector<const Instruction *, 8> PoisonStack; 7043 7044 // We start by assuming \c I, the post-inc add recurrence, is poison. Only 7045 // things that are known to be poison under that assumption go on the 7046 // PoisonStack. 7047 Pushed.insert(I); 7048 PoisonStack.push_back(I); 7049 7050 bool LatchControlDependentOnPoison = false; 7051 while (!PoisonStack.empty() && !LatchControlDependentOnPoison) { 7052 const Instruction *Poison = PoisonStack.pop_back_val(); 7053 7054 for (auto *PoisonUser : Poison->users()) { 7055 if (propagatesPoison(cast<Operator>(PoisonUser))) { 7056 if (Pushed.insert(cast<Instruction>(PoisonUser)).second) 7057 PoisonStack.push_back(cast<Instruction>(PoisonUser)); 7058 } else if (auto *BI = dyn_cast<BranchInst>(PoisonUser)) { 7059 assert(BI->isConditional() && "Only possibility!"); 7060 if (BI->getParent() == LatchBB) { 7061 LatchControlDependentOnPoison = true; 7062 break; 7063 } 7064 } 7065 } 7066 } 7067 7068 return LatchControlDependentOnPoison && loopHasNoAbnormalExits(L); 7069 } 7070 7071 ScalarEvolution::LoopProperties 7072 ScalarEvolution::getLoopProperties(const Loop *L) { 7073 using LoopProperties = ScalarEvolution::LoopProperties; 7074 7075 auto Itr = LoopPropertiesCache.find(L); 7076 if (Itr == LoopPropertiesCache.end()) { 7077 auto HasSideEffects = [](Instruction *I) { 7078 if (auto *SI = dyn_cast<StoreInst>(I)) 7079 return !SI->isSimple(); 7080 7081 return I->mayThrow() || I->mayWriteToMemory(); 7082 }; 7083 7084 LoopProperties LP = {/* HasNoAbnormalExits */ true, 7085 /*HasNoSideEffects*/ true}; 7086 7087 for (auto *BB : L->getBlocks()) 7088 for (auto &I : *BB) { 7089 if (!isGuaranteedToTransferExecutionToSuccessor(&I)) 7090 LP.HasNoAbnormalExits = false; 7091 if (HasSideEffects(&I)) 7092 LP.HasNoSideEffects = false; 7093 if (!LP.HasNoAbnormalExits && !LP.HasNoSideEffects) 7094 break; // We're already as pessimistic as we can get. 7095 } 7096 7097 auto InsertPair = LoopPropertiesCache.insert({L, LP}); 7098 assert(InsertPair.second && "We just checked!"); 7099 Itr = InsertPair.first; 7100 } 7101 7102 return Itr->second; 7103 } 7104 7105 bool ScalarEvolution::loopIsFiniteByAssumption(const Loop *L) { 7106 // A mustprogress loop without side effects must be finite. 7107 // TODO: The check used here is very conservative. It's only *specific* 7108 // side effects which are well defined in infinite loops. 7109 return isFinite(L) || (isMustProgress(L) && loopHasNoSideEffects(L)); 7110 } 7111 7112 const SCEV *ScalarEvolution::createSCEV(Value *V) { 7113 if (!isSCEVable(V->getType())) 7114 return getUnknown(V); 7115 7116 if (Instruction *I = dyn_cast<Instruction>(V)) { 7117 // Don't attempt to analyze instructions in blocks that aren't 7118 // reachable. Such instructions don't matter, and they aren't required 7119 // to obey basic rules for definitions dominating uses which this 7120 // analysis depends on. 7121 if (!DT.isReachableFromEntry(I->getParent())) 7122 return getUnknown(UndefValue::get(V->getType())); 7123 } else if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) 7124 return getConstant(CI); 7125 else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) 7126 return GA->isInterposable() ? getUnknown(V) : getSCEV(GA->getAliasee()); 7127 else if (!isa<ConstantExpr>(V)) 7128 return getUnknown(V); 7129 7130 Operator *U = cast<Operator>(V); 7131 if (auto BO = MatchBinaryOp(U, DT)) { 7132 switch (BO->Opcode) { 7133 case Instruction::Add: { 7134 // The simple thing to do would be to just call getSCEV on both operands 7135 // and call getAddExpr with the result. However if we're looking at a 7136 // bunch of things all added together, this can be quite inefficient, 7137 // because it leads to N-1 getAddExpr calls for N ultimate operands. 7138 // Instead, gather up all the operands and make a single getAddExpr call. 7139 // LLVM IR canonical form means we need only traverse the left operands. 7140 SmallVector<const SCEV *, 4> AddOps; 7141 do { 7142 if (BO->Op) { 7143 if (auto *OpSCEV = getExistingSCEV(BO->Op)) { 7144 AddOps.push_back(OpSCEV); 7145 break; 7146 } 7147 7148 // If a NUW or NSW flag can be applied to the SCEV for this 7149 // addition, then compute the SCEV for this addition by itself 7150 // with a separate call to getAddExpr. We need to do that 7151 // instead of pushing the operands of the addition onto AddOps, 7152 // since the flags are only known to apply to this particular 7153 // addition - they may not apply to other additions that can be 7154 // formed with operands from AddOps. 7155 const SCEV *RHS = getSCEV(BO->RHS); 7156 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op); 7157 if (Flags != SCEV::FlagAnyWrap) { 7158 const SCEV *LHS = getSCEV(BO->LHS); 7159 if (BO->Opcode == Instruction::Sub) 7160 AddOps.push_back(getMinusSCEV(LHS, RHS, Flags)); 7161 else 7162 AddOps.push_back(getAddExpr(LHS, RHS, Flags)); 7163 break; 7164 } 7165 } 7166 7167 if (BO->Opcode == Instruction::Sub) 7168 AddOps.push_back(getNegativeSCEV(getSCEV(BO->RHS))); 7169 else 7170 AddOps.push_back(getSCEV(BO->RHS)); 7171 7172 auto NewBO = MatchBinaryOp(BO->LHS, DT); 7173 if (!NewBO || (NewBO->Opcode != Instruction::Add && 7174 NewBO->Opcode != Instruction::Sub)) { 7175 AddOps.push_back(getSCEV(BO->LHS)); 7176 break; 7177 } 7178 BO = NewBO; 7179 } while (true); 7180 7181 return getAddExpr(AddOps); 7182 } 7183 7184 case Instruction::Mul: { 7185 SmallVector<const SCEV *, 4> MulOps; 7186 do { 7187 if (BO->Op) { 7188 if (auto *OpSCEV = getExistingSCEV(BO->Op)) { 7189 MulOps.push_back(OpSCEV); 7190 break; 7191 } 7192 7193 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op); 7194 if (Flags != SCEV::FlagAnyWrap) { 7195 MulOps.push_back( 7196 getMulExpr(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags)); 7197 break; 7198 } 7199 } 7200 7201 MulOps.push_back(getSCEV(BO->RHS)); 7202 auto NewBO = MatchBinaryOp(BO->LHS, DT); 7203 if (!NewBO || NewBO->Opcode != Instruction::Mul) { 7204 MulOps.push_back(getSCEV(BO->LHS)); 7205 break; 7206 } 7207 BO = NewBO; 7208 } while (true); 7209 7210 return getMulExpr(MulOps); 7211 } 7212 case Instruction::UDiv: 7213 return getUDivExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7214 case Instruction::URem: 7215 return getURemExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7216 case Instruction::Sub: { 7217 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 7218 if (BO->Op) 7219 Flags = getNoWrapFlagsFromUB(BO->Op); 7220 return getMinusSCEV(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags); 7221 } 7222 case Instruction::And: 7223 // For an expression like x&255 that merely masks off the high bits, 7224 // use zext(trunc(x)) as the SCEV expression. 7225 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 7226 if (CI->isZero()) 7227 return getSCEV(BO->RHS); 7228 if (CI->isMinusOne()) 7229 return getSCEV(BO->LHS); 7230 const APInt &A = CI->getValue(); 7231 7232 // Instcombine's ShrinkDemandedConstant may strip bits out of 7233 // constants, obscuring what would otherwise be a low-bits mask. 7234 // Use computeKnownBits to compute what ShrinkDemandedConstant 7235 // knew about to reconstruct a low-bits mask value. 7236 unsigned LZ = A.countLeadingZeros(); 7237 unsigned TZ = A.countTrailingZeros(); 7238 unsigned BitWidth = A.getBitWidth(); 7239 KnownBits Known(BitWidth); 7240 computeKnownBits(BO->LHS, Known, getDataLayout(), 7241 0, &AC, nullptr, &DT); 7242 7243 APInt EffectiveMask = 7244 APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ); 7245 if ((LZ != 0 || TZ != 0) && !((~A & ~Known.Zero) & EffectiveMask)) { 7246 const SCEV *MulCount = getConstant(APInt::getOneBitSet(BitWidth, TZ)); 7247 const SCEV *LHS = getSCEV(BO->LHS); 7248 const SCEV *ShiftedLHS = nullptr; 7249 if (auto *LHSMul = dyn_cast<SCEVMulExpr>(LHS)) { 7250 if (auto *OpC = dyn_cast<SCEVConstant>(LHSMul->getOperand(0))) { 7251 // For an expression like (x * 8) & 8, simplify the multiply. 7252 unsigned MulZeros = OpC->getAPInt().countTrailingZeros(); 7253 unsigned GCD = std::min(MulZeros, TZ); 7254 APInt DivAmt = APInt::getOneBitSet(BitWidth, TZ - GCD); 7255 SmallVector<const SCEV*, 4> MulOps; 7256 MulOps.push_back(getConstant(OpC->getAPInt().lshr(GCD))); 7257 MulOps.append(LHSMul->op_begin() + 1, LHSMul->op_end()); 7258 auto *NewMul = getMulExpr(MulOps, LHSMul->getNoWrapFlags()); 7259 ShiftedLHS = getUDivExpr(NewMul, getConstant(DivAmt)); 7260 } 7261 } 7262 if (!ShiftedLHS) 7263 ShiftedLHS = getUDivExpr(LHS, MulCount); 7264 return getMulExpr( 7265 getZeroExtendExpr( 7266 getTruncateExpr(ShiftedLHS, 7267 IntegerType::get(getContext(), BitWidth - LZ - TZ)), 7268 BO->LHS->getType()), 7269 MulCount); 7270 } 7271 } 7272 // Binary `and` is a bit-wise `umin`. 7273 if (BO->LHS->getType()->isIntegerTy(1)) 7274 return getUMinExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7275 break; 7276 7277 case Instruction::Or: 7278 // If the RHS of the Or is a constant, we may have something like: 7279 // X*4+1 which got turned into X*4|1. Handle this as an Add so loop 7280 // optimizations will transparently handle this case. 7281 // 7282 // In order for this transformation to be safe, the LHS must be of the 7283 // form X*(2^n) and the Or constant must be less than 2^n. 7284 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 7285 const SCEV *LHS = getSCEV(BO->LHS); 7286 const APInt &CIVal = CI->getValue(); 7287 if (GetMinTrailingZeros(LHS) >= 7288 (CIVal.getBitWidth() - CIVal.countLeadingZeros())) { 7289 // Build a plain add SCEV. 7290 return getAddExpr(LHS, getSCEV(CI), 7291 (SCEV::NoWrapFlags)(SCEV::FlagNUW | SCEV::FlagNSW)); 7292 } 7293 } 7294 // Binary `or` is a bit-wise `umax`. 7295 if (BO->LHS->getType()->isIntegerTy(1)) 7296 return getUMaxExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7297 break; 7298 7299 case Instruction::Xor: 7300 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 7301 // If the RHS of xor is -1, then this is a not operation. 7302 if (CI->isMinusOne()) 7303 return getNotSCEV(getSCEV(BO->LHS)); 7304 7305 // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask. 7306 // This is a variant of the check for xor with -1, and it handles 7307 // the case where instcombine has trimmed non-demanded bits out 7308 // of an xor with -1. 7309 if (auto *LBO = dyn_cast<BinaryOperator>(BO->LHS)) 7310 if (ConstantInt *LCI = dyn_cast<ConstantInt>(LBO->getOperand(1))) 7311 if (LBO->getOpcode() == Instruction::And && 7312 LCI->getValue() == CI->getValue()) 7313 if (const SCEVZeroExtendExpr *Z = 7314 dyn_cast<SCEVZeroExtendExpr>(getSCEV(BO->LHS))) { 7315 Type *UTy = BO->LHS->getType(); 7316 const SCEV *Z0 = Z->getOperand(); 7317 Type *Z0Ty = Z0->getType(); 7318 unsigned Z0TySize = getTypeSizeInBits(Z0Ty); 7319 7320 // If C is a low-bits mask, the zero extend is serving to 7321 // mask off the high bits. Complement the operand and 7322 // re-apply the zext. 7323 if (CI->getValue().isMask(Z0TySize)) 7324 return getZeroExtendExpr(getNotSCEV(Z0), UTy); 7325 7326 // If C is a single bit, it may be in the sign-bit position 7327 // before the zero-extend. In this case, represent the xor 7328 // using an add, which is equivalent, and re-apply the zext. 7329 APInt Trunc = CI->getValue().trunc(Z0TySize); 7330 if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() && 7331 Trunc.isSignMask()) 7332 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)), 7333 UTy); 7334 } 7335 } 7336 break; 7337 7338 case Instruction::Shl: 7339 // Turn shift left of a constant amount into a multiply. 7340 if (ConstantInt *SA = dyn_cast<ConstantInt>(BO->RHS)) { 7341 uint32_t BitWidth = cast<IntegerType>(SA->getType())->getBitWidth(); 7342 7343 // If the shift count is not less than the bitwidth, the result of 7344 // the shift is undefined. Don't try to analyze it, because the 7345 // resolution chosen here may differ from the resolution chosen in 7346 // other parts of the compiler. 7347 if (SA->getValue().uge(BitWidth)) 7348 break; 7349 7350 // We can safely preserve the nuw flag in all cases. It's also safe to 7351 // turn a nuw nsw shl into a nuw nsw mul. However, nsw in isolation 7352 // requires special handling. It can be preserved as long as we're not 7353 // left shifting by bitwidth - 1. 7354 auto Flags = SCEV::FlagAnyWrap; 7355 if (BO->Op) { 7356 auto MulFlags = getNoWrapFlagsFromUB(BO->Op); 7357 if ((MulFlags & SCEV::FlagNSW) && 7358 ((MulFlags & SCEV::FlagNUW) || SA->getValue().ult(BitWidth - 1))) 7359 Flags = (SCEV::NoWrapFlags)(Flags | SCEV::FlagNSW); 7360 if (MulFlags & SCEV::FlagNUW) 7361 Flags = (SCEV::NoWrapFlags)(Flags | SCEV::FlagNUW); 7362 } 7363 7364 Constant *X = ConstantInt::get( 7365 getContext(), APInt::getOneBitSet(BitWidth, SA->getZExtValue())); 7366 return getMulExpr(getSCEV(BO->LHS), getSCEV(X), Flags); 7367 } 7368 break; 7369 7370 case Instruction::AShr: { 7371 // AShr X, C, where C is a constant. 7372 ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS); 7373 if (!CI) 7374 break; 7375 7376 Type *OuterTy = BO->LHS->getType(); 7377 uint64_t BitWidth = getTypeSizeInBits(OuterTy); 7378 // If the shift count is not less than the bitwidth, the result of 7379 // the shift is undefined. Don't try to analyze it, because the 7380 // resolution chosen here may differ from the resolution chosen in 7381 // other parts of the compiler. 7382 if (CI->getValue().uge(BitWidth)) 7383 break; 7384 7385 if (CI->isZero()) 7386 return getSCEV(BO->LHS); // shift by zero --> noop 7387 7388 uint64_t AShrAmt = CI->getZExtValue(); 7389 Type *TruncTy = IntegerType::get(getContext(), BitWidth - AShrAmt); 7390 7391 Operator *L = dyn_cast<Operator>(BO->LHS); 7392 if (L && L->getOpcode() == Instruction::Shl) { 7393 // X = Shl A, n 7394 // Y = AShr X, m 7395 // Both n and m are constant. 7396 7397 const SCEV *ShlOp0SCEV = getSCEV(L->getOperand(0)); 7398 if (L->getOperand(1) == BO->RHS) 7399 // For a two-shift sext-inreg, i.e. n = m, 7400 // use sext(trunc(x)) as the SCEV expression. 7401 return getSignExtendExpr( 7402 getTruncateExpr(ShlOp0SCEV, TruncTy), OuterTy); 7403 7404 ConstantInt *ShlAmtCI = dyn_cast<ConstantInt>(L->getOperand(1)); 7405 if (ShlAmtCI && ShlAmtCI->getValue().ult(BitWidth)) { 7406 uint64_t ShlAmt = ShlAmtCI->getZExtValue(); 7407 if (ShlAmt > AShrAmt) { 7408 // When n > m, use sext(mul(trunc(x), 2^(n-m)))) as the SCEV 7409 // expression. We already checked that ShlAmt < BitWidth, so 7410 // the multiplier, 1 << (ShlAmt - AShrAmt), fits into TruncTy as 7411 // ShlAmt - AShrAmt < Amt. 7412 APInt Mul = APInt::getOneBitSet(BitWidth - AShrAmt, 7413 ShlAmt - AShrAmt); 7414 return getSignExtendExpr( 7415 getMulExpr(getTruncateExpr(ShlOp0SCEV, TruncTy), 7416 getConstant(Mul)), OuterTy); 7417 } 7418 } 7419 } 7420 break; 7421 } 7422 } 7423 } 7424 7425 switch (U->getOpcode()) { 7426 case Instruction::Trunc: 7427 return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType()); 7428 7429 case Instruction::ZExt: 7430 return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType()); 7431 7432 case Instruction::SExt: 7433 if (auto BO = MatchBinaryOp(U->getOperand(0), DT)) { 7434 // The NSW flag of a subtract does not always survive the conversion to 7435 // A + (-1)*B. By pushing sign extension onto its operands we are much 7436 // more likely to preserve NSW and allow later AddRec optimisations. 7437 // 7438 // NOTE: This is effectively duplicating this logic from getSignExtend: 7439 // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw> 7440 // but by that point the NSW information has potentially been lost. 7441 if (BO->Opcode == Instruction::Sub && BO->IsNSW) { 7442 Type *Ty = U->getType(); 7443 auto *V1 = getSignExtendExpr(getSCEV(BO->LHS), Ty); 7444 auto *V2 = getSignExtendExpr(getSCEV(BO->RHS), Ty); 7445 return getMinusSCEV(V1, V2, SCEV::FlagNSW); 7446 } 7447 } 7448 return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType()); 7449 7450 case Instruction::BitCast: 7451 // BitCasts are no-op casts so we just eliminate the cast. 7452 if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType())) 7453 return getSCEV(U->getOperand(0)); 7454 break; 7455 7456 case Instruction::PtrToInt: { 7457 // Pointer to integer cast is straight-forward, so do model it. 7458 const SCEV *Op = getSCEV(U->getOperand(0)); 7459 Type *DstIntTy = U->getType(); 7460 // But only if effective SCEV (integer) type is wide enough to represent 7461 // all possible pointer values. 7462 const SCEV *IntOp = getPtrToIntExpr(Op, DstIntTy); 7463 if (isa<SCEVCouldNotCompute>(IntOp)) 7464 return getUnknown(V); 7465 return IntOp; 7466 } 7467 case Instruction::IntToPtr: 7468 // Just don't deal with inttoptr casts. 7469 return getUnknown(V); 7470 7471 case Instruction::SDiv: 7472 // If both operands are non-negative, this is just an udiv. 7473 if (isKnownNonNegative(getSCEV(U->getOperand(0))) && 7474 isKnownNonNegative(getSCEV(U->getOperand(1)))) 7475 return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1))); 7476 break; 7477 7478 case Instruction::SRem: 7479 // If both operands are non-negative, this is just an urem. 7480 if (isKnownNonNegative(getSCEV(U->getOperand(0))) && 7481 isKnownNonNegative(getSCEV(U->getOperand(1)))) 7482 return getURemExpr(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1))); 7483 break; 7484 7485 case Instruction::GetElementPtr: 7486 return createNodeForGEP(cast<GEPOperator>(U)); 7487 7488 case Instruction::PHI: 7489 return createNodeForPHI(cast<PHINode>(U)); 7490 7491 case Instruction::Select: 7492 return createNodeForSelectOrPHI(U, U->getOperand(0), U->getOperand(1), 7493 U->getOperand(2)); 7494 7495 case Instruction::Call: 7496 case Instruction::Invoke: 7497 if (Value *RV = cast<CallBase>(U)->getReturnedArgOperand()) 7498 return getSCEV(RV); 7499 7500 if (auto *II = dyn_cast<IntrinsicInst>(U)) { 7501 switch (II->getIntrinsicID()) { 7502 case Intrinsic::abs: 7503 return getAbsExpr( 7504 getSCEV(II->getArgOperand(0)), 7505 /*IsNSW=*/cast<ConstantInt>(II->getArgOperand(1))->isOne()); 7506 case Intrinsic::umax: 7507 return getUMaxExpr(getSCEV(II->getArgOperand(0)), 7508 getSCEV(II->getArgOperand(1))); 7509 case Intrinsic::umin: 7510 return getUMinExpr(getSCEV(II->getArgOperand(0)), 7511 getSCEV(II->getArgOperand(1))); 7512 case Intrinsic::smax: 7513 return getSMaxExpr(getSCEV(II->getArgOperand(0)), 7514 getSCEV(II->getArgOperand(1))); 7515 case Intrinsic::smin: 7516 return getSMinExpr(getSCEV(II->getArgOperand(0)), 7517 getSCEV(II->getArgOperand(1))); 7518 case Intrinsic::usub_sat: { 7519 const SCEV *X = getSCEV(II->getArgOperand(0)); 7520 const SCEV *Y = getSCEV(II->getArgOperand(1)); 7521 const SCEV *ClampedY = getUMinExpr(X, Y); 7522 return getMinusSCEV(X, ClampedY, SCEV::FlagNUW); 7523 } 7524 case Intrinsic::uadd_sat: { 7525 const SCEV *X = getSCEV(II->getArgOperand(0)); 7526 const SCEV *Y = getSCEV(II->getArgOperand(1)); 7527 const SCEV *ClampedX = getUMinExpr(X, getNotSCEV(Y)); 7528 return getAddExpr(ClampedX, Y, SCEV::FlagNUW); 7529 } 7530 case Intrinsic::start_loop_iterations: 7531 // A start_loop_iterations is just equivalent to the first operand for 7532 // SCEV purposes. 7533 return getSCEV(II->getArgOperand(0)); 7534 default: 7535 break; 7536 } 7537 } 7538 break; 7539 } 7540 7541 return getUnknown(V); 7542 } 7543 7544 //===----------------------------------------------------------------------===// 7545 // Iteration Count Computation Code 7546 // 7547 7548 const SCEV *ScalarEvolution::getTripCountFromExitCount(const SCEV *ExitCount, 7549 bool Extend) { 7550 if (isa<SCEVCouldNotCompute>(ExitCount)) 7551 return getCouldNotCompute(); 7552 7553 auto *ExitCountType = ExitCount->getType(); 7554 assert(ExitCountType->isIntegerTy()); 7555 7556 if (!Extend) 7557 return getAddExpr(ExitCount, getOne(ExitCountType)); 7558 7559 auto *WiderType = Type::getIntNTy(ExitCountType->getContext(), 7560 1 + ExitCountType->getScalarSizeInBits()); 7561 return getAddExpr(getNoopOrZeroExtend(ExitCount, WiderType), 7562 getOne(WiderType)); 7563 } 7564 7565 static unsigned getConstantTripCount(const SCEVConstant *ExitCount) { 7566 if (!ExitCount) 7567 return 0; 7568 7569 ConstantInt *ExitConst = ExitCount->getValue(); 7570 7571 // Guard against huge trip counts. 7572 if (ExitConst->getValue().getActiveBits() > 32) 7573 return 0; 7574 7575 // In case of integer overflow, this returns 0, which is correct. 7576 return ((unsigned)ExitConst->getZExtValue()) + 1; 7577 } 7578 7579 unsigned ScalarEvolution::getSmallConstantTripCount(const Loop *L) { 7580 auto *ExitCount = dyn_cast<SCEVConstant>(getBackedgeTakenCount(L, Exact)); 7581 return getConstantTripCount(ExitCount); 7582 } 7583 7584 unsigned 7585 ScalarEvolution::getSmallConstantTripCount(const Loop *L, 7586 const BasicBlock *ExitingBlock) { 7587 assert(ExitingBlock && "Must pass a non-null exiting block!"); 7588 assert(L->isLoopExiting(ExitingBlock) && 7589 "Exiting block must actually branch out of the loop!"); 7590 const SCEVConstant *ExitCount = 7591 dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock)); 7592 return getConstantTripCount(ExitCount); 7593 } 7594 7595 unsigned ScalarEvolution::getSmallConstantMaxTripCount(const Loop *L) { 7596 const auto *MaxExitCount = 7597 dyn_cast<SCEVConstant>(getConstantMaxBackedgeTakenCount(L)); 7598 return getConstantTripCount(MaxExitCount); 7599 } 7600 7601 const SCEV *ScalarEvolution::getConstantMaxTripCountFromArray(const Loop *L) { 7602 // We can't infer from Array in Irregular Loop. 7603 // FIXME: It's hard to infer loop bound from array operated in Nested Loop. 7604 if (!L->isLoopSimplifyForm() || !L->isInnermost()) 7605 return getCouldNotCompute(); 7606 7607 // FIXME: To make the scene more typical, we only analysis loops that have 7608 // one exiting block and that block must be the latch. To make it easier to 7609 // capture loops that have memory access and memory access will be executed 7610 // in each iteration. 7611 const BasicBlock *LoopLatch = L->getLoopLatch(); 7612 assert(LoopLatch && "See defination of simplify form loop."); 7613 if (L->getExitingBlock() != LoopLatch) 7614 return getCouldNotCompute(); 7615 7616 const DataLayout &DL = getDataLayout(); 7617 SmallVector<const SCEV *> InferCountColl; 7618 for (auto *BB : L->getBlocks()) { 7619 // Go here, we can know that Loop is a single exiting and simplified form 7620 // loop. Make sure that infer from Memory Operation in those BBs must be 7621 // executed in loop. First step, we can make sure that max execution time 7622 // of MemAccessBB in loop represents latch max excution time. 7623 // If MemAccessBB does not dom Latch, skip. 7624 // Entry 7625 // │ 7626 // ┌─────▼─────┐ 7627 // │Loop Header◄─────┐ 7628 // └──┬──────┬─┘ │ 7629 // │ │ │ 7630 // ┌────────▼──┐ ┌─▼─────┐ │ 7631 // │MemAccessBB│ │OtherBB│ │ 7632 // └────────┬──┘ └─┬─────┘ │ 7633 // │ │ │ 7634 // ┌─▼──────▼─┐ │ 7635 // │Loop Latch├─────┘ 7636 // └────┬─────┘ 7637 // ▼ 7638 // Exit 7639 if (!DT.dominates(BB, LoopLatch)) 7640 continue; 7641 7642 for (Instruction &Inst : *BB) { 7643 // Find Memory Operation Instruction. 7644 auto *GEP = getLoadStorePointerOperand(&Inst); 7645 if (!GEP) 7646 continue; 7647 7648 auto *ElemSize = dyn_cast<SCEVConstant>(getElementSize(&Inst)); 7649 // Do not infer from scalar type, eg."ElemSize = sizeof()". 7650 if (!ElemSize) 7651 continue; 7652 7653 // Use a existing polynomial recurrence on the trip count. 7654 auto *AddRec = dyn_cast<SCEVAddRecExpr>(getSCEV(GEP)); 7655 if (!AddRec) 7656 continue; 7657 auto *ArrBase = dyn_cast<SCEVUnknown>(getPointerBase(AddRec)); 7658 auto *Step = dyn_cast<SCEVConstant>(AddRec->getStepRecurrence(*this)); 7659 if (!ArrBase || !Step) 7660 continue; 7661 assert(isLoopInvariant(ArrBase, L) && "See addrec definition"); 7662 7663 // Only handle { %array + step }, 7664 // FIXME: {(SCEVAddRecExpr) + step } could not be analysed here. 7665 if (AddRec->getStart() != ArrBase) 7666 continue; 7667 7668 // Memory operation pattern which have gaps. 7669 // Or repeat memory opreation. 7670 // And index of GEP wraps arround. 7671 if (Step->getAPInt().getActiveBits() > 32 || 7672 Step->getAPInt().getZExtValue() != 7673 ElemSize->getAPInt().getZExtValue() || 7674 Step->isZero() || Step->getAPInt().isNegative()) 7675 continue; 7676 7677 // Only infer from stack array which has certain size. 7678 // Make sure alloca instruction is not excuted in loop. 7679 AllocaInst *AllocateInst = dyn_cast<AllocaInst>(ArrBase->getValue()); 7680 if (!AllocateInst || L->contains(AllocateInst->getParent())) 7681 continue; 7682 7683 // Make sure only handle normal array. 7684 auto *Ty = dyn_cast<ArrayType>(AllocateInst->getAllocatedType()); 7685 auto *ArrSize = dyn_cast<ConstantInt>(AllocateInst->getArraySize()); 7686 if (!Ty || !ArrSize || !ArrSize->isOne()) 7687 continue; 7688 7689 // FIXME: Since gep indices are silently zext to the indexing type, 7690 // we will have a narrow gep index which wraps around rather than 7691 // increasing strictly, we shoule ensure that step is increasing 7692 // strictly by the loop iteration. 7693 // Now we can infer a max execution time by MemLength/StepLength. 7694 const SCEV *MemSize = 7695 getConstant(Step->getType(), DL.getTypeAllocSize(Ty)); 7696 auto *MaxExeCount = 7697 dyn_cast<SCEVConstant>(getUDivCeilSCEV(MemSize, Step)); 7698 if (!MaxExeCount || MaxExeCount->getAPInt().getActiveBits() > 32) 7699 continue; 7700 7701 // If the loop reaches the maximum number of executions, we can not 7702 // access bytes starting outside the statically allocated size without 7703 // being immediate UB. But it is allowed to enter loop header one more 7704 // time. 7705 auto *InferCount = dyn_cast<SCEVConstant>( 7706 getAddExpr(MaxExeCount, getOne(MaxExeCount->getType()))); 7707 // Discard the maximum number of execution times under 32bits. 7708 if (!InferCount || InferCount->getAPInt().getActiveBits() > 32) 7709 continue; 7710 7711 InferCountColl.push_back(InferCount); 7712 } 7713 } 7714 7715 if (InferCountColl.size() == 0) 7716 return getCouldNotCompute(); 7717 7718 return getUMinFromMismatchedTypes(InferCountColl); 7719 } 7720 7721 unsigned ScalarEvolution::getSmallConstantTripMultiple(const Loop *L) { 7722 SmallVector<BasicBlock *, 8> ExitingBlocks; 7723 L->getExitingBlocks(ExitingBlocks); 7724 7725 Optional<unsigned> Res = None; 7726 for (auto *ExitingBB : ExitingBlocks) { 7727 unsigned Multiple = getSmallConstantTripMultiple(L, ExitingBB); 7728 if (!Res) 7729 Res = Multiple; 7730 Res = (unsigned)GreatestCommonDivisor64(*Res, Multiple); 7731 } 7732 return Res.getValueOr(1); 7733 } 7734 7735 unsigned ScalarEvolution::getSmallConstantTripMultiple(const Loop *L, 7736 const SCEV *ExitCount) { 7737 if (ExitCount == getCouldNotCompute()) 7738 return 1; 7739 7740 // Get the trip count 7741 const SCEV *TCExpr = getTripCountFromExitCount(ExitCount); 7742 7743 const SCEVConstant *TC = dyn_cast<SCEVConstant>(TCExpr); 7744 if (!TC) 7745 // Attempt to factor more general cases. Returns the greatest power of 7746 // two divisor. If overflow happens, the trip count expression is still 7747 // divisible by the greatest power of 2 divisor returned. 7748 return 1U << std::min((uint32_t)31, 7749 GetMinTrailingZeros(applyLoopGuards(TCExpr, L))); 7750 7751 ConstantInt *Result = TC->getValue(); 7752 7753 // Guard against huge trip counts (this requires checking 7754 // for zero to handle the case where the trip count == -1 and the 7755 // addition wraps). 7756 if (!Result || Result->getValue().getActiveBits() > 32 || 7757 Result->getValue().getActiveBits() == 0) 7758 return 1; 7759 7760 return (unsigned)Result->getZExtValue(); 7761 } 7762 7763 /// Returns the largest constant divisor of the trip count of this loop as a 7764 /// normal unsigned value, if possible. This means that the actual trip count is 7765 /// always a multiple of the returned value (don't forget the trip count could 7766 /// very well be zero as well!). 7767 /// 7768 /// Returns 1 if the trip count is unknown or not guaranteed to be the 7769 /// multiple of a constant (which is also the case if the trip count is simply 7770 /// constant, use getSmallConstantTripCount for that case), Will also return 1 7771 /// if the trip count is very large (>= 2^32). 7772 /// 7773 /// As explained in the comments for getSmallConstantTripCount, this assumes 7774 /// that control exits the loop via ExitingBlock. 7775 unsigned 7776 ScalarEvolution::getSmallConstantTripMultiple(const Loop *L, 7777 const BasicBlock *ExitingBlock) { 7778 assert(ExitingBlock && "Must pass a non-null exiting block!"); 7779 assert(L->isLoopExiting(ExitingBlock) && 7780 "Exiting block must actually branch out of the loop!"); 7781 const SCEV *ExitCount = getExitCount(L, ExitingBlock); 7782 return getSmallConstantTripMultiple(L, ExitCount); 7783 } 7784 7785 const SCEV *ScalarEvolution::getExitCount(const Loop *L, 7786 const BasicBlock *ExitingBlock, 7787 ExitCountKind Kind) { 7788 switch (Kind) { 7789 case Exact: 7790 case SymbolicMaximum: 7791 return getBackedgeTakenInfo(L).getExact(ExitingBlock, this); 7792 case ConstantMaximum: 7793 return getBackedgeTakenInfo(L).getConstantMax(ExitingBlock, this); 7794 }; 7795 llvm_unreachable("Invalid ExitCountKind!"); 7796 } 7797 7798 const SCEV * 7799 ScalarEvolution::getPredicatedBackedgeTakenCount(const Loop *L, 7800 SmallVector<const SCEVPredicate *, 4> &Preds) { 7801 return getPredicatedBackedgeTakenInfo(L).getExact(L, this, &Preds); 7802 } 7803 7804 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L, 7805 ExitCountKind Kind) { 7806 switch (Kind) { 7807 case Exact: 7808 return getBackedgeTakenInfo(L).getExact(L, this); 7809 case ConstantMaximum: 7810 return getBackedgeTakenInfo(L).getConstantMax(this); 7811 case SymbolicMaximum: 7812 return getBackedgeTakenInfo(L).getSymbolicMax(L, this); 7813 }; 7814 llvm_unreachable("Invalid ExitCountKind!"); 7815 } 7816 7817 bool ScalarEvolution::isBackedgeTakenCountMaxOrZero(const Loop *L) { 7818 return getBackedgeTakenInfo(L).isConstantMaxOrZero(this); 7819 } 7820 7821 /// Push PHI nodes in the header of the given loop onto the given Worklist. 7822 static void PushLoopPHIs(const Loop *L, 7823 SmallVectorImpl<Instruction *> &Worklist, 7824 SmallPtrSetImpl<Instruction *> &Visited) { 7825 BasicBlock *Header = L->getHeader(); 7826 7827 // Push all Loop-header PHIs onto the Worklist stack. 7828 for (PHINode &PN : Header->phis()) 7829 if (Visited.insert(&PN).second) 7830 Worklist.push_back(&PN); 7831 } 7832 7833 const ScalarEvolution::BackedgeTakenInfo & 7834 ScalarEvolution::getPredicatedBackedgeTakenInfo(const Loop *L) { 7835 auto &BTI = getBackedgeTakenInfo(L); 7836 if (BTI.hasFullInfo()) 7837 return BTI; 7838 7839 auto Pair = PredicatedBackedgeTakenCounts.insert({L, BackedgeTakenInfo()}); 7840 7841 if (!Pair.second) 7842 return Pair.first->second; 7843 7844 BackedgeTakenInfo Result = 7845 computeBackedgeTakenCount(L, /*AllowPredicates=*/true); 7846 7847 return PredicatedBackedgeTakenCounts.find(L)->second = std::move(Result); 7848 } 7849 7850 ScalarEvolution::BackedgeTakenInfo & 7851 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) { 7852 // Initially insert an invalid entry for this loop. If the insertion 7853 // succeeds, proceed to actually compute a backedge-taken count and 7854 // update the value. The temporary CouldNotCompute value tells SCEV 7855 // code elsewhere that it shouldn't attempt to request a new 7856 // backedge-taken count, which could result in infinite recursion. 7857 std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair = 7858 BackedgeTakenCounts.insert({L, BackedgeTakenInfo()}); 7859 if (!Pair.second) 7860 return Pair.first->second; 7861 7862 // computeBackedgeTakenCount may allocate memory for its result. Inserting it 7863 // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result 7864 // must be cleared in this scope. 7865 BackedgeTakenInfo Result = computeBackedgeTakenCount(L); 7866 7867 // In product build, there are no usage of statistic. 7868 (void)NumTripCountsComputed; 7869 (void)NumTripCountsNotComputed; 7870 #if LLVM_ENABLE_STATS || !defined(NDEBUG) 7871 const SCEV *BEExact = Result.getExact(L, this); 7872 if (BEExact != getCouldNotCompute()) { 7873 assert(isLoopInvariant(BEExact, L) && 7874 isLoopInvariant(Result.getConstantMax(this), L) && 7875 "Computed backedge-taken count isn't loop invariant for loop!"); 7876 ++NumTripCountsComputed; 7877 } else if (Result.getConstantMax(this) == getCouldNotCompute() && 7878 isa<PHINode>(L->getHeader()->begin())) { 7879 // Only count loops that have phi nodes as not being computable. 7880 ++NumTripCountsNotComputed; 7881 } 7882 #endif // LLVM_ENABLE_STATS || !defined(NDEBUG) 7883 7884 // Now that we know more about the trip count for this loop, forget any 7885 // existing SCEV values for PHI nodes in this loop since they are only 7886 // conservative estimates made without the benefit of trip count 7887 // information. This invalidation is not necessary for correctness, and is 7888 // only done to produce more precise results. 7889 if (Result.hasAnyInfo()) { 7890 // Invalidate any expression using an addrec in this loop. 7891 SmallVector<const SCEV *, 8> ToForget; 7892 auto LoopUsersIt = LoopUsers.find(L); 7893 if (LoopUsersIt != LoopUsers.end()) 7894 append_range(ToForget, LoopUsersIt->second); 7895 forgetMemoizedResults(ToForget); 7896 7897 // Invalidate constant-evolved loop header phis. 7898 for (PHINode &PN : L->getHeader()->phis()) 7899 ConstantEvolutionLoopExitValue.erase(&PN); 7900 } 7901 7902 // Re-lookup the insert position, since the call to 7903 // computeBackedgeTakenCount above could result in a 7904 // recusive call to getBackedgeTakenInfo (on a different 7905 // loop), which would invalidate the iterator computed 7906 // earlier. 7907 return BackedgeTakenCounts.find(L)->second = std::move(Result); 7908 } 7909 7910 void ScalarEvolution::forgetAllLoops() { 7911 // This method is intended to forget all info about loops. It should 7912 // invalidate caches as if the following happened: 7913 // - The trip counts of all loops have changed arbitrarily 7914 // - Every llvm::Value has been updated in place to produce a different 7915 // result. 7916 BackedgeTakenCounts.clear(); 7917 PredicatedBackedgeTakenCounts.clear(); 7918 BECountUsers.clear(); 7919 LoopPropertiesCache.clear(); 7920 ConstantEvolutionLoopExitValue.clear(); 7921 ValueExprMap.clear(); 7922 ValuesAtScopes.clear(); 7923 ValuesAtScopesUsers.clear(); 7924 LoopDispositions.clear(); 7925 BlockDispositions.clear(); 7926 UnsignedRanges.clear(); 7927 SignedRanges.clear(); 7928 ExprValueMap.clear(); 7929 HasRecMap.clear(); 7930 MinTrailingZerosCache.clear(); 7931 PredicatedSCEVRewrites.clear(); 7932 } 7933 7934 void ScalarEvolution::forgetLoop(const Loop *L) { 7935 SmallVector<const Loop *, 16> LoopWorklist(1, L); 7936 SmallVector<Instruction *, 32> Worklist; 7937 SmallPtrSet<Instruction *, 16> Visited; 7938 SmallVector<const SCEV *, 16> ToForget; 7939 7940 // Iterate over all the loops and sub-loops to drop SCEV information. 7941 while (!LoopWorklist.empty()) { 7942 auto *CurrL = LoopWorklist.pop_back_val(); 7943 7944 // Drop any stored trip count value. 7945 forgetBackedgeTakenCounts(CurrL, /* Predicated */ false); 7946 forgetBackedgeTakenCounts(CurrL, /* Predicated */ true); 7947 7948 // Drop information about predicated SCEV rewrites for this loop. 7949 for (auto I = PredicatedSCEVRewrites.begin(); 7950 I != PredicatedSCEVRewrites.end();) { 7951 std::pair<const SCEV *, const Loop *> Entry = I->first; 7952 if (Entry.second == CurrL) 7953 PredicatedSCEVRewrites.erase(I++); 7954 else 7955 ++I; 7956 } 7957 7958 auto LoopUsersItr = LoopUsers.find(CurrL); 7959 if (LoopUsersItr != LoopUsers.end()) { 7960 ToForget.insert(ToForget.end(), LoopUsersItr->second.begin(), 7961 LoopUsersItr->second.end()); 7962 LoopUsers.erase(LoopUsersItr); 7963 } 7964 7965 // Drop information about expressions based on loop-header PHIs. 7966 PushLoopPHIs(CurrL, Worklist, Visited); 7967 7968 while (!Worklist.empty()) { 7969 Instruction *I = Worklist.pop_back_val(); 7970 7971 ValueExprMapType::iterator It = 7972 ValueExprMap.find_as(static_cast<Value *>(I)); 7973 if (It != ValueExprMap.end()) { 7974 eraseValueFromMap(It->first); 7975 ToForget.push_back(It->second); 7976 if (PHINode *PN = dyn_cast<PHINode>(I)) 7977 ConstantEvolutionLoopExitValue.erase(PN); 7978 } 7979 7980 PushDefUseChildren(I, Worklist, Visited); 7981 } 7982 7983 LoopPropertiesCache.erase(CurrL); 7984 // Forget all contained loops too, to avoid dangling entries in the 7985 // ValuesAtScopes map. 7986 LoopWorklist.append(CurrL->begin(), CurrL->end()); 7987 } 7988 forgetMemoizedResults(ToForget); 7989 } 7990 7991 void ScalarEvolution::forgetTopmostLoop(const Loop *L) { 7992 while (Loop *Parent = L->getParentLoop()) 7993 L = Parent; 7994 forgetLoop(L); 7995 } 7996 7997 void ScalarEvolution::forgetValue(Value *V) { 7998 Instruction *I = dyn_cast<Instruction>(V); 7999 if (!I) return; 8000 8001 // Drop information about expressions based on loop-header PHIs. 8002 SmallVector<Instruction *, 16> Worklist; 8003 SmallPtrSet<Instruction *, 8> Visited; 8004 SmallVector<const SCEV *, 8> ToForget; 8005 Worklist.push_back(I); 8006 Visited.insert(I); 8007 8008 while (!Worklist.empty()) { 8009 I = Worklist.pop_back_val(); 8010 ValueExprMapType::iterator It = 8011 ValueExprMap.find_as(static_cast<Value *>(I)); 8012 if (It != ValueExprMap.end()) { 8013 eraseValueFromMap(It->first); 8014 ToForget.push_back(It->second); 8015 if (PHINode *PN = dyn_cast<PHINode>(I)) 8016 ConstantEvolutionLoopExitValue.erase(PN); 8017 } 8018 8019 PushDefUseChildren(I, Worklist, Visited); 8020 } 8021 forgetMemoizedResults(ToForget); 8022 } 8023 8024 void ScalarEvolution::forgetLoopDispositions(const Loop *L) { 8025 LoopDispositions.clear(); 8026 } 8027 8028 /// Get the exact loop backedge taken count considering all loop exits. A 8029 /// computable result can only be returned for loops with all exiting blocks 8030 /// dominating the latch. howFarToZero assumes that the limit of each loop test 8031 /// is never skipped. This is a valid assumption as long as the loop exits via 8032 /// that test. For precise results, it is the caller's responsibility to specify 8033 /// the relevant loop exiting block using getExact(ExitingBlock, SE). 8034 const SCEV * 8035 ScalarEvolution::BackedgeTakenInfo::getExact(const Loop *L, ScalarEvolution *SE, 8036 SmallVector<const SCEVPredicate *, 4> *Preds) const { 8037 // If any exits were not computable, the loop is not computable. 8038 if (!isComplete() || ExitNotTaken.empty()) 8039 return SE->getCouldNotCompute(); 8040 8041 const BasicBlock *Latch = L->getLoopLatch(); 8042 // All exiting blocks we have collected must dominate the only backedge. 8043 if (!Latch) 8044 return SE->getCouldNotCompute(); 8045 8046 // All exiting blocks we have gathered dominate loop's latch, so exact trip 8047 // count is simply a minimum out of all these calculated exit counts. 8048 SmallVector<const SCEV *, 2> Ops; 8049 for (auto &ENT : ExitNotTaken) { 8050 const SCEV *BECount = ENT.ExactNotTaken; 8051 assert(BECount != SE->getCouldNotCompute() && "Bad exit SCEV!"); 8052 assert(SE->DT.dominates(ENT.ExitingBlock, Latch) && 8053 "We should only have known counts for exiting blocks that dominate " 8054 "latch!"); 8055 8056 Ops.push_back(BECount); 8057 8058 if (Preds) 8059 for (auto *P : ENT.Predicates) 8060 Preds->push_back(P); 8061 8062 assert((Preds || ENT.hasAlwaysTruePredicate()) && 8063 "Predicate should be always true!"); 8064 } 8065 8066 return SE->getUMinFromMismatchedTypes(Ops); 8067 } 8068 8069 /// Get the exact not taken count for this loop exit. 8070 const SCEV * 8071 ScalarEvolution::BackedgeTakenInfo::getExact(const BasicBlock *ExitingBlock, 8072 ScalarEvolution *SE) const { 8073 for (auto &ENT : ExitNotTaken) 8074 if (ENT.ExitingBlock == ExitingBlock && ENT.hasAlwaysTruePredicate()) 8075 return ENT.ExactNotTaken; 8076 8077 return SE->getCouldNotCompute(); 8078 } 8079 8080 const SCEV *ScalarEvolution::BackedgeTakenInfo::getConstantMax( 8081 const BasicBlock *ExitingBlock, ScalarEvolution *SE) const { 8082 for (auto &ENT : ExitNotTaken) 8083 if (ENT.ExitingBlock == ExitingBlock && ENT.hasAlwaysTruePredicate()) 8084 return ENT.MaxNotTaken; 8085 8086 return SE->getCouldNotCompute(); 8087 } 8088 8089 /// getConstantMax - Get the constant max backedge taken count for the loop. 8090 const SCEV * 8091 ScalarEvolution::BackedgeTakenInfo::getConstantMax(ScalarEvolution *SE) const { 8092 auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) { 8093 return !ENT.hasAlwaysTruePredicate(); 8094 }; 8095 8096 if (!getConstantMax() || any_of(ExitNotTaken, PredicateNotAlwaysTrue)) 8097 return SE->getCouldNotCompute(); 8098 8099 assert((isa<SCEVCouldNotCompute>(getConstantMax()) || 8100 isa<SCEVConstant>(getConstantMax())) && 8101 "No point in having a non-constant max backedge taken count!"); 8102 return getConstantMax(); 8103 } 8104 8105 const SCEV * 8106 ScalarEvolution::BackedgeTakenInfo::getSymbolicMax(const Loop *L, 8107 ScalarEvolution *SE) { 8108 if (!SymbolicMax) 8109 SymbolicMax = SE->computeSymbolicMaxBackedgeTakenCount(L); 8110 return SymbolicMax; 8111 } 8112 8113 bool ScalarEvolution::BackedgeTakenInfo::isConstantMaxOrZero( 8114 ScalarEvolution *SE) const { 8115 auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) { 8116 return !ENT.hasAlwaysTruePredicate(); 8117 }; 8118 return MaxOrZero && !any_of(ExitNotTaken, PredicateNotAlwaysTrue); 8119 } 8120 8121 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E) 8122 : ExitLimit(E, E, false, None) { 8123 } 8124 8125 ScalarEvolution::ExitLimit::ExitLimit( 8126 const SCEV *E, const SCEV *M, bool MaxOrZero, 8127 ArrayRef<const SmallPtrSetImpl<const SCEVPredicate *> *> PredSetList) 8128 : ExactNotTaken(E), MaxNotTaken(M), MaxOrZero(MaxOrZero) { 8129 // If we prove the max count is zero, so is the symbolic bound. This happens 8130 // in practice due to differences in a) how context sensitive we've chosen 8131 // to be and b) how we reason about bounds impied by UB. 8132 if (MaxNotTaken->isZero()) 8133 ExactNotTaken = MaxNotTaken; 8134 8135 assert((isa<SCEVCouldNotCompute>(ExactNotTaken) || 8136 !isa<SCEVCouldNotCompute>(MaxNotTaken)) && 8137 "Exact is not allowed to be less precise than Max"); 8138 assert((isa<SCEVCouldNotCompute>(MaxNotTaken) || 8139 isa<SCEVConstant>(MaxNotTaken)) && 8140 "No point in having a non-constant max backedge taken count!"); 8141 for (auto *PredSet : PredSetList) 8142 for (auto *P : *PredSet) 8143 addPredicate(P); 8144 assert((isa<SCEVCouldNotCompute>(E) || !E->getType()->isPointerTy()) && 8145 "Backedge count should be int"); 8146 assert((isa<SCEVCouldNotCompute>(M) || !M->getType()->isPointerTy()) && 8147 "Max backedge count should be int"); 8148 } 8149 8150 ScalarEvolution::ExitLimit::ExitLimit( 8151 const SCEV *E, const SCEV *M, bool MaxOrZero, 8152 const SmallPtrSetImpl<const SCEVPredicate *> &PredSet) 8153 : ExitLimit(E, M, MaxOrZero, {&PredSet}) { 8154 } 8155 8156 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E, const SCEV *M, 8157 bool MaxOrZero) 8158 : ExitLimit(E, M, MaxOrZero, None) { 8159 } 8160 8161 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each 8162 /// computable exit into a persistent ExitNotTakenInfo array. 8163 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo( 8164 ArrayRef<ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo> ExitCounts, 8165 bool IsComplete, const SCEV *ConstantMax, bool MaxOrZero) 8166 : ConstantMax(ConstantMax), IsComplete(IsComplete), MaxOrZero(MaxOrZero) { 8167 using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo; 8168 8169 ExitNotTaken.reserve(ExitCounts.size()); 8170 std::transform( 8171 ExitCounts.begin(), ExitCounts.end(), std::back_inserter(ExitNotTaken), 8172 [&](const EdgeExitInfo &EEI) { 8173 BasicBlock *ExitBB = EEI.first; 8174 const ExitLimit &EL = EEI.second; 8175 return ExitNotTakenInfo(ExitBB, EL.ExactNotTaken, EL.MaxNotTaken, 8176 EL.Predicates); 8177 }); 8178 assert((isa<SCEVCouldNotCompute>(ConstantMax) || 8179 isa<SCEVConstant>(ConstantMax)) && 8180 "No point in having a non-constant max backedge taken count!"); 8181 } 8182 8183 /// Compute the number of times the backedge of the specified loop will execute. 8184 ScalarEvolution::BackedgeTakenInfo 8185 ScalarEvolution::computeBackedgeTakenCount(const Loop *L, 8186 bool AllowPredicates) { 8187 SmallVector<BasicBlock *, 8> ExitingBlocks; 8188 L->getExitingBlocks(ExitingBlocks); 8189 8190 using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo; 8191 8192 SmallVector<EdgeExitInfo, 4> ExitCounts; 8193 bool CouldComputeBECount = true; 8194 BasicBlock *Latch = L->getLoopLatch(); // may be NULL. 8195 const SCEV *MustExitMaxBECount = nullptr; 8196 const SCEV *MayExitMaxBECount = nullptr; 8197 bool MustExitMaxOrZero = false; 8198 8199 // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts 8200 // and compute maxBECount. 8201 // Do a union of all the predicates here. 8202 for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) { 8203 BasicBlock *ExitBB = ExitingBlocks[i]; 8204 8205 // We canonicalize untaken exits to br (constant), ignore them so that 8206 // proving an exit untaken doesn't negatively impact our ability to reason 8207 // about the loop as whole. 8208 if (auto *BI = dyn_cast<BranchInst>(ExitBB->getTerminator())) 8209 if (auto *CI = dyn_cast<ConstantInt>(BI->getCondition())) { 8210 bool ExitIfTrue = !L->contains(BI->getSuccessor(0)); 8211 if (ExitIfTrue == CI->isZero()) 8212 continue; 8213 } 8214 8215 ExitLimit EL = computeExitLimit(L, ExitBB, AllowPredicates); 8216 8217 assert((AllowPredicates || EL.Predicates.empty()) && 8218 "Predicated exit limit when predicates are not allowed!"); 8219 8220 // 1. For each exit that can be computed, add an entry to ExitCounts. 8221 // CouldComputeBECount is true only if all exits can be computed. 8222 if (EL.ExactNotTaken == getCouldNotCompute()) 8223 // We couldn't compute an exact value for this exit, so 8224 // we won't be able to compute an exact value for the loop. 8225 CouldComputeBECount = false; 8226 else 8227 ExitCounts.emplace_back(ExitBB, EL); 8228 8229 // 2. Derive the loop's MaxBECount from each exit's max number of 8230 // non-exiting iterations. Partition the loop exits into two kinds: 8231 // LoopMustExits and LoopMayExits. 8232 // 8233 // If the exit dominates the loop latch, it is a LoopMustExit otherwise it 8234 // is a LoopMayExit. If any computable LoopMustExit is found, then 8235 // MaxBECount is the minimum EL.MaxNotTaken of computable 8236 // LoopMustExits. Otherwise, MaxBECount is conservatively the maximum 8237 // EL.MaxNotTaken, where CouldNotCompute is considered greater than any 8238 // computable EL.MaxNotTaken. 8239 if (EL.MaxNotTaken != getCouldNotCompute() && Latch && 8240 DT.dominates(ExitBB, Latch)) { 8241 if (!MustExitMaxBECount) { 8242 MustExitMaxBECount = EL.MaxNotTaken; 8243 MustExitMaxOrZero = EL.MaxOrZero; 8244 } else { 8245 MustExitMaxBECount = 8246 getUMinFromMismatchedTypes(MustExitMaxBECount, EL.MaxNotTaken); 8247 } 8248 } else if (MayExitMaxBECount != getCouldNotCompute()) { 8249 if (!MayExitMaxBECount || EL.MaxNotTaken == getCouldNotCompute()) 8250 MayExitMaxBECount = EL.MaxNotTaken; 8251 else { 8252 MayExitMaxBECount = 8253 getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.MaxNotTaken); 8254 } 8255 } 8256 } 8257 const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount : 8258 (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute()); 8259 // The loop backedge will be taken the maximum or zero times if there's 8260 // a single exit that must be taken the maximum or zero times. 8261 bool MaxOrZero = (MustExitMaxOrZero && ExitingBlocks.size() == 1); 8262 8263 // Remember which SCEVs are used in exit limits for invalidation purposes. 8264 // We only care about non-constant SCEVs here, so we can ignore EL.MaxNotTaken 8265 // and MaxBECount, which must be SCEVConstant. 8266 for (const auto &Pair : ExitCounts) 8267 if (!isa<SCEVConstant>(Pair.second.ExactNotTaken)) 8268 BECountUsers[Pair.second.ExactNotTaken].insert({L, AllowPredicates}); 8269 return BackedgeTakenInfo(std::move(ExitCounts), CouldComputeBECount, 8270 MaxBECount, MaxOrZero); 8271 } 8272 8273 ScalarEvolution::ExitLimit 8274 ScalarEvolution::computeExitLimit(const Loop *L, BasicBlock *ExitingBlock, 8275 bool AllowPredicates) { 8276 assert(L->contains(ExitingBlock) && "Exit count for non-loop block?"); 8277 // If our exiting block does not dominate the latch, then its connection with 8278 // loop's exit limit may be far from trivial. 8279 const BasicBlock *Latch = L->getLoopLatch(); 8280 if (!Latch || !DT.dominates(ExitingBlock, Latch)) 8281 return getCouldNotCompute(); 8282 8283 bool IsOnlyExit = (L->getExitingBlock() != nullptr); 8284 Instruction *Term = ExitingBlock->getTerminator(); 8285 if (BranchInst *BI = dyn_cast<BranchInst>(Term)) { 8286 assert(BI->isConditional() && "If unconditional, it can't be in loop!"); 8287 bool ExitIfTrue = !L->contains(BI->getSuccessor(0)); 8288 assert(ExitIfTrue == L->contains(BI->getSuccessor(1)) && 8289 "It should have one successor in loop and one exit block!"); 8290 // Proceed to the next level to examine the exit condition expression. 8291 return computeExitLimitFromCond( 8292 L, BI->getCondition(), ExitIfTrue, 8293 /*ControlsExit=*/IsOnlyExit, AllowPredicates); 8294 } 8295 8296 if (SwitchInst *SI = dyn_cast<SwitchInst>(Term)) { 8297 // For switch, make sure that there is a single exit from the loop. 8298 BasicBlock *Exit = nullptr; 8299 for (auto *SBB : successors(ExitingBlock)) 8300 if (!L->contains(SBB)) { 8301 if (Exit) // Multiple exit successors. 8302 return getCouldNotCompute(); 8303 Exit = SBB; 8304 } 8305 assert(Exit && "Exiting block must have at least one exit"); 8306 return computeExitLimitFromSingleExitSwitch(L, SI, Exit, 8307 /*ControlsExit=*/IsOnlyExit); 8308 } 8309 8310 return getCouldNotCompute(); 8311 } 8312 8313 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCond( 8314 const Loop *L, Value *ExitCond, bool ExitIfTrue, 8315 bool ControlsExit, bool AllowPredicates) { 8316 ScalarEvolution::ExitLimitCacheTy Cache(L, ExitIfTrue, AllowPredicates); 8317 return computeExitLimitFromCondCached(Cache, L, ExitCond, ExitIfTrue, 8318 ControlsExit, AllowPredicates); 8319 } 8320 8321 Optional<ScalarEvolution::ExitLimit> 8322 ScalarEvolution::ExitLimitCache::find(const Loop *L, Value *ExitCond, 8323 bool ExitIfTrue, bool ControlsExit, 8324 bool AllowPredicates) { 8325 (void)this->L; 8326 (void)this->ExitIfTrue; 8327 (void)this->AllowPredicates; 8328 8329 assert(this->L == L && this->ExitIfTrue == ExitIfTrue && 8330 this->AllowPredicates == AllowPredicates && 8331 "Variance in assumed invariant key components!"); 8332 auto Itr = TripCountMap.find({ExitCond, ControlsExit}); 8333 if (Itr == TripCountMap.end()) 8334 return None; 8335 return Itr->second; 8336 } 8337 8338 void ScalarEvolution::ExitLimitCache::insert(const Loop *L, Value *ExitCond, 8339 bool ExitIfTrue, 8340 bool ControlsExit, 8341 bool AllowPredicates, 8342 const ExitLimit &EL) { 8343 assert(this->L == L && this->ExitIfTrue == ExitIfTrue && 8344 this->AllowPredicates == AllowPredicates && 8345 "Variance in assumed invariant key components!"); 8346 8347 auto InsertResult = TripCountMap.insert({{ExitCond, ControlsExit}, EL}); 8348 assert(InsertResult.second && "Expected successful insertion!"); 8349 (void)InsertResult; 8350 (void)ExitIfTrue; 8351 } 8352 8353 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondCached( 8354 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 8355 bool ControlsExit, bool AllowPredicates) { 8356 8357 if (auto MaybeEL = 8358 Cache.find(L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates)) 8359 return *MaybeEL; 8360 8361 ExitLimit EL = computeExitLimitFromCondImpl(Cache, L, ExitCond, ExitIfTrue, 8362 ControlsExit, AllowPredicates); 8363 Cache.insert(L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates, EL); 8364 return EL; 8365 } 8366 8367 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondImpl( 8368 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 8369 bool ControlsExit, bool AllowPredicates) { 8370 // Handle BinOp conditions (And, Or). 8371 if (auto LimitFromBinOp = computeExitLimitFromCondFromBinOp( 8372 Cache, L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates)) 8373 return *LimitFromBinOp; 8374 8375 // With an icmp, it may be feasible to compute an exact backedge-taken count. 8376 // Proceed to the next level to examine the icmp. 8377 if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond)) { 8378 ExitLimit EL = 8379 computeExitLimitFromICmp(L, ExitCondICmp, ExitIfTrue, ControlsExit); 8380 if (EL.hasFullInfo() || !AllowPredicates) 8381 return EL; 8382 8383 // Try again, but use SCEV predicates this time. 8384 return computeExitLimitFromICmp(L, ExitCondICmp, ExitIfTrue, ControlsExit, 8385 /*AllowPredicates=*/true); 8386 } 8387 8388 // Check for a constant condition. These are normally stripped out by 8389 // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to 8390 // preserve the CFG and is temporarily leaving constant conditions 8391 // in place. 8392 if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) { 8393 if (ExitIfTrue == !CI->getZExtValue()) 8394 // The backedge is always taken. 8395 return getCouldNotCompute(); 8396 else 8397 // The backedge is never taken. 8398 return getZero(CI->getType()); 8399 } 8400 8401 // If we're exiting based on the overflow flag of an x.with.overflow intrinsic 8402 // with a constant step, we can form an equivalent icmp predicate and figure 8403 // out how many iterations will be taken before we exit. 8404 const WithOverflowInst *WO; 8405 const APInt *C; 8406 if (match(ExitCond, m_ExtractValue<1>(m_WithOverflowInst(WO))) && 8407 match(WO->getRHS(), m_APInt(C))) { 8408 ConstantRange NWR = 8409 ConstantRange::makeExactNoWrapRegion(WO->getBinaryOp(), *C, 8410 WO->getNoWrapKind()); 8411 CmpInst::Predicate Pred; 8412 APInt NewRHSC, Offset; 8413 NWR.getEquivalentICmp(Pred, NewRHSC, Offset); 8414 if (!ExitIfTrue) 8415 Pred = ICmpInst::getInversePredicate(Pred); 8416 auto *LHS = getSCEV(WO->getLHS()); 8417 if (Offset != 0) 8418 LHS = getAddExpr(LHS, getConstant(Offset)); 8419 auto EL = computeExitLimitFromICmp(L, Pred, LHS, getConstant(NewRHSC), 8420 ControlsExit, AllowPredicates); 8421 if (EL.hasAnyInfo()) return EL; 8422 } 8423 8424 // If it's not an integer or pointer comparison then compute it the hard way. 8425 return computeExitCountExhaustively(L, ExitCond, ExitIfTrue); 8426 } 8427 8428 Optional<ScalarEvolution::ExitLimit> 8429 ScalarEvolution::computeExitLimitFromCondFromBinOp( 8430 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 8431 bool ControlsExit, bool AllowPredicates) { 8432 // Check if the controlling expression for this loop is an And or Or. 8433 Value *Op0, *Op1; 8434 bool IsAnd = false; 8435 if (match(ExitCond, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) 8436 IsAnd = true; 8437 else if (match(ExitCond, m_LogicalOr(m_Value(Op0), m_Value(Op1)))) 8438 IsAnd = false; 8439 else 8440 return None; 8441 8442 // EitherMayExit is true in these two cases: 8443 // br (and Op0 Op1), loop, exit 8444 // br (or Op0 Op1), exit, loop 8445 bool EitherMayExit = IsAnd ^ ExitIfTrue; 8446 ExitLimit EL0 = computeExitLimitFromCondCached(Cache, L, Op0, ExitIfTrue, 8447 ControlsExit && !EitherMayExit, 8448 AllowPredicates); 8449 ExitLimit EL1 = computeExitLimitFromCondCached(Cache, L, Op1, ExitIfTrue, 8450 ControlsExit && !EitherMayExit, 8451 AllowPredicates); 8452 8453 // Be robust against unsimplified IR for the form "op i1 X, NeutralElement" 8454 const Constant *NeutralElement = ConstantInt::get(ExitCond->getType(), IsAnd); 8455 if (isa<ConstantInt>(Op1)) 8456 return Op1 == NeutralElement ? EL0 : EL1; 8457 if (isa<ConstantInt>(Op0)) 8458 return Op0 == NeutralElement ? EL1 : EL0; 8459 8460 const SCEV *BECount = getCouldNotCompute(); 8461 const SCEV *MaxBECount = getCouldNotCompute(); 8462 if (EitherMayExit) { 8463 // Both conditions must be same for the loop to continue executing. 8464 // Choose the less conservative count. 8465 if (EL0.ExactNotTaken != getCouldNotCompute() && 8466 EL1.ExactNotTaken != getCouldNotCompute()) { 8467 BECount = getUMinFromMismatchedTypes( 8468 EL0.ExactNotTaken, EL1.ExactNotTaken, 8469 /*Sequential=*/!isa<BinaryOperator>(ExitCond)); 8470 8471 // If EL0.ExactNotTaken was zero and ExitCond was a short-circuit form, 8472 // it should have been simplified to zero (see the condition (3) above) 8473 assert(!isa<BinaryOperator>(ExitCond) || !EL0.ExactNotTaken->isZero() || 8474 BECount->isZero()); 8475 } 8476 if (EL0.MaxNotTaken == getCouldNotCompute()) 8477 MaxBECount = EL1.MaxNotTaken; 8478 else if (EL1.MaxNotTaken == getCouldNotCompute()) 8479 MaxBECount = EL0.MaxNotTaken; 8480 else 8481 MaxBECount = getUMinFromMismatchedTypes(EL0.MaxNotTaken, EL1.MaxNotTaken); 8482 } else { 8483 // Both conditions must be same at the same time for the loop to exit. 8484 // For now, be conservative. 8485 if (EL0.ExactNotTaken == EL1.ExactNotTaken) 8486 BECount = EL0.ExactNotTaken; 8487 } 8488 8489 // There are cases (e.g. PR26207) where computeExitLimitFromCond is able 8490 // to be more aggressive when computing BECount than when computing 8491 // MaxBECount. In these cases it is possible for EL0.ExactNotTaken and 8492 // EL1.ExactNotTaken to match, but for EL0.MaxNotTaken and EL1.MaxNotTaken 8493 // to not. 8494 if (isa<SCEVCouldNotCompute>(MaxBECount) && 8495 !isa<SCEVCouldNotCompute>(BECount)) 8496 MaxBECount = getConstant(getUnsignedRangeMax(BECount)); 8497 8498 return ExitLimit(BECount, MaxBECount, false, 8499 { &EL0.Predicates, &EL1.Predicates }); 8500 } 8501 8502 ScalarEvolution::ExitLimit 8503 ScalarEvolution::computeExitLimitFromICmp(const Loop *L, 8504 ICmpInst *ExitCond, 8505 bool ExitIfTrue, 8506 bool ControlsExit, 8507 bool AllowPredicates) { 8508 // If the condition was exit on true, convert the condition to exit on false 8509 ICmpInst::Predicate Pred; 8510 if (!ExitIfTrue) 8511 Pred = ExitCond->getPredicate(); 8512 else 8513 Pred = ExitCond->getInversePredicate(); 8514 const ICmpInst::Predicate OriginalPred = Pred; 8515 8516 const SCEV *LHS = getSCEV(ExitCond->getOperand(0)); 8517 const SCEV *RHS = getSCEV(ExitCond->getOperand(1)); 8518 8519 ExitLimit EL = computeExitLimitFromICmp(L, Pred, LHS, RHS, ControlsExit, 8520 AllowPredicates); 8521 if (EL.hasAnyInfo()) return EL; 8522 8523 auto *ExhaustiveCount = 8524 computeExitCountExhaustively(L, ExitCond, ExitIfTrue); 8525 8526 if (!isa<SCEVCouldNotCompute>(ExhaustiveCount)) 8527 return ExhaustiveCount; 8528 8529 return computeShiftCompareExitLimit(ExitCond->getOperand(0), 8530 ExitCond->getOperand(1), L, OriginalPred); 8531 } 8532 ScalarEvolution::ExitLimit 8533 ScalarEvolution::computeExitLimitFromICmp(const Loop *L, 8534 ICmpInst::Predicate Pred, 8535 const SCEV *LHS, const SCEV *RHS, 8536 bool ControlsExit, 8537 bool AllowPredicates) { 8538 8539 // Try to evaluate any dependencies out of the loop. 8540 LHS = getSCEVAtScope(LHS, L); 8541 RHS = getSCEVAtScope(RHS, L); 8542 8543 // At this point, we would like to compute how many iterations of the 8544 // loop the predicate will return true for these inputs. 8545 if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) { 8546 // If there is a loop-invariant, force it into the RHS. 8547 std::swap(LHS, RHS); 8548 Pred = ICmpInst::getSwappedPredicate(Pred); 8549 } 8550 8551 bool ControllingFiniteLoop = 8552 ControlsExit && loopHasNoAbnormalExits(L) && loopIsFiniteByAssumption(L); 8553 // Simplify the operands before analyzing them. 8554 (void)SimplifyICmpOperands(Pred, LHS, RHS, /*Depth=*/0, 8555 ControllingFiniteLoop); 8556 8557 // If we have a comparison of a chrec against a constant, try to use value 8558 // ranges to answer this query. 8559 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) 8560 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS)) 8561 if (AddRec->getLoop() == L) { 8562 // Form the constant range. 8563 ConstantRange CompRange = 8564 ConstantRange::makeExactICmpRegion(Pred, RHSC->getAPInt()); 8565 8566 const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this); 8567 if (!isa<SCEVCouldNotCompute>(Ret)) return Ret; 8568 } 8569 8570 // If this loop must exit based on this condition (or execute undefined 8571 // behaviour), and we can prove the test sequence produced must repeat 8572 // the same values on self-wrap of the IV, then we can infer that IV 8573 // doesn't self wrap because if it did, we'd have an infinite (undefined) 8574 // loop. 8575 if (ControllingFiniteLoop && isLoopInvariant(RHS, L)) { 8576 // TODO: We can peel off any functions which are invertible *in L*. Loop 8577 // invariant terms are effectively constants for our purposes here. 8578 auto *InnerLHS = LHS; 8579 if (auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(LHS)) 8580 InnerLHS = ZExt->getOperand(); 8581 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(InnerLHS)) { 8582 auto *StrideC = dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this)); 8583 if (!AR->hasNoSelfWrap() && AR->getLoop() == L && AR->isAffine() && 8584 StrideC && StrideC->getAPInt().isPowerOf2()) { 8585 auto Flags = AR->getNoWrapFlags(); 8586 Flags = setFlags(Flags, SCEV::FlagNW); 8587 SmallVector<const SCEV*> Operands{AR->operands()}; 8588 Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags); 8589 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), Flags); 8590 } 8591 } 8592 } 8593 8594 switch (Pred) { 8595 case ICmpInst::ICMP_NE: { // while (X != Y) 8596 // Convert to: while (X-Y != 0) 8597 if (LHS->getType()->isPointerTy()) { 8598 LHS = getLosslessPtrToIntExpr(LHS); 8599 if (isa<SCEVCouldNotCompute>(LHS)) 8600 return LHS; 8601 } 8602 if (RHS->getType()->isPointerTy()) { 8603 RHS = getLosslessPtrToIntExpr(RHS); 8604 if (isa<SCEVCouldNotCompute>(RHS)) 8605 return RHS; 8606 } 8607 ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit, 8608 AllowPredicates); 8609 if (EL.hasAnyInfo()) return EL; 8610 break; 8611 } 8612 case ICmpInst::ICMP_EQ: { // while (X == Y) 8613 // Convert to: while (X-Y == 0) 8614 if (LHS->getType()->isPointerTy()) { 8615 LHS = getLosslessPtrToIntExpr(LHS); 8616 if (isa<SCEVCouldNotCompute>(LHS)) 8617 return LHS; 8618 } 8619 if (RHS->getType()->isPointerTy()) { 8620 RHS = getLosslessPtrToIntExpr(RHS); 8621 if (isa<SCEVCouldNotCompute>(RHS)) 8622 return RHS; 8623 } 8624 ExitLimit EL = howFarToNonZero(getMinusSCEV(LHS, RHS), L); 8625 if (EL.hasAnyInfo()) return EL; 8626 break; 8627 } 8628 case ICmpInst::ICMP_SLT: 8629 case ICmpInst::ICMP_ULT: { // while (X < Y) 8630 bool IsSigned = Pred == ICmpInst::ICMP_SLT; 8631 ExitLimit EL = howManyLessThans(LHS, RHS, L, IsSigned, ControlsExit, 8632 AllowPredicates); 8633 if (EL.hasAnyInfo()) return EL; 8634 break; 8635 } 8636 case ICmpInst::ICMP_SGT: 8637 case ICmpInst::ICMP_UGT: { // while (X > Y) 8638 bool IsSigned = Pred == ICmpInst::ICMP_SGT; 8639 ExitLimit EL = 8640 howManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit, 8641 AllowPredicates); 8642 if (EL.hasAnyInfo()) return EL; 8643 break; 8644 } 8645 default: 8646 break; 8647 } 8648 8649 return getCouldNotCompute(); 8650 } 8651 8652 ScalarEvolution::ExitLimit 8653 ScalarEvolution::computeExitLimitFromSingleExitSwitch(const Loop *L, 8654 SwitchInst *Switch, 8655 BasicBlock *ExitingBlock, 8656 bool ControlsExit) { 8657 assert(!L->contains(ExitingBlock) && "Not an exiting block!"); 8658 8659 // Give up if the exit is the default dest of a switch. 8660 if (Switch->getDefaultDest() == ExitingBlock) 8661 return getCouldNotCompute(); 8662 8663 assert(L->contains(Switch->getDefaultDest()) && 8664 "Default case must not exit the loop!"); 8665 const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L); 8666 const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock)); 8667 8668 // while (X != Y) --> while (X-Y != 0) 8669 ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit); 8670 if (EL.hasAnyInfo()) 8671 return EL; 8672 8673 return getCouldNotCompute(); 8674 } 8675 8676 static ConstantInt * 8677 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C, 8678 ScalarEvolution &SE) { 8679 const SCEV *InVal = SE.getConstant(C); 8680 const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE); 8681 assert(isa<SCEVConstant>(Val) && 8682 "Evaluation of SCEV at constant didn't fold correctly?"); 8683 return cast<SCEVConstant>(Val)->getValue(); 8684 } 8685 8686 ScalarEvolution::ExitLimit ScalarEvolution::computeShiftCompareExitLimit( 8687 Value *LHS, Value *RHSV, const Loop *L, ICmpInst::Predicate Pred) { 8688 ConstantInt *RHS = dyn_cast<ConstantInt>(RHSV); 8689 if (!RHS) 8690 return getCouldNotCompute(); 8691 8692 const BasicBlock *Latch = L->getLoopLatch(); 8693 if (!Latch) 8694 return getCouldNotCompute(); 8695 8696 const BasicBlock *Predecessor = L->getLoopPredecessor(); 8697 if (!Predecessor) 8698 return getCouldNotCompute(); 8699 8700 // Return true if V is of the form "LHS `shift_op` <positive constant>". 8701 // Return LHS in OutLHS and shift_opt in OutOpCode. 8702 auto MatchPositiveShift = 8703 [](Value *V, Value *&OutLHS, Instruction::BinaryOps &OutOpCode) { 8704 8705 using namespace PatternMatch; 8706 8707 ConstantInt *ShiftAmt; 8708 if (match(V, m_LShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8709 OutOpCode = Instruction::LShr; 8710 else if (match(V, m_AShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8711 OutOpCode = Instruction::AShr; 8712 else if (match(V, m_Shl(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8713 OutOpCode = Instruction::Shl; 8714 else 8715 return false; 8716 8717 return ShiftAmt->getValue().isStrictlyPositive(); 8718 }; 8719 8720 // Recognize a "shift recurrence" either of the form %iv or of %iv.shifted in 8721 // 8722 // loop: 8723 // %iv = phi i32 [ %iv.shifted, %loop ], [ %val, %preheader ] 8724 // %iv.shifted = lshr i32 %iv, <positive constant> 8725 // 8726 // Return true on a successful match. Return the corresponding PHI node (%iv 8727 // above) in PNOut and the opcode of the shift operation in OpCodeOut. 8728 auto MatchShiftRecurrence = 8729 [&](Value *V, PHINode *&PNOut, Instruction::BinaryOps &OpCodeOut) { 8730 Optional<Instruction::BinaryOps> PostShiftOpCode; 8731 8732 { 8733 Instruction::BinaryOps OpC; 8734 Value *V; 8735 8736 // If we encounter a shift instruction, "peel off" the shift operation, 8737 // and remember that we did so. Later when we inspect %iv's backedge 8738 // value, we will make sure that the backedge value uses the same 8739 // operation. 8740 // 8741 // Note: the peeled shift operation does not have to be the same 8742 // instruction as the one feeding into the PHI's backedge value. We only 8743 // really care about it being the same *kind* of shift instruction -- 8744 // that's all that is required for our later inferences to hold. 8745 if (MatchPositiveShift(LHS, V, OpC)) { 8746 PostShiftOpCode = OpC; 8747 LHS = V; 8748 } 8749 } 8750 8751 PNOut = dyn_cast<PHINode>(LHS); 8752 if (!PNOut || PNOut->getParent() != L->getHeader()) 8753 return false; 8754 8755 Value *BEValue = PNOut->getIncomingValueForBlock(Latch); 8756 Value *OpLHS; 8757 8758 return 8759 // The backedge value for the PHI node must be a shift by a positive 8760 // amount 8761 MatchPositiveShift(BEValue, OpLHS, OpCodeOut) && 8762 8763 // of the PHI node itself 8764 OpLHS == PNOut && 8765 8766 // and the kind of shift should be match the kind of shift we peeled 8767 // off, if any. 8768 (!PostShiftOpCode.hasValue() || *PostShiftOpCode == OpCodeOut); 8769 }; 8770 8771 PHINode *PN; 8772 Instruction::BinaryOps OpCode; 8773 if (!MatchShiftRecurrence(LHS, PN, OpCode)) 8774 return getCouldNotCompute(); 8775 8776 const DataLayout &DL = getDataLayout(); 8777 8778 // The key rationale for this optimization is that for some kinds of shift 8779 // recurrences, the value of the recurrence "stabilizes" to either 0 or -1 8780 // within a finite number of iterations. If the condition guarding the 8781 // backedge (in the sense that the backedge is taken if the condition is true) 8782 // is false for the value the shift recurrence stabilizes to, then we know 8783 // that the backedge is taken only a finite number of times. 8784 8785 ConstantInt *StableValue = nullptr; 8786 switch (OpCode) { 8787 default: 8788 llvm_unreachable("Impossible case!"); 8789 8790 case Instruction::AShr: { 8791 // {K,ashr,<positive-constant>} stabilizes to signum(K) in at most 8792 // bitwidth(K) iterations. 8793 Value *FirstValue = PN->getIncomingValueForBlock(Predecessor); 8794 KnownBits Known = computeKnownBits(FirstValue, DL, 0, &AC, 8795 Predecessor->getTerminator(), &DT); 8796 auto *Ty = cast<IntegerType>(RHS->getType()); 8797 if (Known.isNonNegative()) 8798 StableValue = ConstantInt::get(Ty, 0); 8799 else if (Known.isNegative()) 8800 StableValue = ConstantInt::get(Ty, -1, true); 8801 else 8802 return getCouldNotCompute(); 8803 8804 break; 8805 } 8806 case Instruction::LShr: 8807 case Instruction::Shl: 8808 // Both {K,lshr,<positive-constant>} and {K,shl,<positive-constant>} 8809 // stabilize to 0 in at most bitwidth(K) iterations. 8810 StableValue = ConstantInt::get(cast<IntegerType>(RHS->getType()), 0); 8811 break; 8812 } 8813 8814 auto *Result = 8815 ConstantFoldCompareInstOperands(Pred, StableValue, RHS, DL, &TLI); 8816 assert(Result->getType()->isIntegerTy(1) && 8817 "Otherwise cannot be an operand to a branch instruction"); 8818 8819 if (Result->isZeroValue()) { 8820 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 8821 const SCEV *UpperBound = 8822 getConstant(getEffectiveSCEVType(RHS->getType()), BitWidth); 8823 return ExitLimit(getCouldNotCompute(), UpperBound, false); 8824 } 8825 8826 return getCouldNotCompute(); 8827 } 8828 8829 /// Return true if we can constant fold an instruction of the specified type, 8830 /// assuming that all operands were constants. 8831 static bool CanConstantFold(const Instruction *I) { 8832 if (isa<BinaryOperator>(I) || isa<CmpInst>(I) || 8833 isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) || 8834 isa<LoadInst>(I) || isa<ExtractValueInst>(I)) 8835 return true; 8836 8837 if (const CallInst *CI = dyn_cast<CallInst>(I)) 8838 if (const Function *F = CI->getCalledFunction()) 8839 return canConstantFoldCallTo(CI, F); 8840 return false; 8841 } 8842 8843 /// Determine whether this instruction can constant evolve within this loop 8844 /// assuming its operands can all constant evolve. 8845 static bool canConstantEvolve(Instruction *I, const Loop *L) { 8846 // An instruction outside of the loop can't be derived from a loop PHI. 8847 if (!L->contains(I)) return false; 8848 8849 if (isa<PHINode>(I)) { 8850 // We don't currently keep track of the control flow needed to evaluate 8851 // PHIs, so we cannot handle PHIs inside of loops. 8852 return L->getHeader() == I->getParent(); 8853 } 8854 8855 // If we won't be able to constant fold this expression even if the operands 8856 // are constants, bail early. 8857 return CanConstantFold(I); 8858 } 8859 8860 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by 8861 /// recursing through each instruction operand until reaching a loop header phi. 8862 static PHINode * 8863 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L, 8864 DenseMap<Instruction *, PHINode *> &PHIMap, 8865 unsigned Depth) { 8866 if (Depth > MaxConstantEvolvingDepth) 8867 return nullptr; 8868 8869 // Otherwise, we can evaluate this instruction if all of its operands are 8870 // constant or derived from a PHI node themselves. 8871 PHINode *PHI = nullptr; 8872 for (Value *Op : UseInst->operands()) { 8873 if (isa<Constant>(Op)) continue; 8874 8875 Instruction *OpInst = dyn_cast<Instruction>(Op); 8876 if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr; 8877 8878 PHINode *P = dyn_cast<PHINode>(OpInst); 8879 if (!P) 8880 // If this operand is already visited, reuse the prior result. 8881 // We may have P != PHI if this is the deepest point at which the 8882 // inconsistent paths meet. 8883 P = PHIMap.lookup(OpInst); 8884 if (!P) { 8885 // Recurse and memoize the results, whether a phi is found or not. 8886 // This recursive call invalidates pointers into PHIMap. 8887 P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap, Depth + 1); 8888 PHIMap[OpInst] = P; 8889 } 8890 if (!P) 8891 return nullptr; // Not evolving from PHI 8892 if (PHI && PHI != P) 8893 return nullptr; // Evolving from multiple different PHIs. 8894 PHI = P; 8895 } 8896 // This is a expression evolving from a constant PHI! 8897 return PHI; 8898 } 8899 8900 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node 8901 /// in the loop that V is derived from. We allow arbitrary operations along the 8902 /// way, but the operands of an operation must either be constants or a value 8903 /// derived from a constant PHI. If this expression does not fit with these 8904 /// constraints, return null. 8905 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) { 8906 Instruction *I = dyn_cast<Instruction>(V); 8907 if (!I || !canConstantEvolve(I, L)) return nullptr; 8908 8909 if (PHINode *PN = dyn_cast<PHINode>(I)) 8910 return PN; 8911 8912 // Record non-constant instructions contained by the loop. 8913 DenseMap<Instruction *, PHINode *> PHIMap; 8914 return getConstantEvolvingPHIOperands(I, L, PHIMap, 0); 8915 } 8916 8917 /// EvaluateExpression - Given an expression that passes the 8918 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node 8919 /// in the loop has the value PHIVal. If we can't fold this expression for some 8920 /// reason, return null. 8921 static Constant *EvaluateExpression(Value *V, const Loop *L, 8922 DenseMap<Instruction *, Constant *> &Vals, 8923 const DataLayout &DL, 8924 const TargetLibraryInfo *TLI) { 8925 // Convenient constant check, but redundant for recursive calls. 8926 if (Constant *C = dyn_cast<Constant>(V)) return C; 8927 Instruction *I = dyn_cast<Instruction>(V); 8928 if (!I) return nullptr; 8929 8930 if (Constant *C = Vals.lookup(I)) return C; 8931 8932 // An instruction inside the loop depends on a value outside the loop that we 8933 // weren't given a mapping for, or a value such as a call inside the loop. 8934 if (!canConstantEvolve(I, L)) return nullptr; 8935 8936 // An unmapped PHI can be due to a branch or another loop inside this loop, 8937 // or due to this not being the initial iteration through a loop where we 8938 // couldn't compute the evolution of this particular PHI last time. 8939 if (isa<PHINode>(I)) return nullptr; 8940 8941 std::vector<Constant*> Operands(I->getNumOperands()); 8942 8943 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) { 8944 Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i)); 8945 if (!Operand) { 8946 Operands[i] = dyn_cast<Constant>(I->getOperand(i)); 8947 if (!Operands[i]) return nullptr; 8948 continue; 8949 } 8950 Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI); 8951 Vals[Operand] = C; 8952 if (!C) return nullptr; 8953 Operands[i] = C; 8954 } 8955 8956 if (CmpInst *CI = dyn_cast<CmpInst>(I)) 8957 return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0], 8958 Operands[1], DL, TLI); 8959 if (LoadInst *LI = dyn_cast<LoadInst>(I)) { 8960 if (!LI->isVolatile()) 8961 return ConstantFoldLoadFromConstPtr(Operands[0], LI->getType(), DL); 8962 } 8963 return ConstantFoldInstOperands(I, Operands, DL, TLI); 8964 } 8965 8966 8967 // If every incoming value to PN except the one for BB is a specific Constant, 8968 // return that, else return nullptr. 8969 static Constant *getOtherIncomingValue(PHINode *PN, BasicBlock *BB) { 8970 Constant *IncomingVal = nullptr; 8971 8972 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 8973 if (PN->getIncomingBlock(i) == BB) 8974 continue; 8975 8976 auto *CurrentVal = dyn_cast<Constant>(PN->getIncomingValue(i)); 8977 if (!CurrentVal) 8978 return nullptr; 8979 8980 if (IncomingVal != CurrentVal) { 8981 if (IncomingVal) 8982 return nullptr; 8983 IncomingVal = CurrentVal; 8984 } 8985 } 8986 8987 return IncomingVal; 8988 } 8989 8990 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is 8991 /// in the header of its containing loop, we know the loop executes a 8992 /// constant number of times, and the PHI node is just a recurrence 8993 /// involving constants, fold it. 8994 Constant * 8995 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN, 8996 const APInt &BEs, 8997 const Loop *L) { 8998 auto I = ConstantEvolutionLoopExitValue.find(PN); 8999 if (I != ConstantEvolutionLoopExitValue.end()) 9000 return I->second; 9001 9002 if (BEs.ugt(MaxBruteForceIterations)) 9003 return ConstantEvolutionLoopExitValue[PN] = nullptr; // Not going to evaluate it. 9004 9005 Constant *&RetVal = ConstantEvolutionLoopExitValue[PN]; 9006 9007 DenseMap<Instruction *, Constant *> CurrentIterVals; 9008 BasicBlock *Header = L->getHeader(); 9009 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!"); 9010 9011 BasicBlock *Latch = L->getLoopLatch(); 9012 if (!Latch) 9013 return nullptr; 9014 9015 for (PHINode &PHI : Header->phis()) { 9016 if (auto *StartCST = getOtherIncomingValue(&PHI, Latch)) 9017 CurrentIterVals[&PHI] = StartCST; 9018 } 9019 if (!CurrentIterVals.count(PN)) 9020 return RetVal = nullptr; 9021 9022 Value *BEValue = PN->getIncomingValueForBlock(Latch); 9023 9024 // Execute the loop symbolically to determine the exit value. 9025 assert(BEs.getActiveBits() < CHAR_BIT * sizeof(unsigned) && 9026 "BEs is <= MaxBruteForceIterations which is an 'unsigned'!"); 9027 9028 unsigned NumIterations = BEs.getZExtValue(); // must be in range 9029 unsigned IterationNum = 0; 9030 const DataLayout &DL = getDataLayout(); 9031 for (; ; ++IterationNum) { 9032 if (IterationNum == NumIterations) 9033 return RetVal = CurrentIterVals[PN]; // Got exit value! 9034 9035 // Compute the value of the PHIs for the next iteration. 9036 // EvaluateExpression adds non-phi values to the CurrentIterVals map. 9037 DenseMap<Instruction *, Constant *> NextIterVals; 9038 Constant *NextPHI = 9039 EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 9040 if (!NextPHI) 9041 return nullptr; // Couldn't evaluate! 9042 NextIterVals[PN] = NextPHI; 9043 9044 bool StoppedEvolving = NextPHI == CurrentIterVals[PN]; 9045 9046 // Also evaluate the other PHI nodes. However, we don't get to stop if we 9047 // cease to be able to evaluate one of them or if they stop evolving, 9048 // because that doesn't necessarily prevent us from computing PN. 9049 SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute; 9050 for (const auto &I : CurrentIterVals) { 9051 PHINode *PHI = dyn_cast<PHINode>(I.first); 9052 if (!PHI || PHI == PN || PHI->getParent() != Header) continue; 9053 PHIsToCompute.emplace_back(PHI, I.second); 9054 } 9055 // We use two distinct loops because EvaluateExpression may invalidate any 9056 // iterators into CurrentIterVals. 9057 for (const auto &I : PHIsToCompute) { 9058 PHINode *PHI = I.first; 9059 Constant *&NextPHI = NextIterVals[PHI]; 9060 if (!NextPHI) { // Not already computed. 9061 Value *BEValue = PHI->getIncomingValueForBlock(Latch); 9062 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 9063 } 9064 if (NextPHI != I.second) 9065 StoppedEvolving = false; 9066 } 9067 9068 // If all entries in CurrentIterVals == NextIterVals then we can stop 9069 // iterating, the loop can't continue to change. 9070 if (StoppedEvolving) 9071 return RetVal = CurrentIterVals[PN]; 9072 9073 CurrentIterVals.swap(NextIterVals); 9074 } 9075 } 9076 9077 const SCEV *ScalarEvolution::computeExitCountExhaustively(const Loop *L, 9078 Value *Cond, 9079 bool ExitWhen) { 9080 PHINode *PN = getConstantEvolvingPHI(Cond, L); 9081 if (!PN) return getCouldNotCompute(); 9082 9083 // If the loop is canonicalized, the PHI will have exactly two entries. 9084 // That's the only form we support here. 9085 if (PN->getNumIncomingValues() != 2) return getCouldNotCompute(); 9086 9087 DenseMap<Instruction *, Constant *> CurrentIterVals; 9088 BasicBlock *Header = L->getHeader(); 9089 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!"); 9090 9091 BasicBlock *Latch = L->getLoopLatch(); 9092 assert(Latch && "Should follow from NumIncomingValues == 2!"); 9093 9094 for (PHINode &PHI : Header->phis()) { 9095 if (auto *StartCST = getOtherIncomingValue(&PHI, Latch)) 9096 CurrentIterVals[&PHI] = StartCST; 9097 } 9098 if (!CurrentIterVals.count(PN)) 9099 return getCouldNotCompute(); 9100 9101 // Okay, we find a PHI node that defines the trip count of this loop. Execute 9102 // the loop symbolically to determine when the condition gets a value of 9103 // "ExitWhen". 9104 unsigned MaxIterations = MaxBruteForceIterations; // Limit analysis. 9105 const DataLayout &DL = getDataLayout(); 9106 for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){ 9107 auto *CondVal = dyn_cast_or_null<ConstantInt>( 9108 EvaluateExpression(Cond, L, CurrentIterVals, DL, &TLI)); 9109 9110 // Couldn't symbolically evaluate. 9111 if (!CondVal) return getCouldNotCompute(); 9112 9113 if (CondVal->getValue() == uint64_t(ExitWhen)) { 9114 ++NumBruteForceTripCountsComputed; 9115 return getConstant(Type::getInt32Ty(getContext()), IterationNum); 9116 } 9117 9118 // Update all the PHI nodes for the next iteration. 9119 DenseMap<Instruction *, Constant *> NextIterVals; 9120 9121 // Create a list of which PHIs we need to compute. We want to do this before 9122 // calling EvaluateExpression on them because that may invalidate iterators 9123 // into CurrentIterVals. 9124 SmallVector<PHINode *, 8> PHIsToCompute; 9125 for (const auto &I : CurrentIterVals) { 9126 PHINode *PHI = dyn_cast<PHINode>(I.first); 9127 if (!PHI || PHI->getParent() != Header) continue; 9128 PHIsToCompute.push_back(PHI); 9129 } 9130 for (PHINode *PHI : PHIsToCompute) { 9131 Constant *&NextPHI = NextIterVals[PHI]; 9132 if (NextPHI) continue; // Already computed! 9133 9134 Value *BEValue = PHI->getIncomingValueForBlock(Latch); 9135 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 9136 } 9137 CurrentIterVals.swap(NextIterVals); 9138 } 9139 9140 // Too many iterations were needed to evaluate. 9141 return getCouldNotCompute(); 9142 } 9143 9144 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) { 9145 SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values = 9146 ValuesAtScopes[V]; 9147 // Check to see if we've folded this expression at this loop before. 9148 for (auto &LS : Values) 9149 if (LS.first == L) 9150 return LS.second ? LS.second : V; 9151 9152 Values.emplace_back(L, nullptr); 9153 9154 // Otherwise compute it. 9155 const SCEV *C = computeSCEVAtScope(V, L); 9156 for (auto &LS : reverse(ValuesAtScopes[V])) 9157 if (LS.first == L) { 9158 LS.second = C; 9159 if (!isa<SCEVConstant>(C)) 9160 ValuesAtScopesUsers[C].push_back({L, V}); 9161 break; 9162 } 9163 return C; 9164 } 9165 9166 /// This builds up a Constant using the ConstantExpr interface. That way, we 9167 /// will return Constants for objects which aren't represented by a 9168 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt. 9169 /// Returns NULL if the SCEV isn't representable as a Constant. 9170 static Constant *BuildConstantFromSCEV(const SCEV *V) { 9171 switch (V->getSCEVType()) { 9172 case scCouldNotCompute: 9173 case scAddRecExpr: 9174 return nullptr; 9175 case scConstant: 9176 return cast<SCEVConstant>(V)->getValue(); 9177 case scUnknown: 9178 return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue()); 9179 case scSignExtend: { 9180 const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V); 9181 if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand())) 9182 return ConstantExpr::getSExt(CastOp, SS->getType()); 9183 return nullptr; 9184 } 9185 case scZeroExtend: { 9186 const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V); 9187 if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand())) 9188 return ConstantExpr::getZExt(CastOp, SZ->getType()); 9189 return nullptr; 9190 } 9191 case scPtrToInt: { 9192 const SCEVPtrToIntExpr *P2I = cast<SCEVPtrToIntExpr>(V); 9193 if (Constant *CastOp = BuildConstantFromSCEV(P2I->getOperand())) 9194 return ConstantExpr::getPtrToInt(CastOp, P2I->getType()); 9195 9196 return nullptr; 9197 } 9198 case scTruncate: { 9199 const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V); 9200 if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand())) 9201 return ConstantExpr::getTrunc(CastOp, ST->getType()); 9202 return nullptr; 9203 } 9204 case scAddExpr: { 9205 const SCEVAddExpr *SA = cast<SCEVAddExpr>(V); 9206 if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) { 9207 if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) { 9208 unsigned AS = PTy->getAddressSpace(); 9209 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS); 9210 C = ConstantExpr::getBitCast(C, DestPtrTy); 9211 } 9212 for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) { 9213 Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i)); 9214 if (!C2) 9215 return nullptr; 9216 9217 // First pointer! 9218 if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) { 9219 unsigned AS = C2->getType()->getPointerAddressSpace(); 9220 std::swap(C, C2); 9221 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS); 9222 // The offsets have been converted to bytes. We can add bytes to an 9223 // i8* by GEP with the byte count in the first index. 9224 C = ConstantExpr::getBitCast(C, DestPtrTy); 9225 } 9226 9227 // Don't bother trying to sum two pointers. We probably can't 9228 // statically compute a load that results from it anyway. 9229 if (C2->getType()->isPointerTy()) 9230 return nullptr; 9231 9232 if (C->getType()->isPointerTy()) { 9233 C = ConstantExpr::getGetElementPtr(Type::getInt8Ty(C->getContext()), 9234 C, C2); 9235 } else { 9236 C = ConstantExpr::getAdd(C, C2); 9237 } 9238 } 9239 return C; 9240 } 9241 return nullptr; 9242 } 9243 case scMulExpr: { 9244 const SCEVMulExpr *SM = cast<SCEVMulExpr>(V); 9245 if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) { 9246 // Don't bother with pointers at all. 9247 if (C->getType()->isPointerTy()) 9248 return nullptr; 9249 for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) { 9250 Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i)); 9251 if (!C2 || C2->getType()->isPointerTy()) 9252 return nullptr; 9253 C = ConstantExpr::getMul(C, C2); 9254 } 9255 return C; 9256 } 9257 return nullptr; 9258 } 9259 case scUDivExpr: { 9260 const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V); 9261 if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS())) 9262 if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS())) 9263 if (LHS->getType() == RHS->getType()) 9264 return ConstantExpr::getUDiv(LHS, RHS); 9265 return nullptr; 9266 } 9267 case scSMaxExpr: 9268 case scUMaxExpr: 9269 case scSMinExpr: 9270 case scUMinExpr: 9271 case scSequentialUMinExpr: 9272 return nullptr; // TODO: smax, umax, smin, umax, umin_seq. 9273 } 9274 llvm_unreachable("Unknown SCEV kind!"); 9275 } 9276 9277 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) { 9278 if (isa<SCEVConstant>(V)) return V; 9279 9280 // If this instruction is evolved from a constant-evolving PHI, compute the 9281 // exit value from the loop without using SCEVs. 9282 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) { 9283 if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) { 9284 if (PHINode *PN = dyn_cast<PHINode>(I)) { 9285 const Loop *CurrLoop = this->LI[I->getParent()]; 9286 // Looking for loop exit value. 9287 if (CurrLoop && CurrLoop->getParentLoop() == L && 9288 PN->getParent() == CurrLoop->getHeader()) { 9289 // Okay, there is no closed form solution for the PHI node. Check 9290 // to see if the loop that contains it has a known backedge-taken 9291 // count. If so, we may be able to force computation of the exit 9292 // value. 9293 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(CurrLoop); 9294 // This trivial case can show up in some degenerate cases where 9295 // the incoming IR has not yet been fully simplified. 9296 if (BackedgeTakenCount->isZero()) { 9297 Value *InitValue = nullptr; 9298 bool MultipleInitValues = false; 9299 for (unsigned i = 0; i < PN->getNumIncomingValues(); i++) { 9300 if (!CurrLoop->contains(PN->getIncomingBlock(i))) { 9301 if (!InitValue) 9302 InitValue = PN->getIncomingValue(i); 9303 else if (InitValue != PN->getIncomingValue(i)) { 9304 MultipleInitValues = true; 9305 break; 9306 } 9307 } 9308 } 9309 if (!MultipleInitValues && InitValue) 9310 return getSCEV(InitValue); 9311 } 9312 // Do we have a loop invariant value flowing around the backedge 9313 // for a loop which must execute the backedge? 9314 if (!isa<SCEVCouldNotCompute>(BackedgeTakenCount) && 9315 isKnownPositive(BackedgeTakenCount) && 9316 PN->getNumIncomingValues() == 2) { 9317 9318 unsigned InLoopPred = 9319 CurrLoop->contains(PN->getIncomingBlock(0)) ? 0 : 1; 9320 Value *BackedgeVal = PN->getIncomingValue(InLoopPred); 9321 if (CurrLoop->isLoopInvariant(BackedgeVal)) 9322 return getSCEV(BackedgeVal); 9323 } 9324 if (auto *BTCC = dyn_cast<SCEVConstant>(BackedgeTakenCount)) { 9325 // Okay, we know how many times the containing loop executes. If 9326 // this is a constant evolving PHI node, get the final value at 9327 // the specified iteration number. 9328 Constant *RV = getConstantEvolutionLoopExitValue( 9329 PN, BTCC->getAPInt(), CurrLoop); 9330 if (RV) return getSCEV(RV); 9331 } 9332 } 9333 9334 // If there is a single-input Phi, evaluate it at our scope. If we can 9335 // prove that this replacement does not break LCSSA form, use new value. 9336 if (PN->getNumOperands() == 1) { 9337 const SCEV *Input = getSCEV(PN->getOperand(0)); 9338 const SCEV *InputAtScope = getSCEVAtScope(Input, L); 9339 // TODO: We can generalize it using LI.replacementPreservesLCSSAForm, 9340 // for the simplest case just support constants. 9341 if (isa<SCEVConstant>(InputAtScope)) return InputAtScope; 9342 } 9343 } 9344 9345 // Okay, this is an expression that we cannot symbolically evaluate 9346 // into a SCEV. Check to see if it's possible to symbolically evaluate 9347 // the arguments into constants, and if so, try to constant propagate the 9348 // result. This is particularly useful for computing loop exit values. 9349 if (CanConstantFold(I)) { 9350 SmallVector<Constant *, 4> Operands; 9351 bool MadeImprovement = false; 9352 for (Value *Op : I->operands()) { 9353 if (Constant *C = dyn_cast<Constant>(Op)) { 9354 Operands.push_back(C); 9355 continue; 9356 } 9357 9358 // If any of the operands is non-constant and if they are 9359 // non-integer and non-pointer, don't even try to analyze them 9360 // with scev techniques. 9361 if (!isSCEVable(Op->getType())) 9362 return V; 9363 9364 const SCEV *OrigV = getSCEV(Op); 9365 const SCEV *OpV = getSCEVAtScope(OrigV, L); 9366 MadeImprovement |= OrigV != OpV; 9367 9368 Constant *C = BuildConstantFromSCEV(OpV); 9369 if (!C) return V; 9370 if (C->getType() != Op->getType()) 9371 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false, 9372 Op->getType(), 9373 false), 9374 C, Op->getType()); 9375 Operands.push_back(C); 9376 } 9377 9378 // Check to see if getSCEVAtScope actually made an improvement. 9379 if (MadeImprovement) { 9380 Constant *C = nullptr; 9381 const DataLayout &DL = getDataLayout(); 9382 if (const CmpInst *CI = dyn_cast<CmpInst>(I)) 9383 C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0], 9384 Operands[1], DL, &TLI); 9385 else if (const LoadInst *Load = dyn_cast<LoadInst>(I)) { 9386 if (!Load->isVolatile()) 9387 C = ConstantFoldLoadFromConstPtr(Operands[0], Load->getType(), 9388 DL); 9389 } else 9390 C = ConstantFoldInstOperands(I, Operands, DL, &TLI); 9391 if (!C) return V; 9392 return getSCEV(C); 9393 } 9394 } 9395 } 9396 9397 // This is some other type of SCEVUnknown, just return it. 9398 return V; 9399 } 9400 9401 if (isa<SCEVCommutativeExpr>(V) || isa<SCEVSequentialMinMaxExpr>(V)) { 9402 const auto *Comm = cast<SCEVNAryExpr>(V); 9403 // Avoid performing the look-up in the common case where the specified 9404 // expression has no loop-variant portions. 9405 for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) { 9406 const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L); 9407 if (OpAtScope != Comm->getOperand(i)) { 9408 // Okay, at least one of these operands is loop variant but might be 9409 // foldable. Build a new instance of the folded commutative expression. 9410 SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(), 9411 Comm->op_begin()+i); 9412 NewOps.push_back(OpAtScope); 9413 9414 for (++i; i != e; ++i) { 9415 OpAtScope = getSCEVAtScope(Comm->getOperand(i), L); 9416 NewOps.push_back(OpAtScope); 9417 } 9418 if (isa<SCEVAddExpr>(Comm)) 9419 return getAddExpr(NewOps, Comm->getNoWrapFlags()); 9420 if (isa<SCEVMulExpr>(Comm)) 9421 return getMulExpr(NewOps, Comm->getNoWrapFlags()); 9422 if (isa<SCEVMinMaxExpr>(Comm)) 9423 return getMinMaxExpr(Comm->getSCEVType(), NewOps); 9424 if (isa<SCEVSequentialMinMaxExpr>(Comm)) 9425 return getSequentialMinMaxExpr(Comm->getSCEVType(), NewOps); 9426 llvm_unreachable("Unknown commutative / sequential min/max SCEV type!"); 9427 } 9428 } 9429 // If we got here, all operands are loop invariant. 9430 return Comm; 9431 } 9432 9433 if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) { 9434 const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L); 9435 const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L); 9436 if (LHS == Div->getLHS() && RHS == Div->getRHS()) 9437 return Div; // must be loop invariant 9438 return getUDivExpr(LHS, RHS); 9439 } 9440 9441 // If this is a loop recurrence for a loop that does not contain L, then we 9442 // are dealing with the final value computed by the loop. 9443 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) { 9444 // First, attempt to evaluate each operand. 9445 // Avoid performing the look-up in the common case where the specified 9446 // expression has no loop-variant portions. 9447 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) { 9448 const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L); 9449 if (OpAtScope == AddRec->getOperand(i)) 9450 continue; 9451 9452 // Okay, at least one of these operands is loop variant but might be 9453 // foldable. Build a new instance of the folded commutative expression. 9454 SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(), 9455 AddRec->op_begin()+i); 9456 NewOps.push_back(OpAtScope); 9457 for (++i; i != e; ++i) 9458 NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L)); 9459 9460 const SCEV *FoldedRec = 9461 getAddRecExpr(NewOps, AddRec->getLoop(), 9462 AddRec->getNoWrapFlags(SCEV::FlagNW)); 9463 AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec); 9464 // The addrec may be folded to a nonrecurrence, for example, if the 9465 // induction variable is multiplied by zero after constant folding. Go 9466 // ahead and return the folded value. 9467 if (!AddRec) 9468 return FoldedRec; 9469 break; 9470 } 9471 9472 // If the scope is outside the addrec's loop, evaluate it by using the 9473 // loop exit value of the addrec. 9474 if (!AddRec->getLoop()->contains(L)) { 9475 // To evaluate this recurrence, we need to know how many times the AddRec 9476 // loop iterates. Compute this now. 9477 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop()); 9478 if (BackedgeTakenCount == getCouldNotCompute()) return AddRec; 9479 9480 // Then, evaluate the AddRec. 9481 return AddRec->evaluateAtIteration(BackedgeTakenCount, *this); 9482 } 9483 9484 return AddRec; 9485 } 9486 9487 if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) { 9488 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L); 9489 if (Op == Cast->getOperand()) 9490 return Cast; // must be loop invariant 9491 return getCastExpr(Cast->getSCEVType(), Op, Cast->getType()); 9492 } 9493 9494 llvm_unreachable("Unknown SCEV type!"); 9495 } 9496 9497 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) { 9498 return getSCEVAtScope(getSCEV(V), L); 9499 } 9500 9501 const SCEV *ScalarEvolution::stripInjectiveFunctions(const SCEV *S) const { 9502 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) 9503 return stripInjectiveFunctions(ZExt->getOperand()); 9504 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) 9505 return stripInjectiveFunctions(SExt->getOperand()); 9506 return S; 9507 } 9508 9509 /// Finds the minimum unsigned root of the following equation: 9510 /// 9511 /// A * X = B (mod N) 9512 /// 9513 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of 9514 /// A and B isn't important. 9515 /// 9516 /// If the equation does not have a solution, SCEVCouldNotCompute is returned. 9517 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const SCEV *B, 9518 ScalarEvolution &SE) { 9519 uint32_t BW = A.getBitWidth(); 9520 assert(BW == SE.getTypeSizeInBits(B->getType())); 9521 assert(A != 0 && "A must be non-zero."); 9522 9523 // 1. D = gcd(A, N) 9524 // 9525 // The gcd of A and N may have only one prime factor: 2. The number of 9526 // trailing zeros in A is its multiplicity 9527 uint32_t Mult2 = A.countTrailingZeros(); 9528 // D = 2^Mult2 9529 9530 // 2. Check if B is divisible by D. 9531 // 9532 // B is divisible by D if and only if the multiplicity of prime factor 2 for B 9533 // is not less than multiplicity of this prime factor for D. 9534 if (SE.GetMinTrailingZeros(B) < Mult2) 9535 return SE.getCouldNotCompute(); 9536 9537 // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic 9538 // modulo (N / D). 9539 // 9540 // If D == 1, (N / D) == N == 2^BW, so we need one extra bit to represent 9541 // (N / D) in general. The inverse itself always fits into BW bits, though, 9542 // so we immediately truncate it. 9543 APInt AD = A.lshr(Mult2).zext(BW + 1); // AD = A / D 9544 APInt Mod(BW + 1, 0); 9545 Mod.setBit(BW - Mult2); // Mod = N / D 9546 APInt I = AD.multiplicativeInverse(Mod).trunc(BW); 9547 9548 // 4. Compute the minimum unsigned root of the equation: 9549 // I * (B / D) mod (N / D) 9550 // To simplify the computation, we factor out the divide by D: 9551 // (I * B mod N) / D 9552 const SCEV *D = SE.getConstant(APInt::getOneBitSet(BW, Mult2)); 9553 return SE.getUDivExactExpr(SE.getMulExpr(B, SE.getConstant(I)), D); 9554 } 9555 9556 /// For a given quadratic addrec, generate coefficients of the corresponding 9557 /// quadratic equation, multiplied by a common value to ensure that they are 9558 /// integers. 9559 /// The returned value is a tuple { A, B, C, M, BitWidth }, where 9560 /// Ax^2 + Bx + C is the quadratic function, M is the value that A, B and C 9561 /// were multiplied by, and BitWidth is the bit width of the original addrec 9562 /// coefficients. 9563 /// This function returns None if the addrec coefficients are not compile- 9564 /// time constants. 9565 static Optional<std::tuple<APInt, APInt, APInt, APInt, unsigned>> 9566 GetQuadraticEquation(const SCEVAddRecExpr *AddRec) { 9567 assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!"); 9568 const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0)); 9569 const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1)); 9570 const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2)); 9571 LLVM_DEBUG(dbgs() << __func__ << ": analyzing quadratic addrec: " 9572 << *AddRec << '\n'); 9573 9574 // We currently can only solve this if the coefficients are constants. 9575 if (!LC || !MC || !NC) { 9576 LLVM_DEBUG(dbgs() << __func__ << ": coefficients are not constant\n"); 9577 return None; 9578 } 9579 9580 APInt L = LC->getAPInt(); 9581 APInt M = MC->getAPInt(); 9582 APInt N = NC->getAPInt(); 9583 assert(!N.isZero() && "This is not a quadratic addrec"); 9584 9585 unsigned BitWidth = LC->getAPInt().getBitWidth(); 9586 unsigned NewWidth = BitWidth + 1; 9587 LLVM_DEBUG(dbgs() << __func__ << ": addrec coeff bw: " 9588 << BitWidth << '\n'); 9589 // The sign-extension (as opposed to a zero-extension) here matches the 9590 // extension used in SolveQuadraticEquationWrap (with the same motivation). 9591 N = N.sext(NewWidth); 9592 M = M.sext(NewWidth); 9593 L = L.sext(NewWidth); 9594 9595 // The increments are M, M+N, M+2N, ..., so the accumulated values are 9596 // L+M, (L+M)+(M+N), (L+M)+(M+N)+(M+2N), ..., that is, 9597 // L+M, L+2M+N, L+3M+3N, ... 9598 // After n iterations the accumulated value Acc is L + nM + n(n-1)/2 N. 9599 // 9600 // The equation Acc = 0 is then 9601 // L + nM + n(n-1)/2 N = 0, or 2L + 2M n + n(n-1) N = 0. 9602 // In a quadratic form it becomes: 9603 // N n^2 + (2M-N) n + 2L = 0. 9604 9605 APInt A = N; 9606 APInt B = 2 * M - A; 9607 APInt C = 2 * L; 9608 APInt T = APInt(NewWidth, 2); 9609 LLVM_DEBUG(dbgs() << __func__ << ": equation " << A << "x^2 + " << B 9610 << "x + " << C << ", coeff bw: " << NewWidth 9611 << ", multiplied by " << T << '\n'); 9612 return std::make_tuple(A, B, C, T, BitWidth); 9613 } 9614 9615 /// Helper function to compare optional APInts: 9616 /// (a) if X and Y both exist, return min(X, Y), 9617 /// (b) if neither X nor Y exist, return None, 9618 /// (c) if exactly one of X and Y exists, return that value. 9619 static Optional<APInt> MinOptional(Optional<APInt> X, Optional<APInt> Y) { 9620 if (X.hasValue() && Y.hasValue()) { 9621 unsigned W = std::max(X->getBitWidth(), Y->getBitWidth()); 9622 APInt XW = X->sextOrSelf(W); 9623 APInt YW = Y->sextOrSelf(W); 9624 return XW.slt(YW) ? *X : *Y; 9625 } 9626 if (!X.hasValue() && !Y.hasValue()) 9627 return None; 9628 return X.hasValue() ? *X : *Y; 9629 } 9630 9631 /// Helper function to truncate an optional APInt to a given BitWidth. 9632 /// When solving addrec-related equations, it is preferable to return a value 9633 /// that has the same bit width as the original addrec's coefficients. If the 9634 /// solution fits in the original bit width, truncate it (except for i1). 9635 /// Returning a value of a different bit width may inhibit some optimizations. 9636 /// 9637 /// In general, a solution to a quadratic equation generated from an addrec 9638 /// may require BW+1 bits, where BW is the bit width of the addrec's 9639 /// coefficients. The reason is that the coefficients of the quadratic 9640 /// equation are BW+1 bits wide (to avoid truncation when converting from 9641 /// the addrec to the equation). 9642 static Optional<APInt> TruncIfPossible(Optional<APInt> X, unsigned BitWidth) { 9643 if (!X.hasValue()) 9644 return None; 9645 unsigned W = X->getBitWidth(); 9646 if (BitWidth > 1 && BitWidth < W && X->isIntN(BitWidth)) 9647 return X->trunc(BitWidth); 9648 return X; 9649 } 9650 9651 /// Let c(n) be the value of the quadratic chrec {L,+,M,+,N} after n 9652 /// iterations. The values L, M, N are assumed to be signed, and they 9653 /// should all have the same bit widths. 9654 /// Find the least n >= 0 such that c(n) = 0 in the arithmetic modulo 2^BW, 9655 /// where BW is the bit width of the addrec's coefficients. 9656 /// If the calculated value is a BW-bit integer (for BW > 1), it will be 9657 /// returned as such, otherwise the bit width of the returned value may 9658 /// be greater than BW. 9659 /// 9660 /// This function returns None if 9661 /// (a) the addrec coefficients are not constant, or 9662 /// (b) SolveQuadraticEquationWrap was unable to find a solution. For cases 9663 /// like x^2 = 5, no integer solutions exist, in other cases an integer 9664 /// solution may exist, but SolveQuadraticEquationWrap may fail to find it. 9665 static Optional<APInt> 9666 SolveQuadraticAddRecExact(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) { 9667 APInt A, B, C, M; 9668 unsigned BitWidth; 9669 auto T = GetQuadraticEquation(AddRec); 9670 if (!T.hasValue()) 9671 return None; 9672 9673 std::tie(A, B, C, M, BitWidth) = *T; 9674 LLVM_DEBUG(dbgs() << __func__ << ": solving for unsigned overflow\n"); 9675 Optional<APInt> X = APIntOps::SolveQuadraticEquationWrap(A, B, C, BitWidth+1); 9676 if (!X.hasValue()) 9677 return None; 9678 9679 ConstantInt *CX = ConstantInt::get(SE.getContext(), *X); 9680 ConstantInt *V = EvaluateConstantChrecAtConstant(AddRec, CX, SE); 9681 if (!V->isZero()) 9682 return None; 9683 9684 return TruncIfPossible(X, BitWidth); 9685 } 9686 9687 /// Let c(n) be the value of the quadratic chrec {0,+,M,+,N} after n 9688 /// iterations. The values M, N are assumed to be signed, and they 9689 /// should all have the same bit widths. 9690 /// Find the least n such that c(n) does not belong to the given range, 9691 /// while c(n-1) does. 9692 /// 9693 /// This function returns None if 9694 /// (a) the addrec coefficients are not constant, or 9695 /// (b) SolveQuadraticEquationWrap was unable to find a solution for the 9696 /// bounds of the range. 9697 static Optional<APInt> 9698 SolveQuadraticAddRecRange(const SCEVAddRecExpr *AddRec, 9699 const ConstantRange &Range, ScalarEvolution &SE) { 9700 assert(AddRec->getOperand(0)->isZero() && 9701 "Starting value of addrec should be 0"); 9702 LLVM_DEBUG(dbgs() << __func__ << ": solving boundary crossing for range " 9703 << Range << ", addrec " << *AddRec << '\n'); 9704 // This case is handled in getNumIterationsInRange. Here we can assume that 9705 // we start in the range. 9706 assert(Range.contains(APInt(SE.getTypeSizeInBits(AddRec->getType()), 0)) && 9707 "Addrec's initial value should be in range"); 9708 9709 APInt A, B, C, M; 9710 unsigned BitWidth; 9711 auto T = GetQuadraticEquation(AddRec); 9712 if (!T.hasValue()) 9713 return None; 9714 9715 // Be careful about the return value: there can be two reasons for not 9716 // returning an actual number. First, if no solutions to the equations 9717 // were found, and second, if the solutions don't leave the given range. 9718 // The first case means that the actual solution is "unknown", the second 9719 // means that it's known, but not valid. If the solution is unknown, we 9720 // cannot make any conclusions. 9721 // Return a pair: the optional solution and a flag indicating if the 9722 // solution was found. 9723 auto SolveForBoundary = [&](APInt Bound) -> std::pair<Optional<APInt>,bool> { 9724 // Solve for signed overflow and unsigned overflow, pick the lower 9725 // solution. 9726 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: checking boundary " 9727 << Bound << " (before multiplying by " << M << ")\n"); 9728 Bound *= M; // The quadratic equation multiplier. 9729 9730 Optional<APInt> SO = None; 9731 if (BitWidth > 1) { 9732 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: solving for " 9733 "signed overflow\n"); 9734 SO = APIntOps::SolveQuadraticEquationWrap(A, B, -Bound, BitWidth); 9735 } 9736 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: solving for " 9737 "unsigned overflow\n"); 9738 Optional<APInt> UO = APIntOps::SolveQuadraticEquationWrap(A, B, -Bound, 9739 BitWidth+1); 9740 9741 auto LeavesRange = [&] (const APInt &X) { 9742 ConstantInt *C0 = ConstantInt::get(SE.getContext(), X); 9743 ConstantInt *V0 = EvaluateConstantChrecAtConstant(AddRec, C0, SE); 9744 if (Range.contains(V0->getValue())) 9745 return false; 9746 // X should be at least 1, so X-1 is non-negative. 9747 ConstantInt *C1 = ConstantInt::get(SE.getContext(), X-1); 9748 ConstantInt *V1 = EvaluateConstantChrecAtConstant(AddRec, C1, SE); 9749 if (Range.contains(V1->getValue())) 9750 return true; 9751 return false; 9752 }; 9753 9754 // If SolveQuadraticEquationWrap returns None, it means that there can 9755 // be a solution, but the function failed to find it. We cannot treat it 9756 // as "no solution". 9757 if (!SO.hasValue() || !UO.hasValue()) 9758 return { None, false }; 9759 9760 // Check the smaller value first to see if it leaves the range. 9761 // At this point, both SO and UO must have values. 9762 Optional<APInt> Min = MinOptional(SO, UO); 9763 if (LeavesRange(*Min)) 9764 return { Min, true }; 9765 Optional<APInt> Max = Min == SO ? UO : SO; 9766 if (LeavesRange(*Max)) 9767 return { Max, true }; 9768 9769 // Solutions were found, but were eliminated, hence the "true". 9770 return { None, true }; 9771 }; 9772 9773 std::tie(A, B, C, M, BitWidth) = *T; 9774 // Lower bound is inclusive, subtract 1 to represent the exiting value. 9775 APInt Lower = Range.getLower().sextOrSelf(A.getBitWidth()) - 1; 9776 APInt Upper = Range.getUpper().sextOrSelf(A.getBitWidth()); 9777 auto SL = SolveForBoundary(Lower); 9778 auto SU = SolveForBoundary(Upper); 9779 // If any of the solutions was unknown, no meaninigful conclusions can 9780 // be made. 9781 if (!SL.second || !SU.second) 9782 return None; 9783 9784 // Claim: The correct solution is not some value between Min and Max. 9785 // 9786 // Justification: Assuming that Min and Max are different values, one of 9787 // them is when the first signed overflow happens, the other is when the 9788 // first unsigned overflow happens. Crossing the range boundary is only 9789 // possible via an overflow (treating 0 as a special case of it, modeling 9790 // an overflow as crossing k*2^W for some k). 9791 // 9792 // The interesting case here is when Min was eliminated as an invalid 9793 // solution, but Max was not. The argument is that if there was another 9794 // overflow between Min and Max, it would also have been eliminated if 9795 // it was considered. 9796 // 9797 // For a given boundary, it is possible to have two overflows of the same 9798 // type (signed/unsigned) without having the other type in between: this 9799 // can happen when the vertex of the parabola is between the iterations 9800 // corresponding to the overflows. This is only possible when the two 9801 // overflows cross k*2^W for the same k. In such case, if the second one 9802 // left the range (and was the first one to do so), the first overflow 9803 // would have to enter the range, which would mean that either we had left 9804 // the range before or that we started outside of it. Both of these cases 9805 // are contradictions. 9806 // 9807 // Claim: In the case where SolveForBoundary returns None, the correct 9808 // solution is not some value between the Max for this boundary and the 9809 // Min of the other boundary. 9810 // 9811 // Justification: Assume that we had such Max_A and Min_B corresponding 9812 // to range boundaries A and B and such that Max_A < Min_B. If there was 9813 // a solution between Max_A and Min_B, it would have to be caused by an 9814 // overflow corresponding to either A or B. It cannot correspond to B, 9815 // since Min_B is the first occurrence of such an overflow. If it 9816 // corresponded to A, it would have to be either a signed or an unsigned 9817 // overflow that is larger than both eliminated overflows for A. But 9818 // between the eliminated overflows and this overflow, the values would 9819 // cover the entire value space, thus crossing the other boundary, which 9820 // is a contradiction. 9821 9822 return TruncIfPossible(MinOptional(SL.first, SU.first), BitWidth); 9823 } 9824 9825 ScalarEvolution::ExitLimit 9826 ScalarEvolution::howFarToZero(const SCEV *V, const Loop *L, bool ControlsExit, 9827 bool AllowPredicates) { 9828 9829 // This is only used for loops with a "x != y" exit test. The exit condition 9830 // is now expressed as a single expression, V = x-y. So the exit test is 9831 // effectively V != 0. We know and take advantage of the fact that this 9832 // expression only being used in a comparison by zero context. 9833 9834 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 9835 // If the value is a constant 9836 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) { 9837 // If the value is already zero, the branch will execute zero times. 9838 if (C->getValue()->isZero()) return C; 9839 return getCouldNotCompute(); // Otherwise it will loop infinitely. 9840 } 9841 9842 const SCEVAddRecExpr *AddRec = 9843 dyn_cast<SCEVAddRecExpr>(stripInjectiveFunctions(V)); 9844 9845 if (!AddRec && AllowPredicates) 9846 // Try to make this an AddRec using runtime tests, in the first X 9847 // iterations of this loop, where X is the SCEV expression found by the 9848 // algorithm below. 9849 AddRec = convertSCEVToAddRecWithPredicates(V, L, Predicates); 9850 9851 if (!AddRec || AddRec->getLoop() != L) 9852 return getCouldNotCompute(); 9853 9854 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of 9855 // the quadratic equation to solve it. 9856 if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) { 9857 // We can only use this value if the chrec ends up with an exact zero 9858 // value at this index. When solving for "X*X != 5", for example, we 9859 // should not accept a root of 2. 9860 if (auto S = SolveQuadraticAddRecExact(AddRec, *this)) { 9861 const auto *R = cast<SCEVConstant>(getConstant(S.getValue())); 9862 return ExitLimit(R, R, false, Predicates); 9863 } 9864 return getCouldNotCompute(); 9865 } 9866 9867 // Otherwise we can only handle this if it is affine. 9868 if (!AddRec->isAffine()) 9869 return getCouldNotCompute(); 9870 9871 // If this is an affine expression, the execution count of this branch is 9872 // the minimum unsigned root of the following equation: 9873 // 9874 // Start + Step*N = 0 (mod 2^BW) 9875 // 9876 // equivalent to: 9877 // 9878 // Step*N = -Start (mod 2^BW) 9879 // 9880 // where BW is the common bit width of Start and Step. 9881 9882 // Get the initial value for the loop. 9883 const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop()); 9884 const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop()); 9885 9886 // For now we handle only constant steps. 9887 // 9888 // TODO: Handle a nonconstant Step given AddRec<NUW>. If the 9889 // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap 9890 // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step. 9891 // We have not yet seen any such cases. 9892 const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step); 9893 if (!StepC || StepC->getValue()->isZero()) 9894 return getCouldNotCompute(); 9895 9896 // For positive steps (counting up until unsigned overflow): 9897 // N = -Start/Step (as unsigned) 9898 // For negative steps (counting down to zero): 9899 // N = Start/-Step 9900 // First compute the unsigned distance from zero in the direction of Step. 9901 bool CountDown = StepC->getAPInt().isNegative(); 9902 const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start); 9903 9904 // Handle unitary steps, which cannot wraparound. 9905 // 1*N = -Start; -1*N = Start (mod 2^BW), so: 9906 // N = Distance (as unsigned) 9907 if (StepC->getValue()->isOne() || StepC->getValue()->isMinusOne()) { 9908 APInt MaxBECount = getUnsignedRangeMax(applyLoopGuards(Distance, L)); 9909 MaxBECount = APIntOps::umin(MaxBECount, getUnsignedRangeMax(Distance)); 9910 9911 // When a loop like "for (int i = 0; i != n; ++i) { /* body */ }" is rotated, 9912 // we end up with a loop whose backedge-taken count is n - 1. Detect this 9913 // case, and see if we can improve the bound. 9914 // 9915 // Explicitly handling this here is necessary because getUnsignedRange 9916 // isn't context-sensitive; it doesn't know that we only care about the 9917 // range inside the loop. 9918 const SCEV *Zero = getZero(Distance->getType()); 9919 const SCEV *One = getOne(Distance->getType()); 9920 const SCEV *DistancePlusOne = getAddExpr(Distance, One); 9921 if (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_NE, DistancePlusOne, Zero)) { 9922 // If Distance + 1 doesn't overflow, we can compute the maximum distance 9923 // as "unsigned_max(Distance + 1) - 1". 9924 ConstantRange CR = getUnsignedRange(DistancePlusOne); 9925 MaxBECount = APIntOps::umin(MaxBECount, CR.getUnsignedMax() - 1); 9926 } 9927 return ExitLimit(Distance, getConstant(MaxBECount), false, Predicates); 9928 } 9929 9930 // If the condition controls loop exit (the loop exits only if the expression 9931 // is true) and the addition is no-wrap we can use unsigned divide to 9932 // compute the backedge count. In this case, the step may not divide the 9933 // distance, but we don't care because if the condition is "missed" the loop 9934 // will have undefined behavior due to wrapping. 9935 if (ControlsExit && AddRec->hasNoSelfWrap() && 9936 loopHasNoAbnormalExits(AddRec->getLoop())) { 9937 const SCEV *Exact = 9938 getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step); 9939 const SCEV *Max = getCouldNotCompute(); 9940 if (Exact != getCouldNotCompute()) { 9941 APInt MaxInt = getUnsignedRangeMax(applyLoopGuards(Exact, L)); 9942 Max = getConstant(APIntOps::umin(MaxInt, getUnsignedRangeMax(Exact))); 9943 } 9944 return ExitLimit(Exact, Max, false, Predicates); 9945 } 9946 9947 // Solve the general equation. 9948 const SCEV *E = SolveLinEquationWithOverflow(StepC->getAPInt(), 9949 getNegativeSCEV(Start), *this); 9950 9951 const SCEV *M = E; 9952 if (E != getCouldNotCompute()) { 9953 APInt MaxWithGuards = getUnsignedRangeMax(applyLoopGuards(E, L)); 9954 M = getConstant(APIntOps::umin(MaxWithGuards, getUnsignedRangeMax(E))); 9955 } 9956 return ExitLimit(E, M, false, Predicates); 9957 } 9958 9959 ScalarEvolution::ExitLimit 9960 ScalarEvolution::howFarToNonZero(const SCEV *V, const Loop *L) { 9961 // Loops that look like: while (X == 0) are very strange indeed. We don't 9962 // handle them yet except for the trivial case. This could be expanded in the 9963 // future as needed. 9964 9965 // If the value is a constant, check to see if it is known to be non-zero 9966 // already. If so, the backedge will execute zero times. 9967 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) { 9968 if (!C->getValue()->isZero()) 9969 return getZero(C->getType()); 9970 return getCouldNotCompute(); // Otherwise it will loop infinitely. 9971 } 9972 9973 // We could implement others, but I really doubt anyone writes loops like 9974 // this, and if they did, they would already be constant folded. 9975 return getCouldNotCompute(); 9976 } 9977 9978 std::pair<const BasicBlock *, const BasicBlock *> 9979 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(const BasicBlock *BB) 9980 const { 9981 // If the block has a unique predecessor, then there is no path from the 9982 // predecessor to the block that does not go through the direct edge 9983 // from the predecessor to the block. 9984 if (const BasicBlock *Pred = BB->getSinglePredecessor()) 9985 return {Pred, BB}; 9986 9987 // A loop's header is defined to be a block that dominates the loop. 9988 // If the header has a unique predecessor outside the loop, it must be 9989 // a block that has exactly one successor that can reach the loop. 9990 if (const Loop *L = LI.getLoopFor(BB)) 9991 return {L->getLoopPredecessor(), L->getHeader()}; 9992 9993 return {nullptr, nullptr}; 9994 } 9995 9996 /// SCEV structural equivalence is usually sufficient for testing whether two 9997 /// expressions are equal, however for the purposes of looking for a condition 9998 /// guarding a loop, it can be useful to be a little more general, since a 9999 /// front-end may have replicated the controlling expression. 10000 static bool HasSameValue(const SCEV *A, const SCEV *B) { 10001 // Quick check to see if they are the same SCEV. 10002 if (A == B) return true; 10003 10004 auto ComputesEqualValues = [](const Instruction *A, const Instruction *B) { 10005 // Not all instructions that are "identical" compute the same value. For 10006 // instance, two distinct alloca instructions allocating the same type are 10007 // identical and do not read memory; but compute distinct values. 10008 return A->isIdenticalTo(B) && (isa<BinaryOperator>(A) || isa<GetElementPtrInst>(A)); 10009 }; 10010 10011 // Otherwise, if they're both SCEVUnknown, it's possible that they hold 10012 // two different instructions with the same value. Check for this case. 10013 if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A)) 10014 if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B)) 10015 if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue())) 10016 if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue())) 10017 if (ComputesEqualValues(AI, BI)) 10018 return true; 10019 10020 // Otherwise assume they may have a different value. 10021 return false; 10022 } 10023 10024 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred, 10025 const SCEV *&LHS, const SCEV *&RHS, 10026 unsigned Depth, 10027 bool ControllingFiniteLoop) { 10028 bool Changed = false; 10029 // Simplifies ICMP to trivial true or false by turning it into '0 == 0' or 10030 // '0 != 0'. 10031 auto TrivialCase = [&](bool TriviallyTrue) { 10032 LHS = RHS = getConstant(ConstantInt::getFalse(getContext())); 10033 Pred = TriviallyTrue ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE; 10034 return true; 10035 }; 10036 // If we hit the max recursion limit bail out. 10037 if (Depth >= 3) 10038 return false; 10039 10040 // Canonicalize a constant to the right side. 10041 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) { 10042 // Check for both operands constant. 10043 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 10044 if (ConstantExpr::getICmp(Pred, 10045 LHSC->getValue(), 10046 RHSC->getValue())->isNullValue()) 10047 return TrivialCase(false); 10048 else 10049 return TrivialCase(true); 10050 } 10051 // Otherwise swap the operands to put the constant on the right. 10052 std::swap(LHS, RHS); 10053 Pred = ICmpInst::getSwappedPredicate(Pred); 10054 Changed = true; 10055 } 10056 10057 // If we're comparing an addrec with a value which is loop-invariant in the 10058 // addrec's loop, put the addrec on the left. Also make a dominance check, 10059 // as both operands could be addrecs loop-invariant in each other's loop. 10060 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) { 10061 const Loop *L = AR->getLoop(); 10062 if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) { 10063 std::swap(LHS, RHS); 10064 Pred = ICmpInst::getSwappedPredicate(Pred); 10065 Changed = true; 10066 } 10067 } 10068 10069 // If there's a constant operand, canonicalize comparisons with boundary 10070 // cases, and canonicalize *-or-equal comparisons to regular comparisons. 10071 if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) { 10072 const APInt &RA = RC->getAPInt(); 10073 10074 bool SimplifiedByConstantRange = false; 10075 10076 if (!ICmpInst::isEquality(Pred)) { 10077 ConstantRange ExactCR = ConstantRange::makeExactICmpRegion(Pred, RA); 10078 if (ExactCR.isFullSet()) 10079 return TrivialCase(true); 10080 else if (ExactCR.isEmptySet()) 10081 return TrivialCase(false); 10082 10083 APInt NewRHS; 10084 CmpInst::Predicate NewPred; 10085 if (ExactCR.getEquivalentICmp(NewPred, NewRHS) && 10086 ICmpInst::isEquality(NewPred)) { 10087 // We were able to convert an inequality to an equality. 10088 Pred = NewPred; 10089 RHS = getConstant(NewRHS); 10090 Changed = SimplifiedByConstantRange = true; 10091 } 10092 } 10093 10094 if (!SimplifiedByConstantRange) { 10095 switch (Pred) { 10096 default: 10097 break; 10098 case ICmpInst::ICMP_EQ: 10099 case ICmpInst::ICMP_NE: 10100 // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b. 10101 if (!RA) 10102 if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS)) 10103 if (const SCEVMulExpr *ME = 10104 dyn_cast<SCEVMulExpr>(AE->getOperand(0))) 10105 if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 && 10106 ME->getOperand(0)->isAllOnesValue()) { 10107 RHS = AE->getOperand(1); 10108 LHS = ME->getOperand(1); 10109 Changed = true; 10110 } 10111 break; 10112 10113 10114 // The "Should have been caught earlier!" messages refer to the fact 10115 // that the ExactCR.isFullSet() or ExactCR.isEmptySet() check above 10116 // should have fired on the corresponding cases, and canonicalized the 10117 // check to trivial case. 10118 10119 case ICmpInst::ICMP_UGE: 10120 assert(!RA.isMinValue() && "Should have been caught earlier!"); 10121 Pred = ICmpInst::ICMP_UGT; 10122 RHS = getConstant(RA - 1); 10123 Changed = true; 10124 break; 10125 case ICmpInst::ICMP_ULE: 10126 assert(!RA.isMaxValue() && "Should have been caught earlier!"); 10127 Pred = ICmpInst::ICMP_ULT; 10128 RHS = getConstant(RA + 1); 10129 Changed = true; 10130 break; 10131 case ICmpInst::ICMP_SGE: 10132 assert(!RA.isMinSignedValue() && "Should have been caught earlier!"); 10133 Pred = ICmpInst::ICMP_SGT; 10134 RHS = getConstant(RA - 1); 10135 Changed = true; 10136 break; 10137 case ICmpInst::ICMP_SLE: 10138 assert(!RA.isMaxSignedValue() && "Should have been caught earlier!"); 10139 Pred = ICmpInst::ICMP_SLT; 10140 RHS = getConstant(RA + 1); 10141 Changed = true; 10142 break; 10143 } 10144 } 10145 } 10146 10147 // Check for obvious equality. 10148 if (HasSameValue(LHS, RHS)) { 10149 if (ICmpInst::isTrueWhenEqual(Pred)) 10150 return TrivialCase(true); 10151 if (ICmpInst::isFalseWhenEqual(Pred)) 10152 return TrivialCase(false); 10153 } 10154 10155 // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by 10156 // adding or subtracting 1 from one of the operands. This can be done for 10157 // one of two reasons: 10158 // 1) The range of the RHS does not include the (signed/unsigned) boundaries 10159 // 2) The loop is finite, with this comparison controlling the exit. Since the 10160 // loop is finite, the bound cannot include the corresponding boundary 10161 // (otherwise it would loop forever). 10162 switch (Pred) { 10163 case ICmpInst::ICMP_SLE: 10164 if (ControllingFiniteLoop || !getSignedRangeMax(RHS).isMaxSignedValue()) { 10165 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS, 10166 SCEV::FlagNSW); 10167 Pred = ICmpInst::ICMP_SLT; 10168 Changed = true; 10169 } else if (!getSignedRangeMin(LHS).isMinSignedValue()) { 10170 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS, 10171 SCEV::FlagNSW); 10172 Pred = ICmpInst::ICMP_SLT; 10173 Changed = true; 10174 } 10175 break; 10176 case ICmpInst::ICMP_SGE: 10177 if (ControllingFiniteLoop || !getSignedRangeMin(RHS).isMinSignedValue()) { 10178 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS, 10179 SCEV::FlagNSW); 10180 Pred = ICmpInst::ICMP_SGT; 10181 Changed = true; 10182 } else if (!getSignedRangeMax(LHS).isMaxSignedValue()) { 10183 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS, 10184 SCEV::FlagNSW); 10185 Pred = ICmpInst::ICMP_SGT; 10186 Changed = true; 10187 } 10188 break; 10189 case ICmpInst::ICMP_ULE: 10190 if (ControllingFiniteLoop || !getUnsignedRangeMax(RHS).isMaxValue()) { 10191 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS, 10192 SCEV::FlagNUW); 10193 Pred = ICmpInst::ICMP_ULT; 10194 Changed = true; 10195 } else if (!getUnsignedRangeMin(LHS).isMinValue()) { 10196 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS); 10197 Pred = ICmpInst::ICMP_ULT; 10198 Changed = true; 10199 } 10200 break; 10201 case ICmpInst::ICMP_UGE: 10202 if (ControllingFiniteLoop || !getUnsignedRangeMin(RHS).isMinValue()) { 10203 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS); 10204 Pred = ICmpInst::ICMP_UGT; 10205 Changed = true; 10206 } else if (!getUnsignedRangeMax(LHS).isMaxValue()) { 10207 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS, 10208 SCEV::FlagNUW); 10209 Pred = ICmpInst::ICMP_UGT; 10210 Changed = true; 10211 } 10212 break; 10213 default: 10214 break; 10215 } 10216 10217 // TODO: More simplifications are possible here. 10218 10219 // Recursively simplify until we either hit a recursion limit or nothing 10220 // changes. 10221 if (Changed) 10222 return SimplifyICmpOperands(Pred, LHS, RHS, Depth + 1, 10223 ControllingFiniteLoop); 10224 10225 return Changed; 10226 } 10227 10228 bool ScalarEvolution::isKnownNegative(const SCEV *S) { 10229 return getSignedRangeMax(S).isNegative(); 10230 } 10231 10232 bool ScalarEvolution::isKnownPositive(const SCEV *S) { 10233 return getSignedRangeMin(S).isStrictlyPositive(); 10234 } 10235 10236 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) { 10237 return !getSignedRangeMin(S).isNegative(); 10238 } 10239 10240 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) { 10241 return !getSignedRangeMax(S).isStrictlyPositive(); 10242 } 10243 10244 bool ScalarEvolution::isKnownNonZero(const SCEV *S) { 10245 return getUnsignedRangeMin(S) != 0; 10246 } 10247 10248 std::pair<const SCEV *, const SCEV *> 10249 ScalarEvolution::SplitIntoInitAndPostInc(const Loop *L, const SCEV *S) { 10250 // Compute SCEV on entry of loop L. 10251 const SCEV *Start = SCEVInitRewriter::rewrite(S, L, *this); 10252 if (Start == getCouldNotCompute()) 10253 return { Start, Start }; 10254 // Compute post increment SCEV for loop L. 10255 const SCEV *PostInc = SCEVPostIncRewriter::rewrite(S, L, *this); 10256 assert(PostInc != getCouldNotCompute() && "Unexpected could not compute"); 10257 return { Start, PostInc }; 10258 } 10259 10260 bool ScalarEvolution::isKnownViaInduction(ICmpInst::Predicate Pred, 10261 const SCEV *LHS, const SCEV *RHS) { 10262 // First collect all loops. 10263 SmallPtrSet<const Loop *, 8> LoopsUsed; 10264 getUsedLoops(LHS, LoopsUsed); 10265 getUsedLoops(RHS, LoopsUsed); 10266 10267 if (LoopsUsed.empty()) 10268 return false; 10269 10270 // Domination relationship must be a linear order on collected loops. 10271 #ifndef NDEBUG 10272 for (auto *L1 : LoopsUsed) 10273 for (auto *L2 : LoopsUsed) 10274 assert((DT.dominates(L1->getHeader(), L2->getHeader()) || 10275 DT.dominates(L2->getHeader(), L1->getHeader())) && 10276 "Domination relationship is not a linear order"); 10277 #endif 10278 10279 const Loop *MDL = 10280 *std::max_element(LoopsUsed.begin(), LoopsUsed.end(), 10281 [&](const Loop *L1, const Loop *L2) { 10282 return DT.properlyDominates(L1->getHeader(), L2->getHeader()); 10283 }); 10284 10285 // Get init and post increment value for LHS. 10286 auto SplitLHS = SplitIntoInitAndPostInc(MDL, LHS); 10287 // if LHS contains unknown non-invariant SCEV then bail out. 10288 if (SplitLHS.first == getCouldNotCompute()) 10289 return false; 10290 assert (SplitLHS.second != getCouldNotCompute() && "Unexpected CNC"); 10291 // Get init and post increment value for RHS. 10292 auto SplitRHS = SplitIntoInitAndPostInc(MDL, RHS); 10293 // if RHS contains unknown non-invariant SCEV then bail out. 10294 if (SplitRHS.first == getCouldNotCompute()) 10295 return false; 10296 assert (SplitRHS.second != getCouldNotCompute() && "Unexpected CNC"); 10297 // It is possible that init SCEV contains an invariant load but it does 10298 // not dominate MDL and is not available at MDL loop entry, so we should 10299 // check it here. 10300 if (!isAvailableAtLoopEntry(SplitLHS.first, MDL) || 10301 !isAvailableAtLoopEntry(SplitRHS.first, MDL)) 10302 return false; 10303 10304 // It seems backedge guard check is faster than entry one so in some cases 10305 // it can speed up whole estimation by short circuit 10306 return isLoopBackedgeGuardedByCond(MDL, Pred, SplitLHS.second, 10307 SplitRHS.second) && 10308 isLoopEntryGuardedByCond(MDL, Pred, SplitLHS.first, SplitRHS.first); 10309 } 10310 10311 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred, 10312 const SCEV *LHS, const SCEV *RHS) { 10313 // Canonicalize the inputs first. 10314 (void)SimplifyICmpOperands(Pred, LHS, RHS); 10315 10316 if (isKnownViaInduction(Pred, LHS, RHS)) 10317 return true; 10318 10319 if (isKnownPredicateViaSplitting(Pred, LHS, RHS)) 10320 return true; 10321 10322 // Otherwise see what can be done with some simple reasoning. 10323 return isKnownViaNonRecursiveReasoning(Pred, LHS, RHS); 10324 } 10325 10326 Optional<bool> ScalarEvolution::evaluatePredicate(ICmpInst::Predicate Pred, 10327 const SCEV *LHS, 10328 const SCEV *RHS) { 10329 if (isKnownPredicate(Pred, LHS, RHS)) 10330 return true; 10331 else if (isKnownPredicate(ICmpInst::getInversePredicate(Pred), LHS, RHS)) 10332 return false; 10333 return None; 10334 } 10335 10336 bool ScalarEvolution::isKnownPredicateAt(ICmpInst::Predicate Pred, 10337 const SCEV *LHS, const SCEV *RHS, 10338 const Instruction *CtxI) { 10339 // TODO: Analyze guards and assumes from Context's block. 10340 return isKnownPredicate(Pred, LHS, RHS) || 10341 isBasicBlockEntryGuardedByCond(CtxI->getParent(), Pred, LHS, RHS); 10342 } 10343 10344 Optional<bool> ScalarEvolution::evaluatePredicateAt(ICmpInst::Predicate Pred, 10345 const SCEV *LHS, 10346 const SCEV *RHS, 10347 const Instruction *CtxI) { 10348 Optional<bool> KnownWithoutContext = evaluatePredicate(Pred, LHS, RHS); 10349 if (KnownWithoutContext) 10350 return KnownWithoutContext; 10351 10352 if (isBasicBlockEntryGuardedByCond(CtxI->getParent(), Pred, LHS, RHS)) 10353 return true; 10354 else if (isBasicBlockEntryGuardedByCond(CtxI->getParent(), 10355 ICmpInst::getInversePredicate(Pred), 10356 LHS, RHS)) 10357 return false; 10358 return None; 10359 } 10360 10361 bool ScalarEvolution::isKnownOnEveryIteration(ICmpInst::Predicate Pred, 10362 const SCEVAddRecExpr *LHS, 10363 const SCEV *RHS) { 10364 const Loop *L = LHS->getLoop(); 10365 return isLoopEntryGuardedByCond(L, Pred, LHS->getStart(), RHS) && 10366 isLoopBackedgeGuardedByCond(L, Pred, LHS->getPostIncExpr(*this), RHS); 10367 } 10368 10369 Optional<ScalarEvolution::MonotonicPredicateType> 10370 ScalarEvolution::getMonotonicPredicateType(const SCEVAddRecExpr *LHS, 10371 ICmpInst::Predicate Pred) { 10372 auto Result = getMonotonicPredicateTypeImpl(LHS, Pred); 10373 10374 #ifndef NDEBUG 10375 // Verify an invariant: inverting the predicate should turn a monotonically 10376 // increasing change to a monotonically decreasing one, and vice versa. 10377 if (Result) { 10378 auto ResultSwapped = 10379 getMonotonicPredicateTypeImpl(LHS, ICmpInst::getSwappedPredicate(Pred)); 10380 10381 assert(ResultSwapped.hasValue() && "should be able to analyze both!"); 10382 assert(ResultSwapped.getValue() != Result.getValue() && 10383 "monotonicity should flip as we flip the predicate"); 10384 } 10385 #endif 10386 10387 return Result; 10388 } 10389 10390 Optional<ScalarEvolution::MonotonicPredicateType> 10391 ScalarEvolution::getMonotonicPredicateTypeImpl(const SCEVAddRecExpr *LHS, 10392 ICmpInst::Predicate Pred) { 10393 // A zero step value for LHS means the induction variable is essentially a 10394 // loop invariant value. We don't really depend on the predicate actually 10395 // flipping from false to true (for increasing predicates, and the other way 10396 // around for decreasing predicates), all we care about is that *if* the 10397 // predicate changes then it only changes from false to true. 10398 // 10399 // A zero step value in itself is not very useful, but there may be places 10400 // where SCEV can prove X >= 0 but not prove X > 0, so it is helpful to be 10401 // as general as possible. 10402 10403 // Only handle LE/LT/GE/GT predicates. 10404 if (!ICmpInst::isRelational(Pred)) 10405 return None; 10406 10407 bool IsGreater = ICmpInst::isGE(Pred) || ICmpInst::isGT(Pred); 10408 assert((IsGreater || ICmpInst::isLE(Pred) || ICmpInst::isLT(Pred)) && 10409 "Should be greater or less!"); 10410 10411 // Check that AR does not wrap. 10412 if (ICmpInst::isUnsigned(Pred)) { 10413 if (!LHS->hasNoUnsignedWrap()) 10414 return None; 10415 return IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 10416 } else { 10417 assert(ICmpInst::isSigned(Pred) && 10418 "Relational predicate is either signed or unsigned!"); 10419 if (!LHS->hasNoSignedWrap()) 10420 return None; 10421 10422 const SCEV *Step = LHS->getStepRecurrence(*this); 10423 10424 if (isKnownNonNegative(Step)) 10425 return IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 10426 10427 if (isKnownNonPositive(Step)) 10428 return !IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 10429 10430 return None; 10431 } 10432 } 10433 10434 Optional<ScalarEvolution::LoopInvariantPredicate> 10435 ScalarEvolution::getLoopInvariantPredicate(ICmpInst::Predicate Pred, 10436 const SCEV *LHS, const SCEV *RHS, 10437 const Loop *L) { 10438 10439 // If there is a loop-invariant, force it into the RHS, otherwise bail out. 10440 if (!isLoopInvariant(RHS, L)) { 10441 if (!isLoopInvariant(LHS, L)) 10442 return None; 10443 10444 std::swap(LHS, RHS); 10445 Pred = ICmpInst::getSwappedPredicate(Pred); 10446 } 10447 10448 const SCEVAddRecExpr *ArLHS = dyn_cast<SCEVAddRecExpr>(LHS); 10449 if (!ArLHS || ArLHS->getLoop() != L) 10450 return None; 10451 10452 auto MonotonicType = getMonotonicPredicateType(ArLHS, Pred); 10453 if (!MonotonicType) 10454 return None; 10455 // If the predicate "ArLHS `Pred` RHS" monotonically increases from false to 10456 // true as the loop iterates, and the backedge is control dependent on 10457 // "ArLHS `Pred` RHS" == true then we can reason as follows: 10458 // 10459 // * if the predicate was false in the first iteration then the predicate 10460 // is never evaluated again, since the loop exits without taking the 10461 // backedge. 10462 // * if the predicate was true in the first iteration then it will 10463 // continue to be true for all future iterations since it is 10464 // monotonically increasing. 10465 // 10466 // For both the above possibilities, we can replace the loop varying 10467 // predicate with its value on the first iteration of the loop (which is 10468 // loop invariant). 10469 // 10470 // A similar reasoning applies for a monotonically decreasing predicate, by 10471 // replacing true with false and false with true in the above two bullets. 10472 bool Increasing = *MonotonicType == ScalarEvolution::MonotonicallyIncreasing; 10473 auto P = Increasing ? Pred : ICmpInst::getInversePredicate(Pred); 10474 10475 if (!isLoopBackedgeGuardedByCond(L, P, LHS, RHS)) 10476 return None; 10477 10478 return ScalarEvolution::LoopInvariantPredicate(Pred, ArLHS->getStart(), RHS); 10479 } 10480 10481 Optional<ScalarEvolution::LoopInvariantPredicate> 10482 ScalarEvolution::getLoopInvariantExitCondDuringFirstIterations( 10483 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, const Loop *L, 10484 const Instruction *CtxI, const SCEV *MaxIter) { 10485 // Try to prove the following set of facts: 10486 // - The predicate is monotonic in the iteration space. 10487 // - If the check does not fail on the 1st iteration: 10488 // - No overflow will happen during first MaxIter iterations; 10489 // - It will not fail on the MaxIter'th iteration. 10490 // If the check does fail on the 1st iteration, we leave the loop and no 10491 // other checks matter. 10492 10493 // If there is a loop-invariant, force it into the RHS, otherwise bail out. 10494 if (!isLoopInvariant(RHS, L)) { 10495 if (!isLoopInvariant(LHS, L)) 10496 return None; 10497 10498 std::swap(LHS, RHS); 10499 Pred = ICmpInst::getSwappedPredicate(Pred); 10500 } 10501 10502 auto *AR = dyn_cast<SCEVAddRecExpr>(LHS); 10503 if (!AR || AR->getLoop() != L) 10504 return None; 10505 10506 // The predicate must be relational (i.e. <, <=, >=, >). 10507 if (!ICmpInst::isRelational(Pred)) 10508 return None; 10509 10510 // TODO: Support steps other than +/- 1. 10511 const SCEV *Step = AR->getStepRecurrence(*this); 10512 auto *One = getOne(Step->getType()); 10513 auto *MinusOne = getNegativeSCEV(One); 10514 if (Step != One && Step != MinusOne) 10515 return None; 10516 10517 // Type mismatch here means that MaxIter is potentially larger than max 10518 // unsigned value in start type, which mean we cannot prove no wrap for the 10519 // indvar. 10520 if (AR->getType() != MaxIter->getType()) 10521 return None; 10522 10523 // Value of IV on suggested last iteration. 10524 const SCEV *Last = AR->evaluateAtIteration(MaxIter, *this); 10525 // Does it still meet the requirement? 10526 if (!isLoopBackedgeGuardedByCond(L, Pred, Last, RHS)) 10527 return None; 10528 // Because step is +/- 1 and MaxIter has same type as Start (i.e. it does 10529 // not exceed max unsigned value of this type), this effectively proves 10530 // that there is no wrap during the iteration. To prove that there is no 10531 // signed/unsigned wrap, we need to check that 10532 // Start <= Last for step = 1 or Start >= Last for step = -1. 10533 ICmpInst::Predicate NoOverflowPred = 10534 CmpInst::isSigned(Pred) ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 10535 if (Step == MinusOne) 10536 NoOverflowPred = CmpInst::getSwappedPredicate(NoOverflowPred); 10537 const SCEV *Start = AR->getStart(); 10538 if (!isKnownPredicateAt(NoOverflowPred, Start, Last, CtxI)) 10539 return None; 10540 10541 // Everything is fine. 10542 return ScalarEvolution::LoopInvariantPredicate(Pred, Start, RHS); 10543 } 10544 10545 bool ScalarEvolution::isKnownPredicateViaConstantRanges( 10546 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) { 10547 if (HasSameValue(LHS, RHS)) 10548 return ICmpInst::isTrueWhenEqual(Pred); 10549 10550 // This code is split out from isKnownPredicate because it is called from 10551 // within isLoopEntryGuardedByCond. 10552 10553 auto CheckRanges = [&](const ConstantRange &RangeLHS, 10554 const ConstantRange &RangeRHS) { 10555 return RangeLHS.icmp(Pred, RangeRHS); 10556 }; 10557 10558 // The check at the top of the function catches the case where the values are 10559 // known to be equal. 10560 if (Pred == CmpInst::ICMP_EQ) 10561 return false; 10562 10563 if (Pred == CmpInst::ICMP_NE) { 10564 if (CheckRanges(getSignedRange(LHS), getSignedRange(RHS)) || 10565 CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS))) 10566 return true; 10567 auto *Diff = getMinusSCEV(LHS, RHS); 10568 return !isa<SCEVCouldNotCompute>(Diff) && isKnownNonZero(Diff); 10569 } 10570 10571 if (CmpInst::isSigned(Pred)) 10572 return CheckRanges(getSignedRange(LHS), getSignedRange(RHS)); 10573 10574 return CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS)); 10575 } 10576 10577 bool ScalarEvolution::isKnownPredicateViaNoOverflow(ICmpInst::Predicate Pred, 10578 const SCEV *LHS, 10579 const SCEV *RHS) { 10580 // Match X to (A + C1)<ExpectedFlags> and Y to (A + C2)<ExpectedFlags>, where 10581 // C1 and C2 are constant integers. If either X or Y are not add expressions, 10582 // consider them as X + 0 and Y + 0 respectively. C1 and C2 are returned via 10583 // OutC1 and OutC2. 10584 auto MatchBinaryAddToConst = [this](const SCEV *X, const SCEV *Y, 10585 APInt &OutC1, APInt &OutC2, 10586 SCEV::NoWrapFlags ExpectedFlags) { 10587 const SCEV *XNonConstOp, *XConstOp; 10588 const SCEV *YNonConstOp, *YConstOp; 10589 SCEV::NoWrapFlags XFlagsPresent; 10590 SCEV::NoWrapFlags YFlagsPresent; 10591 10592 if (!splitBinaryAdd(X, XConstOp, XNonConstOp, XFlagsPresent)) { 10593 XConstOp = getZero(X->getType()); 10594 XNonConstOp = X; 10595 XFlagsPresent = ExpectedFlags; 10596 } 10597 if (!isa<SCEVConstant>(XConstOp) || 10598 (XFlagsPresent & ExpectedFlags) != ExpectedFlags) 10599 return false; 10600 10601 if (!splitBinaryAdd(Y, YConstOp, YNonConstOp, YFlagsPresent)) { 10602 YConstOp = getZero(Y->getType()); 10603 YNonConstOp = Y; 10604 YFlagsPresent = ExpectedFlags; 10605 } 10606 10607 if (!isa<SCEVConstant>(YConstOp) || 10608 (YFlagsPresent & ExpectedFlags) != ExpectedFlags) 10609 return false; 10610 10611 if (YNonConstOp != XNonConstOp) 10612 return false; 10613 10614 OutC1 = cast<SCEVConstant>(XConstOp)->getAPInt(); 10615 OutC2 = cast<SCEVConstant>(YConstOp)->getAPInt(); 10616 10617 return true; 10618 }; 10619 10620 APInt C1; 10621 APInt C2; 10622 10623 switch (Pred) { 10624 default: 10625 break; 10626 10627 case ICmpInst::ICMP_SGE: 10628 std::swap(LHS, RHS); 10629 LLVM_FALLTHROUGH; 10630 case ICmpInst::ICMP_SLE: 10631 // (X + C1)<nsw> s<= (X + C2)<nsw> if C1 s<= C2. 10632 if (MatchBinaryAddToConst(LHS, RHS, C1, C2, SCEV::FlagNSW) && C1.sle(C2)) 10633 return true; 10634 10635 break; 10636 10637 case ICmpInst::ICMP_SGT: 10638 std::swap(LHS, RHS); 10639 LLVM_FALLTHROUGH; 10640 case ICmpInst::ICMP_SLT: 10641 // (X + C1)<nsw> s< (X + C2)<nsw> if C1 s< C2. 10642 if (MatchBinaryAddToConst(LHS, RHS, C1, C2, SCEV::FlagNSW) && C1.slt(C2)) 10643 return true; 10644 10645 break; 10646 10647 case ICmpInst::ICMP_UGE: 10648 std::swap(LHS, RHS); 10649 LLVM_FALLTHROUGH; 10650 case ICmpInst::ICMP_ULE: 10651 // (X + C1)<nuw> u<= (X + C2)<nuw> for C1 u<= C2. 10652 if (MatchBinaryAddToConst(RHS, LHS, C2, C1, SCEV::FlagNUW) && C1.ule(C2)) 10653 return true; 10654 10655 break; 10656 10657 case ICmpInst::ICMP_UGT: 10658 std::swap(LHS, RHS); 10659 LLVM_FALLTHROUGH; 10660 case ICmpInst::ICMP_ULT: 10661 // (X + C1)<nuw> u< (X + C2)<nuw> if C1 u< C2. 10662 if (MatchBinaryAddToConst(RHS, LHS, C2, C1, SCEV::FlagNUW) && C1.ult(C2)) 10663 return true; 10664 break; 10665 } 10666 10667 return false; 10668 } 10669 10670 bool ScalarEvolution::isKnownPredicateViaSplitting(ICmpInst::Predicate Pred, 10671 const SCEV *LHS, 10672 const SCEV *RHS) { 10673 if (Pred != ICmpInst::ICMP_ULT || ProvingSplitPredicate) 10674 return false; 10675 10676 // Allowing arbitrary number of activations of isKnownPredicateViaSplitting on 10677 // the stack can result in exponential time complexity. 10678 SaveAndRestore<bool> Restore(ProvingSplitPredicate, true); 10679 10680 // If L >= 0 then I `ult` L <=> I >= 0 && I `slt` L 10681 // 10682 // To prove L >= 0 we use isKnownNonNegative whereas to prove I >= 0 we use 10683 // isKnownPredicate. isKnownPredicate is more powerful, but also more 10684 // expensive; and using isKnownNonNegative(RHS) is sufficient for most of the 10685 // interesting cases seen in practice. We can consider "upgrading" L >= 0 to 10686 // use isKnownPredicate later if needed. 10687 return isKnownNonNegative(RHS) && 10688 isKnownPredicate(CmpInst::ICMP_SGE, LHS, getZero(LHS->getType())) && 10689 isKnownPredicate(CmpInst::ICMP_SLT, LHS, RHS); 10690 } 10691 10692 bool ScalarEvolution::isImpliedViaGuard(const BasicBlock *BB, 10693 ICmpInst::Predicate Pred, 10694 const SCEV *LHS, const SCEV *RHS) { 10695 // No need to even try if we know the module has no guards. 10696 if (!HasGuards) 10697 return false; 10698 10699 return any_of(*BB, [&](const Instruction &I) { 10700 using namespace llvm::PatternMatch; 10701 10702 Value *Condition; 10703 return match(&I, m_Intrinsic<Intrinsic::experimental_guard>( 10704 m_Value(Condition))) && 10705 isImpliedCond(Pred, LHS, RHS, Condition, false); 10706 }); 10707 } 10708 10709 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is 10710 /// protected by a conditional between LHS and RHS. This is used to 10711 /// to eliminate casts. 10712 bool 10713 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L, 10714 ICmpInst::Predicate Pred, 10715 const SCEV *LHS, const SCEV *RHS) { 10716 // Interpret a null as meaning no loop, where there is obviously no guard 10717 // (interprocedural conditions notwithstanding). 10718 if (!L) return true; 10719 10720 if (VerifyIR) 10721 assert(!verifyFunction(*L->getHeader()->getParent(), &dbgs()) && 10722 "This cannot be done on broken IR!"); 10723 10724 10725 if (isKnownViaNonRecursiveReasoning(Pred, LHS, RHS)) 10726 return true; 10727 10728 BasicBlock *Latch = L->getLoopLatch(); 10729 if (!Latch) 10730 return false; 10731 10732 BranchInst *LoopContinuePredicate = 10733 dyn_cast<BranchInst>(Latch->getTerminator()); 10734 if (LoopContinuePredicate && LoopContinuePredicate->isConditional() && 10735 isImpliedCond(Pred, LHS, RHS, 10736 LoopContinuePredicate->getCondition(), 10737 LoopContinuePredicate->getSuccessor(0) != L->getHeader())) 10738 return true; 10739 10740 // We don't want more than one activation of the following loops on the stack 10741 // -- that can lead to O(n!) time complexity. 10742 if (WalkingBEDominatingConds) 10743 return false; 10744 10745 SaveAndRestore<bool> ClearOnExit(WalkingBEDominatingConds, true); 10746 10747 // See if we can exploit a trip count to prove the predicate. 10748 const auto &BETakenInfo = getBackedgeTakenInfo(L); 10749 const SCEV *LatchBECount = BETakenInfo.getExact(Latch, this); 10750 if (LatchBECount != getCouldNotCompute()) { 10751 // We know that Latch branches back to the loop header exactly 10752 // LatchBECount times. This means the backdege condition at Latch is 10753 // equivalent to "{0,+,1} u< LatchBECount". 10754 Type *Ty = LatchBECount->getType(); 10755 auto NoWrapFlags = SCEV::NoWrapFlags(SCEV::FlagNUW | SCEV::FlagNW); 10756 const SCEV *LoopCounter = 10757 getAddRecExpr(getZero(Ty), getOne(Ty), L, NoWrapFlags); 10758 if (isImpliedCond(Pred, LHS, RHS, ICmpInst::ICMP_ULT, LoopCounter, 10759 LatchBECount)) 10760 return true; 10761 } 10762 10763 // Check conditions due to any @llvm.assume intrinsics. 10764 for (auto &AssumeVH : AC.assumptions()) { 10765 if (!AssumeVH) 10766 continue; 10767 auto *CI = cast<CallInst>(AssumeVH); 10768 if (!DT.dominates(CI, Latch->getTerminator())) 10769 continue; 10770 10771 if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false)) 10772 return true; 10773 } 10774 10775 // If the loop is not reachable from the entry block, we risk running into an 10776 // infinite loop as we walk up into the dom tree. These loops do not matter 10777 // anyway, so we just return a conservative answer when we see them. 10778 if (!DT.isReachableFromEntry(L->getHeader())) 10779 return false; 10780 10781 if (isImpliedViaGuard(Latch, Pred, LHS, RHS)) 10782 return true; 10783 10784 for (DomTreeNode *DTN = DT[Latch], *HeaderDTN = DT[L->getHeader()]; 10785 DTN != HeaderDTN; DTN = DTN->getIDom()) { 10786 assert(DTN && "should reach the loop header before reaching the root!"); 10787 10788 BasicBlock *BB = DTN->getBlock(); 10789 if (isImpliedViaGuard(BB, Pred, LHS, RHS)) 10790 return true; 10791 10792 BasicBlock *PBB = BB->getSinglePredecessor(); 10793 if (!PBB) 10794 continue; 10795 10796 BranchInst *ContinuePredicate = dyn_cast<BranchInst>(PBB->getTerminator()); 10797 if (!ContinuePredicate || !ContinuePredicate->isConditional()) 10798 continue; 10799 10800 Value *Condition = ContinuePredicate->getCondition(); 10801 10802 // If we have an edge `E` within the loop body that dominates the only 10803 // latch, the condition guarding `E` also guards the backedge. This 10804 // reasoning works only for loops with a single latch. 10805 10806 BasicBlockEdge DominatingEdge(PBB, BB); 10807 if (DominatingEdge.isSingleEdge()) { 10808 // We're constructively (and conservatively) enumerating edges within the 10809 // loop body that dominate the latch. The dominator tree better agree 10810 // with us on this: 10811 assert(DT.dominates(DominatingEdge, Latch) && "should be!"); 10812 10813 if (isImpliedCond(Pred, LHS, RHS, Condition, 10814 BB != ContinuePredicate->getSuccessor(0))) 10815 return true; 10816 } 10817 } 10818 10819 return false; 10820 } 10821 10822 bool ScalarEvolution::isBasicBlockEntryGuardedByCond(const BasicBlock *BB, 10823 ICmpInst::Predicate Pred, 10824 const SCEV *LHS, 10825 const SCEV *RHS) { 10826 if (VerifyIR) 10827 assert(!verifyFunction(*BB->getParent(), &dbgs()) && 10828 "This cannot be done on broken IR!"); 10829 10830 // If we cannot prove strict comparison (e.g. a > b), maybe we can prove 10831 // the facts (a >= b && a != b) separately. A typical situation is when the 10832 // non-strict comparison is known from ranges and non-equality is known from 10833 // dominating predicates. If we are proving strict comparison, we always try 10834 // to prove non-equality and non-strict comparison separately. 10835 auto NonStrictPredicate = ICmpInst::getNonStrictPredicate(Pred); 10836 const bool ProvingStrictComparison = (Pred != NonStrictPredicate); 10837 bool ProvedNonStrictComparison = false; 10838 bool ProvedNonEquality = false; 10839 10840 auto SplitAndProve = 10841 [&](std::function<bool(ICmpInst::Predicate)> Fn) -> bool { 10842 if (!ProvedNonStrictComparison) 10843 ProvedNonStrictComparison = Fn(NonStrictPredicate); 10844 if (!ProvedNonEquality) 10845 ProvedNonEquality = Fn(ICmpInst::ICMP_NE); 10846 if (ProvedNonStrictComparison && ProvedNonEquality) 10847 return true; 10848 return false; 10849 }; 10850 10851 if (ProvingStrictComparison) { 10852 auto ProofFn = [&](ICmpInst::Predicate P) { 10853 return isKnownViaNonRecursiveReasoning(P, LHS, RHS); 10854 }; 10855 if (SplitAndProve(ProofFn)) 10856 return true; 10857 } 10858 10859 // Try to prove (Pred, LHS, RHS) using isImpliedViaGuard. 10860 auto ProveViaGuard = [&](const BasicBlock *Block) { 10861 if (isImpliedViaGuard(Block, Pred, LHS, RHS)) 10862 return true; 10863 if (ProvingStrictComparison) { 10864 auto ProofFn = [&](ICmpInst::Predicate P) { 10865 return isImpliedViaGuard(Block, P, LHS, RHS); 10866 }; 10867 if (SplitAndProve(ProofFn)) 10868 return true; 10869 } 10870 return false; 10871 }; 10872 10873 // Try to prove (Pred, LHS, RHS) using isImpliedCond. 10874 auto ProveViaCond = [&](const Value *Condition, bool Inverse) { 10875 const Instruction *CtxI = &BB->front(); 10876 if (isImpliedCond(Pred, LHS, RHS, Condition, Inverse, CtxI)) 10877 return true; 10878 if (ProvingStrictComparison) { 10879 auto ProofFn = [&](ICmpInst::Predicate P) { 10880 return isImpliedCond(P, LHS, RHS, Condition, Inverse, CtxI); 10881 }; 10882 if (SplitAndProve(ProofFn)) 10883 return true; 10884 } 10885 return false; 10886 }; 10887 10888 // Starting at the block's predecessor, climb up the predecessor chain, as long 10889 // as there are predecessors that can be found that have unique successors 10890 // leading to the original block. 10891 const Loop *ContainingLoop = LI.getLoopFor(BB); 10892 const BasicBlock *PredBB; 10893 if (ContainingLoop && ContainingLoop->getHeader() == BB) 10894 PredBB = ContainingLoop->getLoopPredecessor(); 10895 else 10896 PredBB = BB->getSinglePredecessor(); 10897 for (std::pair<const BasicBlock *, const BasicBlock *> Pair(PredBB, BB); 10898 Pair.first; Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) { 10899 if (ProveViaGuard(Pair.first)) 10900 return true; 10901 10902 const BranchInst *LoopEntryPredicate = 10903 dyn_cast<BranchInst>(Pair.first->getTerminator()); 10904 if (!LoopEntryPredicate || 10905 LoopEntryPredicate->isUnconditional()) 10906 continue; 10907 10908 if (ProveViaCond(LoopEntryPredicate->getCondition(), 10909 LoopEntryPredicate->getSuccessor(0) != Pair.second)) 10910 return true; 10911 } 10912 10913 // Check conditions due to any @llvm.assume intrinsics. 10914 for (auto &AssumeVH : AC.assumptions()) { 10915 if (!AssumeVH) 10916 continue; 10917 auto *CI = cast<CallInst>(AssumeVH); 10918 if (!DT.dominates(CI, BB)) 10919 continue; 10920 10921 if (ProveViaCond(CI->getArgOperand(0), false)) 10922 return true; 10923 } 10924 10925 return false; 10926 } 10927 10928 bool ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L, 10929 ICmpInst::Predicate Pred, 10930 const SCEV *LHS, 10931 const SCEV *RHS) { 10932 // Interpret a null as meaning no loop, where there is obviously no guard 10933 // (interprocedural conditions notwithstanding). 10934 if (!L) 10935 return false; 10936 10937 // Both LHS and RHS must be available at loop entry. 10938 assert(isAvailableAtLoopEntry(LHS, L) && 10939 "LHS is not available at Loop Entry"); 10940 assert(isAvailableAtLoopEntry(RHS, L) && 10941 "RHS is not available at Loop Entry"); 10942 10943 if (isKnownViaNonRecursiveReasoning(Pred, LHS, RHS)) 10944 return true; 10945 10946 return isBasicBlockEntryGuardedByCond(L->getHeader(), Pred, LHS, RHS); 10947 } 10948 10949 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS, 10950 const SCEV *RHS, 10951 const Value *FoundCondValue, bool Inverse, 10952 const Instruction *CtxI) { 10953 // False conditions implies anything. Do not bother analyzing it further. 10954 if (FoundCondValue == 10955 ConstantInt::getBool(FoundCondValue->getContext(), Inverse)) 10956 return true; 10957 10958 if (!PendingLoopPredicates.insert(FoundCondValue).second) 10959 return false; 10960 10961 auto ClearOnExit = 10962 make_scope_exit([&]() { PendingLoopPredicates.erase(FoundCondValue); }); 10963 10964 // Recursively handle And and Or conditions. 10965 const Value *Op0, *Op1; 10966 if (match(FoundCondValue, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) { 10967 if (!Inverse) 10968 return isImpliedCond(Pred, LHS, RHS, Op0, Inverse, CtxI) || 10969 isImpliedCond(Pred, LHS, RHS, Op1, Inverse, CtxI); 10970 } else if (match(FoundCondValue, m_LogicalOr(m_Value(Op0), m_Value(Op1)))) { 10971 if (Inverse) 10972 return isImpliedCond(Pred, LHS, RHS, Op0, Inverse, CtxI) || 10973 isImpliedCond(Pred, LHS, RHS, Op1, Inverse, CtxI); 10974 } 10975 10976 const ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue); 10977 if (!ICI) return false; 10978 10979 // Now that we found a conditional branch that dominates the loop or controls 10980 // the loop latch. Check to see if it is the comparison we are looking for. 10981 ICmpInst::Predicate FoundPred; 10982 if (Inverse) 10983 FoundPred = ICI->getInversePredicate(); 10984 else 10985 FoundPred = ICI->getPredicate(); 10986 10987 const SCEV *FoundLHS = getSCEV(ICI->getOperand(0)); 10988 const SCEV *FoundRHS = getSCEV(ICI->getOperand(1)); 10989 10990 return isImpliedCond(Pred, LHS, RHS, FoundPred, FoundLHS, FoundRHS, CtxI); 10991 } 10992 10993 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS, 10994 const SCEV *RHS, 10995 ICmpInst::Predicate FoundPred, 10996 const SCEV *FoundLHS, const SCEV *FoundRHS, 10997 const Instruction *CtxI) { 10998 // Balance the types. 10999 if (getTypeSizeInBits(LHS->getType()) < 11000 getTypeSizeInBits(FoundLHS->getType())) { 11001 // For unsigned and equality predicates, try to prove that both found 11002 // operands fit into narrow unsigned range. If so, try to prove facts in 11003 // narrow types. 11004 if (!CmpInst::isSigned(FoundPred) && !FoundLHS->getType()->isPointerTy() && 11005 !FoundRHS->getType()->isPointerTy()) { 11006 auto *NarrowType = LHS->getType(); 11007 auto *WideType = FoundLHS->getType(); 11008 auto BitWidth = getTypeSizeInBits(NarrowType); 11009 const SCEV *MaxValue = getZeroExtendExpr( 11010 getConstant(APInt::getMaxValue(BitWidth)), WideType); 11011 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, FoundLHS, 11012 MaxValue) && 11013 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, FoundRHS, 11014 MaxValue)) { 11015 const SCEV *TruncFoundLHS = getTruncateExpr(FoundLHS, NarrowType); 11016 const SCEV *TruncFoundRHS = getTruncateExpr(FoundRHS, NarrowType); 11017 if (isImpliedCondBalancedTypes(Pred, LHS, RHS, FoundPred, TruncFoundLHS, 11018 TruncFoundRHS, CtxI)) 11019 return true; 11020 } 11021 } 11022 11023 if (LHS->getType()->isPointerTy() || RHS->getType()->isPointerTy()) 11024 return false; 11025 if (CmpInst::isSigned(Pred)) { 11026 LHS = getSignExtendExpr(LHS, FoundLHS->getType()); 11027 RHS = getSignExtendExpr(RHS, FoundLHS->getType()); 11028 } else { 11029 LHS = getZeroExtendExpr(LHS, FoundLHS->getType()); 11030 RHS = getZeroExtendExpr(RHS, FoundLHS->getType()); 11031 } 11032 } else if (getTypeSizeInBits(LHS->getType()) > 11033 getTypeSizeInBits(FoundLHS->getType())) { 11034 if (FoundLHS->getType()->isPointerTy() || FoundRHS->getType()->isPointerTy()) 11035 return false; 11036 if (CmpInst::isSigned(FoundPred)) { 11037 FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType()); 11038 FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType()); 11039 } else { 11040 FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType()); 11041 FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType()); 11042 } 11043 } 11044 return isImpliedCondBalancedTypes(Pred, LHS, RHS, FoundPred, FoundLHS, 11045 FoundRHS, CtxI); 11046 } 11047 11048 bool ScalarEvolution::isImpliedCondBalancedTypes( 11049 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 11050 ICmpInst::Predicate FoundPred, const SCEV *FoundLHS, const SCEV *FoundRHS, 11051 const Instruction *CtxI) { 11052 assert(getTypeSizeInBits(LHS->getType()) == 11053 getTypeSizeInBits(FoundLHS->getType()) && 11054 "Types should be balanced!"); 11055 // Canonicalize the query to match the way instcombine will have 11056 // canonicalized the comparison. 11057 if (SimplifyICmpOperands(Pred, LHS, RHS)) 11058 if (LHS == RHS) 11059 return CmpInst::isTrueWhenEqual(Pred); 11060 if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS)) 11061 if (FoundLHS == FoundRHS) 11062 return CmpInst::isFalseWhenEqual(FoundPred); 11063 11064 // Check to see if we can make the LHS or RHS match. 11065 if (LHS == FoundRHS || RHS == FoundLHS) { 11066 if (isa<SCEVConstant>(RHS)) { 11067 std::swap(FoundLHS, FoundRHS); 11068 FoundPred = ICmpInst::getSwappedPredicate(FoundPred); 11069 } else { 11070 std::swap(LHS, RHS); 11071 Pred = ICmpInst::getSwappedPredicate(Pred); 11072 } 11073 } 11074 11075 // Check whether the found predicate is the same as the desired predicate. 11076 if (FoundPred == Pred) 11077 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, CtxI); 11078 11079 // Check whether swapping the found predicate makes it the same as the 11080 // desired predicate. 11081 if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) { 11082 // We can write the implication 11083 // 0. LHS Pred RHS <- FoundLHS SwapPred FoundRHS 11084 // using one of the following ways: 11085 // 1. LHS Pred RHS <- FoundRHS Pred FoundLHS 11086 // 2. RHS SwapPred LHS <- FoundLHS SwapPred FoundRHS 11087 // 3. LHS Pred RHS <- ~FoundLHS Pred ~FoundRHS 11088 // 4. ~LHS SwapPred ~RHS <- FoundLHS SwapPred FoundRHS 11089 // Forms 1. and 2. require swapping the operands of one condition. Don't 11090 // do this if it would break canonical constant/addrec ordering. 11091 if (!isa<SCEVConstant>(RHS) && !isa<SCEVAddRecExpr>(LHS)) 11092 return isImpliedCondOperands(FoundPred, RHS, LHS, FoundLHS, FoundRHS, 11093 CtxI); 11094 if (!isa<SCEVConstant>(FoundRHS) && !isa<SCEVAddRecExpr>(FoundLHS)) 11095 return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS, CtxI); 11096 11097 // There's no clear preference between forms 3. and 4., try both. Avoid 11098 // forming getNotSCEV of pointer values as the resulting subtract is 11099 // not legal. 11100 if (!LHS->getType()->isPointerTy() && !RHS->getType()->isPointerTy() && 11101 isImpliedCondOperands(FoundPred, getNotSCEV(LHS), getNotSCEV(RHS), 11102 FoundLHS, FoundRHS, CtxI)) 11103 return true; 11104 11105 if (!FoundLHS->getType()->isPointerTy() && 11106 !FoundRHS->getType()->isPointerTy() && 11107 isImpliedCondOperands(Pred, LHS, RHS, getNotSCEV(FoundLHS), 11108 getNotSCEV(FoundRHS), CtxI)) 11109 return true; 11110 11111 return false; 11112 } 11113 11114 auto IsSignFlippedPredicate = [](CmpInst::Predicate P1, 11115 CmpInst::Predicate P2) { 11116 assert(P1 != P2 && "Handled earlier!"); 11117 return CmpInst::isRelational(P2) && 11118 P1 == CmpInst::getFlippedSignednessPredicate(P2); 11119 }; 11120 if (IsSignFlippedPredicate(Pred, FoundPred)) { 11121 // Unsigned comparison is the same as signed comparison when both the 11122 // operands are non-negative or negative. 11123 if ((isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS)) || 11124 (isKnownNegative(FoundLHS) && isKnownNegative(FoundRHS))) 11125 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, CtxI); 11126 // Create local copies that we can freely swap and canonicalize our 11127 // conditions to "le/lt". 11128 ICmpInst::Predicate CanonicalPred = Pred, CanonicalFoundPred = FoundPred; 11129 const SCEV *CanonicalLHS = LHS, *CanonicalRHS = RHS, 11130 *CanonicalFoundLHS = FoundLHS, *CanonicalFoundRHS = FoundRHS; 11131 if (ICmpInst::isGT(CanonicalPred) || ICmpInst::isGE(CanonicalPred)) { 11132 CanonicalPred = ICmpInst::getSwappedPredicate(CanonicalPred); 11133 CanonicalFoundPred = ICmpInst::getSwappedPredicate(CanonicalFoundPred); 11134 std::swap(CanonicalLHS, CanonicalRHS); 11135 std::swap(CanonicalFoundLHS, CanonicalFoundRHS); 11136 } 11137 assert((ICmpInst::isLT(CanonicalPred) || ICmpInst::isLE(CanonicalPred)) && 11138 "Must be!"); 11139 assert((ICmpInst::isLT(CanonicalFoundPred) || 11140 ICmpInst::isLE(CanonicalFoundPred)) && 11141 "Must be!"); 11142 if (ICmpInst::isSigned(CanonicalPred) && isKnownNonNegative(CanonicalRHS)) 11143 // Use implication: 11144 // x <u y && y >=s 0 --> x <s y. 11145 // If we can prove the left part, the right part is also proven. 11146 return isImpliedCondOperands(CanonicalFoundPred, CanonicalLHS, 11147 CanonicalRHS, CanonicalFoundLHS, 11148 CanonicalFoundRHS); 11149 if (ICmpInst::isUnsigned(CanonicalPred) && isKnownNegative(CanonicalRHS)) 11150 // Use implication: 11151 // x <s y && y <s 0 --> x <u y. 11152 // If we can prove the left part, the right part is also proven. 11153 return isImpliedCondOperands(CanonicalFoundPred, CanonicalLHS, 11154 CanonicalRHS, CanonicalFoundLHS, 11155 CanonicalFoundRHS); 11156 } 11157 11158 // Check if we can make progress by sharpening ranges. 11159 if (FoundPred == ICmpInst::ICMP_NE && 11160 (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) { 11161 11162 const SCEVConstant *C = nullptr; 11163 const SCEV *V = nullptr; 11164 11165 if (isa<SCEVConstant>(FoundLHS)) { 11166 C = cast<SCEVConstant>(FoundLHS); 11167 V = FoundRHS; 11168 } else { 11169 C = cast<SCEVConstant>(FoundRHS); 11170 V = FoundLHS; 11171 } 11172 11173 // The guarding predicate tells us that C != V. If the known range 11174 // of V is [C, t), we can sharpen the range to [C + 1, t). The 11175 // range we consider has to correspond to same signedness as the 11176 // predicate we're interested in folding. 11177 11178 APInt Min = ICmpInst::isSigned(Pred) ? 11179 getSignedRangeMin(V) : getUnsignedRangeMin(V); 11180 11181 if (Min == C->getAPInt()) { 11182 // Given (V >= Min && V != Min) we conclude V >= (Min + 1). 11183 // This is true even if (Min + 1) wraps around -- in case of 11184 // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)). 11185 11186 APInt SharperMin = Min + 1; 11187 11188 switch (Pred) { 11189 case ICmpInst::ICMP_SGE: 11190 case ICmpInst::ICMP_UGE: 11191 // We know V `Pred` SharperMin. If this implies LHS `Pred` 11192 // RHS, we're done. 11193 if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(SharperMin), 11194 CtxI)) 11195 return true; 11196 LLVM_FALLTHROUGH; 11197 11198 case ICmpInst::ICMP_SGT: 11199 case ICmpInst::ICMP_UGT: 11200 // We know from the range information that (V `Pred` Min || 11201 // V == Min). We know from the guarding condition that !(V 11202 // == Min). This gives us 11203 // 11204 // V `Pred` Min || V == Min && !(V == Min) 11205 // => V `Pred` Min 11206 // 11207 // If V `Pred` Min implies LHS `Pred` RHS, we're done. 11208 11209 if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min), CtxI)) 11210 return true; 11211 break; 11212 11213 // `LHS < RHS` and `LHS <= RHS` are handled in the same way as `RHS > LHS` and `RHS >= LHS` respectively. 11214 case ICmpInst::ICMP_SLE: 11215 case ICmpInst::ICMP_ULE: 11216 if (isImpliedCondOperands(CmpInst::getSwappedPredicate(Pred), RHS, 11217 LHS, V, getConstant(SharperMin), CtxI)) 11218 return true; 11219 LLVM_FALLTHROUGH; 11220 11221 case ICmpInst::ICMP_SLT: 11222 case ICmpInst::ICMP_ULT: 11223 if (isImpliedCondOperands(CmpInst::getSwappedPredicate(Pred), RHS, 11224 LHS, V, getConstant(Min), CtxI)) 11225 return true; 11226 break; 11227 11228 default: 11229 // No change 11230 break; 11231 } 11232 } 11233 } 11234 11235 // Check whether the actual condition is beyond sufficient. 11236 if (FoundPred == ICmpInst::ICMP_EQ) 11237 if (ICmpInst::isTrueWhenEqual(Pred)) 11238 if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, CtxI)) 11239 return true; 11240 if (Pred == ICmpInst::ICMP_NE) 11241 if (!ICmpInst::isTrueWhenEqual(FoundPred)) 11242 if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS, CtxI)) 11243 return true; 11244 11245 // Otherwise assume the worst. 11246 return false; 11247 } 11248 11249 bool ScalarEvolution::splitBinaryAdd(const SCEV *Expr, 11250 const SCEV *&L, const SCEV *&R, 11251 SCEV::NoWrapFlags &Flags) { 11252 const auto *AE = dyn_cast<SCEVAddExpr>(Expr); 11253 if (!AE || AE->getNumOperands() != 2) 11254 return false; 11255 11256 L = AE->getOperand(0); 11257 R = AE->getOperand(1); 11258 Flags = AE->getNoWrapFlags(); 11259 return true; 11260 } 11261 11262 Optional<APInt> ScalarEvolution::computeConstantDifference(const SCEV *More, 11263 const SCEV *Less) { 11264 // We avoid subtracting expressions here because this function is usually 11265 // fairly deep in the call stack (i.e. is called many times). 11266 11267 // X - X = 0. 11268 if (More == Less) 11269 return APInt(getTypeSizeInBits(More->getType()), 0); 11270 11271 if (isa<SCEVAddRecExpr>(Less) && isa<SCEVAddRecExpr>(More)) { 11272 const auto *LAR = cast<SCEVAddRecExpr>(Less); 11273 const auto *MAR = cast<SCEVAddRecExpr>(More); 11274 11275 if (LAR->getLoop() != MAR->getLoop()) 11276 return None; 11277 11278 // We look at affine expressions only; not for correctness but to keep 11279 // getStepRecurrence cheap. 11280 if (!LAR->isAffine() || !MAR->isAffine()) 11281 return None; 11282 11283 if (LAR->getStepRecurrence(*this) != MAR->getStepRecurrence(*this)) 11284 return None; 11285 11286 Less = LAR->getStart(); 11287 More = MAR->getStart(); 11288 11289 // fall through 11290 } 11291 11292 if (isa<SCEVConstant>(Less) && isa<SCEVConstant>(More)) { 11293 const auto &M = cast<SCEVConstant>(More)->getAPInt(); 11294 const auto &L = cast<SCEVConstant>(Less)->getAPInt(); 11295 return M - L; 11296 } 11297 11298 SCEV::NoWrapFlags Flags; 11299 const SCEV *LLess = nullptr, *RLess = nullptr; 11300 const SCEV *LMore = nullptr, *RMore = nullptr; 11301 const SCEVConstant *C1 = nullptr, *C2 = nullptr; 11302 // Compare (X + C1) vs X. 11303 if (splitBinaryAdd(Less, LLess, RLess, Flags)) 11304 if ((C1 = dyn_cast<SCEVConstant>(LLess))) 11305 if (RLess == More) 11306 return -(C1->getAPInt()); 11307 11308 // Compare X vs (X + C2). 11309 if (splitBinaryAdd(More, LMore, RMore, Flags)) 11310 if ((C2 = dyn_cast<SCEVConstant>(LMore))) 11311 if (RMore == Less) 11312 return C2->getAPInt(); 11313 11314 // Compare (X + C1) vs (X + C2). 11315 if (C1 && C2 && RLess == RMore) 11316 return C2->getAPInt() - C1->getAPInt(); 11317 11318 return None; 11319 } 11320 11321 bool ScalarEvolution::isImpliedCondOperandsViaAddRecStart( 11322 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 11323 const SCEV *FoundLHS, const SCEV *FoundRHS, const Instruction *CtxI) { 11324 // Try to recognize the following pattern: 11325 // 11326 // FoundRHS = ... 11327 // ... 11328 // loop: 11329 // FoundLHS = {Start,+,W} 11330 // context_bb: // Basic block from the same loop 11331 // known(Pred, FoundLHS, FoundRHS) 11332 // 11333 // If some predicate is known in the context of a loop, it is also known on 11334 // each iteration of this loop, including the first iteration. Therefore, in 11335 // this case, `FoundLHS Pred FoundRHS` implies `Start Pred FoundRHS`. Try to 11336 // prove the original pred using this fact. 11337 if (!CtxI) 11338 return false; 11339 const BasicBlock *ContextBB = CtxI->getParent(); 11340 // Make sure AR varies in the context block. 11341 if (auto *AR = dyn_cast<SCEVAddRecExpr>(FoundLHS)) { 11342 const Loop *L = AR->getLoop(); 11343 // Make sure that context belongs to the loop and executes on 1st iteration 11344 // (if it ever executes at all). 11345 if (!L->contains(ContextBB) || !DT.dominates(ContextBB, L->getLoopLatch())) 11346 return false; 11347 if (!isAvailableAtLoopEntry(FoundRHS, AR->getLoop())) 11348 return false; 11349 return isImpliedCondOperands(Pred, LHS, RHS, AR->getStart(), FoundRHS); 11350 } 11351 11352 if (auto *AR = dyn_cast<SCEVAddRecExpr>(FoundRHS)) { 11353 const Loop *L = AR->getLoop(); 11354 // Make sure that context belongs to the loop and executes on 1st iteration 11355 // (if it ever executes at all). 11356 if (!L->contains(ContextBB) || !DT.dominates(ContextBB, L->getLoopLatch())) 11357 return false; 11358 if (!isAvailableAtLoopEntry(FoundLHS, AR->getLoop())) 11359 return false; 11360 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, AR->getStart()); 11361 } 11362 11363 return false; 11364 } 11365 11366 bool ScalarEvolution::isImpliedCondOperandsViaNoOverflow( 11367 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 11368 const SCEV *FoundLHS, const SCEV *FoundRHS) { 11369 if (Pred != CmpInst::ICMP_SLT && Pred != CmpInst::ICMP_ULT) 11370 return false; 11371 11372 const auto *AddRecLHS = dyn_cast<SCEVAddRecExpr>(LHS); 11373 if (!AddRecLHS) 11374 return false; 11375 11376 const auto *AddRecFoundLHS = dyn_cast<SCEVAddRecExpr>(FoundLHS); 11377 if (!AddRecFoundLHS) 11378 return false; 11379 11380 // We'd like to let SCEV reason about control dependencies, so we constrain 11381 // both the inequalities to be about add recurrences on the same loop. This 11382 // way we can use isLoopEntryGuardedByCond later. 11383 11384 const Loop *L = AddRecFoundLHS->getLoop(); 11385 if (L != AddRecLHS->getLoop()) 11386 return false; 11387 11388 // FoundLHS u< FoundRHS u< -C => (FoundLHS + C) u< (FoundRHS + C) ... (1) 11389 // 11390 // FoundLHS s< FoundRHS s< INT_MIN - C => (FoundLHS + C) s< (FoundRHS + C) 11391 // ... (2) 11392 // 11393 // Informal proof for (2), assuming (1) [*]: 11394 // 11395 // We'll also assume (A s< B) <=> ((A + INT_MIN) u< (B + INT_MIN)) ... (3)[**] 11396 // 11397 // Then 11398 // 11399 // FoundLHS s< FoundRHS s< INT_MIN - C 11400 // <=> (FoundLHS + INT_MIN) u< (FoundRHS + INT_MIN) u< -C [ using (3) ] 11401 // <=> (FoundLHS + INT_MIN + C) u< (FoundRHS + INT_MIN + C) [ using (1) ] 11402 // <=> (FoundLHS + INT_MIN + C + INT_MIN) s< 11403 // (FoundRHS + INT_MIN + C + INT_MIN) [ using (3) ] 11404 // <=> FoundLHS + C s< FoundRHS + C 11405 // 11406 // [*]: (1) can be proved by ruling out overflow. 11407 // 11408 // [**]: This can be proved by analyzing all the four possibilities: 11409 // (A s< 0, B s< 0), (A s< 0, B s>= 0), (A s>= 0, B s< 0) and 11410 // (A s>= 0, B s>= 0). 11411 // 11412 // Note: 11413 // Despite (2), "FoundRHS s< INT_MIN - C" does not mean that "FoundRHS + C" 11414 // will not sign underflow. For instance, say FoundLHS = (i8 -128), FoundRHS 11415 // = (i8 -127) and C = (i8 -100). Then INT_MIN - C = (i8 -28), and FoundRHS 11416 // s< (INT_MIN - C). Lack of sign overflow / underflow in "FoundRHS + C" is 11417 // neither necessary nor sufficient to prove "(FoundLHS + C) s< (FoundRHS + 11418 // C)". 11419 11420 Optional<APInt> LDiff = computeConstantDifference(LHS, FoundLHS); 11421 Optional<APInt> RDiff = computeConstantDifference(RHS, FoundRHS); 11422 if (!LDiff || !RDiff || *LDiff != *RDiff) 11423 return false; 11424 11425 if (LDiff->isMinValue()) 11426 return true; 11427 11428 APInt FoundRHSLimit; 11429 11430 if (Pred == CmpInst::ICMP_ULT) { 11431 FoundRHSLimit = -(*RDiff); 11432 } else { 11433 assert(Pred == CmpInst::ICMP_SLT && "Checked above!"); 11434 FoundRHSLimit = APInt::getSignedMinValue(getTypeSizeInBits(RHS->getType())) - *RDiff; 11435 } 11436 11437 // Try to prove (1) or (2), as needed. 11438 return isAvailableAtLoopEntry(FoundRHS, L) && 11439 isLoopEntryGuardedByCond(L, Pred, FoundRHS, 11440 getConstant(FoundRHSLimit)); 11441 } 11442 11443 bool ScalarEvolution::isImpliedViaMerge(ICmpInst::Predicate Pred, 11444 const SCEV *LHS, const SCEV *RHS, 11445 const SCEV *FoundLHS, 11446 const SCEV *FoundRHS, unsigned Depth) { 11447 const PHINode *LPhi = nullptr, *RPhi = nullptr; 11448 11449 auto ClearOnExit = make_scope_exit([&]() { 11450 if (LPhi) { 11451 bool Erased = PendingMerges.erase(LPhi); 11452 assert(Erased && "Failed to erase LPhi!"); 11453 (void)Erased; 11454 } 11455 if (RPhi) { 11456 bool Erased = PendingMerges.erase(RPhi); 11457 assert(Erased && "Failed to erase RPhi!"); 11458 (void)Erased; 11459 } 11460 }); 11461 11462 // Find respective Phis and check that they are not being pending. 11463 if (const SCEVUnknown *LU = dyn_cast<SCEVUnknown>(LHS)) 11464 if (auto *Phi = dyn_cast<PHINode>(LU->getValue())) { 11465 if (!PendingMerges.insert(Phi).second) 11466 return false; 11467 LPhi = Phi; 11468 } 11469 if (const SCEVUnknown *RU = dyn_cast<SCEVUnknown>(RHS)) 11470 if (auto *Phi = dyn_cast<PHINode>(RU->getValue())) { 11471 // If we detect a loop of Phi nodes being processed by this method, for 11472 // example: 11473 // 11474 // %a = phi i32 [ %some1, %preheader ], [ %b, %latch ] 11475 // %b = phi i32 [ %some2, %preheader ], [ %a, %latch ] 11476 // 11477 // we don't want to deal with a case that complex, so return conservative 11478 // answer false. 11479 if (!PendingMerges.insert(Phi).second) 11480 return false; 11481 RPhi = Phi; 11482 } 11483 11484 // If none of LHS, RHS is a Phi, nothing to do here. 11485 if (!LPhi && !RPhi) 11486 return false; 11487 11488 // If there is a SCEVUnknown Phi we are interested in, make it left. 11489 if (!LPhi) { 11490 std::swap(LHS, RHS); 11491 std::swap(FoundLHS, FoundRHS); 11492 std::swap(LPhi, RPhi); 11493 Pred = ICmpInst::getSwappedPredicate(Pred); 11494 } 11495 11496 assert(LPhi && "LPhi should definitely be a SCEVUnknown Phi!"); 11497 const BasicBlock *LBB = LPhi->getParent(); 11498 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS); 11499 11500 auto ProvedEasily = [&](const SCEV *S1, const SCEV *S2) { 11501 return isKnownViaNonRecursiveReasoning(Pred, S1, S2) || 11502 isImpliedCondOperandsViaRanges(Pred, S1, S2, FoundLHS, FoundRHS) || 11503 isImpliedViaOperations(Pred, S1, S2, FoundLHS, FoundRHS, Depth); 11504 }; 11505 11506 if (RPhi && RPhi->getParent() == LBB) { 11507 // Case one: RHS is also a SCEVUnknown Phi from the same basic block. 11508 // If we compare two Phis from the same block, and for each entry block 11509 // the predicate is true for incoming values from this block, then the 11510 // predicate is also true for the Phis. 11511 for (const BasicBlock *IncBB : predecessors(LBB)) { 11512 const SCEV *L = getSCEV(LPhi->getIncomingValueForBlock(IncBB)); 11513 const SCEV *R = getSCEV(RPhi->getIncomingValueForBlock(IncBB)); 11514 if (!ProvedEasily(L, R)) 11515 return false; 11516 } 11517 } else if (RAR && RAR->getLoop()->getHeader() == LBB) { 11518 // Case two: RHS is also a Phi from the same basic block, and it is an 11519 // AddRec. It means that there is a loop which has both AddRec and Unknown 11520 // PHIs, for it we can compare incoming values of AddRec from above the loop 11521 // and latch with their respective incoming values of LPhi. 11522 // TODO: Generalize to handle loops with many inputs in a header. 11523 if (LPhi->getNumIncomingValues() != 2) return false; 11524 11525 auto *RLoop = RAR->getLoop(); 11526 auto *Predecessor = RLoop->getLoopPredecessor(); 11527 assert(Predecessor && "Loop with AddRec with no predecessor?"); 11528 const SCEV *L1 = getSCEV(LPhi->getIncomingValueForBlock(Predecessor)); 11529 if (!ProvedEasily(L1, RAR->getStart())) 11530 return false; 11531 auto *Latch = RLoop->getLoopLatch(); 11532 assert(Latch && "Loop with AddRec with no latch?"); 11533 const SCEV *L2 = getSCEV(LPhi->getIncomingValueForBlock(Latch)); 11534 if (!ProvedEasily(L2, RAR->getPostIncExpr(*this))) 11535 return false; 11536 } else { 11537 // In all other cases go over inputs of LHS and compare each of them to RHS, 11538 // the predicate is true for (LHS, RHS) if it is true for all such pairs. 11539 // At this point RHS is either a non-Phi, or it is a Phi from some block 11540 // different from LBB. 11541 for (const BasicBlock *IncBB : predecessors(LBB)) { 11542 // Check that RHS is available in this block. 11543 if (!dominates(RHS, IncBB)) 11544 return false; 11545 const SCEV *L = getSCEV(LPhi->getIncomingValueForBlock(IncBB)); 11546 // Make sure L does not refer to a value from a potentially previous 11547 // iteration of a loop. 11548 if (!properlyDominates(L, IncBB)) 11549 return false; 11550 if (!ProvedEasily(L, RHS)) 11551 return false; 11552 } 11553 } 11554 return true; 11555 } 11556 11557 bool ScalarEvolution::isImpliedCondOperandsViaShift(ICmpInst::Predicate Pred, 11558 const SCEV *LHS, 11559 const SCEV *RHS, 11560 const SCEV *FoundLHS, 11561 const SCEV *FoundRHS) { 11562 // We want to imply LHS < RHS from LHS < (RHS >> shiftvalue). First, make 11563 // sure that we are dealing with same LHS. 11564 if (RHS == FoundRHS) { 11565 std::swap(LHS, RHS); 11566 std::swap(FoundLHS, FoundRHS); 11567 Pred = ICmpInst::getSwappedPredicate(Pred); 11568 } 11569 if (LHS != FoundLHS) 11570 return false; 11571 11572 auto *SUFoundRHS = dyn_cast<SCEVUnknown>(FoundRHS); 11573 if (!SUFoundRHS) 11574 return false; 11575 11576 Value *Shiftee, *ShiftValue; 11577 11578 using namespace PatternMatch; 11579 if (match(SUFoundRHS->getValue(), 11580 m_LShr(m_Value(Shiftee), m_Value(ShiftValue)))) { 11581 auto *ShifteeS = getSCEV(Shiftee); 11582 // Prove one of the following: 11583 // LHS <u (shiftee >> shiftvalue) && shiftee <=u RHS ---> LHS <u RHS 11584 // LHS <=u (shiftee >> shiftvalue) && shiftee <=u RHS ---> LHS <=u RHS 11585 // LHS <s (shiftee >> shiftvalue) && shiftee <=s RHS && shiftee >=s 0 11586 // ---> LHS <s RHS 11587 // LHS <=s (shiftee >> shiftvalue) && shiftee <=s RHS && shiftee >=s 0 11588 // ---> LHS <=s RHS 11589 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) 11590 return isKnownPredicate(ICmpInst::ICMP_ULE, ShifteeS, RHS); 11591 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) 11592 if (isKnownNonNegative(ShifteeS)) 11593 return isKnownPredicate(ICmpInst::ICMP_SLE, ShifteeS, RHS); 11594 } 11595 11596 return false; 11597 } 11598 11599 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred, 11600 const SCEV *LHS, const SCEV *RHS, 11601 const SCEV *FoundLHS, 11602 const SCEV *FoundRHS, 11603 const Instruction *CtxI) { 11604 if (isImpliedCondOperandsViaRanges(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11605 return true; 11606 11607 if (isImpliedCondOperandsViaNoOverflow(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11608 return true; 11609 11610 if (isImpliedCondOperandsViaShift(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11611 return true; 11612 11613 if (isImpliedCondOperandsViaAddRecStart(Pred, LHS, RHS, FoundLHS, FoundRHS, 11614 CtxI)) 11615 return true; 11616 11617 return isImpliedCondOperandsHelper(Pred, LHS, RHS, 11618 FoundLHS, FoundRHS); 11619 } 11620 11621 /// Is MaybeMinMaxExpr an (U|S)(Min|Max) of Candidate and some other values? 11622 template <typename MinMaxExprType> 11623 static bool IsMinMaxConsistingOf(const SCEV *MaybeMinMaxExpr, 11624 const SCEV *Candidate) { 11625 const MinMaxExprType *MinMaxExpr = dyn_cast<MinMaxExprType>(MaybeMinMaxExpr); 11626 if (!MinMaxExpr) 11627 return false; 11628 11629 return is_contained(MinMaxExpr->operands(), Candidate); 11630 } 11631 11632 static bool IsKnownPredicateViaAddRecStart(ScalarEvolution &SE, 11633 ICmpInst::Predicate Pred, 11634 const SCEV *LHS, const SCEV *RHS) { 11635 // If both sides are affine addrecs for the same loop, with equal 11636 // steps, and we know the recurrences don't wrap, then we only 11637 // need to check the predicate on the starting values. 11638 11639 if (!ICmpInst::isRelational(Pred)) 11640 return false; 11641 11642 const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS); 11643 if (!LAR) 11644 return false; 11645 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS); 11646 if (!RAR) 11647 return false; 11648 if (LAR->getLoop() != RAR->getLoop()) 11649 return false; 11650 if (!LAR->isAffine() || !RAR->isAffine()) 11651 return false; 11652 11653 if (LAR->getStepRecurrence(SE) != RAR->getStepRecurrence(SE)) 11654 return false; 11655 11656 SCEV::NoWrapFlags NW = ICmpInst::isSigned(Pred) ? 11657 SCEV::FlagNSW : SCEV::FlagNUW; 11658 if (!LAR->getNoWrapFlags(NW) || !RAR->getNoWrapFlags(NW)) 11659 return false; 11660 11661 return SE.isKnownPredicate(Pred, LAR->getStart(), RAR->getStart()); 11662 } 11663 11664 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max 11665 /// expression? 11666 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE, 11667 ICmpInst::Predicate Pred, 11668 const SCEV *LHS, const SCEV *RHS) { 11669 switch (Pred) { 11670 default: 11671 return false; 11672 11673 case ICmpInst::ICMP_SGE: 11674 std::swap(LHS, RHS); 11675 LLVM_FALLTHROUGH; 11676 case ICmpInst::ICMP_SLE: 11677 return 11678 // min(A, ...) <= A 11679 IsMinMaxConsistingOf<SCEVSMinExpr>(LHS, RHS) || 11680 // A <= max(A, ...) 11681 IsMinMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS); 11682 11683 case ICmpInst::ICMP_UGE: 11684 std::swap(LHS, RHS); 11685 LLVM_FALLTHROUGH; 11686 case ICmpInst::ICMP_ULE: 11687 return 11688 // min(A, ...) <= A 11689 // FIXME: what about umin_seq? 11690 IsMinMaxConsistingOf<SCEVUMinExpr>(LHS, RHS) || 11691 // A <= max(A, ...) 11692 IsMinMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS); 11693 } 11694 11695 llvm_unreachable("covered switch fell through?!"); 11696 } 11697 11698 bool ScalarEvolution::isImpliedViaOperations(ICmpInst::Predicate Pred, 11699 const SCEV *LHS, const SCEV *RHS, 11700 const SCEV *FoundLHS, 11701 const SCEV *FoundRHS, 11702 unsigned Depth) { 11703 assert(getTypeSizeInBits(LHS->getType()) == 11704 getTypeSizeInBits(RHS->getType()) && 11705 "LHS and RHS have different sizes?"); 11706 assert(getTypeSizeInBits(FoundLHS->getType()) == 11707 getTypeSizeInBits(FoundRHS->getType()) && 11708 "FoundLHS and FoundRHS have different sizes?"); 11709 // We want to avoid hurting the compile time with analysis of too big trees. 11710 if (Depth > MaxSCEVOperationsImplicationDepth) 11711 return false; 11712 11713 // We only want to work with GT comparison so far. 11714 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_SLT) { 11715 Pred = CmpInst::getSwappedPredicate(Pred); 11716 std::swap(LHS, RHS); 11717 std::swap(FoundLHS, FoundRHS); 11718 } 11719 11720 // For unsigned, try to reduce it to corresponding signed comparison. 11721 if (Pred == ICmpInst::ICMP_UGT) 11722 // We can replace unsigned predicate with its signed counterpart if all 11723 // involved values are non-negative. 11724 // TODO: We could have better support for unsigned. 11725 if (isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS)) { 11726 // Knowing that both FoundLHS and FoundRHS are non-negative, and knowing 11727 // FoundLHS >u FoundRHS, we also know that FoundLHS >s FoundRHS. Let us 11728 // use this fact to prove that LHS and RHS are non-negative. 11729 const SCEV *MinusOne = getMinusOne(LHS->getType()); 11730 if (isImpliedCondOperands(ICmpInst::ICMP_SGT, LHS, MinusOne, FoundLHS, 11731 FoundRHS) && 11732 isImpliedCondOperands(ICmpInst::ICMP_SGT, RHS, MinusOne, FoundLHS, 11733 FoundRHS)) 11734 Pred = ICmpInst::ICMP_SGT; 11735 } 11736 11737 if (Pred != ICmpInst::ICMP_SGT) 11738 return false; 11739 11740 auto GetOpFromSExt = [&](const SCEV *S) { 11741 if (auto *Ext = dyn_cast<SCEVSignExtendExpr>(S)) 11742 return Ext->getOperand(); 11743 // TODO: If S is a SCEVConstant then you can cheaply "strip" the sext off 11744 // the constant in some cases. 11745 return S; 11746 }; 11747 11748 // Acquire values from extensions. 11749 auto *OrigLHS = LHS; 11750 auto *OrigFoundLHS = FoundLHS; 11751 LHS = GetOpFromSExt(LHS); 11752 FoundLHS = GetOpFromSExt(FoundLHS); 11753 11754 // Is the SGT predicate can be proved trivially or using the found context. 11755 auto IsSGTViaContext = [&](const SCEV *S1, const SCEV *S2) { 11756 return isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGT, S1, S2) || 11757 isImpliedViaOperations(ICmpInst::ICMP_SGT, S1, S2, OrigFoundLHS, 11758 FoundRHS, Depth + 1); 11759 }; 11760 11761 if (auto *LHSAddExpr = dyn_cast<SCEVAddExpr>(LHS)) { 11762 // We want to avoid creation of any new non-constant SCEV. Since we are 11763 // going to compare the operands to RHS, we should be certain that we don't 11764 // need any size extensions for this. So let's decline all cases when the 11765 // sizes of types of LHS and RHS do not match. 11766 // TODO: Maybe try to get RHS from sext to catch more cases? 11767 if (getTypeSizeInBits(LHS->getType()) != getTypeSizeInBits(RHS->getType())) 11768 return false; 11769 11770 // Should not overflow. 11771 if (!LHSAddExpr->hasNoSignedWrap()) 11772 return false; 11773 11774 auto *LL = LHSAddExpr->getOperand(0); 11775 auto *LR = LHSAddExpr->getOperand(1); 11776 auto *MinusOne = getMinusOne(RHS->getType()); 11777 11778 // Checks that S1 >= 0 && S2 > RHS, trivially or using the found context. 11779 auto IsSumGreaterThanRHS = [&](const SCEV *S1, const SCEV *S2) { 11780 return IsSGTViaContext(S1, MinusOne) && IsSGTViaContext(S2, RHS); 11781 }; 11782 // Try to prove the following rule: 11783 // (LHS = LL + LR) && (LL >= 0) && (LR > RHS) => (LHS > RHS). 11784 // (LHS = LL + LR) && (LR >= 0) && (LL > RHS) => (LHS > RHS). 11785 if (IsSumGreaterThanRHS(LL, LR) || IsSumGreaterThanRHS(LR, LL)) 11786 return true; 11787 } else if (auto *LHSUnknownExpr = dyn_cast<SCEVUnknown>(LHS)) { 11788 Value *LL, *LR; 11789 // FIXME: Once we have SDiv implemented, we can get rid of this matching. 11790 11791 using namespace llvm::PatternMatch; 11792 11793 if (match(LHSUnknownExpr->getValue(), m_SDiv(m_Value(LL), m_Value(LR)))) { 11794 // Rules for division. 11795 // We are going to perform some comparisons with Denominator and its 11796 // derivative expressions. In general case, creating a SCEV for it may 11797 // lead to a complex analysis of the entire graph, and in particular it 11798 // can request trip count recalculation for the same loop. This would 11799 // cache as SCEVCouldNotCompute to avoid the infinite recursion. To avoid 11800 // this, we only want to create SCEVs that are constants in this section. 11801 // So we bail if Denominator is not a constant. 11802 if (!isa<ConstantInt>(LR)) 11803 return false; 11804 11805 auto *Denominator = cast<SCEVConstant>(getSCEV(LR)); 11806 11807 // We want to make sure that LHS = FoundLHS / Denominator. If it is so, 11808 // then a SCEV for the numerator already exists and matches with FoundLHS. 11809 auto *Numerator = getExistingSCEV(LL); 11810 if (!Numerator || Numerator->getType() != FoundLHS->getType()) 11811 return false; 11812 11813 // Make sure that the numerator matches with FoundLHS and the denominator 11814 // is positive. 11815 if (!HasSameValue(Numerator, FoundLHS) || !isKnownPositive(Denominator)) 11816 return false; 11817 11818 auto *DTy = Denominator->getType(); 11819 auto *FRHSTy = FoundRHS->getType(); 11820 if (DTy->isPointerTy() != FRHSTy->isPointerTy()) 11821 // One of types is a pointer and another one is not. We cannot extend 11822 // them properly to a wider type, so let us just reject this case. 11823 // TODO: Usage of getEffectiveSCEVType for DTy, FRHSTy etc should help 11824 // to avoid this check. 11825 return false; 11826 11827 // Given that: 11828 // FoundLHS > FoundRHS, LHS = FoundLHS / Denominator, Denominator > 0. 11829 auto *WTy = getWiderType(DTy, FRHSTy); 11830 auto *DenominatorExt = getNoopOrSignExtend(Denominator, WTy); 11831 auto *FoundRHSExt = getNoopOrSignExtend(FoundRHS, WTy); 11832 11833 // Try to prove the following rule: 11834 // (FoundRHS > Denominator - 2) && (RHS <= 0) => (LHS > RHS). 11835 // For example, given that FoundLHS > 2. It means that FoundLHS is at 11836 // least 3. If we divide it by Denominator < 4, we will have at least 1. 11837 auto *DenomMinusTwo = getMinusSCEV(DenominatorExt, getConstant(WTy, 2)); 11838 if (isKnownNonPositive(RHS) && 11839 IsSGTViaContext(FoundRHSExt, DenomMinusTwo)) 11840 return true; 11841 11842 // Try to prove the following rule: 11843 // (FoundRHS > -1 - Denominator) && (RHS < 0) => (LHS > RHS). 11844 // For example, given that FoundLHS > -3. Then FoundLHS is at least -2. 11845 // If we divide it by Denominator > 2, then: 11846 // 1. If FoundLHS is negative, then the result is 0. 11847 // 2. If FoundLHS is non-negative, then the result is non-negative. 11848 // Anyways, the result is non-negative. 11849 auto *MinusOne = getMinusOne(WTy); 11850 auto *NegDenomMinusOne = getMinusSCEV(MinusOne, DenominatorExt); 11851 if (isKnownNegative(RHS) && 11852 IsSGTViaContext(FoundRHSExt, NegDenomMinusOne)) 11853 return true; 11854 } 11855 } 11856 11857 // If our expression contained SCEVUnknown Phis, and we split it down and now 11858 // need to prove something for them, try to prove the predicate for every 11859 // possible incoming values of those Phis. 11860 if (isImpliedViaMerge(Pred, OrigLHS, RHS, OrigFoundLHS, FoundRHS, Depth + 1)) 11861 return true; 11862 11863 return false; 11864 } 11865 11866 static bool isKnownPredicateExtendIdiom(ICmpInst::Predicate Pred, 11867 const SCEV *LHS, const SCEV *RHS) { 11868 // zext x u<= sext x, sext x s<= zext x 11869 switch (Pred) { 11870 case ICmpInst::ICMP_SGE: 11871 std::swap(LHS, RHS); 11872 LLVM_FALLTHROUGH; 11873 case ICmpInst::ICMP_SLE: { 11874 // If operand >=s 0 then ZExt == SExt. If operand <s 0 then SExt <s ZExt. 11875 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(LHS); 11876 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(RHS); 11877 if (SExt && ZExt && SExt->getOperand() == ZExt->getOperand()) 11878 return true; 11879 break; 11880 } 11881 case ICmpInst::ICMP_UGE: 11882 std::swap(LHS, RHS); 11883 LLVM_FALLTHROUGH; 11884 case ICmpInst::ICMP_ULE: { 11885 // If operand >=s 0 then ZExt == SExt. If operand <s 0 then ZExt <u SExt. 11886 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(LHS); 11887 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(RHS); 11888 if (SExt && ZExt && SExt->getOperand() == ZExt->getOperand()) 11889 return true; 11890 break; 11891 } 11892 default: 11893 break; 11894 }; 11895 return false; 11896 } 11897 11898 bool 11899 ScalarEvolution::isKnownViaNonRecursiveReasoning(ICmpInst::Predicate Pred, 11900 const SCEV *LHS, const SCEV *RHS) { 11901 return isKnownPredicateExtendIdiom(Pred, LHS, RHS) || 11902 isKnownPredicateViaConstantRanges(Pred, LHS, RHS) || 11903 IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS) || 11904 IsKnownPredicateViaAddRecStart(*this, Pred, LHS, RHS) || 11905 isKnownPredicateViaNoOverflow(Pred, LHS, RHS); 11906 } 11907 11908 bool 11909 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred, 11910 const SCEV *LHS, const SCEV *RHS, 11911 const SCEV *FoundLHS, 11912 const SCEV *FoundRHS) { 11913 switch (Pred) { 11914 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!"); 11915 case ICmpInst::ICMP_EQ: 11916 case ICmpInst::ICMP_NE: 11917 if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS)) 11918 return true; 11919 break; 11920 case ICmpInst::ICMP_SLT: 11921 case ICmpInst::ICMP_SLE: 11922 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SLE, LHS, FoundLHS) && 11923 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGE, RHS, FoundRHS)) 11924 return true; 11925 break; 11926 case ICmpInst::ICMP_SGT: 11927 case ICmpInst::ICMP_SGE: 11928 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGE, LHS, FoundLHS) && 11929 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SLE, RHS, FoundRHS)) 11930 return true; 11931 break; 11932 case ICmpInst::ICMP_ULT: 11933 case ICmpInst::ICMP_ULE: 11934 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, LHS, FoundLHS) && 11935 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_UGE, RHS, FoundRHS)) 11936 return true; 11937 break; 11938 case ICmpInst::ICMP_UGT: 11939 case ICmpInst::ICMP_UGE: 11940 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_UGE, LHS, FoundLHS) && 11941 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, RHS, FoundRHS)) 11942 return true; 11943 break; 11944 } 11945 11946 // Maybe it can be proved via operations? 11947 if (isImpliedViaOperations(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11948 return true; 11949 11950 return false; 11951 } 11952 11953 bool ScalarEvolution::isImpliedCondOperandsViaRanges(ICmpInst::Predicate Pred, 11954 const SCEV *LHS, 11955 const SCEV *RHS, 11956 const SCEV *FoundLHS, 11957 const SCEV *FoundRHS) { 11958 if (!isa<SCEVConstant>(RHS) || !isa<SCEVConstant>(FoundRHS)) 11959 // The restriction on `FoundRHS` be lifted easily -- it exists only to 11960 // reduce the compile time impact of this optimization. 11961 return false; 11962 11963 Optional<APInt> Addend = computeConstantDifference(LHS, FoundLHS); 11964 if (!Addend) 11965 return false; 11966 11967 const APInt &ConstFoundRHS = cast<SCEVConstant>(FoundRHS)->getAPInt(); 11968 11969 // `FoundLHSRange` is the range we know `FoundLHS` to be in by virtue of the 11970 // antecedent "`FoundLHS` `Pred` `FoundRHS`". 11971 ConstantRange FoundLHSRange = 11972 ConstantRange::makeExactICmpRegion(Pred, ConstFoundRHS); 11973 11974 // Since `LHS` is `FoundLHS` + `Addend`, we can compute a range for `LHS`: 11975 ConstantRange LHSRange = FoundLHSRange.add(ConstantRange(*Addend)); 11976 11977 // We can also compute the range of values for `LHS` that satisfy the 11978 // consequent, "`LHS` `Pred` `RHS`": 11979 const APInt &ConstRHS = cast<SCEVConstant>(RHS)->getAPInt(); 11980 // The antecedent implies the consequent if every value of `LHS` that 11981 // satisfies the antecedent also satisfies the consequent. 11982 return LHSRange.icmp(Pred, ConstRHS); 11983 } 11984 11985 bool ScalarEvolution::canIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride, 11986 bool IsSigned) { 11987 assert(isKnownPositive(Stride) && "Positive stride expected!"); 11988 11989 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 11990 const SCEV *One = getOne(Stride->getType()); 11991 11992 if (IsSigned) { 11993 APInt MaxRHS = getSignedRangeMax(RHS); 11994 APInt MaxValue = APInt::getSignedMaxValue(BitWidth); 11995 APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One)); 11996 11997 // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow! 11998 return (std::move(MaxValue) - MaxStrideMinusOne).slt(MaxRHS); 11999 } 12000 12001 APInt MaxRHS = getUnsignedRangeMax(RHS); 12002 APInt MaxValue = APInt::getMaxValue(BitWidth); 12003 APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One)); 12004 12005 // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow! 12006 return (std::move(MaxValue) - MaxStrideMinusOne).ult(MaxRHS); 12007 } 12008 12009 bool ScalarEvolution::canIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride, 12010 bool IsSigned) { 12011 12012 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 12013 const SCEV *One = getOne(Stride->getType()); 12014 12015 if (IsSigned) { 12016 APInt MinRHS = getSignedRangeMin(RHS); 12017 APInt MinValue = APInt::getSignedMinValue(BitWidth); 12018 APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One)); 12019 12020 // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow! 12021 return (std::move(MinValue) + MaxStrideMinusOne).sgt(MinRHS); 12022 } 12023 12024 APInt MinRHS = getUnsignedRangeMin(RHS); 12025 APInt MinValue = APInt::getMinValue(BitWidth); 12026 APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One)); 12027 12028 // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow! 12029 return (std::move(MinValue) + MaxStrideMinusOne).ugt(MinRHS); 12030 } 12031 12032 const SCEV *ScalarEvolution::getUDivCeilSCEV(const SCEV *N, const SCEV *D) { 12033 // umin(N, 1) + floor((N - umin(N, 1)) / D) 12034 // This is equivalent to "1 + floor((N - 1) / D)" for N != 0. The umin 12035 // expression fixes the case of N=0. 12036 const SCEV *MinNOne = getUMinExpr(N, getOne(N->getType())); 12037 const SCEV *NMinusOne = getMinusSCEV(N, MinNOne); 12038 return getAddExpr(MinNOne, getUDivExpr(NMinusOne, D)); 12039 } 12040 12041 const SCEV *ScalarEvolution::computeMaxBECountForLT(const SCEV *Start, 12042 const SCEV *Stride, 12043 const SCEV *End, 12044 unsigned BitWidth, 12045 bool IsSigned) { 12046 // The logic in this function assumes we can represent a positive stride. 12047 // If we can't, the backedge-taken count must be zero. 12048 if (IsSigned && BitWidth == 1) 12049 return getZero(Stride->getType()); 12050 12051 // This code has only been closely audited for negative strides in the 12052 // unsigned comparison case, it may be correct for signed comparison, but 12053 // that needs to be established. 12054 assert((!IsSigned || !isKnownNonPositive(Stride)) && 12055 "Stride is expected strictly positive for signed case!"); 12056 12057 // Calculate the maximum backedge count based on the range of values 12058 // permitted by Start, End, and Stride. 12059 APInt MinStart = 12060 IsSigned ? getSignedRangeMin(Start) : getUnsignedRangeMin(Start); 12061 12062 APInt MinStride = 12063 IsSigned ? getSignedRangeMin(Stride) : getUnsignedRangeMin(Stride); 12064 12065 // We assume either the stride is positive, or the backedge-taken count 12066 // is zero. So force StrideForMaxBECount to be at least one. 12067 APInt One(BitWidth, 1); 12068 APInt StrideForMaxBECount = IsSigned ? APIntOps::smax(One, MinStride) 12069 : APIntOps::umax(One, MinStride); 12070 12071 APInt MaxValue = IsSigned ? APInt::getSignedMaxValue(BitWidth) 12072 : APInt::getMaxValue(BitWidth); 12073 APInt Limit = MaxValue - (StrideForMaxBECount - 1); 12074 12075 // Although End can be a MAX expression we estimate MaxEnd considering only 12076 // the case End = RHS of the loop termination condition. This is safe because 12077 // in the other case (End - Start) is zero, leading to a zero maximum backedge 12078 // taken count. 12079 APInt MaxEnd = IsSigned ? APIntOps::smin(getSignedRangeMax(End), Limit) 12080 : APIntOps::umin(getUnsignedRangeMax(End), Limit); 12081 12082 // MaxBECount = ceil((max(MaxEnd, MinStart) - MinStart) / Stride) 12083 MaxEnd = IsSigned ? APIntOps::smax(MaxEnd, MinStart) 12084 : APIntOps::umax(MaxEnd, MinStart); 12085 12086 return getUDivCeilSCEV(getConstant(MaxEnd - MinStart) /* Delta */, 12087 getConstant(StrideForMaxBECount) /* Step */); 12088 } 12089 12090 ScalarEvolution::ExitLimit 12091 ScalarEvolution::howManyLessThans(const SCEV *LHS, const SCEV *RHS, 12092 const Loop *L, bool IsSigned, 12093 bool ControlsExit, bool AllowPredicates) { 12094 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 12095 12096 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS); 12097 bool PredicatedIV = false; 12098 12099 auto canAssumeNoSelfWrap = [&](const SCEVAddRecExpr *AR) { 12100 // Can we prove this loop *must* be UB if overflow of IV occurs? 12101 // Reasoning goes as follows: 12102 // * Suppose the IV did self wrap. 12103 // * If Stride evenly divides the iteration space, then once wrap 12104 // occurs, the loop must revisit the same values. 12105 // * We know that RHS is invariant, and that none of those values 12106 // caused this exit to be taken previously. Thus, this exit is 12107 // dynamically dead. 12108 // * If this is the sole exit, then a dead exit implies the loop 12109 // must be infinite if there are no abnormal exits. 12110 // * If the loop were infinite, then it must either not be mustprogress 12111 // or have side effects. Otherwise, it must be UB. 12112 // * It can't (by assumption), be UB so we have contradicted our 12113 // premise and can conclude the IV did not in fact self-wrap. 12114 if (!isLoopInvariant(RHS, L)) 12115 return false; 12116 12117 auto *StrideC = dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this)); 12118 if (!StrideC || !StrideC->getAPInt().isPowerOf2()) 12119 return false; 12120 12121 if (!ControlsExit || !loopHasNoAbnormalExits(L)) 12122 return false; 12123 12124 return loopIsFiniteByAssumption(L); 12125 }; 12126 12127 if (!IV) { 12128 if (auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(LHS)) { 12129 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(ZExt->getOperand()); 12130 if (AR && AR->getLoop() == L && AR->isAffine()) { 12131 auto canProveNUW = [&]() { 12132 if (!isLoopInvariant(RHS, L)) 12133 return false; 12134 12135 if (!isKnownNonZero(AR->getStepRecurrence(*this))) 12136 // We need the sequence defined by AR to strictly increase in the 12137 // unsigned integer domain for the logic below to hold. 12138 return false; 12139 12140 const unsigned InnerBitWidth = getTypeSizeInBits(AR->getType()); 12141 const unsigned OuterBitWidth = getTypeSizeInBits(RHS->getType()); 12142 // If RHS <=u Limit, then there must exist a value V in the sequence 12143 // defined by AR (e.g. {Start,+,Step}) such that V >u RHS, and 12144 // V <=u UINT_MAX. Thus, we must exit the loop before unsigned 12145 // overflow occurs. This limit also implies that a signed comparison 12146 // (in the wide bitwidth) is equivalent to an unsigned comparison as 12147 // the high bits on both sides must be zero. 12148 APInt StrideMax = getUnsignedRangeMax(AR->getStepRecurrence(*this)); 12149 APInt Limit = APInt::getMaxValue(InnerBitWidth) - (StrideMax - 1); 12150 Limit = Limit.zext(OuterBitWidth); 12151 return getUnsignedRangeMax(applyLoopGuards(RHS, L)).ule(Limit); 12152 }; 12153 auto Flags = AR->getNoWrapFlags(); 12154 if (!hasFlags(Flags, SCEV::FlagNUW) && canProveNUW()) 12155 Flags = setFlags(Flags, SCEV::FlagNUW); 12156 12157 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), Flags); 12158 if (AR->hasNoUnsignedWrap()) { 12159 // Emulate what getZeroExtendExpr would have done during construction 12160 // if we'd been able to infer the fact just above at that time. 12161 const SCEV *Step = AR->getStepRecurrence(*this); 12162 Type *Ty = ZExt->getType(); 12163 auto *S = getAddRecExpr( 12164 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 0), 12165 getZeroExtendExpr(Step, Ty, 0), L, AR->getNoWrapFlags()); 12166 IV = dyn_cast<SCEVAddRecExpr>(S); 12167 } 12168 } 12169 } 12170 } 12171 12172 12173 if (!IV && AllowPredicates) { 12174 // Try to make this an AddRec using runtime tests, in the first X 12175 // iterations of this loop, where X is the SCEV expression found by the 12176 // algorithm below. 12177 IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates); 12178 PredicatedIV = true; 12179 } 12180 12181 // Avoid weird loops 12182 if (!IV || IV->getLoop() != L || !IV->isAffine()) 12183 return getCouldNotCompute(); 12184 12185 // A precondition of this method is that the condition being analyzed 12186 // reaches an exiting branch which dominates the latch. Given that, we can 12187 // assume that an increment which violates the nowrap specification and 12188 // produces poison must cause undefined behavior when the resulting poison 12189 // value is branched upon and thus we can conclude that the backedge is 12190 // taken no more often than would be required to produce that poison value. 12191 // Note that a well defined loop can exit on the iteration which violates 12192 // the nowrap specification if there is another exit (either explicit or 12193 // implicit/exceptional) which causes the loop to execute before the 12194 // exiting instruction we're analyzing would trigger UB. 12195 auto WrapType = IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW; 12196 bool NoWrap = ControlsExit && IV->getNoWrapFlags(WrapType); 12197 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT; 12198 12199 const SCEV *Stride = IV->getStepRecurrence(*this); 12200 12201 bool PositiveStride = isKnownPositive(Stride); 12202 12203 // Avoid negative or zero stride values. 12204 if (!PositiveStride) { 12205 // We can compute the correct backedge taken count for loops with unknown 12206 // strides if we can prove that the loop is not an infinite loop with side 12207 // effects. Here's the loop structure we are trying to handle - 12208 // 12209 // i = start 12210 // do { 12211 // A[i] = i; 12212 // i += s; 12213 // } while (i < end); 12214 // 12215 // The backedge taken count for such loops is evaluated as - 12216 // (max(end, start + stride) - start - 1) /u stride 12217 // 12218 // The additional preconditions that we need to check to prove correctness 12219 // of the above formula is as follows - 12220 // 12221 // a) IV is either nuw or nsw depending upon signedness (indicated by the 12222 // NoWrap flag). 12223 // b) the loop is guaranteed to be finite (e.g. is mustprogress and has 12224 // no side effects within the loop) 12225 // c) loop has a single static exit (with no abnormal exits) 12226 // 12227 // Precondition a) implies that if the stride is negative, this is a single 12228 // trip loop. The backedge taken count formula reduces to zero in this case. 12229 // 12230 // Precondition b) and c) combine to imply that if rhs is invariant in L, 12231 // then a zero stride means the backedge can't be taken without executing 12232 // undefined behavior. 12233 // 12234 // The positive stride case is the same as isKnownPositive(Stride) returning 12235 // true (original behavior of the function). 12236 // 12237 if (PredicatedIV || !NoWrap || !loopIsFiniteByAssumption(L) || 12238 !loopHasNoAbnormalExits(L)) 12239 return getCouldNotCompute(); 12240 12241 // This bailout is protecting the logic in computeMaxBECountForLT which 12242 // has not yet been sufficiently auditted or tested with negative strides. 12243 // We used to filter out all known-non-positive cases here, we're in the 12244 // process of being less restrictive bit by bit. 12245 if (IsSigned && isKnownNonPositive(Stride)) 12246 return getCouldNotCompute(); 12247 12248 if (!isKnownNonZero(Stride)) { 12249 // If we have a step of zero, and RHS isn't invariant in L, we don't know 12250 // if it might eventually be greater than start and if so, on which 12251 // iteration. We can't even produce a useful upper bound. 12252 if (!isLoopInvariant(RHS, L)) 12253 return getCouldNotCompute(); 12254 12255 // We allow a potentially zero stride, but we need to divide by stride 12256 // below. Since the loop can't be infinite and this check must control 12257 // the sole exit, we can infer the exit must be taken on the first 12258 // iteration (e.g. backedge count = 0) if the stride is zero. Given that, 12259 // we know the numerator in the divides below must be zero, so we can 12260 // pick an arbitrary non-zero value for the denominator (e.g. stride) 12261 // and produce the right result. 12262 // FIXME: Handle the case where Stride is poison? 12263 auto wouldZeroStrideBeUB = [&]() { 12264 // Proof by contradiction. Suppose the stride were zero. If we can 12265 // prove that the backedge *is* taken on the first iteration, then since 12266 // we know this condition controls the sole exit, we must have an 12267 // infinite loop. We can't have a (well defined) infinite loop per 12268 // check just above. 12269 // Note: The (Start - Stride) term is used to get the start' term from 12270 // (start' + stride,+,stride). Remember that we only care about the 12271 // result of this expression when stride == 0 at runtime. 12272 auto *StartIfZero = getMinusSCEV(IV->getStart(), Stride); 12273 return isLoopEntryGuardedByCond(L, Cond, StartIfZero, RHS); 12274 }; 12275 if (!wouldZeroStrideBeUB()) { 12276 Stride = getUMaxExpr(Stride, getOne(Stride->getType())); 12277 } 12278 } 12279 } else if (!Stride->isOne() && !NoWrap) { 12280 auto isUBOnWrap = [&]() { 12281 // From no-self-wrap, we need to then prove no-(un)signed-wrap. This 12282 // follows trivially from the fact that every (un)signed-wrapped, but 12283 // not self-wrapped value must be LT than the last value before 12284 // (un)signed wrap. Since we know that last value didn't exit, nor 12285 // will any smaller one. 12286 return canAssumeNoSelfWrap(IV); 12287 }; 12288 12289 // Avoid proven overflow cases: this will ensure that the backedge taken 12290 // count will not generate any unsigned overflow. Relaxed no-overflow 12291 // conditions exploit NoWrapFlags, allowing to optimize in presence of 12292 // undefined behaviors like the case of C language. 12293 if (canIVOverflowOnLT(RHS, Stride, IsSigned) && !isUBOnWrap()) 12294 return getCouldNotCompute(); 12295 } 12296 12297 // On all paths just preceeding, we established the following invariant: 12298 // IV can be assumed not to overflow up to and including the exiting 12299 // iteration. We proved this in one of two ways: 12300 // 1) We can show overflow doesn't occur before the exiting iteration 12301 // 1a) canIVOverflowOnLT, and b) step of one 12302 // 2) We can show that if overflow occurs, the loop must execute UB 12303 // before any possible exit. 12304 // Note that we have not yet proved RHS invariant (in general). 12305 12306 const SCEV *Start = IV->getStart(); 12307 12308 // Preserve pointer-typed Start/RHS to pass to isLoopEntryGuardedByCond. 12309 // If we convert to integers, isLoopEntryGuardedByCond will miss some cases. 12310 // Use integer-typed versions for actual computation; we can't subtract 12311 // pointers in general. 12312 const SCEV *OrigStart = Start; 12313 const SCEV *OrigRHS = RHS; 12314 if (Start->getType()->isPointerTy()) { 12315 Start = getLosslessPtrToIntExpr(Start); 12316 if (isa<SCEVCouldNotCompute>(Start)) 12317 return Start; 12318 } 12319 if (RHS->getType()->isPointerTy()) { 12320 RHS = getLosslessPtrToIntExpr(RHS); 12321 if (isa<SCEVCouldNotCompute>(RHS)) 12322 return RHS; 12323 } 12324 12325 // When the RHS is not invariant, we do not know the end bound of the loop and 12326 // cannot calculate the ExactBECount needed by ExitLimit. However, we can 12327 // calculate the MaxBECount, given the start, stride and max value for the end 12328 // bound of the loop (RHS), and the fact that IV does not overflow (which is 12329 // checked above). 12330 if (!isLoopInvariant(RHS, L)) { 12331 const SCEV *MaxBECount = computeMaxBECountForLT( 12332 Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned); 12333 return ExitLimit(getCouldNotCompute() /* ExactNotTaken */, MaxBECount, 12334 false /*MaxOrZero*/, Predicates); 12335 } 12336 12337 // We use the expression (max(End,Start)-Start)/Stride to describe the 12338 // backedge count, as if the backedge is taken at least once max(End,Start) 12339 // is End and so the result is as above, and if not max(End,Start) is Start 12340 // so we get a backedge count of zero. 12341 const SCEV *BECount = nullptr; 12342 auto *OrigStartMinusStride = getMinusSCEV(OrigStart, Stride); 12343 assert(isAvailableAtLoopEntry(OrigStartMinusStride, L) && "Must be!"); 12344 assert(isAvailableAtLoopEntry(OrigStart, L) && "Must be!"); 12345 assert(isAvailableAtLoopEntry(OrigRHS, L) && "Must be!"); 12346 // Can we prove (max(RHS,Start) > Start - Stride? 12347 if (isLoopEntryGuardedByCond(L, Cond, OrigStartMinusStride, OrigStart) && 12348 isLoopEntryGuardedByCond(L, Cond, OrigStartMinusStride, OrigRHS)) { 12349 // In this case, we can use a refined formula for computing backedge taken 12350 // count. The general formula remains: 12351 // "End-Start /uceiling Stride" where "End = max(RHS,Start)" 12352 // We want to use the alternate formula: 12353 // "((End - 1) - (Start - Stride)) /u Stride" 12354 // Let's do a quick case analysis to show these are equivalent under 12355 // our precondition that max(RHS,Start) > Start - Stride. 12356 // * For RHS <= Start, the backedge-taken count must be zero. 12357 // "((End - 1) - (Start - Stride)) /u Stride" reduces to 12358 // "((Start - 1) - (Start - Stride)) /u Stride" which simplies to 12359 // "Stride - 1 /u Stride" which is indeed zero for all non-zero values 12360 // of Stride. For 0 stride, we've use umin(1,Stride) above, reducing 12361 // this to the stride of 1 case. 12362 // * For RHS >= Start, the backedge count must be "RHS-Start /uceil Stride". 12363 // "((End - 1) - (Start - Stride)) /u Stride" reduces to 12364 // "((RHS - 1) - (Start - Stride)) /u Stride" reassociates to 12365 // "((RHS - (Start - Stride) - 1) /u Stride". 12366 // Our preconditions trivially imply no overflow in that form. 12367 const SCEV *MinusOne = getMinusOne(Stride->getType()); 12368 const SCEV *Numerator = 12369 getMinusSCEV(getAddExpr(RHS, MinusOne), getMinusSCEV(Start, Stride)); 12370 BECount = getUDivExpr(Numerator, Stride); 12371 } 12372 12373 const SCEV *BECountIfBackedgeTaken = nullptr; 12374 if (!BECount) { 12375 auto canProveRHSGreaterThanEqualStart = [&]() { 12376 auto CondGE = IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 12377 if (isLoopEntryGuardedByCond(L, CondGE, OrigRHS, OrigStart)) 12378 return true; 12379 12380 // (RHS > Start - 1) implies RHS >= Start. 12381 // * "RHS >= Start" is trivially equivalent to "RHS > Start - 1" if 12382 // "Start - 1" doesn't overflow. 12383 // * For signed comparison, if Start - 1 does overflow, it's equal 12384 // to INT_MAX, and "RHS >s INT_MAX" is trivially false. 12385 // * For unsigned comparison, if Start - 1 does overflow, it's equal 12386 // to UINT_MAX, and "RHS >u UINT_MAX" is trivially false. 12387 // 12388 // FIXME: Should isLoopEntryGuardedByCond do this for us? 12389 auto CondGT = IsSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT; 12390 auto *StartMinusOne = getAddExpr(OrigStart, 12391 getMinusOne(OrigStart->getType())); 12392 return isLoopEntryGuardedByCond(L, CondGT, OrigRHS, StartMinusOne); 12393 }; 12394 12395 // If we know that RHS >= Start in the context of loop, then we know that 12396 // max(RHS, Start) = RHS at this point. 12397 const SCEV *End; 12398 if (canProveRHSGreaterThanEqualStart()) { 12399 End = RHS; 12400 } else { 12401 // If RHS < Start, the backedge will be taken zero times. So in 12402 // general, we can write the backedge-taken count as: 12403 // 12404 // RHS >= Start ? ceil(RHS - Start) / Stride : 0 12405 // 12406 // We convert it to the following to make it more convenient for SCEV: 12407 // 12408 // ceil(max(RHS, Start) - Start) / Stride 12409 End = IsSigned ? getSMaxExpr(RHS, Start) : getUMaxExpr(RHS, Start); 12410 12411 // See what would happen if we assume the backedge is taken. This is 12412 // used to compute MaxBECount. 12413 BECountIfBackedgeTaken = getUDivCeilSCEV(getMinusSCEV(RHS, Start), Stride); 12414 } 12415 12416 // At this point, we know: 12417 // 12418 // 1. If IsSigned, Start <=s End; otherwise, Start <=u End 12419 // 2. The index variable doesn't overflow. 12420 // 12421 // Therefore, we know N exists such that 12422 // (Start + Stride * N) >= End, and computing "(Start + Stride * N)" 12423 // doesn't overflow. 12424 // 12425 // Using this information, try to prove whether the addition in 12426 // "(Start - End) + (Stride - 1)" has unsigned overflow. 12427 const SCEV *One = getOne(Stride->getType()); 12428 bool MayAddOverflow = [&] { 12429 if (auto *StrideC = dyn_cast<SCEVConstant>(Stride)) { 12430 if (StrideC->getAPInt().isPowerOf2()) { 12431 // Suppose Stride is a power of two, and Start/End are unsigned 12432 // integers. Let UMAX be the largest representable unsigned 12433 // integer. 12434 // 12435 // By the preconditions of this function, we know 12436 // "(Start + Stride * N) >= End", and this doesn't overflow. 12437 // As a formula: 12438 // 12439 // End <= (Start + Stride * N) <= UMAX 12440 // 12441 // Subtracting Start from all the terms: 12442 // 12443 // End - Start <= Stride * N <= UMAX - Start 12444 // 12445 // Since Start is unsigned, UMAX - Start <= UMAX. Therefore: 12446 // 12447 // End - Start <= Stride * N <= UMAX 12448 // 12449 // Stride * N is a multiple of Stride. Therefore, 12450 // 12451 // End - Start <= Stride * N <= UMAX - (UMAX mod Stride) 12452 // 12453 // Since Stride is a power of two, UMAX + 1 is divisible by Stride. 12454 // Therefore, UMAX mod Stride == Stride - 1. So we can write: 12455 // 12456 // End - Start <= Stride * N <= UMAX - Stride - 1 12457 // 12458 // Dropping the middle term: 12459 // 12460 // End - Start <= UMAX - Stride - 1 12461 // 12462 // Adding Stride - 1 to both sides: 12463 // 12464 // (End - Start) + (Stride - 1) <= UMAX 12465 // 12466 // In other words, the addition doesn't have unsigned overflow. 12467 // 12468 // A similar proof works if we treat Start/End as signed values. 12469 // Just rewrite steps before "End - Start <= Stride * N <= UMAX" to 12470 // use signed max instead of unsigned max. Note that we're trying 12471 // to prove a lack of unsigned overflow in either case. 12472 return false; 12473 } 12474 } 12475 if (Start == Stride || Start == getMinusSCEV(Stride, One)) { 12476 // If Start is equal to Stride, (End - Start) + (Stride - 1) == End - 1. 12477 // If !IsSigned, 0 <u Stride == Start <=u End; so 0 <u End - 1 <u End. 12478 // If IsSigned, 0 <s Stride == Start <=s End; so 0 <s End - 1 <s End. 12479 // 12480 // If Start is equal to Stride - 1, (End - Start) + Stride - 1 == End. 12481 return false; 12482 } 12483 return true; 12484 }(); 12485 12486 const SCEV *Delta = getMinusSCEV(End, Start); 12487 if (!MayAddOverflow) { 12488 // floor((D + (S - 1)) / S) 12489 // We prefer this formulation if it's legal because it's fewer operations. 12490 BECount = 12491 getUDivExpr(getAddExpr(Delta, getMinusSCEV(Stride, One)), Stride); 12492 } else { 12493 BECount = getUDivCeilSCEV(Delta, Stride); 12494 } 12495 } 12496 12497 const SCEV *MaxBECount; 12498 bool MaxOrZero = false; 12499 if (isa<SCEVConstant>(BECount)) { 12500 MaxBECount = BECount; 12501 } else if (BECountIfBackedgeTaken && 12502 isa<SCEVConstant>(BECountIfBackedgeTaken)) { 12503 // If we know exactly how many times the backedge will be taken if it's 12504 // taken at least once, then the backedge count will either be that or 12505 // zero. 12506 MaxBECount = BECountIfBackedgeTaken; 12507 MaxOrZero = true; 12508 } else { 12509 MaxBECount = computeMaxBECountForLT( 12510 Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned); 12511 } 12512 12513 if (isa<SCEVCouldNotCompute>(MaxBECount) && 12514 !isa<SCEVCouldNotCompute>(BECount)) 12515 MaxBECount = getConstant(getUnsignedRangeMax(BECount)); 12516 12517 return ExitLimit(BECount, MaxBECount, MaxOrZero, Predicates); 12518 } 12519 12520 ScalarEvolution::ExitLimit 12521 ScalarEvolution::howManyGreaterThans(const SCEV *LHS, const SCEV *RHS, 12522 const Loop *L, bool IsSigned, 12523 bool ControlsExit, bool AllowPredicates) { 12524 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 12525 // We handle only IV > Invariant 12526 if (!isLoopInvariant(RHS, L)) 12527 return getCouldNotCompute(); 12528 12529 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS); 12530 if (!IV && AllowPredicates) 12531 // Try to make this an AddRec using runtime tests, in the first X 12532 // iterations of this loop, where X is the SCEV expression found by the 12533 // algorithm below. 12534 IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates); 12535 12536 // Avoid weird loops 12537 if (!IV || IV->getLoop() != L || !IV->isAffine()) 12538 return getCouldNotCompute(); 12539 12540 auto WrapType = IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW; 12541 bool NoWrap = ControlsExit && IV->getNoWrapFlags(WrapType); 12542 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT; 12543 12544 const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this)); 12545 12546 // Avoid negative or zero stride values 12547 if (!isKnownPositive(Stride)) 12548 return getCouldNotCompute(); 12549 12550 // Avoid proven overflow cases: this will ensure that the backedge taken count 12551 // will not generate any unsigned overflow. Relaxed no-overflow conditions 12552 // exploit NoWrapFlags, allowing to optimize in presence of undefined 12553 // behaviors like the case of C language. 12554 if (!Stride->isOne() && !NoWrap) 12555 if (canIVOverflowOnGT(RHS, Stride, IsSigned)) 12556 return getCouldNotCompute(); 12557 12558 const SCEV *Start = IV->getStart(); 12559 const SCEV *End = RHS; 12560 if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS)) { 12561 // If we know that Start >= RHS in the context of loop, then we know that 12562 // min(RHS, Start) = RHS at this point. 12563 if (isLoopEntryGuardedByCond( 12564 L, IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE, Start, RHS)) 12565 End = RHS; 12566 else 12567 End = IsSigned ? getSMinExpr(RHS, Start) : getUMinExpr(RHS, Start); 12568 } 12569 12570 if (Start->getType()->isPointerTy()) { 12571 Start = getLosslessPtrToIntExpr(Start); 12572 if (isa<SCEVCouldNotCompute>(Start)) 12573 return Start; 12574 } 12575 if (End->getType()->isPointerTy()) { 12576 End = getLosslessPtrToIntExpr(End); 12577 if (isa<SCEVCouldNotCompute>(End)) 12578 return End; 12579 } 12580 12581 // Compute ((Start - End) + (Stride - 1)) / Stride. 12582 // FIXME: This can overflow. Holding off on fixing this for now; 12583 // howManyGreaterThans will hopefully be gone soon. 12584 const SCEV *One = getOne(Stride->getType()); 12585 const SCEV *BECount = getUDivExpr( 12586 getAddExpr(getMinusSCEV(Start, End), getMinusSCEV(Stride, One)), Stride); 12587 12588 APInt MaxStart = IsSigned ? getSignedRangeMax(Start) 12589 : getUnsignedRangeMax(Start); 12590 12591 APInt MinStride = IsSigned ? getSignedRangeMin(Stride) 12592 : getUnsignedRangeMin(Stride); 12593 12594 unsigned BitWidth = getTypeSizeInBits(LHS->getType()); 12595 APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1) 12596 : APInt::getMinValue(BitWidth) + (MinStride - 1); 12597 12598 // Although End can be a MIN expression we estimate MinEnd considering only 12599 // the case End = RHS. This is safe because in the other case (Start - End) 12600 // is zero, leading to a zero maximum backedge taken count. 12601 APInt MinEnd = 12602 IsSigned ? APIntOps::smax(getSignedRangeMin(RHS), Limit) 12603 : APIntOps::umax(getUnsignedRangeMin(RHS), Limit); 12604 12605 const SCEV *MaxBECount = isa<SCEVConstant>(BECount) 12606 ? BECount 12607 : getUDivCeilSCEV(getConstant(MaxStart - MinEnd), 12608 getConstant(MinStride)); 12609 12610 if (isa<SCEVCouldNotCompute>(MaxBECount)) 12611 MaxBECount = BECount; 12612 12613 return ExitLimit(BECount, MaxBECount, false, Predicates); 12614 } 12615 12616 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(const ConstantRange &Range, 12617 ScalarEvolution &SE) const { 12618 if (Range.isFullSet()) // Infinite loop. 12619 return SE.getCouldNotCompute(); 12620 12621 // If the start is a non-zero constant, shift the range to simplify things. 12622 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart())) 12623 if (!SC->getValue()->isZero()) { 12624 SmallVector<const SCEV *, 4> Operands(operands()); 12625 Operands[0] = SE.getZero(SC->getType()); 12626 const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(), 12627 getNoWrapFlags(FlagNW)); 12628 if (const auto *ShiftedAddRec = dyn_cast<SCEVAddRecExpr>(Shifted)) 12629 return ShiftedAddRec->getNumIterationsInRange( 12630 Range.subtract(SC->getAPInt()), SE); 12631 // This is strange and shouldn't happen. 12632 return SE.getCouldNotCompute(); 12633 } 12634 12635 // The only time we can solve this is when we have all constant indices. 12636 // Otherwise, we cannot determine the overflow conditions. 12637 if (any_of(operands(), [](const SCEV *Op) { return !isa<SCEVConstant>(Op); })) 12638 return SE.getCouldNotCompute(); 12639 12640 // Okay at this point we know that all elements of the chrec are constants and 12641 // that the start element is zero. 12642 12643 // First check to see if the range contains zero. If not, the first 12644 // iteration exits. 12645 unsigned BitWidth = SE.getTypeSizeInBits(getType()); 12646 if (!Range.contains(APInt(BitWidth, 0))) 12647 return SE.getZero(getType()); 12648 12649 if (isAffine()) { 12650 // If this is an affine expression then we have this situation: 12651 // Solve {0,+,A} in Range === Ax in Range 12652 12653 // We know that zero is in the range. If A is positive then we know that 12654 // the upper value of the range must be the first possible exit value. 12655 // If A is negative then the lower of the range is the last possible loop 12656 // value. Also note that we already checked for a full range. 12657 APInt A = cast<SCEVConstant>(getOperand(1))->getAPInt(); 12658 APInt End = A.sge(1) ? (Range.getUpper() - 1) : Range.getLower(); 12659 12660 // The exit value should be (End+A)/A. 12661 APInt ExitVal = (End + A).udiv(A); 12662 ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal); 12663 12664 // Evaluate at the exit value. If we really did fall out of the valid 12665 // range, then we computed our trip count, otherwise wrap around or other 12666 // things must have happened. 12667 ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE); 12668 if (Range.contains(Val->getValue())) 12669 return SE.getCouldNotCompute(); // Something strange happened 12670 12671 // Ensure that the previous value is in the range. 12672 assert(Range.contains( 12673 EvaluateConstantChrecAtConstant(this, 12674 ConstantInt::get(SE.getContext(), ExitVal - 1), SE)->getValue()) && 12675 "Linear scev computation is off in a bad way!"); 12676 return SE.getConstant(ExitValue); 12677 } 12678 12679 if (isQuadratic()) { 12680 if (auto S = SolveQuadraticAddRecRange(this, Range, SE)) 12681 return SE.getConstant(S.getValue()); 12682 } 12683 12684 return SE.getCouldNotCompute(); 12685 } 12686 12687 const SCEVAddRecExpr * 12688 SCEVAddRecExpr::getPostIncExpr(ScalarEvolution &SE) const { 12689 assert(getNumOperands() > 1 && "AddRec with zero step?"); 12690 // There is a temptation to just call getAddExpr(this, getStepRecurrence(SE)), 12691 // but in this case we cannot guarantee that the value returned will be an 12692 // AddRec because SCEV does not have a fixed point where it stops 12693 // simplification: it is legal to return ({rec1} + {rec2}). For example, it 12694 // may happen if we reach arithmetic depth limit while simplifying. So we 12695 // construct the returned value explicitly. 12696 SmallVector<const SCEV *, 3> Ops; 12697 // If this is {A,+,B,+,C,...,+,N}, then its step is {B,+,C,+,...,+,N}, and 12698 // (this + Step) is {A+B,+,B+C,+...,+,N}. 12699 for (unsigned i = 0, e = getNumOperands() - 1; i < e; ++i) 12700 Ops.push_back(SE.getAddExpr(getOperand(i), getOperand(i + 1))); 12701 // We know that the last operand is not a constant zero (otherwise it would 12702 // have been popped out earlier). This guarantees us that if the result has 12703 // the same last operand, then it will also not be popped out, meaning that 12704 // the returned value will be an AddRec. 12705 const SCEV *Last = getOperand(getNumOperands() - 1); 12706 assert(!Last->isZero() && "Recurrency with zero step?"); 12707 Ops.push_back(Last); 12708 return cast<SCEVAddRecExpr>(SE.getAddRecExpr(Ops, getLoop(), 12709 SCEV::FlagAnyWrap)); 12710 } 12711 12712 // Return true when S contains at least an undef value. 12713 bool ScalarEvolution::containsUndefs(const SCEV *S) const { 12714 return SCEVExprContains(S, [](const SCEV *S) { 12715 if (const auto *SU = dyn_cast<SCEVUnknown>(S)) 12716 return isa<UndefValue>(SU->getValue()); 12717 return false; 12718 }); 12719 } 12720 12721 /// Return the size of an element read or written by Inst. 12722 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) { 12723 Type *Ty; 12724 if (StoreInst *Store = dyn_cast<StoreInst>(Inst)) 12725 Ty = Store->getValueOperand()->getType(); 12726 else if (LoadInst *Load = dyn_cast<LoadInst>(Inst)) 12727 Ty = Load->getType(); 12728 else 12729 return nullptr; 12730 12731 Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty)); 12732 return getSizeOfExpr(ETy, Ty); 12733 } 12734 12735 //===----------------------------------------------------------------------===// 12736 // SCEVCallbackVH Class Implementation 12737 //===----------------------------------------------------------------------===// 12738 12739 void ScalarEvolution::SCEVCallbackVH::deleted() { 12740 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!"); 12741 if (PHINode *PN = dyn_cast<PHINode>(getValPtr())) 12742 SE->ConstantEvolutionLoopExitValue.erase(PN); 12743 SE->eraseValueFromMap(getValPtr()); 12744 // this now dangles! 12745 } 12746 12747 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) { 12748 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!"); 12749 12750 // Forget all the expressions associated with users of the old value, 12751 // so that future queries will recompute the expressions using the new 12752 // value. 12753 Value *Old = getValPtr(); 12754 SmallVector<User *, 16> Worklist(Old->users()); 12755 SmallPtrSet<User *, 8> Visited; 12756 while (!Worklist.empty()) { 12757 User *U = Worklist.pop_back_val(); 12758 // Deleting the Old value will cause this to dangle. Postpone 12759 // that until everything else is done. 12760 if (U == Old) 12761 continue; 12762 if (!Visited.insert(U).second) 12763 continue; 12764 if (PHINode *PN = dyn_cast<PHINode>(U)) 12765 SE->ConstantEvolutionLoopExitValue.erase(PN); 12766 SE->eraseValueFromMap(U); 12767 llvm::append_range(Worklist, U->users()); 12768 } 12769 // Delete the Old value. 12770 if (PHINode *PN = dyn_cast<PHINode>(Old)) 12771 SE->ConstantEvolutionLoopExitValue.erase(PN); 12772 SE->eraseValueFromMap(Old); 12773 // this now dangles! 12774 } 12775 12776 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se) 12777 : CallbackVH(V), SE(se) {} 12778 12779 //===----------------------------------------------------------------------===// 12780 // ScalarEvolution Class Implementation 12781 //===----------------------------------------------------------------------===// 12782 12783 ScalarEvolution::ScalarEvolution(Function &F, TargetLibraryInfo &TLI, 12784 AssumptionCache &AC, DominatorTree &DT, 12785 LoopInfo &LI) 12786 : F(F), TLI(TLI), AC(AC), DT(DT), LI(LI), 12787 CouldNotCompute(new SCEVCouldNotCompute()), ValuesAtScopes(64), 12788 LoopDispositions(64), BlockDispositions(64) { 12789 // To use guards for proving predicates, we need to scan every instruction in 12790 // relevant basic blocks, and not just terminators. Doing this is a waste of 12791 // time if the IR does not actually contain any calls to 12792 // @llvm.experimental.guard, so do a quick check and remember this beforehand. 12793 // 12794 // This pessimizes the case where a pass that preserves ScalarEvolution wants 12795 // to _add_ guards to the module when there weren't any before, and wants 12796 // ScalarEvolution to optimize based on those guards. For now we prefer to be 12797 // efficient in lieu of being smart in that rather obscure case. 12798 12799 auto *GuardDecl = F.getParent()->getFunction( 12800 Intrinsic::getName(Intrinsic::experimental_guard)); 12801 HasGuards = GuardDecl && !GuardDecl->use_empty(); 12802 } 12803 12804 ScalarEvolution::ScalarEvolution(ScalarEvolution &&Arg) 12805 : F(Arg.F), HasGuards(Arg.HasGuards), TLI(Arg.TLI), AC(Arg.AC), DT(Arg.DT), 12806 LI(Arg.LI), CouldNotCompute(std::move(Arg.CouldNotCompute)), 12807 ValueExprMap(std::move(Arg.ValueExprMap)), 12808 PendingLoopPredicates(std::move(Arg.PendingLoopPredicates)), 12809 PendingPhiRanges(std::move(Arg.PendingPhiRanges)), 12810 PendingMerges(std::move(Arg.PendingMerges)), 12811 MinTrailingZerosCache(std::move(Arg.MinTrailingZerosCache)), 12812 BackedgeTakenCounts(std::move(Arg.BackedgeTakenCounts)), 12813 PredicatedBackedgeTakenCounts( 12814 std::move(Arg.PredicatedBackedgeTakenCounts)), 12815 BECountUsers(std::move(Arg.BECountUsers)), 12816 ConstantEvolutionLoopExitValue( 12817 std::move(Arg.ConstantEvolutionLoopExitValue)), 12818 ValuesAtScopes(std::move(Arg.ValuesAtScopes)), 12819 ValuesAtScopesUsers(std::move(Arg.ValuesAtScopesUsers)), 12820 LoopDispositions(std::move(Arg.LoopDispositions)), 12821 LoopPropertiesCache(std::move(Arg.LoopPropertiesCache)), 12822 BlockDispositions(std::move(Arg.BlockDispositions)), 12823 SCEVUsers(std::move(Arg.SCEVUsers)), 12824 UnsignedRanges(std::move(Arg.UnsignedRanges)), 12825 SignedRanges(std::move(Arg.SignedRanges)), 12826 UniqueSCEVs(std::move(Arg.UniqueSCEVs)), 12827 UniquePreds(std::move(Arg.UniquePreds)), 12828 SCEVAllocator(std::move(Arg.SCEVAllocator)), 12829 LoopUsers(std::move(Arg.LoopUsers)), 12830 PredicatedSCEVRewrites(std::move(Arg.PredicatedSCEVRewrites)), 12831 FirstUnknown(Arg.FirstUnknown) { 12832 Arg.FirstUnknown = nullptr; 12833 } 12834 12835 ScalarEvolution::~ScalarEvolution() { 12836 // Iterate through all the SCEVUnknown instances and call their 12837 // destructors, so that they release their references to their values. 12838 for (SCEVUnknown *U = FirstUnknown; U;) { 12839 SCEVUnknown *Tmp = U; 12840 U = U->Next; 12841 Tmp->~SCEVUnknown(); 12842 } 12843 FirstUnknown = nullptr; 12844 12845 ExprValueMap.clear(); 12846 ValueExprMap.clear(); 12847 HasRecMap.clear(); 12848 BackedgeTakenCounts.clear(); 12849 PredicatedBackedgeTakenCounts.clear(); 12850 12851 assert(PendingLoopPredicates.empty() && "isImpliedCond garbage"); 12852 assert(PendingPhiRanges.empty() && "getRangeRef garbage"); 12853 assert(PendingMerges.empty() && "isImpliedViaMerge garbage"); 12854 assert(!WalkingBEDominatingConds && "isLoopBackedgeGuardedByCond garbage!"); 12855 assert(!ProvingSplitPredicate && "ProvingSplitPredicate garbage!"); 12856 } 12857 12858 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) { 12859 return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L)); 12860 } 12861 12862 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE, 12863 const Loop *L) { 12864 // Print all inner loops first 12865 for (Loop *I : *L) 12866 PrintLoopInfo(OS, SE, I); 12867 12868 OS << "Loop "; 12869 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12870 OS << ": "; 12871 12872 SmallVector<BasicBlock *, 8> ExitingBlocks; 12873 L->getExitingBlocks(ExitingBlocks); 12874 if (ExitingBlocks.size() != 1) 12875 OS << "<multiple exits> "; 12876 12877 if (SE->hasLoopInvariantBackedgeTakenCount(L)) 12878 OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L) << "\n"; 12879 else 12880 OS << "Unpredictable backedge-taken count.\n"; 12881 12882 if (ExitingBlocks.size() > 1) 12883 for (BasicBlock *ExitingBlock : ExitingBlocks) { 12884 OS << " exit count for " << ExitingBlock->getName() << ": " 12885 << *SE->getExitCount(L, ExitingBlock) << "\n"; 12886 } 12887 12888 OS << "Loop "; 12889 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12890 OS << ": "; 12891 12892 if (!isa<SCEVCouldNotCompute>(SE->getConstantMaxBackedgeTakenCount(L))) { 12893 OS << "max backedge-taken count is " << *SE->getConstantMaxBackedgeTakenCount(L); 12894 if (SE->isBackedgeTakenCountMaxOrZero(L)) 12895 OS << ", actual taken count either this or zero."; 12896 } else { 12897 OS << "Unpredictable max backedge-taken count. "; 12898 } 12899 12900 OS << "\n" 12901 "Loop "; 12902 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12903 OS << ": "; 12904 12905 SmallVector<const SCEVPredicate *, 4> Preds; 12906 auto PBT = SE->getPredicatedBackedgeTakenCount(L, Preds); 12907 if (!isa<SCEVCouldNotCompute>(PBT)) { 12908 OS << "Predicated backedge-taken count is " << *PBT << "\n"; 12909 OS << " Predicates:\n"; 12910 for (auto *P : Preds) 12911 P->print(OS, 4); 12912 } else { 12913 OS << "Unpredictable predicated backedge-taken count. "; 12914 } 12915 OS << "\n"; 12916 12917 if (SE->hasLoopInvariantBackedgeTakenCount(L)) { 12918 OS << "Loop "; 12919 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12920 OS << ": "; 12921 OS << "Trip multiple is " << SE->getSmallConstantTripMultiple(L) << "\n"; 12922 } 12923 } 12924 12925 static StringRef loopDispositionToStr(ScalarEvolution::LoopDisposition LD) { 12926 switch (LD) { 12927 case ScalarEvolution::LoopVariant: 12928 return "Variant"; 12929 case ScalarEvolution::LoopInvariant: 12930 return "Invariant"; 12931 case ScalarEvolution::LoopComputable: 12932 return "Computable"; 12933 } 12934 llvm_unreachable("Unknown ScalarEvolution::LoopDisposition kind!"); 12935 } 12936 12937 void ScalarEvolution::print(raw_ostream &OS) const { 12938 // ScalarEvolution's implementation of the print method is to print 12939 // out SCEV values of all instructions that are interesting. Doing 12940 // this potentially causes it to create new SCEV objects though, 12941 // which technically conflicts with the const qualifier. This isn't 12942 // observable from outside the class though, so casting away the 12943 // const isn't dangerous. 12944 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this); 12945 12946 if (ClassifyExpressions) { 12947 OS << "Classifying expressions for: "; 12948 F.printAsOperand(OS, /*PrintType=*/false); 12949 OS << "\n"; 12950 for (Instruction &I : instructions(F)) 12951 if (isSCEVable(I.getType()) && !isa<CmpInst>(I)) { 12952 OS << I << '\n'; 12953 OS << " --> "; 12954 const SCEV *SV = SE.getSCEV(&I); 12955 SV->print(OS); 12956 if (!isa<SCEVCouldNotCompute>(SV)) { 12957 OS << " U: "; 12958 SE.getUnsignedRange(SV).print(OS); 12959 OS << " S: "; 12960 SE.getSignedRange(SV).print(OS); 12961 } 12962 12963 const Loop *L = LI.getLoopFor(I.getParent()); 12964 12965 const SCEV *AtUse = SE.getSCEVAtScope(SV, L); 12966 if (AtUse != SV) { 12967 OS << " --> "; 12968 AtUse->print(OS); 12969 if (!isa<SCEVCouldNotCompute>(AtUse)) { 12970 OS << " U: "; 12971 SE.getUnsignedRange(AtUse).print(OS); 12972 OS << " S: "; 12973 SE.getSignedRange(AtUse).print(OS); 12974 } 12975 } 12976 12977 if (L) { 12978 OS << "\t\t" "Exits: "; 12979 const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop()); 12980 if (!SE.isLoopInvariant(ExitValue, L)) { 12981 OS << "<<Unknown>>"; 12982 } else { 12983 OS << *ExitValue; 12984 } 12985 12986 bool First = true; 12987 for (auto *Iter = L; Iter; Iter = Iter->getParentLoop()) { 12988 if (First) { 12989 OS << "\t\t" "LoopDispositions: { "; 12990 First = false; 12991 } else { 12992 OS << ", "; 12993 } 12994 12995 Iter->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12996 OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, Iter)); 12997 } 12998 12999 for (auto *InnerL : depth_first(L)) { 13000 if (InnerL == L) 13001 continue; 13002 if (First) { 13003 OS << "\t\t" "LoopDispositions: { "; 13004 First = false; 13005 } else { 13006 OS << ", "; 13007 } 13008 13009 InnerL->getHeader()->printAsOperand(OS, /*PrintType=*/false); 13010 OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, InnerL)); 13011 } 13012 13013 OS << " }"; 13014 } 13015 13016 OS << "\n"; 13017 } 13018 } 13019 13020 OS << "Determining loop execution counts for: "; 13021 F.printAsOperand(OS, /*PrintType=*/false); 13022 OS << "\n"; 13023 for (Loop *I : LI) 13024 PrintLoopInfo(OS, &SE, I); 13025 } 13026 13027 ScalarEvolution::LoopDisposition 13028 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) { 13029 auto &Values = LoopDispositions[S]; 13030 for (auto &V : Values) { 13031 if (V.getPointer() == L) 13032 return V.getInt(); 13033 } 13034 Values.emplace_back(L, LoopVariant); 13035 LoopDisposition D = computeLoopDisposition(S, L); 13036 auto &Values2 = LoopDispositions[S]; 13037 for (auto &V : llvm::reverse(Values2)) { 13038 if (V.getPointer() == L) { 13039 V.setInt(D); 13040 break; 13041 } 13042 } 13043 return D; 13044 } 13045 13046 ScalarEvolution::LoopDisposition 13047 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) { 13048 switch (S->getSCEVType()) { 13049 case scConstant: 13050 return LoopInvariant; 13051 case scPtrToInt: 13052 case scTruncate: 13053 case scZeroExtend: 13054 case scSignExtend: 13055 return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L); 13056 case scAddRecExpr: { 13057 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S); 13058 13059 // If L is the addrec's loop, it's computable. 13060 if (AR->getLoop() == L) 13061 return LoopComputable; 13062 13063 // Add recurrences are never invariant in the function-body (null loop). 13064 if (!L) 13065 return LoopVariant; 13066 13067 // Everything that is not defined at loop entry is variant. 13068 if (DT.dominates(L->getHeader(), AR->getLoop()->getHeader())) 13069 return LoopVariant; 13070 assert(!L->contains(AR->getLoop()) && "Containing loop's header does not" 13071 " dominate the contained loop's header?"); 13072 13073 // This recurrence is invariant w.r.t. L if AR's loop contains L. 13074 if (AR->getLoop()->contains(L)) 13075 return LoopInvariant; 13076 13077 // This recurrence is variant w.r.t. L if any of its operands 13078 // are variant. 13079 for (auto *Op : AR->operands()) 13080 if (!isLoopInvariant(Op, L)) 13081 return LoopVariant; 13082 13083 // Otherwise it's loop-invariant. 13084 return LoopInvariant; 13085 } 13086 case scAddExpr: 13087 case scMulExpr: 13088 case scUMaxExpr: 13089 case scSMaxExpr: 13090 case scUMinExpr: 13091 case scSMinExpr: 13092 case scSequentialUMinExpr: { 13093 bool HasVarying = false; 13094 for (auto *Op : cast<SCEVNAryExpr>(S)->operands()) { 13095 LoopDisposition D = getLoopDisposition(Op, L); 13096 if (D == LoopVariant) 13097 return LoopVariant; 13098 if (D == LoopComputable) 13099 HasVarying = true; 13100 } 13101 return HasVarying ? LoopComputable : LoopInvariant; 13102 } 13103 case scUDivExpr: { 13104 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S); 13105 LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L); 13106 if (LD == LoopVariant) 13107 return LoopVariant; 13108 LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L); 13109 if (RD == LoopVariant) 13110 return LoopVariant; 13111 return (LD == LoopInvariant && RD == LoopInvariant) ? 13112 LoopInvariant : LoopComputable; 13113 } 13114 case scUnknown: 13115 // All non-instruction values are loop invariant. All instructions are loop 13116 // invariant if they are not contained in the specified loop. 13117 // Instructions are never considered invariant in the function body 13118 // (null loop) because they are defined within the "loop". 13119 if (auto *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) 13120 return (L && !L->contains(I)) ? LoopInvariant : LoopVariant; 13121 return LoopInvariant; 13122 case scCouldNotCompute: 13123 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 13124 } 13125 llvm_unreachable("Unknown SCEV kind!"); 13126 } 13127 13128 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) { 13129 return getLoopDisposition(S, L) == LoopInvariant; 13130 } 13131 13132 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) { 13133 return getLoopDisposition(S, L) == LoopComputable; 13134 } 13135 13136 ScalarEvolution::BlockDisposition 13137 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) { 13138 auto &Values = BlockDispositions[S]; 13139 for (auto &V : Values) { 13140 if (V.getPointer() == BB) 13141 return V.getInt(); 13142 } 13143 Values.emplace_back(BB, DoesNotDominateBlock); 13144 BlockDisposition D = computeBlockDisposition(S, BB); 13145 auto &Values2 = BlockDispositions[S]; 13146 for (auto &V : llvm::reverse(Values2)) { 13147 if (V.getPointer() == BB) { 13148 V.setInt(D); 13149 break; 13150 } 13151 } 13152 return D; 13153 } 13154 13155 ScalarEvolution::BlockDisposition 13156 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) { 13157 switch (S->getSCEVType()) { 13158 case scConstant: 13159 return ProperlyDominatesBlock; 13160 case scPtrToInt: 13161 case scTruncate: 13162 case scZeroExtend: 13163 case scSignExtend: 13164 return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB); 13165 case scAddRecExpr: { 13166 // This uses a "dominates" query instead of "properly dominates" query 13167 // to test for proper dominance too, because the instruction which 13168 // produces the addrec's value is a PHI, and a PHI effectively properly 13169 // dominates its entire containing block. 13170 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S); 13171 if (!DT.dominates(AR->getLoop()->getHeader(), BB)) 13172 return DoesNotDominateBlock; 13173 13174 // Fall through into SCEVNAryExpr handling. 13175 LLVM_FALLTHROUGH; 13176 } 13177 case scAddExpr: 13178 case scMulExpr: 13179 case scUMaxExpr: 13180 case scSMaxExpr: 13181 case scUMinExpr: 13182 case scSMinExpr: 13183 case scSequentialUMinExpr: { 13184 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S); 13185 bool Proper = true; 13186 for (const SCEV *NAryOp : NAry->operands()) { 13187 BlockDisposition D = getBlockDisposition(NAryOp, BB); 13188 if (D == DoesNotDominateBlock) 13189 return DoesNotDominateBlock; 13190 if (D == DominatesBlock) 13191 Proper = false; 13192 } 13193 return Proper ? ProperlyDominatesBlock : DominatesBlock; 13194 } 13195 case scUDivExpr: { 13196 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S); 13197 const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS(); 13198 BlockDisposition LD = getBlockDisposition(LHS, BB); 13199 if (LD == DoesNotDominateBlock) 13200 return DoesNotDominateBlock; 13201 BlockDisposition RD = getBlockDisposition(RHS, BB); 13202 if (RD == DoesNotDominateBlock) 13203 return DoesNotDominateBlock; 13204 return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ? 13205 ProperlyDominatesBlock : DominatesBlock; 13206 } 13207 case scUnknown: 13208 if (Instruction *I = 13209 dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) { 13210 if (I->getParent() == BB) 13211 return DominatesBlock; 13212 if (DT.properlyDominates(I->getParent(), BB)) 13213 return ProperlyDominatesBlock; 13214 return DoesNotDominateBlock; 13215 } 13216 return ProperlyDominatesBlock; 13217 case scCouldNotCompute: 13218 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 13219 } 13220 llvm_unreachable("Unknown SCEV kind!"); 13221 } 13222 13223 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) { 13224 return getBlockDisposition(S, BB) >= DominatesBlock; 13225 } 13226 13227 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) { 13228 return getBlockDisposition(S, BB) == ProperlyDominatesBlock; 13229 } 13230 13231 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const { 13232 return SCEVExprContains(S, [&](const SCEV *Expr) { return Expr == Op; }); 13233 } 13234 13235 void ScalarEvolution::forgetBackedgeTakenCounts(const Loop *L, 13236 bool Predicated) { 13237 auto &BECounts = 13238 Predicated ? PredicatedBackedgeTakenCounts : BackedgeTakenCounts; 13239 auto It = BECounts.find(L); 13240 if (It != BECounts.end()) { 13241 for (const ExitNotTakenInfo &ENT : It->second.ExitNotTaken) { 13242 if (!isa<SCEVConstant>(ENT.ExactNotTaken)) { 13243 auto UserIt = BECountUsers.find(ENT.ExactNotTaken); 13244 assert(UserIt != BECountUsers.end()); 13245 UserIt->second.erase({L, Predicated}); 13246 } 13247 } 13248 BECounts.erase(It); 13249 } 13250 } 13251 13252 void ScalarEvolution::forgetMemoizedResults(ArrayRef<const SCEV *> SCEVs) { 13253 SmallPtrSet<const SCEV *, 8> ToForget(SCEVs.begin(), SCEVs.end()); 13254 SmallVector<const SCEV *, 8> Worklist(ToForget.begin(), ToForget.end()); 13255 13256 while (!Worklist.empty()) { 13257 const SCEV *Curr = Worklist.pop_back_val(); 13258 auto Users = SCEVUsers.find(Curr); 13259 if (Users != SCEVUsers.end()) 13260 for (auto *User : Users->second) 13261 if (ToForget.insert(User).second) 13262 Worklist.push_back(User); 13263 } 13264 13265 for (auto *S : ToForget) 13266 forgetMemoizedResultsImpl(S); 13267 13268 for (auto I = PredicatedSCEVRewrites.begin(); 13269 I != PredicatedSCEVRewrites.end();) { 13270 std::pair<const SCEV *, const Loop *> Entry = I->first; 13271 if (ToForget.count(Entry.first)) 13272 PredicatedSCEVRewrites.erase(I++); 13273 else 13274 ++I; 13275 } 13276 } 13277 13278 void ScalarEvolution::forgetMemoizedResultsImpl(const SCEV *S) { 13279 LoopDispositions.erase(S); 13280 BlockDispositions.erase(S); 13281 UnsignedRanges.erase(S); 13282 SignedRanges.erase(S); 13283 HasRecMap.erase(S); 13284 MinTrailingZerosCache.erase(S); 13285 13286 auto ExprIt = ExprValueMap.find(S); 13287 if (ExprIt != ExprValueMap.end()) { 13288 for (auto &ValueAndOffset : ExprIt->second) { 13289 if (ValueAndOffset.second == nullptr) { 13290 auto ValueIt = ValueExprMap.find_as(ValueAndOffset.first); 13291 if (ValueIt != ValueExprMap.end()) 13292 ValueExprMap.erase(ValueIt); 13293 } 13294 } 13295 ExprValueMap.erase(ExprIt); 13296 } 13297 13298 auto ScopeIt = ValuesAtScopes.find(S); 13299 if (ScopeIt != ValuesAtScopes.end()) { 13300 for (const auto &Pair : ScopeIt->second) 13301 if (!isa_and_nonnull<SCEVConstant>(Pair.second)) 13302 erase_value(ValuesAtScopesUsers[Pair.second], 13303 std::make_pair(Pair.first, S)); 13304 ValuesAtScopes.erase(ScopeIt); 13305 } 13306 13307 auto ScopeUserIt = ValuesAtScopesUsers.find(S); 13308 if (ScopeUserIt != ValuesAtScopesUsers.end()) { 13309 for (const auto &Pair : ScopeUserIt->second) 13310 erase_value(ValuesAtScopes[Pair.second], std::make_pair(Pair.first, S)); 13311 ValuesAtScopesUsers.erase(ScopeUserIt); 13312 } 13313 13314 auto BEUsersIt = BECountUsers.find(S); 13315 if (BEUsersIt != BECountUsers.end()) { 13316 // Work on a copy, as forgetBackedgeTakenCounts() will modify the original. 13317 auto Copy = BEUsersIt->second; 13318 for (const auto &Pair : Copy) 13319 forgetBackedgeTakenCounts(Pair.getPointer(), Pair.getInt()); 13320 BECountUsers.erase(BEUsersIt); 13321 } 13322 } 13323 13324 void 13325 ScalarEvolution::getUsedLoops(const SCEV *S, 13326 SmallPtrSetImpl<const Loop *> &LoopsUsed) { 13327 struct FindUsedLoops { 13328 FindUsedLoops(SmallPtrSetImpl<const Loop *> &LoopsUsed) 13329 : LoopsUsed(LoopsUsed) {} 13330 SmallPtrSetImpl<const Loop *> &LoopsUsed; 13331 bool follow(const SCEV *S) { 13332 if (auto *AR = dyn_cast<SCEVAddRecExpr>(S)) 13333 LoopsUsed.insert(AR->getLoop()); 13334 return true; 13335 } 13336 13337 bool isDone() const { return false; } 13338 }; 13339 13340 FindUsedLoops F(LoopsUsed); 13341 SCEVTraversal<FindUsedLoops>(F).visitAll(S); 13342 } 13343 13344 void ScalarEvolution::verify() const { 13345 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this); 13346 ScalarEvolution SE2(F, TLI, AC, DT, LI); 13347 13348 SmallVector<Loop *, 8> LoopStack(LI.begin(), LI.end()); 13349 13350 // Map's SCEV expressions from one ScalarEvolution "universe" to another. 13351 struct SCEVMapper : public SCEVRewriteVisitor<SCEVMapper> { 13352 SCEVMapper(ScalarEvolution &SE) : SCEVRewriteVisitor<SCEVMapper>(SE) {} 13353 13354 const SCEV *visitConstant(const SCEVConstant *Constant) { 13355 return SE.getConstant(Constant->getAPInt()); 13356 } 13357 13358 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 13359 return SE.getUnknown(Expr->getValue()); 13360 } 13361 13362 const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) { 13363 return SE.getCouldNotCompute(); 13364 } 13365 }; 13366 13367 SCEVMapper SCM(SE2); 13368 13369 while (!LoopStack.empty()) { 13370 auto *L = LoopStack.pop_back_val(); 13371 llvm::append_range(LoopStack, *L); 13372 13373 auto *CurBECount = SCM.visit( 13374 const_cast<ScalarEvolution *>(this)->getBackedgeTakenCount(L)); 13375 auto *NewBECount = SE2.getBackedgeTakenCount(L); 13376 13377 if (CurBECount == SE2.getCouldNotCompute() || 13378 NewBECount == SE2.getCouldNotCompute()) { 13379 // NB! This situation is legal, but is very suspicious -- whatever pass 13380 // change the loop to make a trip count go from could not compute to 13381 // computable or vice-versa *should have* invalidated SCEV. However, we 13382 // choose not to assert here (for now) since we don't want false 13383 // positives. 13384 continue; 13385 } 13386 13387 if (containsUndefs(CurBECount) || containsUndefs(NewBECount)) { 13388 // SCEV treats "undef" as an unknown but consistent value (i.e. it does 13389 // not propagate undef aggressively). This means we can (and do) fail 13390 // verification in cases where a transform makes the trip count of a loop 13391 // go from "undef" to "undef+1" (say). The transform is fine, since in 13392 // both cases the loop iterates "undef" times, but SCEV thinks we 13393 // increased the trip count of the loop by 1 incorrectly. 13394 continue; 13395 } 13396 13397 if (SE.getTypeSizeInBits(CurBECount->getType()) > 13398 SE.getTypeSizeInBits(NewBECount->getType())) 13399 NewBECount = SE2.getZeroExtendExpr(NewBECount, CurBECount->getType()); 13400 else if (SE.getTypeSizeInBits(CurBECount->getType()) < 13401 SE.getTypeSizeInBits(NewBECount->getType())) 13402 CurBECount = SE2.getZeroExtendExpr(CurBECount, NewBECount->getType()); 13403 13404 const SCEV *Delta = SE2.getMinusSCEV(CurBECount, NewBECount); 13405 13406 // Unless VerifySCEVStrict is set, we only compare constant deltas. 13407 if ((VerifySCEVStrict || isa<SCEVConstant>(Delta)) && !Delta->isZero()) { 13408 dbgs() << "Trip Count for " << *L << " Changed!\n"; 13409 dbgs() << "Old: " << *CurBECount << "\n"; 13410 dbgs() << "New: " << *NewBECount << "\n"; 13411 dbgs() << "Delta: " << *Delta << "\n"; 13412 std::abort(); 13413 } 13414 } 13415 13416 // Collect all valid loops currently in LoopInfo. 13417 SmallPtrSet<Loop *, 32> ValidLoops; 13418 SmallVector<Loop *, 32> Worklist(LI.begin(), LI.end()); 13419 while (!Worklist.empty()) { 13420 Loop *L = Worklist.pop_back_val(); 13421 if (ValidLoops.contains(L)) 13422 continue; 13423 ValidLoops.insert(L); 13424 Worklist.append(L->begin(), L->end()); 13425 } 13426 for (auto &KV : ValueExprMap) { 13427 #ifndef NDEBUG 13428 // Check for SCEV expressions referencing invalid/deleted loops. 13429 if (auto *AR = dyn_cast<SCEVAddRecExpr>(KV.second)) { 13430 assert(ValidLoops.contains(AR->getLoop()) && 13431 "AddRec references invalid loop"); 13432 } 13433 #endif 13434 13435 // Check that the value is also part of the reverse map. 13436 auto It = ExprValueMap.find(KV.second); 13437 if (It == ExprValueMap.end() || !It->second.contains({KV.first, nullptr})) { 13438 dbgs() << "Value " << *KV.first 13439 << " is in ValueExprMap but not in ExprValueMap\n"; 13440 std::abort(); 13441 } 13442 } 13443 13444 for (const auto &KV : ExprValueMap) { 13445 for (const auto &ValueAndOffset : KV.second) { 13446 if (ValueAndOffset.second != nullptr) 13447 continue; 13448 13449 auto It = ValueExprMap.find_as(ValueAndOffset.first); 13450 if (It == ValueExprMap.end()) { 13451 dbgs() << "Value " << *ValueAndOffset.first 13452 << " is in ExprValueMap but not in ValueExprMap\n"; 13453 std::abort(); 13454 } 13455 if (It->second != KV.first) { 13456 dbgs() << "Value " << *ValueAndOffset.first 13457 << " mapped to " << *It->second 13458 << " rather than " << *KV.first << "\n"; 13459 std::abort(); 13460 } 13461 } 13462 } 13463 13464 // Verify integrity of SCEV users. 13465 for (const auto &S : UniqueSCEVs) { 13466 SmallVector<const SCEV *, 4> Ops; 13467 collectUniqueOps(&S, Ops); 13468 for (const auto *Op : Ops) { 13469 // We do not store dependencies of constants. 13470 if (isa<SCEVConstant>(Op)) 13471 continue; 13472 auto It = SCEVUsers.find(Op); 13473 if (It != SCEVUsers.end() && It->second.count(&S)) 13474 continue; 13475 dbgs() << "Use of operand " << *Op << " by user " << S 13476 << " is not being tracked!\n"; 13477 std::abort(); 13478 } 13479 } 13480 13481 // Verify integrity of ValuesAtScopes users. 13482 for (const auto &ValueAndVec : ValuesAtScopes) { 13483 const SCEV *Value = ValueAndVec.first; 13484 for (const auto &LoopAndValueAtScope : ValueAndVec.second) { 13485 const Loop *L = LoopAndValueAtScope.first; 13486 const SCEV *ValueAtScope = LoopAndValueAtScope.second; 13487 if (!isa<SCEVConstant>(ValueAtScope)) { 13488 auto It = ValuesAtScopesUsers.find(ValueAtScope); 13489 if (It != ValuesAtScopesUsers.end() && 13490 is_contained(It->second, std::make_pair(L, Value))) 13491 continue; 13492 dbgs() << "Value: " << *Value << ", Loop: " << *L << ", ValueAtScope: " 13493 << *ValueAtScope << " missing in ValuesAtScopesUsers\n"; 13494 std::abort(); 13495 } 13496 } 13497 } 13498 13499 for (const auto &ValueAtScopeAndVec : ValuesAtScopesUsers) { 13500 const SCEV *ValueAtScope = ValueAtScopeAndVec.first; 13501 for (const auto &LoopAndValue : ValueAtScopeAndVec.second) { 13502 const Loop *L = LoopAndValue.first; 13503 const SCEV *Value = LoopAndValue.second; 13504 assert(!isa<SCEVConstant>(Value)); 13505 auto It = ValuesAtScopes.find(Value); 13506 if (It != ValuesAtScopes.end() && 13507 is_contained(It->second, std::make_pair(L, ValueAtScope))) 13508 continue; 13509 dbgs() << "Value: " << *Value << ", Loop: " << *L << ", ValueAtScope: " 13510 << *ValueAtScope << " missing in ValuesAtScopes\n"; 13511 std::abort(); 13512 } 13513 } 13514 13515 // Verify integrity of BECountUsers. 13516 auto VerifyBECountUsers = [&](bool Predicated) { 13517 auto &BECounts = 13518 Predicated ? PredicatedBackedgeTakenCounts : BackedgeTakenCounts; 13519 for (const auto &LoopAndBEInfo : BECounts) { 13520 for (const ExitNotTakenInfo &ENT : LoopAndBEInfo.second.ExitNotTaken) { 13521 if (!isa<SCEVConstant>(ENT.ExactNotTaken)) { 13522 auto UserIt = BECountUsers.find(ENT.ExactNotTaken); 13523 if (UserIt != BECountUsers.end() && 13524 UserIt->second.contains({ LoopAndBEInfo.first, Predicated })) 13525 continue; 13526 dbgs() << "Value " << *ENT.ExactNotTaken << " for loop " 13527 << *LoopAndBEInfo.first << " missing from BECountUsers\n"; 13528 std::abort(); 13529 } 13530 } 13531 } 13532 }; 13533 VerifyBECountUsers(/* Predicated */ false); 13534 VerifyBECountUsers(/* Predicated */ true); 13535 } 13536 13537 bool ScalarEvolution::invalidate( 13538 Function &F, const PreservedAnalyses &PA, 13539 FunctionAnalysisManager::Invalidator &Inv) { 13540 // Invalidate the ScalarEvolution object whenever it isn't preserved or one 13541 // of its dependencies is invalidated. 13542 auto PAC = PA.getChecker<ScalarEvolutionAnalysis>(); 13543 return !(PAC.preserved() || PAC.preservedSet<AllAnalysesOn<Function>>()) || 13544 Inv.invalidate<AssumptionAnalysis>(F, PA) || 13545 Inv.invalidate<DominatorTreeAnalysis>(F, PA) || 13546 Inv.invalidate<LoopAnalysis>(F, PA); 13547 } 13548 13549 AnalysisKey ScalarEvolutionAnalysis::Key; 13550 13551 ScalarEvolution ScalarEvolutionAnalysis::run(Function &F, 13552 FunctionAnalysisManager &AM) { 13553 return ScalarEvolution(F, AM.getResult<TargetLibraryAnalysis>(F), 13554 AM.getResult<AssumptionAnalysis>(F), 13555 AM.getResult<DominatorTreeAnalysis>(F), 13556 AM.getResult<LoopAnalysis>(F)); 13557 } 13558 13559 PreservedAnalyses 13560 ScalarEvolutionVerifierPass::run(Function &F, FunctionAnalysisManager &AM) { 13561 AM.getResult<ScalarEvolutionAnalysis>(F).verify(); 13562 return PreservedAnalyses::all(); 13563 } 13564 13565 PreservedAnalyses 13566 ScalarEvolutionPrinterPass::run(Function &F, FunctionAnalysisManager &AM) { 13567 // For compatibility with opt's -analyze feature under legacy pass manager 13568 // which was not ported to NPM. This keeps tests using 13569 // update_analyze_test_checks.py working. 13570 OS << "Printing analysis 'Scalar Evolution Analysis' for function '" 13571 << F.getName() << "':\n"; 13572 AM.getResult<ScalarEvolutionAnalysis>(F).print(OS); 13573 return PreservedAnalyses::all(); 13574 } 13575 13576 INITIALIZE_PASS_BEGIN(ScalarEvolutionWrapperPass, "scalar-evolution", 13577 "Scalar Evolution Analysis", false, true) 13578 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 13579 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass) 13580 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 13581 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass) 13582 INITIALIZE_PASS_END(ScalarEvolutionWrapperPass, "scalar-evolution", 13583 "Scalar Evolution Analysis", false, true) 13584 13585 char ScalarEvolutionWrapperPass::ID = 0; 13586 13587 ScalarEvolutionWrapperPass::ScalarEvolutionWrapperPass() : FunctionPass(ID) { 13588 initializeScalarEvolutionWrapperPassPass(*PassRegistry::getPassRegistry()); 13589 } 13590 13591 bool ScalarEvolutionWrapperPass::runOnFunction(Function &F) { 13592 SE.reset(new ScalarEvolution( 13593 F, getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(F), 13594 getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F), 13595 getAnalysis<DominatorTreeWrapperPass>().getDomTree(), 13596 getAnalysis<LoopInfoWrapperPass>().getLoopInfo())); 13597 return false; 13598 } 13599 13600 void ScalarEvolutionWrapperPass::releaseMemory() { SE.reset(); } 13601 13602 void ScalarEvolutionWrapperPass::print(raw_ostream &OS, const Module *) const { 13603 SE->print(OS); 13604 } 13605 13606 void ScalarEvolutionWrapperPass::verifyAnalysis() const { 13607 if (!VerifySCEV) 13608 return; 13609 13610 SE->verify(); 13611 } 13612 13613 void ScalarEvolutionWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const { 13614 AU.setPreservesAll(); 13615 AU.addRequiredTransitive<AssumptionCacheTracker>(); 13616 AU.addRequiredTransitive<LoopInfoWrapperPass>(); 13617 AU.addRequiredTransitive<DominatorTreeWrapperPass>(); 13618 AU.addRequiredTransitive<TargetLibraryInfoWrapperPass>(); 13619 } 13620 13621 const SCEVPredicate *ScalarEvolution::getEqualPredicate(const SCEV *LHS, 13622 const SCEV *RHS) { 13623 return getComparePredicate(ICmpInst::ICMP_EQ, LHS, RHS); 13624 } 13625 13626 const SCEVPredicate * 13627 ScalarEvolution::getComparePredicate(const ICmpInst::Predicate Pred, 13628 const SCEV *LHS, const SCEV *RHS) { 13629 FoldingSetNodeID ID; 13630 assert(LHS->getType() == RHS->getType() && 13631 "Type mismatch between LHS and RHS"); 13632 // Unique this node based on the arguments 13633 ID.AddInteger(SCEVPredicate::P_Compare); 13634 ID.AddInteger(Pred); 13635 ID.AddPointer(LHS); 13636 ID.AddPointer(RHS); 13637 void *IP = nullptr; 13638 if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP)) 13639 return S; 13640 SCEVComparePredicate *Eq = new (SCEVAllocator) 13641 SCEVComparePredicate(ID.Intern(SCEVAllocator), Pred, LHS, RHS); 13642 UniquePreds.InsertNode(Eq, IP); 13643 return Eq; 13644 } 13645 13646 const SCEVPredicate *ScalarEvolution::getWrapPredicate( 13647 const SCEVAddRecExpr *AR, 13648 SCEVWrapPredicate::IncrementWrapFlags AddedFlags) { 13649 FoldingSetNodeID ID; 13650 // Unique this node based on the arguments 13651 ID.AddInteger(SCEVPredicate::P_Wrap); 13652 ID.AddPointer(AR); 13653 ID.AddInteger(AddedFlags); 13654 void *IP = nullptr; 13655 if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP)) 13656 return S; 13657 auto *OF = new (SCEVAllocator) 13658 SCEVWrapPredicate(ID.Intern(SCEVAllocator), AR, AddedFlags); 13659 UniquePreds.InsertNode(OF, IP); 13660 return OF; 13661 } 13662 13663 namespace { 13664 13665 class SCEVPredicateRewriter : public SCEVRewriteVisitor<SCEVPredicateRewriter> { 13666 public: 13667 13668 /// Rewrites \p S in the context of a loop L and the SCEV predication 13669 /// infrastructure. 13670 /// 13671 /// If \p Pred is non-null, the SCEV expression is rewritten to respect the 13672 /// equivalences present in \p Pred. 13673 /// 13674 /// If \p NewPreds is non-null, rewrite is free to add further predicates to 13675 /// \p NewPreds such that the result will be an AddRecExpr. 13676 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE, 13677 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds, 13678 const SCEVPredicate *Pred) { 13679 SCEVPredicateRewriter Rewriter(L, SE, NewPreds, Pred); 13680 return Rewriter.visit(S); 13681 } 13682 13683 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 13684 if (Pred) { 13685 if (auto *U = dyn_cast<SCEVUnionPredicate>(Pred)) { 13686 for (auto *Pred : U->getPredicates()) 13687 if (const auto *IPred = dyn_cast<SCEVComparePredicate>(Pred)) 13688 if (IPred->getLHS() == Expr && 13689 IPred->getPredicate() == ICmpInst::ICMP_EQ) 13690 return IPred->getRHS(); 13691 } else if (const auto *IPred = dyn_cast<SCEVComparePredicate>(Pred)) { 13692 if (IPred->getLHS() == Expr && 13693 IPred->getPredicate() == ICmpInst::ICMP_EQ) 13694 return IPred->getRHS(); 13695 } 13696 } 13697 return convertToAddRecWithPreds(Expr); 13698 } 13699 13700 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) { 13701 const SCEV *Operand = visit(Expr->getOperand()); 13702 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand); 13703 if (AR && AR->getLoop() == L && AR->isAffine()) { 13704 // This couldn't be folded because the operand didn't have the nuw 13705 // flag. Add the nusw flag as an assumption that we could make. 13706 const SCEV *Step = AR->getStepRecurrence(SE); 13707 Type *Ty = Expr->getType(); 13708 if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNUSW)) 13709 return SE.getAddRecExpr(SE.getZeroExtendExpr(AR->getStart(), Ty), 13710 SE.getSignExtendExpr(Step, Ty), L, 13711 AR->getNoWrapFlags()); 13712 } 13713 return SE.getZeroExtendExpr(Operand, Expr->getType()); 13714 } 13715 13716 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) { 13717 const SCEV *Operand = visit(Expr->getOperand()); 13718 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand); 13719 if (AR && AR->getLoop() == L && AR->isAffine()) { 13720 // This couldn't be folded because the operand didn't have the nsw 13721 // flag. Add the nssw flag as an assumption that we could make. 13722 const SCEV *Step = AR->getStepRecurrence(SE); 13723 Type *Ty = Expr->getType(); 13724 if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNSSW)) 13725 return SE.getAddRecExpr(SE.getSignExtendExpr(AR->getStart(), Ty), 13726 SE.getSignExtendExpr(Step, Ty), L, 13727 AR->getNoWrapFlags()); 13728 } 13729 return SE.getSignExtendExpr(Operand, Expr->getType()); 13730 } 13731 13732 private: 13733 explicit SCEVPredicateRewriter(const Loop *L, ScalarEvolution &SE, 13734 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds, 13735 const SCEVPredicate *Pred) 13736 : SCEVRewriteVisitor(SE), NewPreds(NewPreds), Pred(Pred), L(L) {} 13737 13738 bool addOverflowAssumption(const SCEVPredicate *P) { 13739 if (!NewPreds) { 13740 // Check if we've already made this assumption. 13741 return Pred && Pred->implies(P); 13742 } 13743 NewPreds->insert(P); 13744 return true; 13745 } 13746 13747 bool addOverflowAssumption(const SCEVAddRecExpr *AR, 13748 SCEVWrapPredicate::IncrementWrapFlags AddedFlags) { 13749 auto *A = SE.getWrapPredicate(AR, AddedFlags); 13750 return addOverflowAssumption(A); 13751 } 13752 13753 // If \p Expr represents a PHINode, we try to see if it can be represented 13754 // as an AddRec, possibly under a predicate (PHISCEVPred). If it is possible 13755 // to add this predicate as a runtime overflow check, we return the AddRec. 13756 // If \p Expr does not meet these conditions (is not a PHI node, or we 13757 // couldn't create an AddRec for it, or couldn't add the predicate), we just 13758 // return \p Expr. 13759 const SCEV *convertToAddRecWithPreds(const SCEVUnknown *Expr) { 13760 if (!isa<PHINode>(Expr->getValue())) 13761 return Expr; 13762 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 13763 PredicatedRewrite = SE.createAddRecFromPHIWithCasts(Expr); 13764 if (!PredicatedRewrite) 13765 return Expr; 13766 for (auto *P : PredicatedRewrite->second){ 13767 // Wrap predicates from outer loops are not supported. 13768 if (auto *WP = dyn_cast<const SCEVWrapPredicate>(P)) { 13769 if (L != WP->getExpr()->getLoop()) 13770 return Expr; 13771 } 13772 if (!addOverflowAssumption(P)) 13773 return Expr; 13774 } 13775 return PredicatedRewrite->first; 13776 } 13777 13778 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds; 13779 const SCEVPredicate *Pred; 13780 const Loop *L; 13781 }; 13782 13783 } // end anonymous namespace 13784 13785 const SCEV * 13786 ScalarEvolution::rewriteUsingPredicate(const SCEV *S, const Loop *L, 13787 const SCEVPredicate &Preds) { 13788 return SCEVPredicateRewriter::rewrite(S, L, *this, nullptr, &Preds); 13789 } 13790 13791 const SCEVAddRecExpr *ScalarEvolution::convertSCEVToAddRecWithPredicates( 13792 const SCEV *S, const Loop *L, 13793 SmallPtrSetImpl<const SCEVPredicate *> &Preds) { 13794 SmallPtrSet<const SCEVPredicate *, 4> TransformPreds; 13795 S = SCEVPredicateRewriter::rewrite(S, L, *this, &TransformPreds, nullptr); 13796 auto *AddRec = dyn_cast<SCEVAddRecExpr>(S); 13797 13798 if (!AddRec) 13799 return nullptr; 13800 13801 // Since the transformation was successful, we can now transfer the SCEV 13802 // predicates. 13803 for (auto *P : TransformPreds) 13804 Preds.insert(P); 13805 13806 return AddRec; 13807 } 13808 13809 /// SCEV predicates 13810 SCEVPredicate::SCEVPredicate(const FoldingSetNodeIDRef ID, 13811 SCEVPredicateKind Kind) 13812 : FastID(ID), Kind(Kind) {} 13813 13814 SCEVComparePredicate::SCEVComparePredicate(const FoldingSetNodeIDRef ID, 13815 const ICmpInst::Predicate Pred, 13816 const SCEV *LHS, const SCEV *RHS) 13817 : SCEVPredicate(ID, P_Compare), Pred(Pred), LHS(LHS), RHS(RHS) { 13818 assert(LHS->getType() == RHS->getType() && "LHS and RHS types don't match"); 13819 assert(LHS != RHS && "LHS and RHS are the same SCEV"); 13820 } 13821 13822 bool SCEVComparePredicate::implies(const SCEVPredicate *N) const { 13823 const auto *Op = dyn_cast<SCEVComparePredicate>(N); 13824 13825 if (!Op) 13826 return false; 13827 13828 if (Pred != ICmpInst::ICMP_EQ) 13829 return false; 13830 13831 return Op->LHS == LHS && Op->RHS == RHS; 13832 } 13833 13834 bool SCEVComparePredicate::isAlwaysTrue() const { return false; } 13835 13836 void SCEVComparePredicate::print(raw_ostream &OS, unsigned Depth) const { 13837 if (Pred == ICmpInst::ICMP_EQ) 13838 OS.indent(Depth) << "Equal predicate: " << *LHS << " == " << *RHS << "\n"; 13839 else 13840 OS.indent(Depth) << "Compare predicate: " << *LHS 13841 << " " << CmpInst::getPredicateName(Pred) << ") " 13842 << *RHS << "\n"; 13843 13844 } 13845 13846 SCEVWrapPredicate::SCEVWrapPredicate(const FoldingSetNodeIDRef ID, 13847 const SCEVAddRecExpr *AR, 13848 IncrementWrapFlags Flags) 13849 : SCEVPredicate(ID, P_Wrap), AR(AR), Flags(Flags) {} 13850 13851 const SCEVAddRecExpr *SCEVWrapPredicate::getExpr() const { return AR; } 13852 13853 bool SCEVWrapPredicate::implies(const SCEVPredicate *N) const { 13854 const auto *Op = dyn_cast<SCEVWrapPredicate>(N); 13855 13856 return Op && Op->AR == AR && setFlags(Flags, Op->Flags) == Flags; 13857 } 13858 13859 bool SCEVWrapPredicate::isAlwaysTrue() const { 13860 SCEV::NoWrapFlags ScevFlags = AR->getNoWrapFlags(); 13861 IncrementWrapFlags IFlags = Flags; 13862 13863 if (ScalarEvolution::setFlags(ScevFlags, SCEV::FlagNSW) == ScevFlags) 13864 IFlags = clearFlags(IFlags, IncrementNSSW); 13865 13866 return IFlags == IncrementAnyWrap; 13867 } 13868 13869 void SCEVWrapPredicate::print(raw_ostream &OS, unsigned Depth) const { 13870 OS.indent(Depth) << *getExpr() << " Added Flags: "; 13871 if (SCEVWrapPredicate::IncrementNUSW & getFlags()) 13872 OS << "<nusw>"; 13873 if (SCEVWrapPredicate::IncrementNSSW & getFlags()) 13874 OS << "<nssw>"; 13875 OS << "\n"; 13876 } 13877 13878 SCEVWrapPredicate::IncrementWrapFlags 13879 SCEVWrapPredicate::getImpliedFlags(const SCEVAddRecExpr *AR, 13880 ScalarEvolution &SE) { 13881 IncrementWrapFlags ImpliedFlags = IncrementAnyWrap; 13882 SCEV::NoWrapFlags StaticFlags = AR->getNoWrapFlags(); 13883 13884 // We can safely transfer the NSW flag as NSSW. 13885 if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNSW) == StaticFlags) 13886 ImpliedFlags = IncrementNSSW; 13887 13888 if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNUW) == StaticFlags) { 13889 // If the increment is positive, the SCEV NUW flag will also imply the 13890 // WrapPredicate NUSW flag. 13891 if (const auto *Step = dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE))) 13892 if (Step->getValue()->getValue().isNonNegative()) 13893 ImpliedFlags = setFlags(ImpliedFlags, IncrementNUSW); 13894 } 13895 13896 return ImpliedFlags; 13897 } 13898 13899 /// Union predicates don't get cached so create a dummy set ID for it. 13900 SCEVUnionPredicate::SCEVUnionPredicate(ArrayRef<const SCEVPredicate *> Preds) 13901 : SCEVPredicate(FoldingSetNodeIDRef(nullptr, 0), P_Union) { 13902 for (auto *P : Preds) 13903 add(P); 13904 } 13905 13906 bool SCEVUnionPredicate::isAlwaysTrue() const { 13907 return all_of(Preds, 13908 [](const SCEVPredicate *I) { return I->isAlwaysTrue(); }); 13909 } 13910 13911 bool SCEVUnionPredicate::implies(const SCEVPredicate *N) const { 13912 if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N)) 13913 return all_of(Set->Preds, 13914 [this](const SCEVPredicate *I) { return this->implies(I); }); 13915 13916 return any_of(Preds, 13917 [N](const SCEVPredicate *I) { return I->implies(N); }); 13918 } 13919 13920 void SCEVUnionPredicate::print(raw_ostream &OS, unsigned Depth) const { 13921 for (auto Pred : Preds) 13922 Pred->print(OS, Depth); 13923 } 13924 13925 void SCEVUnionPredicate::add(const SCEVPredicate *N) { 13926 if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N)) { 13927 for (auto Pred : Set->Preds) 13928 add(Pred); 13929 return; 13930 } 13931 13932 Preds.push_back(N); 13933 } 13934 13935 PredicatedScalarEvolution::PredicatedScalarEvolution(ScalarEvolution &SE, 13936 Loop &L) 13937 : SE(SE), L(L) { 13938 SmallVector<const SCEVPredicate*, 4> Empty; 13939 Preds = std::make_unique<SCEVUnionPredicate>(Empty); 13940 } 13941 13942 void ScalarEvolution::registerUser(const SCEV *User, 13943 ArrayRef<const SCEV *> Ops) { 13944 for (auto *Op : Ops) 13945 // We do not expect that forgetting cached data for SCEVConstants will ever 13946 // open any prospects for sharpening or introduce any correctness issues, 13947 // so we don't bother storing their dependencies. 13948 if (!isa<SCEVConstant>(Op)) 13949 SCEVUsers[Op].insert(User); 13950 } 13951 13952 const SCEV *PredicatedScalarEvolution::getSCEV(Value *V) { 13953 const SCEV *Expr = SE.getSCEV(V); 13954 RewriteEntry &Entry = RewriteMap[Expr]; 13955 13956 // If we already have an entry and the version matches, return it. 13957 if (Entry.second && Generation == Entry.first) 13958 return Entry.second; 13959 13960 // We found an entry but it's stale. Rewrite the stale entry 13961 // according to the current predicate. 13962 if (Entry.second) 13963 Expr = Entry.second; 13964 13965 const SCEV *NewSCEV = SE.rewriteUsingPredicate(Expr, &L, *Preds); 13966 Entry = {Generation, NewSCEV}; 13967 13968 return NewSCEV; 13969 } 13970 13971 const SCEV *PredicatedScalarEvolution::getBackedgeTakenCount() { 13972 if (!BackedgeCount) { 13973 SmallVector<const SCEVPredicate *, 4> Preds; 13974 BackedgeCount = SE.getPredicatedBackedgeTakenCount(&L, Preds); 13975 for (auto *P : Preds) 13976 addPredicate(*P); 13977 } 13978 return BackedgeCount; 13979 } 13980 13981 void PredicatedScalarEvolution::addPredicate(const SCEVPredicate &Pred) { 13982 if (Preds->implies(&Pred)) 13983 return; 13984 13985 auto &OldPreds = Preds->getPredicates(); 13986 SmallVector<const SCEVPredicate*, 4> NewPreds(OldPreds.begin(), OldPreds.end()); 13987 NewPreds.push_back(&Pred); 13988 Preds = std::make_unique<SCEVUnionPredicate>(NewPreds); 13989 updateGeneration(); 13990 } 13991 13992 const SCEVPredicate &PredicatedScalarEvolution::getPredicate() const { 13993 return *Preds; 13994 } 13995 13996 void PredicatedScalarEvolution::updateGeneration() { 13997 // If the generation number wrapped recompute everything. 13998 if (++Generation == 0) { 13999 for (auto &II : RewriteMap) { 14000 const SCEV *Rewritten = II.second.second; 14001 II.second = {Generation, SE.rewriteUsingPredicate(Rewritten, &L, *Preds)}; 14002 } 14003 } 14004 } 14005 14006 void PredicatedScalarEvolution::setNoOverflow( 14007 Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) { 14008 const SCEV *Expr = getSCEV(V); 14009 const auto *AR = cast<SCEVAddRecExpr>(Expr); 14010 14011 auto ImpliedFlags = SCEVWrapPredicate::getImpliedFlags(AR, SE); 14012 14013 // Clear the statically implied flags. 14014 Flags = SCEVWrapPredicate::clearFlags(Flags, ImpliedFlags); 14015 addPredicate(*SE.getWrapPredicate(AR, Flags)); 14016 14017 auto II = FlagsMap.insert({V, Flags}); 14018 if (!II.second) 14019 II.first->second = SCEVWrapPredicate::setFlags(Flags, II.first->second); 14020 } 14021 14022 bool PredicatedScalarEvolution::hasNoOverflow( 14023 Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) { 14024 const SCEV *Expr = getSCEV(V); 14025 const auto *AR = cast<SCEVAddRecExpr>(Expr); 14026 14027 Flags = SCEVWrapPredicate::clearFlags( 14028 Flags, SCEVWrapPredicate::getImpliedFlags(AR, SE)); 14029 14030 auto II = FlagsMap.find(V); 14031 14032 if (II != FlagsMap.end()) 14033 Flags = SCEVWrapPredicate::clearFlags(Flags, II->second); 14034 14035 return Flags == SCEVWrapPredicate::IncrementAnyWrap; 14036 } 14037 14038 const SCEVAddRecExpr *PredicatedScalarEvolution::getAsAddRec(Value *V) { 14039 const SCEV *Expr = this->getSCEV(V); 14040 SmallPtrSet<const SCEVPredicate *, 4> NewPreds; 14041 auto *New = SE.convertSCEVToAddRecWithPredicates(Expr, &L, NewPreds); 14042 14043 if (!New) 14044 return nullptr; 14045 14046 for (auto *P : NewPreds) 14047 addPredicate(*P); 14048 14049 RewriteMap[SE.getSCEV(V)] = {Generation, New}; 14050 return New; 14051 } 14052 14053 PredicatedScalarEvolution::PredicatedScalarEvolution( 14054 const PredicatedScalarEvolution &Init) 14055 : RewriteMap(Init.RewriteMap), SE(Init.SE), L(Init.L), 14056 Preds(std::make_unique<SCEVUnionPredicate>(Init.Preds->getPredicates())), 14057 Generation(Init.Generation), BackedgeCount(Init.BackedgeCount) { 14058 for (auto I : Init.FlagsMap) 14059 FlagsMap.insert(I); 14060 } 14061 14062 void PredicatedScalarEvolution::print(raw_ostream &OS, unsigned Depth) const { 14063 // For each block. 14064 for (auto *BB : L.getBlocks()) 14065 for (auto &I : *BB) { 14066 if (!SE.isSCEVable(I.getType())) 14067 continue; 14068 14069 auto *Expr = SE.getSCEV(&I); 14070 auto II = RewriteMap.find(Expr); 14071 14072 if (II == RewriteMap.end()) 14073 continue; 14074 14075 // Don't print things that are not interesting. 14076 if (II->second.second == Expr) 14077 continue; 14078 14079 OS.indent(Depth) << "[PSE]" << I << ":\n"; 14080 OS.indent(Depth + 2) << *Expr << "\n"; 14081 OS.indent(Depth + 2) << "--> " << *II->second.second << "\n"; 14082 } 14083 } 14084 14085 // Match the mathematical pattern A - (A / B) * B, where A and B can be 14086 // arbitrary expressions. Also match zext (trunc A to iB) to iY, which is used 14087 // for URem with constant power-of-2 second operands. 14088 // It's not always easy, as A and B can be folded (imagine A is X / 2, and B is 14089 // 4, A / B becomes X / 8). 14090 bool ScalarEvolution::matchURem(const SCEV *Expr, const SCEV *&LHS, 14091 const SCEV *&RHS) { 14092 // Try to match 'zext (trunc A to iB) to iY', which is used 14093 // for URem with constant power-of-2 second operands. Make sure the size of 14094 // the operand A matches the size of the whole expressions. 14095 if (const auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(Expr)) 14096 if (const auto *Trunc = dyn_cast<SCEVTruncateExpr>(ZExt->getOperand(0))) { 14097 LHS = Trunc->getOperand(); 14098 // Bail out if the type of the LHS is larger than the type of the 14099 // expression for now. 14100 if (getTypeSizeInBits(LHS->getType()) > 14101 getTypeSizeInBits(Expr->getType())) 14102 return false; 14103 if (LHS->getType() != Expr->getType()) 14104 LHS = getZeroExtendExpr(LHS, Expr->getType()); 14105 RHS = getConstant(APInt(getTypeSizeInBits(Expr->getType()), 1) 14106 << getTypeSizeInBits(Trunc->getType())); 14107 return true; 14108 } 14109 const auto *Add = dyn_cast<SCEVAddExpr>(Expr); 14110 if (Add == nullptr || Add->getNumOperands() != 2) 14111 return false; 14112 14113 const SCEV *A = Add->getOperand(1); 14114 const auto *Mul = dyn_cast<SCEVMulExpr>(Add->getOperand(0)); 14115 14116 if (Mul == nullptr) 14117 return false; 14118 14119 const auto MatchURemWithDivisor = [&](const SCEV *B) { 14120 // (SomeExpr + (-(SomeExpr / B) * B)). 14121 if (Expr == getURemExpr(A, B)) { 14122 LHS = A; 14123 RHS = B; 14124 return true; 14125 } 14126 return false; 14127 }; 14128 14129 // (SomeExpr + (-1 * (SomeExpr / B) * B)). 14130 if (Mul->getNumOperands() == 3 && isa<SCEVConstant>(Mul->getOperand(0))) 14131 return MatchURemWithDivisor(Mul->getOperand(1)) || 14132 MatchURemWithDivisor(Mul->getOperand(2)); 14133 14134 // (SomeExpr + ((-SomeExpr / B) * B)) or (SomeExpr + ((SomeExpr / B) * -B)). 14135 if (Mul->getNumOperands() == 2) 14136 return MatchURemWithDivisor(Mul->getOperand(1)) || 14137 MatchURemWithDivisor(Mul->getOperand(0)) || 14138 MatchURemWithDivisor(getNegativeSCEV(Mul->getOperand(1))) || 14139 MatchURemWithDivisor(getNegativeSCEV(Mul->getOperand(0))); 14140 return false; 14141 } 14142 14143 const SCEV * 14144 ScalarEvolution::computeSymbolicMaxBackedgeTakenCount(const Loop *L) { 14145 SmallVector<BasicBlock*, 16> ExitingBlocks; 14146 L->getExitingBlocks(ExitingBlocks); 14147 14148 // Form an expression for the maximum exit count possible for this loop. We 14149 // merge the max and exact information to approximate a version of 14150 // getConstantMaxBackedgeTakenCount which isn't restricted to just constants. 14151 SmallVector<const SCEV*, 4> ExitCounts; 14152 for (BasicBlock *ExitingBB : ExitingBlocks) { 14153 const SCEV *ExitCount = getExitCount(L, ExitingBB); 14154 if (isa<SCEVCouldNotCompute>(ExitCount)) 14155 ExitCount = getExitCount(L, ExitingBB, 14156 ScalarEvolution::ConstantMaximum); 14157 if (!isa<SCEVCouldNotCompute>(ExitCount)) { 14158 assert(DT.dominates(ExitingBB, L->getLoopLatch()) && 14159 "We should only have known counts for exiting blocks that " 14160 "dominate latch!"); 14161 ExitCounts.push_back(ExitCount); 14162 } 14163 } 14164 if (ExitCounts.empty()) 14165 return getCouldNotCompute(); 14166 return getUMinFromMismatchedTypes(ExitCounts); 14167 } 14168 14169 /// A rewriter to replace SCEV expressions in Map with the corresponding entry 14170 /// in the map. It skips AddRecExpr because we cannot guarantee that the 14171 /// replacement is loop invariant in the loop of the AddRec. 14172 /// 14173 /// At the moment only rewriting SCEVUnknown and SCEVZeroExtendExpr is 14174 /// supported. 14175 class SCEVLoopGuardRewriter : public SCEVRewriteVisitor<SCEVLoopGuardRewriter> { 14176 const DenseMap<const SCEV *, const SCEV *> ⤅ 14177 14178 public: 14179 SCEVLoopGuardRewriter(ScalarEvolution &SE, 14180 DenseMap<const SCEV *, const SCEV *> &M) 14181 : SCEVRewriteVisitor(SE), Map(M) {} 14182 14183 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { return Expr; } 14184 14185 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 14186 auto I = Map.find(Expr); 14187 if (I == Map.end()) 14188 return Expr; 14189 return I->second; 14190 } 14191 14192 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) { 14193 auto I = Map.find(Expr); 14194 if (I == Map.end()) 14195 return SCEVRewriteVisitor<SCEVLoopGuardRewriter>::visitZeroExtendExpr( 14196 Expr); 14197 return I->second; 14198 } 14199 }; 14200 14201 const SCEV *ScalarEvolution::applyLoopGuards(const SCEV *Expr, const Loop *L) { 14202 SmallVector<const SCEV *> ExprsToRewrite; 14203 auto CollectCondition = [&](ICmpInst::Predicate Predicate, const SCEV *LHS, 14204 const SCEV *RHS, 14205 DenseMap<const SCEV *, const SCEV *> 14206 &RewriteMap) { 14207 // WARNING: It is generally unsound to apply any wrap flags to the proposed 14208 // replacement SCEV which isn't directly implied by the structure of that 14209 // SCEV. In particular, using contextual facts to imply flags is *NOT* 14210 // legal. See the scoping rules for flags in the header to understand why. 14211 14212 // If LHS is a constant, apply information to the other expression. 14213 if (isa<SCEVConstant>(LHS)) { 14214 std::swap(LHS, RHS); 14215 Predicate = CmpInst::getSwappedPredicate(Predicate); 14216 } 14217 14218 // Check for a condition of the form (-C1 + X < C2). InstCombine will 14219 // create this form when combining two checks of the form (X u< C2 + C1) and 14220 // (X >=u C1). 14221 auto MatchRangeCheckIdiom = [this, Predicate, LHS, RHS, &RewriteMap, 14222 &ExprsToRewrite]() { 14223 auto *AddExpr = dyn_cast<SCEVAddExpr>(LHS); 14224 if (!AddExpr || AddExpr->getNumOperands() != 2) 14225 return false; 14226 14227 auto *C1 = dyn_cast<SCEVConstant>(AddExpr->getOperand(0)); 14228 auto *LHSUnknown = dyn_cast<SCEVUnknown>(AddExpr->getOperand(1)); 14229 auto *C2 = dyn_cast<SCEVConstant>(RHS); 14230 if (!C1 || !C2 || !LHSUnknown) 14231 return false; 14232 14233 auto ExactRegion = 14234 ConstantRange::makeExactICmpRegion(Predicate, C2->getAPInt()) 14235 .sub(C1->getAPInt()); 14236 14237 // Bail out, unless we have a non-wrapping, monotonic range. 14238 if (ExactRegion.isWrappedSet() || ExactRegion.isFullSet()) 14239 return false; 14240 auto I = RewriteMap.find(LHSUnknown); 14241 const SCEV *RewrittenLHS = I != RewriteMap.end() ? I->second : LHSUnknown; 14242 RewriteMap[LHSUnknown] = getUMaxExpr( 14243 getConstant(ExactRegion.getUnsignedMin()), 14244 getUMinExpr(RewrittenLHS, getConstant(ExactRegion.getUnsignedMax()))); 14245 ExprsToRewrite.push_back(LHSUnknown); 14246 return true; 14247 }; 14248 if (MatchRangeCheckIdiom()) 14249 return; 14250 14251 // If we have LHS == 0, check if LHS is computing a property of some unknown 14252 // SCEV %v which we can rewrite %v to express explicitly. 14253 const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS); 14254 if (Predicate == CmpInst::ICMP_EQ && RHSC && 14255 RHSC->getValue()->isNullValue()) { 14256 // If LHS is A % B, i.e. A % B == 0, rewrite A to (A /u B) * B to 14257 // explicitly express that. 14258 const SCEV *URemLHS = nullptr; 14259 const SCEV *URemRHS = nullptr; 14260 if (matchURem(LHS, URemLHS, URemRHS)) { 14261 if (const SCEVUnknown *LHSUnknown = dyn_cast<SCEVUnknown>(URemLHS)) { 14262 auto Multiple = getMulExpr(getUDivExpr(URemLHS, URemRHS), URemRHS); 14263 RewriteMap[LHSUnknown] = Multiple; 14264 ExprsToRewrite.push_back(LHSUnknown); 14265 return; 14266 } 14267 } 14268 } 14269 14270 // Do not apply information for constants or if RHS contains an AddRec. 14271 if (isa<SCEVConstant>(LHS) || containsAddRecurrence(RHS)) 14272 return; 14273 14274 // If RHS is SCEVUnknown, make sure the information is applied to it. 14275 if (!isa<SCEVUnknown>(LHS) && isa<SCEVUnknown>(RHS)) { 14276 std::swap(LHS, RHS); 14277 Predicate = CmpInst::getSwappedPredicate(Predicate); 14278 } 14279 14280 // Limit to expressions that can be rewritten. 14281 if (!isa<SCEVUnknown>(LHS) && !isa<SCEVZeroExtendExpr>(LHS)) 14282 return; 14283 14284 // Check whether LHS has already been rewritten. In that case we want to 14285 // chain further rewrites onto the already rewritten value. 14286 auto I = RewriteMap.find(LHS); 14287 const SCEV *RewrittenLHS = I != RewriteMap.end() ? I->second : LHS; 14288 14289 const SCEV *RewrittenRHS = nullptr; 14290 switch (Predicate) { 14291 case CmpInst::ICMP_ULT: 14292 RewrittenRHS = 14293 getUMinExpr(RewrittenLHS, getMinusSCEV(RHS, getOne(RHS->getType()))); 14294 break; 14295 case CmpInst::ICMP_SLT: 14296 RewrittenRHS = 14297 getSMinExpr(RewrittenLHS, getMinusSCEV(RHS, getOne(RHS->getType()))); 14298 break; 14299 case CmpInst::ICMP_ULE: 14300 RewrittenRHS = getUMinExpr(RewrittenLHS, RHS); 14301 break; 14302 case CmpInst::ICMP_SLE: 14303 RewrittenRHS = getSMinExpr(RewrittenLHS, RHS); 14304 break; 14305 case CmpInst::ICMP_UGT: 14306 RewrittenRHS = 14307 getUMaxExpr(RewrittenLHS, getAddExpr(RHS, getOne(RHS->getType()))); 14308 break; 14309 case CmpInst::ICMP_SGT: 14310 RewrittenRHS = 14311 getSMaxExpr(RewrittenLHS, getAddExpr(RHS, getOne(RHS->getType()))); 14312 break; 14313 case CmpInst::ICMP_UGE: 14314 RewrittenRHS = getUMaxExpr(RewrittenLHS, RHS); 14315 break; 14316 case CmpInst::ICMP_SGE: 14317 RewrittenRHS = getSMaxExpr(RewrittenLHS, RHS); 14318 break; 14319 case CmpInst::ICMP_EQ: 14320 if (isa<SCEVConstant>(RHS)) 14321 RewrittenRHS = RHS; 14322 break; 14323 case CmpInst::ICMP_NE: 14324 if (isa<SCEVConstant>(RHS) && 14325 cast<SCEVConstant>(RHS)->getValue()->isNullValue()) 14326 RewrittenRHS = getUMaxExpr(RewrittenLHS, getOne(RHS->getType())); 14327 break; 14328 default: 14329 break; 14330 } 14331 14332 if (RewrittenRHS) { 14333 RewriteMap[LHS] = RewrittenRHS; 14334 if (LHS == RewrittenLHS) 14335 ExprsToRewrite.push_back(LHS); 14336 } 14337 }; 14338 // First, collect conditions from dominating branches. Starting at the loop 14339 // predecessor, climb up the predecessor chain, as long as there are 14340 // predecessors that can be found that have unique successors leading to the 14341 // original header. 14342 // TODO: share this logic with isLoopEntryGuardedByCond. 14343 SmallVector<std::pair<Value *, bool>> Terms; 14344 for (std::pair<const BasicBlock *, const BasicBlock *> Pair( 14345 L->getLoopPredecessor(), L->getHeader()); 14346 Pair.first; Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) { 14347 14348 const BranchInst *LoopEntryPredicate = 14349 dyn_cast<BranchInst>(Pair.first->getTerminator()); 14350 if (!LoopEntryPredicate || LoopEntryPredicate->isUnconditional()) 14351 continue; 14352 14353 Terms.emplace_back(LoopEntryPredicate->getCondition(), 14354 LoopEntryPredicate->getSuccessor(0) == Pair.second); 14355 } 14356 14357 // Now apply the information from the collected conditions to RewriteMap. 14358 // Conditions are processed in reverse order, so the earliest conditions is 14359 // processed first. This ensures the SCEVs with the shortest dependency chains 14360 // are constructed first. 14361 DenseMap<const SCEV *, const SCEV *> RewriteMap; 14362 for (auto &E : reverse(Terms)) { 14363 bool EnterIfTrue = E.second; 14364 SmallVector<Value *, 8> Worklist; 14365 SmallPtrSet<Value *, 8> Visited; 14366 Worklist.push_back(E.first); 14367 while (!Worklist.empty()) { 14368 Value *Cond = Worklist.pop_back_val(); 14369 if (!Visited.insert(Cond).second) 14370 continue; 14371 14372 if (auto *Cmp = dyn_cast<ICmpInst>(Cond)) { 14373 auto Predicate = 14374 EnterIfTrue ? Cmp->getPredicate() : Cmp->getInversePredicate(); 14375 CollectCondition(Predicate, getSCEV(Cmp->getOperand(0)), 14376 getSCEV(Cmp->getOperand(1)), RewriteMap); 14377 continue; 14378 } 14379 14380 Value *L, *R; 14381 if (EnterIfTrue ? match(Cond, m_LogicalAnd(m_Value(L), m_Value(R))) 14382 : match(Cond, m_LogicalOr(m_Value(L), m_Value(R)))) { 14383 Worklist.push_back(L); 14384 Worklist.push_back(R); 14385 } 14386 } 14387 } 14388 14389 // Also collect information from assumptions dominating the loop. 14390 for (auto &AssumeVH : AC.assumptions()) { 14391 if (!AssumeVH) 14392 continue; 14393 auto *AssumeI = cast<CallInst>(AssumeVH); 14394 auto *Cmp = dyn_cast<ICmpInst>(AssumeI->getOperand(0)); 14395 if (!Cmp || !DT.dominates(AssumeI, L->getHeader())) 14396 continue; 14397 CollectCondition(Cmp->getPredicate(), getSCEV(Cmp->getOperand(0)), 14398 getSCEV(Cmp->getOperand(1)), RewriteMap); 14399 } 14400 14401 if (RewriteMap.empty()) 14402 return Expr; 14403 14404 // Now that all rewrite information is collect, rewrite the collected 14405 // expressions with the information in the map. This applies information to 14406 // sub-expressions. 14407 if (ExprsToRewrite.size() > 1) { 14408 for (const SCEV *Expr : ExprsToRewrite) { 14409 const SCEV *RewriteTo = RewriteMap[Expr]; 14410 RewriteMap.erase(Expr); 14411 SCEVLoopGuardRewriter Rewriter(*this, RewriteMap); 14412 RewriteMap.insert({Expr, Rewriter.visit(RewriteTo)}); 14413 } 14414 } 14415 14416 SCEVLoopGuardRewriter Rewriter(*this, RewriteMap); 14417 return Rewriter.visit(Expr); 14418 } 14419