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/ScalarEvolutionExpressions.h" 83 #include "llvm/Analysis/TargetLibraryInfo.h" 84 #include "llvm/Analysis/ValueTracking.h" 85 #include "llvm/Config/llvm-config.h" 86 #include "llvm/IR/Argument.h" 87 #include "llvm/IR/BasicBlock.h" 88 #include "llvm/IR/CFG.h" 89 #include "llvm/IR/Constant.h" 90 #include "llvm/IR/ConstantRange.h" 91 #include "llvm/IR/Constants.h" 92 #include "llvm/IR/DataLayout.h" 93 #include "llvm/IR/DerivedTypes.h" 94 #include "llvm/IR/Dominators.h" 95 #include "llvm/IR/Function.h" 96 #include "llvm/IR/GlobalAlias.h" 97 #include "llvm/IR/GlobalValue.h" 98 #include "llvm/IR/InstIterator.h" 99 #include "llvm/IR/InstrTypes.h" 100 #include "llvm/IR/Instruction.h" 101 #include "llvm/IR/Instructions.h" 102 #include "llvm/IR/IntrinsicInst.h" 103 #include "llvm/IR/Intrinsics.h" 104 #include "llvm/IR/LLVMContext.h" 105 #include "llvm/IR/Operator.h" 106 #include "llvm/IR/PatternMatch.h" 107 #include "llvm/IR/Type.h" 108 #include "llvm/IR/Use.h" 109 #include "llvm/IR/User.h" 110 #include "llvm/IR/Value.h" 111 #include "llvm/IR/Verifier.h" 112 #include "llvm/InitializePasses.h" 113 #include "llvm/Pass.h" 114 #include "llvm/Support/Casting.h" 115 #include "llvm/Support/CommandLine.h" 116 #include "llvm/Support/Compiler.h" 117 #include "llvm/Support/Debug.h" 118 #include "llvm/Support/ErrorHandling.h" 119 #include "llvm/Support/KnownBits.h" 120 #include "llvm/Support/SaveAndRestore.h" 121 #include "llvm/Support/raw_ostream.h" 122 #include <algorithm> 123 #include <cassert> 124 #include <climits> 125 #include <cstdint> 126 #include <cstdlib> 127 #include <map> 128 #include <memory> 129 #include <tuple> 130 #include <utility> 131 #include <vector> 132 133 using namespace llvm; 134 using namespace PatternMatch; 135 136 #define DEBUG_TYPE "scalar-evolution" 137 138 STATISTIC(NumTripCountsComputed, 139 "Number of loops with predictable loop counts"); 140 STATISTIC(NumTripCountsNotComputed, 141 "Number of loops without predictable loop counts"); 142 STATISTIC(NumBruteForceTripCountsComputed, 143 "Number of loops with trip counts computed by force"); 144 145 #ifdef EXPENSIVE_CHECKS 146 bool llvm::VerifySCEV = true; 147 #else 148 bool llvm::VerifySCEV = false; 149 #endif 150 151 static cl::opt<unsigned> 152 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden, 153 cl::ZeroOrMore, 154 cl::desc("Maximum number of iterations SCEV will " 155 "symbolically execute a constant " 156 "derived loop"), 157 cl::init(100)); 158 159 static cl::opt<bool, true> VerifySCEVOpt( 160 "verify-scev", cl::Hidden, cl::location(VerifySCEV), 161 cl::desc("Verify ScalarEvolution's backedge taken counts (slow)")); 162 static cl::opt<bool> VerifySCEVStrict( 163 "verify-scev-strict", cl::Hidden, 164 cl::desc("Enable stricter verification with -verify-scev is passed")); 165 static cl::opt<bool> 166 VerifySCEVMap("verify-scev-maps", cl::Hidden, 167 cl::desc("Verify no dangling value in ScalarEvolution's " 168 "ExprValueMap (slow)")); 169 170 static cl::opt<bool> VerifyIR( 171 "scev-verify-ir", cl::Hidden, 172 cl::desc("Verify IR correctness when making sensitive SCEV queries (slow)"), 173 cl::init(false)); 174 175 static cl::opt<unsigned> MulOpsInlineThreshold( 176 "scev-mulops-inline-threshold", cl::Hidden, 177 cl::desc("Threshold for inlining multiplication operands into a SCEV"), 178 cl::init(32)); 179 180 static cl::opt<unsigned> AddOpsInlineThreshold( 181 "scev-addops-inline-threshold", cl::Hidden, 182 cl::desc("Threshold for inlining addition operands into a SCEV"), 183 cl::init(500)); 184 185 static cl::opt<unsigned> MaxSCEVCompareDepth( 186 "scalar-evolution-max-scev-compare-depth", cl::Hidden, 187 cl::desc("Maximum depth of recursive SCEV complexity comparisons"), 188 cl::init(32)); 189 190 static cl::opt<unsigned> MaxSCEVOperationsImplicationDepth( 191 "scalar-evolution-max-scev-operations-implication-depth", cl::Hidden, 192 cl::desc("Maximum depth of recursive SCEV operations implication analysis"), 193 cl::init(2)); 194 195 static cl::opt<unsigned> MaxValueCompareDepth( 196 "scalar-evolution-max-value-compare-depth", cl::Hidden, 197 cl::desc("Maximum depth of recursive value complexity comparisons"), 198 cl::init(2)); 199 200 static cl::opt<unsigned> 201 MaxArithDepth("scalar-evolution-max-arith-depth", cl::Hidden, 202 cl::desc("Maximum depth of recursive arithmetics"), 203 cl::init(32)); 204 205 static cl::opt<unsigned> MaxConstantEvolvingDepth( 206 "scalar-evolution-max-constant-evolving-depth", cl::Hidden, 207 cl::desc("Maximum depth of recursive constant evolving"), cl::init(32)); 208 209 static cl::opt<unsigned> 210 MaxCastDepth("scalar-evolution-max-cast-depth", cl::Hidden, 211 cl::desc("Maximum depth of recursive SExt/ZExt/Trunc"), 212 cl::init(8)); 213 214 static cl::opt<unsigned> 215 MaxAddRecSize("scalar-evolution-max-add-rec-size", cl::Hidden, 216 cl::desc("Max coefficients in AddRec during evolving"), 217 cl::init(8)); 218 219 static cl::opt<unsigned> 220 HugeExprThreshold("scalar-evolution-huge-expr-threshold", cl::Hidden, 221 cl::desc("Size of the expression which is considered huge"), 222 cl::init(4096)); 223 224 static cl::opt<bool> 225 ClassifyExpressions("scalar-evolution-classify-expressions", 226 cl::Hidden, cl::init(true), 227 cl::desc("When printing analysis, include information on every instruction")); 228 229 static cl::opt<bool> UseExpensiveRangeSharpening( 230 "scalar-evolution-use-expensive-range-sharpening", cl::Hidden, 231 cl::init(false), 232 cl::desc("Use more powerful methods of sharpening expression ranges. May " 233 "be costly in terms of compile time")); 234 235 static cl::opt<unsigned> MaxPhiSCCAnalysisSize( 236 "scalar-evolution-max-scc-analysis-depth", cl::Hidden, 237 cl::desc("Maximum amount of nodes to process while searching SCEVUnknown " 238 "Phi strongly connected components"), 239 cl::init(8)); 240 241 static cl::opt<bool> 242 EnableFiniteLoopControl("scalar-evolution-finite-loop", cl::Hidden, 243 cl::desc("Handle <= and >= in finite loops"), 244 cl::init(true)); 245 246 //===----------------------------------------------------------------------===// 247 // SCEV class definitions 248 //===----------------------------------------------------------------------===// 249 250 //===----------------------------------------------------------------------===// 251 // Implementation of the SCEV class. 252 // 253 254 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 255 LLVM_DUMP_METHOD void SCEV::dump() const { 256 print(dbgs()); 257 dbgs() << '\n'; 258 } 259 #endif 260 261 void SCEV::print(raw_ostream &OS) const { 262 switch (getSCEVType()) { 263 case scConstant: 264 cast<SCEVConstant>(this)->getValue()->printAsOperand(OS, false); 265 return; 266 case scPtrToInt: { 267 const SCEVPtrToIntExpr *PtrToInt = cast<SCEVPtrToIntExpr>(this); 268 const SCEV *Op = PtrToInt->getOperand(); 269 OS << "(ptrtoint " << *Op->getType() << " " << *Op << " to " 270 << *PtrToInt->getType() << ")"; 271 return; 272 } 273 case scTruncate: { 274 const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this); 275 const SCEV *Op = Trunc->getOperand(); 276 OS << "(trunc " << *Op->getType() << " " << *Op << " to " 277 << *Trunc->getType() << ")"; 278 return; 279 } 280 case scZeroExtend: { 281 const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this); 282 const SCEV *Op = ZExt->getOperand(); 283 OS << "(zext " << *Op->getType() << " " << *Op << " to " 284 << *ZExt->getType() << ")"; 285 return; 286 } 287 case scSignExtend: { 288 const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this); 289 const SCEV *Op = SExt->getOperand(); 290 OS << "(sext " << *Op->getType() << " " << *Op << " to " 291 << *SExt->getType() << ")"; 292 return; 293 } 294 case scAddRecExpr: { 295 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this); 296 OS << "{" << *AR->getOperand(0); 297 for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i) 298 OS << ",+," << *AR->getOperand(i); 299 OS << "}<"; 300 if (AR->hasNoUnsignedWrap()) 301 OS << "nuw><"; 302 if (AR->hasNoSignedWrap()) 303 OS << "nsw><"; 304 if (AR->hasNoSelfWrap() && 305 !AR->getNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW))) 306 OS << "nw><"; 307 AR->getLoop()->getHeader()->printAsOperand(OS, /*PrintType=*/false); 308 OS << ">"; 309 return; 310 } 311 case scAddExpr: 312 case scMulExpr: 313 case scUMaxExpr: 314 case scSMaxExpr: 315 case scUMinExpr: 316 case scSMinExpr: 317 case scSequentialUMinExpr: { 318 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this); 319 const char *OpStr = nullptr; 320 switch (NAry->getSCEVType()) { 321 case scAddExpr: OpStr = " + "; break; 322 case scMulExpr: OpStr = " * "; break; 323 case scUMaxExpr: OpStr = " umax "; break; 324 case scSMaxExpr: OpStr = " smax "; break; 325 case scUMinExpr: 326 OpStr = " umin "; 327 break; 328 case scSMinExpr: 329 OpStr = " smin "; 330 break; 331 case scSequentialUMinExpr: 332 OpStr = " umin_seq "; 333 break; 334 default: 335 llvm_unreachable("There are no other nary expression types."); 336 } 337 OS << "("; 338 ListSeparator LS(OpStr); 339 for (const SCEV *Op : NAry->operands()) 340 OS << LS << *Op; 341 OS << ")"; 342 switch (NAry->getSCEVType()) { 343 case scAddExpr: 344 case scMulExpr: 345 if (NAry->hasNoUnsignedWrap()) 346 OS << "<nuw>"; 347 if (NAry->hasNoSignedWrap()) 348 OS << "<nsw>"; 349 break; 350 default: 351 // Nothing to print for other nary expressions. 352 break; 353 } 354 return; 355 } 356 case scUDivExpr: { 357 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this); 358 OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")"; 359 return; 360 } 361 case scUnknown: { 362 const SCEVUnknown *U = cast<SCEVUnknown>(this); 363 Type *AllocTy; 364 if (U->isSizeOf(AllocTy)) { 365 OS << "sizeof(" << *AllocTy << ")"; 366 return; 367 } 368 if (U->isAlignOf(AllocTy)) { 369 OS << "alignof(" << *AllocTy << ")"; 370 return; 371 } 372 373 Type *CTy; 374 Constant *FieldNo; 375 if (U->isOffsetOf(CTy, FieldNo)) { 376 OS << "offsetof(" << *CTy << ", "; 377 FieldNo->printAsOperand(OS, false); 378 OS << ")"; 379 return; 380 } 381 382 // Otherwise just print it normally. 383 U->getValue()->printAsOperand(OS, false); 384 return; 385 } 386 case scCouldNotCompute: 387 OS << "***COULDNOTCOMPUTE***"; 388 return; 389 } 390 llvm_unreachable("Unknown SCEV kind!"); 391 } 392 393 Type *SCEV::getType() const { 394 switch (getSCEVType()) { 395 case scConstant: 396 return cast<SCEVConstant>(this)->getType(); 397 case scPtrToInt: 398 case scTruncate: 399 case scZeroExtend: 400 case scSignExtend: 401 return cast<SCEVCastExpr>(this)->getType(); 402 case scAddRecExpr: 403 return cast<SCEVAddRecExpr>(this)->getType(); 404 case scMulExpr: 405 return cast<SCEVMulExpr>(this)->getType(); 406 case scUMaxExpr: 407 case scSMaxExpr: 408 case scUMinExpr: 409 case scSMinExpr: 410 return cast<SCEVMinMaxExpr>(this)->getType(); 411 case scSequentialUMinExpr: 412 return cast<SCEVSequentialMinMaxExpr>(this)->getType(); 413 case scAddExpr: 414 return cast<SCEVAddExpr>(this)->getType(); 415 case scUDivExpr: 416 return cast<SCEVUDivExpr>(this)->getType(); 417 case scUnknown: 418 return cast<SCEVUnknown>(this)->getType(); 419 case scCouldNotCompute: 420 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 421 } 422 llvm_unreachable("Unknown SCEV kind!"); 423 } 424 425 bool SCEV::isZero() const { 426 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 427 return SC->getValue()->isZero(); 428 return false; 429 } 430 431 bool SCEV::isOne() const { 432 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 433 return SC->getValue()->isOne(); 434 return false; 435 } 436 437 bool SCEV::isAllOnesValue() const { 438 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this)) 439 return SC->getValue()->isMinusOne(); 440 return false; 441 } 442 443 bool SCEV::isNonConstantNegative() const { 444 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(this); 445 if (!Mul) return false; 446 447 // If there is a constant factor, it will be first. 448 const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0)); 449 if (!SC) return false; 450 451 // Return true if the value is negative, this matches things like (-42 * V). 452 return SC->getAPInt().isNegative(); 453 } 454 455 SCEVCouldNotCompute::SCEVCouldNotCompute() : 456 SCEV(FoldingSetNodeIDRef(), scCouldNotCompute, 0) {} 457 458 bool SCEVCouldNotCompute::classof(const SCEV *S) { 459 return S->getSCEVType() == scCouldNotCompute; 460 } 461 462 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) { 463 FoldingSetNodeID ID; 464 ID.AddInteger(scConstant); 465 ID.AddPointer(V); 466 void *IP = nullptr; 467 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 468 SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V); 469 UniqueSCEVs.InsertNode(S, IP); 470 return S; 471 } 472 473 const SCEV *ScalarEvolution::getConstant(const APInt &Val) { 474 return getConstant(ConstantInt::get(getContext(), Val)); 475 } 476 477 const SCEV * 478 ScalarEvolution::getConstant(Type *Ty, uint64_t V, bool isSigned) { 479 IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty)); 480 return getConstant(ConstantInt::get(ITy, V, isSigned)); 481 } 482 483 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID, SCEVTypes SCEVTy, 484 const SCEV *op, Type *ty) 485 : SCEV(ID, SCEVTy, computeExpressionSize(op)), Ty(ty) { 486 Operands[0] = op; 487 } 488 489 SCEVPtrToIntExpr::SCEVPtrToIntExpr(const FoldingSetNodeIDRef ID, const SCEV *Op, 490 Type *ITy) 491 : SCEVCastExpr(ID, scPtrToInt, Op, ITy) { 492 assert(getOperand()->getType()->isPointerTy() && Ty->isIntegerTy() && 493 "Must be a non-bit-width-changing pointer-to-integer cast!"); 494 } 495 496 SCEVIntegralCastExpr::SCEVIntegralCastExpr(const FoldingSetNodeIDRef ID, 497 SCEVTypes SCEVTy, const SCEV *op, 498 Type *ty) 499 : SCEVCastExpr(ID, SCEVTy, op, ty) {} 500 501 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID, const SCEV *op, 502 Type *ty) 503 : SCEVIntegralCastExpr(ID, scTruncate, op, ty) { 504 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 505 "Cannot truncate non-integer value!"); 506 } 507 508 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID, 509 const SCEV *op, Type *ty) 510 : SCEVIntegralCastExpr(ID, scZeroExtend, op, ty) { 511 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 512 "Cannot zero extend non-integer value!"); 513 } 514 515 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID, 516 const SCEV *op, Type *ty) 517 : SCEVIntegralCastExpr(ID, scSignExtend, op, ty) { 518 assert(getOperand()->getType()->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 519 "Cannot sign extend non-integer value!"); 520 } 521 522 void SCEVUnknown::deleted() { 523 // Clear this SCEVUnknown from various maps. 524 SE->forgetMemoizedResults(this); 525 526 // Remove this SCEVUnknown from the uniquing map. 527 SE->UniqueSCEVs.RemoveNode(this); 528 529 // Release the value. 530 setValPtr(nullptr); 531 } 532 533 void SCEVUnknown::allUsesReplacedWith(Value *New) { 534 // Clear this SCEVUnknown from various maps. 535 SE->forgetMemoizedResults(this); 536 537 // Remove this SCEVUnknown from the uniquing map. 538 SE->UniqueSCEVs.RemoveNode(this); 539 540 // Replace the value pointer in case someone is still using this SCEVUnknown. 541 setValPtr(New); 542 } 543 544 bool SCEVUnknown::isSizeOf(Type *&AllocTy) const { 545 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 546 if (VCE->getOpcode() == Instruction::PtrToInt) 547 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 548 if (CE->getOpcode() == Instruction::GetElementPtr && 549 CE->getOperand(0)->isNullValue() && 550 CE->getNumOperands() == 2) 551 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1))) 552 if (CI->isOne()) { 553 AllocTy = cast<GEPOperator>(CE)->getSourceElementType(); 554 return true; 555 } 556 557 return false; 558 } 559 560 bool SCEVUnknown::isAlignOf(Type *&AllocTy) const { 561 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 562 if (VCE->getOpcode() == Instruction::PtrToInt) 563 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 564 if (CE->getOpcode() == Instruction::GetElementPtr && 565 CE->getOperand(0)->isNullValue()) { 566 Type *Ty = cast<GEPOperator>(CE)->getSourceElementType(); 567 if (StructType *STy = dyn_cast<StructType>(Ty)) 568 if (!STy->isPacked() && 569 CE->getNumOperands() == 3 && 570 CE->getOperand(1)->isNullValue()) { 571 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2))) 572 if (CI->isOne() && 573 STy->getNumElements() == 2 && 574 STy->getElementType(0)->isIntegerTy(1)) { 575 AllocTy = STy->getElementType(1); 576 return true; 577 } 578 } 579 } 580 581 return false; 582 } 583 584 bool SCEVUnknown::isOffsetOf(Type *&CTy, Constant *&FieldNo) const { 585 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue())) 586 if (VCE->getOpcode() == Instruction::PtrToInt) 587 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0))) 588 if (CE->getOpcode() == Instruction::GetElementPtr && 589 CE->getNumOperands() == 3 && 590 CE->getOperand(0)->isNullValue() && 591 CE->getOperand(1)->isNullValue()) { 592 Type *Ty = cast<GEPOperator>(CE)->getSourceElementType(); 593 // Ignore vector types here so that ScalarEvolutionExpander doesn't 594 // emit getelementptrs that index into vectors. 595 if (Ty->isStructTy() || Ty->isArrayTy()) { 596 CTy = Ty; 597 FieldNo = CE->getOperand(2); 598 return true; 599 } 600 } 601 602 return false; 603 } 604 605 //===----------------------------------------------------------------------===// 606 // SCEV Utilities 607 //===----------------------------------------------------------------------===// 608 609 /// Compare the two values \p LV and \p RV in terms of their "complexity" where 610 /// "complexity" is a partial (and somewhat ad-hoc) relation used to order 611 /// operands in SCEV expressions. \p EqCache is a set of pairs of values that 612 /// have been previously deemed to be "equally complex" by this routine. It is 613 /// intended to avoid exponential time complexity in cases like: 614 /// 615 /// %a = f(%x, %y) 616 /// %b = f(%a, %a) 617 /// %c = f(%b, %b) 618 /// 619 /// %d = f(%x, %y) 620 /// %e = f(%d, %d) 621 /// %f = f(%e, %e) 622 /// 623 /// CompareValueComplexity(%f, %c) 624 /// 625 /// Since we do not continue running this routine on expression trees once we 626 /// have seen unequal values, there is no need to track them in the cache. 627 static int 628 CompareValueComplexity(EquivalenceClasses<const Value *> &EqCacheValue, 629 const LoopInfo *const LI, Value *LV, Value *RV, 630 unsigned Depth) { 631 if (Depth > MaxValueCompareDepth || EqCacheValue.isEquivalent(LV, RV)) 632 return 0; 633 634 // Order pointer values after integer values. This helps SCEVExpander form 635 // GEPs. 636 bool LIsPointer = LV->getType()->isPointerTy(), 637 RIsPointer = RV->getType()->isPointerTy(); 638 if (LIsPointer != RIsPointer) 639 return (int)LIsPointer - (int)RIsPointer; 640 641 // Compare getValueID values. 642 unsigned LID = LV->getValueID(), RID = RV->getValueID(); 643 if (LID != RID) 644 return (int)LID - (int)RID; 645 646 // Sort arguments by their position. 647 if (const auto *LA = dyn_cast<Argument>(LV)) { 648 const auto *RA = cast<Argument>(RV); 649 unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo(); 650 return (int)LArgNo - (int)RArgNo; 651 } 652 653 if (const auto *LGV = dyn_cast<GlobalValue>(LV)) { 654 const auto *RGV = cast<GlobalValue>(RV); 655 656 const auto IsGVNameSemantic = [&](const GlobalValue *GV) { 657 auto LT = GV->getLinkage(); 658 return !(GlobalValue::isPrivateLinkage(LT) || 659 GlobalValue::isInternalLinkage(LT)); 660 }; 661 662 // Use the names to distinguish the two values, but only if the 663 // names are semantically important. 664 if (IsGVNameSemantic(LGV) && IsGVNameSemantic(RGV)) 665 return LGV->getName().compare(RGV->getName()); 666 } 667 668 // For instructions, compare their loop depth, and their operand count. This 669 // is pretty loose. 670 if (const auto *LInst = dyn_cast<Instruction>(LV)) { 671 const auto *RInst = cast<Instruction>(RV); 672 673 // Compare loop depths. 674 const BasicBlock *LParent = LInst->getParent(), 675 *RParent = RInst->getParent(); 676 if (LParent != RParent) { 677 unsigned LDepth = LI->getLoopDepth(LParent), 678 RDepth = LI->getLoopDepth(RParent); 679 if (LDepth != RDepth) 680 return (int)LDepth - (int)RDepth; 681 } 682 683 // Compare the number of operands. 684 unsigned LNumOps = LInst->getNumOperands(), 685 RNumOps = RInst->getNumOperands(); 686 if (LNumOps != RNumOps) 687 return (int)LNumOps - (int)RNumOps; 688 689 for (unsigned Idx : seq(0u, LNumOps)) { 690 int Result = 691 CompareValueComplexity(EqCacheValue, LI, LInst->getOperand(Idx), 692 RInst->getOperand(Idx), Depth + 1); 693 if (Result != 0) 694 return Result; 695 } 696 } 697 698 EqCacheValue.unionSets(LV, RV); 699 return 0; 700 } 701 702 // Return negative, zero, or positive, if LHS is less than, equal to, or greater 703 // than RHS, respectively. A three-way result allows recursive comparisons to be 704 // more efficient. 705 // If the max analysis depth was reached, return None, assuming we do not know 706 // if they are equivalent for sure. 707 static Optional<int> 708 CompareSCEVComplexity(EquivalenceClasses<const SCEV *> &EqCacheSCEV, 709 EquivalenceClasses<const Value *> &EqCacheValue, 710 const LoopInfo *const LI, const SCEV *LHS, 711 const SCEV *RHS, DominatorTree &DT, unsigned Depth = 0) { 712 // Fast-path: SCEVs are uniqued so we can do a quick equality check. 713 if (LHS == RHS) 714 return 0; 715 716 // Primarily, sort the SCEVs by their getSCEVType(). 717 SCEVTypes LType = LHS->getSCEVType(), RType = RHS->getSCEVType(); 718 if (LType != RType) 719 return (int)LType - (int)RType; 720 721 if (EqCacheSCEV.isEquivalent(LHS, RHS)) 722 return 0; 723 724 if (Depth > MaxSCEVCompareDepth) 725 return None; 726 727 // Aside from the getSCEVType() ordering, the particular ordering 728 // isn't very important except that it's beneficial to be consistent, 729 // so that (a + b) and (b + a) don't end up as different expressions. 730 switch (LType) { 731 case scUnknown: { 732 const SCEVUnknown *LU = cast<SCEVUnknown>(LHS); 733 const SCEVUnknown *RU = cast<SCEVUnknown>(RHS); 734 735 int X = CompareValueComplexity(EqCacheValue, LI, LU->getValue(), 736 RU->getValue(), Depth + 1); 737 if (X == 0) 738 EqCacheSCEV.unionSets(LHS, RHS); 739 return X; 740 } 741 742 case scConstant: { 743 const SCEVConstant *LC = cast<SCEVConstant>(LHS); 744 const SCEVConstant *RC = cast<SCEVConstant>(RHS); 745 746 // Compare constant values. 747 const APInt &LA = LC->getAPInt(); 748 const APInt &RA = RC->getAPInt(); 749 unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth(); 750 if (LBitWidth != RBitWidth) 751 return (int)LBitWidth - (int)RBitWidth; 752 return LA.ult(RA) ? -1 : 1; 753 } 754 755 case scAddRecExpr: { 756 const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS); 757 const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS); 758 759 // There is always a dominance between two recs that are used by one SCEV, 760 // so we can safely sort recs by loop header dominance. We require such 761 // order in getAddExpr. 762 const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop(); 763 if (LLoop != RLoop) { 764 const BasicBlock *LHead = LLoop->getHeader(), *RHead = RLoop->getHeader(); 765 assert(LHead != RHead && "Two loops share the same header?"); 766 if (DT.dominates(LHead, RHead)) 767 return 1; 768 else 769 assert(DT.dominates(RHead, LHead) && 770 "No dominance between recurrences used by one SCEV?"); 771 return -1; 772 } 773 774 // Addrec complexity grows with operand count. 775 unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands(); 776 if (LNumOps != RNumOps) 777 return (int)LNumOps - (int)RNumOps; 778 779 // Lexicographically compare. 780 for (unsigned i = 0; i != LNumOps; ++i) { 781 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, 782 LA->getOperand(i), RA->getOperand(i), DT, 783 Depth + 1); 784 if (X != 0) 785 return X; 786 } 787 EqCacheSCEV.unionSets(LHS, RHS); 788 return 0; 789 } 790 791 case scAddExpr: 792 case scMulExpr: 793 case scSMaxExpr: 794 case scUMaxExpr: 795 case scSMinExpr: 796 case scUMinExpr: 797 case scSequentialUMinExpr: { 798 const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS); 799 const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS); 800 801 // Lexicographically compare n-ary expressions. 802 unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands(); 803 if (LNumOps != RNumOps) 804 return (int)LNumOps - (int)RNumOps; 805 806 for (unsigned i = 0; i != LNumOps; ++i) { 807 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, 808 LC->getOperand(i), RC->getOperand(i), DT, 809 Depth + 1); 810 if (X != 0) 811 return X; 812 } 813 EqCacheSCEV.unionSets(LHS, RHS); 814 return 0; 815 } 816 817 case scUDivExpr: { 818 const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS); 819 const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS); 820 821 // Lexicographically compare udiv expressions. 822 auto X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getLHS(), 823 RC->getLHS(), DT, Depth + 1); 824 if (X != 0) 825 return X; 826 X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getRHS(), 827 RC->getRHS(), DT, Depth + 1); 828 if (X == 0) 829 EqCacheSCEV.unionSets(LHS, RHS); 830 return X; 831 } 832 833 case scPtrToInt: 834 case scTruncate: 835 case scZeroExtend: 836 case scSignExtend: { 837 const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS); 838 const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS); 839 840 // Compare cast expressions by operand. 841 auto X = 842 CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getOperand(), 843 RC->getOperand(), DT, Depth + 1); 844 if (X == 0) 845 EqCacheSCEV.unionSets(LHS, RHS); 846 return X; 847 } 848 849 case scCouldNotCompute: 850 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 851 } 852 llvm_unreachable("Unknown SCEV kind!"); 853 } 854 855 /// Given a list of SCEV objects, order them by their complexity, and group 856 /// objects of the same complexity together by value. When this routine is 857 /// finished, we know that any duplicates in the vector are consecutive and that 858 /// complexity is monotonically increasing. 859 /// 860 /// Note that we go take special precautions to ensure that we get deterministic 861 /// results from this routine. In other words, we don't want the results of 862 /// this to depend on where the addresses of various SCEV objects happened to 863 /// land in memory. 864 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops, 865 LoopInfo *LI, DominatorTree &DT) { 866 if (Ops.size() < 2) return; // Noop 867 868 EquivalenceClasses<const SCEV *> EqCacheSCEV; 869 EquivalenceClasses<const Value *> EqCacheValue; 870 871 // Whether LHS has provably less complexity than RHS. 872 auto IsLessComplex = [&](const SCEV *LHS, const SCEV *RHS) { 873 auto Complexity = 874 CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LHS, RHS, DT); 875 return Complexity && *Complexity < 0; 876 }; 877 if (Ops.size() == 2) { 878 // This is the common case, which also happens to be trivially simple. 879 // Special case it. 880 const SCEV *&LHS = Ops[0], *&RHS = Ops[1]; 881 if (IsLessComplex(RHS, LHS)) 882 std::swap(LHS, RHS); 883 return; 884 } 885 886 // Do the rough sort by complexity. 887 llvm::stable_sort(Ops, [&](const SCEV *LHS, const SCEV *RHS) { 888 return IsLessComplex(LHS, RHS); 889 }); 890 891 // Now that we are sorted by complexity, group elements of the same 892 // complexity. Note that this is, at worst, N^2, but the vector is likely to 893 // be extremely short in practice. Note that we take this approach because we 894 // do not want to depend on the addresses of the objects we are grouping. 895 for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) { 896 const SCEV *S = Ops[i]; 897 unsigned Complexity = S->getSCEVType(); 898 899 // If there are any objects of the same complexity and same value as this 900 // one, group them. 901 for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) { 902 if (Ops[j] == S) { // Found a duplicate. 903 // Move it to immediately after i'th element. 904 std::swap(Ops[i+1], Ops[j]); 905 ++i; // no need to rescan it. 906 if (i == e-2) return; // Done! 907 } 908 } 909 } 910 } 911 912 /// Returns true if \p Ops contains a huge SCEV (the subtree of S contains at 913 /// least HugeExprThreshold nodes). 914 static bool hasHugeExpression(ArrayRef<const SCEV *> Ops) { 915 return any_of(Ops, [](const SCEV *S) { 916 return S->getExpressionSize() >= HugeExprThreshold; 917 }); 918 } 919 920 //===----------------------------------------------------------------------===// 921 // Simple SCEV method implementations 922 //===----------------------------------------------------------------------===// 923 924 /// Compute BC(It, K). The result has width W. Assume, K > 0. 925 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K, 926 ScalarEvolution &SE, 927 Type *ResultTy) { 928 // Handle the simplest case efficiently. 929 if (K == 1) 930 return SE.getTruncateOrZeroExtend(It, ResultTy); 931 932 // We are using the following formula for BC(It, K): 933 // 934 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K! 935 // 936 // Suppose, W is the bitwidth of the return value. We must be prepared for 937 // overflow. Hence, we must assure that the result of our computation is 938 // equal to the accurate one modulo 2^W. Unfortunately, division isn't 939 // safe in modular arithmetic. 940 // 941 // However, this code doesn't use exactly that formula; the formula it uses 942 // is something like the following, where T is the number of factors of 2 in 943 // K! (i.e. trailing zeros in the binary representation of K!), and ^ is 944 // exponentiation: 945 // 946 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T) 947 // 948 // This formula is trivially equivalent to the previous formula. However, 949 // this formula can be implemented much more efficiently. The trick is that 950 // K! / 2^T is odd, and exact division by an odd number *is* safe in modular 951 // arithmetic. To do exact division in modular arithmetic, all we have 952 // to do is multiply by the inverse. Therefore, this step can be done at 953 // width W. 954 // 955 // The next issue is how to safely do the division by 2^T. The way this 956 // is done is by doing the multiplication step at a width of at least W + T 957 // bits. This way, the bottom W+T bits of the product are accurate. Then, 958 // when we perform the division by 2^T (which is equivalent to a right shift 959 // by T), the bottom W bits are accurate. Extra bits are okay; they'll get 960 // truncated out after the division by 2^T. 961 // 962 // In comparison to just directly using the first formula, this technique 963 // is much more efficient; using the first formula requires W * K bits, 964 // but this formula less than W + K bits. Also, the first formula requires 965 // a division step, whereas this formula only requires multiplies and shifts. 966 // 967 // It doesn't matter whether the subtraction step is done in the calculation 968 // width or the input iteration count's width; if the subtraction overflows, 969 // the result must be zero anyway. We prefer here to do it in the width of 970 // the induction variable because it helps a lot for certain cases; CodeGen 971 // isn't smart enough to ignore the overflow, which leads to much less 972 // efficient code if the width of the subtraction is wider than the native 973 // register width. 974 // 975 // (It's possible to not widen at all by pulling out factors of 2 before 976 // the multiplication; for example, K=2 can be calculated as 977 // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires 978 // extra arithmetic, so it's not an obvious win, and it gets 979 // much more complicated for K > 3.) 980 981 // Protection from insane SCEVs; this bound is conservative, 982 // but it probably doesn't matter. 983 if (K > 1000) 984 return SE.getCouldNotCompute(); 985 986 unsigned W = SE.getTypeSizeInBits(ResultTy); 987 988 // Calculate K! / 2^T and T; we divide out the factors of two before 989 // multiplying for calculating K! / 2^T to avoid overflow. 990 // Other overflow doesn't matter because we only care about the bottom 991 // W bits of the result. 992 APInt OddFactorial(W, 1); 993 unsigned T = 1; 994 for (unsigned i = 3; i <= K; ++i) { 995 APInt Mult(W, i); 996 unsigned TwoFactors = Mult.countTrailingZeros(); 997 T += TwoFactors; 998 Mult.lshrInPlace(TwoFactors); 999 OddFactorial *= Mult; 1000 } 1001 1002 // We need at least W + T bits for the multiplication step 1003 unsigned CalculationBits = W + T; 1004 1005 // Calculate 2^T, at width T+W. 1006 APInt DivFactor = APInt::getOneBitSet(CalculationBits, T); 1007 1008 // Calculate the multiplicative inverse of K! / 2^T; 1009 // this multiplication factor will perform the exact division by 1010 // K! / 2^T. 1011 APInt Mod = APInt::getSignedMinValue(W+1); 1012 APInt MultiplyFactor = OddFactorial.zext(W+1); 1013 MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod); 1014 MultiplyFactor = MultiplyFactor.trunc(W); 1015 1016 // Calculate the product, at width T+W 1017 IntegerType *CalculationTy = IntegerType::get(SE.getContext(), 1018 CalculationBits); 1019 const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy); 1020 for (unsigned i = 1; i != K; ++i) { 1021 const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i)); 1022 Dividend = SE.getMulExpr(Dividend, 1023 SE.getTruncateOrZeroExtend(S, CalculationTy)); 1024 } 1025 1026 // Divide by 2^T 1027 const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor)); 1028 1029 // Truncate the result, and divide by K! / 2^T. 1030 1031 return SE.getMulExpr(SE.getConstant(MultiplyFactor), 1032 SE.getTruncateOrZeroExtend(DivResult, ResultTy)); 1033 } 1034 1035 /// Return the value of this chain of recurrences at the specified iteration 1036 /// number. We can evaluate this recurrence by multiplying each element in the 1037 /// chain by the binomial coefficient corresponding to it. In other words, we 1038 /// can evaluate {A,+,B,+,C,+,D} as: 1039 /// 1040 /// A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3) 1041 /// 1042 /// where BC(It, k) stands for binomial coefficient. 1043 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It, 1044 ScalarEvolution &SE) const { 1045 return evaluateAtIteration(makeArrayRef(op_begin(), op_end()), It, SE); 1046 } 1047 1048 const SCEV * 1049 SCEVAddRecExpr::evaluateAtIteration(ArrayRef<const SCEV *> Operands, 1050 const SCEV *It, ScalarEvolution &SE) { 1051 assert(Operands.size() > 0); 1052 const SCEV *Result = Operands[0]; 1053 for (unsigned i = 1, e = Operands.size(); i != e; ++i) { 1054 // The computation is correct in the face of overflow provided that the 1055 // multiplication is performed _after_ the evaluation of the binomial 1056 // coefficient. 1057 const SCEV *Coeff = BinomialCoefficient(It, i, SE, Result->getType()); 1058 if (isa<SCEVCouldNotCompute>(Coeff)) 1059 return Coeff; 1060 1061 Result = SE.getAddExpr(Result, SE.getMulExpr(Operands[i], Coeff)); 1062 } 1063 return Result; 1064 } 1065 1066 //===----------------------------------------------------------------------===// 1067 // SCEV Expression folder implementations 1068 //===----------------------------------------------------------------------===// 1069 1070 const SCEV *ScalarEvolution::getLosslessPtrToIntExpr(const SCEV *Op, 1071 unsigned Depth) { 1072 assert(Depth <= 1 && 1073 "getLosslessPtrToIntExpr() should self-recurse at most once."); 1074 1075 // We could be called with an integer-typed operands during SCEV rewrites. 1076 // Since the operand is an integer already, just perform zext/trunc/self cast. 1077 if (!Op->getType()->isPointerTy()) 1078 return Op; 1079 1080 // What would be an ID for such a SCEV cast expression? 1081 FoldingSetNodeID ID; 1082 ID.AddInteger(scPtrToInt); 1083 ID.AddPointer(Op); 1084 1085 void *IP = nullptr; 1086 1087 // Is there already an expression for such a cast? 1088 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 1089 return S; 1090 1091 // It isn't legal for optimizations to construct new ptrtoint expressions 1092 // for non-integral pointers. 1093 if (getDataLayout().isNonIntegralPointerType(Op->getType())) 1094 return getCouldNotCompute(); 1095 1096 Type *IntPtrTy = getDataLayout().getIntPtrType(Op->getType()); 1097 1098 // We can only trivially model ptrtoint if SCEV's effective (integer) type 1099 // is sufficiently wide to represent all possible pointer values. 1100 // We could theoretically teach SCEV to truncate wider pointers, but 1101 // that isn't implemented for now. 1102 if (getDataLayout().getTypeSizeInBits(getEffectiveSCEVType(Op->getType())) != 1103 getDataLayout().getTypeSizeInBits(IntPtrTy)) 1104 return getCouldNotCompute(); 1105 1106 // If not, is this expression something we can't reduce any further? 1107 if (auto *U = dyn_cast<SCEVUnknown>(Op)) { 1108 // Perform some basic constant folding. If the operand of the ptr2int cast 1109 // is a null pointer, don't create a ptr2int SCEV expression (that will be 1110 // left as-is), but produce a zero constant. 1111 // NOTE: We could handle a more general case, but lack motivational cases. 1112 if (isa<ConstantPointerNull>(U->getValue())) 1113 return getZero(IntPtrTy); 1114 1115 // Create an explicit cast node. 1116 // We can reuse the existing insert position since if we get here, 1117 // we won't have made any changes which would invalidate it. 1118 SCEV *S = new (SCEVAllocator) 1119 SCEVPtrToIntExpr(ID.Intern(SCEVAllocator), Op, IntPtrTy); 1120 UniqueSCEVs.InsertNode(S, IP); 1121 registerUser(S, Op); 1122 return S; 1123 } 1124 1125 assert(Depth == 0 && "getLosslessPtrToIntExpr() should not self-recurse for " 1126 "non-SCEVUnknown's."); 1127 1128 // Otherwise, we've got some expression that is more complex than just a 1129 // single SCEVUnknown. But we don't want to have a SCEVPtrToIntExpr of an 1130 // arbitrary expression, we want to have SCEVPtrToIntExpr of an SCEVUnknown 1131 // only, and the expressions must otherwise be integer-typed. 1132 // So sink the cast down to the SCEVUnknown's. 1133 1134 /// The SCEVPtrToIntSinkingRewriter takes a scalar evolution expression, 1135 /// which computes a pointer-typed value, and rewrites the whole expression 1136 /// tree so that *all* the computations are done on integers, and the only 1137 /// pointer-typed operands in the expression are SCEVUnknown. 1138 class SCEVPtrToIntSinkingRewriter 1139 : public SCEVRewriteVisitor<SCEVPtrToIntSinkingRewriter> { 1140 using Base = SCEVRewriteVisitor<SCEVPtrToIntSinkingRewriter>; 1141 1142 public: 1143 SCEVPtrToIntSinkingRewriter(ScalarEvolution &SE) : SCEVRewriteVisitor(SE) {} 1144 1145 static const SCEV *rewrite(const SCEV *Scev, ScalarEvolution &SE) { 1146 SCEVPtrToIntSinkingRewriter Rewriter(SE); 1147 return Rewriter.visit(Scev); 1148 } 1149 1150 const SCEV *visit(const SCEV *S) { 1151 Type *STy = S->getType(); 1152 // If the expression is not pointer-typed, just keep it as-is. 1153 if (!STy->isPointerTy()) 1154 return S; 1155 // Else, recursively sink the cast down into it. 1156 return Base::visit(S); 1157 } 1158 1159 const SCEV *visitAddExpr(const SCEVAddExpr *Expr) { 1160 SmallVector<const SCEV *, 2> Operands; 1161 bool Changed = false; 1162 for (auto *Op : Expr->operands()) { 1163 Operands.push_back(visit(Op)); 1164 Changed |= Op != Operands.back(); 1165 } 1166 return !Changed ? Expr : SE.getAddExpr(Operands, Expr->getNoWrapFlags()); 1167 } 1168 1169 const SCEV *visitMulExpr(const SCEVMulExpr *Expr) { 1170 SmallVector<const SCEV *, 2> Operands; 1171 bool Changed = false; 1172 for (auto *Op : Expr->operands()) { 1173 Operands.push_back(visit(Op)); 1174 Changed |= Op != Operands.back(); 1175 } 1176 return !Changed ? Expr : SE.getMulExpr(Operands, Expr->getNoWrapFlags()); 1177 } 1178 1179 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 1180 assert(Expr->getType()->isPointerTy() && 1181 "Should only reach pointer-typed SCEVUnknown's."); 1182 return SE.getLosslessPtrToIntExpr(Expr, /*Depth=*/1); 1183 } 1184 }; 1185 1186 // And actually perform the cast sinking. 1187 const SCEV *IntOp = SCEVPtrToIntSinkingRewriter::rewrite(Op, *this); 1188 assert(IntOp->getType()->isIntegerTy() && 1189 "We must have succeeded in sinking the cast, " 1190 "and ending up with an integer-typed expression!"); 1191 return IntOp; 1192 } 1193 1194 const SCEV *ScalarEvolution::getPtrToIntExpr(const SCEV *Op, Type *Ty) { 1195 assert(Ty->isIntegerTy() && "Target type must be an integer type!"); 1196 1197 const SCEV *IntOp = getLosslessPtrToIntExpr(Op); 1198 if (isa<SCEVCouldNotCompute>(IntOp)) 1199 return IntOp; 1200 1201 return getTruncateOrZeroExtend(IntOp, Ty); 1202 } 1203 1204 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op, Type *Ty, 1205 unsigned Depth) { 1206 assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) && 1207 "This is not a truncating conversion!"); 1208 assert(isSCEVable(Ty) && 1209 "This is not a conversion to a SCEVable type!"); 1210 assert(!Op->getType()->isPointerTy() && "Can't truncate pointer!"); 1211 Ty = getEffectiveSCEVType(Ty); 1212 1213 FoldingSetNodeID ID; 1214 ID.AddInteger(scTruncate); 1215 ID.AddPointer(Op); 1216 ID.AddPointer(Ty); 1217 void *IP = nullptr; 1218 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1219 1220 // Fold if the operand is constant. 1221 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1222 return getConstant( 1223 cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(), Ty))); 1224 1225 // trunc(trunc(x)) --> trunc(x) 1226 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) 1227 return getTruncateExpr(ST->getOperand(), Ty, Depth + 1); 1228 1229 // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing 1230 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op)) 1231 return getTruncateOrSignExtend(SS->getOperand(), Ty, Depth + 1); 1232 1233 // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing 1234 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1235 return getTruncateOrZeroExtend(SZ->getOperand(), Ty, Depth + 1); 1236 1237 if (Depth > MaxCastDepth) { 1238 SCEV *S = 1239 new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator), Op, Ty); 1240 UniqueSCEVs.InsertNode(S, IP); 1241 registerUser(S, Op); 1242 return S; 1243 } 1244 1245 // trunc(x1 + ... + xN) --> trunc(x1) + ... + trunc(xN) and 1246 // trunc(x1 * ... * xN) --> trunc(x1) * ... * trunc(xN), 1247 // if after transforming we have at most one truncate, not counting truncates 1248 // that replace other casts. 1249 if (isa<SCEVAddExpr>(Op) || isa<SCEVMulExpr>(Op)) { 1250 auto *CommOp = cast<SCEVCommutativeExpr>(Op); 1251 SmallVector<const SCEV *, 4> Operands; 1252 unsigned numTruncs = 0; 1253 for (unsigned i = 0, e = CommOp->getNumOperands(); i != e && numTruncs < 2; 1254 ++i) { 1255 const SCEV *S = getTruncateExpr(CommOp->getOperand(i), Ty, Depth + 1); 1256 if (!isa<SCEVIntegralCastExpr>(CommOp->getOperand(i)) && 1257 isa<SCEVTruncateExpr>(S)) 1258 numTruncs++; 1259 Operands.push_back(S); 1260 } 1261 if (numTruncs < 2) { 1262 if (isa<SCEVAddExpr>(Op)) 1263 return getAddExpr(Operands); 1264 else if (isa<SCEVMulExpr>(Op)) 1265 return getMulExpr(Operands); 1266 else 1267 llvm_unreachable("Unexpected SCEV type for Op."); 1268 } 1269 // Although we checked in the beginning that ID is not in the cache, it is 1270 // possible that during recursion and different modification ID was inserted 1271 // into the cache. So if we find it, just return it. 1272 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 1273 return S; 1274 } 1275 1276 // If the input value is a chrec scev, truncate the chrec's operands. 1277 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) { 1278 SmallVector<const SCEV *, 4> Operands; 1279 for (const SCEV *Op : AddRec->operands()) 1280 Operands.push_back(getTruncateExpr(Op, Ty, Depth + 1)); 1281 return getAddRecExpr(Operands, AddRec->getLoop(), SCEV::FlagAnyWrap); 1282 } 1283 1284 // Return zero if truncating to known zeros. 1285 uint32_t MinTrailingZeros = GetMinTrailingZeros(Op); 1286 if (MinTrailingZeros >= getTypeSizeInBits(Ty)) 1287 return getZero(Ty); 1288 1289 // The cast wasn't folded; create an explicit cast node. We can reuse 1290 // the existing insert position since if we get here, we won't have 1291 // made any changes which would invalidate it. 1292 SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator), 1293 Op, Ty); 1294 UniqueSCEVs.InsertNode(S, IP); 1295 registerUser(S, Op); 1296 return S; 1297 } 1298 1299 // Get the limit of a recurrence such that incrementing by Step cannot cause 1300 // signed overflow as long as the value of the recurrence within the 1301 // loop does not exceed this limit before incrementing. 1302 static const SCEV *getSignedOverflowLimitForStep(const SCEV *Step, 1303 ICmpInst::Predicate *Pred, 1304 ScalarEvolution *SE) { 1305 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType()); 1306 if (SE->isKnownPositive(Step)) { 1307 *Pred = ICmpInst::ICMP_SLT; 1308 return SE->getConstant(APInt::getSignedMinValue(BitWidth) - 1309 SE->getSignedRangeMax(Step)); 1310 } 1311 if (SE->isKnownNegative(Step)) { 1312 *Pred = ICmpInst::ICMP_SGT; 1313 return SE->getConstant(APInt::getSignedMaxValue(BitWidth) - 1314 SE->getSignedRangeMin(Step)); 1315 } 1316 return nullptr; 1317 } 1318 1319 // Get the limit of a recurrence such that incrementing by Step cannot cause 1320 // unsigned overflow as long as the value of the recurrence within the loop does 1321 // not exceed this limit before incrementing. 1322 static const SCEV *getUnsignedOverflowLimitForStep(const SCEV *Step, 1323 ICmpInst::Predicate *Pred, 1324 ScalarEvolution *SE) { 1325 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType()); 1326 *Pred = ICmpInst::ICMP_ULT; 1327 1328 return SE->getConstant(APInt::getMinValue(BitWidth) - 1329 SE->getUnsignedRangeMax(Step)); 1330 } 1331 1332 namespace { 1333 1334 struct ExtendOpTraitsBase { 1335 typedef const SCEV *(ScalarEvolution::*GetExtendExprTy)(const SCEV *, Type *, 1336 unsigned); 1337 }; 1338 1339 // Used to make code generic over signed and unsigned overflow. 1340 template <typename ExtendOp> struct ExtendOpTraits { 1341 // Members present: 1342 // 1343 // static const SCEV::NoWrapFlags WrapType; 1344 // 1345 // static const ExtendOpTraitsBase::GetExtendExprTy GetExtendExpr; 1346 // 1347 // static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1348 // ICmpInst::Predicate *Pred, 1349 // ScalarEvolution *SE); 1350 }; 1351 1352 template <> 1353 struct ExtendOpTraits<SCEVSignExtendExpr> : public ExtendOpTraitsBase { 1354 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNSW; 1355 1356 static const GetExtendExprTy GetExtendExpr; 1357 1358 static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1359 ICmpInst::Predicate *Pred, 1360 ScalarEvolution *SE) { 1361 return getSignedOverflowLimitForStep(Step, Pred, SE); 1362 } 1363 }; 1364 1365 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits< 1366 SCEVSignExtendExpr>::GetExtendExpr = &ScalarEvolution::getSignExtendExpr; 1367 1368 template <> 1369 struct ExtendOpTraits<SCEVZeroExtendExpr> : public ExtendOpTraitsBase { 1370 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNUW; 1371 1372 static const GetExtendExprTy GetExtendExpr; 1373 1374 static const SCEV *getOverflowLimitForStep(const SCEV *Step, 1375 ICmpInst::Predicate *Pred, 1376 ScalarEvolution *SE) { 1377 return getUnsignedOverflowLimitForStep(Step, Pred, SE); 1378 } 1379 }; 1380 1381 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits< 1382 SCEVZeroExtendExpr>::GetExtendExpr = &ScalarEvolution::getZeroExtendExpr; 1383 1384 } // end anonymous namespace 1385 1386 // The recurrence AR has been shown to have no signed/unsigned wrap or something 1387 // close to it. Typically, if we can prove NSW/NUW for AR, then we can just as 1388 // easily prove NSW/NUW for its preincrement or postincrement sibling. This 1389 // allows normalizing a sign/zero extended AddRec as such: {sext/zext(Step + 1390 // Start),+,Step} => {(Step + sext/zext(Start),+,Step} As a result, the 1391 // expression "Step + sext/zext(PreIncAR)" is congruent with 1392 // "sext/zext(PostIncAR)" 1393 template <typename ExtendOpTy> 1394 static const SCEV *getPreStartForExtend(const SCEVAddRecExpr *AR, Type *Ty, 1395 ScalarEvolution *SE, unsigned Depth) { 1396 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType; 1397 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr; 1398 1399 const Loop *L = AR->getLoop(); 1400 const SCEV *Start = AR->getStart(); 1401 const SCEV *Step = AR->getStepRecurrence(*SE); 1402 1403 // Check for a simple looking step prior to loop entry. 1404 const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Start); 1405 if (!SA) 1406 return nullptr; 1407 1408 // Create an AddExpr for "PreStart" after subtracting Step. Full SCEV 1409 // subtraction is expensive. For this purpose, perform a quick and dirty 1410 // difference, by checking for Step in the operand list. 1411 SmallVector<const SCEV *, 4> DiffOps; 1412 for (const SCEV *Op : SA->operands()) 1413 if (Op != Step) 1414 DiffOps.push_back(Op); 1415 1416 if (DiffOps.size() == SA->getNumOperands()) 1417 return nullptr; 1418 1419 // Try to prove `WrapType` (SCEV::FlagNSW or SCEV::FlagNUW) on `PreStart` + 1420 // `Step`: 1421 1422 // 1. NSW/NUW flags on the step increment. 1423 auto PreStartFlags = 1424 ScalarEvolution::maskFlags(SA->getNoWrapFlags(), SCEV::FlagNUW); 1425 const SCEV *PreStart = SE->getAddExpr(DiffOps, PreStartFlags); 1426 const SCEVAddRecExpr *PreAR = dyn_cast<SCEVAddRecExpr>( 1427 SE->getAddRecExpr(PreStart, Step, L, SCEV::FlagAnyWrap)); 1428 1429 // "{S,+,X} is <nsw>/<nuw>" and "the backedge is taken at least once" implies 1430 // "S+X does not sign/unsign-overflow". 1431 // 1432 1433 const SCEV *BECount = SE->getBackedgeTakenCount(L); 1434 if (PreAR && PreAR->getNoWrapFlags(WrapType) && 1435 !isa<SCEVCouldNotCompute>(BECount) && SE->isKnownPositive(BECount)) 1436 return PreStart; 1437 1438 // 2. Direct overflow check on the step operation's expression. 1439 unsigned BitWidth = SE->getTypeSizeInBits(AR->getType()); 1440 Type *WideTy = IntegerType::get(SE->getContext(), BitWidth * 2); 1441 const SCEV *OperandExtendedStart = 1442 SE->getAddExpr((SE->*GetExtendExpr)(PreStart, WideTy, Depth), 1443 (SE->*GetExtendExpr)(Step, WideTy, Depth)); 1444 if ((SE->*GetExtendExpr)(Start, WideTy, Depth) == OperandExtendedStart) { 1445 if (PreAR && AR->getNoWrapFlags(WrapType)) { 1446 // If we know `AR` == {`PreStart`+`Step`,+,`Step`} is `WrapType` (FlagNSW 1447 // or FlagNUW) and that `PreStart` + `Step` is `WrapType` too, then 1448 // `PreAR` == {`PreStart`,+,`Step`} is also `WrapType`. Cache this fact. 1449 SE->setNoWrapFlags(const_cast<SCEVAddRecExpr *>(PreAR), WrapType); 1450 } 1451 return PreStart; 1452 } 1453 1454 // 3. Loop precondition. 1455 ICmpInst::Predicate Pred; 1456 const SCEV *OverflowLimit = 1457 ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(Step, &Pred, SE); 1458 1459 if (OverflowLimit && 1460 SE->isLoopEntryGuardedByCond(L, Pred, PreStart, OverflowLimit)) 1461 return PreStart; 1462 1463 return nullptr; 1464 } 1465 1466 // Get the normalized zero or sign extended expression for this AddRec's Start. 1467 template <typename ExtendOpTy> 1468 static const SCEV *getExtendAddRecStart(const SCEVAddRecExpr *AR, Type *Ty, 1469 ScalarEvolution *SE, 1470 unsigned Depth) { 1471 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr; 1472 1473 const SCEV *PreStart = getPreStartForExtend<ExtendOpTy>(AR, Ty, SE, Depth); 1474 if (!PreStart) 1475 return (SE->*GetExtendExpr)(AR->getStart(), Ty, Depth); 1476 1477 return SE->getAddExpr((SE->*GetExtendExpr)(AR->getStepRecurrence(*SE), Ty, 1478 Depth), 1479 (SE->*GetExtendExpr)(PreStart, Ty, Depth)); 1480 } 1481 1482 // Try to prove away overflow by looking at "nearby" add recurrences. A 1483 // motivating example for this rule: if we know `{0,+,4}` is `ult` `-1` and it 1484 // does not itself wrap then we can conclude that `{1,+,4}` is `nuw`. 1485 // 1486 // Formally: 1487 // 1488 // {S,+,X} == {S-T,+,X} + T 1489 // => Ext({S,+,X}) == Ext({S-T,+,X} + T) 1490 // 1491 // If ({S-T,+,X} + T) does not overflow ... (1) 1492 // 1493 // RHS == Ext({S-T,+,X} + T) == Ext({S-T,+,X}) + Ext(T) 1494 // 1495 // If {S-T,+,X} does not overflow ... (2) 1496 // 1497 // RHS == Ext({S-T,+,X}) + Ext(T) == {Ext(S-T),+,Ext(X)} + Ext(T) 1498 // == {Ext(S-T)+Ext(T),+,Ext(X)} 1499 // 1500 // If (S-T)+T does not overflow ... (3) 1501 // 1502 // RHS == {Ext(S-T)+Ext(T),+,Ext(X)} == {Ext(S-T+T),+,Ext(X)} 1503 // == {Ext(S),+,Ext(X)} == LHS 1504 // 1505 // Thus, if (1), (2) and (3) are true for some T, then 1506 // Ext({S,+,X}) == {Ext(S),+,Ext(X)} 1507 // 1508 // (3) is implied by (1) -- "(S-T)+T does not overflow" is simply "({S-T,+,X}+T) 1509 // does not overflow" restricted to the 0th iteration. Therefore we only need 1510 // to check for (1) and (2). 1511 // 1512 // In the current context, S is `Start`, X is `Step`, Ext is `ExtendOpTy` and T 1513 // is `Delta` (defined below). 1514 template <typename ExtendOpTy> 1515 bool ScalarEvolution::proveNoWrapByVaryingStart(const SCEV *Start, 1516 const SCEV *Step, 1517 const Loop *L) { 1518 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType; 1519 1520 // We restrict `Start` to a constant to prevent SCEV from spending too much 1521 // time here. It is correct (but more expensive) to continue with a 1522 // non-constant `Start` and do a general SCEV subtraction to compute 1523 // `PreStart` below. 1524 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start); 1525 if (!StartC) 1526 return false; 1527 1528 APInt StartAI = StartC->getAPInt(); 1529 1530 for (unsigned Delta : {-2, -1, 1, 2}) { 1531 const SCEV *PreStart = getConstant(StartAI - Delta); 1532 1533 FoldingSetNodeID ID; 1534 ID.AddInteger(scAddRecExpr); 1535 ID.AddPointer(PreStart); 1536 ID.AddPointer(Step); 1537 ID.AddPointer(L); 1538 void *IP = nullptr; 1539 const auto *PreAR = 1540 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 1541 1542 // Give up if we don't already have the add recurrence we need because 1543 // actually constructing an add recurrence is relatively expensive. 1544 if (PreAR && PreAR->getNoWrapFlags(WrapType)) { // proves (2) 1545 const SCEV *DeltaS = getConstant(StartC->getType(), Delta); 1546 ICmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE; 1547 const SCEV *Limit = ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep( 1548 DeltaS, &Pred, this); 1549 if (Limit && isKnownPredicate(Pred, PreAR, Limit)) // proves (1) 1550 return true; 1551 } 1552 } 1553 1554 return false; 1555 } 1556 1557 // Finds an integer D for an expression (C + x + y + ...) such that the top 1558 // level addition in (D + (C - D + x + y + ...)) would not wrap (signed or 1559 // unsigned) and the number of trailing zeros of (C - D + x + y + ...) is 1560 // maximized, where C is the \p ConstantTerm, x, y, ... are arbitrary SCEVs, and 1561 // the (C + x + y + ...) expression is \p WholeAddExpr. 1562 static APInt extractConstantWithoutWrapping(ScalarEvolution &SE, 1563 const SCEVConstant *ConstantTerm, 1564 const SCEVAddExpr *WholeAddExpr) { 1565 const APInt &C = ConstantTerm->getAPInt(); 1566 const unsigned BitWidth = C.getBitWidth(); 1567 // Find number of trailing zeros of (x + y + ...) w/o the C first: 1568 uint32_t TZ = BitWidth; 1569 for (unsigned I = 1, E = WholeAddExpr->getNumOperands(); I < E && TZ; ++I) 1570 TZ = std::min(TZ, SE.GetMinTrailingZeros(WholeAddExpr->getOperand(I))); 1571 if (TZ) { 1572 // Set D to be as many least significant bits of C as possible while still 1573 // guaranteeing that adding D to (C - D + x + y + ...) won't cause a wrap: 1574 return TZ < BitWidth ? C.trunc(TZ).zext(BitWidth) : C; 1575 } 1576 return APInt(BitWidth, 0); 1577 } 1578 1579 // Finds an integer D for an affine AddRec expression {C,+,x} such that the top 1580 // level addition in (D + {C-D,+,x}) would not wrap (signed or unsigned) and the 1581 // number of trailing zeros of (C - D + x * n) is maximized, where C is the \p 1582 // ConstantStart, x is an arbitrary \p Step, and n is the loop trip count. 1583 static APInt extractConstantWithoutWrapping(ScalarEvolution &SE, 1584 const APInt &ConstantStart, 1585 const SCEV *Step) { 1586 const unsigned BitWidth = ConstantStart.getBitWidth(); 1587 const uint32_t TZ = SE.GetMinTrailingZeros(Step); 1588 if (TZ) 1589 return TZ < BitWidth ? ConstantStart.trunc(TZ).zext(BitWidth) 1590 : ConstantStart; 1591 return APInt(BitWidth, 0); 1592 } 1593 1594 const SCEV * 1595 ScalarEvolution::getZeroExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) { 1596 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 1597 "This is not an extending conversion!"); 1598 assert(isSCEVable(Ty) && 1599 "This is not a conversion to a SCEVable type!"); 1600 assert(!Op->getType()->isPointerTy() && "Can't extend pointer!"); 1601 Ty = getEffectiveSCEVType(Ty); 1602 1603 // Fold if the operand is constant. 1604 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1605 return getConstant( 1606 cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(), Ty))); 1607 1608 // zext(zext(x)) --> zext(x) 1609 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1610 return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1); 1611 1612 // Before doing any expensive analysis, check to see if we've already 1613 // computed a SCEV for this Op and Ty. 1614 FoldingSetNodeID ID; 1615 ID.AddInteger(scZeroExtend); 1616 ID.AddPointer(Op); 1617 ID.AddPointer(Ty); 1618 void *IP = nullptr; 1619 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1620 if (Depth > MaxCastDepth) { 1621 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator), 1622 Op, Ty); 1623 UniqueSCEVs.InsertNode(S, IP); 1624 registerUser(S, Op); 1625 return S; 1626 } 1627 1628 // zext(trunc(x)) --> zext(x) or x or trunc(x) 1629 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) { 1630 // It's possible the bits taken off by the truncate were all zero bits. If 1631 // so, we should be able to simplify this further. 1632 const SCEV *X = ST->getOperand(); 1633 ConstantRange CR = getUnsignedRange(X); 1634 unsigned TruncBits = getTypeSizeInBits(ST->getType()); 1635 unsigned NewBits = getTypeSizeInBits(Ty); 1636 if (CR.truncate(TruncBits).zeroExtend(NewBits).contains( 1637 CR.zextOrTrunc(NewBits))) 1638 return getTruncateOrZeroExtend(X, Ty, Depth); 1639 } 1640 1641 // If the input value is a chrec scev, and we can prove that the value 1642 // did not overflow the old, smaller, value, we can zero extend all of the 1643 // operands (often constants). This allows analysis of something like 1644 // this: for (unsigned char X = 0; X < 100; ++X) { int Y = X; } 1645 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) 1646 if (AR->isAffine()) { 1647 const SCEV *Start = AR->getStart(); 1648 const SCEV *Step = AR->getStepRecurrence(*this); 1649 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 1650 const Loop *L = AR->getLoop(); 1651 1652 if (!AR->hasNoUnsignedWrap()) { 1653 auto NewFlags = proveNoWrapViaConstantRanges(AR); 1654 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1655 } 1656 1657 // If we have special knowledge that this addrec won't overflow, 1658 // we don't need to do any further analysis. 1659 if (AR->hasNoUnsignedWrap()) 1660 return getAddRecExpr( 1661 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1), 1662 getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 1663 1664 // Check whether the backedge-taken count is SCEVCouldNotCompute. 1665 // Note that this serves two purposes: It filters out loops that are 1666 // simply not analyzable, and it covers the case where this code is 1667 // being called from within backedge-taken count analysis, such that 1668 // attempting to ask for the backedge-taken count would likely result 1669 // in infinite recursion. In the later case, the analysis code will 1670 // cope with a conservative value, and it will take care to purge 1671 // that value once it has finished. 1672 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 1673 if (!isa<SCEVCouldNotCompute>(MaxBECount)) { 1674 // Manually compute the final value for AR, checking for overflow. 1675 1676 // Check whether the backedge-taken count can be losslessly casted to 1677 // the addrec's type. The count is always unsigned. 1678 const SCEV *CastedMaxBECount = 1679 getTruncateOrZeroExtend(MaxBECount, Start->getType(), Depth); 1680 const SCEV *RecastedMaxBECount = getTruncateOrZeroExtend( 1681 CastedMaxBECount, MaxBECount->getType(), Depth); 1682 if (MaxBECount == RecastedMaxBECount) { 1683 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2); 1684 // Check whether Start+Step*MaxBECount has no unsigned overflow. 1685 const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step, 1686 SCEV::FlagAnyWrap, Depth + 1); 1687 const SCEV *ZAdd = getZeroExtendExpr(getAddExpr(Start, ZMul, 1688 SCEV::FlagAnyWrap, 1689 Depth + 1), 1690 WideTy, Depth + 1); 1691 const SCEV *WideStart = getZeroExtendExpr(Start, WideTy, Depth + 1); 1692 const SCEV *WideMaxBECount = 1693 getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1); 1694 const SCEV *OperandExtendedAdd = 1695 getAddExpr(WideStart, 1696 getMulExpr(WideMaxBECount, 1697 getZeroExtendExpr(Step, WideTy, Depth + 1), 1698 SCEV::FlagAnyWrap, Depth + 1), 1699 SCEV::FlagAnyWrap, Depth + 1); 1700 if (ZAdd == OperandExtendedAdd) { 1701 // Cache knowledge of AR NUW, which is propagated to this AddRec. 1702 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNUW); 1703 // Return the expression with the addrec on the outside. 1704 return getAddRecExpr( 1705 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1706 Depth + 1), 1707 getZeroExtendExpr(Step, Ty, Depth + 1), L, 1708 AR->getNoWrapFlags()); 1709 } 1710 // Similar to above, only this time treat the step value as signed. 1711 // This covers loops that count down. 1712 OperandExtendedAdd = 1713 getAddExpr(WideStart, 1714 getMulExpr(WideMaxBECount, 1715 getSignExtendExpr(Step, WideTy, Depth + 1), 1716 SCEV::FlagAnyWrap, Depth + 1), 1717 SCEV::FlagAnyWrap, Depth + 1); 1718 if (ZAdd == OperandExtendedAdd) { 1719 // Cache knowledge of AR NW, which is propagated to this AddRec. 1720 // Negative step causes unsigned wrap, but it still can't self-wrap. 1721 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 1722 // Return the expression with the addrec on the outside. 1723 return getAddRecExpr( 1724 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1725 Depth + 1), 1726 getSignExtendExpr(Step, Ty, Depth + 1), L, 1727 AR->getNoWrapFlags()); 1728 } 1729 } 1730 } 1731 1732 // Normally, in the cases we can prove no-overflow via a 1733 // backedge guarding condition, we can also compute a backedge 1734 // taken count for the loop. The exceptions are assumptions and 1735 // guards present in the loop -- SCEV is not great at exploiting 1736 // these to compute max backedge taken counts, but can still use 1737 // these to prove lack of overflow. Use this fact to avoid 1738 // doing extra work that may not pay off. 1739 if (!isa<SCEVCouldNotCompute>(MaxBECount) || HasGuards || 1740 !AC.assumptions().empty()) { 1741 1742 auto NewFlags = proveNoUnsignedWrapViaInduction(AR); 1743 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1744 if (AR->hasNoUnsignedWrap()) { 1745 // Same as nuw case above - duplicated here to avoid a compile time 1746 // issue. It's not clear that the order of checks does matter, but 1747 // it's one of two issue possible causes for a change which was 1748 // reverted. Be conservative for the moment. 1749 return getAddRecExpr( 1750 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1751 Depth + 1), 1752 getZeroExtendExpr(Step, Ty, Depth + 1), L, 1753 AR->getNoWrapFlags()); 1754 } 1755 1756 // For a negative step, we can extend the operands iff doing so only 1757 // traverses values in the range zext([0,UINT_MAX]). 1758 if (isKnownNegative(Step)) { 1759 const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) - 1760 getSignedRangeMin(Step)); 1761 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) || 1762 isKnownOnEveryIteration(ICmpInst::ICMP_UGT, AR, N)) { 1763 // Cache knowledge of AR NW, which is propagated to this 1764 // AddRec. Negative step causes unsigned wrap, but it 1765 // still can't self-wrap. 1766 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 1767 // Return the expression with the addrec on the outside. 1768 return getAddRecExpr( 1769 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 1770 Depth + 1), 1771 getSignExtendExpr(Step, Ty, Depth + 1), L, 1772 AR->getNoWrapFlags()); 1773 } 1774 } 1775 } 1776 1777 // zext({C,+,Step}) --> (zext(D) + zext({C-D,+,Step}))<nuw><nsw> 1778 // if D + (C - D + Step * n) could be proven to not unsigned wrap 1779 // where D maximizes the number of trailing zeros of (C - D + Step * n) 1780 if (const auto *SC = dyn_cast<SCEVConstant>(Start)) { 1781 const APInt &C = SC->getAPInt(); 1782 const APInt &D = extractConstantWithoutWrapping(*this, C, Step); 1783 if (D != 0) { 1784 const SCEV *SZExtD = getZeroExtendExpr(getConstant(D), Ty, Depth); 1785 const SCEV *SResidual = 1786 getAddRecExpr(getConstant(C - D), Step, L, AR->getNoWrapFlags()); 1787 const SCEV *SZExtR = getZeroExtendExpr(SResidual, Ty, Depth + 1); 1788 return getAddExpr(SZExtD, SZExtR, 1789 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1790 Depth + 1); 1791 } 1792 } 1793 1794 if (proveNoWrapByVaryingStart<SCEVZeroExtendExpr>(Start, Step, L)) { 1795 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNUW); 1796 return getAddRecExpr( 1797 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1), 1798 getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 1799 } 1800 } 1801 1802 // zext(A % B) --> zext(A) % zext(B) 1803 { 1804 const SCEV *LHS; 1805 const SCEV *RHS; 1806 if (matchURem(Op, LHS, RHS)) 1807 return getURemExpr(getZeroExtendExpr(LHS, Ty, Depth + 1), 1808 getZeroExtendExpr(RHS, Ty, Depth + 1)); 1809 } 1810 1811 // zext(A / B) --> zext(A) / zext(B). 1812 if (auto *Div = dyn_cast<SCEVUDivExpr>(Op)) 1813 return getUDivExpr(getZeroExtendExpr(Div->getLHS(), Ty, Depth + 1), 1814 getZeroExtendExpr(Div->getRHS(), Ty, Depth + 1)); 1815 1816 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) { 1817 // zext((A + B + ...)<nuw>) --> (zext(A) + zext(B) + ...)<nuw> 1818 if (SA->hasNoUnsignedWrap()) { 1819 // If the addition does not unsign overflow then we can, by definition, 1820 // commute the zero extension with the addition operation. 1821 SmallVector<const SCEV *, 4> Ops; 1822 for (const auto *Op : SA->operands()) 1823 Ops.push_back(getZeroExtendExpr(Op, Ty, Depth + 1)); 1824 return getAddExpr(Ops, SCEV::FlagNUW, Depth + 1); 1825 } 1826 1827 // zext(C + x + y + ...) --> (zext(D) + zext((C - D) + x + y + ...)) 1828 // if D + (C - D + x + y + ...) could be proven to not unsigned wrap 1829 // where D maximizes the number of trailing zeros of (C - D + x + y + ...) 1830 // 1831 // Often address arithmetics contain expressions like 1832 // (zext (add (shl X, C1), C2)), for instance, (zext (5 + (4 * X))). 1833 // This transformation is useful while proving that such expressions are 1834 // equal or differ by a small constant amount, see LoadStoreVectorizer pass. 1835 if (const auto *SC = dyn_cast<SCEVConstant>(SA->getOperand(0))) { 1836 const APInt &D = extractConstantWithoutWrapping(*this, SC, SA); 1837 if (D != 0) { 1838 const SCEV *SZExtD = getZeroExtendExpr(getConstant(D), Ty, Depth); 1839 const SCEV *SResidual = 1840 getAddExpr(getConstant(-D), SA, SCEV::FlagAnyWrap, Depth); 1841 const SCEV *SZExtR = getZeroExtendExpr(SResidual, Ty, Depth + 1); 1842 return getAddExpr(SZExtD, SZExtR, 1843 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1844 Depth + 1); 1845 } 1846 } 1847 } 1848 1849 if (auto *SM = dyn_cast<SCEVMulExpr>(Op)) { 1850 // zext((A * B * ...)<nuw>) --> (zext(A) * zext(B) * ...)<nuw> 1851 if (SM->hasNoUnsignedWrap()) { 1852 // If the multiply does not unsign overflow then we can, by definition, 1853 // commute the zero extension with the multiply operation. 1854 SmallVector<const SCEV *, 4> Ops; 1855 for (const auto *Op : SM->operands()) 1856 Ops.push_back(getZeroExtendExpr(Op, Ty, Depth + 1)); 1857 return getMulExpr(Ops, SCEV::FlagNUW, Depth + 1); 1858 } 1859 1860 // zext(2^K * (trunc X to iN)) to iM -> 1861 // 2^K * (zext(trunc X to i{N-K}) to iM)<nuw> 1862 // 1863 // Proof: 1864 // 1865 // zext(2^K * (trunc X to iN)) to iM 1866 // = zext((trunc X to iN) << K) to iM 1867 // = zext((trunc X to i{N-K}) << K)<nuw> to iM 1868 // (because shl removes the top K bits) 1869 // = zext((2^K * (trunc X to i{N-K}))<nuw>) to iM 1870 // = (2^K * (zext(trunc X to i{N-K}) to iM))<nuw>. 1871 // 1872 if (SM->getNumOperands() == 2) 1873 if (auto *MulLHS = dyn_cast<SCEVConstant>(SM->getOperand(0))) 1874 if (MulLHS->getAPInt().isPowerOf2()) 1875 if (auto *TruncRHS = dyn_cast<SCEVTruncateExpr>(SM->getOperand(1))) { 1876 int NewTruncBits = getTypeSizeInBits(TruncRHS->getType()) - 1877 MulLHS->getAPInt().logBase2(); 1878 Type *NewTruncTy = IntegerType::get(getContext(), NewTruncBits); 1879 return getMulExpr( 1880 getZeroExtendExpr(MulLHS, Ty), 1881 getZeroExtendExpr( 1882 getTruncateExpr(TruncRHS->getOperand(), NewTruncTy), Ty), 1883 SCEV::FlagNUW, Depth + 1); 1884 } 1885 } 1886 1887 // The cast wasn't folded; create an explicit cast node. 1888 // Recompute the insert position, as it may have been invalidated. 1889 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1890 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator), 1891 Op, Ty); 1892 UniqueSCEVs.InsertNode(S, IP); 1893 registerUser(S, Op); 1894 return S; 1895 } 1896 1897 const SCEV * 1898 ScalarEvolution::getSignExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) { 1899 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 1900 "This is not an extending conversion!"); 1901 assert(isSCEVable(Ty) && 1902 "This is not a conversion to a SCEVable type!"); 1903 assert(!Op->getType()->isPointerTy() && "Can't extend pointer!"); 1904 Ty = getEffectiveSCEVType(Ty); 1905 1906 // Fold if the operand is constant. 1907 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 1908 return getConstant( 1909 cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(), Ty))); 1910 1911 // sext(sext(x)) --> sext(x) 1912 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op)) 1913 return getSignExtendExpr(SS->getOperand(), Ty, Depth + 1); 1914 1915 // sext(zext(x)) --> zext(x) 1916 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op)) 1917 return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1); 1918 1919 // Before doing any expensive analysis, check to see if we've already 1920 // computed a SCEV for this Op and Ty. 1921 FoldingSetNodeID ID; 1922 ID.AddInteger(scSignExtend); 1923 ID.AddPointer(Op); 1924 ID.AddPointer(Ty); 1925 void *IP = nullptr; 1926 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 1927 // Limit recursion depth. 1928 if (Depth > MaxCastDepth) { 1929 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator), 1930 Op, Ty); 1931 UniqueSCEVs.InsertNode(S, IP); 1932 registerUser(S, Op); 1933 return S; 1934 } 1935 1936 // sext(trunc(x)) --> sext(x) or x or trunc(x) 1937 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) { 1938 // It's possible the bits taken off by the truncate were all sign bits. If 1939 // so, we should be able to simplify this further. 1940 const SCEV *X = ST->getOperand(); 1941 ConstantRange CR = getSignedRange(X); 1942 unsigned TruncBits = getTypeSizeInBits(ST->getType()); 1943 unsigned NewBits = getTypeSizeInBits(Ty); 1944 if (CR.truncate(TruncBits).signExtend(NewBits).contains( 1945 CR.sextOrTrunc(NewBits))) 1946 return getTruncateOrSignExtend(X, Ty, Depth); 1947 } 1948 1949 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) { 1950 // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw> 1951 if (SA->hasNoSignedWrap()) { 1952 // If the addition does not sign overflow then we can, by definition, 1953 // commute the sign extension with the addition operation. 1954 SmallVector<const SCEV *, 4> Ops; 1955 for (const auto *Op : SA->operands()) 1956 Ops.push_back(getSignExtendExpr(Op, Ty, Depth + 1)); 1957 return getAddExpr(Ops, SCEV::FlagNSW, Depth + 1); 1958 } 1959 1960 // sext(C + x + y + ...) --> (sext(D) + sext((C - D) + x + y + ...)) 1961 // if D + (C - D + x + y + ...) could be proven to not signed wrap 1962 // where D maximizes the number of trailing zeros of (C - D + x + y + ...) 1963 // 1964 // For instance, this will bring two seemingly different expressions: 1965 // 1 + sext(5 + 20 * %x + 24 * %y) and 1966 // sext(6 + 20 * %x + 24 * %y) 1967 // to the same form: 1968 // 2 + sext(4 + 20 * %x + 24 * %y) 1969 if (const auto *SC = dyn_cast<SCEVConstant>(SA->getOperand(0))) { 1970 const APInt &D = extractConstantWithoutWrapping(*this, SC, SA); 1971 if (D != 0) { 1972 const SCEV *SSExtD = getSignExtendExpr(getConstant(D), Ty, Depth); 1973 const SCEV *SResidual = 1974 getAddExpr(getConstant(-D), SA, SCEV::FlagAnyWrap, Depth); 1975 const SCEV *SSExtR = getSignExtendExpr(SResidual, Ty, Depth + 1); 1976 return getAddExpr(SSExtD, SSExtR, 1977 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 1978 Depth + 1); 1979 } 1980 } 1981 } 1982 // If the input value is a chrec scev, and we can prove that the value 1983 // did not overflow the old, smaller, value, we can sign extend all of the 1984 // operands (often constants). This allows analysis of something like 1985 // this: for (signed char X = 0; X < 100; ++X) { int Y = X; } 1986 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) 1987 if (AR->isAffine()) { 1988 const SCEV *Start = AR->getStart(); 1989 const SCEV *Step = AR->getStepRecurrence(*this); 1990 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 1991 const Loop *L = AR->getLoop(); 1992 1993 if (!AR->hasNoSignedWrap()) { 1994 auto NewFlags = proveNoWrapViaConstantRanges(AR); 1995 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 1996 } 1997 1998 // If we have special knowledge that this addrec won't overflow, 1999 // we don't need to do any further analysis. 2000 if (AR->hasNoSignedWrap()) 2001 return getAddRecExpr( 2002 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 2003 getSignExtendExpr(Step, Ty, Depth + 1), L, SCEV::FlagNSW); 2004 2005 // Check whether the backedge-taken count is SCEVCouldNotCompute. 2006 // Note that this serves two purposes: It filters out loops that are 2007 // simply not analyzable, and it covers the case where this code is 2008 // being called from within backedge-taken count analysis, such that 2009 // attempting to ask for the backedge-taken count would likely result 2010 // in infinite recursion. In the later case, the analysis code will 2011 // cope with a conservative value, and it will take care to purge 2012 // that value once it has finished. 2013 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 2014 if (!isa<SCEVCouldNotCompute>(MaxBECount)) { 2015 // Manually compute the final value for AR, checking for 2016 // overflow. 2017 2018 // Check whether the backedge-taken count can be losslessly casted to 2019 // the addrec's type. The count is always unsigned. 2020 const SCEV *CastedMaxBECount = 2021 getTruncateOrZeroExtend(MaxBECount, Start->getType(), Depth); 2022 const SCEV *RecastedMaxBECount = getTruncateOrZeroExtend( 2023 CastedMaxBECount, MaxBECount->getType(), Depth); 2024 if (MaxBECount == RecastedMaxBECount) { 2025 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2); 2026 // Check whether Start+Step*MaxBECount has no signed overflow. 2027 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step, 2028 SCEV::FlagAnyWrap, Depth + 1); 2029 const SCEV *SAdd = getSignExtendExpr(getAddExpr(Start, SMul, 2030 SCEV::FlagAnyWrap, 2031 Depth + 1), 2032 WideTy, Depth + 1); 2033 const SCEV *WideStart = getSignExtendExpr(Start, WideTy, Depth + 1); 2034 const SCEV *WideMaxBECount = 2035 getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1); 2036 const SCEV *OperandExtendedAdd = 2037 getAddExpr(WideStart, 2038 getMulExpr(WideMaxBECount, 2039 getSignExtendExpr(Step, WideTy, Depth + 1), 2040 SCEV::FlagAnyWrap, Depth + 1), 2041 SCEV::FlagAnyWrap, Depth + 1); 2042 if (SAdd == OperandExtendedAdd) { 2043 // Cache knowledge of AR NSW, which is propagated to this AddRec. 2044 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNSW); 2045 // Return the expression with the addrec on the outside. 2046 return getAddRecExpr( 2047 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, 2048 Depth + 1), 2049 getSignExtendExpr(Step, Ty, Depth + 1), L, 2050 AR->getNoWrapFlags()); 2051 } 2052 // Similar to above, only this time treat the step value as unsigned. 2053 // This covers loops that count up with an unsigned step. 2054 OperandExtendedAdd = 2055 getAddExpr(WideStart, 2056 getMulExpr(WideMaxBECount, 2057 getZeroExtendExpr(Step, WideTy, Depth + 1), 2058 SCEV::FlagAnyWrap, Depth + 1), 2059 SCEV::FlagAnyWrap, Depth + 1); 2060 if (SAdd == OperandExtendedAdd) { 2061 // If AR wraps around then 2062 // 2063 // abs(Step) * MaxBECount > unsigned-max(AR->getType()) 2064 // => SAdd != OperandExtendedAdd 2065 // 2066 // Thus (AR is not NW => SAdd != OperandExtendedAdd) <=> 2067 // (SAdd == OperandExtendedAdd => AR is NW) 2068 2069 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNW); 2070 2071 // Return the expression with the addrec on the outside. 2072 return getAddRecExpr( 2073 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, 2074 Depth + 1), 2075 getZeroExtendExpr(Step, Ty, Depth + 1), L, 2076 AR->getNoWrapFlags()); 2077 } 2078 } 2079 } 2080 2081 auto NewFlags = proveNoSignedWrapViaInduction(AR); 2082 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), NewFlags); 2083 if (AR->hasNoSignedWrap()) { 2084 // Same as nsw case above - duplicated here to avoid a compile time 2085 // issue. It's not clear that the order of checks does matter, but 2086 // it's one of two issue possible causes for a change which was 2087 // reverted. Be conservative for the moment. 2088 return getAddRecExpr( 2089 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 2090 getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 2091 } 2092 2093 // sext({C,+,Step}) --> (sext(D) + sext({C-D,+,Step}))<nuw><nsw> 2094 // if D + (C - D + Step * n) could be proven to not signed wrap 2095 // where D maximizes the number of trailing zeros of (C - D + Step * n) 2096 if (const auto *SC = dyn_cast<SCEVConstant>(Start)) { 2097 const APInt &C = SC->getAPInt(); 2098 const APInt &D = extractConstantWithoutWrapping(*this, C, Step); 2099 if (D != 0) { 2100 const SCEV *SSExtD = getSignExtendExpr(getConstant(D), Ty, Depth); 2101 const SCEV *SResidual = 2102 getAddRecExpr(getConstant(C - D), Step, L, AR->getNoWrapFlags()); 2103 const SCEV *SSExtR = getSignExtendExpr(SResidual, Ty, Depth + 1); 2104 return getAddExpr(SSExtD, SSExtR, 2105 (SCEV::NoWrapFlags)(SCEV::FlagNSW | SCEV::FlagNUW), 2106 Depth + 1); 2107 } 2108 } 2109 2110 if (proveNoWrapByVaryingStart<SCEVSignExtendExpr>(Start, Step, L)) { 2111 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), SCEV::FlagNSW); 2112 return getAddRecExpr( 2113 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1), 2114 getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags()); 2115 } 2116 } 2117 2118 // If the input value is provably positive and we could not simplify 2119 // away the sext build a zext instead. 2120 if (isKnownNonNegative(Op)) 2121 return getZeroExtendExpr(Op, Ty, Depth + 1); 2122 2123 // The cast wasn't folded; create an explicit cast node. 2124 // Recompute the insert position, as it may have been invalidated. 2125 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 2126 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator), 2127 Op, Ty); 2128 UniqueSCEVs.InsertNode(S, IP); 2129 registerUser(S, { Op }); 2130 return S; 2131 } 2132 2133 const SCEV *ScalarEvolution::getCastExpr(SCEVTypes Kind, const SCEV *Op, 2134 Type *Ty) { 2135 switch (Kind) { 2136 case scTruncate: 2137 return getTruncateExpr(Op, Ty); 2138 case scZeroExtend: 2139 return getZeroExtendExpr(Op, Ty); 2140 case scSignExtend: 2141 return getSignExtendExpr(Op, Ty); 2142 case scPtrToInt: 2143 return getPtrToIntExpr(Op, Ty); 2144 default: 2145 llvm_unreachable("Not a SCEV cast expression!"); 2146 } 2147 } 2148 2149 /// getAnyExtendExpr - Return a SCEV for the given operand extended with 2150 /// unspecified bits out to the given type. 2151 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op, 2152 Type *Ty) { 2153 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) && 2154 "This is not an extending conversion!"); 2155 assert(isSCEVable(Ty) && 2156 "This is not a conversion to a SCEVable type!"); 2157 Ty = getEffectiveSCEVType(Ty); 2158 2159 // Sign-extend negative constants. 2160 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op)) 2161 if (SC->getAPInt().isNegative()) 2162 return getSignExtendExpr(Op, Ty); 2163 2164 // Peel off a truncate cast. 2165 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) { 2166 const SCEV *NewOp = T->getOperand(); 2167 if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty)) 2168 return getAnyExtendExpr(NewOp, Ty); 2169 return getTruncateOrNoop(NewOp, Ty); 2170 } 2171 2172 // Next try a zext cast. If the cast is folded, use it. 2173 const SCEV *ZExt = getZeroExtendExpr(Op, Ty); 2174 if (!isa<SCEVZeroExtendExpr>(ZExt)) 2175 return ZExt; 2176 2177 // Next try a sext cast. If the cast is folded, use it. 2178 const SCEV *SExt = getSignExtendExpr(Op, Ty); 2179 if (!isa<SCEVSignExtendExpr>(SExt)) 2180 return SExt; 2181 2182 // Force the cast to be folded into the operands of an addrec. 2183 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) { 2184 SmallVector<const SCEV *, 4> Ops; 2185 for (const SCEV *Op : AR->operands()) 2186 Ops.push_back(getAnyExtendExpr(Op, Ty)); 2187 return getAddRecExpr(Ops, AR->getLoop(), SCEV::FlagNW); 2188 } 2189 2190 // If the expression is obviously signed, use the sext cast value. 2191 if (isa<SCEVSMaxExpr>(Op)) 2192 return SExt; 2193 2194 // Absent any other information, use the zext cast value. 2195 return ZExt; 2196 } 2197 2198 /// Process the given Ops list, which is a list of operands to be added under 2199 /// the given scale, update the given map. This is a helper function for 2200 /// getAddRecExpr. As an example of what it does, given a sequence of operands 2201 /// that would form an add expression like this: 2202 /// 2203 /// m + n + 13 + (A * (o + p + (B * (q + m + 29)))) + r + (-1 * r) 2204 /// 2205 /// where A and B are constants, update the map with these values: 2206 /// 2207 /// (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0) 2208 /// 2209 /// and add 13 + A*B*29 to AccumulatedConstant. 2210 /// This will allow getAddRecExpr to produce this: 2211 /// 2212 /// 13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B) 2213 /// 2214 /// This form often exposes folding opportunities that are hidden in 2215 /// the original operand list. 2216 /// 2217 /// Return true iff it appears that any interesting folding opportunities 2218 /// may be exposed. This helps getAddRecExpr short-circuit extra work in 2219 /// the common case where no interesting opportunities are present, and 2220 /// is also used as a check to avoid infinite recursion. 2221 static bool 2222 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M, 2223 SmallVectorImpl<const SCEV *> &NewOps, 2224 APInt &AccumulatedConstant, 2225 const SCEV *const *Ops, size_t NumOperands, 2226 const APInt &Scale, 2227 ScalarEvolution &SE) { 2228 bool Interesting = false; 2229 2230 // Iterate over the add operands. They are sorted, with constants first. 2231 unsigned i = 0; 2232 while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) { 2233 ++i; 2234 // Pull a buried constant out to the outside. 2235 if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero()) 2236 Interesting = true; 2237 AccumulatedConstant += Scale * C->getAPInt(); 2238 } 2239 2240 // Next comes everything else. We're especially interested in multiplies 2241 // here, but they're in the middle, so just visit the rest with one loop. 2242 for (; i != NumOperands; ++i) { 2243 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]); 2244 if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) { 2245 APInt NewScale = 2246 Scale * cast<SCEVConstant>(Mul->getOperand(0))->getAPInt(); 2247 if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) { 2248 // A multiplication of a constant with another add; recurse. 2249 const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1)); 2250 Interesting |= 2251 CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant, 2252 Add->op_begin(), Add->getNumOperands(), 2253 NewScale, SE); 2254 } else { 2255 // A multiplication of a constant with some other value. Update 2256 // the map. 2257 SmallVector<const SCEV *, 4> MulOps(drop_begin(Mul->operands())); 2258 const SCEV *Key = SE.getMulExpr(MulOps); 2259 auto Pair = M.insert({Key, NewScale}); 2260 if (Pair.second) { 2261 NewOps.push_back(Pair.first->first); 2262 } else { 2263 Pair.first->second += NewScale; 2264 // The map already had an entry for this value, which may indicate 2265 // a folding opportunity. 2266 Interesting = true; 2267 } 2268 } 2269 } else { 2270 // An ordinary operand. Update the map. 2271 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair = 2272 M.insert({Ops[i], Scale}); 2273 if (Pair.second) { 2274 NewOps.push_back(Pair.first->first); 2275 } else { 2276 Pair.first->second += Scale; 2277 // The map already had an entry for this value, which may indicate 2278 // a folding opportunity. 2279 Interesting = true; 2280 } 2281 } 2282 } 2283 2284 return Interesting; 2285 } 2286 2287 bool ScalarEvolution::willNotOverflow(Instruction::BinaryOps BinOp, bool Signed, 2288 const SCEV *LHS, const SCEV *RHS) { 2289 const SCEV *(ScalarEvolution::*Operation)(const SCEV *, const SCEV *, 2290 SCEV::NoWrapFlags, unsigned); 2291 switch (BinOp) { 2292 default: 2293 llvm_unreachable("Unsupported binary op"); 2294 case Instruction::Add: 2295 Operation = &ScalarEvolution::getAddExpr; 2296 break; 2297 case Instruction::Sub: 2298 Operation = &ScalarEvolution::getMinusSCEV; 2299 break; 2300 case Instruction::Mul: 2301 Operation = &ScalarEvolution::getMulExpr; 2302 break; 2303 } 2304 2305 const SCEV *(ScalarEvolution::*Extension)(const SCEV *, Type *, unsigned) = 2306 Signed ? &ScalarEvolution::getSignExtendExpr 2307 : &ScalarEvolution::getZeroExtendExpr; 2308 2309 // Check ext(LHS op RHS) == ext(LHS) op ext(RHS) 2310 auto *NarrowTy = cast<IntegerType>(LHS->getType()); 2311 auto *WideTy = 2312 IntegerType::get(NarrowTy->getContext(), NarrowTy->getBitWidth() * 2); 2313 2314 const SCEV *A = (this->*Extension)( 2315 (this->*Operation)(LHS, RHS, SCEV::FlagAnyWrap, 0), WideTy, 0); 2316 const SCEV *B = (this->*Operation)((this->*Extension)(LHS, WideTy, 0), 2317 (this->*Extension)(RHS, WideTy, 0), 2318 SCEV::FlagAnyWrap, 0); 2319 return A == B; 2320 } 2321 2322 std::pair<SCEV::NoWrapFlags, bool /*Deduced*/> 2323 ScalarEvolution::getStrengthenedNoWrapFlagsFromBinOp( 2324 const OverflowingBinaryOperator *OBO) { 2325 SCEV::NoWrapFlags Flags = SCEV::NoWrapFlags::FlagAnyWrap; 2326 2327 if (OBO->hasNoUnsignedWrap()) 2328 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2329 if (OBO->hasNoSignedWrap()) 2330 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 2331 2332 bool Deduced = false; 2333 2334 if (OBO->hasNoUnsignedWrap() && OBO->hasNoSignedWrap()) 2335 return {Flags, Deduced}; 2336 2337 if (OBO->getOpcode() != Instruction::Add && 2338 OBO->getOpcode() != Instruction::Sub && 2339 OBO->getOpcode() != Instruction::Mul) 2340 return {Flags, Deduced}; 2341 2342 const SCEV *LHS = getSCEV(OBO->getOperand(0)); 2343 const SCEV *RHS = getSCEV(OBO->getOperand(1)); 2344 2345 if (!OBO->hasNoUnsignedWrap() && 2346 willNotOverflow((Instruction::BinaryOps)OBO->getOpcode(), 2347 /* Signed */ false, LHS, RHS)) { 2348 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2349 Deduced = true; 2350 } 2351 2352 if (!OBO->hasNoSignedWrap() && 2353 willNotOverflow((Instruction::BinaryOps)OBO->getOpcode(), 2354 /* Signed */ true, LHS, RHS)) { 2355 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 2356 Deduced = true; 2357 } 2358 2359 return {Flags, Deduced}; 2360 } 2361 2362 // We're trying to construct a SCEV of type `Type' with `Ops' as operands and 2363 // `OldFlags' as can't-wrap behavior. Infer a more aggressive set of 2364 // can't-overflow flags for the operation if possible. 2365 static SCEV::NoWrapFlags 2366 StrengthenNoWrapFlags(ScalarEvolution *SE, SCEVTypes Type, 2367 const ArrayRef<const SCEV *> Ops, 2368 SCEV::NoWrapFlags Flags) { 2369 using namespace std::placeholders; 2370 2371 using OBO = OverflowingBinaryOperator; 2372 2373 bool CanAnalyze = 2374 Type == scAddExpr || Type == scAddRecExpr || Type == scMulExpr; 2375 (void)CanAnalyze; 2376 assert(CanAnalyze && "don't call from other places!"); 2377 2378 int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW; 2379 SCEV::NoWrapFlags SignOrUnsignWrap = 2380 ScalarEvolution::maskFlags(Flags, SignOrUnsignMask); 2381 2382 // If FlagNSW is true and all the operands are non-negative, infer FlagNUW. 2383 auto IsKnownNonNegative = [&](const SCEV *S) { 2384 return SE->isKnownNonNegative(S); 2385 }; 2386 2387 if (SignOrUnsignWrap == SCEV::FlagNSW && all_of(Ops, IsKnownNonNegative)) 2388 Flags = 2389 ScalarEvolution::setFlags(Flags, (SCEV::NoWrapFlags)SignOrUnsignMask); 2390 2391 SignOrUnsignWrap = ScalarEvolution::maskFlags(Flags, SignOrUnsignMask); 2392 2393 if (SignOrUnsignWrap != SignOrUnsignMask && 2394 (Type == scAddExpr || Type == scMulExpr) && Ops.size() == 2 && 2395 isa<SCEVConstant>(Ops[0])) { 2396 2397 auto Opcode = [&] { 2398 switch (Type) { 2399 case scAddExpr: 2400 return Instruction::Add; 2401 case scMulExpr: 2402 return Instruction::Mul; 2403 default: 2404 llvm_unreachable("Unexpected SCEV op."); 2405 } 2406 }(); 2407 2408 const APInt &C = cast<SCEVConstant>(Ops[0])->getAPInt(); 2409 2410 // (A <opcode> C) --> (A <opcode> C)<nsw> if the op doesn't sign overflow. 2411 if (!(SignOrUnsignWrap & SCEV::FlagNSW)) { 2412 auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 2413 Opcode, C, OBO::NoSignedWrap); 2414 if (NSWRegion.contains(SE->getSignedRange(Ops[1]))) 2415 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 2416 } 2417 2418 // (A <opcode> C) --> (A <opcode> C)<nuw> if the op doesn't unsign overflow. 2419 if (!(SignOrUnsignWrap & SCEV::FlagNUW)) { 2420 auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 2421 Opcode, C, OBO::NoUnsignedWrap); 2422 if (NUWRegion.contains(SE->getUnsignedRange(Ops[1]))) 2423 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2424 } 2425 } 2426 2427 // <0,+,nonnegative><nw> is also nuw 2428 // TODO: Add corresponding nsw case 2429 if (Type == scAddRecExpr && ScalarEvolution::hasFlags(Flags, SCEV::FlagNW) && 2430 !ScalarEvolution::hasFlags(Flags, SCEV::FlagNUW) && Ops.size() == 2 && 2431 Ops[0]->isZero() && IsKnownNonNegative(Ops[1])) 2432 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2433 2434 // both (udiv X, Y) * Y and Y * (udiv X, Y) are always NUW 2435 if (Type == scMulExpr && !ScalarEvolution::hasFlags(Flags, SCEV::FlagNUW) && 2436 Ops.size() == 2) { 2437 if (auto *UDiv = dyn_cast<SCEVUDivExpr>(Ops[0])) 2438 if (UDiv->getOperand(1) == Ops[1]) 2439 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2440 if (auto *UDiv = dyn_cast<SCEVUDivExpr>(Ops[1])) 2441 if (UDiv->getOperand(1) == Ops[0]) 2442 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 2443 } 2444 2445 return Flags; 2446 } 2447 2448 bool ScalarEvolution::isAvailableAtLoopEntry(const SCEV *S, const Loop *L) { 2449 return isLoopInvariant(S, L) && properlyDominates(S, L->getHeader()); 2450 } 2451 2452 /// Get a canonical add expression, or something simpler if possible. 2453 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops, 2454 SCEV::NoWrapFlags OrigFlags, 2455 unsigned Depth) { 2456 assert(!(OrigFlags & ~(SCEV::FlagNUW | SCEV::FlagNSW)) && 2457 "only nuw or nsw allowed"); 2458 assert(!Ops.empty() && "Cannot get empty add!"); 2459 if (Ops.size() == 1) return Ops[0]; 2460 #ifndef NDEBUG 2461 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 2462 for (unsigned i = 1, e = Ops.size(); i != e; ++i) 2463 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 2464 "SCEVAddExpr operand types don't match!"); 2465 unsigned NumPtrs = count_if( 2466 Ops, [](const SCEV *Op) { return Op->getType()->isPointerTy(); }); 2467 assert(NumPtrs <= 1 && "add has at most one pointer operand"); 2468 #endif 2469 2470 // Sort by complexity, this groups all similar expression types together. 2471 GroupByComplexity(Ops, &LI, DT); 2472 2473 // If there are any constants, fold them together. 2474 unsigned Idx = 0; 2475 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 2476 ++Idx; 2477 assert(Idx < Ops.size()); 2478 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 2479 // We found two constants, fold them together! 2480 Ops[0] = getConstant(LHSC->getAPInt() + RHSC->getAPInt()); 2481 if (Ops.size() == 2) return Ops[0]; 2482 Ops.erase(Ops.begin()+1); // Erase the folded element 2483 LHSC = cast<SCEVConstant>(Ops[0]); 2484 } 2485 2486 // If we are left with a constant zero being added, strip it off. 2487 if (LHSC->getValue()->isZero()) { 2488 Ops.erase(Ops.begin()); 2489 --Idx; 2490 } 2491 2492 if (Ops.size() == 1) return Ops[0]; 2493 } 2494 2495 // Delay expensive flag strengthening until necessary. 2496 auto ComputeFlags = [this, OrigFlags](const ArrayRef<const SCEV *> Ops) { 2497 return StrengthenNoWrapFlags(this, scAddExpr, Ops, OrigFlags); 2498 }; 2499 2500 // Limit recursion calls depth. 2501 if (Depth > MaxArithDepth || hasHugeExpression(Ops)) 2502 return getOrCreateAddExpr(Ops, ComputeFlags(Ops)); 2503 2504 if (SCEV *S = findExistingSCEVInCache(scAddExpr, Ops)) { 2505 // Don't strengthen flags if we have no new information. 2506 SCEVAddExpr *Add = static_cast<SCEVAddExpr *>(S); 2507 if (Add->getNoWrapFlags(OrigFlags) != OrigFlags) 2508 Add->setNoWrapFlags(ComputeFlags(Ops)); 2509 return S; 2510 } 2511 2512 // Okay, check to see if the same value occurs in the operand list more than 2513 // once. If so, merge them together into an multiply expression. Since we 2514 // sorted the list, these values are required to be adjacent. 2515 Type *Ty = Ops[0]->getType(); 2516 bool FoundMatch = false; 2517 for (unsigned i = 0, e = Ops.size(); i != e-1; ++i) 2518 if (Ops[i] == Ops[i+1]) { // X + Y + Y --> X + Y*2 2519 // Scan ahead to count how many equal operands there are. 2520 unsigned Count = 2; 2521 while (i+Count != e && Ops[i+Count] == Ops[i]) 2522 ++Count; 2523 // Merge the values into a multiply. 2524 const SCEV *Scale = getConstant(Ty, Count); 2525 const SCEV *Mul = getMulExpr(Scale, Ops[i], SCEV::FlagAnyWrap, Depth + 1); 2526 if (Ops.size() == Count) 2527 return Mul; 2528 Ops[i] = Mul; 2529 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count); 2530 --i; e -= Count - 1; 2531 FoundMatch = true; 2532 } 2533 if (FoundMatch) 2534 return getAddExpr(Ops, OrigFlags, Depth + 1); 2535 2536 // Check for truncates. If all the operands are truncated from the same 2537 // type, see if factoring out the truncate would permit the result to be 2538 // folded. eg., n*trunc(x) + m*trunc(y) --> trunc(trunc(m)*x + trunc(n)*y) 2539 // if the contents of the resulting outer trunc fold to something simple. 2540 auto FindTruncSrcType = [&]() -> Type * { 2541 // We're ultimately looking to fold an addrec of truncs and muls of only 2542 // constants and truncs, so if we find any other types of SCEV 2543 // as operands of the addrec then we bail and return nullptr here. 2544 // Otherwise, we return the type of the operand of a trunc that we find. 2545 if (auto *T = dyn_cast<SCEVTruncateExpr>(Ops[Idx])) 2546 return T->getOperand()->getType(); 2547 if (const auto *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) { 2548 const auto *LastOp = Mul->getOperand(Mul->getNumOperands() - 1); 2549 if (const auto *T = dyn_cast<SCEVTruncateExpr>(LastOp)) 2550 return T->getOperand()->getType(); 2551 } 2552 return nullptr; 2553 }; 2554 if (auto *SrcType = FindTruncSrcType()) { 2555 SmallVector<const SCEV *, 8> LargeOps; 2556 bool Ok = true; 2557 // Check all the operands to see if they can be represented in the 2558 // source type of the truncate. 2559 for (unsigned i = 0, e = Ops.size(); i != e; ++i) { 2560 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) { 2561 if (T->getOperand()->getType() != SrcType) { 2562 Ok = false; 2563 break; 2564 } 2565 LargeOps.push_back(T->getOperand()); 2566 } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) { 2567 LargeOps.push_back(getAnyExtendExpr(C, SrcType)); 2568 } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) { 2569 SmallVector<const SCEV *, 8> LargeMulOps; 2570 for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) { 2571 if (const SCEVTruncateExpr *T = 2572 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) { 2573 if (T->getOperand()->getType() != SrcType) { 2574 Ok = false; 2575 break; 2576 } 2577 LargeMulOps.push_back(T->getOperand()); 2578 } else if (const auto *C = dyn_cast<SCEVConstant>(M->getOperand(j))) { 2579 LargeMulOps.push_back(getAnyExtendExpr(C, SrcType)); 2580 } else { 2581 Ok = false; 2582 break; 2583 } 2584 } 2585 if (Ok) 2586 LargeOps.push_back(getMulExpr(LargeMulOps, SCEV::FlagAnyWrap, Depth + 1)); 2587 } else { 2588 Ok = false; 2589 break; 2590 } 2591 } 2592 if (Ok) { 2593 // Evaluate the expression in the larger type. 2594 const SCEV *Fold = getAddExpr(LargeOps, SCEV::FlagAnyWrap, Depth + 1); 2595 // If it folds to something simple, use it. Otherwise, don't. 2596 if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold)) 2597 return getTruncateExpr(Fold, Ty); 2598 } 2599 } 2600 2601 if (Ops.size() == 2) { 2602 // Check if we have an expression of the form ((X + C1) - C2), where C1 and 2603 // C2 can be folded in a way that allows retaining wrapping flags of (X + 2604 // C1). 2605 const SCEV *A = Ops[0]; 2606 const SCEV *B = Ops[1]; 2607 auto *AddExpr = dyn_cast<SCEVAddExpr>(B); 2608 auto *C = dyn_cast<SCEVConstant>(A); 2609 if (AddExpr && C && isa<SCEVConstant>(AddExpr->getOperand(0))) { 2610 auto C1 = cast<SCEVConstant>(AddExpr->getOperand(0))->getAPInt(); 2611 auto C2 = C->getAPInt(); 2612 SCEV::NoWrapFlags PreservedFlags = SCEV::FlagAnyWrap; 2613 2614 APInt ConstAdd = C1 + C2; 2615 auto AddFlags = AddExpr->getNoWrapFlags(); 2616 // Adding a smaller constant is NUW if the original AddExpr was NUW. 2617 if (ScalarEvolution::hasFlags(AddFlags, SCEV::FlagNUW) && 2618 ConstAdd.ule(C1)) { 2619 PreservedFlags = 2620 ScalarEvolution::setFlags(PreservedFlags, SCEV::FlagNUW); 2621 } 2622 2623 // Adding a constant with the same sign and small magnitude is NSW, if the 2624 // original AddExpr was NSW. 2625 if (ScalarEvolution::hasFlags(AddFlags, SCEV::FlagNSW) && 2626 C1.isSignBitSet() == ConstAdd.isSignBitSet() && 2627 ConstAdd.abs().ule(C1.abs())) { 2628 PreservedFlags = 2629 ScalarEvolution::setFlags(PreservedFlags, SCEV::FlagNSW); 2630 } 2631 2632 if (PreservedFlags != SCEV::FlagAnyWrap) { 2633 SmallVector<const SCEV *, 4> NewOps(AddExpr->operands()); 2634 NewOps[0] = getConstant(ConstAdd); 2635 return getAddExpr(NewOps, PreservedFlags); 2636 } 2637 } 2638 } 2639 2640 // Canonicalize (-1 * urem X, Y) + X --> (Y * X/Y) 2641 if (Ops.size() == 2) { 2642 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[0]); 2643 if (Mul && Mul->getNumOperands() == 2 && 2644 Mul->getOperand(0)->isAllOnesValue()) { 2645 const SCEV *X; 2646 const SCEV *Y; 2647 if (matchURem(Mul->getOperand(1), X, Y) && X == Ops[1]) { 2648 return getMulExpr(Y, getUDivExpr(X, Y)); 2649 } 2650 } 2651 } 2652 2653 // Skip past any other cast SCEVs. 2654 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr) 2655 ++Idx; 2656 2657 // If there are add operands they would be next. 2658 if (Idx < Ops.size()) { 2659 bool DeletedAdd = false; 2660 // If the original flags and all inlined SCEVAddExprs are NUW, use the 2661 // common NUW flag for expression after inlining. Other flags cannot be 2662 // preserved, because they may depend on the original order of operations. 2663 SCEV::NoWrapFlags CommonFlags = maskFlags(OrigFlags, SCEV::FlagNUW); 2664 while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) { 2665 if (Ops.size() > AddOpsInlineThreshold || 2666 Add->getNumOperands() > AddOpsInlineThreshold) 2667 break; 2668 // If we have an add, expand the add operands onto the end of the operands 2669 // list. 2670 Ops.erase(Ops.begin()+Idx); 2671 Ops.append(Add->op_begin(), Add->op_end()); 2672 DeletedAdd = true; 2673 CommonFlags = maskFlags(CommonFlags, Add->getNoWrapFlags()); 2674 } 2675 2676 // If we deleted at least one add, we added operands to the end of the list, 2677 // and they are not necessarily sorted. Recurse to resort and resimplify 2678 // any operands we just acquired. 2679 if (DeletedAdd) 2680 return getAddExpr(Ops, CommonFlags, Depth + 1); 2681 } 2682 2683 // Skip over the add expression until we get to a multiply. 2684 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr) 2685 ++Idx; 2686 2687 // Check to see if there are any folding opportunities present with 2688 // operands multiplied by constant values. 2689 if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) { 2690 uint64_t BitWidth = getTypeSizeInBits(Ty); 2691 DenseMap<const SCEV *, APInt> M; 2692 SmallVector<const SCEV *, 8> NewOps; 2693 APInt AccumulatedConstant(BitWidth, 0); 2694 if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant, 2695 Ops.data(), Ops.size(), 2696 APInt(BitWidth, 1), *this)) { 2697 struct APIntCompare { 2698 bool operator()(const APInt &LHS, const APInt &RHS) const { 2699 return LHS.ult(RHS); 2700 } 2701 }; 2702 2703 // Some interesting folding opportunity is present, so its worthwhile to 2704 // re-generate the operands list. Group the operands by constant scale, 2705 // to avoid multiplying by the same constant scale multiple times. 2706 std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists; 2707 for (const SCEV *NewOp : NewOps) 2708 MulOpLists[M.find(NewOp)->second].push_back(NewOp); 2709 // Re-generate the operands list. 2710 Ops.clear(); 2711 if (AccumulatedConstant != 0) 2712 Ops.push_back(getConstant(AccumulatedConstant)); 2713 for (auto &MulOp : MulOpLists) { 2714 if (MulOp.first == 1) { 2715 Ops.push_back(getAddExpr(MulOp.second, SCEV::FlagAnyWrap, Depth + 1)); 2716 } else if (MulOp.first != 0) { 2717 Ops.push_back(getMulExpr( 2718 getConstant(MulOp.first), 2719 getAddExpr(MulOp.second, SCEV::FlagAnyWrap, Depth + 1), 2720 SCEV::FlagAnyWrap, Depth + 1)); 2721 } 2722 } 2723 if (Ops.empty()) 2724 return getZero(Ty); 2725 if (Ops.size() == 1) 2726 return Ops[0]; 2727 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2728 } 2729 } 2730 2731 // If we are adding something to a multiply expression, make sure the 2732 // something is not already an operand of the multiply. If so, merge it into 2733 // the multiply. 2734 for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) { 2735 const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]); 2736 for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) { 2737 const SCEV *MulOpSCEV = Mul->getOperand(MulOp); 2738 if (isa<SCEVConstant>(MulOpSCEV)) 2739 continue; 2740 for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp) 2741 if (MulOpSCEV == Ops[AddOp]) { 2742 // Fold W + X + (X * Y * Z) --> W + (X * ((Y*Z)+1)) 2743 const SCEV *InnerMul = Mul->getOperand(MulOp == 0); 2744 if (Mul->getNumOperands() != 2) { 2745 // If the multiply has more than two operands, we must get the 2746 // Y*Z term. 2747 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(), 2748 Mul->op_begin()+MulOp); 2749 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end()); 2750 InnerMul = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2751 } 2752 SmallVector<const SCEV *, 2> TwoOps = {getOne(Ty), InnerMul}; 2753 const SCEV *AddOne = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2754 const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV, 2755 SCEV::FlagAnyWrap, Depth + 1); 2756 if (Ops.size() == 2) return OuterMul; 2757 if (AddOp < Idx) { 2758 Ops.erase(Ops.begin()+AddOp); 2759 Ops.erase(Ops.begin()+Idx-1); 2760 } else { 2761 Ops.erase(Ops.begin()+Idx); 2762 Ops.erase(Ops.begin()+AddOp-1); 2763 } 2764 Ops.push_back(OuterMul); 2765 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2766 } 2767 2768 // Check this multiply against other multiplies being added together. 2769 for (unsigned OtherMulIdx = Idx+1; 2770 OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]); 2771 ++OtherMulIdx) { 2772 const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]); 2773 // If MulOp occurs in OtherMul, we can fold the two multiplies 2774 // together. 2775 for (unsigned OMulOp = 0, e = OtherMul->getNumOperands(); 2776 OMulOp != e; ++OMulOp) 2777 if (OtherMul->getOperand(OMulOp) == MulOpSCEV) { 2778 // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E)) 2779 const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0); 2780 if (Mul->getNumOperands() != 2) { 2781 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(), 2782 Mul->op_begin()+MulOp); 2783 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end()); 2784 InnerMul1 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2785 } 2786 const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0); 2787 if (OtherMul->getNumOperands() != 2) { 2788 SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(), 2789 OtherMul->op_begin()+OMulOp); 2790 MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end()); 2791 InnerMul2 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1); 2792 } 2793 SmallVector<const SCEV *, 2> TwoOps = {InnerMul1, InnerMul2}; 2794 const SCEV *InnerMulSum = 2795 getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2796 const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum, 2797 SCEV::FlagAnyWrap, Depth + 1); 2798 if (Ops.size() == 2) return OuterMul; 2799 Ops.erase(Ops.begin()+Idx); 2800 Ops.erase(Ops.begin()+OtherMulIdx-1); 2801 Ops.push_back(OuterMul); 2802 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2803 } 2804 } 2805 } 2806 } 2807 2808 // If there are any add recurrences in the operands list, see if any other 2809 // added values are loop invariant. If so, we can fold them into the 2810 // recurrence. 2811 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr) 2812 ++Idx; 2813 2814 // Scan over all recurrences, trying to fold loop invariants into them. 2815 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) { 2816 // Scan all of the other operands to this add and add them to the vector if 2817 // they are loop invariant w.r.t. the recurrence. 2818 SmallVector<const SCEV *, 8> LIOps; 2819 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]); 2820 const Loop *AddRecLoop = AddRec->getLoop(); 2821 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 2822 if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) { 2823 LIOps.push_back(Ops[i]); 2824 Ops.erase(Ops.begin()+i); 2825 --i; --e; 2826 } 2827 2828 // If we found some loop invariants, fold them into the recurrence. 2829 if (!LIOps.empty()) { 2830 // Compute nowrap flags for the addition of the loop-invariant ops and 2831 // the addrec. Temporarily push it as an operand for that purpose. These 2832 // flags are valid in the scope of the addrec only. 2833 LIOps.push_back(AddRec); 2834 SCEV::NoWrapFlags Flags = ComputeFlags(LIOps); 2835 LIOps.pop_back(); 2836 2837 // NLI + LI + {Start,+,Step} --> NLI + {LI+Start,+,Step} 2838 LIOps.push_back(AddRec->getStart()); 2839 2840 SmallVector<const SCEV *, 4> AddRecOps(AddRec->operands()); 2841 2842 // It is not in general safe to propagate flags valid on an add within 2843 // the addrec scope to one outside it. We must prove that the inner 2844 // scope is guaranteed to execute if the outer one does to be able to 2845 // safely propagate. We know the program is undefined if poison is 2846 // produced on the inner scoped addrec. We also know that *for this use* 2847 // the outer scoped add can't overflow (because of the flags we just 2848 // computed for the inner scoped add) without the program being undefined. 2849 // Proving that entry to the outer scope neccesitates entry to the inner 2850 // scope, thus proves the program undefined if the flags would be violated 2851 // in the outer scope. 2852 SCEV::NoWrapFlags AddFlags = Flags; 2853 if (AddFlags != SCEV::FlagAnyWrap) { 2854 auto *DefI = getDefiningScopeBound(LIOps); 2855 auto *ReachI = &*AddRecLoop->getHeader()->begin(); 2856 if (!isGuaranteedToTransferExecutionTo(DefI, ReachI)) 2857 AddFlags = SCEV::FlagAnyWrap; 2858 } 2859 AddRecOps[0] = getAddExpr(LIOps, AddFlags, Depth + 1); 2860 2861 // Build the new addrec. Propagate the NUW and NSW flags if both the 2862 // outer add and the inner addrec are guaranteed to have no overflow. 2863 // Always propagate NW. 2864 Flags = AddRec->getNoWrapFlags(setFlags(Flags, SCEV::FlagNW)); 2865 const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop, Flags); 2866 2867 // If all of the other operands were loop invariant, we are done. 2868 if (Ops.size() == 1) return NewRec; 2869 2870 // Otherwise, add the folded AddRec by the non-invariant parts. 2871 for (unsigned i = 0;; ++i) 2872 if (Ops[i] == AddRec) { 2873 Ops[i] = NewRec; 2874 break; 2875 } 2876 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2877 } 2878 2879 // Okay, if there weren't any loop invariants to be folded, check to see if 2880 // there are multiple AddRec's with the same loop induction variable being 2881 // added together. If so, we can fold them. 2882 for (unsigned OtherIdx = Idx+1; 2883 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 2884 ++OtherIdx) { 2885 // We expect the AddRecExpr's to be sorted in reverse dominance order, 2886 // so that the 1st found AddRecExpr is dominated by all others. 2887 assert(DT.dominates( 2888 cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()->getHeader(), 2889 AddRec->getLoop()->getHeader()) && 2890 "AddRecExprs are not sorted in reverse dominance order?"); 2891 if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) { 2892 // Other + {A,+,B}<L> + {C,+,D}<L> --> Other + {A+C,+,B+D}<L> 2893 SmallVector<const SCEV *, 4> AddRecOps(AddRec->operands()); 2894 for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 2895 ++OtherIdx) { 2896 const auto *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]); 2897 if (OtherAddRec->getLoop() == AddRecLoop) { 2898 for (unsigned i = 0, e = OtherAddRec->getNumOperands(); 2899 i != e; ++i) { 2900 if (i >= AddRecOps.size()) { 2901 AddRecOps.append(OtherAddRec->op_begin()+i, 2902 OtherAddRec->op_end()); 2903 break; 2904 } 2905 SmallVector<const SCEV *, 2> TwoOps = { 2906 AddRecOps[i], OtherAddRec->getOperand(i)}; 2907 AddRecOps[i] = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1); 2908 } 2909 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx; 2910 } 2911 } 2912 // Step size has changed, so we cannot guarantee no self-wraparound. 2913 Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop, SCEV::FlagAnyWrap); 2914 return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 2915 } 2916 } 2917 2918 // Otherwise couldn't fold anything into this recurrence. Move onto the 2919 // next one. 2920 } 2921 2922 // Okay, it looks like we really DO need an add expr. Check to see if we 2923 // already have one, otherwise create a new one. 2924 return getOrCreateAddExpr(Ops, ComputeFlags(Ops)); 2925 } 2926 2927 const SCEV * 2928 ScalarEvolution::getOrCreateAddExpr(ArrayRef<const SCEV *> Ops, 2929 SCEV::NoWrapFlags Flags) { 2930 FoldingSetNodeID ID; 2931 ID.AddInteger(scAddExpr); 2932 for (const SCEV *Op : Ops) 2933 ID.AddPointer(Op); 2934 void *IP = nullptr; 2935 SCEVAddExpr *S = 2936 static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2937 if (!S) { 2938 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2939 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2940 S = new (SCEVAllocator) 2941 SCEVAddExpr(ID.Intern(SCEVAllocator), O, Ops.size()); 2942 UniqueSCEVs.InsertNode(S, IP); 2943 registerUser(S, Ops); 2944 } 2945 S->setNoWrapFlags(Flags); 2946 return S; 2947 } 2948 2949 const SCEV * 2950 ScalarEvolution::getOrCreateAddRecExpr(ArrayRef<const SCEV *> Ops, 2951 const Loop *L, SCEV::NoWrapFlags Flags) { 2952 FoldingSetNodeID ID; 2953 ID.AddInteger(scAddRecExpr); 2954 for (const SCEV *Op : Ops) 2955 ID.AddPointer(Op); 2956 ID.AddPointer(L); 2957 void *IP = nullptr; 2958 SCEVAddRecExpr *S = 2959 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2960 if (!S) { 2961 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2962 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2963 S = new (SCEVAllocator) 2964 SCEVAddRecExpr(ID.Intern(SCEVAllocator), O, Ops.size(), L); 2965 UniqueSCEVs.InsertNode(S, IP); 2966 LoopUsers[L].push_back(S); 2967 registerUser(S, Ops); 2968 } 2969 setNoWrapFlags(S, Flags); 2970 return S; 2971 } 2972 2973 const SCEV * 2974 ScalarEvolution::getOrCreateMulExpr(ArrayRef<const SCEV *> Ops, 2975 SCEV::NoWrapFlags Flags) { 2976 FoldingSetNodeID ID; 2977 ID.AddInteger(scMulExpr); 2978 for (const SCEV *Op : Ops) 2979 ID.AddPointer(Op); 2980 void *IP = nullptr; 2981 SCEVMulExpr *S = 2982 static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP)); 2983 if (!S) { 2984 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 2985 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 2986 S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator), 2987 O, Ops.size()); 2988 UniqueSCEVs.InsertNode(S, IP); 2989 registerUser(S, Ops); 2990 } 2991 S->setNoWrapFlags(Flags); 2992 return S; 2993 } 2994 2995 static uint64_t umul_ov(uint64_t i, uint64_t j, bool &Overflow) { 2996 uint64_t k = i*j; 2997 if (j > 1 && k / j != i) Overflow = true; 2998 return k; 2999 } 3000 3001 /// Compute the result of "n choose k", the binomial coefficient. If an 3002 /// intermediate computation overflows, Overflow will be set and the return will 3003 /// be garbage. Overflow is not cleared on absence of overflow. 3004 static uint64_t Choose(uint64_t n, uint64_t k, bool &Overflow) { 3005 // We use the multiplicative formula: 3006 // n(n-1)(n-2)...(n-(k-1)) / k(k-1)(k-2)...1 . 3007 // At each iteration, we take the n-th term of the numeral and divide by the 3008 // (k-n)th term of the denominator. This division will always produce an 3009 // integral result, and helps reduce the chance of overflow in the 3010 // intermediate computations. However, we can still overflow even when the 3011 // final result would fit. 3012 3013 if (n == 0 || n == k) return 1; 3014 if (k > n) return 0; 3015 3016 if (k > n/2) 3017 k = n-k; 3018 3019 uint64_t r = 1; 3020 for (uint64_t i = 1; i <= k; ++i) { 3021 r = umul_ov(r, n-(i-1), Overflow); 3022 r /= i; 3023 } 3024 return r; 3025 } 3026 3027 /// Determine if any of the operands in this SCEV are a constant or if 3028 /// any of the add or multiply expressions in this SCEV contain a constant. 3029 static bool containsConstantInAddMulChain(const SCEV *StartExpr) { 3030 struct FindConstantInAddMulChain { 3031 bool FoundConstant = false; 3032 3033 bool follow(const SCEV *S) { 3034 FoundConstant |= isa<SCEVConstant>(S); 3035 return isa<SCEVAddExpr>(S) || isa<SCEVMulExpr>(S); 3036 } 3037 3038 bool isDone() const { 3039 return FoundConstant; 3040 } 3041 }; 3042 3043 FindConstantInAddMulChain F; 3044 SCEVTraversal<FindConstantInAddMulChain> ST(F); 3045 ST.visitAll(StartExpr); 3046 return F.FoundConstant; 3047 } 3048 3049 /// Get a canonical multiply expression, or something simpler if possible. 3050 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops, 3051 SCEV::NoWrapFlags OrigFlags, 3052 unsigned Depth) { 3053 assert(OrigFlags == maskFlags(OrigFlags, SCEV::FlagNUW | SCEV::FlagNSW) && 3054 "only nuw or nsw allowed"); 3055 assert(!Ops.empty() && "Cannot get empty mul!"); 3056 if (Ops.size() == 1) return Ops[0]; 3057 #ifndef NDEBUG 3058 Type *ETy = Ops[0]->getType(); 3059 assert(!ETy->isPointerTy()); 3060 for (unsigned i = 1, e = Ops.size(); i != e; ++i) 3061 assert(Ops[i]->getType() == ETy && 3062 "SCEVMulExpr operand types don't match!"); 3063 #endif 3064 3065 // Sort by complexity, this groups all similar expression types together. 3066 GroupByComplexity(Ops, &LI, DT); 3067 3068 // If there are any constants, fold them together. 3069 unsigned Idx = 0; 3070 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 3071 ++Idx; 3072 assert(Idx < Ops.size()); 3073 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 3074 // We found two constants, fold them together! 3075 Ops[0] = getConstant(LHSC->getAPInt() * RHSC->getAPInt()); 3076 if (Ops.size() == 2) return Ops[0]; 3077 Ops.erase(Ops.begin()+1); // Erase the folded element 3078 LHSC = cast<SCEVConstant>(Ops[0]); 3079 } 3080 3081 // If we have a multiply of zero, it will always be zero. 3082 if (LHSC->getValue()->isZero()) 3083 return LHSC; 3084 3085 // If we are left with a constant one being multiplied, strip it off. 3086 if (LHSC->getValue()->isOne()) { 3087 Ops.erase(Ops.begin()); 3088 --Idx; 3089 } 3090 3091 if (Ops.size() == 1) 3092 return Ops[0]; 3093 } 3094 3095 // Delay expensive flag strengthening until necessary. 3096 auto ComputeFlags = [this, OrigFlags](const ArrayRef<const SCEV *> Ops) { 3097 return StrengthenNoWrapFlags(this, scMulExpr, Ops, OrigFlags); 3098 }; 3099 3100 // Limit recursion calls depth. 3101 if (Depth > MaxArithDepth || hasHugeExpression(Ops)) 3102 return getOrCreateMulExpr(Ops, ComputeFlags(Ops)); 3103 3104 if (SCEV *S = findExistingSCEVInCache(scMulExpr, Ops)) { 3105 // Don't strengthen flags if we have no new information. 3106 SCEVMulExpr *Mul = static_cast<SCEVMulExpr *>(S); 3107 if (Mul->getNoWrapFlags(OrigFlags) != OrigFlags) 3108 Mul->setNoWrapFlags(ComputeFlags(Ops)); 3109 return S; 3110 } 3111 3112 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 3113 if (Ops.size() == 2) { 3114 // C1*(C2+V) -> C1*C2 + C1*V 3115 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) 3116 // If any of Add's ops are Adds or Muls with a constant, apply this 3117 // transformation as well. 3118 // 3119 // TODO: There are some cases where this transformation is not 3120 // profitable; for example, Add = (C0 + X) * Y + Z. Maybe the scope of 3121 // this transformation should be narrowed down. 3122 if (Add->getNumOperands() == 2 && containsConstantInAddMulChain(Add)) 3123 return getAddExpr(getMulExpr(LHSC, Add->getOperand(0), 3124 SCEV::FlagAnyWrap, Depth + 1), 3125 getMulExpr(LHSC, Add->getOperand(1), 3126 SCEV::FlagAnyWrap, Depth + 1), 3127 SCEV::FlagAnyWrap, Depth + 1); 3128 3129 if (Ops[0]->isAllOnesValue()) { 3130 // If we have a mul by -1 of an add, try distributing the -1 among the 3131 // add operands. 3132 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) { 3133 SmallVector<const SCEV *, 4> NewOps; 3134 bool AnyFolded = false; 3135 for (const SCEV *AddOp : Add->operands()) { 3136 const SCEV *Mul = getMulExpr(Ops[0], AddOp, SCEV::FlagAnyWrap, 3137 Depth + 1); 3138 if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true; 3139 NewOps.push_back(Mul); 3140 } 3141 if (AnyFolded) 3142 return getAddExpr(NewOps, SCEV::FlagAnyWrap, Depth + 1); 3143 } else if (const auto *AddRec = dyn_cast<SCEVAddRecExpr>(Ops[1])) { 3144 // Negation preserves a recurrence's no self-wrap property. 3145 SmallVector<const SCEV *, 4> Operands; 3146 for (const SCEV *AddRecOp : AddRec->operands()) 3147 Operands.push_back(getMulExpr(Ops[0], AddRecOp, SCEV::FlagAnyWrap, 3148 Depth + 1)); 3149 3150 return getAddRecExpr(Operands, AddRec->getLoop(), 3151 AddRec->getNoWrapFlags(SCEV::FlagNW)); 3152 } 3153 } 3154 } 3155 } 3156 3157 // Skip over the add expression until we get to a multiply. 3158 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr) 3159 ++Idx; 3160 3161 // If there are mul operands inline them all into this expression. 3162 if (Idx < Ops.size()) { 3163 bool DeletedMul = false; 3164 while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) { 3165 if (Ops.size() > MulOpsInlineThreshold) 3166 break; 3167 // If we have an mul, expand the mul operands onto the end of the 3168 // operands list. 3169 Ops.erase(Ops.begin()+Idx); 3170 Ops.append(Mul->op_begin(), Mul->op_end()); 3171 DeletedMul = true; 3172 } 3173 3174 // If we deleted at least one mul, we added operands to the end of the 3175 // list, and they are not necessarily sorted. Recurse to resort and 3176 // resimplify any operands we just acquired. 3177 if (DeletedMul) 3178 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3179 } 3180 3181 // If there are any add recurrences in the operands list, see if any other 3182 // added values are loop invariant. If so, we can fold them into the 3183 // recurrence. 3184 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr) 3185 ++Idx; 3186 3187 // Scan over all recurrences, trying to fold loop invariants into them. 3188 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) { 3189 // Scan all of the other operands to this mul and add them to the vector 3190 // if they are loop invariant w.r.t. the recurrence. 3191 SmallVector<const SCEV *, 8> LIOps; 3192 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]); 3193 const Loop *AddRecLoop = AddRec->getLoop(); 3194 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 3195 if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) { 3196 LIOps.push_back(Ops[i]); 3197 Ops.erase(Ops.begin()+i); 3198 --i; --e; 3199 } 3200 3201 // If we found some loop invariants, fold them into the recurrence. 3202 if (!LIOps.empty()) { 3203 // NLI * LI * {Start,+,Step} --> NLI * {LI*Start,+,LI*Step} 3204 SmallVector<const SCEV *, 4> NewOps; 3205 NewOps.reserve(AddRec->getNumOperands()); 3206 const SCEV *Scale = getMulExpr(LIOps, SCEV::FlagAnyWrap, Depth + 1); 3207 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) 3208 NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i), 3209 SCEV::FlagAnyWrap, Depth + 1)); 3210 3211 // Build the new addrec. Propagate the NUW and NSW flags if both the 3212 // outer mul and the inner addrec are guaranteed to have no overflow. 3213 // 3214 // No self-wrap cannot be guaranteed after changing the step size, but 3215 // will be inferred if either NUW or NSW is true. 3216 SCEV::NoWrapFlags Flags = ComputeFlags({Scale, AddRec}); 3217 const SCEV *NewRec = getAddRecExpr( 3218 NewOps, AddRecLoop, AddRec->getNoWrapFlags(Flags)); 3219 3220 // If all of the other operands were loop invariant, we are done. 3221 if (Ops.size() == 1) return NewRec; 3222 3223 // Otherwise, multiply the folded AddRec by the non-invariant parts. 3224 for (unsigned i = 0;; ++i) 3225 if (Ops[i] == AddRec) { 3226 Ops[i] = NewRec; 3227 break; 3228 } 3229 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3230 } 3231 3232 // Okay, if there weren't any loop invariants to be folded, check to see 3233 // if there are multiple AddRec's with the same loop induction variable 3234 // being multiplied together. If so, we can fold them. 3235 3236 // {A1,+,A2,+,...,+,An}<L> * {B1,+,B2,+,...,+,Bn}<L> 3237 // = {x=1 in [ sum y=x..2x [ sum z=max(y-x, y-n)..min(x,n) [ 3238 // choose(x, 2x)*choose(2x-y, x-z)*A_{y-z}*B_z 3239 // ]]],+,...up to x=2n}. 3240 // Note that the arguments to choose() are always integers with values 3241 // known at compile time, never SCEV objects. 3242 // 3243 // The implementation avoids pointless extra computations when the two 3244 // addrec's are of different length (mathematically, it's equivalent to 3245 // an infinite stream of zeros on the right). 3246 bool OpsModified = false; 3247 for (unsigned OtherIdx = Idx+1; 3248 OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]); 3249 ++OtherIdx) { 3250 const SCEVAddRecExpr *OtherAddRec = 3251 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]); 3252 if (!OtherAddRec || OtherAddRec->getLoop() != AddRecLoop) 3253 continue; 3254 3255 // Limit max number of arguments to avoid creation of unreasonably big 3256 // SCEVAddRecs with very complex operands. 3257 if (AddRec->getNumOperands() + OtherAddRec->getNumOperands() - 1 > 3258 MaxAddRecSize || hasHugeExpression({AddRec, OtherAddRec})) 3259 continue; 3260 3261 bool Overflow = false; 3262 Type *Ty = AddRec->getType(); 3263 bool LargerThan64Bits = getTypeSizeInBits(Ty) > 64; 3264 SmallVector<const SCEV*, 7> AddRecOps; 3265 for (int x = 0, xe = AddRec->getNumOperands() + 3266 OtherAddRec->getNumOperands() - 1; x != xe && !Overflow; ++x) { 3267 SmallVector <const SCEV *, 7> SumOps; 3268 for (int y = x, ye = 2*x+1; y != ye && !Overflow; ++y) { 3269 uint64_t Coeff1 = Choose(x, 2*x - y, Overflow); 3270 for (int z = std::max(y-x, y-(int)AddRec->getNumOperands()+1), 3271 ze = std::min(x+1, (int)OtherAddRec->getNumOperands()); 3272 z < ze && !Overflow; ++z) { 3273 uint64_t Coeff2 = Choose(2*x - y, x-z, Overflow); 3274 uint64_t Coeff; 3275 if (LargerThan64Bits) 3276 Coeff = umul_ov(Coeff1, Coeff2, Overflow); 3277 else 3278 Coeff = Coeff1*Coeff2; 3279 const SCEV *CoeffTerm = getConstant(Ty, Coeff); 3280 const SCEV *Term1 = AddRec->getOperand(y-z); 3281 const SCEV *Term2 = OtherAddRec->getOperand(z); 3282 SumOps.push_back(getMulExpr(CoeffTerm, Term1, Term2, 3283 SCEV::FlagAnyWrap, Depth + 1)); 3284 } 3285 } 3286 if (SumOps.empty()) 3287 SumOps.push_back(getZero(Ty)); 3288 AddRecOps.push_back(getAddExpr(SumOps, SCEV::FlagAnyWrap, Depth + 1)); 3289 } 3290 if (!Overflow) { 3291 const SCEV *NewAddRec = getAddRecExpr(AddRecOps, AddRecLoop, 3292 SCEV::FlagAnyWrap); 3293 if (Ops.size() == 2) return NewAddRec; 3294 Ops[Idx] = NewAddRec; 3295 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx; 3296 OpsModified = true; 3297 AddRec = dyn_cast<SCEVAddRecExpr>(NewAddRec); 3298 if (!AddRec) 3299 break; 3300 } 3301 } 3302 if (OpsModified) 3303 return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1); 3304 3305 // Otherwise couldn't fold anything into this recurrence. Move onto the 3306 // next one. 3307 } 3308 3309 // Okay, it looks like we really DO need an mul expr. Check to see if we 3310 // already have one, otherwise create a new one. 3311 return getOrCreateMulExpr(Ops, ComputeFlags(Ops)); 3312 } 3313 3314 /// Represents an unsigned remainder expression based on unsigned division. 3315 const SCEV *ScalarEvolution::getURemExpr(const SCEV *LHS, 3316 const SCEV *RHS) { 3317 assert(getEffectiveSCEVType(LHS->getType()) == 3318 getEffectiveSCEVType(RHS->getType()) && 3319 "SCEVURemExpr operand types don't match!"); 3320 3321 // Short-circuit easy cases 3322 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 3323 // If constant is one, the result is trivial 3324 if (RHSC->getValue()->isOne()) 3325 return getZero(LHS->getType()); // X urem 1 --> 0 3326 3327 // If constant is a power of two, fold into a zext(trunc(LHS)). 3328 if (RHSC->getAPInt().isPowerOf2()) { 3329 Type *FullTy = LHS->getType(); 3330 Type *TruncTy = 3331 IntegerType::get(getContext(), RHSC->getAPInt().logBase2()); 3332 return getZeroExtendExpr(getTruncateExpr(LHS, TruncTy), FullTy); 3333 } 3334 } 3335 3336 // Fallback to %a == %x urem %y == %x -<nuw> ((%x udiv %y) *<nuw> %y) 3337 const SCEV *UDiv = getUDivExpr(LHS, RHS); 3338 const SCEV *Mult = getMulExpr(UDiv, RHS, SCEV::FlagNUW); 3339 return getMinusSCEV(LHS, Mult, SCEV::FlagNUW); 3340 } 3341 3342 /// Get a canonical unsigned division expression, or something simpler if 3343 /// possible. 3344 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS, 3345 const SCEV *RHS) { 3346 assert(!LHS->getType()->isPointerTy() && 3347 "SCEVUDivExpr operand can't be pointer!"); 3348 assert(LHS->getType() == RHS->getType() && 3349 "SCEVUDivExpr operand types don't match!"); 3350 3351 FoldingSetNodeID ID; 3352 ID.AddInteger(scUDivExpr); 3353 ID.AddPointer(LHS); 3354 ID.AddPointer(RHS); 3355 void *IP = nullptr; 3356 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 3357 return S; 3358 3359 // 0 udiv Y == 0 3360 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) 3361 if (LHSC->getValue()->isZero()) 3362 return LHS; 3363 3364 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 3365 if (RHSC->getValue()->isOne()) 3366 return LHS; // X udiv 1 --> x 3367 // If the denominator is zero, the result of the udiv is undefined. Don't 3368 // try to analyze it, because the resolution chosen here may differ from 3369 // the resolution chosen in other parts of the compiler. 3370 if (!RHSC->getValue()->isZero()) { 3371 // Determine if the division can be folded into the operands of 3372 // its operands. 3373 // TODO: Generalize this to non-constants by using known-bits information. 3374 Type *Ty = LHS->getType(); 3375 unsigned LZ = RHSC->getAPInt().countLeadingZeros(); 3376 unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1; 3377 // For non-power-of-two values, effectively round the value up to the 3378 // nearest power of two. 3379 if (!RHSC->getAPInt().isPowerOf2()) 3380 ++MaxShiftAmt; 3381 IntegerType *ExtTy = 3382 IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt); 3383 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS)) 3384 if (const SCEVConstant *Step = 3385 dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this))) { 3386 // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded. 3387 const APInt &StepInt = Step->getAPInt(); 3388 const APInt &DivInt = RHSC->getAPInt(); 3389 if (!StepInt.urem(DivInt) && 3390 getZeroExtendExpr(AR, ExtTy) == 3391 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy), 3392 getZeroExtendExpr(Step, ExtTy), 3393 AR->getLoop(), SCEV::FlagAnyWrap)) { 3394 SmallVector<const SCEV *, 4> Operands; 3395 for (const SCEV *Op : AR->operands()) 3396 Operands.push_back(getUDivExpr(Op, RHS)); 3397 return getAddRecExpr(Operands, AR->getLoop(), SCEV::FlagNW); 3398 } 3399 /// Get a canonical UDivExpr for a recurrence. 3400 /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0. 3401 // We can currently only fold X%N if X is constant. 3402 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart()); 3403 if (StartC && !DivInt.urem(StepInt) && 3404 getZeroExtendExpr(AR, ExtTy) == 3405 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy), 3406 getZeroExtendExpr(Step, ExtTy), 3407 AR->getLoop(), SCEV::FlagAnyWrap)) { 3408 const APInt &StartInt = StartC->getAPInt(); 3409 const APInt &StartRem = StartInt.urem(StepInt); 3410 if (StartRem != 0) { 3411 const SCEV *NewLHS = 3412 getAddRecExpr(getConstant(StartInt - StartRem), Step, 3413 AR->getLoop(), SCEV::FlagNW); 3414 if (LHS != NewLHS) { 3415 LHS = NewLHS; 3416 3417 // Reset the ID to include the new LHS, and check if it is 3418 // already cached. 3419 ID.clear(); 3420 ID.AddInteger(scUDivExpr); 3421 ID.AddPointer(LHS); 3422 ID.AddPointer(RHS); 3423 IP = nullptr; 3424 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) 3425 return S; 3426 } 3427 } 3428 } 3429 } 3430 // (A*B)/C --> A*(B/C) if safe and B/C can be folded. 3431 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) { 3432 SmallVector<const SCEV *, 4> Operands; 3433 for (const SCEV *Op : M->operands()) 3434 Operands.push_back(getZeroExtendExpr(Op, ExtTy)); 3435 if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands)) 3436 // Find an operand that's safely divisible. 3437 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) { 3438 const SCEV *Op = M->getOperand(i); 3439 const SCEV *Div = getUDivExpr(Op, RHSC); 3440 if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) { 3441 Operands = SmallVector<const SCEV *, 4>(M->operands()); 3442 Operands[i] = Div; 3443 return getMulExpr(Operands); 3444 } 3445 } 3446 } 3447 3448 // (A/B)/C --> A/(B*C) if safe and B*C can be folded. 3449 if (const SCEVUDivExpr *OtherDiv = dyn_cast<SCEVUDivExpr>(LHS)) { 3450 if (auto *DivisorConstant = 3451 dyn_cast<SCEVConstant>(OtherDiv->getRHS())) { 3452 bool Overflow = false; 3453 APInt NewRHS = 3454 DivisorConstant->getAPInt().umul_ov(RHSC->getAPInt(), Overflow); 3455 if (Overflow) { 3456 return getConstant(RHSC->getType(), 0, false); 3457 } 3458 return getUDivExpr(OtherDiv->getLHS(), getConstant(NewRHS)); 3459 } 3460 } 3461 3462 // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded. 3463 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) { 3464 SmallVector<const SCEV *, 4> Operands; 3465 for (const SCEV *Op : A->operands()) 3466 Operands.push_back(getZeroExtendExpr(Op, ExtTy)); 3467 if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) { 3468 Operands.clear(); 3469 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) { 3470 const SCEV *Op = getUDivExpr(A->getOperand(i), RHS); 3471 if (isa<SCEVUDivExpr>(Op) || 3472 getMulExpr(Op, RHS) != A->getOperand(i)) 3473 break; 3474 Operands.push_back(Op); 3475 } 3476 if (Operands.size() == A->getNumOperands()) 3477 return getAddExpr(Operands); 3478 } 3479 } 3480 3481 // Fold if both operands are constant. 3482 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) { 3483 Constant *LHSCV = LHSC->getValue(); 3484 Constant *RHSCV = RHSC->getValue(); 3485 return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV, 3486 RHSCV))); 3487 } 3488 } 3489 } 3490 3491 // The Insertion Point (IP) might be invalid by now (due to UniqueSCEVs 3492 // changes). Make sure we get a new one. 3493 IP = nullptr; 3494 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S; 3495 SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator), 3496 LHS, RHS); 3497 UniqueSCEVs.InsertNode(S, IP); 3498 registerUser(S, {LHS, RHS}); 3499 return S; 3500 } 3501 3502 APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) { 3503 APInt A = C1->getAPInt().abs(); 3504 APInt B = C2->getAPInt().abs(); 3505 uint32_t ABW = A.getBitWidth(); 3506 uint32_t BBW = B.getBitWidth(); 3507 3508 if (ABW > BBW) 3509 B = B.zext(ABW); 3510 else if (ABW < BBW) 3511 A = A.zext(BBW); 3512 3513 return APIntOps::GreatestCommonDivisor(std::move(A), std::move(B)); 3514 } 3515 3516 /// Get a canonical unsigned division expression, or something simpler if 3517 /// possible. There is no representation for an exact udiv in SCEV IR, but we 3518 /// can attempt to remove factors from the LHS and RHS. We can't do this when 3519 /// it's not exact because the udiv may be clearing bits. 3520 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS, 3521 const SCEV *RHS) { 3522 // TODO: we could try to find factors in all sorts of things, but for now we 3523 // just deal with u/exact (multiply, constant). See SCEVDivision towards the 3524 // end of this file for inspiration. 3525 3526 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS); 3527 if (!Mul || !Mul->hasNoUnsignedWrap()) 3528 return getUDivExpr(LHS, RHS); 3529 3530 if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) { 3531 // If the mulexpr multiplies by a constant, then that constant must be the 3532 // first element of the mulexpr. 3533 if (const auto *LHSCst = dyn_cast<SCEVConstant>(Mul->getOperand(0))) { 3534 if (LHSCst == RHSCst) { 3535 SmallVector<const SCEV *, 2> Operands(drop_begin(Mul->operands())); 3536 return getMulExpr(Operands); 3537 } 3538 3539 // We can't just assume that LHSCst divides RHSCst cleanly, it could be 3540 // that there's a factor provided by one of the other terms. We need to 3541 // check. 3542 APInt Factor = gcd(LHSCst, RHSCst); 3543 if (!Factor.isIntN(1)) { 3544 LHSCst = 3545 cast<SCEVConstant>(getConstant(LHSCst->getAPInt().udiv(Factor))); 3546 RHSCst = 3547 cast<SCEVConstant>(getConstant(RHSCst->getAPInt().udiv(Factor))); 3548 SmallVector<const SCEV *, 2> Operands; 3549 Operands.push_back(LHSCst); 3550 Operands.append(Mul->op_begin() + 1, Mul->op_end()); 3551 LHS = getMulExpr(Operands); 3552 RHS = RHSCst; 3553 Mul = dyn_cast<SCEVMulExpr>(LHS); 3554 if (!Mul) 3555 return getUDivExactExpr(LHS, RHS); 3556 } 3557 } 3558 } 3559 3560 for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) { 3561 if (Mul->getOperand(i) == RHS) { 3562 SmallVector<const SCEV *, 2> Operands; 3563 Operands.append(Mul->op_begin(), Mul->op_begin() + i); 3564 Operands.append(Mul->op_begin() + i + 1, Mul->op_end()); 3565 return getMulExpr(Operands); 3566 } 3567 } 3568 3569 return getUDivExpr(LHS, RHS); 3570 } 3571 3572 /// Get an add recurrence expression for the specified loop. Simplify the 3573 /// expression as much as possible. 3574 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step, 3575 const Loop *L, 3576 SCEV::NoWrapFlags Flags) { 3577 SmallVector<const SCEV *, 4> Operands; 3578 Operands.push_back(Start); 3579 if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step)) 3580 if (StepChrec->getLoop() == L) { 3581 Operands.append(StepChrec->op_begin(), StepChrec->op_end()); 3582 return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW)); 3583 } 3584 3585 Operands.push_back(Step); 3586 return getAddRecExpr(Operands, L, Flags); 3587 } 3588 3589 /// Get an add recurrence expression for the specified loop. Simplify the 3590 /// expression as much as possible. 3591 const SCEV * 3592 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands, 3593 const Loop *L, SCEV::NoWrapFlags Flags) { 3594 if (Operands.size() == 1) return Operands[0]; 3595 #ifndef NDEBUG 3596 Type *ETy = getEffectiveSCEVType(Operands[0]->getType()); 3597 for (unsigned i = 1, e = Operands.size(); i != e; ++i) { 3598 assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy && 3599 "SCEVAddRecExpr operand types don't match!"); 3600 assert(!Operands[i]->getType()->isPointerTy() && "Step must be integer"); 3601 } 3602 for (unsigned i = 0, e = Operands.size(); i != e; ++i) 3603 assert(isLoopInvariant(Operands[i], L) && 3604 "SCEVAddRecExpr operand is not loop-invariant!"); 3605 #endif 3606 3607 if (Operands.back()->isZero()) { 3608 Operands.pop_back(); 3609 return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0} --> X 3610 } 3611 3612 // It's tempting to want to call getConstantMaxBackedgeTakenCount count here and 3613 // use that information to infer NUW and NSW flags. However, computing a 3614 // BE count requires calling getAddRecExpr, so we may not yet have a 3615 // meaningful BE count at this point (and if we don't, we'd be stuck 3616 // with a SCEVCouldNotCompute as the cached BE count). 3617 3618 Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags); 3619 3620 // Canonicalize nested AddRecs in by nesting them in order of loop depth. 3621 if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) { 3622 const Loop *NestedLoop = NestedAR->getLoop(); 3623 if (L->contains(NestedLoop) 3624 ? (L->getLoopDepth() < NestedLoop->getLoopDepth()) 3625 : (!NestedLoop->contains(L) && 3626 DT.dominates(L->getHeader(), NestedLoop->getHeader()))) { 3627 SmallVector<const SCEV *, 4> NestedOperands(NestedAR->operands()); 3628 Operands[0] = NestedAR->getStart(); 3629 // AddRecs require their operands be loop-invariant with respect to their 3630 // loops. Don't perform this transformation if it would break this 3631 // requirement. 3632 bool AllInvariant = all_of( 3633 Operands, [&](const SCEV *Op) { return isLoopInvariant(Op, L); }); 3634 3635 if (AllInvariant) { 3636 // Create a recurrence for the outer loop with the same step size. 3637 // 3638 // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the 3639 // inner recurrence has the same property. 3640 SCEV::NoWrapFlags OuterFlags = 3641 maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags()); 3642 3643 NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags); 3644 AllInvariant = all_of(NestedOperands, [&](const SCEV *Op) { 3645 return isLoopInvariant(Op, NestedLoop); 3646 }); 3647 3648 if (AllInvariant) { 3649 // Ok, both add recurrences are valid after the transformation. 3650 // 3651 // The inner recurrence keeps its NW flag but only keeps NUW/NSW if 3652 // the outer recurrence has the same property. 3653 SCEV::NoWrapFlags InnerFlags = 3654 maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags); 3655 return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags); 3656 } 3657 } 3658 // Reset Operands to its original state. 3659 Operands[0] = NestedAR; 3660 } 3661 } 3662 3663 // Okay, it looks like we really DO need an addrec expr. Check to see if we 3664 // already have one, otherwise create a new one. 3665 return getOrCreateAddRecExpr(Operands, L, Flags); 3666 } 3667 3668 const SCEV * 3669 ScalarEvolution::getGEPExpr(GEPOperator *GEP, 3670 const SmallVectorImpl<const SCEV *> &IndexExprs) { 3671 const SCEV *BaseExpr = getSCEV(GEP->getPointerOperand()); 3672 // getSCEV(Base)->getType() has the same address space as Base->getType() 3673 // because SCEV::getType() preserves the address space. 3674 Type *IntIdxTy = getEffectiveSCEVType(BaseExpr->getType()); 3675 const bool AssumeInBoundsFlags = [&]() { 3676 if (!GEP->isInBounds()) 3677 return false; 3678 3679 // We'd like to propagate flags from the IR to the corresponding SCEV nodes, 3680 // but to do that, we have to ensure that said flag is valid in the entire 3681 // defined scope of the SCEV. 3682 auto *GEPI = dyn_cast<Instruction>(GEP); 3683 // TODO: non-instructions have global scope. We might be able to prove 3684 // some global scope cases 3685 return GEPI && isSCEVExprNeverPoison(GEPI); 3686 }(); 3687 3688 SCEV::NoWrapFlags OffsetWrap = 3689 AssumeInBoundsFlags ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 3690 3691 Type *CurTy = GEP->getType(); 3692 bool FirstIter = true; 3693 SmallVector<const SCEV *, 4> Offsets; 3694 for (const SCEV *IndexExpr : IndexExprs) { 3695 // Compute the (potentially symbolic) offset in bytes for this index. 3696 if (StructType *STy = dyn_cast<StructType>(CurTy)) { 3697 // For a struct, add the member offset. 3698 ConstantInt *Index = cast<SCEVConstant>(IndexExpr)->getValue(); 3699 unsigned FieldNo = Index->getZExtValue(); 3700 const SCEV *FieldOffset = getOffsetOfExpr(IntIdxTy, STy, FieldNo); 3701 Offsets.push_back(FieldOffset); 3702 3703 // Update CurTy to the type of the field at Index. 3704 CurTy = STy->getTypeAtIndex(Index); 3705 } else { 3706 // Update CurTy to its element type. 3707 if (FirstIter) { 3708 assert(isa<PointerType>(CurTy) && 3709 "The first index of a GEP indexes a pointer"); 3710 CurTy = GEP->getSourceElementType(); 3711 FirstIter = false; 3712 } else { 3713 CurTy = GetElementPtrInst::getTypeAtIndex(CurTy, (uint64_t)0); 3714 } 3715 // For an array, add the element offset, explicitly scaled. 3716 const SCEV *ElementSize = getSizeOfExpr(IntIdxTy, CurTy); 3717 // Getelementptr indices are signed. 3718 IndexExpr = getTruncateOrSignExtend(IndexExpr, IntIdxTy); 3719 3720 // Multiply the index by the element size to compute the element offset. 3721 const SCEV *LocalOffset = getMulExpr(IndexExpr, ElementSize, OffsetWrap); 3722 Offsets.push_back(LocalOffset); 3723 } 3724 } 3725 3726 // Handle degenerate case of GEP without offsets. 3727 if (Offsets.empty()) 3728 return BaseExpr; 3729 3730 // Add the offsets together, assuming nsw if inbounds. 3731 const SCEV *Offset = getAddExpr(Offsets, OffsetWrap); 3732 // Add the base address and the offset. We cannot use the nsw flag, as the 3733 // base address is unsigned. However, if we know that the offset is 3734 // non-negative, we can use nuw. 3735 SCEV::NoWrapFlags BaseWrap = AssumeInBoundsFlags && isKnownNonNegative(Offset) 3736 ? SCEV::FlagNUW : SCEV::FlagAnyWrap; 3737 auto *GEPExpr = getAddExpr(BaseExpr, Offset, BaseWrap); 3738 assert(BaseExpr->getType() == GEPExpr->getType() && 3739 "GEP should not change type mid-flight."); 3740 return GEPExpr; 3741 } 3742 3743 SCEV *ScalarEvolution::findExistingSCEVInCache(SCEVTypes SCEVType, 3744 ArrayRef<const SCEV *> Ops) { 3745 FoldingSetNodeID ID; 3746 ID.AddInteger(SCEVType); 3747 for (const SCEV *Op : Ops) 3748 ID.AddPointer(Op); 3749 void *IP = nullptr; 3750 return UniqueSCEVs.FindNodeOrInsertPos(ID, IP); 3751 } 3752 3753 const SCEV *ScalarEvolution::getAbsExpr(const SCEV *Op, bool IsNSW) { 3754 SCEV::NoWrapFlags Flags = IsNSW ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 3755 return getSMaxExpr(Op, getNegativeSCEV(Op, Flags)); 3756 } 3757 3758 const SCEV *ScalarEvolution::getMinMaxExpr(SCEVTypes Kind, 3759 SmallVectorImpl<const SCEV *> &Ops) { 3760 assert(SCEVMinMaxExpr::isMinMaxType(Kind) && "Not a SCEVMinMaxExpr!"); 3761 assert(!Ops.empty() && "Cannot get empty (u|s)(min|max)!"); 3762 if (Ops.size() == 1) return Ops[0]; 3763 #ifndef NDEBUG 3764 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 3765 for (unsigned i = 1, e = Ops.size(); i != e; ++i) { 3766 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 3767 "Operand types don't match!"); 3768 assert(Ops[0]->getType()->isPointerTy() == 3769 Ops[i]->getType()->isPointerTy() && 3770 "min/max should be consistently pointerish"); 3771 } 3772 #endif 3773 3774 bool IsSigned = Kind == scSMaxExpr || Kind == scSMinExpr; 3775 bool IsMax = Kind == scSMaxExpr || Kind == scUMaxExpr; 3776 3777 // Sort by complexity, this groups all similar expression types together. 3778 GroupByComplexity(Ops, &LI, DT); 3779 3780 // Check if we have created the same expression before. 3781 if (const SCEV *S = findExistingSCEVInCache(Kind, Ops)) { 3782 return S; 3783 } 3784 3785 // If there are any constants, fold them together. 3786 unsigned Idx = 0; 3787 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) { 3788 ++Idx; 3789 assert(Idx < Ops.size()); 3790 auto FoldOp = [&](const APInt &LHS, const APInt &RHS) { 3791 if (Kind == scSMaxExpr) 3792 return APIntOps::smax(LHS, RHS); 3793 else if (Kind == scSMinExpr) 3794 return APIntOps::smin(LHS, RHS); 3795 else if (Kind == scUMaxExpr) 3796 return APIntOps::umax(LHS, RHS); 3797 else if (Kind == scUMinExpr) 3798 return APIntOps::umin(LHS, RHS); 3799 llvm_unreachable("Unknown SCEV min/max opcode"); 3800 }; 3801 3802 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) { 3803 // We found two constants, fold them together! 3804 ConstantInt *Fold = ConstantInt::get( 3805 getContext(), FoldOp(LHSC->getAPInt(), RHSC->getAPInt())); 3806 Ops[0] = getConstant(Fold); 3807 Ops.erase(Ops.begin()+1); // Erase the folded element 3808 if (Ops.size() == 1) return Ops[0]; 3809 LHSC = cast<SCEVConstant>(Ops[0]); 3810 } 3811 3812 bool IsMinV = LHSC->getValue()->isMinValue(IsSigned); 3813 bool IsMaxV = LHSC->getValue()->isMaxValue(IsSigned); 3814 3815 if (IsMax ? IsMinV : IsMaxV) { 3816 // If we are left with a constant minimum(/maximum)-int, strip it off. 3817 Ops.erase(Ops.begin()); 3818 --Idx; 3819 } else if (IsMax ? IsMaxV : IsMinV) { 3820 // If we have a max(/min) with a constant maximum(/minimum)-int, 3821 // it will always be the extremum. 3822 return LHSC; 3823 } 3824 3825 if (Ops.size() == 1) return Ops[0]; 3826 } 3827 3828 // Find the first operation of the same kind 3829 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < Kind) 3830 ++Idx; 3831 3832 // Check to see if one of the operands is of the same kind. If so, expand its 3833 // operands onto our operand list, and recurse to simplify. 3834 if (Idx < Ops.size()) { 3835 bool DeletedAny = false; 3836 while (Ops[Idx]->getSCEVType() == Kind) { 3837 const SCEVMinMaxExpr *SMME = cast<SCEVMinMaxExpr>(Ops[Idx]); 3838 Ops.erase(Ops.begin()+Idx); 3839 Ops.append(SMME->op_begin(), SMME->op_end()); 3840 DeletedAny = true; 3841 } 3842 3843 if (DeletedAny) 3844 return getMinMaxExpr(Kind, Ops); 3845 } 3846 3847 // Okay, check to see if the same value occurs in the operand list twice. If 3848 // so, delete one. Since we sorted the list, these values are required to 3849 // be adjacent. 3850 llvm::CmpInst::Predicate GEPred = 3851 IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 3852 llvm::CmpInst::Predicate LEPred = 3853 IsSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 3854 llvm::CmpInst::Predicate FirstPred = IsMax ? GEPred : LEPred; 3855 llvm::CmpInst::Predicate SecondPred = IsMax ? LEPred : GEPred; 3856 for (unsigned i = 0, e = Ops.size() - 1; i != e; ++i) { 3857 if (Ops[i] == Ops[i + 1] || 3858 isKnownViaNonRecursiveReasoning(FirstPred, Ops[i], Ops[i + 1])) { 3859 // X op Y op Y --> X op Y 3860 // X op Y --> X, if we know X, Y are ordered appropriately 3861 Ops.erase(Ops.begin() + i + 1, Ops.begin() + i + 2); 3862 --i; 3863 --e; 3864 } else if (isKnownViaNonRecursiveReasoning(SecondPred, Ops[i], 3865 Ops[i + 1])) { 3866 // X op Y --> Y, if we know X, Y are ordered appropriately 3867 Ops.erase(Ops.begin() + i, Ops.begin() + i + 1); 3868 --i; 3869 --e; 3870 } 3871 } 3872 3873 if (Ops.size() == 1) return Ops[0]; 3874 3875 assert(!Ops.empty() && "Reduced smax down to nothing!"); 3876 3877 // Okay, it looks like we really DO need an expr. Check to see if we 3878 // already have one, otherwise create a new one. 3879 FoldingSetNodeID ID; 3880 ID.AddInteger(Kind); 3881 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 3882 ID.AddPointer(Ops[i]); 3883 void *IP = nullptr; 3884 const SCEV *ExistingSCEV = UniqueSCEVs.FindNodeOrInsertPos(ID, IP); 3885 if (ExistingSCEV) 3886 return ExistingSCEV; 3887 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 3888 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 3889 SCEV *S = new (SCEVAllocator) 3890 SCEVMinMaxExpr(ID.Intern(SCEVAllocator), Kind, O, Ops.size()); 3891 3892 UniqueSCEVs.InsertNode(S, IP); 3893 registerUser(S, Ops); 3894 return S; 3895 } 3896 3897 namespace { 3898 3899 class SCEVSequentialMinMaxDeduplicatingVisitor final 3900 : public SCEVVisitor<SCEVSequentialMinMaxDeduplicatingVisitor, 3901 Optional<const SCEV *>> { 3902 using RetVal = Optional<const SCEV *>; 3903 using Base = SCEVVisitor<SCEVSequentialMinMaxDeduplicatingVisitor, RetVal>; 3904 3905 ScalarEvolution &SE; 3906 const SCEVTypes RootKind; // Must be a sequential min/max expression. 3907 const SCEVTypes NonSequentialRootKind; // Non-sequential variant of RootKind. 3908 SmallPtrSet<const SCEV *, 16> SeenOps; 3909 3910 bool canRecurseInto(SCEVTypes Kind) const { 3911 // We can only recurse into the SCEV expression of the same effective type 3912 // as the type of our root SCEV expression. 3913 return RootKind == Kind || NonSequentialRootKind == Kind; 3914 }; 3915 3916 RetVal visitAnyMinMaxExpr(const SCEV *S) { 3917 assert((isa<SCEVMinMaxExpr>(S) || isa<SCEVSequentialMinMaxExpr>(S)) && 3918 "Only for min/max expressions."); 3919 SCEVTypes Kind = S->getSCEVType(); 3920 3921 if (!canRecurseInto(Kind)) 3922 return S; 3923 3924 auto *NAry = cast<SCEVNAryExpr>(S); 3925 SmallVector<const SCEV *> NewOps; 3926 bool Changed = 3927 visit(Kind, makeArrayRef(NAry->op_begin(), NAry->op_end()), NewOps); 3928 3929 if (!Changed) 3930 return S; 3931 if (NewOps.empty()) 3932 return None; 3933 3934 return isa<SCEVSequentialMinMaxExpr>(S) 3935 ? SE.getSequentialMinMaxExpr(Kind, NewOps) 3936 : SE.getMinMaxExpr(Kind, NewOps); 3937 } 3938 3939 RetVal visit(const SCEV *S) { 3940 // Has the whole operand been seen already? 3941 if (!SeenOps.insert(S).second) 3942 return None; 3943 return Base::visit(S); 3944 } 3945 3946 public: 3947 SCEVSequentialMinMaxDeduplicatingVisitor(ScalarEvolution &SE, 3948 SCEVTypes RootKind) 3949 : SE(SE), RootKind(RootKind), 3950 NonSequentialRootKind( 3951 SCEVSequentialMinMaxExpr::getEquivalentNonSequentialSCEVType( 3952 RootKind)) {} 3953 3954 bool /*Changed*/ visit(SCEVTypes Kind, ArrayRef<const SCEV *> OrigOps, 3955 SmallVectorImpl<const SCEV *> &NewOps) { 3956 bool Changed = false; 3957 SmallVector<const SCEV *> Ops; 3958 Ops.reserve(OrigOps.size()); 3959 3960 for (const SCEV *Op : OrigOps) { 3961 RetVal NewOp = visit(Op); 3962 if (NewOp != Op) 3963 Changed = true; 3964 if (NewOp) 3965 Ops.emplace_back(*NewOp); 3966 } 3967 3968 if (Changed) 3969 NewOps = std::move(Ops); 3970 return Changed; 3971 } 3972 3973 RetVal visitConstant(const SCEVConstant *Constant) { return Constant; } 3974 3975 RetVal visitPtrToIntExpr(const SCEVPtrToIntExpr *Expr) { return Expr; } 3976 3977 RetVal visitTruncateExpr(const SCEVTruncateExpr *Expr) { return Expr; } 3978 3979 RetVal visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) { return Expr; } 3980 3981 RetVal visitSignExtendExpr(const SCEVSignExtendExpr *Expr) { return Expr; } 3982 3983 RetVal visitAddExpr(const SCEVAddExpr *Expr) { return Expr; } 3984 3985 RetVal visitMulExpr(const SCEVMulExpr *Expr) { return Expr; } 3986 3987 RetVal visitUDivExpr(const SCEVUDivExpr *Expr) { return Expr; } 3988 3989 RetVal visitAddRecExpr(const SCEVAddRecExpr *Expr) { return Expr; } 3990 3991 RetVal visitSMaxExpr(const SCEVSMaxExpr *Expr) { 3992 return visitAnyMinMaxExpr(Expr); 3993 } 3994 3995 RetVal visitUMaxExpr(const SCEVUMaxExpr *Expr) { 3996 return visitAnyMinMaxExpr(Expr); 3997 } 3998 3999 RetVal visitSMinExpr(const SCEVSMinExpr *Expr) { 4000 return visitAnyMinMaxExpr(Expr); 4001 } 4002 4003 RetVal visitUMinExpr(const SCEVUMinExpr *Expr) { 4004 return visitAnyMinMaxExpr(Expr); 4005 } 4006 4007 RetVal visitSequentialUMinExpr(const SCEVSequentialUMinExpr *Expr) { 4008 return visitAnyMinMaxExpr(Expr); 4009 } 4010 4011 RetVal visitUnknown(const SCEVUnknown *Expr) { return Expr; } 4012 4013 RetVal visitCouldNotCompute(const SCEVCouldNotCompute *Expr) { return Expr; } 4014 }; 4015 4016 } // namespace 4017 4018 const SCEV * 4019 ScalarEvolution::getSequentialMinMaxExpr(SCEVTypes Kind, 4020 SmallVectorImpl<const SCEV *> &Ops) { 4021 assert(SCEVSequentialMinMaxExpr::isSequentialMinMaxType(Kind) && 4022 "Not a SCEVSequentialMinMaxExpr!"); 4023 assert(!Ops.empty() && "Cannot get empty (u|s)(min|max)!"); 4024 if (Ops.size() == 1) 4025 return Ops[0]; 4026 if (Ops.size() == 2 && 4027 any_of(Ops, [](const SCEV *Op) { return isa<SCEVConstant>(Op); })) 4028 return getMinMaxExpr( 4029 SCEVSequentialMinMaxExpr::getEquivalentNonSequentialSCEVType(Kind), 4030 Ops); 4031 #ifndef NDEBUG 4032 Type *ETy = getEffectiveSCEVType(Ops[0]->getType()); 4033 for (unsigned i = 1, e = Ops.size(); i != e; ++i) { 4034 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy && 4035 "Operand types don't match!"); 4036 assert(Ops[0]->getType()->isPointerTy() == 4037 Ops[i]->getType()->isPointerTy() && 4038 "min/max should be consistently pointerish"); 4039 } 4040 #endif 4041 4042 // Note that SCEVSequentialMinMaxExpr is *NOT* commutative, 4043 // so we can *NOT* do any kind of sorting of the expressions! 4044 4045 // Check if we have created the same expression before. 4046 if (const SCEV *S = findExistingSCEVInCache(Kind, Ops)) 4047 return S; 4048 4049 // FIXME: there are *some* simplifications that we can do here. 4050 4051 // Keep only the first instance of an operand. 4052 { 4053 SCEVSequentialMinMaxDeduplicatingVisitor Deduplicator(*this, Kind); 4054 bool Changed = Deduplicator.visit(Kind, Ops, Ops); 4055 if (Changed) 4056 return getSequentialMinMaxExpr(Kind, Ops); 4057 } 4058 4059 // Check to see if one of the operands is of the same kind. If so, expand its 4060 // operands onto our operand list, and recurse to simplify. 4061 { 4062 unsigned Idx = 0; 4063 bool DeletedAny = false; 4064 while (Idx < Ops.size()) { 4065 if (Ops[Idx]->getSCEVType() != Kind) { 4066 ++Idx; 4067 continue; 4068 } 4069 const auto *SMME = cast<SCEVSequentialMinMaxExpr>(Ops[Idx]); 4070 Ops.erase(Ops.begin() + Idx); 4071 Ops.insert(Ops.begin() + Idx, SMME->op_begin(), SMME->op_end()); 4072 DeletedAny = true; 4073 } 4074 4075 if (DeletedAny) 4076 return getSequentialMinMaxExpr(Kind, Ops); 4077 } 4078 4079 // Okay, it looks like we really DO need an expr. Check to see if we 4080 // already have one, otherwise create a new one. 4081 FoldingSetNodeID ID; 4082 ID.AddInteger(Kind); 4083 for (unsigned i = 0, e = Ops.size(); i != e; ++i) 4084 ID.AddPointer(Ops[i]); 4085 void *IP = nullptr; 4086 const SCEV *ExistingSCEV = UniqueSCEVs.FindNodeOrInsertPos(ID, IP); 4087 if (ExistingSCEV) 4088 return ExistingSCEV; 4089 4090 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size()); 4091 std::uninitialized_copy(Ops.begin(), Ops.end(), O); 4092 SCEV *S = new (SCEVAllocator) 4093 SCEVSequentialMinMaxExpr(ID.Intern(SCEVAllocator), Kind, O, Ops.size()); 4094 4095 UniqueSCEVs.InsertNode(S, IP); 4096 registerUser(S, Ops); 4097 return S; 4098 } 4099 4100 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS, const SCEV *RHS) { 4101 SmallVector<const SCEV *, 2> Ops = {LHS, RHS}; 4102 return getSMaxExpr(Ops); 4103 } 4104 4105 const SCEV *ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) { 4106 return getMinMaxExpr(scSMaxExpr, Ops); 4107 } 4108 4109 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS, const SCEV *RHS) { 4110 SmallVector<const SCEV *, 2> Ops = {LHS, RHS}; 4111 return getUMaxExpr(Ops); 4112 } 4113 4114 const SCEV *ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) { 4115 return getMinMaxExpr(scUMaxExpr, Ops); 4116 } 4117 4118 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS, 4119 const SCEV *RHS) { 4120 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 4121 return getSMinExpr(Ops); 4122 } 4123 4124 const SCEV *ScalarEvolution::getSMinExpr(SmallVectorImpl<const SCEV *> &Ops) { 4125 return getMinMaxExpr(scSMinExpr, Ops); 4126 } 4127 4128 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS, const SCEV *RHS, 4129 bool Sequential) { 4130 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 4131 return getUMinExpr(Ops, Sequential); 4132 } 4133 4134 const SCEV *ScalarEvolution::getUMinExpr(SmallVectorImpl<const SCEV *> &Ops, 4135 bool Sequential) { 4136 return Sequential ? getSequentialMinMaxExpr(scSequentialUMinExpr, Ops) 4137 : getMinMaxExpr(scUMinExpr, Ops); 4138 } 4139 4140 const SCEV * 4141 ScalarEvolution::getSizeOfScalableVectorExpr(Type *IntTy, 4142 ScalableVectorType *ScalableTy) { 4143 Constant *NullPtr = Constant::getNullValue(ScalableTy->getPointerTo()); 4144 Constant *One = ConstantInt::get(IntTy, 1); 4145 Constant *GEP = ConstantExpr::getGetElementPtr(ScalableTy, NullPtr, One); 4146 // Note that the expression we created is the final expression, we don't 4147 // want to simplify it any further Also, if we call a normal getSCEV(), 4148 // we'll end up in an endless recursion. So just create an SCEVUnknown. 4149 return getUnknown(ConstantExpr::getPtrToInt(GEP, IntTy)); 4150 } 4151 4152 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) { 4153 if (auto *ScalableAllocTy = dyn_cast<ScalableVectorType>(AllocTy)) 4154 return getSizeOfScalableVectorExpr(IntTy, ScalableAllocTy); 4155 // We can bypass creating a target-independent constant expression and then 4156 // folding it back into a ConstantInt. This is just a compile-time 4157 // optimization. 4158 return getConstant(IntTy, getDataLayout().getTypeAllocSize(AllocTy)); 4159 } 4160 4161 const SCEV *ScalarEvolution::getStoreSizeOfExpr(Type *IntTy, Type *StoreTy) { 4162 if (auto *ScalableStoreTy = dyn_cast<ScalableVectorType>(StoreTy)) 4163 return getSizeOfScalableVectorExpr(IntTy, ScalableStoreTy); 4164 // We can bypass creating a target-independent constant expression and then 4165 // folding it back into a ConstantInt. This is just a compile-time 4166 // optimization. 4167 return getConstant(IntTy, getDataLayout().getTypeStoreSize(StoreTy)); 4168 } 4169 4170 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy, 4171 StructType *STy, 4172 unsigned FieldNo) { 4173 // We can bypass creating a target-independent constant expression and then 4174 // folding it back into a ConstantInt. This is just a compile-time 4175 // optimization. 4176 return getConstant( 4177 IntTy, getDataLayout().getStructLayout(STy)->getElementOffset(FieldNo)); 4178 } 4179 4180 const SCEV *ScalarEvolution::getUnknown(Value *V) { 4181 // Don't attempt to do anything other than create a SCEVUnknown object 4182 // here. createSCEV only calls getUnknown after checking for all other 4183 // interesting possibilities, and any other code that calls getUnknown 4184 // is doing so in order to hide a value from SCEV canonicalization. 4185 4186 FoldingSetNodeID ID; 4187 ID.AddInteger(scUnknown); 4188 ID.AddPointer(V); 4189 void *IP = nullptr; 4190 if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) { 4191 assert(cast<SCEVUnknown>(S)->getValue() == V && 4192 "Stale SCEVUnknown in uniquing map!"); 4193 return S; 4194 } 4195 SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this, 4196 FirstUnknown); 4197 FirstUnknown = cast<SCEVUnknown>(S); 4198 UniqueSCEVs.InsertNode(S, IP); 4199 return S; 4200 } 4201 4202 //===----------------------------------------------------------------------===// 4203 // Basic SCEV Analysis and PHI Idiom Recognition Code 4204 // 4205 4206 /// Test if values of the given type are analyzable within the SCEV 4207 /// framework. This primarily includes integer types, and it can optionally 4208 /// include pointer types if the ScalarEvolution class has access to 4209 /// target-specific information. 4210 bool ScalarEvolution::isSCEVable(Type *Ty) const { 4211 // Integers and pointers are always SCEVable. 4212 return Ty->isIntOrPtrTy(); 4213 } 4214 4215 /// Return the size in bits of the specified type, for which isSCEVable must 4216 /// return true. 4217 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const { 4218 assert(isSCEVable(Ty) && "Type is not SCEVable!"); 4219 if (Ty->isPointerTy()) 4220 return getDataLayout().getIndexTypeSizeInBits(Ty); 4221 return getDataLayout().getTypeSizeInBits(Ty); 4222 } 4223 4224 /// Return a type with the same bitwidth as the given type and which represents 4225 /// how SCEV will treat the given type, for which isSCEVable must return 4226 /// true. For pointer types, this is the pointer index sized integer type. 4227 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const { 4228 assert(isSCEVable(Ty) && "Type is not SCEVable!"); 4229 4230 if (Ty->isIntegerTy()) 4231 return Ty; 4232 4233 // The only other support type is pointer. 4234 assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!"); 4235 return getDataLayout().getIndexType(Ty); 4236 } 4237 4238 Type *ScalarEvolution::getWiderType(Type *T1, Type *T2) const { 4239 return getTypeSizeInBits(T1) >= getTypeSizeInBits(T2) ? T1 : T2; 4240 } 4241 4242 bool ScalarEvolution::instructionCouldExistWitthOperands(const SCEV *A, 4243 const SCEV *B) { 4244 /// For a valid use point to exist, the defining scope of one operand 4245 /// must dominate the other. 4246 bool PreciseA, PreciseB; 4247 auto *ScopeA = getDefiningScopeBound({A}, PreciseA); 4248 auto *ScopeB = getDefiningScopeBound({B}, PreciseB); 4249 if (!PreciseA || !PreciseB) 4250 // Can't tell. 4251 return false; 4252 return (ScopeA == ScopeB) || DT.dominates(ScopeA, ScopeB) || 4253 DT.dominates(ScopeB, ScopeA); 4254 } 4255 4256 4257 const SCEV *ScalarEvolution::getCouldNotCompute() { 4258 return CouldNotCompute.get(); 4259 } 4260 4261 bool ScalarEvolution::checkValidity(const SCEV *S) const { 4262 bool ContainsNulls = SCEVExprContains(S, [](const SCEV *S) { 4263 auto *SU = dyn_cast<SCEVUnknown>(S); 4264 return SU && SU->getValue() == nullptr; 4265 }); 4266 4267 return !ContainsNulls; 4268 } 4269 4270 bool ScalarEvolution::containsAddRecurrence(const SCEV *S) { 4271 HasRecMapType::iterator I = HasRecMap.find(S); 4272 if (I != HasRecMap.end()) 4273 return I->second; 4274 4275 bool FoundAddRec = 4276 SCEVExprContains(S, [](const SCEV *S) { return isa<SCEVAddRecExpr>(S); }); 4277 HasRecMap.insert({S, FoundAddRec}); 4278 return FoundAddRec; 4279 } 4280 4281 /// Return the ValueOffsetPair set for \p S. \p S can be represented 4282 /// by the value and offset from any ValueOffsetPair in the set. 4283 ArrayRef<Value *> ScalarEvolution::getSCEVValues(const SCEV *S) { 4284 ExprValueMapType::iterator SI = ExprValueMap.find_as(S); 4285 if (SI == ExprValueMap.end()) 4286 return None; 4287 #ifndef NDEBUG 4288 if (VerifySCEVMap) { 4289 // Check there is no dangling Value in the set returned. 4290 for (Value *V : SI->second) 4291 assert(ValueExprMap.count(V)); 4292 } 4293 #endif 4294 return SI->second.getArrayRef(); 4295 } 4296 4297 /// Erase Value from ValueExprMap and ExprValueMap. ValueExprMap.erase(V) 4298 /// cannot be used separately. eraseValueFromMap should be used to remove 4299 /// V from ValueExprMap and ExprValueMap at the same time. 4300 void ScalarEvolution::eraseValueFromMap(Value *V) { 4301 ValueExprMapType::iterator I = ValueExprMap.find_as(V); 4302 if (I != ValueExprMap.end()) { 4303 auto EVIt = ExprValueMap.find(I->second); 4304 bool Removed = EVIt->second.remove(V); 4305 (void) Removed; 4306 assert(Removed && "Value not in ExprValueMap?"); 4307 ValueExprMap.erase(I); 4308 } 4309 } 4310 4311 void ScalarEvolution::insertValueToMap(Value *V, const SCEV *S) { 4312 // A recursive query may have already computed the SCEV. It should be 4313 // equivalent, but may not necessarily be exactly the same, e.g. due to lazily 4314 // inferred nowrap flags. 4315 auto It = ValueExprMap.find_as(V); 4316 if (It == ValueExprMap.end()) { 4317 ValueExprMap.insert({SCEVCallbackVH(V, this), S}); 4318 ExprValueMap[S].insert(V); 4319 } 4320 } 4321 4322 /// Return an existing SCEV if it exists, otherwise analyze the expression and 4323 /// create a new one. 4324 const SCEV *ScalarEvolution::getSCEV(Value *V) { 4325 assert(isSCEVable(V->getType()) && "Value is not SCEVable!"); 4326 4327 const SCEV *S = getExistingSCEV(V); 4328 if (S == nullptr) { 4329 S = createSCEV(V); 4330 // During PHI resolution, it is possible to create two SCEVs for the same 4331 // V, so it is needed to double check whether V->S is inserted into 4332 // ValueExprMap before insert S->{V, 0} into ExprValueMap. 4333 std::pair<ValueExprMapType::iterator, bool> Pair = 4334 ValueExprMap.insert({SCEVCallbackVH(V, this), S}); 4335 if (Pair.second) 4336 ExprValueMap[S].insert(V); 4337 } 4338 return S; 4339 } 4340 4341 const SCEV *ScalarEvolution::getExistingSCEV(Value *V) { 4342 assert(isSCEVable(V->getType()) && "Value is not SCEVable!"); 4343 4344 ValueExprMapType::iterator I = ValueExprMap.find_as(V); 4345 if (I != ValueExprMap.end()) { 4346 const SCEV *S = I->second; 4347 assert(checkValidity(S) && 4348 "existing SCEV has not been properly invalidated"); 4349 return S; 4350 } 4351 return nullptr; 4352 } 4353 4354 /// Return a SCEV corresponding to -V = -1*V 4355 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V, 4356 SCEV::NoWrapFlags Flags) { 4357 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V)) 4358 return getConstant( 4359 cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue()))); 4360 4361 Type *Ty = V->getType(); 4362 Ty = getEffectiveSCEVType(Ty); 4363 return getMulExpr(V, getMinusOne(Ty), Flags); 4364 } 4365 4366 /// If Expr computes ~A, return A else return nullptr 4367 static const SCEV *MatchNotExpr(const SCEV *Expr) { 4368 const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr); 4369 if (!Add || Add->getNumOperands() != 2 || 4370 !Add->getOperand(0)->isAllOnesValue()) 4371 return nullptr; 4372 4373 const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1)); 4374 if (!AddRHS || AddRHS->getNumOperands() != 2 || 4375 !AddRHS->getOperand(0)->isAllOnesValue()) 4376 return nullptr; 4377 4378 return AddRHS->getOperand(1); 4379 } 4380 4381 /// Return a SCEV corresponding to ~V = -1-V 4382 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) { 4383 assert(!V->getType()->isPointerTy() && "Can't negate pointer"); 4384 4385 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V)) 4386 return getConstant( 4387 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue()))); 4388 4389 // Fold ~(u|s)(min|max)(~x, ~y) to (u|s)(max|min)(x, y) 4390 if (const SCEVMinMaxExpr *MME = dyn_cast<SCEVMinMaxExpr>(V)) { 4391 auto MatchMinMaxNegation = [&](const SCEVMinMaxExpr *MME) { 4392 SmallVector<const SCEV *, 2> MatchedOperands; 4393 for (const SCEV *Operand : MME->operands()) { 4394 const SCEV *Matched = MatchNotExpr(Operand); 4395 if (!Matched) 4396 return (const SCEV *)nullptr; 4397 MatchedOperands.push_back(Matched); 4398 } 4399 return getMinMaxExpr(SCEVMinMaxExpr::negate(MME->getSCEVType()), 4400 MatchedOperands); 4401 }; 4402 if (const SCEV *Replaced = MatchMinMaxNegation(MME)) 4403 return Replaced; 4404 } 4405 4406 Type *Ty = V->getType(); 4407 Ty = getEffectiveSCEVType(Ty); 4408 return getMinusSCEV(getMinusOne(Ty), V); 4409 } 4410 4411 const SCEV *ScalarEvolution::removePointerBase(const SCEV *P) { 4412 assert(P->getType()->isPointerTy()); 4413 4414 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(P)) { 4415 // The base of an AddRec is the first operand. 4416 SmallVector<const SCEV *> Ops{AddRec->operands()}; 4417 Ops[0] = removePointerBase(Ops[0]); 4418 // Don't try to transfer nowrap flags for now. We could in some cases 4419 // (for example, if pointer operand of the AddRec is a SCEVUnknown). 4420 return getAddRecExpr(Ops, AddRec->getLoop(), SCEV::FlagAnyWrap); 4421 } 4422 if (auto *Add = dyn_cast<SCEVAddExpr>(P)) { 4423 // The base of an Add is the pointer operand. 4424 SmallVector<const SCEV *> Ops{Add->operands()}; 4425 const SCEV **PtrOp = nullptr; 4426 for (const SCEV *&AddOp : Ops) { 4427 if (AddOp->getType()->isPointerTy()) { 4428 assert(!PtrOp && "Cannot have multiple pointer ops"); 4429 PtrOp = &AddOp; 4430 } 4431 } 4432 *PtrOp = removePointerBase(*PtrOp); 4433 // Don't try to transfer nowrap flags for now. We could in some cases 4434 // (for example, if the pointer operand of the Add is a SCEVUnknown). 4435 return getAddExpr(Ops); 4436 } 4437 // Any other expression must be a pointer base. 4438 return getZero(P->getType()); 4439 } 4440 4441 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS, 4442 SCEV::NoWrapFlags Flags, 4443 unsigned Depth) { 4444 // Fast path: X - X --> 0. 4445 if (LHS == RHS) 4446 return getZero(LHS->getType()); 4447 4448 // If we subtract two pointers with different pointer bases, bail. 4449 // Eventually, we're going to add an assertion to getMulExpr that we 4450 // can't multiply by a pointer. 4451 if (RHS->getType()->isPointerTy()) { 4452 if (!LHS->getType()->isPointerTy() || 4453 getPointerBase(LHS) != getPointerBase(RHS)) 4454 return getCouldNotCompute(); 4455 LHS = removePointerBase(LHS); 4456 RHS = removePointerBase(RHS); 4457 } 4458 4459 // We represent LHS - RHS as LHS + (-1)*RHS. This transformation 4460 // makes it so that we cannot make much use of NUW. 4461 auto AddFlags = SCEV::FlagAnyWrap; 4462 const bool RHSIsNotMinSigned = 4463 !getSignedRangeMin(RHS).isMinSignedValue(); 4464 if (hasFlags(Flags, SCEV::FlagNSW)) { 4465 // Let M be the minimum representable signed value. Then (-1)*RHS 4466 // signed-wraps if and only if RHS is M. That can happen even for 4467 // a NSW subtraction because e.g. (-1)*M signed-wraps even though 4468 // -1 - M does not. So to transfer NSW from LHS - RHS to LHS + 4469 // (-1)*RHS, we need to prove that RHS != M. 4470 // 4471 // If LHS is non-negative and we know that LHS - RHS does not 4472 // signed-wrap, then RHS cannot be M. So we can rule out signed-wrap 4473 // either by proving that RHS > M or that LHS >= 0. 4474 if (RHSIsNotMinSigned || isKnownNonNegative(LHS)) { 4475 AddFlags = SCEV::FlagNSW; 4476 } 4477 } 4478 4479 // FIXME: Find a correct way to transfer NSW to (-1)*M when LHS - 4480 // RHS is NSW and LHS >= 0. 4481 // 4482 // The difficulty here is that the NSW flag may have been proven 4483 // relative to a loop that is to be found in a recurrence in LHS and 4484 // not in RHS. Applying NSW to (-1)*M may then let the NSW have a 4485 // larger scope than intended. 4486 auto NegFlags = RHSIsNotMinSigned ? SCEV::FlagNSW : SCEV::FlagAnyWrap; 4487 4488 return getAddExpr(LHS, getNegativeSCEV(RHS, NegFlags), AddFlags, Depth); 4489 } 4490 4491 const SCEV *ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty, 4492 unsigned Depth) { 4493 Type *SrcTy = V->getType(); 4494 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4495 "Cannot truncate or zero extend with non-integer arguments!"); 4496 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4497 return V; // No conversion 4498 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty)) 4499 return getTruncateExpr(V, Ty, Depth); 4500 return getZeroExtendExpr(V, Ty, Depth); 4501 } 4502 4503 const SCEV *ScalarEvolution::getTruncateOrSignExtend(const SCEV *V, Type *Ty, 4504 unsigned Depth) { 4505 Type *SrcTy = V->getType(); 4506 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4507 "Cannot truncate or zero extend with non-integer arguments!"); 4508 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4509 return V; // No conversion 4510 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty)) 4511 return getTruncateExpr(V, Ty, Depth); 4512 return getSignExtendExpr(V, Ty, Depth); 4513 } 4514 4515 const SCEV * 4516 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) { 4517 Type *SrcTy = V->getType(); 4518 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4519 "Cannot noop or zero extend with non-integer arguments!"); 4520 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4521 "getNoopOrZeroExtend cannot truncate!"); 4522 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4523 return V; // No conversion 4524 return getZeroExtendExpr(V, Ty); 4525 } 4526 4527 const SCEV * 4528 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) { 4529 Type *SrcTy = V->getType(); 4530 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4531 "Cannot noop or sign extend with non-integer arguments!"); 4532 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4533 "getNoopOrSignExtend cannot truncate!"); 4534 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4535 return V; // No conversion 4536 return getSignExtendExpr(V, Ty); 4537 } 4538 4539 const SCEV * 4540 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) { 4541 Type *SrcTy = V->getType(); 4542 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4543 "Cannot noop or any extend with non-integer arguments!"); 4544 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) && 4545 "getNoopOrAnyExtend cannot truncate!"); 4546 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4547 return V; // No conversion 4548 return getAnyExtendExpr(V, Ty); 4549 } 4550 4551 const SCEV * 4552 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) { 4553 Type *SrcTy = V->getType(); 4554 assert(SrcTy->isIntOrPtrTy() && Ty->isIntOrPtrTy() && 4555 "Cannot truncate or noop with non-integer arguments!"); 4556 assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) && 4557 "getTruncateOrNoop cannot extend!"); 4558 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty)) 4559 return V; // No conversion 4560 return getTruncateExpr(V, Ty); 4561 } 4562 4563 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS, 4564 const SCEV *RHS) { 4565 const SCEV *PromotedLHS = LHS; 4566 const SCEV *PromotedRHS = RHS; 4567 4568 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType())) 4569 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType()); 4570 else 4571 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType()); 4572 4573 return getUMaxExpr(PromotedLHS, PromotedRHS); 4574 } 4575 4576 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS, 4577 const SCEV *RHS, 4578 bool Sequential) { 4579 SmallVector<const SCEV *, 2> Ops = { LHS, RHS }; 4580 return getUMinFromMismatchedTypes(Ops, Sequential); 4581 } 4582 4583 const SCEV * 4584 ScalarEvolution::getUMinFromMismatchedTypes(SmallVectorImpl<const SCEV *> &Ops, 4585 bool Sequential) { 4586 assert(!Ops.empty() && "At least one operand must be!"); 4587 // Trivial case. 4588 if (Ops.size() == 1) 4589 return Ops[0]; 4590 4591 // Find the max type first. 4592 Type *MaxType = nullptr; 4593 for (auto *S : Ops) 4594 if (MaxType) 4595 MaxType = getWiderType(MaxType, S->getType()); 4596 else 4597 MaxType = S->getType(); 4598 assert(MaxType && "Failed to find maximum type!"); 4599 4600 // Extend all ops to max type. 4601 SmallVector<const SCEV *, 2> PromotedOps; 4602 for (auto *S : Ops) 4603 PromotedOps.push_back(getNoopOrZeroExtend(S, MaxType)); 4604 4605 // Generate umin. 4606 return getUMinExpr(PromotedOps, Sequential); 4607 } 4608 4609 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) { 4610 // A pointer operand may evaluate to a nonpointer expression, such as null. 4611 if (!V->getType()->isPointerTy()) 4612 return V; 4613 4614 while (true) { 4615 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(V)) { 4616 V = AddRec->getStart(); 4617 } else if (auto *Add = dyn_cast<SCEVAddExpr>(V)) { 4618 const SCEV *PtrOp = nullptr; 4619 for (const SCEV *AddOp : Add->operands()) { 4620 if (AddOp->getType()->isPointerTy()) { 4621 assert(!PtrOp && "Cannot have multiple pointer ops"); 4622 PtrOp = AddOp; 4623 } 4624 } 4625 assert(PtrOp && "Must have pointer op"); 4626 V = PtrOp; 4627 } else // Not something we can look further into. 4628 return V; 4629 } 4630 } 4631 4632 /// Push users of the given Instruction onto the given Worklist. 4633 static void PushDefUseChildren(Instruction *I, 4634 SmallVectorImpl<Instruction *> &Worklist, 4635 SmallPtrSetImpl<Instruction *> &Visited) { 4636 // Push the def-use children onto the Worklist stack. 4637 for (User *U : I->users()) { 4638 auto *UserInsn = cast<Instruction>(U); 4639 if (Visited.insert(UserInsn).second) 4640 Worklist.push_back(UserInsn); 4641 } 4642 } 4643 4644 namespace { 4645 4646 /// Takes SCEV S and Loop L. For each AddRec sub-expression, use its start 4647 /// expression in case its Loop is L. If it is not L then 4648 /// if IgnoreOtherLoops is true then use AddRec itself 4649 /// otherwise rewrite cannot be done. 4650 /// If SCEV contains non-invariant unknown SCEV rewrite cannot be done. 4651 class SCEVInitRewriter : public SCEVRewriteVisitor<SCEVInitRewriter> { 4652 public: 4653 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE, 4654 bool IgnoreOtherLoops = true) { 4655 SCEVInitRewriter Rewriter(L, SE); 4656 const SCEV *Result = Rewriter.visit(S); 4657 if (Rewriter.hasSeenLoopVariantSCEVUnknown()) 4658 return SE.getCouldNotCompute(); 4659 return Rewriter.hasSeenOtherLoops() && !IgnoreOtherLoops 4660 ? SE.getCouldNotCompute() 4661 : Result; 4662 } 4663 4664 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4665 if (!SE.isLoopInvariant(Expr, L)) 4666 SeenLoopVariantSCEVUnknown = true; 4667 return Expr; 4668 } 4669 4670 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4671 // Only re-write AddRecExprs for this loop. 4672 if (Expr->getLoop() == L) 4673 return Expr->getStart(); 4674 SeenOtherLoops = true; 4675 return Expr; 4676 } 4677 4678 bool hasSeenLoopVariantSCEVUnknown() { return SeenLoopVariantSCEVUnknown; } 4679 4680 bool hasSeenOtherLoops() { return SeenOtherLoops; } 4681 4682 private: 4683 explicit SCEVInitRewriter(const Loop *L, ScalarEvolution &SE) 4684 : SCEVRewriteVisitor(SE), L(L) {} 4685 4686 const Loop *L; 4687 bool SeenLoopVariantSCEVUnknown = false; 4688 bool SeenOtherLoops = false; 4689 }; 4690 4691 /// Takes SCEV S and Loop L. For each AddRec sub-expression, use its post 4692 /// increment expression in case its Loop is L. If it is not L then 4693 /// use AddRec itself. 4694 /// If SCEV contains non-invariant unknown SCEV rewrite cannot be done. 4695 class SCEVPostIncRewriter : public SCEVRewriteVisitor<SCEVPostIncRewriter> { 4696 public: 4697 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE) { 4698 SCEVPostIncRewriter Rewriter(L, SE); 4699 const SCEV *Result = Rewriter.visit(S); 4700 return Rewriter.hasSeenLoopVariantSCEVUnknown() 4701 ? SE.getCouldNotCompute() 4702 : Result; 4703 } 4704 4705 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4706 if (!SE.isLoopInvariant(Expr, L)) 4707 SeenLoopVariantSCEVUnknown = true; 4708 return Expr; 4709 } 4710 4711 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4712 // Only re-write AddRecExprs for this loop. 4713 if (Expr->getLoop() == L) 4714 return Expr->getPostIncExpr(SE); 4715 SeenOtherLoops = true; 4716 return Expr; 4717 } 4718 4719 bool hasSeenLoopVariantSCEVUnknown() { return SeenLoopVariantSCEVUnknown; } 4720 4721 bool hasSeenOtherLoops() { return SeenOtherLoops; } 4722 4723 private: 4724 explicit SCEVPostIncRewriter(const Loop *L, ScalarEvolution &SE) 4725 : SCEVRewriteVisitor(SE), L(L) {} 4726 4727 const Loop *L; 4728 bool SeenLoopVariantSCEVUnknown = false; 4729 bool SeenOtherLoops = false; 4730 }; 4731 4732 /// This class evaluates the compare condition by matching it against the 4733 /// condition of loop latch. If there is a match we assume a true value 4734 /// for the condition while building SCEV nodes. 4735 class SCEVBackedgeConditionFolder 4736 : public SCEVRewriteVisitor<SCEVBackedgeConditionFolder> { 4737 public: 4738 static const SCEV *rewrite(const SCEV *S, const Loop *L, 4739 ScalarEvolution &SE) { 4740 bool IsPosBECond = false; 4741 Value *BECond = nullptr; 4742 if (BasicBlock *Latch = L->getLoopLatch()) { 4743 BranchInst *BI = dyn_cast<BranchInst>(Latch->getTerminator()); 4744 if (BI && BI->isConditional()) { 4745 assert(BI->getSuccessor(0) != BI->getSuccessor(1) && 4746 "Both outgoing branches should not target same header!"); 4747 BECond = BI->getCondition(); 4748 IsPosBECond = BI->getSuccessor(0) == L->getHeader(); 4749 } else { 4750 return S; 4751 } 4752 } 4753 SCEVBackedgeConditionFolder Rewriter(L, BECond, IsPosBECond, SE); 4754 return Rewriter.visit(S); 4755 } 4756 4757 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4758 const SCEV *Result = Expr; 4759 bool InvariantF = SE.isLoopInvariant(Expr, L); 4760 4761 if (!InvariantF) { 4762 Instruction *I = cast<Instruction>(Expr->getValue()); 4763 switch (I->getOpcode()) { 4764 case Instruction::Select: { 4765 SelectInst *SI = cast<SelectInst>(I); 4766 Optional<const SCEV *> Res = 4767 compareWithBackedgeCondition(SI->getCondition()); 4768 if (Res.hasValue()) { 4769 bool IsOne = cast<SCEVConstant>(Res.getValue())->getValue()->isOne(); 4770 Result = SE.getSCEV(IsOne ? SI->getTrueValue() : SI->getFalseValue()); 4771 } 4772 break; 4773 } 4774 default: { 4775 Optional<const SCEV *> Res = compareWithBackedgeCondition(I); 4776 if (Res.hasValue()) 4777 Result = Res.getValue(); 4778 break; 4779 } 4780 } 4781 } 4782 return Result; 4783 } 4784 4785 private: 4786 explicit SCEVBackedgeConditionFolder(const Loop *L, Value *BECond, 4787 bool IsPosBECond, ScalarEvolution &SE) 4788 : SCEVRewriteVisitor(SE), L(L), BackedgeCond(BECond), 4789 IsPositiveBECond(IsPosBECond) {} 4790 4791 Optional<const SCEV *> compareWithBackedgeCondition(Value *IC); 4792 4793 const Loop *L; 4794 /// Loop back condition. 4795 Value *BackedgeCond = nullptr; 4796 /// Set to true if loop back is on positive branch condition. 4797 bool IsPositiveBECond; 4798 }; 4799 4800 Optional<const SCEV *> 4801 SCEVBackedgeConditionFolder::compareWithBackedgeCondition(Value *IC) { 4802 4803 // If value matches the backedge condition for loop latch, 4804 // then return a constant evolution node based on loopback 4805 // branch taken. 4806 if (BackedgeCond == IC) 4807 return IsPositiveBECond ? SE.getOne(Type::getInt1Ty(SE.getContext())) 4808 : SE.getZero(Type::getInt1Ty(SE.getContext())); 4809 return None; 4810 } 4811 4812 class SCEVShiftRewriter : public SCEVRewriteVisitor<SCEVShiftRewriter> { 4813 public: 4814 static const SCEV *rewrite(const SCEV *S, const Loop *L, 4815 ScalarEvolution &SE) { 4816 SCEVShiftRewriter Rewriter(L, SE); 4817 const SCEV *Result = Rewriter.visit(S); 4818 return Rewriter.isValid() ? Result : SE.getCouldNotCompute(); 4819 } 4820 4821 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 4822 // Only allow AddRecExprs for this loop. 4823 if (!SE.isLoopInvariant(Expr, L)) 4824 Valid = false; 4825 return Expr; 4826 } 4827 4828 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { 4829 if (Expr->getLoop() == L && Expr->isAffine()) 4830 return SE.getMinusSCEV(Expr, Expr->getStepRecurrence(SE)); 4831 Valid = false; 4832 return Expr; 4833 } 4834 4835 bool isValid() { return Valid; } 4836 4837 private: 4838 explicit SCEVShiftRewriter(const Loop *L, ScalarEvolution &SE) 4839 : SCEVRewriteVisitor(SE), L(L) {} 4840 4841 const Loop *L; 4842 bool Valid = true; 4843 }; 4844 4845 } // end anonymous namespace 4846 4847 SCEV::NoWrapFlags 4848 ScalarEvolution::proveNoWrapViaConstantRanges(const SCEVAddRecExpr *AR) { 4849 if (!AR->isAffine()) 4850 return SCEV::FlagAnyWrap; 4851 4852 using OBO = OverflowingBinaryOperator; 4853 4854 SCEV::NoWrapFlags Result = SCEV::FlagAnyWrap; 4855 4856 if (!AR->hasNoSignedWrap()) { 4857 ConstantRange AddRecRange = getSignedRange(AR); 4858 ConstantRange IncRange = getSignedRange(AR->getStepRecurrence(*this)); 4859 4860 auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 4861 Instruction::Add, IncRange, OBO::NoSignedWrap); 4862 if (NSWRegion.contains(AddRecRange)) 4863 Result = ScalarEvolution::setFlags(Result, SCEV::FlagNSW); 4864 } 4865 4866 if (!AR->hasNoUnsignedWrap()) { 4867 ConstantRange AddRecRange = getUnsignedRange(AR); 4868 ConstantRange IncRange = getUnsignedRange(AR->getStepRecurrence(*this)); 4869 4870 auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion( 4871 Instruction::Add, IncRange, OBO::NoUnsignedWrap); 4872 if (NUWRegion.contains(AddRecRange)) 4873 Result = ScalarEvolution::setFlags(Result, SCEV::FlagNUW); 4874 } 4875 4876 return Result; 4877 } 4878 4879 SCEV::NoWrapFlags 4880 ScalarEvolution::proveNoSignedWrapViaInduction(const SCEVAddRecExpr *AR) { 4881 SCEV::NoWrapFlags Result = AR->getNoWrapFlags(); 4882 4883 if (AR->hasNoSignedWrap()) 4884 return Result; 4885 4886 if (!AR->isAffine()) 4887 return Result; 4888 4889 const SCEV *Step = AR->getStepRecurrence(*this); 4890 const Loop *L = AR->getLoop(); 4891 4892 // Check whether the backedge-taken count is SCEVCouldNotCompute. 4893 // Note that this serves two purposes: It filters out loops that are 4894 // simply not analyzable, and it covers the case where this code is 4895 // being called from within backedge-taken count analysis, such that 4896 // attempting to ask for the backedge-taken count would likely result 4897 // in infinite recursion. In the later case, the analysis code will 4898 // cope with a conservative value, and it will take care to purge 4899 // that value once it has finished. 4900 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 4901 4902 // Normally, in the cases we can prove no-overflow via a 4903 // backedge guarding condition, we can also compute a backedge 4904 // taken count for the loop. The exceptions are assumptions and 4905 // guards present in the loop -- SCEV is not great at exploiting 4906 // these to compute max backedge taken counts, but can still use 4907 // these to prove lack of overflow. Use this fact to avoid 4908 // doing extra work that may not pay off. 4909 4910 if (isa<SCEVCouldNotCompute>(MaxBECount) && !HasGuards && 4911 AC.assumptions().empty()) 4912 return Result; 4913 4914 // If the backedge is guarded by a comparison with the pre-inc value the 4915 // addrec is safe. Also, if the entry is guarded by a comparison with the 4916 // start value and the backedge is guarded by a comparison with the post-inc 4917 // value, the addrec is safe. 4918 ICmpInst::Predicate Pred; 4919 const SCEV *OverflowLimit = 4920 getSignedOverflowLimitForStep(Step, &Pred, this); 4921 if (OverflowLimit && 4922 (isLoopBackedgeGuardedByCond(L, Pred, AR, OverflowLimit) || 4923 isKnownOnEveryIteration(Pred, AR, OverflowLimit))) { 4924 Result = setFlags(Result, SCEV::FlagNSW); 4925 } 4926 return Result; 4927 } 4928 SCEV::NoWrapFlags 4929 ScalarEvolution::proveNoUnsignedWrapViaInduction(const SCEVAddRecExpr *AR) { 4930 SCEV::NoWrapFlags Result = AR->getNoWrapFlags(); 4931 4932 if (AR->hasNoUnsignedWrap()) 4933 return Result; 4934 4935 if (!AR->isAffine()) 4936 return Result; 4937 4938 const SCEV *Step = AR->getStepRecurrence(*this); 4939 unsigned BitWidth = getTypeSizeInBits(AR->getType()); 4940 const Loop *L = AR->getLoop(); 4941 4942 // Check whether the backedge-taken count is SCEVCouldNotCompute. 4943 // Note that this serves two purposes: It filters out loops that are 4944 // simply not analyzable, and it covers the case where this code is 4945 // being called from within backedge-taken count analysis, such that 4946 // attempting to ask for the backedge-taken count would likely result 4947 // in infinite recursion. In the later case, the analysis code will 4948 // cope with a conservative value, and it will take care to purge 4949 // that value once it has finished. 4950 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(L); 4951 4952 // Normally, in the cases we can prove no-overflow via a 4953 // backedge guarding condition, we can also compute a backedge 4954 // taken count for the loop. The exceptions are assumptions and 4955 // guards present in the loop -- SCEV is not great at exploiting 4956 // these to compute max backedge taken counts, but can still use 4957 // these to prove lack of overflow. Use this fact to avoid 4958 // doing extra work that may not pay off. 4959 4960 if (isa<SCEVCouldNotCompute>(MaxBECount) && !HasGuards && 4961 AC.assumptions().empty()) 4962 return Result; 4963 4964 // If the backedge is guarded by a comparison with the pre-inc value the 4965 // addrec is safe. Also, if the entry is guarded by a comparison with the 4966 // start value and the backedge is guarded by a comparison with the post-inc 4967 // value, the addrec is safe. 4968 if (isKnownPositive(Step)) { 4969 const SCEV *N = getConstant(APInt::getMinValue(BitWidth) - 4970 getUnsignedRangeMax(Step)); 4971 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) || 4972 isKnownOnEveryIteration(ICmpInst::ICMP_ULT, AR, N)) { 4973 Result = setFlags(Result, SCEV::FlagNUW); 4974 } 4975 } 4976 4977 return Result; 4978 } 4979 4980 namespace { 4981 4982 /// Represents an abstract binary operation. This may exist as a 4983 /// normal instruction or constant expression, or may have been 4984 /// derived from an expression tree. 4985 struct BinaryOp { 4986 unsigned Opcode; 4987 Value *LHS; 4988 Value *RHS; 4989 bool IsNSW = false; 4990 bool IsNUW = false; 4991 4992 /// Op is set if this BinaryOp corresponds to a concrete LLVM instruction or 4993 /// constant expression. 4994 Operator *Op = nullptr; 4995 4996 explicit BinaryOp(Operator *Op) 4997 : Opcode(Op->getOpcode()), LHS(Op->getOperand(0)), RHS(Op->getOperand(1)), 4998 Op(Op) { 4999 if (auto *OBO = dyn_cast<OverflowingBinaryOperator>(Op)) { 5000 IsNSW = OBO->hasNoSignedWrap(); 5001 IsNUW = OBO->hasNoUnsignedWrap(); 5002 } 5003 } 5004 5005 explicit BinaryOp(unsigned Opcode, Value *LHS, Value *RHS, bool IsNSW = false, 5006 bool IsNUW = false) 5007 : Opcode(Opcode), LHS(LHS), RHS(RHS), IsNSW(IsNSW), IsNUW(IsNUW) {} 5008 }; 5009 5010 } // end anonymous namespace 5011 5012 /// Try to map \p V into a BinaryOp, and return \c None on failure. 5013 static Optional<BinaryOp> MatchBinaryOp(Value *V, DominatorTree &DT) { 5014 auto *Op = dyn_cast<Operator>(V); 5015 if (!Op) 5016 return None; 5017 5018 // Implementation detail: all the cleverness here should happen without 5019 // creating new SCEV expressions -- our caller knowns tricks to avoid creating 5020 // SCEV expressions when possible, and we should not break that. 5021 5022 switch (Op->getOpcode()) { 5023 case Instruction::Add: 5024 case Instruction::Sub: 5025 case Instruction::Mul: 5026 case Instruction::UDiv: 5027 case Instruction::URem: 5028 case Instruction::And: 5029 case Instruction::Or: 5030 case Instruction::AShr: 5031 case Instruction::Shl: 5032 return BinaryOp(Op); 5033 5034 case Instruction::Xor: 5035 if (auto *RHSC = dyn_cast<ConstantInt>(Op->getOperand(1))) 5036 // If the RHS of the xor is a signmask, then this is just an add. 5037 // Instcombine turns add of signmask into xor as a strength reduction step. 5038 if (RHSC->getValue().isSignMask()) 5039 return BinaryOp(Instruction::Add, Op->getOperand(0), Op->getOperand(1)); 5040 // Binary `xor` is a bit-wise `add`. 5041 if (V->getType()->isIntegerTy(1)) 5042 return BinaryOp(Instruction::Add, Op->getOperand(0), Op->getOperand(1)); 5043 return BinaryOp(Op); 5044 5045 case Instruction::LShr: 5046 // Turn logical shift right of a constant into a unsigned divide. 5047 if (ConstantInt *SA = dyn_cast<ConstantInt>(Op->getOperand(1))) { 5048 uint32_t BitWidth = cast<IntegerType>(Op->getType())->getBitWidth(); 5049 5050 // If the shift count is not less than the bitwidth, the result of 5051 // the shift is undefined. Don't try to analyze it, because the 5052 // resolution chosen here may differ from the resolution chosen in 5053 // other parts of the compiler. 5054 if (SA->getValue().ult(BitWidth)) { 5055 Constant *X = 5056 ConstantInt::get(SA->getContext(), 5057 APInt::getOneBitSet(BitWidth, SA->getZExtValue())); 5058 return BinaryOp(Instruction::UDiv, Op->getOperand(0), X); 5059 } 5060 } 5061 return BinaryOp(Op); 5062 5063 case Instruction::ExtractValue: { 5064 auto *EVI = cast<ExtractValueInst>(Op); 5065 if (EVI->getNumIndices() != 1 || EVI->getIndices()[0] != 0) 5066 break; 5067 5068 auto *WO = dyn_cast<WithOverflowInst>(EVI->getAggregateOperand()); 5069 if (!WO) 5070 break; 5071 5072 Instruction::BinaryOps BinOp = WO->getBinaryOp(); 5073 bool Signed = WO->isSigned(); 5074 // TODO: Should add nuw/nsw flags for mul as well. 5075 if (BinOp == Instruction::Mul || !isOverflowIntrinsicNoWrap(WO, DT)) 5076 return BinaryOp(BinOp, WO->getLHS(), WO->getRHS()); 5077 5078 // Now that we know that all uses of the arithmetic-result component of 5079 // CI are guarded by the overflow check, we can go ahead and pretend 5080 // that the arithmetic is non-overflowing. 5081 return BinaryOp(BinOp, WO->getLHS(), WO->getRHS(), 5082 /* IsNSW = */ Signed, /* IsNUW = */ !Signed); 5083 } 5084 5085 default: 5086 break; 5087 } 5088 5089 // Recognise intrinsic loop.decrement.reg, and as this has exactly the same 5090 // semantics as a Sub, return a binary sub expression. 5091 if (auto *II = dyn_cast<IntrinsicInst>(V)) 5092 if (II->getIntrinsicID() == Intrinsic::loop_decrement_reg) 5093 return BinaryOp(Instruction::Sub, II->getOperand(0), II->getOperand(1)); 5094 5095 return None; 5096 } 5097 5098 /// Helper function to createAddRecFromPHIWithCasts. We have a phi 5099 /// node whose symbolic (unknown) SCEV is \p SymbolicPHI, which is updated via 5100 /// the loop backedge by a SCEVAddExpr, possibly also with a few casts on the 5101 /// way. This function checks if \p Op, an operand of this SCEVAddExpr, 5102 /// follows one of the following patterns: 5103 /// Op == (SExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) 5104 /// Op == (ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) 5105 /// If the SCEV expression of \p Op conforms with one of the expected patterns 5106 /// we return the type of the truncation operation, and indicate whether the 5107 /// truncated type should be treated as signed/unsigned by setting 5108 /// \p Signed to true/false, respectively. 5109 static Type *isSimpleCastedPHI(const SCEV *Op, const SCEVUnknown *SymbolicPHI, 5110 bool &Signed, ScalarEvolution &SE) { 5111 // The case where Op == SymbolicPHI (that is, with no type conversions on 5112 // the way) is handled by the regular add recurrence creating logic and 5113 // would have already been triggered in createAddRecForPHI. Reaching it here 5114 // means that createAddRecFromPHI had failed for this PHI before (e.g., 5115 // because one of the other operands of the SCEVAddExpr updating this PHI is 5116 // not invariant). 5117 // 5118 // Here we look for the case where Op = (ext(trunc(SymbolicPHI))), and in 5119 // this case predicates that allow us to prove that Op == SymbolicPHI will 5120 // be added. 5121 if (Op == SymbolicPHI) 5122 return nullptr; 5123 5124 unsigned SourceBits = SE.getTypeSizeInBits(SymbolicPHI->getType()); 5125 unsigned NewBits = SE.getTypeSizeInBits(Op->getType()); 5126 if (SourceBits != NewBits) 5127 return nullptr; 5128 5129 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(Op); 5130 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(Op); 5131 if (!SExt && !ZExt) 5132 return nullptr; 5133 const SCEVTruncateExpr *Trunc = 5134 SExt ? dyn_cast<SCEVTruncateExpr>(SExt->getOperand()) 5135 : dyn_cast<SCEVTruncateExpr>(ZExt->getOperand()); 5136 if (!Trunc) 5137 return nullptr; 5138 const SCEV *X = Trunc->getOperand(); 5139 if (X != SymbolicPHI) 5140 return nullptr; 5141 Signed = SExt != nullptr; 5142 return Trunc->getType(); 5143 } 5144 5145 static const Loop *isIntegerLoopHeaderPHI(const PHINode *PN, LoopInfo &LI) { 5146 if (!PN->getType()->isIntegerTy()) 5147 return nullptr; 5148 const Loop *L = LI.getLoopFor(PN->getParent()); 5149 if (!L || L->getHeader() != PN->getParent()) 5150 return nullptr; 5151 return L; 5152 } 5153 5154 // Analyze \p SymbolicPHI, a SCEV expression of a phi node, and check if the 5155 // computation that updates the phi follows the following pattern: 5156 // (SExt/ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) + InvariantAccum 5157 // which correspond to a phi->trunc->sext/zext->add->phi update chain. 5158 // If so, try to see if it can be rewritten as an AddRecExpr under some 5159 // Predicates. If successful, return them as a pair. Also cache the results 5160 // of the analysis. 5161 // 5162 // Example usage scenario: 5163 // Say the Rewriter is called for the following SCEV: 5164 // 8 * ((sext i32 (trunc i64 %X to i32) to i64) + %Step) 5165 // where: 5166 // %X = phi i64 (%Start, %BEValue) 5167 // It will visitMul->visitAdd->visitSExt->visitTrunc->visitUnknown(%X), 5168 // and call this function with %SymbolicPHI = %X. 5169 // 5170 // The analysis will find that the value coming around the backedge has 5171 // the following SCEV: 5172 // BEValue = ((sext i32 (trunc i64 %X to i32) to i64) + %Step) 5173 // Upon concluding that this matches the desired pattern, the function 5174 // will return the pair {NewAddRec, SmallPredsVec} where: 5175 // NewAddRec = {%Start,+,%Step} 5176 // SmallPredsVec = {P1, P2, P3} as follows: 5177 // P1(WrapPred): AR: {trunc(%Start),+,(trunc %Step)}<nsw> Flags: <nssw> 5178 // P2(EqualPred): %Start == (sext i32 (trunc i64 %Start to i32) to i64) 5179 // P3(EqualPred): %Step == (sext i32 (trunc i64 %Step to i32) to i64) 5180 // The returned pair means that SymbolicPHI can be rewritten into NewAddRec 5181 // under the predicates {P1,P2,P3}. 5182 // This predicated rewrite will be cached in PredicatedSCEVRewrites: 5183 // PredicatedSCEVRewrites[{%X,L}] = {NewAddRec, {P1,P2,P3)} 5184 // 5185 // TODO's: 5186 // 5187 // 1) Extend the Induction descriptor to also support inductions that involve 5188 // casts: When needed (namely, when we are called in the context of the 5189 // vectorizer induction analysis), a Set of cast instructions will be 5190 // populated by this method, and provided back to isInductionPHI. This is 5191 // needed to allow the vectorizer to properly record them to be ignored by 5192 // the cost model and to avoid vectorizing them (otherwise these casts, 5193 // which are redundant under the runtime overflow checks, will be 5194 // vectorized, which can be costly). 5195 // 5196 // 2) Support additional induction/PHISCEV patterns: We also want to support 5197 // inductions where the sext-trunc / zext-trunc operations (partly) occur 5198 // after the induction update operation (the induction increment): 5199 // 5200 // (Trunc iy (SExt/ZExt ix (%SymbolicPHI + InvariantAccum) to iy) to ix) 5201 // which correspond to a phi->add->trunc->sext/zext->phi update chain. 5202 // 5203 // (Trunc iy ((SExt/ZExt ix (%SymbolicPhi) to iy) + InvariantAccum) to ix) 5204 // which correspond to a phi->trunc->add->sext/zext->phi update chain. 5205 // 5206 // 3) Outline common code with createAddRecFromPHI to avoid duplication. 5207 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 5208 ScalarEvolution::createAddRecFromPHIWithCastsImpl(const SCEVUnknown *SymbolicPHI) { 5209 SmallVector<const SCEVPredicate *, 3> Predicates; 5210 5211 // *** Part1: Analyze if we have a phi-with-cast pattern for which we can 5212 // return an AddRec expression under some predicate. 5213 5214 auto *PN = cast<PHINode>(SymbolicPHI->getValue()); 5215 const Loop *L = isIntegerLoopHeaderPHI(PN, LI); 5216 assert(L && "Expecting an integer loop header phi"); 5217 5218 // The loop may have multiple entrances or multiple exits; we can analyze 5219 // this phi as an addrec if it has a unique entry value and a unique 5220 // backedge value. 5221 Value *BEValueV = nullptr, *StartValueV = nullptr; 5222 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 5223 Value *V = PN->getIncomingValue(i); 5224 if (L->contains(PN->getIncomingBlock(i))) { 5225 if (!BEValueV) { 5226 BEValueV = V; 5227 } else if (BEValueV != V) { 5228 BEValueV = nullptr; 5229 break; 5230 } 5231 } else if (!StartValueV) { 5232 StartValueV = V; 5233 } else if (StartValueV != V) { 5234 StartValueV = nullptr; 5235 break; 5236 } 5237 } 5238 if (!BEValueV || !StartValueV) 5239 return None; 5240 5241 const SCEV *BEValue = getSCEV(BEValueV); 5242 5243 // If the value coming around the backedge is an add with the symbolic 5244 // value we just inserted, possibly with casts that we can ignore under 5245 // an appropriate runtime guard, then we found a simple induction variable! 5246 const auto *Add = dyn_cast<SCEVAddExpr>(BEValue); 5247 if (!Add) 5248 return None; 5249 5250 // If there is a single occurrence of the symbolic value, possibly 5251 // casted, replace it with a recurrence. 5252 unsigned FoundIndex = Add->getNumOperands(); 5253 Type *TruncTy = nullptr; 5254 bool Signed; 5255 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5256 if ((TruncTy = 5257 isSimpleCastedPHI(Add->getOperand(i), SymbolicPHI, Signed, *this))) 5258 if (FoundIndex == e) { 5259 FoundIndex = i; 5260 break; 5261 } 5262 5263 if (FoundIndex == Add->getNumOperands()) 5264 return None; 5265 5266 // Create an add with everything but the specified operand. 5267 SmallVector<const SCEV *, 8> Ops; 5268 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5269 if (i != FoundIndex) 5270 Ops.push_back(Add->getOperand(i)); 5271 const SCEV *Accum = getAddExpr(Ops); 5272 5273 // The runtime checks will not be valid if the step amount is 5274 // varying inside the loop. 5275 if (!isLoopInvariant(Accum, L)) 5276 return None; 5277 5278 // *** Part2: Create the predicates 5279 5280 // Analysis was successful: we have a phi-with-cast pattern for which we 5281 // can return an AddRec expression under the following predicates: 5282 // 5283 // P1: A Wrap predicate that guarantees that Trunc(Start) + i*Trunc(Accum) 5284 // fits within the truncated type (does not overflow) for i = 0 to n-1. 5285 // P2: An Equal predicate that guarantees that 5286 // Start = (Ext ix (Trunc iy (Start) to ix) to iy) 5287 // P3: An Equal predicate that guarantees that 5288 // Accum = (Ext ix (Trunc iy (Accum) to ix) to iy) 5289 // 5290 // As we next prove, the above predicates guarantee that: 5291 // Start + i*Accum = (Ext ix (Trunc iy ( Start + i*Accum ) to ix) to iy) 5292 // 5293 // 5294 // More formally, we want to prove that: 5295 // Expr(i+1) = Start + (i+1) * Accum 5296 // = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum 5297 // 5298 // Given that: 5299 // 1) Expr(0) = Start 5300 // 2) Expr(1) = Start + Accum 5301 // = (Ext ix (Trunc iy (Start) to ix) to iy) + Accum :: from P2 5302 // 3) Induction hypothesis (step i): 5303 // Expr(i) = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum 5304 // 5305 // Proof: 5306 // Expr(i+1) = 5307 // = Start + (i+1)*Accum 5308 // = (Start + i*Accum) + Accum 5309 // = Expr(i) + Accum 5310 // = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum + Accum 5311 // :: from step i 5312 // 5313 // = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy) + Accum + Accum 5314 // 5315 // = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy) 5316 // + (Ext ix (Trunc iy (Accum) to ix) to iy) 5317 // + Accum :: from P3 5318 // 5319 // = (Ext ix (Trunc iy ((Start + (i-1)*Accum) + Accum) to ix) to iy) 5320 // + Accum :: from P1: Ext(x)+Ext(y)=>Ext(x+y) 5321 // 5322 // = (Ext ix (Trunc iy (Start + i*Accum) to ix) to iy) + Accum 5323 // = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum 5324 // 5325 // By induction, the same applies to all iterations 1<=i<n: 5326 // 5327 5328 // Create a truncated addrec for which we will add a no overflow check (P1). 5329 const SCEV *StartVal = getSCEV(StartValueV); 5330 const SCEV *PHISCEV = 5331 getAddRecExpr(getTruncateExpr(StartVal, TruncTy), 5332 getTruncateExpr(Accum, TruncTy), L, SCEV::FlagAnyWrap); 5333 5334 // PHISCEV can be either a SCEVConstant or a SCEVAddRecExpr. 5335 // ex: If truncated Accum is 0 and StartVal is a constant, then PHISCEV 5336 // will be constant. 5337 // 5338 // If PHISCEV is a constant, then P1 degenerates into P2 or P3, so we don't 5339 // add P1. 5340 if (const auto *AR = dyn_cast<SCEVAddRecExpr>(PHISCEV)) { 5341 SCEVWrapPredicate::IncrementWrapFlags AddedFlags = 5342 Signed ? SCEVWrapPredicate::IncrementNSSW 5343 : SCEVWrapPredicate::IncrementNUSW; 5344 const SCEVPredicate *AddRecPred = getWrapPredicate(AR, AddedFlags); 5345 Predicates.push_back(AddRecPred); 5346 } 5347 5348 // Create the Equal Predicates P2,P3: 5349 5350 // It is possible that the predicates P2 and/or P3 are computable at 5351 // compile time due to StartVal and/or Accum being constants. 5352 // If either one is, then we can check that now and escape if either P2 5353 // or P3 is false. 5354 5355 // Construct the extended SCEV: (Ext ix (Trunc iy (Expr) to ix) to iy) 5356 // for each of StartVal and Accum 5357 auto getExtendedExpr = [&](const SCEV *Expr, 5358 bool CreateSignExtend) -> const SCEV * { 5359 assert(isLoopInvariant(Expr, L) && "Expr is expected to be invariant"); 5360 const SCEV *TruncatedExpr = getTruncateExpr(Expr, TruncTy); 5361 const SCEV *ExtendedExpr = 5362 CreateSignExtend ? getSignExtendExpr(TruncatedExpr, Expr->getType()) 5363 : getZeroExtendExpr(TruncatedExpr, Expr->getType()); 5364 return ExtendedExpr; 5365 }; 5366 5367 // Given: 5368 // ExtendedExpr = (Ext ix (Trunc iy (Expr) to ix) to iy 5369 // = getExtendedExpr(Expr) 5370 // Determine whether the predicate P: Expr == ExtendedExpr 5371 // is known to be false at compile time 5372 auto PredIsKnownFalse = [&](const SCEV *Expr, 5373 const SCEV *ExtendedExpr) -> bool { 5374 return Expr != ExtendedExpr && 5375 isKnownPredicate(ICmpInst::ICMP_NE, Expr, ExtendedExpr); 5376 }; 5377 5378 const SCEV *StartExtended = getExtendedExpr(StartVal, Signed); 5379 if (PredIsKnownFalse(StartVal, StartExtended)) { 5380 LLVM_DEBUG(dbgs() << "P2 is compile-time false\n";); 5381 return None; 5382 } 5383 5384 // The Step is always Signed (because the overflow checks are either 5385 // NSSW or NUSW) 5386 const SCEV *AccumExtended = getExtendedExpr(Accum, /*CreateSignExtend=*/true); 5387 if (PredIsKnownFalse(Accum, AccumExtended)) { 5388 LLVM_DEBUG(dbgs() << "P3 is compile-time false\n";); 5389 return None; 5390 } 5391 5392 auto AppendPredicate = [&](const SCEV *Expr, 5393 const SCEV *ExtendedExpr) -> void { 5394 if (Expr != ExtendedExpr && 5395 !isKnownPredicate(ICmpInst::ICMP_EQ, Expr, ExtendedExpr)) { 5396 const SCEVPredicate *Pred = getEqualPredicate(Expr, ExtendedExpr); 5397 LLVM_DEBUG(dbgs() << "Added Predicate: " << *Pred); 5398 Predicates.push_back(Pred); 5399 } 5400 }; 5401 5402 AppendPredicate(StartVal, StartExtended); 5403 AppendPredicate(Accum, AccumExtended); 5404 5405 // *** Part3: Predicates are ready. Now go ahead and create the new addrec in 5406 // which the casts had been folded away. The caller can rewrite SymbolicPHI 5407 // into NewAR if it will also add the runtime overflow checks specified in 5408 // Predicates. 5409 auto *NewAR = getAddRecExpr(StartVal, Accum, L, SCEV::FlagAnyWrap); 5410 5411 std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> PredRewrite = 5412 std::make_pair(NewAR, Predicates); 5413 // Remember the result of the analysis for this SCEV at this locayyytion. 5414 PredicatedSCEVRewrites[{SymbolicPHI, L}] = PredRewrite; 5415 return PredRewrite; 5416 } 5417 5418 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 5419 ScalarEvolution::createAddRecFromPHIWithCasts(const SCEVUnknown *SymbolicPHI) { 5420 auto *PN = cast<PHINode>(SymbolicPHI->getValue()); 5421 const Loop *L = isIntegerLoopHeaderPHI(PN, LI); 5422 if (!L) 5423 return None; 5424 5425 // Check to see if we already analyzed this PHI. 5426 auto I = PredicatedSCEVRewrites.find({SymbolicPHI, L}); 5427 if (I != PredicatedSCEVRewrites.end()) { 5428 std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> Rewrite = 5429 I->second; 5430 // Analysis was done before and failed to create an AddRec: 5431 if (Rewrite.first == SymbolicPHI) 5432 return None; 5433 // Analysis was done before and succeeded to create an AddRec under 5434 // a predicate: 5435 assert(isa<SCEVAddRecExpr>(Rewrite.first) && "Expected an AddRec"); 5436 assert(!(Rewrite.second).empty() && "Expected to find Predicates"); 5437 return Rewrite; 5438 } 5439 5440 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 5441 Rewrite = createAddRecFromPHIWithCastsImpl(SymbolicPHI); 5442 5443 // Record in the cache that the analysis failed 5444 if (!Rewrite) { 5445 SmallVector<const SCEVPredicate *, 3> Predicates; 5446 PredicatedSCEVRewrites[{SymbolicPHI, L}] = {SymbolicPHI, Predicates}; 5447 return None; 5448 } 5449 5450 return Rewrite; 5451 } 5452 5453 // FIXME: This utility is currently required because the Rewriter currently 5454 // does not rewrite this expression: 5455 // {0, +, (sext ix (trunc iy to ix) to iy)} 5456 // into {0, +, %step}, 5457 // even when the following Equal predicate exists: 5458 // "%step == (sext ix (trunc iy to ix) to iy)". 5459 bool PredicatedScalarEvolution::areAddRecsEqualWithPreds( 5460 const SCEVAddRecExpr *AR1, const SCEVAddRecExpr *AR2) const { 5461 if (AR1 == AR2) 5462 return true; 5463 5464 auto areExprsEqual = [&](const SCEV *Expr1, const SCEV *Expr2) -> bool { 5465 if (Expr1 != Expr2 && !Preds->implies(SE.getEqualPredicate(Expr1, Expr2)) && 5466 !Preds->implies(SE.getEqualPredicate(Expr2, Expr1))) 5467 return false; 5468 return true; 5469 }; 5470 5471 if (!areExprsEqual(AR1->getStart(), AR2->getStart()) || 5472 !areExprsEqual(AR1->getStepRecurrence(SE), AR2->getStepRecurrence(SE))) 5473 return false; 5474 return true; 5475 } 5476 5477 /// A helper function for createAddRecFromPHI to handle simple cases. 5478 /// 5479 /// This function tries to find an AddRec expression for the simplest (yet most 5480 /// common) cases: PN = PHI(Start, OP(Self, LoopInvariant)). 5481 /// If it fails, createAddRecFromPHI will use a more general, but slow, 5482 /// technique for finding the AddRec expression. 5483 const SCEV *ScalarEvolution::createSimpleAffineAddRec(PHINode *PN, 5484 Value *BEValueV, 5485 Value *StartValueV) { 5486 const Loop *L = LI.getLoopFor(PN->getParent()); 5487 assert(L && L->getHeader() == PN->getParent()); 5488 assert(BEValueV && StartValueV); 5489 5490 auto BO = MatchBinaryOp(BEValueV, DT); 5491 if (!BO) 5492 return nullptr; 5493 5494 if (BO->Opcode != Instruction::Add) 5495 return nullptr; 5496 5497 const SCEV *Accum = nullptr; 5498 if (BO->LHS == PN && L->isLoopInvariant(BO->RHS)) 5499 Accum = getSCEV(BO->RHS); 5500 else if (BO->RHS == PN && L->isLoopInvariant(BO->LHS)) 5501 Accum = getSCEV(BO->LHS); 5502 5503 if (!Accum) 5504 return nullptr; 5505 5506 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 5507 if (BO->IsNUW) 5508 Flags = setFlags(Flags, SCEV::FlagNUW); 5509 if (BO->IsNSW) 5510 Flags = setFlags(Flags, SCEV::FlagNSW); 5511 5512 const SCEV *StartVal = getSCEV(StartValueV); 5513 const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags); 5514 insertValueToMap(PN, PHISCEV); 5515 5516 // We can add Flags to the post-inc expression only if we 5517 // know that it is *undefined behavior* for BEValueV to 5518 // overflow. 5519 if (auto *BEInst = dyn_cast<Instruction>(BEValueV)) { 5520 assert(isLoopInvariant(Accum, L) && 5521 "Accum is defined outside L, but is not invariant?"); 5522 if (isAddRecNeverPoison(BEInst, L)) 5523 (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags); 5524 } 5525 5526 return PHISCEV; 5527 } 5528 5529 const SCEV *ScalarEvolution::createAddRecFromPHI(PHINode *PN) { 5530 const Loop *L = LI.getLoopFor(PN->getParent()); 5531 if (!L || L->getHeader() != PN->getParent()) 5532 return nullptr; 5533 5534 // The loop may have multiple entrances or multiple exits; we can analyze 5535 // this phi as an addrec if it has a unique entry value and a unique 5536 // backedge value. 5537 Value *BEValueV = nullptr, *StartValueV = nullptr; 5538 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 5539 Value *V = PN->getIncomingValue(i); 5540 if (L->contains(PN->getIncomingBlock(i))) { 5541 if (!BEValueV) { 5542 BEValueV = V; 5543 } else if (BEValueV != V) { 5544 BEValueV = nullptr; 5545 break; 5546 } 5547 } else if (!StartValueV) { 5548 StartValueV = V; 5549 } else if (StartValueV != V) { 5550 StartValueV = nullptr; 5551 break; 5552 } 5553 } 5554 if (!BEValueV || !StartValueV) 5555 return nullptr; 5556 5557 assert(ValueExprMap.find_as(PN) == ValueExprMap.end() && 5558 "PHI node already processed?"); 5559 5560 // First, try to find AddRec expression without creating a fictituos symbolic 5561 // value for PN. 5562 if (auto *S = createSimpleAffineAddRec(PN, BEValueV, StartValueV)) 5563 return S; 5564 5565 // Handle PHI node value symbolically. 5566 const SCEV *SymbolicName = getUnknown(PN); 5567 insertValueToMap(PN, SymbolicName); 5568 5569 // Using this symbolic name for the PHI, analyze the value coming around 5570 // the back-edge. 5571 const SCEV *BEValue = getSCEV(BEValueV); 5572 5573 // NOTE: If BEValue is loop invariant, we know that the PHI node just 5574 // has a special value for the first iteration of the loop. 5575 5576 // If the value coming around the backedge is an add with the symbolic 5577 // value we just inserted, then we found a simple induction variable! 5578 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) { 5579 // If there is a single occurrence of the symbolic value, replace it 5580 // with a recurrence. 5581 unsigned FoundIndex = Add->getNumOperands(); 5582 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5583 if (Add->getOperand(i) == SymbolicName) 5584 if (FoundIndex == e) { 5585 FoundIndex = i; 5586 break; 5587 } 5588 5589 if (FoundIndex != Add->getNumOperands()) { 5590 // Create an add with everything but the specified operand. 5591 SmallVector<const SCEV *, 8> Ops; 5592 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i) 5593 if (i != FoundIndex) 5594 Ops.push_back(SCEVBackedgeConditionFolder::rewrite(Add->getOperand(i), 5595 L, *this)); 5596 const SCEV *Accum = getAddExpr(Ops); 5597 5598 // This is not a valid addrec if the step amount is varying each 5599 // loop iteration, but is not itself an addrec in this loop. 5600 if (isLoopInvariant(Accum, L) || 5601 (isa<SCEVAddRecExpr>(Accum) && 5602 cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) { 5603 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 5604 5605 if (auto BO = MatchBinaryOp(BEValueV, DT)) { 5606 if (BO->Opcode == Instruction::Add && BO->LHS == PN) { 5607 if (BO->IsNUW) 5608 Flags = setFlags(Flags, SCEV::FlagNUW); 5609 if (BO->IsNSW) 5610 Flags = setFlags(Flags, SCEV::FlagNSW); 5611 } 5612 } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) { 5613 // If the increment is an inbounds GEP, then we know the address 5614 // space cannot be wrapped around. We cannot make any guarantee 5615 // about signed or unsigned overflow because pointers are 5616 // unsigned but we may have a negative index from the base 5617 // pointer. We can guarantee that no unsigned wrap occurs if the 5618 // indices form a positive value. 5619 if (GEP->isInBounds() && GEP->getOperand(0) == PN) { 5620 Flags = setFlags(Flags, SCEV::FlagNW); 5621 5622 const SCEV *Ptr = getSCEV(GEP->getPointerOperand()); 5623 if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr))) 5624 Flags = setFlags(Flags, SCEV::FlagNUW); 5625 } 5626 5627 // We cannot transfer nuw and nsw flags from subtraction 5628 // operations -- sub nuw X, Y is not the same as add nuw X, -Y 5629 // for instance. 5630 } 5631 5632 const SCEV *StartVal = getSCEV(StartValueV); 5633 const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags); 5634 5635 // Okay, for the entire analysis of this edge we assumed the PHI 5636 // to be symbolic. We now need to go back and purge all of the 5637 // entries for the scalars that use the symbolic expression. 5638 forgetMemoizedResults(SymbolicName); 5639 insertValueToMap(PN, PHISCEV); 5640 5641 // We can add Flags to the post-inc expression only if we 5642 // know that it is *undefined behavior* for BEValueV to 5643 // overflow. 5644 if (auto *BEInst = dyn_cast<Instruction>(BEValueV)) 5645 if (isLoopInvariant(Accum, L) && isAddRecNeverPoison(BEInst, L)) 5646 (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags); 5647 5648 return PHISCEV; 5649 } 5650 } 5651 } else { 5652 // Otherwise, this could be a loop like this: 5653 // i = 0; for (j = 1; ..; ++j) { .... i = j; } 5654 // In this case, j = {1,+,1} and BEValue is j. 5655 // Because the other in-value of i (0) fits the evolution of BEValue 5656 // i really is an addrec evolution. 5657 // 5658 // We can generalize this saying that i is the shifted value of BEValue 5659 // by one iteration: 5660 // PHI(f(0), f({1,+,1})) --> f({0,+,1}) 5661 const SCEV *Shifted = SCEVShiftRewriter::rewrite(BEValue, L, *this); 5662 const SCEV *Start = SCEVInitRewriter::rewrite(Shifted, L, *this, false); 5663 if (Shifted != getCouldNotCompute() && 5664 Start != getCouldNotCompute()) { 5665 const SCEV *StartVal = getSCEV(StartValueV); 5666 if (Start == StartVal) { 5667 // Okay, for the entire analysis of this edge we assumed the PHI 5668 // to be symbolic. We now need to go back and purge all of the 5669 // entries for the scalars that use the symbolic expression. 5670 forgetMemoizedResults(SymbolicName); 5671 insertValueToMap(PN, Shifted); 5672 return Shifted; 5673 } 5674 } 5675 } 5676 5677 // Remove the temporary PHI node SCEV that has been inserted while intending 5678 // to create an AddRecExpr for this PHI node. We can not keep this temporary 5679 // as it will prevent later (possibly simpler) SCEV expressions to be added 5680 // to the ValueExprMap. 5681 eraseValueFromMap(PN); 5682 5683 return nullptr; 5684 } 5685 5686 // Checks if the SCEV S is available at BB. S is considered available at BB 5687 // if S can be materialized at BB without introducing a fault. 5688 static bool IsAvailableOnEntry(const Loop *L, DominatorTree &DT, const SCEV *S, 5689 BasicBlock *BB) { 5690 struct CheckAvailable { 5691 bool TraversalDone = false; 5692 bool Available = true; 5693 5694 const Loop *L = nullptr; // The loop BB is in (can be nullptr) 5695 BasicBlock *BB = nullptr; 5696 DominatorTree &DT; 5697 5698 CheckAvailable(const Loop *L, BasicBlock *BB, DominatorTree &DT) 5699 : L(L), BB(BB), DT(DT) {} 5700 5701 bool setUnavailable() { 5702 TraversalDone = true; 5703 Available = false; 5704 return false; 5705 } 5706 5707 bool follow(const SCEV *S) { 5708 switch (S->getSCEVType()) { 5709 case scConstant: 5710 case scPtrToInt: 5711 case scTruncate: 5712 case scZeroExtend: 5713 case scSignExtend: 5714 case scAddExpr: 5715 case scMulExpr: 5716 case scUMaxExpr: 5717 case scSMaxExpr: 5718 case scUMinExpr: 5719 case scSMinExpr: 5720 case scSequentialUMinExpr: 5721 // These expressions are available if their operand(s) is/are. 5722 return true; 5723 5724 case scAddRecExpr: { 5725 // We allow add recurrences that are on the loop BB is in, or some 5726 // outer loop. This guarantees availability because the value of the 5727 // add recurrence at BB is simply the "current" value of the induction 5728 // variable. We can relax this in the future; for instance an add 5729 // recurrence on a sibling dominating loop is also available at BB. 5730 const auto *ARLoop = cast<SCEVAddRecExpr>(S)->getLoop(); 5731 if (L && (ARLoop == L || ARLoop->contains(L))) 5732 return true; 5733 5734 return setUnavailable(); 5735 } 5736 5737 case scUnknown: { 5738 // For SCEVUnknown, we check for simple dominance. 5739 const auto *SU = cast<SCEVUnknown>(S); 5740 Value *V = SU->getValue(); 5741 5742 if (isa<Argument>(V)) 5743 return false; 5744 5745 if (isa<Instruction>(V) && DT.dominates(cast<Instruction>(V), BB)) 5746 return false; 5747 5748 return setUnavailable(); 5749 } 5750 5751 case scUDivExpr: 5752 case scCouldNotCompute: 5753 // We do not try to smart about these at all. 5754 return setUnavailable(); 5755 } 5756 llvm_unreachable("Unknown SCEV kind!"); 5757 } 5758 5759 bool isDone() { return TraversalDone; } 5760 }; 5761 5762 CheckAvailable CA(L, BB, DT); 5763 SCEVTraversal<CheckAvailable> ST(CA); 5764 5765 ST.visitAll(S); 5766 return CA.Available; 5767 } 5768 5769 // Try to match a control flow sequence that branches out at BI and merges back 5770 // at Merge into a "C ? LHS : RHS" select pattern. Return true on a successful 5771 // match. 5772 static bool BrPHIToSelect(DominatorTree &DT, BranchInst *BI, PHINode *Merge, 5773 Value *&C, Value *&LHS, Value *&RHS) { 5774 C = BI->getCondition(); 5775 5776 BasicBlockEdge LeftEdge(BI->getParent(), BI->getSuccessor(0)); 5777 BasicBlockEdge RightEdge(BI->getParent(), BI->getSuccessor(1)); 5778 5779 if (!LeftEdge.isSingleEdge()) 5780 return false; 5781 5782 assert(RightEdge.isSingleEdge() && "Follows from LeftEdge.isSingleEdge()"); 5783 5784 Use &LeftUse = Merge->getOperandUse(0); 5785 Use &RightUse = Merge->getOperandUse(1); 5786 5787 if (DT.dominates(LeftEdge, LeftUse) && DT.dominates(RightEdge, RightUse)) { 5788 LHS = LeftUse; 5789 RHS = RightUse; 5790 return true; 5791 } 5792 5793 if (DT.dominates(LeftEdge, RightUse) && DT.dominates(RightEdge, LeftUse)) { 5794 LHS = RightUse; 5795 RHS = LeftUse; 5796 return true; 5797 } 5798 5799 return false; 5800 } 5801 5802 const SCEV *ScalarEvolution::createNodeFromSelectLikePHI(PHINode *PN) { 5803 auto IsReachable = 5804 [&](BasicBlock *BB) { return DT.isReachableFromEntry(BB); }; 5805 if (PN->getNumIncomingValues() == 2 && all_of(PN->blocks(), IsReachable)) { 5806 const Loop *L = LI.getLoopFor(PN->getParent()); 5807 5808 // We don't want to break LCSSA, even in a SCEV expression tree. 5809 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) 5810 if (LI.getLoopFor(PN->getIncomingBlock(i)) != L) 5811 return nullptr; 5812 5813 // Try to match 5814 // 5815 // br %cond, label %left, label %right 5816 // left: 5817 // br label %merge 5818 // right: 5819 // br label %merge 5820 // merge: 5821 // V = phi [ %x, %left ], [ %y, %right ] 5822 // 5823 // as "select %cond, %x, %y" 5824 5825 BasicBlock *IDom = DT[PN->getParent()]->getIDom()->getBlock(); 5826 assert(IDom && "At least the entry block should dominate PN"); 5827 5828 auto *BI = dyn_cast<BranchInst>(IDom->getTerminator()); 5829 Value *Cond = nullptr, *LHS = nullptr, *RHS = nullptr; 5830 5831 if (BI && BI->isConditional() && 5832 BrPHIToSelect(DT, BI, PN, Cond, LHS, RHS) && 5833 IsAvailableOnEntry(L, DT, getSCEV(LHS), PN->getParent()) && 5834 IsAvailableOnEntry(L, DT, getSCEV(RHS), PN->getParent())) 5835 return createNodeForSelectOrPHI(PN, Cond, LHS, RHS); 5836 } 5837 5838 return nullptr; 5839 } 5840 5841 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) { 5842 if (const SCEV *S = createAddRecFromPHI(PN)) 5843 return S; 5844 5845 if (const SCEV *S = createNodeFromSelectLikePHI(PN)) 5846 return S; 5847 5848 // If the PHI has a single incoming value, follow that value, unless the 5849 // PHI's incoming blocks are in a different loop, in which case doing so 5850 // risks breaking LCSSA form. Instcombine would normally zap these, but 5851 // it doesn't have DominatorTree information, so it may miss cases. 5852 if (Value *V = SimplifyInstruction(PN, {getDataLayout(), &TLI, &DT, &AC})) 5853 if (LI.replacementPreservesLCSSAForm(PN, V)) 5854 return getSCEV(V); 5855 5856 // If it's not a loop phi, we can't handle it yet. 5857 return getUnknown(PN); 5858 } 5859 5860 bool SCEVMinMaxExprContains(const SCEV *Root, const SCEV *OperandToFind, 5861 SCEVTypes RootKind) { 5862 struct FindClosure { 5863 const SCEV *OperandToFind; 5864 const SCEVTypes RootKind; // Must be a sequential min/max expression. 5865 const SCEVTypes NonSequentialRootKind; // Non-seq variant of RootKind. 5866 5867 bool Found = false; 5868 5869 bool canRecurseInto(SCEVTypes Kind) const { 5870 // We can only recurse into the SCEV expression of the same effective type 5871 // as the type of our root SCEV expression, and into zero-extensions. 5872 return RootKind == Kind || NonSequentialRootKind == Kind || 5873 scZeroExtend == Kind; 5874 }; 5875 5876 FindClosure(const SCEV *OperandToFind, SCEVTypes RootKind) 5877 : OperandToFind(OperandToFind), RootKind(RootKind), 5878 NonSequentialRootKind( 5879 SCEVSequentialMinMaxExpr::getEquivalentNonSequentialSCEVType( 5880 RootKind)) {} 5881 5882 bool follow(const SCEV *S) { 5883 Found = S == OperandToFind; 5884 5885 return !isDone() && canRecurseInto(S->getSCEVType()); 5886 } 5887 5888 bool isDone() const { return Found; } 5889 }; 5890 5891 FindClosure FC(OperandToFind, RootKind); 5892 visitAll(Root, FC); 5893 return FC.Found; 5894 } 5895 5896 const SCEV *ScalarEvolution::createNodeForSelectOrPHIInstWithICmpInstCond( 5897 Instruction *I, ICmpInst *Cond, Value *TrueVal, Value *FalseVal) { 5898 // Try to match some simple smax or umax patterns. 5899 auto *ICI = Cond; 5900 5901 Value *LHS = ICI->getOperand(0); 5902 Value *RHS = ICI->getOperand(1); 5903 5904 switch (ICI->getPredicate()) { 5905 case ICmpInst::ICMP_SLT: 5906 case ICmpInst::ICMP_SLE: 5907 case ICmpInst::ICMP_ULT: 5908 case ICmpInst::ICMP_ULE: 5909 std::swap(LHS, RHS); 5910 LLVM_FALLTHROUGH; 5911 case ICmpInst::ICMP_SGT: 5912 case ICmpInst::ICMP_SGE: 5913 case ICmpInst::ICMP_UGT: 5914 case ICmpInst::ICMP_UGE: 5915 // a > b ? a+x : b+x -> max(a, b)+x 5916 // a > b ? b+x : a+x -> min(a, b)+x 5917 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) { 5918 bool Signed = ICI->isSigned(); 5919 const SCEV *LA = getSCEV(TrueVal); 5920 const SCEV *RA = getSCEV(FalseVal); 5921 const SCEV *LS = getSCEV(LHS); 5922 const SCEV *RS = getSCEV(RHS); 5923 if (LA->getType()->isPointerTy()) { 5924 // FIXME: Handle cases where LS/RS are pointers not equal to LA/RA. 5925 // Need to make sure we can't produce weird expressions involving 5926 // negated pointers. 5927 if (LA == LS && RA == RS) 5928 return Signed ? getSMaxExpr(LS, RS) : getUMaxExpr(LS, RS); 5929 if (LA == RS && RA == LS) 5930 return Signed ? getSMinExpr(LS, RS) : getUMinExpr(LS, RS); 5931 } 5932 auto CoerceOperand = [&](const SCEV *Op) -> const SCEV * { 5933 if (Op->getType()->isPointerTy()) { 5934 Op = getLosslessPtrToIntExpr(Op); 5935 if (isa<SCEVCouldNotCompute>(Op)) 5936 return Op; 5937 } 5938 if (Signed) 5939 Op = getNoopOrSignExtend(Op, I->getType()); 5940 else 5941 Op = getNoopOrZeroExtend(Op, I->getType()); 5942 return Op; 5943 }; 5944 LS = CoerceOperand(LS); 5945 RS = CoerceOperand(RS); 5946 if (isa<SCEVCouldNotCompute>(LS) || isa<SCEVCouldNotCompute>(RS)) 5947 break; 5948 const SCEV *LDiff = getMinusSCEV(LA, LS); 5949 const SCEV *RDiff = getMinusSCEV(RA, RS); 5950 if (LDiff == RDiff) 5951 return getAddExpr(Signed ? getSMaxExpr(LS, RS) : getUMaxExpr(LS, RS), 5952 LDiff); 5953 LDiff = getMinusSCEV(LA, RS); 5954 RDiff = getMinusSCEV(RA, LS); 5955 if (LDiff == RDiff) 5956 return getAddExpr(Signed ? getSMinExpr(LS, RS) : getUMinExpr(LS, RS), 5957 LDiff); 5958 } 5959 break; 5960 case ICmpInst::ICMP_NE: 5961 // x != 0 ? x+y : C+y -> x == 0 ? C+y : x+y 5962 std::swap(TrueVal, FalseVal); 5963 LLVM_FALLTHROUGH; 5964 case ICmpInst::ICMP_EQ: 5965 // x == 0 ? C+y : x+y -> umax(x, C)+y iff C u<= 1 5966 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) && 5967 isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) { 5968 const SCEV *X = getNoopOrZeroExtend(getSCEV(LHS), I->getType()); 5969 const SCEV *TrueValExpr = getSCEV(TrueVal); // C+y 5970 const SCEV *FalseValExpr = getSCEV(FalseVal); // x+y 5971 const SCEV *Y = getMinusSCEV(FalseValExpr, X); // y = (x+y)-x 5972 const SCEV *C = getMinusSCEV(TrueValExpr, Y); // C = (C+y)-y 5973 if (isa<SCEVConstant>(C) && cast<SCEVConstant>(C)->getAPInt().ule(1)) 5974 return getAddExpr(getUMaxExpr(X, C), Y); 5975 } 5976 // x == 0 ? 0 : umin (..., x, ...) -> umin_seq(x, umin (...)) 5977 // x == 0 ? 0 : umin_seq(..., x, ...) -> umin_seq(x, umin_seq(...)) 5978 // x == 0 ? 0 : umin (..., umin_seq(..., x, ...), ...) 5979 // -> umin_seq(x, umin (..., umin_seq(...), ...)) 5980 if (isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero() && 5981 isa<ConstantInt>(TrueVal) && cast<ConstantInt>(TrueVal)->isZero()) { 5982 const SCEV *X = getSCEV(LHS); 5983 while (auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(X)) 5984 X = ZExt->getOperand(); 5985 if (getTypeSizeInBits(X->getType()) <= getTypeSizeInBits(I->getType())) { 5986 const SCEV *FalseValExpr = getSCEV(FalseVal); 5987 if (SCEVMinMaxExprContains(FalseValExpr, X, scSequentialUMinExpr)) 5988 return getUMinExpr(getNoopOrZeroExtend(X, I->getType()), FalseValExpr, 5989 /*Sequential=*/true); 5990 } 5991 } 5992 break; 5993 default: 5994 break; 5995 } 5996 5997 return getUnknown(I); 5998 } 5999 6000 static Optional<const SCEV *> 6001 createNodeForSelectViaUMinSeq(ScalarEvolution *SE, const SCEV *CondExpr, 6002 const SCEV *TrueExpr, const SCEV *FalseExpr) { 6003 assert(CondExpr->getType()->isIntegerTy(1) && 6004 TrueExpr->getType() == FalseExpr->getType() && 6005 TrueExpr->getType()->isIntegerTy(1) && 6006 "Unexpected operands of a select."); 6007 6008 // i1 cond ? i1 x : i1 C --> C + (i1 cond ? (i1 x - i1 C) : i1 0) 6009 // --> C + (umin_seq cond, x - C) 6010 // 6011 // i1 cond ? i1 C : i1 x --> C + (i1 cond ? i1 0 : (i1 x - i1 C)) 6012 // --> C + (i1 ~cond ? (i1 x - i1 C) : i1 0) 6013 // --> C + (umin_seq ~cond, x - C) 6014 6015 // FIXME: while we can't legally model the case where both of the hands 6016 // are fully variable, we only require that the *difference* is constant. 6017 if (!isa<SCEVConstant>(TrueExpr) && !isa<SCEVConstant>(FalseExpr)) 6018 return None; 6019 6020 const SCEV *X, *C; 6021 if (isa<SCEVConstant>(TrueExpr)) { 6022 CondExpr = SE->getNotSCEV(CondExpr); 6023 X = FalseExpr; 6024 C = TrueExpr; 6025 } else { 6026 X = TrueExpr; 6027 C = FalseExpr; 6028 } 6029 return SE->getAddExpr(C, SE->getUMinExpr(CondExpr, SE->getMinusSCEV(X, C), 6030 /*Sequential=*/true)); 6031 } 6032 6033 static Optional<const SCEV *> createNodeForSelectViaUMinSeq(ScalarEvolution *SE, 6034 Value *Cond, 6035 Value *TrueVal, 6036 Value *FalseVal) { 6037 if (!isa<ConstantInt>(TrueVal) && !isa<ConstantInt>(FalseVal)) 6038 return None; 6039 6040 return createNodeForSelectViaUMinSeq( 6041 SE, SE->getSCEV(Cond), SE->getSCEV(TrueVal), SE->getSCEV(FalseVal)); 6042 } 6043 6044 const SCEV *ScalarEvolution::createNodeForSelectOrPHIViaUMinSeq( 6045 Value *V, Value *Cond, Value *TrueVal, Value *FalseVal) { 6046 assert(Cond->getType()->isIntegerTy(1) && "Select condition is not an i1?"); 6047 assert(TrueVal->getType() == FalseVal->getType() && 6048 V->getType() == TrueVal->getType() && 6049 "Types of select hands and of the result must match."); 6050 6051 // For now, only deal with i1-typed `select`s. 6052 if (!V->getType()->isIntegerTy(1)) 6053 return getUnknown(V); 6054 6055 if (Optional<const SCEV *> S = 6056 createNodeForSelectViaUMinSeq(this, Cond, TrueVal, FalseVal)) 6057 return *S; 6058 6059 return getUnknown(V); 6060 } 6061 6062 const SCEV *ScalarEvolution::createNodeForSelectOrPHI(Value *V, Value *Cond, 6063 Value *TrueVal, 6064 Value *FalseVal) { 6065 // Handle "constant" branch or select. This can occur for instance when a 6066 // loop pass transforms an inner loop and moves on to process the outer loop. 6067 if (auto *CI = dyn_cast<ConstantInt>(Cond)) 6068 return getSCEV(CI->isOne() ? TrueVal : FalseVal); 6069 6070 if (auto *I = dyn_cast<Instruction>(V)) { 6071 if (auto *ICI = dyn_cast<ICmpInst>(Cond)) { 6072 const SCEV *S = createNodeForSelectOrPHIInstWithICmpInstCond( 6073 I, ICI, TrueVal, FalseVal); 6074 if (!isa<SCEVUnknown>(S)) 6075 return S; 6076 } 6077 } 6078 6079 return createNodeForSelectOrPHIViaUMinSeq(V, Cond, TrueVal, FalseVal); 6080 } 6081 6082 /// Expand GEP instructions into add and multiply operations. This allows them 6083 /// to be analyzed by regular SCEV code. 6084 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) { 6085 // Don't attempt to analyze GEPs over unsized objects. 6086 if (!GEP->getSourceElementType()->isSized()) 6087 return getUnknown(GEP); 6088 6089 SmallVector<const SCEV *, 4> IndexExprs; 6090 for (Value *Index : GEP->indices()) 6091 IndexExprs.push_back(getSCEV(Index)); 6092 return getGEPExpr(GEP, IndexExprs); 6093 } 6094 6095 uint32_t ScalarEvolution::GetMinTrailingZerosImpl(const SCEV *S) { 6096 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) 6097 return C->getAPInt().countTrailingZeros(); 6098 6099 if (const SCEVPtrToIntExpr *I = dyn_cast<SCEVPtrToIntExpr>(S)) 6100 return GetMinTrailingZeros(I->getOperand()); 6101 6102 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S)) 6103 return std::min(GetMinTrailingZeros(T->getOperand()), 6104 (uint32_t)getTypeSizeInBits(T->getType())); 6105 6106 if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) { 6107 uint32_t OpRes = GetMinTrailingZeros(E->getOperand()); 6108 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) 6109 ? getTypeSizeInBits(E->getType()) 6110 : OpRes; 6111 } 6112 6113 if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) { 6114 uint32_t OpRes = GetMinTrailingZeros(E->getOperand()); 6115 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) 6116 ? getTypeSizeInBits(E->getType()) 6117 : OpRes; 6118 } 6119 6120 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) { 6121 // The result is the min of all operands results. 6122 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0)); 6123 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i) 6124 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i))); 6125 return MinOpRes; 6126 } 6127 6128 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) { 6129 // The result is the sum of all operands results. 6130 uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0)); 6131 uint32_t BitWidth = getTypeSizeInBits(M->getType()); 6132 for (unsigned i = 1, e = M->getNumOperands(); 6133 SumOpRes != BitWidth && i != e; ++i) 6134 SumOpRes = 6135 std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)), BitWidth); 6136 return SumOpRes; 6137 } 6138 6139 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) { 6140 // The result is the min of all operands results. 6141 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0)); 6142 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i) 6143 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i))); 6144 return MinOpRes; 6145 } 6146 6147 if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) { 6148 // The result is the min of all operands results. 6149 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0)); 6150 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i) 6151 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i))); 6152 return MinOpRes; 6153 } 6154 6155 if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) { 6156 // The result is the min of all operands results. 6157 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0)); 6158 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i) 6159 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i))); 6160 return MinOpRes; 6161 } 6162 6163 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) { 6164 // For a SCEVUnknown, ask ValueTracking. 6165 KnownBits Known = computeKnownBits(U->getValue(), getDataLayout(), 0, &AC, nullptr, &DT); 6166 return Known.countMinTrailingZeros(); 6167 } 6168 6169 // SCEVUDivExpr 6170 return 0; 6171 } 6172 6173 uint32_t ScalarEvolution::GetMinTrailingZeros(const SCEV *S) { 6174 auto I = MinTrailingZerosCache.find(S); 6175 if (I != MinTrailingZerosCache.end()) 6176 return I->second; 6177 6178 uint32_t Result = GetMinTrailingZerosImpl(S); 6179 auto InsertPair = MinTrailingZerosCache.insert({S, Result}); 6180 assert(InsertPair.second && "Should insert a new key"); 6181 return InsertPair.first->second; 6182 } 6183 6184 /// Helper method to assign a range to V from metadata present in the IR. 6185 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) { 6186 if (Instruction *I = dyn_cast<Instruction>(V)) 6187 if (MDNode *MD = I->getMetadata(LLVMContext::MD_range)) 6188 return getConstantRangeFromMetadata(*MD); 6189 6190 return None; 6191 } 6192 6193 void ScalarEvolution::setNoWrapFlags(SCEVAddRecExpr *AddRec, 6194 SCEV::NoWrapFlags Flags) { 6195 if (AddRec->getNoWrapFlags(Flags) != Flags) { 6196 AddRec->setNoWrapFlags(Flags); 6197 UnsignedRanges.erase(AddRec); 6198 SignedRanges.erase(AddRec); 6199 } 6200 } 6201 6202 ConstantRange ScalarEvolution:: 6203 getRangeForUnknownRecurrence(const SCEVUnknown *U) { 6204 const DataLayout &DL = getDataLayout(); 6205 6206 unsigned BitWidth = getTypeSizeInBits(U->getType()); 6207 const ConstantRange FullSet(BitWidth, /*isFullSet=*/true); 6208 6209 // Match a simple recurrence of the form: <start, ShiftOp, Step>, and then 6210 // use information about the trip count to improve our available range. Note 6211 // that the trip count independent cases are already handled by known bits. 6212 // WARNING: The definition of recurrence used here is subtly different than 6213 // the one used by AddRec (and thus most of this file). Step is allowed to 6214 // be arbitrarily loop varying here, where AddRec allows only loop invariant 6215 // and other addrecs in the same loop (for non-affine addrecs). The code 6216 // below intentionally handles the case where step is not loop invariant. 6217 auto *P = dyn_cast<PHINode>(U->getValue()); 6218 if (!P) 6219 return FullSet; 6220 6221 // Make sure that no Phi input comes from an unreachable block. Otherwise, 6222 // even the values that are not available in these blocks may come from them, 6223 // and this leads to false-positive recurrence test. 6224 for (auto *Pred : predecessors(P->getParent())) 6225 if (!DT.isReachableFromEntry(Pred)) 6226 return FullSet; 6227 6228 BinaryOperator *BO; 6229 Value *Start, *Step; 6230 if (!matchSimpleRecurrence(P, BO, Start, Step)) 6231 return FullSet; 6232 6233 // If we found a recurrence in reachable code, we must be in a loop. Note 6234 // that BO might be in some subloop of L, and that's completely okay. 6235 auto *L = LI.getLoopFor(P->getParent()); 6236 assert(L && L->getHeader() == P->getParent()); 6237 if (!L->contains(BO->getParent())) 6238 // NOTE: This bailout should be an assert instead. However, asserting 6239 // the condition here exposes a case where LoopFusion is querying SCEV 6240 // with malformed loop information during the midst of the transform. 6241 // There doesn't appear to be an obvious fix, so for the moment bailout 6242 // until the caller issue can be fixed. PR49566 tracks the bug. 6243 return FullSet; 6244 6245 // TODO: Extend to other opcodes such as mul, and div 6246 switch (BO->getOpcode()) { 6247 default: 6248 return FullSet; 6249 case Instruction::AShr: 6250 case Instruction::LShr: 6251 case Instruction::Shl: 6252 break; 6253 }; 6254 6255 if (BO->getOperand(0) != P) 6256 // TODO: Handle the power function forms some day. 6257 return FullSet; 6258 6259 unsigned TC = getSmallConstantMaxTripCount(L); 6260 if (!TC || TC >= BitWidth) 6261 return FullSet; 6262 6263 auto KnownStart = computeKnownBits(Start, DL, 0, &AC, nullptr, &DT); 6264 auto KnownStep = computeKnownBits(Step, DL, 0, &AC, nullptr, &DT); 6265 assert(KnownStart.getBitWidth() == BitWidth && 6266 KnownStep.getBitWidth() == BitWidth); 6267 6268 // Compute total shift amount, being careful of overflow and bitwidths. 6269 auto MaxShiftAmt = KnownStep.getMaxValue(); 6270 APInt TCAP(BitWidth, TC-1); 6271 bool Overflow = false; 6272 auto TotalShift = MaxShiftAmt.umul_ov(TCAP, Overflow); 6273 if (Overflow) 6274 return FullSet; 6275 6276 switch (BO->getOpcode()) { 6277 default: 6278 llvm_unreachable("filtered out above"); 6279 case Instruction::AShr: { 6280 // For each ashr, three cases: 6281 // shift = 0 => unchanged value 6282 // saturation => 0 or -1 6283 // other => a value closer to zero (of the same sign) 6284 // Thus, the end value is closer to zero than the start. 6285 auto KnownEnd = KnownBits::ashr(KnownStart, 6286 KnownBits::makeConstant(TotalShift)); 6287 if (KnownStart.isNonNegative()) 6288 // Analogous to lshr (simply not yet canonicalized) 6289 return ConstantRange::getNonEmpty(KnownEnd.getMinValue(), 6290 KnownStart.getMaxValue() + 1); 6291 if (KnownStart.isNegative()) 6292 // End >=u Start && End <=s Start 6293 return ConstantRange::getNonEmpty(KnownStart.getMinValue(), 6294 KnownEnd.getMaxValue() + 1); 6295 break; 6296 } 6297 case Instruction::LShr: { 6298 // For each lshr, three cases: 6299 // shift = 0 => unchanged value 6300 // saturation => 0 6301 // other => a smaller positive number 6302 // Thus, the low end of the unsigned range is the last value produced. 6303 auto KnownEnd = KnownBits::lshr(KnownStart, 6304 KnownBits::makeConstant(TotalShift)); 6305 return ConstantRange::getNonEmpty(KnownEnd.getMinValue(), 6306 KnownStart.getMaxValue() + 1); 6307 } 6308 case Instruction::Shl: { 6309 // Iff no bits are shifted out, value increases on every shift. 6310 auto KnownEnd = KnownBits::shl(KnownStart, 6311 KnownBits::makeConstant(TotalShift)); 6312 if (TotalShift.ult(KnownStart.countMinLeadingZeros())) 6313 return ConstantRange(KnownStart.getMinValue(), 6314 KnownEnd.getMaxValue() + 1); 6315 break; 6316 } 6317 }; 6318 return FullSet; 6319 } 6320 6321 /// Determine the range for a particular SCEV. If SignHint is 6322 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges 6323 /// with a "cleaner" unsigned (resp. signed) representation. 6324 const ConstantRange & 6325 ScalarEvolution::getRangeRef(const SCEV *S, 6326 ScalarEvolution::RangeSignHint SignHint) { 6327 DenseMap<const SCEV *, ConstantRange> &Cache = 6328 SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges 6329 : SignedRanges; 6330 ConstantRange::PreferredRangeType RangeType = 6331 SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED 6332 ? ConstantRange::Unsigned : ConstantRange::Signed; 6333 6334 // See if we've computed this range already. 6335 DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S); 6336 if (I != Cache.end()) 6337 return I->second; 6338 6339 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) 6340 return setRange(C, SignHint, ConstantRange(C->getAPInt())); 6341 6342 unsigned BitWidth = getTypeSizeInBits(S->getType()); 6343 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true); 6344 using OBO = OverflowingBinaryOperator; 6345 6346 // If the value has known zeros, the maximum value will have those known zeros 6347 // as well. 6348 uint32_t TZ = GetMinTrailingZeros(S); 6349 if (TZ != 0) { 6350 if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) 6351 ConservativeResult = 6352 ConstantRange(APInt::getMinValue(BitWidth), 6353 APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1); 6354 else 6355 ConservativeResult = ConstantRange( 6356 APInt::getSignedMinValue(BitWidth), 6357 APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1); 6358 } 6359 6360 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) { 6361 ConstantRange X = getRangeRef(Add->getOperand(0), SignHint); 6362 unsigned WrapType = OBO::AnyWrap; 6363 if (Add->hasNoSignedWrap()) 6364 WrapType |= OBO::NoSignedWrap; 6365 if (Add->hasNoUnsignedWrap()) 6366 WrapType |= OBO::NoUnsignedWrap; 6367 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i) 6368 X = X.addWithNoWrap(getRangeRef(Add->getOperand(i), SignHint), 6369 WrapType, RangeType); 6370 return setRange(Add, SignHint, 6371 ConservativeResult.intersectWith(X, RangeType)); 6372 } 6373 6374 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) { 6375 ConstantRange X = getRangeRef(Mul->getOperand(0), SignHint); 6376 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i) 6377 X = X.multiply(getRangeRef(Mul->getOperand(i), SignHint)); 6378 return setRange(Mul, SignHint, 6379 ConservativeResult.intersectWith(X, RangeType)); 6380 } 6381 6382 if (isa<SCEVMinMaxExpr>(S) || isa<SCEVSequentialMinMaxExpr>(S)) { 6383 Intrinsic::ID ID; 6384 switch (S->getSCEVType()) { 6385 case scUMaxExpr: 6386 ID = Intrinsic::umax; 6387 break; 6388 case scSMaxExpr: 6389 ID = Intrinsic::smax; 6390 break; 6391 case scUMinExpr: 6392 case scSequentialUMinExpr: 6393 ID = Intrinsic::umin; 6394 break; 6395 case scSMinExpr: 6396 ID = Intrinsic::smin; 6397 break; 6398 default: 6399 llvm_unreachable("Unknown SCEVMinMaxExpr/SCEVSequentialMinMaxExpr."); 6400 } 6401 6402 const auto *NAry = cast<SCEVNAryExpr>(S); 6403 ConstantRange X = getRangeRef(NAry->getOperand(0), SignHint); 6404 for (unsigned i = 1, e = NAry->getNumOperands(); i != e; ++i) 6405 X = X.intrinsic(ID, {X, getRangeRef(NAry->getOperand(i), SignHint)}); 6406 return setRange(S, SignHint, 6407 ConservativeResult.intersectWith(X, RangeType)); 6408 } 6409 6410 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) { 6411 ConstantRange X = getRangeRef(UDiv->getLHS(), SignHint); 6412 ConstantRange Y = getRangeRef(UDiv->getRHS(), SignHint); 6413 return setRange(UDiv, SignHint, 6414 ConservativeResult.intersectWith(X.udiv(Y), RangeType)); 6415 } 6416 6417 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) { 6418 ConstantRange X = getRangeRef(ZExt->getOperand(), SignHint); 6419 return setRange(ZExt, SignHint, 6420 ConservativeResult.intersectWith(X.zeroExtend(BitWidth), 6421 RangeType)); 6422 } 6423 6424 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) { 6425 ConstantRange X = getRangeRef(SExt->getOperand(), SignHint); 6426 return setRange(SExt, SignHint, 6427 ConservativeResult.intersectWith(X.signExtend(BitWidth), 6428 RangeType)); 6429 } 6430 6431 if (const SCEVPtrToIntExpr *PtrToInt = dyn_cast<SCEVPtrToIntExpr>(S)) { 6432 ConstantRange X = getRangeRef(PtrToInt->getOperand(), SignHint); 6433 return setRange(PtrToInt, SignHint, X); 6434 } 6435 6436 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) { 6437 ConstantRange X = getRangeRef(Trunc->getOperand(), SignHint); 6438 return setRange(Trunc, SignHint, 6439 ConservativeResult.intersectWith(X.truncate(BitWidth), 6440 RangeType)); 6441 } 6442 6443 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) { 6444 // If there's no unsigned wrap, the value will never be less than its 6445 // initial value. 6446 if (AddRec->hasNoUnsignedWrap()) { 6447 APInt UnsignedMinValue = getUnsignedRangeMin(AddRec->getStart()); 6448 if (!UnsignedMinValue.isZero()) 6449 ConservativeResult = ConservativeResult.intersectWith( 6450 ConstantRange(UnsignedMinValue, APInt(BitWidth, 0)), RangeType); 6451 } 6452 6453 // If there's no signed wrap, and all the operands except initial value have 6454 // the same sign or zero, the value won't ever be: 6455 // 1: smaller than initial value if operands are non negative, 6456 // 2: bigger than initial value if operands are non positive. 6457 // For both cases, value can not cross signed min/max boundary. 6458 if (AddRec->hasNoSignedWrap()) { 6459 bool AllNonNeg = true; 6460 bool AllNonPos = true; 6461 for (unsigned i = 1, e = AddRec->getNumOperands(); i != e; ++i) { 6462 if (!isKnownNonNegative(AddRec->getOperand(i))) 6463 AllNonNeg = false; 6464 if (!isKnownNonPositive(AddRec->getOperand(i))) 6465 AllNonPos = false; 6466 } 6467 if (AllNonNeg) 6468 ConservativeResult = ConservativeResult.intersectWith( 6469 ConstantRange::getNonEmpty(getSignedRangeMin(AddRec->getStart()), 6470 APInt::getSignedMinValue(BitWidth)), 6471 RangeType); 6472 else if (AllNonPos) 6473 ConservativeResult = ConservativeResult.intersectWith( 6474 ConstantRange::getNonEmpty( 6475 APInt::getSignedMinValue(BitWidth), 6476 getSignedRangeMax(AddRec->getStart()) + 1), 6477 RangeType); 6478 } 6479 6480 // TODO: non-affine addrec 6481 if (AddRec->isAffine()) { 6482 const SCEV *MaxBECount = getConstantMaxBackedgeTakenCount(AddRec->getLoop()); 6483 if (!isa<SCEVCouldNotCompute>(MaxBECount) && 6484 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) { 6485 auto RangeFromAffine = getRangeForAffineAR( 6486 AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount, 6487 BitWidth); 6488 ConservativeResult = 6489 ConservativeResult.intersectWith(RangeFromAffine, RangeType); 6490 6491 auto RangeFromFactoring = getRangeViaFactoring( 6492 AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount, 6493 BitWidth); 6494 ConservativeResult = 6495 ConservativeResult.intersectWith(RangeFromFactoring, RangeType); 6496 } 6497 6498 // Now try symbolic BE count and more powerful methods. 6499 if (UseExpensiveRangeSharpening) { 6500 const SCEV *SymbolicMaxBECount = 6501 getSymbolicMaxBackedgeTakenCount(AddRec->getLoop()); 6502 if (!isa<SCEVCouldNotCompute>(SymbolicMaxBECount) && 6503 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth && 6504 AddRec->hasNoSelfWrap()) { 6505 auto RangeFromAffineNew = getRangeForAffineNoSelfWrappingAR( 6506 AddRec, SymbolicMaxBECount, BitWidth, SignHint); 6507 ConservativeResult = 6508 ConservativeResult.intersectWith(RangeFromAffineNew, RangeType); 6509 } 6510 } 6511 } 6512 6513 return setRange(AddRec, SignHint, std::move(ConservativeResult)); 6514 } 6515 6516 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) { 6517 6518 // Check if the IR explicitly contains !range metadata. 6519 Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue()); 6520 if (MDRange.hasValue()) 6521 ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue(), 6522 RangeType); 6523 6524 // Use facts about recurrences in the underlying IR. Note that add 6525 // recurrences are AddRecExprs and thus don't hit this path. This 6526 // primarily handles shift recurrences. 6527 auto CR = getRangeForUnknownRecurrence(U); 6528 ConservativeResult = ConservativeResult.intersectWith(CR); 6529 6530 // See if ValueTracking can give us a useful range. 6531 const DataLayout &DL = getDataLayout(); 6532 KnownBits Known = computeKnownBits(U->getValue(), DL, 0, &AC, nullptr, &DT); 6533 if (Known.getBitWidth() != BitWidth) 6534 Known = Known.zextOrTrunc(BitWidth); 6535 6536 // ValueTracking may be able to compute a tighter result for the number of 6537 // sign bits than for the value of those sign bits. 6538 unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, &AC, nullptr, &DT); 6539 if (U->getType()->isPointerTy()) { 6540 // If the pointer size is larger than the index size type, this can cause 6541 // NS to be larger than BitWidth. So compensate for this. 6542 unsigned ptrSize = DL.getPointerTypeSizeInBits(U->getType()); 6543 int ptrIdxDiff = ptrSize - BitWidth; 6544 if (ptrIdxDiff > 0 && ptrSize > BitWidth && NS > (unsigned)ptrIdxDiff) 6545 NS -= ptrIdxDiff; 6546 } 6547 6548 if (NS > 1) { 6549 // If we know any of the sign bits, we know all of the sign bits. 6550 if (!Known.Zero.getHiBits(NS).isZero()) 6551 Known.Zero.setHighBits(NS); 6552 if (!Known.One.getHiBits(NS).isZero()) 6553 Known.One.setHighBits(NS); 6554 } 6555 6556 if (Known.getMinValue() != Known.getMaxValue() + 1) 6557 ConservativeResult = ConservativeResult.intersectWith( 6558 ConstantRange(Known.getMinValue(), Known.getMaxValue() + 1), 6559 RangeType); 6560 if (NS > 1) 6561 ConservativeResult = ConservativeResult.intersectWith( 6562 ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1), 6563 APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1), 6564 RangeType); 6565 6566 // A range of Phi is a subset of union of all ranges of its input. 6567 if (const PHINode *Phi = dyn_cast<PHINode>(U->getValue())) { 6568 // Make sure that we do not run over cycled Phis. 6569 if (PendingPhiRanges.insert(Phi).second) { 6570 ConstantRange RangeFromOps(BitWidth, /*isFullSet=*/false); 6571 for (auto &Op : Phi->operands()) { 6572 auto OpRange = getRangeRef(getSCEV(Op), SignHint); 6573 RangeFromOps = RangeFromOps.unionWith(OpRange); 6574 // No point to continue if we already have a full set. 6575 if (RangeFromOps.isFullSet()) 6576 break; 6577 } 6578 ConservativeResult = 6579 ConservativeResult.intersectWith(RangeFromOps, RangeType); 6580 bool Erased = PendingPhiRanges.erase(Phi); 6581 assert(Erased && "Failed to erase Phi properly?"); 6582 (void) Erased; 6583 } 6584 } 6585 6586 return setRange(U, SignHint, std::move(ConservativeResult)); 6587 } 6588 6589 return setRange(S, SignHint, std::move(ConservativeResult)); 6590 } 6591 6592 // Given a StartRange, Step and MaxBECount for an expression compute a range of 6593 // values that the expression can take. Initially, the expression has a value 6594 // from StartRange and then is changed by Step up to MaxBECount times. Signed 6595 // argument defines if we treat Step as signed or unsigned. 6596 static ConstantRange getRangeForAffineARHelper(APInt Step, 6597 const ConstantRange &StartRange, 6598 const APInt &MaxBECount, 6599 unsigned BitWidth, bool Signed) { 6600 // If either Step or MaxBECount is 0, then the expression won't change, and we 6601 // just need to return the initial range. 6602 if (Step == 0 || MaxBECount == 0) 6603 return StartRange; 6604 6605 // If we don't know anything about the initial value (i.e. StartRange is 6606 // FullRange), then we don't know anything about the final range either. 6607 // Return FullRange. 6608 if (StartRange.isFullSet()) 6609 return ConstantRange::getFull(BitWidth); 6610 6611 // If Step is signed and negative, then we use its absolute value, but we also 6612 // note that we're moving in the opposite direction. 6613 bool Descending = Signed && Step.isNegative(); 6614 6615 if (Signed) 6616 // This is correct even for INT_SMIN. Let's look at i8 to illustrate this: 6617 // abs(INT_SMIN) = abs(-128) = abs(0x80) = -0x80 = 0x80 = 128. 6618 // This equations hold true due to the well-defined wrap-around behavior of 6619 // APInt. 6620 Step = Step.abs(); 6621 6622 // Check if Offset is more than full span of BitWidth. If it is, the 6623 // expression is guaranteed to overflow. 6624 if (APInt::getMaxValue(StartRange.getBitWidth()).udiv(Step).ult(MaxBECount)) 6625 return ConstantRange::getFull(BitWidth); 6626 6627 // Offset is by how much the expression can change. Checks above guarantee no 6628 // overflow here. 6629 APInt Offset = Step * MaxBECount; 6630 6631 // Minimum value of the final range will match the minimal value of StartRange 6632 // if the expression is increasing and will be decreased by Offset otherwise. 6633 // Maximum value of the final range will match the maximal value of StartRange 6634 // if the expression is decreasing and will be increased by Offset otherwise. 6635 APInt StartLower = StartRange.getLower(); 6636 APInt StartUpper = StartRange.getUpper() - 1; 6637 APInt MovedBoundary = Descending ? (StartLower - std::move(Offset)) 6638 : (StartUpper + std::move(Offset)); 6639 6640 // It's possible that the new minimum/maximum value will fall into the initial 6641 // range (due to wrap around). This means that the expression can take any 6642 // value in this bitwidth, and we have to return full range. 6643 if (StartRange.contains(MovedBoundary)) 6644 return ConstantRange::getFull(BitWidth); 6645 6646 APInt NewLower = 6647 Descending ? std::move(MovedBoundary) : std::move(StartLower); 6648 APInt NewUpper = 6649 Descending ? std::move(StartUpper) : std::move(MovedBoundary); 6650 NewUpper += 1; 6651 6652 // No overflow detected, return [StartLower, StartUpper + Offset + 1) range. 6653 return ConstantRange::getNonEmpty(std::move(NewLower), std::move(NewUpper)); 6654 } 6655 6656 ConstantRange ScalarEvolution::getRangeForAffineAR(const SCEV *Start, 6657 const SCEV *Step, 6658 const SCEV *MaxBECount, 6659 unsigned BitWidth) { 6660 assert(!isa<SCEVCouldNotCompute>(MaxBECount) && 6661 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth && 6662 "Precondition!"); 6663 6664 MaxBECount = getNoopOrZeroExtend(MaxBECount, Start->getType()); 6665 APInt MaxBECountValue = getUnsignedRangeMax(MaxBECount); 6666 6667 // First, consider step signed. 6668 ConstantRange StartSRange = getSignedRange(Start); 6669 ConstantRange StepSRange = getSignedRange(Step); 6670 6671 // If Step can be both positive and negative, we need to find ranges for the 6672 // maximum absolute step values in both directions and union them. 6673 ConstantRange SR = 6674 getRangeForAffineARHelper(StepSRange.getSignedMin(), StartSRange, 6675 MaxBECountValue, BitWidth, /* Signed = */ true); 6676 SR = SR.unionWith(getRangeForAffineARHelper(StepSRange.getSignedMax(), 6677 StartSRange, MaxBECountValue, 6678 BitWidth, /* Signed = */ true)); 6679 6680 // Next, consider step unsigned. 6681 ConstantRange UR = getRangeForAffineARHelper( 6682 getUnsignedRangeMax(Step), getUnsignedRange(Start), 6683 MaxBECountValue, BitWidth, /* Signed = */ false); 6684 6685 // Finally, intersect signed and unsigned ranges. 6686 return SR.intersectWith(UR, ConstantRange::Smallest); 6687 } 6688 6689 ConstantRange ScalarEvolution::getRangeForAffineNoSelfWrappingAR( 6690 const SCEVAddRecExpr *AddRec, const SCEV *MaxBECount, unsigned BitWidth, 6691 ScalarEvolution::RangeSignHint SignHint) { 6692 assert(AddRec->isAffine() && "Non-affine AddRecs are not suppored!\n"); 6693 assert(AddRec->hasNoSelfWrap() && 6694 "This only works for non-self-wrapping AddRecs!"); 6695 const bool IsSigned = SignHint == HINT_RANGE_SIGNED; 6696 const SCEV *Step = AddRec->getStepRecurrence(*this); 6697 // Only deal with constant step to save compile time. 6698 if (!isa<SCEVConstant>(Step)) 6699 return ConstantRange::getFull(BitWidth); 6700 // Let's make sure that we can prove that we do not self-wrap during 6701 // MaxBECount iterations. We need this because MaxBECount is a maximum 6702 // iteration count estimate, and we might infer nw from some exit for which we 6703 // do not know max exit count (or any other side reasoning). 6704 // TODO: Turn into assert at some point. 6705 if (getTypeSizeInBits(MaxBECount->getType()) > 6706 getTypeSizeInBits(AddRec->getType())) 6707 return ConstantRange::getFull(BitWidth); 6708 MaxBECount = getNoopOrZeroExtend(MaxBECount, AddRec->getType()); 6709 const SCEV *RangeWidth = getMinusOne(AddRec->getType()); 6710 const SCEV *StepAbs = getUMinExpr(Step, getNegativeSCEV(Step)); 6711 const SCEV *MaxItersWithoutWrap = getUDivExpr(RangeWidth, StepAbs); 6712 if (!isKnownPredicateViaConstantRanges(ICmpInst::ICMP_ULE, MaxBECount, 6713 MaxItersWithoutWrap)) 6714 return ConstantRange::getFull(BitWidth); 6715 6716 ICmpInst::Predicate LEPred = 6717 IsSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 6718 ICmpInst::Predicate GEPred = 6719 IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 6720 const SCEV *End = AddRec->evaluateAtIteration(MaxBECount, *this); 6721 6722 // We know that there is no self-wrap. Let's take Start and End values and 6723 // look at all intermediate values V1, V2, ..., Vn that IndVar takes during 6724 // the iteration. They either lie inside the range [Min(Start, End), 6725 // Max(Start, End)] or outside it: 6726 // 6727 // Case 1: RangeMin ... Start V1 ... VN End ... RangeMax; 6728 // Case 2: RangeMin Vk ... V1 Start ... End Vn ... Vk + 1 RangeMax; 6729 // 6730 // No self wrap flag guarantees that the intermediate values cannot be BOTH 6731 // outside and inside the range [Min(Start, End), Max(Start, End)]. Using that 6732 // knowledge, let's try to prove that we are dealing with Case 1. It is so if 6733 // Start <= End and step is positive, or Start >= End and step is negative. 6734 const SCEV *Start = AddRec->getStart(); 6735 ConstantRange StartRange = getRangeRef(Start, SignHint); 6736 ConstantRange EndRange = getRangeRef(End, SignHint); 6737 ConstantRange RangeBetween = StartRange.unionWith(EndRange); 6738 // If they already cover full iteration space, we will know nothing useful 6739 // even if we prove what we want to prove. 6740 if (RangeBetween.isFullSet()) 6741 return RangeBetween; 6742 // Only deal with ranges that do not wrap (i.e. RangeMin < RangeMax). 6743 bool IsWrappedSet = IsSigned ? RangeBetween.isSignWrappedSet() 6744 : RangeBetween.isWrappedSet(); 6745 if (IsWrappedSet) 6746 return ConstantRange::getFull(BitWidth); 6747 6748 if (isKnownPositive(Step) && 6749 isKnownPredicateViaConstantRanges(LEPred, Start, End)) 6750 return RangeBetween; 6751 else if (isKnownNegative(Step) && 6752 isKnownPredicateViaConstantRanges(GEPred, Start, End)) 6753 return RangeBetween; 6754 return ConstantRange::getFull(BitWidth); 6755 } 6756 6757 ConstantRange ScalarEvolution::getRangeViaFactoring(const SCEV *Start, 6758 const SCEV *Step, 6759 const SCEV *MaxBECount, 6760 unsigned BitWidth) { 6761 // RangeOf({C?A:B,+,C?P:Q}) == RangeOf(C?{A,+,P}:{B,+,Q}) 6762 // == RangeOf({A,+,P}) union RangeOf({B,+,Q}) 6763 6764 struct SelectPattern { 6765 Value *Condition = nullptr; 6766 APInt TrueValue; 6767 APInt FalseValue; 6768 6769 explicit SelectPattern(ScalarEvolution &SE, unsigned BitWidth, 6770 const SCEV *S) { 6771 Optional<unsigned> CastOp; 6772 APInt Offset(BitWidth, 0); 6773 6774 assert(SE.getTypeSizeInBits(S->getType()) == BitWidth && 6775 "Should be!"); 6776 6777 // Peel off a constant offset: 6778 if (auto *SA = dyn_cast<SCEVAddExpr>(S)) { 6779 // In the future we could consider being smarter here and handle 6780 // {Start+Step,+,Step} too. 6781 if (SA->getNumOperands() != 2 || !isa<SCEVConstant>(SA->getOperand(0))) 6782 return; 6783 6784 Offset = cast<SCEVConstant>(SA->getOperand(0))->getAPInt(); 6785 S = SA->getOperand(1); 6786 } 6787 6788 // Peel off a cast operation 6789 if (auto *SCast = dyn_cast<SCEVIntegralCastExpr>(S)) { 6790 CastOp = SCast->getSCEVType(); 6791 S = SCast->getOperand(); 6792 } 6793 6794 using namespace llvm::PatternMatch; 6795 6796 auto *SU = dyn_cast<SCEVUnknown>(S); 6797 const APInt *TrueVal, *FalseVal; 6798 if (!SU || 6799 !match(SU->getValue(), m_Select(m_Value(Condition), m_APInt(TrueVal), 6800 m_APInt(FalseVal)))) { 6801 Condition = nullptr; 6802 return; 6803 } 6804 6805 TrueValue = *TrueVal; 6806 FalseValue = *FalseVal; 6807 6808 // Re-apply the cast we peeled off earlier 6809 if (CastOp.hasValue()) 6810 switch (*CastOp) { 6811 default: 6812 llvm_unreachable("Unknown SCEV cast type!"); 6813 6814 case scTruncate: 6815 TrueValue = TrueValue.trunc(BitWidth); 6816 FalseValue = FalseValue.trunc(BitWidth); 6817 break; 6818 case scZeroExtend: 6819 TrueValue = TrueValue.zext(BitWidth); 6820 FalseValue = FalseValue.zext(BitWidth); 6821 break; 6822 case scSignExtend: 6823 TrueValue = TrueValue.sext(BitWidth); 6824 FalseValue = FalseValue.sext(BitWidth); 6825 break; 6826 } 6827 6828 // Re-apply the constant offset we peeled off earlier 6829 TrueValue += Offset; 6830 FalseValue += Offset; 6831 } 6832 6833 bool isRecognized() { return Condition != nullptr; } 6834 }; 6835 6836 SelectPattern StartPattern(*this, BitWidth, Start); 6837 if (!StartPattern.isRecognized()) 6838 return ConstantRange::getFull(BitWidth); 6839 6840 SelectPattern StepPattern(*this, BitWidth, Step); 6841 if (!StepPattern.isRecognized()) 6842 return ConstantRange::getFull(BitWidth); 6843 6844 if (StartPattern.Condition != StepPattern.Condition) { 6845 // We don't handle this case today; but we could, by considering four 6846 // possibilities below instead of two. I'm not sure if there are cases where 6847 // that will help over what getRange already does, though. 6848 return ConstantRange::getFull(BitWidth); 6849 } 6850 6851 // NB! Calling ScalarEvolution::getConstant is fine, but we should not try to 6852 // construct arbitrary general SCEV expressions here. This function is called 6853 // from deep in the call stack, and calling getSCEV (on a sext instruction, 6854 // say) can end up caching a suboptimal value. 6855 6856 // FIXME: without the explicit `this` receiver below, MSVC errors out with 6857 // C2352 and C2512 (otherwise it isn't needed). 6858 6859 const SCEV *TrueStart = this->getConstant(StartPattern.TrueValue); 6860 const SCEV *TrueStep = this->getConstant(StepPattern.TrueValue); 6861 const SCEV *FalseStart = this->getConstant(StartPattern.FalseValue); 6862 const SCEV *FalseStep = this->getConstant(StepPattern.FalseValue); 6863 6864 ConstantRange TrueRange = 6865 this->getRangeForAffineAR(TrueStart, TrueStep, MaxBECount, BitWidth); 6866 ConstantRange FalseRange = 6867 this->getRangeForAffineAR(FalseStart, FalseStep, MaxBECount, BitWidth); 6868 6869 return TrueRange.unionWith(FalseRange); 6870 } 6871 6872 SCEV::NoWrapFlags ScalarEvolution::getNoWrapFlagsFromUB(const Value *V) { 6873 if (isa<ConstantExpr>(V)) return SCEV::FlagAnyWrap; 6874 const BinaryOperator *BinOp = cast<BinaryOperator>(V); 6875 6876 // Return early if there are no flags to propagate to the SCEV. 6877 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 6878 if (BinOp->hasNoUnsignedWrap()) 6879 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW); 6880 if (BinOp->hasNoSignedWrap()) 6881 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW); 6882 if (Flags == SCEV::FlagAnyWrap) 6883 return SCEV::FlagAnyWrap; 6884 6885 return isSCEVExprNeverPoison(BinOp) ? Flags : SCEV::FlagAnyWrap; 6886 } 6887 6888 const Instruction * 6889 ScalarEvolution::getNonTrivialDefiningScopeBound(const SCEV *S) { 6890 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(S)) 6891 return &*AddRec->getLoop()->getHeader()->begin(); 6892 if (auto *U = dyn_cast<SCEVUnknown>(S)) 6893 if (auto *I = dyn_cast<Instruction>(U->getValue())) 6894 return I; 6895 return nullptr; 6896 } 6897 6898 /// Fills \p Ops with unique operands of \p S, if it has operands. If not, 6899 /// \p Ops remains unmodified. 6900 static void collectUniqueOps(const SCEV *S, 6901 SmallVectorImpl<const SCEV *> &Ops) { 6902 SmallPtrSet<const SCEV *, 4> Unique; 6903 auto InsertUnique = [&](const SCEV *S) { 6904 if (Unique.insert(S).second) 6905 Ops.push_back(S); 6906 }; 6907 if (auto *S2 = dyn_cast<SCEVCastExpr>(S)) 6908 for (auto *Op : S2->operands()) 6909 InsertUnique(Op); 6910 else if (auto *S2 = dyn_cast<SCEVNAryExpr>(S)) 6911 for (auto *Op : S2->operands()) 6912 InsertUnique(Op); 6913 else if (auto *S2 = dyn_cast<SCEVUDivExpr>(S)) 6914 for (auto *Op : S2->operands()) 6915 InsertUnique(Op); 6916 } 6917 6918 const Instruction * 6919 ScalarEvolution::getDefiningScopeBound(ArrayRef<const SCEV *> Ops, 6920 bool &Precise) { 6921 Precise = true; 6922 // Do a bounded search of the def relation of the requested SCEVs. 6923 SmallSet<const SCEV *, 16> Visited; 6924 SmallVector<const SCEV *> Worklist; 6925 auto pushOp = [&](const SCEV *S) { 6926 if (!Visited.insert(S).second) 6927 return; 6928 // Threshold of 30 here is arbitrary. 6929 if (Visited.size() > 30) { 6930 Precise = false; 6931 return; 6932 } 6933 Worklist.push_back(S); 6934 }; 6935 6936 for (auto *S : Ops) 6937 pushOp(S); 6938 6939 const Instruction *Bound = nullptr; 6940 while (!Worklist.empty()) { 6941 auto *S = Worklist.pop_back_val(); 6942 if (auto *DefI = getNonTrivialDefiningScopeBound(S)) { 6943 if (!Bound || DT.dominates(Bound, DefI)) 6944 Bound = DefI; 6945 } else { 6946 SmallVector<const SCEV *, 4> Ops; 6947 collectUniqueOps(S, Ops); 6948 for (auto *Op : Ops) 6949 pushOp(Op); 6950 } 6951 } 6952 return Bound ? Bound : &*F.getEntryBlock().begin(); 6953 } 6954 6955 const Instruction * 6956 ScalarEvolution::getDefiningScopeBound(ArrayRef<const SCEV *> Ops) { 6957 bool Discard; 6958 return getDefiningScopeBound(Ops, Discard); 6959 } 6960 6961 bool ScalarEvolution::isGuaranteedToTransferExecutionTo(const Instruction *A, 6962 const Instruction *B) { 6963 if (A->getParent() == B->getParent() && 6964 isGuaranteedToTransferExecutionToSuccessor(A->getIterator(), 6965 B->getIterator())) 6966 return true; 6967 6968 auto *BLoop = LI.getLoopFor(B->getParent()); 6969 if (BLoop && BLoop->getHeader() == B->getParent() && 6970 BLoop->getLoopPreheader() == A->getParent() && 6971 isGuaranteedToTransferExecutionToSuccessor(A->getIterator(), 6972 A->getParent()->end()) && 6973 isGuaranteedToTransferExecutionToSuccessor(B->getParent()->begin(), 6974 B->getIterator())) 6975 return true; 6976 return false; 6977 } 6978 6979 6980 bool ScalarEvolution::isSCEVExprNeverPoison(const Instruction *I) { 6981 // Only proceed if we can prove that I does not yield poison. 6982 if (!programUndefinedIfPoison(I)) 6983 return false; 6984 6985 // At this point we know that if I is executed, then it does not wrap 6986 // according to at least one of NSW or NUW. If I is not executed, then we do 6987 // not know if the calculation that I represents would wrap. Multiple 6988 // instructions can map to the same SCEV. If we apply NSW or NUW from I to 6989 // the SCEV, we must guarantee no wrapping for that SCEV also when it is 6990 // derived from other instructions that map to the same SCEV. We cannot make 6991 // that guarantee for cases where I is not executed. So we need to find a 6992 // upper bound on the defining scope for the SCEV, and prove that I is 6993 // executed every time we enter that scope. When the bounding scope is a 6994 // loop (the common case), this is equivalent to proving I executes on every 6995 // iteration of that loop. 6996 SmallVector<const SCEV *> SCEVOps; 6997 for (const Use &Op : I->operands()) { 6998 // I could be an extractvalue from a call to an overflow intrinsic. 6999 // TODO: We can do better here in some cases. 7000 if (isSCEVable(Op->getType())) 7001 SCEVOps.push_back(getSCEV(Op)); 7002 } 7003 auto *DefI = getDefiningScopeBound(SCEVOps); 7004 return isGuaranteedToTransferExecutionTo(DefI, I); 7005 } 7006 7007 bool ScalarEvolution::isAddRecNeverPoison(const Instruction *I, const Loop *L) { 7008 // If we know that \c I can never be poison period, then that's enough. 7009 if (isSCEVExprNeverPoison(I)) 7010 return true; 7011 7012 // For an add recurrence specifically, we assume that infinite loops without 7013 // side effects are undefined behavior, and then reason as follows: 7014 // 7015 // If the add recurrence is poison in any iteration, it is poison on all 7016 // future iterations (since incrementing poison yields poison). If the result 7017 // of the add recurrence is fed into the loop latch condition and the loop 7018 // does not contain any throws or exiting blocks other than the latch, we now 7019 // have the ability to "choose" whether the backedge is taken or not (by 7020 // choosing a sufficiently evil value for the poison feeding into the branch) 7021 // for every iteration including and after the one in which \p I first became 7022 // poison. There are two possibilities (let's call the iteration in which \p 7023 // I first became poison as K): 7024 // 7025 // 1. In the set of iterations including and after K, the loop body executes 7026 // no side effects. In this case executing the backege an infinte number 7027 // of times will yield undefined behavior. 7028 // 7029 // 2. In the set of iterations including and after K, the loop body executes 7030 // at least one side effect. In this case, that specific instance of side 7031 // effect is control dependent on poison, which also yields undefined 7032 // behavior. 7033 7034 auto *ExitingBB = L->getExitingBlock(); 7035 auto *LatchBB = L->getLoopLatch(); 7036 if (!ExitingBB || !LatchBB || ExitingBB != LatchBB) 7037 return false; 7038 7039 SmallPtrSet<const Instruction *, 16> Pushed; 7040 SmallVector<const Instruction *, 8> PoisonStack; 7041 7042 // We start by assuming \c I, the post-inc add recurrence, is poison. Only 7043 // things that are known to be poison under that assumption go on the 7044 // PoisonStack. 7045 Pushed.insert(I); 7046 PoisonStack.push_back(I); 7047 7048 bool LatchControlDependentOnPoison = false; 7049 while (!PoisonStack.empty() && !LatchControlDependentOnPoison) { 7050 const Instruction *Poison = PoisonStack.pop_back_val(); 7051 7052 for (auto *PoisonUser : Poison->users()) { 7053 if (propagatesPoison(cast<Operator>(PoisonUser))) { 7054 if (Pushed.insert(cast<Instruction>(PoisonUser)).second) 7055 PoisonStack.push_back(cast<Instruction>(PoisonUser)); 7056 } else if (auto *BI = dyn_cast<BranchInst>(PoisonUser)) { 7057 assert(BI->isConditional() && "Only possibility!"); 7058 if (BI->getParent() == LatchBB) { 7059 LatchControlDependentOnPoison = true; 7060 break; 7061 } 7062 } 7063 } 7064 } 7065 7066 return LatchControlDependentOnPoison && loopHasNoAbnormalExits(L); 7067 } 7068 7069 ScalarEvolution::LoopProperties 7070 ScalarEvolution::getLoopProperties(const Loop *L) { 7071 using LoopProperties = ScalarEvolution::LoopProperties; 7072 7073 auto Itr = LoopPropertiesCache.find(L); 7074 if (Itr == LoopPropertiesCache.end()) { 7075 auto HasSideEffects = [](Instruction *I) { 7076 if (auto *SI = dyn_cast<StoreInst>(I)) 7077 return !SI->isSimple(); 7078 7079 return I->mayThrow() || I->mayWriteToMemory(); 7080 }; 7081 7082 LoopProperties LP = {/* HasNoAbnormalExits */ true, 7083 /*HasNoSideEffects*/ true}; 7084 7085 for (auto *BB : L->getBlocks()) 7086 for (auto &I : *BB) { 7087 if (!isGuaranteedToTransferExecutionToSuccessor(&I)) 7088 LP.HasNoAbnormalExits = false; 7089 if (HasSideEffects(&I)) 7090 LP.HasNoSideEffects = false; 7091 if (!LP.HasNoAbnormalExits && !LP.HasNoSideEffects) 7092 break; // We're already as pessimistic as we can get. 7093 } 7094 7095 auto InsertPair = LoopPropertiesCache.insert({L, LP}); 7096 assert(InsertPair.second && "We just checked!"); 7097 Itr = InsertPair.first; 7098 } 7099 7100 return Itr->second; 7101 } 7102 7103 bool ScalarEvolution::loopIsFiniteByAssumption(const Loop *L) { 7104 // A mustprogress loop without side effects must be finite. 7105 // TODO: The check used here is very conservative. It's only *specific* 7106 // side effects which are well defined in infinite loops. 7107 return isFinite(L) || (isMustProgress(L) && loopHasNoSideEffects(L)); 7108 } 7109 7110 const SCEV *ScalarEvolution::createSCEV(Value *V) { 7111 if (!isSCEVable(V->getType())) 7112 return getUnknown(V); 7113 7114 if (Instruction *I = dyn_cast<Instruction>(V)) { 7115 // Don't attempt to analyze instructions in blocks that aren't 7116 // reachable. Such instructions don't matter, and they aren't required 7117 // to obey basic rules for definitions dominating uses which this 7118 // analysis depends on. 7119 if (!DT.isReachableFromEntry(I->getParent())) 7120 return getUnknown(UndefValue::get(V->getType())); 7121 } else if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) 7122 return getConstant(CI); 7123 else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) 7124 return GA->isInterposable() ? getUnknown(V) : getSCEV(GA->getAliasee()); 7125 else if (!isa<ConstantExpr>(V)) 7126 return getUnknown(V); 7127 7128 Operator *U = cast<Operator>(V); 7129 if (auto BO = MatchBinaryOp(U, DT)) { 7130 switch (BO->Opcode) { 7131 case Instruction::Add: { 7132 // The simple thing to do would be to just call getSCEV on both operands 7133 // and call getAddExpr with the result. However if we're looking at a 7134 // bunch of things all added together, this can be quite inefficient, 7135 // because it leads to N-1 getAddExpr calls for N ultimate operands. 7136 // Instead, gather up all the operands and make a single getAddExpr call. 7137 // LLVM IR canonical form means we need only traverse the left operands. 7138 SmallVector<const SCEV *, 4> AddOps; 7139 do { 7140 if (BO->Op) { 7141 if (auto *OpSCEV = getExistingSCEV(BO->Op)) { 7142 AddOps.push_back(OpSCEV); 7143 break; 7144 } 7145 7146 // If a NUW or NSW flag can be applied to the SCEV for this 7147 // addition, then compute the SCEV for this addition by itself 7148 // with a separate call to getAddExpr. We need to do that 7149 // instead of pushing the operands of the addition onto AddOps, 7150 // since the flags are only known to apply to this particular 7151 // addition - they may not apply to other additions that can be 7152 // formed with operands from AddOps. 7153 const SCEV *RHS = getSCEV(BO->RHS); 7154 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op); 7155 if (Flags != SCEV::FlagAnyWrap) { 7156 const SCEV *LHS = getSCEV(BO->LHS); 7157 if (BO->Opcode == Instruction::Sub) 7158 AddOps.push_back(getMinusSCEV(LHS, RHS, Flags)); 7159 else 7160 AddOps.push_back(getAddExpr(LHS, RHS, Flags)); 7161 break; 7162 } 7163 } 7164 7165 if (BO->Opcode == Instruction::Sub) 7166 AddOps.push_back(getNegativeSCEV(getSCEV(BO->RHS))); 7167 else 7168 AddOps.push_back(getSCEV(BO->RHS)); 7169 7170 auto NewBO = MatchBinaryOp(BO->LHS, DT); 7171 if (!NewBO || (NewBO->Opcode != Instruction::Add && 7172 NewBO->Opcode != Instruction::Sub)) { 7173 AddOps.push_back(getSCEV(BO->LHS)); 7174 break; 7175 } 7176 BO = NewBO; 7177 } while (true); 7178 7179 return getAddExpr(AddOps); 7180 } 7181 7182 case Instruction::Mul: { 7183 SmallVector<const SCEV *, 4> MulOps; 7184 do { 7185 if (BO->Op) { 7186 if (auto *OpSCEV = getExistingSCEV(BO->Op)) { 7187 MulOps.push_back(OpSCEV); 7188 break; 7189 } 7190 7191 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op); 7192 if (Flags != SCEV::FlagAnyWrap) { 7193 MulOps.push_back( 7194 getMulExpr(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags)); 7195 break; 7196 } 7197 } 7198 7199 MulOps.push_back(getSCEV(BO->RHS)); 7200 auto NewBO = MatchBinaryOp(BO->LHS, DT); 7201 if (!NewBO || NewBO->Opcode != Instruction::Mul) { 7202 MulOps.push_back(getSCEV(BO->LHS)); 7203 break; 7204 } 7205 BO = NewBO; 7206 } while (true); 7207 7208 return getMulExpr(MulOps); 7209 } 7210 case Instruction::UDiv: 7211 return getUDivExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7212 case Instruction::URem: 7213 return getURemExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7214 case Instruction::Sub: { 7215 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap; 7216 if (BO->Op) 7217 Flags = getNoWrapFlagsFromUB(BO->Op); 7218 return getMinusSCEV(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags); 7219 } 7220 case Instruction::And: 7221 // For an expression like x&255 that merely masks off the high bits, 7222 // use zext(trunc(x)) as the SCEV expression. 7223 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 7224 if (CI->isZero()) 7225 return getSCEV(BO->RHS); 7226 if (CI->isMinusOne()) 7227 return getSCEV(BO->LHS); 7228 const APInt &A = CI->getValue(); 7229 7230 // Instcombine's ShrinkDemandedConstant may strip bits out of 7231 // constants, obscuring what would otherwise be a low-bits mask. 7232 // Use computeKnownBits to compute what ShrinkDemandedConstant 7233 // knew about to reconstruct a low-bits mask value. 7234 unsigned LZ = A.countLeadingZeros(); 7235 unsigned TZ = A.countTrailingZeros(); 7236 unsigned BitWidth = A.getBitWidth(); 7237 KnownBits Known(BitWidth); 7238 computeKnownBits(BO->LHS, Known, getDataLayout(), 7239 0, &AC, nullptr, &DT); 7240 7241 APInt EffectiveMask = 7242 APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ); 7243 if ((LZ != 0 || TZ != 0) && !((~A & ~Known.Zero) & EffectiveMask)) { 7244 const SCEV *MulCount = getConstant(APInt::getOneBitSet(BitWidth, TZ)); 7245 const SCEV *LHS = getSCEV(BO->LHS); 7246 const SCEV *ShiftedLHS = nullptr; 7247 if (auto *LHSMul = dyn_cast<SCEVMulExpr>(LHS)) { 7248 if (auto *OpC = dyn_cast<SCEVConstant>(LHSMul->getOperand(0))) { 7249 // For an expression like (x * 8) & 8, simplify the multiply. 7250 unsigned MulZeros = OpC->getAPInt().countTrailingZeros(); 7251 unsigned GCD = std::min(MulZeros, TZ); 7252 APInt DivAmt = APInt::getOneBitSet(BitWidth, TZ - GCD); 7253 SmallVector<const SCEV*, 4> MulOps; 7254 MulOps.push_back(getConstant(OpC->getAPInt().lshr(GCD))); 7255 MulOps.append(LHSMul->op_begin() + 1, LHSMul->op_end()); 7256 auto *NewMul = getMulExpr(MulOps, LHSMul->getNoWrapFlags()); 7257 ShiftedLHS = getUDivExpr(NewMul, getConstant(DivAmt)); 7258 } 7259 } 7260 if (!ShiftedLHS) 7261 ShiftedLHS = getUDivExpr(LHS, MulCount); 7262 return getMulExpr( 7263 getZeroExtendExpr( 7264 getTruncateExpr(ShiftedLHS, 7265 IntegerType::get(getContext(), BitWidth - LZ - TZ)), 7266 BO->LHS->getType()), 7267 MulCount); 7268 } 7269 } 7270 // Binary `and` is a bit-wise `umin`. 7271 if (BO->LHS->getType()->isIntegerTy(1)) 7272 return getUMinExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7273 break; 7274 7275 case Instruction::Or: 7276 // If the RHS of the Or is a constant, we may have something like: 7277 // X*4+1 which got turned into X*4|1. Handle this as an Add so loop 7278 // optimizations will transparently handle this case. 7279 // 7280 // In order for this transformation to be safe, the LHS must be of the 7281 // form X*(2^n) and the Or constant must be less than 2^n. 7282 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 7283 const SCEV *LHS = getSCEV(BO->LHS); 7284 const APInt &CIVal = CI->getValue(); 7285 if (GetMinTrailingZeros(LHS) >= 7286 (CIVal.getBitWidth() - CIVal.countLeadingZeros())) { 7287 // Build a plain add SCEV. 7288 return getAddExpr(LHS, getSCEV(CI), 7289 (SCEV::NoWrapFlags)(SCEV::FlagNUW | SCEV::FlagNSW)); 7290 } 7291 } 7292 // Binary `or` is a bit-wise `umax`. 7293 if (BO->LHS->getType()->isIntegerTy(1)) 7294 return getUMaxExpr(getSCEV(BO->LHS), getSCEV(BO->RHS)); 7295 break; 7296 7297 case Instruction::Xor: 7298 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) { 7299 // If the RHS of xor is -1, then this is a not operation. 7300 if (CI->isMinusOne()) 7301 return getNotSCEV(getSCEV(BO->LHS)); 7302 7303 // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask. 7304 // This is a variant of the check for xor with -1, and it handles 7305 // the case where instcombine has trimmed non-demanded bits out 7306 // of an xor with -1. 7307 if (auto *LBO = dyn_cast<BinaryOperator>(BO->LHS)) 7308 if (ConstantInt *LCI = dyn_cast<ConstantInt>(LBO->getOperand(1))) 7309 if (LBO->getOpcode() == Instruction::And && 7310 LCI->getValue() == CI->getValue()) 7311 if (const SCEVZeroExtendExpr *Z = 7312 dyn_cast<SCEVZeroExtendExpr>(getSCEV(BO->LHS))) { 7313 Type *UTy = BO->LHS->getType(); 7314 const SCEV *Z0 = Z->getOperand(); 7315 Type *Z0Ty = Z0->getType(); 7316 unsigned Z0TySize = getTypeSizeInBits(Z0Ty); 7317 7318 // If C is a low-bits mask, the zero extend is serving to 7319 // mask off the high bits. Complement the operand and 7320 // re-apply the zext. 7321 if (CI->getValue().isMask(Z0TySize)) 7322 return getZeroExtendExpr(getNotSCEV(Z0), UTy); 7323 7324 // If C is a single bit, it may be in the sign-bit position 7325 // before the zero-extend. In this case, represent the xor 7326 // using an add, which is equivalent, and re-apply the zext. 7327 APInt Trunc = CI->getValue().trunc(Z0TySize); 7328 if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() && 7329 Trunc.isSignMask()) 7330 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)), 7331 UTy); 7332 } 7333 } 7334 break; 7335 7336 case Instruction::Shl: 7337 // Turn shift left of a constant amount into a multiply. 7338 if (ConstantInt *SA = dyn_cast<ConstantInt>(BO->RHS)) { 7339 uint32_t BitWidth = cast<IntegerType>(SA->getType())->getBitWidth(); 7340 7341 // If the shift count is not less than the bitwidth, the result of 7342 // the shift is undefined. Don't try to analyze it, because the 7343 // resolution chosen here may differ from the resolution chosen in 7344 // other parts of the compiler. 7345 if (SA->getValue().uge(BitWidth)) 7346 break; 7347 7348 // We can safely preserve the nuw flag in all cases. It's also safe to 7349 // turn a nuw nsw shl into a nuw nsw mul. However, nsw in isolation 7350 // requires special handling. It can be preserved as long as we're not 7351 // left shifting by bitwidth - 1. 7352 auto Flags = SCEV::FlagAnyWrap; 7353 if (BO->Op) { 7354 auto MulFlags = getNoWrapFlagsFromUB(BO->Op); 7355 if ((MulFlags & SCEV::FlagNSW) && 7356 ((MulFlags & SCEV::FlagNUW) || SA->getValue().ult(BitWidth - 1))) 7357 Flags = (SCEV::NoWrapFlags)(Flags | SCEV::FlagNSW); 7358 if (MulFlags & SCEV::FlagNUW) 7359 Flags = (SCEV::NoWrapFlags)(Flags | SCEV::FlagNUW); 7360 } 7361 7362 ConstantInt *X = ConstantInt::get( 7363 getContext(), APInt::getOneBitSet(BitWidth, SA->getZExtValue())); 7364 return getMulExpr(getSCEV(BO->LHS), getConstant(X), Flags); 7365 } 7366 break; 7367 7368 case Instruction::AShr: { 7369 // AShr X, C, where C is a constant. 7370 ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS); 7371 if (!CI) 7372 break; 7373 7374 Type *OuterTy = BO->LHS->getType(); 7375 uint64_t BitWidth = getTypeSizeInBits(OuterTy); 7376 // If the shift count is not less than the bitwidth, the result of 7377 // the shift is undefined. Don't try to analyze it, because the 7378 // resolution chosen here may differ from the resolution chosen in 7379 // other parts of the compiler. 7380 if (CI->getValue().uge(BitWidth)) 7381 break; 7382 7383 if (CI->isZero()) 7384 return getSCEV(BO->LHS); // shift by zero --> noop 7385 7386 uint64_t AShrAmt = CI->getZExtValue(); 7387 Type *TruncTy = IntegerType::get(getContext(), BitWidth - AShrAmt); 7388 7389 Operator *L = dyn_cast<Operator>(BO->LHS); 7390 if (L && L->getOpcode() == Instruction::Shl) { 7391 // X = Shl A, n 7392 // Y = AShr X, m 7393 // Both n and m are constant. 7394 7395 const SCEV *ShlOp0SCEV = getSCEV(L->getOperand(0)); 7396 if (L->getOperand(1) == BO->RHS) 7397 // For a two-shift sext-inreg, i.e. n = m, 7398 // use sext(trunc(x)) as the SCEV expression. 7399 return getSignExtendExpr( 7400 getTruncateExpr(ShlOp0SCEV, TruncTy), OuterTy); 7401 7402 ConstantInt *ShlAmtCI = dyn_cast<ConstantInt>(L->getOperand(1)); 7403 if (ShlAmtCI && ShlAmtCI->getValue().ult(BitWidth)) { 7404 uint64_t ShlAmt = ShlAmtCI->getZExtValue(); 7405 if (ShlAmt > AShrAmt) { 7406 // When n > m, use sext(mul(trunc(x), 2^(n-m)))) as the SCEV 7407 // expression. We already checked that ShlAmt < BitWidth, so 7408 // the multiplier, 1 << (ShlAmt - AShrAmt), fits into TruncTy as 7409 // ShlAmt - AShrAmt < Amt. 7410 APInt Mul = APInt::getOneBitSet(BitWidth - AShrAmt, 7411 ShlAmt - AShrAmt); 7412 return getSignExtendExpr( 7413 getMulExpr(getTruncateExpr(ShlOp0SCEV, TruncTy), 7414 getConstant(Mul)), OuterTy); 7415 } 7416 } 7417 } 7418 break; 7419 } 7420 } 7421 } 7422 7423 switch (U->getOpcode()) { 7424 case Instruction::Trunc: 7425 return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType()); 7426 7427 case Instruction::ZExt: 7428 return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType()); 7429 7430 case Instruction::SExt: 7431 if (auto BO = MatchBinaryOp(U->getOperand(0), DT)) { 7432 // The NSW flag of a subtract does not always survive the conversion to 7433 // A + (-1)*B. By pushing sign extension onto its operands we are much 7434 // more likely to preserve NSW and allow later AddRec optimisations. 7435 // 7436 // NOTE: This is effectively duplicating this logic from getSignExtend: 7437 // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw> 7438 // but by that point the NSW information has potentially been lost. 7439 if (BO->Opcode == Instruction::Sub && BO->IsNSW) { 7440 Type *Ty = U->getType(); 7441 auto *V1 = getSignExtendExpr(getSCEV(BO->LHS), Ty); 7442 auto *V2 = getSignExtendExpr(getSCEV(BO->RHS), Ty); 7443 return getMinusSCEV(V1, V2, SCEV::FlagNSW); 7444 } 7445 } 7446 return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType()); 7447 7448 case Instruction::BitCast: 7449 // BitCasts are no-op casts so we just eliminate the cast. 7450 if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType())) 7451 return getSCEV(U->getOperand(0)); 7452 break; 7453 7454 case Instruction::PtrToInt: { 7455 // Pointer to integer cast is straight-forward, so do model it. 7456 const SCEV *Op = getSCEV(U->getOperand(0)); 7457 Type *DstIntTy = U->getType(); 7458 // But only if effective SCEV (integer) type is wide enough to represent 7459 // all possible pointer values. 7460 const SCEV *IntOp = getPtrToIntExpr(Op, DstIntTy); 7461 if (isa<SCEVCouldNotCompute>(IntOp)) 7462 return getUnknown(V); 7463 return IntOp; 7464 } 7465 case Instruction::IntToPtr: 7466 // Just don't deal with inttoptr casts. 7467 return getUnknown(V); 7468 7469 case Instruction::SDiv: 7470 // If both operands are non-negative, this is just an udiv. 7471 if (isKnownNonNegative(getSCEV(U->getOperand(0))) && 7472 isKnownNonNegative(getSCEV(U->getOperand(1)))) 7473 return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1))); 7474 break; 7475 7476 case Instruction::SRem: 7477 // If both operands are non-negative, this is just an urem. 7478 if (isKnownNonNegative(getSCEV(U->getOperand(0))) && 7479 isKnownNonNegative(getSCEV(U->getOperand(1)))) 7480 return getURemExpr(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1))); 7481 break; 7482 7483 case Instruction::GetElementPtr: 7484 return createNodeForGEP(cast<GEPOperator>(U)); 7485 7486 case Instruction::PHI: 7487 return createNodeForPHI(cast<PHINode>(U)); 7488 7489 case Instruction::Select: 7490 return createNodeForSelectOrPHI(U, U->getOperand(0), U->getOperand(1), 7491 U->getOperand(2)); 7492 7493 case Instruction::Call: 7494 case Instruction::Invoke: 7495 if (Value *RV = cast<CallBase>(U)->getReturnedArgOperand()) 7496 return getSCEV(RV); 7497 7498 if (auto *II = dyn_cast<IntrinsicInst>(U)) { 7499 switch (II->getIntrinsicID()) { 7500 case Intrinsic::abs: 7501 return getAbsExpr( 7502 getSCEV(II->getArgOperand(0)), 7503 /*IsNSW=*/cast<ConstantInt>(II->getArgOperand(1))->isOne()); 7504 case Intrinsic::umax: 7505 return getUMaxExpr(getSCEV(II->getArgOperand(0)), 7506 getSCEV(II->getArgOperand(1))); 7507 case Intrinsic::umin: 7508 return getUMinExpr(getSCEV(II->getArgOperand(0)), 7509 getSCEV(II->getArgOperand(1))); 7510 case Intrinsic::smax: 7511 return getSMaxExpr(getSCEV(II->getArgOperand(0)), 7512 getSCEV(II->getArgOperand(1))); 7513 case Intrinsic::smin: 7514 return getSMinExpr(getSCEV(II->getArgOperand(0)), 7515 getSCEV(II->getArgOperand(1))); 7516 case Intrinsic::usub_sat: { 7517 const SCEV *X = getSCEV(II->getArgOperand(0)); 7518 const SCEV *Y = getSCEV(II->getArgOperand(1)); 7519 const SCEV *ClampedY = getUMinExpr(X, Y); 7520 return getMinusSCEV(X, ClampedY, SCEV::FlagNUW); 7521 } 7522 case Intrinsic::uadd_sat: { 7523 const SCEV *X = getSCEV(II->getArgOperand(0)); 7524 const SCEV *Y = getSCEV(II->getArgOperand(1)); 7525 const SCEV *ClampedX = getUMinExpr(X, getNotSCEV(Y)); 7526 return getAddExpr(ClampedX, Y, SCEV::FlagNUW); 7527 } 7528 case Intrinsic::start_loop_iterations: 7529 // A start_loop_iterations is just equivalent to the first operand for 7530 // SCEV purposes. 7531 return getSCEV(II->getArgOperand(0)); 7532 default: 7533 break; 7534 } 7535 } 7536 break; 7537 } 7538 7539 return getUnknown(V); 7540 } 7541 7542 //===----------------------------------------------------------------------===// 7543 // Iteration Count Computation Code 7544 // 7545 7546 const SCEV *ScalarEvolution::getTripCountFromExitCount(const SCEV *ExitCount, 7547 bool Extend) { 7548 if (isa<SCEVCouldNotCompute>(ExitCount)) 7549 return getCouldNotCompute(); 7550 7551 auto *ExitCountType = ExitCount->getType(); 7552 assert(ExitCountType->isIntegerTy()); 7553 7554 if (!Extend) 7555 return getAddExpr(ExitCount, getOne(ExitCountType)); 7556 7557 auto *WiderType = Type::getIntNTy(ExitCountType->getContext(), 7558 1 + ExitCountType->getScalarSizeInBits()); 7559 return getAddExpr(getNoopOrZeroExtend(ExitCount, WiderType), 7560 getOne(WiderType)); 7561 } 7562 7563 static unsigned getConstantTripCount(const SCEVConstant *ExitCount) { 7564 if (!ExitCount) 7565 return 0; 7566 7567 ConstantInt *ExitConst = ExitCount->getValue(); 7568 7569 // Guard against huge trip counts. 7570 if (ExitConst->getValue().getActiveBits() > 32) 7571 return 0; 7572 7573 // In case of integer overflow, this returns 0, which is correct. 7574 return ((unsigned)ExitConst->getZExtValue()) + 1; 7575 } 7576 7577 unsigned ScalarEvolution::getSmallConstantTripCount(const Loop *L) { 7578 auto *ExitCount = dyn_cast<SCEVConstant>(getBackedgeTakenCount(L, Exact)); 7579 return getConstantTripCount(ExitCount); 7580 } 7581 7582 unsigned 7583 ScalarEvolution::getSmallConstantTripCount(const Loop *L, 7584 const BasicBlock *ExitingBlock) { 7585 assert(ExitingBlock && "Must pass a non-null exiting block!"); 7586 assert(L->isLoopExiting(ExitingBlock) && 7587 "Exiting block must actually branch out of the loop!"); 7588 const SCEVConstant *ExitCount = 7589 dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock)); 7590 return getConstantTripCount(ExitCount); 7591 } 7592 7593 unsigned ScalarEvolution::getSmallConstantMaxTripCount(const Loop *L) { 7594 const auto *MaxExitCount = 7595 dyn_cast<SCEVConstant>(getConstantMaxBackedgeTakenCount(L)); 7596 return getConstantTripCount(MaxExitCount); 7597 } 7598 7599 const SCEV *ScalarEvolution::getConstantMaxTripCountFromArray(const Loop *L) { 7600 // We can't infer from Array in Irregular Loop. 7601 // FIXME: It's hard to infer loop bound from array operated in Nested Loop. 7602 if (!L->isLoopSimplifyForm() || !L->isInnermost()) 7603 return getCouldNotCompute(); 7604 7605 // FIXME: To make the scene more typical, we only analysis loops that have 7606 // one exiting block and that block must be the latch. To make it easier to 7607 // capture loops that have memory access and memory access will be executed 7608 // in each iteration. 7609 const BasicBlock *LoopLatch = L->getLoopLatch(); 7610 assert(LoopLatch && "See defination of simplify form loop."); 7611 if (L->getExitingBlock() != LoopLatch) 7612 return getCouldNotCompute(); 7613 7614 const DataLayout &DL = getDataLayout(); 7615 SmallVector<const SCEV *> InferCountColl; 7616 for (auto *BB : L->getBlocks()) { 7617 // Go here, we can know that Loop is a single exiting and simplified form 7618 // loop. Make sure that infer from Memory Operation in those BBs must be 7619 // executed in loop. First step, we can make sure that max execution time 7620 // of MemAccessBB in loop represents latch max excution time. 7621 // If MemAccessBB does not dom Latch, skip. 7622 // Entry 7623 // │ 7624 // ┌─────▼─────┐ 7625 // │Loop Header◄─────┐ 7626 // └──┬──────┬─┘ │ 7627 // │ │ │ 7628 // ┌────────▼──┐ ┌─▼─────┐ │ 7629 // │MemAccessBB│ │OtherBB│ │ 7630 // └────────┬──┘ └─┬─────┘ │ 7631 // │ │ │ 7632 // ┌─▼──────▼─┐ │ 7633 // │Loop Latch├─────┘ 7634 // └────┬─────┘ 7635 // ▼ 7636 // Exit 7637 if (!DT.dominates(BB, LoopLatch)) 7638 continue; 7639 7640 for (Instruction &Inst : *BB) { 7641 // Find Memory Operation Instruction. 7642 auto *GEP = getLoadStorePointerOperand(&Inst); 7643 if (!GEP) 7644 continue; 7645 7646 auto *ElemSize = dyn_cast<SCEVConstant>(getElementSize(&Inst)); 7647 // Do not infer from scalar type, eg."ElemSize = sizeof()". 7648 if (!ElemSize) 7649 continue; 7650 7651 // Use a existing polynomial recurrence on the trip count. 7652 auto *AddRec = dyn_cast<SCEVAddRecExpr>(getSCEV(GEP)); 7653 if (!AddRec) 7654 continue; 7655 auto *ArrBase = dyn_cast<SCEVUnknown>(getPointerBase(AddRec)); 7656 auto *Step = dyn_cast<SCEVConstant>(AddRec->getStepRecurrence(*this)); 7657 if (!ArrBase || !Step) 7658 continue; 7659 assert(isLoopInvariant(ArrBase, L) && "See addrec definition"); 7660 7661 // Only handle { %array + step }, 7662 // FIXME: {(SCEVAddRecExpr) + step } could not be analysed here. 7663 if (AddRec->getStart() != ArrBase) 7664 continue; 7665 7666 // Memory operation pattern which have gaps. 7667 // Or repeat memory opreation. 7668 // And index of GEP wraps arround. 7669 if (Step->getAPInt().getActiveBits() > 32 || 7670 Step->getAPInt().getZExtValue() != 7671 ElemSize->getAPInt().getZExtValue() || 7672 Step->isZero() || Step->getAPInt().isNegative()) 7673 continue; 7674 7675 // Only infer from stack array which has certain size. 7676 // Make sure alloca instruction is not excuted in loop. 7677 AllocaInst *AllocateInst = dyn_cast<AllocaInst>(ArrBase->getValue()); 7678 if (!AllocateInst || L->contains(AllocateInst->getParent())) 7679 continue; 7680 7681 // Make sure only handle normal array. 7682 auto *Ty = dyn_cast<ArrayType>(AllocateInst->getAllocatedType()); 7683 auto *ArrSize = dyn_cast<ConstantInt>(AllocateInst->getArraySize()); 7684 if (!Ty || !ArrSize || !ArrSize->isOne()) 7685 continue; 7686 7687 // FIXME: Since gep indices are silently zext to the indexing type, 7688 // we will have a narrow gep index which wraps around rather than 7689 // increasing strictly, we shoule ensure that step is increasing 7690 // strictly by the loop iteration. 7691 // Now we can infer a max execution time by MemLength/StepLength. 7692 const SCEV *MemSize = 7693 getConstant(Step->getType(), DL.getTypeAllocSize(Ty)); 7694 auto *MaxExeCount = 7695 dyn_cast<SCEVConstant>(getUDivCeilSCEV(MemSize, Step)); 7696 if (!MaxExeCount || MaxExeCount->getAPInt().getActiveBits() > 32) 7697 continue; 7698 7699 // If the loop reaches the maximum number of executions, we can not 7700 // access bytes starting outside the statically allocated size without 7701 // being immediate UB. But it is allowed to enter loop header one more 7702 // time. 7703 auto *InferCount = dyn_cast<SCEVConstant>( 7704 getAddExpr(MaxExeCount, getOne(MaxExeCount->getType()))); 7705 // Discard the maximum number of execution times under 32bits. 7706 if (!InferCount || InferCount->getAPInt().getActiveBits() > 32) 7707 continue; 7708 7709 InferCountColl.push_back(InferCount); 7710 } 7711 } 7712 7713 if (InferCountColl.size() == 0) 7714 return getCouldNotCompute(); 7715 7716 return getUMinFromMismatchedTypes(InferCountColl); 7717 } 7718 7719 unsigned ScalarEvolution::getSmallConstantTripMultiple(const Loop *L) { 7720 SmallVector<BasicBlock *, 8> ExitingBlocks; 7721 L->getExitingBlocks(ExitingBlocks); 7722 7723 Optional<unsigned> Res = None; 7724 for (auto *ExitingBB : ExitingBlocks) { 7725 unsigned Multiple = getSmallConstantTripMultiple(L, ExitingBB); 7726 if (!Res) 7727 Res = Multiple; 7728 Res = (unsigned)GreatestCommonDivisor64(*Res, Multiple); 7729 } 7730 return Res.getValueOr(1); 7731 } 7732 7733 unsigned ScalarEvolution::getSmallConstantTripMultiple(const Loop *L, 7734 const SCEV *ExitCount) { 7735 if (ExitCount == getCouldNotCompute()) 7736 return 1; 7737 7738 // Get the trip count 7739 const SCEV *TCExpr = getTripCountFromExitCount(ExitCount); 7740 7741 const SCEVConstant *TC = dyn_cast<SCEVConstant>(TCExpr); 7742 if (!TC) 7743 // Attempt to factor more general cases. Returns the greatest power of 7744 // two divisor. If overflow happens, the trip count expression is still 7745 // divisible by the greatest power of 2 divisor returned. 7746 return 1U << std::min((uint32_t)31, 7747 GetMinTrailingZeros(applyLoopGuards(TCExpr, L))); 7748 7749 ConstantInt *Result = TC->getValue(); 7750 7751 // Guard against huge trip counts (this requires checking 7752 // for zero to handle the case where the trip count == -1 and the 7753 // addition wraps). 7754 if (!Result || Result->getValue().getActiveBits() > 32 || 7755 Result->getValue().getActiveBits() == 0) 7756 return 1; 7757 7758 return (unsigned)Result->getZExtValue(); 7759 } 7760 7761 /// Returns the largest constant divisor of the trip count of this loop as a 7762 /// normal unsigned value, if possible. This means that the actual trip count is 7763 /// always a multiple of the returned value (don't forget the trip count could 7764 /// very well be zero as well!). 7765 /// 7766 /// Returns 1 if the trip count is unknown or not guaranteed to be the 7767 /// multiple of a constant (which is also the case if the trip count is simply 7768 /// constant, use getSmallConstantTripCount for that case), Will also return 1 7769 /// if the trip count is very large (>= 2^32). 7770 /// 7771 /// As explained in the comments for getSmallConstantTripCount, this assumes 7772 /// that control exits the loop via ExitingBlock. 7773 unsigned 7774 ScalarEvolution::getSmallConstantTripMultiple(const Loop *L, 7775 const BasicBlock *ExitingBlock) { 7776 assert(ExitingBlock && "Must pass a non-null exiting block!"); 7777 assert(L->isLoopExiting(ExitingBlock) && 7778 "Exiting block must actually branch out of the loop!"); 7779 const SCEV *ExitCount = getExitCount(L, ExitingBlock); 7780 return getSmallConstantTripMultiple(L, ExitCount); 7781 } 7782 7783 const SCEV *ScalarEvolution::getExitCount(const Loop *L, 7784 const BasicBlock *ExitingBlock, 7785 ExitCountKind Kind) { 7786 switch (Kind) { 7787 case Exact: 7788 case SymbolicMaximum: 7789 return getBackedgeTakenInfo(L).getExact(ExitingBlock, this); 7790 case ConstantMaximum: 7791 return getBackedgeTakenInfo(L).getConstantMax(ExitingBlock, this); 7792 }; 7793 llvm_unreachable("Invalid ExitCountKind!"); 7794 } 7795 7796 const SCEV * 7797 ScalarEvolution::getPredicatedBackedgeTakenCount(const Loop *L, 7798 SmallVector<const SCEVPredicate *, 4> &Preds) { 7799 return getPredicatedBackedgeTakenInfo(L).getExact(L, this, &Preds); 7800 } 7801 7802 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L, 7803 ExitCountKind Kind) { 7804 switch (Kind) { 7805 case Exact: 7806 return getBackedgeTakenInfo(L).getExact(L, this); 7807 case ConstantMaximum: 7808 return getBackedgeTakenInfo(L).getConstantMax(this); 7809 case SymbolicMaximum: 7810 return getBackedgeTakenInfo(L).getSymbolicMax(L, this); 7811 }; 7812 llvm_unreachable("Invalid ExitCountKind!"); 7813 } 7814 7815 bool ScalarEvolution::isBackedgeTakenCountMaxOrZero(const Loop *L) { 7816 return getBackedgeTakenInfo(L).isConstantMaxOrZero(this); 7817 } 7818 7819 /// Push PHI nodes in the header of the given loop onto the given Worklist. 7820 static void PushLoopPHIs(const Loop *L, 7821 SmallVectorImpl<Instruction *> &Worklist, 7822 SmallPtrSetImpl<Instruction *> &Visited) { 7823 BasicBlock *Header = L->getHeader(); 7824 7825 // Push all Loop-header PHIs onto the Worklist stack. 7826 for (PHINode &PN : Header->phis()) 7827 if (Visited.insert(&PN).second) 7828 Worklist.push_back(&PN); 7829 } 7830 7831 const ScalarEvolution::BackedgeTakenInfo & 7832 ScalarEvolution::getPredicatedBackedgeTakenInfo(const Loop *L) { 7833 auto &BTI = getBackedgeTakenInfo(L); 7834 if (BTI.hasFullInfo()) 7835 return BTI; 7836 7837 auto Pair = PredicatedBackedgeTakenCounts.insert({L, BackedgeTakenInfo()}); 7838 7839 if (!Pair.second) 7840 return Pair.first->second; 7841 7842 BackedgeTakenInfo Result = 7843 computeBackedgeTakenCount(L, /*AllowPredicates=*/true); 7844 7845 return PredicatedBackedgeTakenCounts.find(L)->second = std::move(Result); 7846 } 7847 7848 ScalarEvolution::BackedgeTakenInfo & 7849 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) { 7850 // Initially insert an invalid entry for this loop. If the insertion 7851 // succeeds, proceed to actually compute a backedge-taken count and 7852 // update the value. The temporary CouldNotCompute value tells SCEV 7853 // code elsewhere that it shouldn't attempt to request a new 7854 // backedge-taken count, which could result in infinite recursion. 7855 std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair = 7856 BackedgeTakenCounts.insert({L, BackedgeTakenInfo()}); 7857 if (!Pair.second) 7858 return Pair.first->second; 7859 7860 // computeBackedgeTakenCount may allocate memory for its result. Inserting it 7861 // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result 7862 // must be cleared in this scope. 7863 BackedgeTakenInfo Result = computeBackedgeTakenCount(L); 7864 7865 // In product build, there are no usage of statistic. 7866 (void)NumTripCountsComputed; 7867 (void)NumTripCountsNotComputed; 7868 #if LLVM_ENABLE_STATS || !defined(NDEBUG) 7869 const SCEV *BEExact = Result.getExact(L, this); 7870 if (BEExact != getCouldNotCompute()) { 7871 assert(isLoopInvariant(BEExact, L) && 7872 isLoopInvariant(Result.getConstantMax(this), L) && 7873 "Computed backedge-taken count isn't loop invariant for loop!"); 7874 ++NumTripCountsComputed; 7875 } else if (Result.getConstantMax(this) == getCouldNotCompute() && 7876 isa<PHINode>(L->getHeader()->begin())) { 7877 // Only count loops that have phi nodes as not being computable. 7878 ++NumTripCountsNotComputed; 7879 } 7880 #endif // LLVM_ENABLE_STATS || !defined(NDEBUG) 7881 7882 // Now that we know more about the trip count for this loop, forget any 7883 // existing SCEV values for PHI nodes in this loop since they are only 7884 // conservative estimates made without the benefit of trip count 7885 // information. This invalidation is not necessary for correctness, and is 7886 // only done to produce more precise results. 7887 if (Result.hasAnyInfo()) { 7888 // Invalidate any expression using an addrec in this loop. 7889 SmallVector<const SCEV *, 8> ToForget; 7890 auto LoopUsersIt = LoopUsers.find(L); 7891 if (LoopUsersIt != LoopUsers.end()) 7892 append_range(ToForget, LoopUsersIt->second); 7893 forgetMemoizedResults(ToForget); 7894 7895 // Invalidate constant-evolved loop header phis. 7896 for (PHINode &PN : L->getHeader()->phis()) 7897 ConstantEvolutionLoopExitValue.erase(&PN); 7898 } 7899 7900 // Re-lookup the insert position, since the call to 7901 // computeBackedgeTakenCount above could result in a 7902 // recusive call to getBackedgeTakenInfo (on a different 7903 // loop), which would invalidate the iterator computed 7904 // earlier. 7905 return BackedgeTakenCounts.find(L)->second = std::move(Result); 7906 } 7907 7908 void ScalarEvolution::forgetAllLoops() { 7909 // This method is intended to forget all info about loops. It should 7910 // invalidate caches as if the following happened: 7911 // - The trip counts of all loops have changed arbitrarily 7912 // - Every llvm::Value has been updated in place to produce a different 7913 // result. 7914 BackedgeTakenCounts.clear(); 7915 PredicatedBackedgeTakenCounts.clear(); 7916 BECountUsers.clear(); 7917 LoopPropertiesCache.clear(); 7918 ConstantEvolutionLoopExitValue.clear(); 7919 ValueExprMap.clear(); 7920 ValuesAtScopes.clear(); 7921 ValuesAtScopesUsers.clear(); 7922 LoopDispositions.clear(); 7923 BlockDispositions.clear(); 7924 UnsignedRanges.clear(); 7925 SignedRanges.clear(); 7926 ExprValueMap.clear(); 7927 HasRecMap.clear(); 7928 MinTrailingZerosCache.clear(); 7929 PredicatedSCEVRewrites.clear(); 7930 } 7931 7932 void ScalarEvolution::forgetLoop(const Loop *L) { 7933 SmallVector<const Loop *, 16> LoopWorklist(1, L); 7934 SmallVector<Instruction *, 32> Worklist; 7935 SmallPtrSet<Instruction *, 16> Visited; 7936 SmallVector<const SCEV *, 16> ToForget; 7937 7938 // Iterate over all the loops and sub-loops to drop SCEV information. 7939 while (!LoopWorklist.empty()) { 7940 auto *CurrL = LoopWorklist.pop_back_val(); 7941 7942 // Drop any stored trip count value. 7943 forgetBackedgeTakenCounts(CurrL, /* Predicated */ false); 7944 forgetBackedgeTakenCounts(CurrL, /* Predicated */ true); 7945 7946 // Drop information about predicated SCEV rewrites for this loop. 7947 for (auto I = PredicatedSCEVRewrites.begin(); 7948 I != PredicatedSCEVRewrites.end();) { 7949 std::pair<const SCEV *, const Loop *> Entry = I->first; 7950 if (Entry.second == CurrL) 7951 PredicatedSCEVRewrites.erase(I++); 7952 else 7953 ++I; 7954 } 7955 7956 auto LoopUsersItr = LoopUsers.find(CurrL); 7957 if (LoopUsersItr != LoopUsers.end()) { 7958 ToForget.insert(ToForget.end(), LoopUsersItr->second.begin(), 7959 LoopUsersItr->second.end()); 7960 } 7961 7962 // Drop information about expressions based on loop-header PHIs. 7963 PushLoopPHIs(CurrL, Worklist, Visited); 7964 7965 while (!Worklist.empty()) { 7966 Instruction *I = Worklist.pop_back_val(); 7967 7968 ValueExprMapType::iterator It = 7969 ValueExprMap.find_as(static_cast<Value *>(I)); 7970 if (It != ValueExprMap.end()) { 7971 eraseValueFromMap(It->first); 7972 ToForget.push_back(It->second); 7973 if (PHINode *PN = dyn_cast<PHINode>(I)) 7974 ConstantEvolutionLoopExitValue.erase(PN); 7975 } 7976 7977 PushDefUseChildren(I, Worklist, Visited); 7978 } 7979 7980 LoopPropertiesCache.erase(CurrL); 7981 // Forget all contained loops too, to avoid dangling entries in the 7982 // ValuesAtScopes map. 7983 LoopWorklist.append(CurrL->begin(), CurrL->end()); 7984 } 7985 forgetMemoizedResults(ToForget); 7986 } 7987 7988 void ScalarEvolution::forgetTopmostLoop(const Loop *L) { 7989 while (Loop *Parent = L->getParentLoop()) 7990 L = Parent; 7991 forgetLoop(L); 7992 } 7993 7994 void ScalarEvolution::forgetValue(Value *V) { 7995 Instruction *I = dyn_cast<Instruction>(V); 7996 if (!I) return; 7997 7998 // Drop information about expressions based on loop-header PHIs. 7999 SmallVector<Instruction *, 16> Worklist; 8000 SmallPtrSet<Instruction *, 8> Visited; 8001 SmallVector<const SCEV *, 8> ToForget; 8002 Worklist.push_back(I); 8003 Visited.insert(I); 8004 8005 while (!Worklist.empty()) { 8006 I = Worklist.pop_back_val(); 8007 ValueExprMapType::iterator It = 8008 ValueExprMap.find_as(static_cast<Value *>(I)); 8009 if (It != ValueExprMap.end()) { 8010 eraseValueFromMap(It->first); 8011 ToForget.push_back(It->second); 8012 if (PHINode *PN = dyn_cast<PHINode>(I)) 8013 ConstantEvolutionLoopExitValue.erase(PN); 8014 } 8015 8016 PushDefUseChildren(I, Worklist, Visited); 8017 } 8018 forgetMemoizedResults(ToForget); 8019 } 8020 8021 void ScalarEvolution::forgetLoopDispositions(const Loop *L) { 8022 LoopDispositions.clear(); 8023 } 8024 8025 /// Get the exact loop backedge taken count considering all loop exits. A 8026 /// computable result can only be returned for loops with all exiting blocks 8027 /// dominating the latch. howFarToZero assumes that the limit of each loop test 8028 /// is never skipped. This is a valid assumption as long as the loop exits via 8029 /// that test. For precise results, it is the caller's responsibility to specify 8030 /// the relevant loop exiting block using getExact(ExitingBlock, SE). 8031 const SCEV * 8032 ScalarEvolution::BackedgeTakenInfo::getExact(const Loop *L, ScalarEvolution *SE, 8033 SmallVector<const SCEVPredicate *, 4> *Preds) const { 8034 // If any exits were not computable, the loop is not computable. 8035 if (!isComplete() || ExitNotTaken.empty()) 8036 return SE->getCouldNotCompute(); 8037 8038 const BasicBlock *Latch = L->getLoopLatch(); 8039 // All exiting blocks we have collected must dominate the only backedge. 8040 if (!Latch) 8041 return SE->getCouldNotCompute(); 8042 8043 // All exiting blocks we have gathered dominate loop's latch, so exact trip 8044 // count is simply a minimum out of all these calculated exit counts. 8045 SmallVector<const SCEV *, 2> Ops; 8046 for (auto &ENT : ExitNotTaken) { 8047 const SCEV *BECount = ENT.ExactNotTaken; 8048 assert(BECount != SE->getCouldNotCompute() && "Bad exit SCEV!"); 8049 assert(SE->DT.dominates(ENT.ExitingBlock, Latch) && 8050 "We should only have known counts for exiting blocks that dominate " 8051 "latch!"); 8052 8053 Ops.push_back(BECount); 8054 8055 if (Preds) 8056 for (auto *P : ENT.Predicates) 8057 Preds->push_back(P); 8058 8059 assert((Preds || ENT.hasAlwaysTruePredicate()) && 8060 "Predicate should be always true!"); 8061 } 8062 8063 return SE->getUMinFromMismatchedTypes(Ops); 8064 } 8065 8066 /// Get the exact not taken count for this loop exit. 8067 const SCEV * 8068 ScalarEvolution::BackedgeTakenInfo::getExact(const BasicBlock *ExitingBlock, 8069 ScalarEvolution *SE) const { 8070 for (auto &ENT : ExitNotTaken) 8071 if (ENT.ExitingBlock == ExitingBlock && ENT.hasAlwaysTruePredicate()) 8072 return ENT.ExactNotTaken; 8073 8074 return SE->getCouldNotCompute(); 8075 } 8076 8077 const SCEV *ScalarEvolution::BackedgeTakenInfo::getConstantMax( 8078 const BasicBlock *ExitingBlock, ScalarEvolution *SE) const { 8079 for (auto &ENT : ExitNotTaken) 8080 if (ENT.ExitingBlock == ExitingBlock && ENT.hasAlwaysTruePredicate()) 8081 return ENT.MaxNotTaken; 8082 8083 return SE->getCouldNotCompute(); 8084 } 8085 8086 /// getConstantMax - Get the constant max backedge taken count for the loop. 8087 const SCEV * 8088 ScalarEvolution::BackedgeTakenInfo::getConstantMax(ScalarEvolution *SE) const { 8089 auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) { 8090 return !ENT.hasAlwaysTruePredicate(); 8091 }; 8092 8093 if (!getConstantMax() || any_of(ExitNotTaken, PredicateNotAlwaysTrue)) 8094 return SE->getCouldNotCompute(); 8095 8096 assert((isa<SCEVCouldNotCompute>(getConstantMax()) || 8097 isa<SCEVConstant>(getConstantMax())) && 8098 "No point in having a non-constant max backedge taken count!"); 8099 return getConstantMax(); 8100 } 8101 8102 const SCEV * 8103 ScalarEvolution::BackedgeTakenInfo::getSymbolicMax(const Loop *L, 8104 ScalarEvolution *SE) { 8105 if (!SymbolicMax) 8106 SymbolicMax = SE->computeSymbolicMaxBackedgeTakenCount(L); 8107 return SymbolicMax; 8108 } 8109 8110 bool ScalarEvolution::BackedgeTakenInfo::isConstantMaxOrZero( 8111 ScalarEvolution *SE) const { 8112 auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) { 8113 return !ENT.hasAlwaysTruePredicate(); 8114 }; 8115 return MaxOrZero && !any_of(ExitNotTaken, PredicateNotAlwaysTrue); 8116 } 8117 8118 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E) 8119 : ExitLimit(E, E, false, None) { 8120 } 8121 8122 ScalarEvolution::ExitLimit::ExitLimit( 8123 const SCEV *E, const SCEV *M, bool MaxOrZero, 8124 ArrayRef<const SmallPtrSetImpl<const SCEVPredicate *> *> PredSetList) 8125 : ExactNotTaken(E), MaxNotTaken(M), MaxOrZero(MaxOrZero) { 8126 // If we prove the max count is zero, so is the symbolic bound. This happens 8127 // in practice due to differences in a) how context sensitive we've chosen 8128 // to be and b) how we reason about bounds impied by UB. 8129 if (MaxNotTaken->isZero()) 8130 ExactNotTaken = MaxNotTaken; 8131 8132 assert((isa<SCEVCouldNotCompute>(ExactNotTaken) || 8133 !isa<SCEVCouldNotCompute>(MaxNotTaken)) && 8134 "Exact is not allowed to be less precise than Max"); 8135 assert((isa<SCEVCouldNotCompute>(MaxNotTaken) || 8136 isa<SCEVConstant>(MaxNotTaken)) && 8137 "No point in having a non-constant max backedge taken count!"); 8138 for (auto *PredSet : PredSetList) 8139 for (auto *P : *PredSet) 8140 addPredicate(P); 8141 assert((isa<SCEVCouldNotCompute>(E) || !E->getType()->isPointerTy()) && 8142 "Backedge count should be int"); 8143 assert((isa<SCEVCouldNotCompute>(M) || !M->getType()->isPointerTy()) && 8144 "Max backedge count should be int"); 8145 } 8146 8147 ScalarEvolution::ExitLimit::ExitLimit( 8148 const SCEV *E, const SCEV *M, bool MaxOrZero, 8149 const SmallPtrSetImpl<const SCEVPredicate *> &PredSet) 8150 : ExitLimit(E, M, MaxOrZero, {&PredSet}) { 8151 } 8152 8153 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E, const SCEV *M, 8154 bool MaxOrZero) 8155 : ExitLimit(E, M, MaxOrZero, None) { 8156 } 8157 8158 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each 8159 /// computable exit into a persistent ExitNotTakenInfo array. 8160 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo( 8161 ArrayRef<ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo> ExitCounts, 8162 bool IsComplete, const SCEV *ConstantMax, bool MaxOrZero) 8163 : ConstantMax(ConstantMax), IsComplete(IsComplete), MaxOrZero(MaxOrZero) { 8164 using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo; 8165 8166 ExitNotTaken.reserve(ExitCounts.size()); 8167 std::transform( 8168 ExitCounts.begin(), ExitCounts.end(), std::back_inserter(ExitNotTaken), 8169 [&](const EdgeExitInfo &EEI) { 8170 BasicBlock *ExitBB = EEI.first; 8171 const ExitLimit &EL = EEI.second; 8172 return ExitNotTakenInfo(ExitBB, EL.ExactNotTaken, EL.MaxNotTaken, 8173 EL.Predicates); 8174 }); 8175 assert((isa<SCEVCouldNotCompute>(ConstantMax) || 8176 isa<SCEVConstant>(ConstantMax)) && 8177 "No point in having a non-constant max backedge taken count!"); 8178 } 8179 8180 /// Compute the number of times the backedge of the specified loop will execute. 8181 ScalarEvolution::BackedgeTakenInfo 8182 ScalarEvolution::computeBackedgeTakenCount(const Loop *L, 8183 bool AllowPredicates) { 8184 SmallVector<BasicBlock *, 8> ExitingBlocks; 8185 L->getExitingBlocks(ExitingBlocks); 8186 8187 using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo; 8188 8189 SmallVector<EdgeExitInfo, 4> ExitCounts; 8190 bool CouldComputeBECount = true; 8191 BasicBlock *Latch = L->getLoopLatch(); // may be NULL. 8192 const SCEV *MustExitMaxBECount = nullptr; 8193 const SCEV *MayExitMaxBECount = nullptr; 8194 bool MustExitMaxOrZero = false; 8195 8196 // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts 8197 // and compute maxBECount. 8198 // Do a union of all the predicates here. 8199 for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) { 8200 BasicBlock *ExitBB = ExitingBlocks[i]; 8201 8202 // We canonicalize untaken exits to br (constant), ignore them so that 8203 // proving an exit untaken doesn't negatively impact our ability to reason 8204 // about the loop as whole. 8205 if (auto *BI = dyn_cast<BranchInst>(ExitBB->getTerminator())) 8206 if (auto *CI = dyn_cast<ConstantInt>(BI->getCondition())) { 8207 bool ExitIfTrue = !L->contains(BI->getSuccessor(0)); 8208 if (ExitIfTrue == CI->isZero()) 8209 continue; 8210 } 8211 8212 ExitLimit EL = computeExitLimit(L, ExitBB, AllowPredicates); 8213 8214 assert((AllowPredicates || EL.Predicates.empty()) && 8215 "Predicated exit limit when predicates are not allowed!"); 8216 8217 // 1. For each exit that can be computed, add an entry to ExitCounts. 8218 // CouldComputeBECount is true only if all exits can be computed. 8219 if (EL.ExactNotTaken == getCouldNotCompute()) 8220 // We couldn't compute an exact value for this exit, so 8221 // we won't be able to compute an exact value for the loop. 8222 CouldComputeBECount = false; 8223 else 8224 ExitCounts.emplace_back(ExitBB, EL); 8225 8226 // 2. Derive the loop's MaxBECount from each exit's max number of 8227 // non-exiting iterations. Partition the loop exits into two kinds: 8228 // LoopMustExits and LoopMayExits. 8229 // 8230 // If the exit dominates the loop latch, it is a LoopMustExit otherwise it 8231 // is a LoopMayExit. If any computable LoopMustExit is found, then 8232 // MaxBECount is the minimum EL.MaxNotTaken of computable 8233 // LoopMustExits. Otherwise, MaxBECount is conservatively the maximum 8234 // EL.MaxNotTaken, where CouldNotCompute is considered greater than any 8235 // computable EL.MaxNotTaken. 8236 if (EL.MaxNotTaken != getCouldNotCompute() && Latch && 8237 DT.dominates(ExitBB, Latch)) { 8238 if (!MustExitMaxBECount) { 8239 MustExitMaxBECount = EL.MaxNotTaken; 8240 MustExitMaxOrZero = EL.MaxOrZero; 8241 } else { 8242 MustExitMaxBECount = 8243 getUMinFromMismatchedTypes(MustExitMaxBECount, EL.MaxNotTaken); 8244 } 8245 } else if (MayExitMaxBECount != getCouldNotCompute()) { 8246 if (!MayExitMaxBECount || EL.MaxNotTaken == getCouldNotCompute()) 8247 MayExitMaxBECount = EL.MaxNotTaken; 8248 else { 8249 MayExitMaxBECount = 8250 getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.MaxNotTaken); 8251 } 8252 } 8253 } 8254 const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount : 8255 (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute()); 8256 // The loop backedge will be taken the maximum or zero times if there's 8257 // a single exit that must be taken the maximum or zero times. 8258 bool MaxOrZero = (MustExitMaxOrZero && ExitingBlocks.size() == 1); 8259 8260 // Remember which SCEVs are used in exit limits for invalidation purposes. 8261 // We only care about non-constant SCEVs here, so we can ignore EL.MaxNotTaken 8262 // and MaxBECount, which must be SCEVConstant. 8263 for (const auto &Pair : ExitCounts) 8264 if (!isa<SCEVConstant>(Pair.second.ExactNotTaken)) 8265 BECountUsers[Pair.second.ExactNotTaken].insert({L, AllowPredicates}); 8266 return BackedgeTakenInfo(std::move(ExitCounts), CouldComputeBECount, 8267 MaxBECount, MaxOrZero); 8268 } 8269 8270 ScalarEvolution::ExitLimit 8271 ScalarEvolution::computeExitLimit(const Loop *L, BasicBlock *ExitingBlock, 8272 bool AllowPredicates) { 8273 assert(L->contains(ExitingBlock) && "Exit count for non-loop block?"); 8274 // If our exiting block does not dominate the latch, then its connection with 8275 // loop's exit limit may be far from trivial. 8276 const BasicBlock *Latch = L->getLoopLatch(); 8277 if (!Latch || !DT.dominates(ExitingBlock, Latch)) 8278 return getCouldNotCompute(); 8279 8280 bool IsOnlyExit = (L->getExitingBlock() != nullptr); 8281 Instruction *Term = ExitingBlock->getTerminator(); 8282 if (BranchInst *BI = dyn_cast<BranchInst>(Term)) { 8283 assert(BI->isConditional() && "If unconditional, it can't be in loop!"); 8284 bool ExitIfTrue = !L->contains(BI->getSuccessor(0)); 8285 assert(ExitIfTrue == L->contains(BI->getSuccessor(1)) && 8286 "It should have one successor in loop and one exit block!"); 8287 // Proceed to the next level to examine the exit condition expression. 8288 return computeExitLimitFromCond( 8289 L, BI->getCondition(), ExitIfTrue, 8290 /*ControlsExit=*/IsOnlyExit, AllowPredicates); 8291 } 8292 8293 if (SwitchInst *SI = dyn_cast<SwitchInst>(Term)) { 8294 // For switch, make sure that there is a single exit from the loop. 8295 BasicBlock *Exit = nullptr; 8296 for (auto *SBB : successors(ExitingBlock)) 8297 if (!L->contains(SBB)) { 8298 if (Exit) // Multiple exit successors. 8299 return getCouldNotCompute(); 8300 Exit = SBB; 8301 } 8302 assert(Exit && "Exiting block must have at least one exit"); 8303 return computeExitLimitFromSingleExitSwitch(L, SI, Exit, 8304 /*ControlsExit=*/IsOnlyExit); 8305 } 8306 8307 return getCouldNotCompute(); 8308 } 8309 8310 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCond( 8311 const Loop *L, Value *ExitCond, bool ExitIfTrue, 8312 bool ControlsExit, bool AllowPredicates) { 8313 ScalarEvolution::ExitLimitCacheTy Cache(L, ExitIfTrue, AllowPredicates); 8314 return computeExitLimitFromCondCached(Cache, L, ExitCond, ExitIfTrue, 8315 ControlsExit, AllowPredicates); 8316 } 8317 8318 Optional<ScalarEvolution::ExitLimit> 8319 ScalarEvolution::ExitLimitCache::find(const Loop *L, Value *ExitCond, 8320 bool ExitIfTrue, bool ControlsExit, 8321 bool AllowPredicates) { 8322 (void)this->L; 8323 (void)this->ExitIfTrue; 8324 (void)this->AllowPredicates; 8325 8326 assert(this->L == L && this->ExitIfTrue == ExitIfTrue && 8327 this->AllowPredicates == AllowPredicates && 8328 "Variance in assumed invariant key components!"); 8329 auto Itr = TripCountMap.find({ExitCond, ControlsExit}); 8330 if (Itr == TripCountMap.end()) 8331 return None; 8332 return Itr->second; 8333 } 8334 8335 void ScalarEvolution::ExitLimitCache::insert(const Loop *L, Value *ExitCond, 8336 bool ExitIfTrue, 8337 bool ControlsExit, 8338 bool AllowPredicates, 8339 const ExitLimit &EL) { 8340 assert(this->L == L && this->ExitIfTrue == ExitIfTrue && 8341 this->AllowPredicates == AllowPredicates && 8342 "Variance in assumed invariant key components!"); 8343 8344 auto InsertResult = TripCountMap.insert({{ExitCond, ControlsExit}, EL}); 8345 assert(InsertResult.second && "Expected successful insertion!"); 8346 (void)InsertResult; 8347 (void)ExitIfTrue; 8348 } 8349 8350 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondCached( 8351 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 8352 bool ControlsExit, bool AllowPredicates) { 8353 8354 if (auto MaybeEL = 8355 Cache.find(L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates)) 8356 return *MaybeEL; 8357 8358 ExitLimit EL = computeExitLimitFromCondImpl(Cache, L, ExitCond, ExitIfTrue, 8359 ControlsExit, AllowPredicates); 8360 Cache.insert(L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates, EL); 8361 return EL; 8362 } 8363 8364 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondImpl( 8365 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 8366 bool ControlsExit, bool AllowPredicates) { 8367 // Handle BinOp conditions (And, Or). 8368 if (auto LimitFromBinOp = computeExitLimitFromCondFromBinOp( 8369 Cache, L, ExitCond, ExitIfTrue, ControlsExit, AllowPredicates)) 8370 return *LimitFromBinOp; 8371 8372 // With an icmp, it may be feasible to compute an exact backedge-taken count. 8373 // Proceed to the next level to examine the icmp. 8374 if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond)) { 8375 ExitLimit EL = 8376 computeExitLimitFromICmp(L, ExitCondICmp, ExitIfTrue, ControlsExit); 8377 if (EL.hasFullInfo() || !AllowPredicates) 8378 return EL; 8379 8380 // Try again, but use SCEV predicates this time. 8381 return computeExitLimitFromICmp(L, ExitCondICmp, ExitIfTrue, ControlsExit, 8382 /*AllowPredicates=*/true); 8383 } 8384 8385 // Check for a constant condition. These are normally stripped out by 8386 // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to 8387 // preserve the CFG and is temporarily leaving constant conditions 8388 // in place. 8389 if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) { 8390 if (ExitIfTrue == !CI->getZExtValue()) 8391 // The backedge is always taken. 8392 return getCouldNotCompute(); 8393 else 8394 // The backedge is never taken. 8395 return getZero(CI->getType()); 8396 } 8397 8398 // If we're exiting based on the overflow flag of an x.with.overflow intrinsic 8399 // with a constant step, we can form an equivalent icmp predicate and figure 8400 // out how many iterations will be taken before we exit. 8401 const WithOverflowInst *WO; 8402 const APInt *C; 8403 if (match(ExitCond, m_ExtractValue<1>(m_WithOverflowInst(WO))) && 8404 match(WO->getRHS(), m_APInt(C))) { 8405 ConstantRange NWR = 8406 ConstantRange::makeExactNoWrapRegion(WO->getBinaryOp(), *C, 8407 WO->getNoWrapKind()); 8408 CmpInst::Predicate Pred; 8409 APInt NewRHSC, Offset; 8410 NWR.getEquivalentICmp(Pred, NewRHSC, Offset); 8411 if (!ExitIfTrue) 8412 Pred = ICmpInst::getInversePredicate(Pred); 8413 auto *LHS = getSCEV(WO->getLHS()); 8414 if (Offset != 0) 8415 LHS = getAddExpr(LHS, getConstant(Offset)); 8416 auto EL = computeExitLimitFromICmp(L, Pred, LHS, getConstant(NewRHSC), 8417 ControlsExit, AllowPredicates); 8418 if (EL.hasAnyInfo()) return EL; 8419 } 8420 8421 // If it's not an integer or pointer comparison then compute it the hard way. 8422 return computeExitCountExhaustively(L, ExitCond, ExitIfTrue); 8423 } 8424 8425 Optional<ScalarEvolution::ExitLimit> 8426 ScalarEvolution::computeExitLimitFromCondFromBinOp( 8427 ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, bool ExitIfTrue, 8428 bool ControlsExit, bool AllowPredicates) { 8429 // Check if the controlling expression for this loop is an And or Or. 8430 Value *Op0, *Op1; 8431 bool IsAnd = false; 8432 if (match(ExitCond, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) 8433 IsAnd = true; 8434 else if (match(ExitCond, m_LogicalOr(m_Value(Op0), m_Value(Op1)))) 8435 IsAnd = false; 8436 else 8437 return None; 8438 8439 // EitherMayExit is true in these two cases: 8440 // br (and Op0 Op1), loop, exit 8441 // br (or Op0 Op1), exit, loop 8442 bool EitherMayExit = IsAnd ^ ExitIfTrue; 8443 ExitLimit EL0 = computeExitLimitFromCondCached(Cache, L, Op0, ExitIfTrue, 8444 ControlsExit && !EitherMayExit, 8445 AllowPredicates); 8446 ExitLimit EL1 = computeExitLimitFromCondCached(Cache, L, Op1, ExitIfTrue, 8447 ControlsExit && !EitherMayExit, 8448 AllowPredicates); 8449 8450 // Be robust against unsimplified IR for the form "op i1 X, NeutralElement" 8451 const Constant *NeutralElement = ConstantInt::get(ExitCond->getType(), IsAnd); 8452 if (isa<ConstantInt>(Op1)) 8453 return Op1 == NeutralElement ? EL0 : EL1; 8454 if (isa<ConstantInt>(Op0)) 8455 return Op0 == NeutralElement ? EL1 : EL0; 8456 8457 const SCEV *BECount = getCouldNotCompute(); 8458 const SCEV *MaxBECount = getCouldNotCompute(); 8459 if (EitherMayExit) { 8460 // Both conditions must be same for the loop to continue executing. 8461 // Choose the less conservative count. 8462 if (EL0.ExactNotTaken != getCouldNotCompute() && 8463 EL1.ExactNotTaken != getCouldNotCompute()) { 8464 BECount = getUMinFromMismatchedTypes( 8465 EL0.ExactNotTaken, EL1.ExactNotTaken, 8466 /*Sequential=*/!isa<BinaryOperator>(ExitCond)); 8467 8468 // If EL0.ExactNotTaken was zero and ExitCond was a short-circuit form, 8469 // it should have been simplified to zero (see the condition (3) above) 8470 assert(!isa<BinaryOperator>(ExitCond) || !EL0.ExactNotTaken->isZero() || 8471 BECount->isZero()); 8472 } 8473 if (EL0.MaxNotTaken == getCouldNotCompute()) 8474 MaxBECount = EL1.MaxNotTaken; 8475 else if (EL1.MaxNotTaken == getCouldNotCompute()) 8476 MaxBECount = EL0.MaxNotTaken; 8477 else 8478 MaxBECount = getUMinFromMismatchedTypes(EL0.MaxNotTaken, EL1.MaxNotTaken); 8479 } else { 8480 // Both conditions must be same at the same time for the loop to exit. 8481 // For now, be conservative. 8482 if (EL0.ExactNotTaken == EL1.ExactNotTaken) 8483 BECount = EL0.ExactNotTaken; 8484 } 8485 8486 // There are cases (e.g. PR26207) where computeExitLimitFromCond is able 8487 // to be more aggressive when computing BECount than when computing 8488 // MaxBECount. In these cases it is possible for EL0.ExactNotTaken and 8489 // EL1.ExactNotTaken to match, but for EL0.MaxNotTaken and EL1.MaxNotTaken 8490 // to not. 8491 if (isa<SCEVCouldNotCompute>(MaxBECount) && 8492 !isa<SCEVCouldNotCompute>(BECount)) 8493 MaxBECount = getConstant(getUnsignedRangeMax(BECount)); 8494 8495 return ExitLimit(BECount, MaxBECount, false, 8496 { &EL0.Predicates, &EL1.Predicates }); 8497 } 8498 8499 ScalarEvolution::ExitLimit 8500 ScalarEvolution::computeExitLimitFromICmp(const Loop *L, 8501 ICmpInst *ExitCond, 8502 bool ExitIfTrue, 8503 bool ControlsExit, 8504 bool AllowPredicates) { 8505 // If the condition was exit on true, convert the condition to exit on false 8506 ICmpInst::Predicate Pred; 8507 if (!ExitIfTrue) 8508 Pred = ExitCond->getPredicate(); 8509 else 8510 Pred = ExitCond->getInversePredicate(); 8511 const ICmpInst::Predicate OriginalPred = Pred; 8512 8513 const SCEV *LHS = getSCEV(ExitCond->getOperand(0)); 8514 const SCEV *RHS = getSCEV(ExitCond->getOperand(1)); 8515 8516 ExitLimit EL = computeExitLimitFromICmp(L, Pred, LHS, RHS, ControlsExit, 8517 AllowPredicates); 8518 if (EL.hasAnyInfo()) return EL; 8519 8520 auto *ExhaustiveCount = 8521 computeExitCountExhaustively(L, ExitCond, ExitIfTrue); 8522 8523 if (!isa<SCEVCouldNotCompute>(ExhaustiveCount)) 8524 return ExhaustiveCount; 8525 8526 return computeShiftCompareExitLimit(ExitCond->getOperand(0), 8527 ExitCond->getOperand(1), L, OriginalPred); 8528 } 8529 ScalarEvolution::ExitLimit 8530 ScalarEvolution::computeExitLimitFromICmp(const Loop *L, 8531 ICmpInst::Predicate Pred, 8532 const SCEV *LHS, const SCEV *RHS, 8533 bool ControlsExit, 8534 bool AllowPredicates) { 8535 8536 // Try to evaluate any dependencies out of the loop. 8537 LHS = getSCEVAtScope(LHS, L); 8538 RHS = getSCEVAtScope(RHS, L); 8539 8540 // At this point, we would like to compute how many iterations of the 8541 // loop the predicate will return true for these inputs. 8542 if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) { 8543 // If there is a loop-invariant, force it into the RHS. 8544 std::swap(LHS, RHS); 8545 Pred = ICmpInst::getSwappedPredicate(Pred); 8546 } 8547 8548 bool ControllingFiniteLoop = 8549 ControlsExit && loopHasNoAbnormalExits(L) && loopIsFiniteByAssumption(L); 8550 // Simplify the operands before analyzing them. 8551 (void)SimplifyICmpOperands(Pred, LHS, RHS, /*Depth=*/0, 8552 (EnableFiniteLoopControl ? ControllingFiniteLoop 8553 : false)); 8554 8555 // If we have a comparison of a chrec against a constant, try to use value 8556 // ranges to answer this query. 8557 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) 8558 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS)) 8559 if (AddRec->getLoop() == L) { 8560 // Form the constant range. 8561 ConstantRange CompRange = 8562 ConstantRange::makeExactICmpRegion(Pred, RHSC->getAPInt()); 8563 8564 const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this); 8565 if (!isa<SCEVCouldNotCompute>(Ret)) return Ret; 8566 } 8567 8568 // If this loop must exit based on this condition (or execute undefined 8569 // behaviour), and we can prove the test sequence produced must repeat 8570 // the same values on self-wrap of the IV, then we can infer that IV 8571 // doesn't self wrap because if it did, we'd have an infinite (undefined) 8572 // loop. 8573 if (ControllingFiniteLoop && isLoopInvariant(RHS, L)) { 8574 // TODO: We can peel off any functions which are invertible *in L*. Loop 8575 // invariant terms are effectively constants for our purposes here. 8576 auto *InnerLHS = LHS; 8577 if (auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(LHS)) 8578 InnerLHS = ZExt->getOperand(); 8579 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(InnerLHS)) { 8580 auto *StrideC = dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this)); 8581 if (!AR->hasNoSelfWrap() && AR->getLoop() == L && AR->isAffine() && 8582 StrideC && StrideC->getAPInt().isPowerOf2()) { 8583 auto Flags = AR->getNoWrapFlags(); 8584 Flags = setFlags(Flags, SCEV::FlagNW); 8585 SmallVector<const SCEV*> Operands{AR->operands()}; 8586 Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags); 8587 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), Flags); 8588 } 8589 } 8590 } 8591 8592 switch (Pred) { 8593 case ICmpInst::ICMP_NE: { // while (X != Y) 8594 // Convert to: while (X-Y != 0) 8595 if (LHS->getType()->isPointerTy()) { 8596 LHS = getLosslessPtrToIntExpr(LHS); 8597 if (isa<SCEVCouldNotCompute>(LHS)) 8598 return LHS; 8599 } 8600 if (RHS->getType()->isPointerTy()) { 8601 RHS = getLosslessPtrToIntExpr(RHS); 8602 if (isa<SCEVCouldNotCompute>(RHS)) 8603 return RHS; 8604 } 8605 ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit, 8606 AllowPredicates); 8607 if (EL.hasAnyInfo()) return EL; 8608 break; 8609 } 8610 case ICmpInst::ICMP_EQ: { // while (X == Y) 8611 // Convert to: while (X-Y == 0) 8612 if (LHS->getType()->isPointerTy()) { 8613 LHS = getLosslessPtrToIntExpr(LHS); 8614 if (isa<SCEVCouldNotCompute>(LHS)) 8615 return LHS; 8616 } 8617 if (RHS->getType()->isPointerTy()) { 8618 RHS = getLosslessPtrToIntExpr(RHS); 8619 if (isa<SCEVCouldNotCompute>(RHS)) 8620 return RHS; 8621 } 8622 ExitLimit EL = howFarToNonZero(getMinusSCEV(LHS, RHS), L); 8623 if (EL.hasAnyInfo()) return EL; 8624 break; 8625 } 8626 case ICmpInst::ICMP_SLT: 8627 case ICmpInst::ICMP_ULT: { // while (X < Y) 8628 bool IsSigned = Pred == ICmpInst::ICMP_SLT; 8629 ExitLimit EL = howManyLessThans(LHS, RHS, L, IsSigned, ControlsExit, 8630 AllowPredicates); 8631 if (EL.hasAnyInfo()) return EL; 8632 break; 8633 } 8634 case ICmpInst::ICMP_SGT: 8635 case ICmpInst::ICMP_UGT: { // while (X > Y) 8636 bool IsSigned = Pred == ICmpInst::ICMP_SGT; 8637 ExitLimit EL = 8638 howManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit, 8639 AllowPredicates); 8640 if (EL.hasAnyInfo()) return EL; 8641 break; 8642 } 8643 default: 8644 break; 8645 } 8646 8647 return getCouldNotCompute(); 8648 } 8649 8650 ScalarEvolution::ExitLimit 8651 ScalarEvolution::computeExitLimitFromSingleExitSwitch(const Loop *L, 8652 SwitchInst *Switch, 8653 BasicBlock *ExitingBlock, 8654 bool ControlsExit) { 8655 assert(!L->contains(ExitingBlock) && "Not an exiting block!"); 8656 8657 // Give up if the exit is the default dest of a switch. 8658 if (Switch->getDefaultDest() == ExitingBlock) 8659 return getCouldNotCompute(); 8660 8661 assert(L->contains(Switch->getDefaultDest()) && 8662 "Default case must not exit the loop!"); 8663 const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L); 8664 const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock)); 8665 8666 // while (X != Y) --> while (X-Y != 0) 8667 ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit); 8668 if (EL.hasAnyInfo()) 8669 return EL; 8670 8671 return getCouldNotCompute(); 8672 } 8673 8674 static ConstantInt * 8675 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C, 8676 ScalarEvolution &SE) { 8677 const SCEV *InVal = SE.getConstant(C); 8678 const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE); 8679 assert(isa<SCEVConstant>(Val) && 8680 "Evaluation of SCEV at constant didn't fold correctly?"); 8681 return cast<SCEVConstant>(Val)->getValue(); 8682 } 8683 8684 ScalarEvolution::ExitLimit ScalarEvolution::computeShiftCompareExitLimit( 8685 Value *LHS, Value *RHSV, const Loop *L, ICmpInst::Predicate Pred) { 8686 ConstantInt *RHS = dyn_cast<ConstantInt>(RHSV); 8687 if (!RHS) 8688 return getCouldNotCompute(); 8689 8690 const BasicBlock *Latch = L->getLoopLatch(); 8691 if (!Latch) 8692 return getCouldNotCompute(); 8693 8694 const BasicBlock *Predecessor = L->getLoopPredecessor(); 8695 if (!Predecessor) 8696 return getCouldNotCompute(); 8697 8698 // Return true if V is of the form "LHS `shift_op` <positive constant>". 8699 // Return LHS in OutLHS and shift_opt in OutOpCode. 8700 auto MatchPositiveShift = 8701 [](Value *V, Value *&OutLHS, Instruction::BinaryOps &OutOpCode) { 8702 8703 using namespace PatternMatch; 8704 8705 ConstantInt *ShiftAmt; 8706 if (match(V, m_LShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8707 OutOpCode = Instruction::LShr; 8708 else if (match(V, m_AShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8709 OutOpCode = Instruction::AShr; 8710 else if (match(V, m_Shl(m_Value(OutLHS), m_ConstantInt(ShiftAmt)))) 8711 OutOpCode = Instruction::Shl; 8712 else 8713 return false; 8714 8715 return ShiftAmt->getValue().isStrictlyPositive(); 8716 }; 8717 8718 // Recognize a "shift recurrence" either of the form %iv or of %iv.shifted in 8719 // 8720 // loop: 8721 // %iv = phi i32 [ %iv.shifted, %loop ], [ %val, %preheader ] 8722 // %iv.shifted = lshr i32 %iv, <positive constant> 8723 // 8724 // Return true on a successful match. Return the corresponding PHI node (%iv 8725 // above) in PNOut and the opcode of the shift operation in OpCodeOut. 8726 auto MatchShiftRecurrence = 8727 [&](Value *V, PHINode *&PNOut, Instruction::BinaryOps &OpCodeOut) { 8728 Optional<Instruction::BinaryOps> PostShiftOpCode; 8729 8730 { 8731 Instruction::BinaryOps OpC; 8732 Value *V; 8733 8734 // If we encounter a shift instruction, "peel off" the shift operation, 8735 // and remember that we did so. Later when we inspect %iv's backedge 8736 // value, we will make sure that the backedge value uses the same 8737 // operation. 8738 // 8739 // Note: the peeled shift operation does not have to be the same 8740 // instruction as the one feeding into the PHI's backedge value. We only 8741 // really care about it being the same *kind* of shift instruction -- 8742 // that's all that is required for our later inferences to hold. 8743 if (MatchPositiveShift(LHS, V, OpC)) { 8744 PostShiftOpCode = OpC; 8745 LHS = V; 8746 } 8747 } 8748 8749 PNOut = dyn_cast<PHINode>(LHS); 8750 if (!PNOut || PNOut->getParent() != L->getHeader()) 8751 return false; 8752 8753 Value *BEValue = PNOut->getIncomingValueForBlock(Latch); 8754 Value *OpLHS; 8755 8756 return 8757 // The backedge value for the PHI node must be a shift by a positive 8758 // amount 8759 MatchPositiveShift(BEValue, OpLHS, OpCodeOut) && 8760 8761 // of the PHI node itself 8762 OpLHS == PNOut && 8763 8764 // and the kind of shift should be match the kind of shift we peeled 8765 // off, if any. 8766 (!PostShiftOpCode.hasValue() || *PostShiftOpCode == OpCodeOut); 8767 }; 8768 8769 PHINode *PN; 8770 Instruction::BinaryOps OpCode; 8771 if (!MatchShiftRecurrence(LHS, PN, OpCode)) 8772 return getCouldNotCompute(); 8773 8774 const DataLayout &DL = getDataLayout(); 8775 8776 // The key rationale for this optimization is that for some kinds of shift 8777 // recurrences, the value of the recurrence "stabilizes" to either 0 or -1 8778 // within a finite number of iterations. If the condition guarding the 8779 // backedge (in the sense that the backedge is taken if the condition is true) 8780 // is false for the value the shift recurrence stabilizes to, then we know 8781 // that the backedge is taken only a finite number of times. 8782 8783 ConstantInt *StableValue = nullptr; 8784 switch (OpCode) { 8785 default: 8786 llvm_unreachable("Impossible case!"); 8787 8788 case Instruction::AShr: { 8789 // {K,ashr,<positive-constant>} stabilizes to signum(K) in at most 8790 // bitwidth(K) iterations. 8791 Value *FirstValue = PN->getIncomingValueForBlock(Predecessor); 8792 KnownBits Known = computeKnownBits(FirstValue, DL, 0, &AC, 8793 Predecessor->getTerminator(), &DT); 8794 auto *Ty = cast<IntegerType>(RHS->getType()); 8795 if (Known.isNonNegative()) 8796 StableValue = ConstantInt::get(Ty, 0); 8797 else if (Known.isNegative()) 8798 StableValue = ConstantInt::get(Ty, -1, true); 8799 else 8800 return getCouldNotCompute(); 8801 8802 break; 8803 } 8804 case Instruction::LShr: 8805 case Instruction::Shl: 8806 // Both {K,lshr,<positive-constant>} and {K,shl,<positive-constant>} 8807 // stabilize to 0 in at most bitwidth(K) iterations. 8808 StableValue = ConstantInt::get(cast<IntegerType>(RHS->getType()), 0); 8809 break; 8810 } 8811 8812 auto *Result = 8813 ConstantFoldCompareInstOperands(Pred, StableValue, RHS, DL, &TLI); 8814 assert(Result->getType()->isIntegerTy(1) && 8815 "Otherwise cannot be an operand to a branch instruction"); 8816 8817 if (Result->isZeroValue()) { 8818 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 8819 const SCEV *UpperBound = 8820 getConstant(getEffectiveSCEVType(RHS->getType()), BitWidth); 8821 return ExitLimit(getCouldNotCompute(), UpperBound, false); 8822 } 8823 8824 return getCouldNotCompute(); 8825 } 8826 8827 /// Return true if we can constant fold an instruction of the specified type, 8828 /// assuming that all operands were constants. 8829 static bool CanConstantFold(const Instruction *I) { 8830 if (isa<BinaryOperator>(I) || isa<CmpInst>(I) || 8831 isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) || 8832 isa<LoadInst>(I) || isa<ExtractValueInst>(I)) 8833 return true; 8834 8835 if (const CallInst *CI = dyn_cast<CallInst>(I)) 8836 if (const Function *F = CI->getCalledFunction()) 8837 return canConstantFoldCallTo(CI, F); 8838 return false; 8839 } 8840 8841 /// Determine whether this instruction can constant evolve within this loop 8842 /// assuming its operands can all constant evolve. 8843 static bool canConstantEvolve(Instruction *I, const Loop *L) { 8844 // An instruction outside of the loop can't be derived from a loop PHI. 8845 if (!L->contains(I)) return false; 8846 8847 if (isa<PHINode>(I)) { 8848 // We don't currently keep track of the control flow needed to evaluate 8849 // PHIs, so we cannot handle PHIs inside of loops. 8850 return L->getHeader() == I->getParent(); 8851 } 8852 8853 // If we won't be able to constant fold this expression even if the operands 8854 // are constants, bail early. 8855 return CanConstantFold(I); 8856 } 8857 8858 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by 8859 /// recursing through each instruction operand until reaching a loop header phi. 8860 static PHINode * 8861 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L, 8862 DenseMap<Instruction *, PHINode *> &PHIMap, 8863 unsigned Depth) { 8864 if (Depth > MaxConstantEvolvingDepth) 8865 return nullptr; 8866 8867 // Otherwise, we can evaluate this instruction if all of its operands are 8868 // constant or derived from a PHI node themselves. 8869 PHINode *PHI = nullptr; 8870 for (Value *Op : UseInst->operands()) { 8871 if (isa<Constant>(Op)) continue; 8872 8873 Instruction *OpInst = dyn_cast<Instruction>(Op); 8874 if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr; 8875 8876 PHINode *P = dyn_cast<PHINode>(OpInst); 8877 if (!P) 8878 // If this operand is already visited, reuse the prior result. 8879 // We may have P != PHI if this is the deepest point at which the 8880 // inconsistent paths meet. 8881 P = PHIMap.lookup(OpInst); 8882 if (!P) { 8883 // Recurse and memoize the results, whether a phi is found or not. 8884 // This recursive call invalidates pointers into PHIMap. 8885 P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap, Depth + 1); 8886 PHIMap[OpInst] = P; 8887 } 8888 if (!P) 8889 return nullptr; // Not evolving from PHI 8890 if (PHI && PHI != P) 8891 return nullptr; // Evolving from multiple different PHIs. 8892 PHI = P; 8893 } 8894 // This is a expression evolving from a constant PHI! 8895 return PHI; 8896 } 8897 8898 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node 8899 /// in the loop that V is derived from. We allow arbitrary operations along the 8900 /// way, but the operands of an operation must either be constants or a value 8901 /// derived from a constant PHI. If this expression does not fit with these 8902 /// constraints, return null. 8903 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) { 8904 Instruction *I = dyn_cast<Instruction>(V); 8905 if (!I || !canConstantEvolve(I, L)) return nullptr; 8906 8907 if (PHINode *PN = dyn_cast<PHINode>(I)) 8908 return PN; 8909 8910 // Record non-constant instructions contained by the loop. 8911 DenseMap<Instruction *, PHINode *> PHIMap; 8912 return getConstantEvolvingPHIOperands(I, L, PHIMap, 0); 8913 } 8914 8915 /// EvaluateExpression - Given an expression that passes the 8916 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node 8917 /// in the loop has the value PHIVal. If we can't fold this expression for some 8918 /// reason, return null. 8919 static Constant *EvaluateExpression(Value *V, const Loop *L, 8920 DenseMap<Instruction *, Constant *> &Vals, 8921 const DataLayout &DL, 8922 const TargetLibraryInfo *TLI) { 8923 // Convenient constant check, but redundant for recursive calls. 8924 if (Constant *C = dyn_cast<Constant>(V)) return C; 8925 Instruction *I = dyn_cast<Instruction>(V); 8926 if (!I) return nullptr; 8927 8928 if (Constant *C = Vals.lookup(I)) return C; 8929 8930 // An instruction inside the loop depends on a value outside the loop that we 8931 // weren't given a mapping for, or a value such as a call inside the loop. 8932 if (!canConstantEvolve(I, L)) return nullptr; 8933 8934 // An unmapped PHI can be due to a branch or another loop inside this loop, 8935 // or due to this not being the initial iteration through a loop where we 8936 // couldn't compute the evolution of this particular PHI last time. 8937 if (isa<PHINode>(I)) return nullptr; 8938 8939 std::vector<Constant*> Operands(I->getNumOperands()); 8940 8941 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) { 8942 Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i)); 8943 if (!Operand) { 8944 Operands[i] = dyn_cast<Constant>(I->getOperand(i)); 8945 if (!Operands[i]) return nullptr; 8946 continue; 8947 } 8948 Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI); 8949 Vals[Operand] = C; 8950 if (!C) return nullptr; 8951 Operands[i] = C; 8952 } 8953 8954 if (CmpInst *CI = dyn_cast<CmpInst>(I)) 8955 return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0], 8956 Operands[1], DL, TLI); 8957 if (LoadInst *LI = dyn_cast<LoadInst>(I)) { 8958 if (!LI->isVolatile()) 8959 return ConstantFoldLoadFromConstPtr(Operands[0], LI->getType(), DL); 8960 } 8961 return ConstantFoldInstOperands(I, Operands, DL, TLI); 8962 } 8963 8964 8965 // If every incoming value to PN except the one for BB is a specific Constant, 8966 // return that, else return nullptr. 8967 static Constant *getOtherIncomingValue(PHINode *PN, BasicBlock *BB) { 8968 Constant *IncomingVal = nullptr; 8969 8970 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { 8971 if (PN->getIncomingBlock(i) == BB) 8972 continue; 8973 8974 auto *CurrentVal = dyn_cast<Constant>(PN->getIncomingValue(i)); 8975 if (!CurrentVal) 8976 return nullptr; 8977 8978 if (IncomingVal != CurrentVal) { 8979 if (IncomingVal) 8980 return nullptr; 8981 IncomingVal = CurrentVal; 8982 } 8983 } 8984 8985 return IncomingVal; 8986 } 8987 8988 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is 8989 /// in the header of its containing loop, we know the loop executes a 8990 /// constant number of times, and the PHI node is just a recurrence 8991 /// involving constants, fold it. 8992 Constant * 8993 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN, 8994 const APInt &BEs, 8995 const Loop *L) { 8996 auto I = ConstantEvolutionLoopExitValue.find(PN); 8997 if (I != ConstantEvolutionLoopExitValue.end()) 8998 return I->second; 8999 9000 if (BEs.ugt(MaxBruteForceIterations)) 9001 return ConstantEvolutionLoopExitValue[PN] = nullptr; // Not going to evaluate it. 9002 9003 Constant *&RetVal = ConstantEvolutionLoopExitValue[PN]; 9004 9005 DenseMap<Instruction *, Constant *> CurrentIterVals; 9006 BasicBlock *Header = L->getHeader(); 9007 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!"); 9008 9009 BasicBlock *Latch = L->getLoopLatch(); 9010 if (!Latch) 9011 return nullptr; 9012 9013 for (PHINode &PHI : Header->phis()) { 9014 if (auto *StartCST = getOtherIncomingValue(&PHI, Latch)) 9015 CurrentIterVals[&PHI] = StartCST; 9016 } 9017 if (!CurrentIterVals.count(PN)) 9018 return RetVal = nullptr; 9019 9020 Value *BEValue = PN->getIncomingValueForBlock(Latch); 9021 9022 // Execute the loop symbolically to determine the exit value. 9023 assert(BEs.getActiveBits() < CHAR_BIT * sizeof(unsigned) && 9024 "BEs is <= MaxBruteForceIterations which is an 'unsigned'!"); 9025 9026 unsigned NumIterations = BEs.getZExtValue(); // must be in range 9027 unsigned IterationNum = 0; 9028 const DataLayout &DL = getDataLayout(); 9029 for (; ; ++IterationNum) { 9030 if (IterationNum == NumIterations) 9031 return RetVal = CurrentIterVals[PN]; // Got exit value! 9032 9033 // Compute the value of the PHIs for the next iteration. 9034 // EvaluateExpression adds non-phi values to the CurrentIterVals map. 9035 DenseMap<Instruction *, Constant *> NextIterVals; 9036 Constant *NextPHI = 9037 EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 9038 if (!NextPHI) 9039 return nullptr; // Couldn't evaluate! 9040 NextIterVals[PN] = NextPHI; 9041 9042 bool StoppedEvolving = NextPHI == CurrentIterVals[PN]; 9043 9044 // Also evaluate the other PHI nodes. However, we don't get to stop if we 9045 // cease to be able to evaluate one of them or if they stop evolving, 9046 // because that doesn't necessarily prevent us from computing PN. 9047 SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute; 9048 for (const auto &I : CurrentIterVals) { 9049 PHINode *PHI = dyn_cast<PHINode>(I.first); 9050 if (!PHI || PHI == PN || PHI->getParent() != Header) continue; 9051 PHIsToCompute.emplace_back(PHI, I.second); 9052 } 9053 // We use two distinct loops because EvaluateExpression may invalidate any 9054 // iterators into CurrentIterVals. 9055 for (const auto &I : PHIsToCompute) { 9056 PHINode *PHI = I.first; 9057 Constant *&NextPHI = NextIterVals[PHI]; 9058 if (!NextPHI) { // Not already computed. 9059 Value *BEValue = PHI->getIncomingValueForBlock(Latch); 9060 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 9061 } 9062 if (NextPHI != I.second) 9063 StoppedEvolving = false; 9064 } 9065 9066 // If all entries in CurrentIterVals == NextIterVals then we can stop 9067 // iterating, the loop can't continue to change. 9068 if (StoppedEvolving) 9069 return RetVal = CurrentIterVals[PN]; 9070 9071 CurrentIterVals.swap(NextIterVals); 9072 } 9073 } 9074 9075 const SCEV *ScalarEvolution::computeExitCountExhaustively(const Loop *L, 9076 Value *Cond, 9077 bool ExitWhen) { 9078 PHINode *PN = getConstantEvolvingPHI(Cond, L); 9079 if (!PN) return getCouldNotCompute(); 9080 9081 // If the loop is canonicalized, the PHI will have exactly two entries. 9082 // That's the only form we support here. 9083 if (PN->getNumIncomingValues() != 2) return getCouldNotCompute(); 9084 9085 DenseMap<Instruction *, Constant *> CurrentIterVals; 9086 BasicBlock *Header = L->getHeader(); 9087 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!"); 9088 9089 BasicBlock *Latch = L->getLoopLatch(); 9090 assert(Latch && "Should follow from NumIncomingValues == 2!"); 9091 9092 for (PHINode &PHI : Header->phis()) { 9093 if (auto *StartCST = getOtherIncomingValue(&PHI, Latch)) 9094 CurrentIterVals[&PHI] = StartCST; 9095 } 9096 if (!CurrentIterVals.count(PN)) 9097 return getCouldNotCompute(); 9098 9099 // Okay, we find a PHI node that defines the trip count of this loop. Execute 9100 // the loop symbolically to determine when the condition gets a value of 9101 // "ExitWhen". 9102 unsigned MaxIterations = MaxBruteForceIterations; // Limit analysis. 9103 const DataLayout &DL = getDataLayout(); 9104 for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){ 9105 auto *CondVal = dyn_cast_or_null<ConstantInt>( 9106 EvaluateExpression(Cond, L, CurrentIterVals, DL, &TLI)); 9107 9108 // Couldn't symbolically evaluate. 9109 if (!CondVal) return getCouldNotCompute(); 9110 9111 if (CondVal->getValue() == uint64_t(ExitWhen)) { 9112 ++NumBruteForceTripCountsComputed; 9113 return getConstant(Type::getInt32Ty(getContext()), IterationNum); 9114 } 9115 9116 // Update all the PHI nodes for the next iteration. 9117 DenseMap<Instruction *, Constant *> NextIterVals; 9118 9119 // Create a list of which PHIs we need to compute. We want to do this before 9120 // calling EvaluateExpression on them because that may invalidate iterators 9121 // into CurrentIterVals. 9122 SmallVector<PHINode *, 8> PHIsToCompute; 9123 for (const auto &I : CurrentIterVals) { 9124 PHINode *PHI = dyn_cast<PHINode>(I.first); 9125 if (!PHI || PHI->getParent() != Header) continue; 9126 PHIsToCompute.push_back(PHI); 9127 } 9128 for (PHINode *PHI : PHIsToCompute) { 9129 Constant *&NextPHI = NextIterVals[PHI]; 9130 if (NextPHI) continue; // Already computed! 9131 9132 Value *BEValue = PHI->getIncomingValueForBlock(Latch); 9133 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI); 9134 } 9135 CurrentIterVals.swap(NextIterVals); 9136 } 9137 9138 // Too many iterations were needed to evaluate. 9139 return getCouldNotCompute(); 9140 } 9141 9142 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) { 9143 SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values = 9144 ValuesAtScopes[V]; 9145 // Check to see if we've folded this expression at this loop before. 9146 for (auto &LS : Values) 9147 if (LS.first == L) 9148 return LS.second ? LS.second : V; 9149 9150 Values.emplace_back(L, nullptr); 9151 9152 // Otherwise compute it. 9153 const SCEV *C = computeSCEVAtScope(V, L); 9154 for (auto &LS : reverse(ValuesAtScopes[V])) 9155 if (LS.first == L) { 9156 LS.second = C; 9157 if (!isa<SCEVConstant>(C)) 9158 ValuesAtScopesUsers[C].push_back({L, V}); 9159 break; 9160 } 9161 return C; 9162 } 9163 9164 /// This builds up a Constant using the ConstantExpr interface. That way, we 9165 /// will return Constants for objects which aren't represented by a 9166 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt. 9167 /// Returns NULL if the SCEV isn't representable as a Constant. 9168 static Constant *BuildConstantFromSCEV(const SCEV *V) { 9169 switch (V->getSCEVType()) { 9170 case scCouldNotCompute: 9171 case scAddRecExpr: 9172 return nullptr; 9173 case scConstant: 9174 return cast<SCEVConstant>(V)->getValue(); 9175 case scUnknown: 9176 return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue()); 9177 case scSignExtend: { 9178 const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V); 9179 if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand())) 9180 return ConstantExpr::getSExt(CastOp, SS->getType()); 9181 return nullptr; 9182 } 9183 case scZeroExtend: { 9184 const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V); 9185 if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand())) 9186 return ConstantExpr::getZExt(CastOp, SZ->getType()); 9187 return nullptr; 9188 } 9189 case scPtrToInt: { 9190 const SCEVPtrToIntExpr *P2I = cast<SCEVPtrToIntExpr>(V); 9191 if (Constant *CastOp = BuildConstantFromSCEV(P2I->getOperand())) 9192 return ConstantExpr::getPtrToInt(CastOp, P2I->getType()); 9193 9194 return nullptr; 9195 } 9196 case scTruncate: { 9197 const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V); 9198 if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand())) 9199 return ConstantExpr::getTrunc(CastOp, ST->getType()); 9200 return nullptr; 9201 } 9202 case scAddExpr: { 9203 const SCEVAddExpr *SA = cast<SCEVAddExpr>(V); 9204 if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) { 9205 if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) { 9206 unsigned AS = PTy->getAddressSpace(); 9207 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS); 9208 C = ConstantExpr::getBitCast(C, DestPtrTy); 9209 } 9210 for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) { 9211 Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i)); 9212 if (!C2) 9213 return nullptr; 9214 9215 // First pointer! 9216 if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) { 9217 unsigned AS = C2->getType()->getPointerAddressSpace(); 9218 std::swap(C, C2); 9219 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS); 9220 // The offsets have been converted to bytes. We can add bytes to an 9221 // i8* by GEP with the byte count in the first index. 9222 C = ConstantExpr::getBitCast(C, DestPtrTy); 9223 } 9224 9225 // Don't bother trying to sum two pointers. We probably can't 9226 // statically compute a load that results from it anyway. 9227 if (C2->getType()->isPointerTy()) 9228 return nullptr; 9229 9230 if (C->getType()->isPointerTy()) { 9231 C = ConstantExpr::getGetElementPtr(Type::getInt8Ty(C->getContext()), 9232 C, C2); 9233 } else { 9234 C = ConstantExpr::getAdd(C, C2); 9235 } 9236 } 9237 return C; 9238 } 9239 return nullptr; 9240 } 9241 case scMulExpr: { 9242 const SCEVMulExpr *SM = cast<SCEVMulExpr>(V); 9243 if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) { 9244 // Don't bother with pointers at all. 9245 if (C->getType()->isPointerTy()) 9246 return nullptr; 9247 for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) { 9248 Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i)); 9249 if (!C2 || C2->getType()->isPointerTy()) 9250 return nullptr; 9251 C = ConstantExpr::getMul(C, C2); 9252 } 9253 return C; 9254 } 9255 return nullptr; 9256 } 9257 case scUDivExpr: { 9258 const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V); 9259 if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS())) 9260 if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS())) 9261 if (LHS->getType() == RHS->getType()) 9262 return ConstantExpr::getUDiv(LHS, RHS); 9263 return nullptr; 9264 } 9265 case scSMaxExpr: 9266 case scUMaxExpr: 9267 case scSMinExpr: 9268 case scUMinExpr: 9269 case scSequentialUMinExpr: 9270 return nullptr; // TODO: smax, umax, smin, umax, umin_seq. 9271 } 9272 llvm_unreachable("Unknown SCEV kind!"); 9273 } 9274 9275 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) { 9276 if (isa<SCEVConstant>(V)) return V; 9277 9278 // If this instruction is evolved from a constant-evolving PHI, compute the 9279 // exit value from the loop without using SCEVs. 9280 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) { 9281 if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) { 9282 if (PHINode *PN = dyn_cast<PHINode>(I)) { 9283 const Loop *CurrLoop = this->LI[I->getParent()]; 9284 // Looking for loop exit value. 9285 if (CurrLoop && CurrLoop->getParentLoop() == L && 9286 PN->getParent() == CurrLoop->getHeader()) { 9287 // Okay, there is no closed form solution for the PHI node. Check 9288 // to see if the loop that contains it has a known backedge-taken 9289 // count. If so, we may be able to force computation of the exit 9290 // value. 9291 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(CurrLoop); 9292 // This trivial case can show up in some degenerate cases where 9293 // the incoming IR has not yet been fully simplified. 9294 if (BackedgeTakenCount->isZero()) { 9295 Value *InitValue = nullptr; 9296 bool MultipleInitValues = false; 9297 for (unsigned i = 0; i < PN->getNumIncomingValues(); i++) { 9298 if (!CurrLoop->contains(PN->getIncomingBlock(i))) { 9299 if (!InitValue) 9300 InitValue = PN->getIncomingValue(i); 9301 else if (InitValue != PN->getIncomingValue(i)) { 9302 MultipleInitValues = true; 9303 break; 9304 } 9305 } 9306 } 9307 if (!MultipleInitValues && InitValue) 9308 return getSCEV(InitValue); 9309 } 9310 // Do we have a loop invariant value flowing around the backedge 9311 // for a loop which must execute the backedge? 9312 if (!isa<SCEVCouldNotCompute>(BackedgeTakenCount) && 9313 isKnownPositive(BackedgeTakenCount) && 9314 PN->getNumIncomingValues() == 2) { 9315 9316 unsigned InLoopPred = 9317 CurrLoop->contains(PN->getIncomingBlock(0)) ? 0 : 1; 9318 Value *BackedgeVal = PN->getIncomingValue(InLoopPred); 9319 if (CurrLoop->isLoopInvariant(BackedgeVal)) 9320 return getSCEV(BackedgeVal); 9321 } 9322 if (auto *BTCC = dyn_cast<SCEVConstant>(BackedgeTakenCount)) { 9323 // Okay, we know how many times the containing loop executes. If 9324 // this is a constant evolving PHI node, get the final value at 9325 // the specified iteration number. 9326 Constant *RV = getConstantEvolutionLoopExitValue( 9327 PN, BTCC->getAPInt(), CurrLoop); 9328 if (RV) return getSCEV(RV); 9329 } 9330 } 9331 9332 // If there is a single-input Phi, evaluate it at our scope. If we can 9333 // prove that this replacement does not break LCSSA form, use new value. 9334 if (PN->getNumOperands() == 1) { 9335 const SCEV *Input = getSCEV(PN->getOperand(0)); 9336 const SCEV *InputAtScope = getSCEVAtScope(Input, L); 9337 // TODO: We can generalize it using LI.replacementPreservesLCSSAForm, 9338 // for the simplest case just support constants. 9339 if (isa<SCEVConstant>(InputAtScope)) return InputAtScope; 9340 } 9341 } 9342 9343 // Okay, this is an expression that we cannot symbolically evaluate 9344 // into a SCEV. Check to see if it's possible to symbolically evaluate 9345 // the arguments into constants, and if so, try to constant propagate the 9346 // result. This is particularly useful for computing loop exit values. 9347 if (CanConstantFold(I)) { 9348 SmallVector<Constant *, 4> Operands; 9349 bool MadeImprovement = false; 9350 for (Value *Op : I->operands()) { 9351 if (Constant *C = dyn_cast<Constant>(Op)) { 9352 Operands.push_back(C); 9353 continue; 9354 } 9355 9356 // If any of the operands is non-constant and if they are 9357 // non-integer and non-pointer, don't even try to analyze them 9358 // with scev techniques. 9359 if (!isSCEVable(Op->getType())) 9360 return V; 9361 9362 const SCEV *OrigV = getSCEV(Op); 9363 const SCEV *OpV = getSCEVAtScope(OrigV, L); 9364 MadeImprovement |= OrigV != OpV; 9365 9366 Constant *C = BuildConstantFromSCEV(OpV); 9367 if (!C) return V; 9368 if (C->getType() != Op->getType()) 9369 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false, 9370 Op->getType(), 9371 false), 9372 C, Op->getType()); 9373 Operands.push_back(C); 9374 } 9375 9376 // Check to see if getSCEVAtScope actually made an improvement. 9377 if (MadeImprovement) { 9378 Constant *C = nullptr; 9379 const DataLayout &DL = getDataLayout(); 9380 if (const CmpInst *CI = dyn_cast<CmpInst>(I)) 9381 C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0], 9382 Operands[1], DL, &TLI); 9383 else if (const LoadInst *Load = dyn_cast<LoadInst>(I)) { 9384 if (!Load->isVolatile()) 9385 C = ConstantFoldLoadFromConstPtr(Operands[0], Load->getType(), 9386 DL); 9387 } else 9388 C = ConstantFoldInstOperands(I, Operands, DL, &TLI); 9389 if (!C) return V; 9390 return getSCEV(C); 9391 } 9392 } 9393 } 9394 9395 // This is some other type of SCEVUnknown, just return it. 9396 return V; 9397 } 9398 9399 if (isa<SCEVCommutativeExpr>(V) || isa<SCEVSequentialMinMaxExpr>(V)) { 9400 const auto *Comm = cast<SCEVNAryExpr>(V); 9401 // Avoid performing the look-up in the common case where the specified 9402 // expression has no loop-variant portions. 9403 for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) { 9404 const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L); 9405 if (OpAtScope != Comm->getOperand(i)) { 9406 // Okay, at least one of these operands is loop variant but might be 9407 // foldable. Build a new instance of the folded commutative expression. 9408 SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(), 9409 Comm->op_begin()+i); 9410 NewOps.push_back(OpAtScope); 9411 9412 for (++i; i != e; ++i) { 9413 OpAtScope = getSCEVAtScope(Comm->getOperand(i), L); 9414 NewOps.push_back(OpAtScope); 9415 } 9416 if (isa<SCEVAddExpr>(Comm)) 9417 return getAddExpr(NewOps, Comm->getNoWrapFlags()); 9418 if (isa<SCEVMulExpr>(Comm)) 9419 return getMulExpr(NewOps, Comm->getNoWrapFlags()); 9420 if (isa<SCEVMinMaxExpr>(Comm)) 9421 return getMinMaxExpr(Comm->getSCEVType(), NewOps); 9422 if (isa<SCEVSequentialMinMaxExpr>(Comm)) 9423 return getSequentialMinMaxExpr(Comm->getSCEVType(), NewOps); 9424 llvm_unreachable("Unknown commutative / sequential min/max SCEV type!"); 9425 } 9426 } 9427 // If we got here, all operands are loop invariant. 9428 return Comm; 9429 } 9430 9431 if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) { 9432 const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L); 9433 const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L); 9434 if (LHS == Div->getLHS() && RHS == Div->getRHS()) 9435 return Div; // must be loop invariant 9436 return getUDivExpr(LHS, RHS); 9437 } 9438 9439 // If this is a loop recurrence for a loop that does not contain L, then we 9440 // are dealing with the final value computed by the loop. 9441 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) { 9442 // First, attempt to evaluate each operand. 9443 // Avoid performing the look-up in the common case where the specified 9444 // expression has no loop-variant portions. 9445 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) { 9446 const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L); 9447 if (OpAtScope == AddRec->getOperand(i)) 9448 continue; 9449 9450 // Okay, at least one of these operands is loop variant but might be 9451 // foldable. Build a new instance of the folded commutative expression. 9452 SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(), 9453 AddRec->op_begin()+i); 9454 NewOps.push_back(OpAtScope); 9455 for (++i; i != e; ++i) 9456 NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L)); 9457 9458 const SCEV *FoldedRec = 9459 getAddRecExpr(NewOps, AddRec->getLoop(), 9460 AddRec->getNoWrapFlags(SCEV::FlagNW)); 9461 AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec); 9462 // The addrec may be folded to a nonrecurrence, for example, if the 9463 // induction variable is multiplied by zero after constant folding. Go 9464 // ahead and return the folded value. 9465 if (!AddRec) 9466 return FoldedRec; 9467 break; 9468 } 9469 9470 // If the scope is outside the addrec's loop, evaluate it by using the 9471 // loop exit value of the addrec. 9472 if (!AddRec->getLoop()->contains(L)) { 9473 // To evaluate this recurrence, we need to know how many times the AddRec 9474 // loop iterates. Compute this now. 9475 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop()); 9476 if (BackedgeTakenCount == getCouldNotCompute()) return AddRec; 9477 9478 // Then, evaluate the AddRec. 9479 return AddRec->evaluateAtIteration(BackedgeTakenCount, *this); 9480 } 9481 9482 return AddRec; 9483 } 9484 9485 if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) { 9486 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L); 9487 if (Op == Cast->getOperand()) 9488 return Cast; // must be loop invariant 9489 return getCastExpr(Cast->getSCEVType(), Op, Cast->getType()); 9490 } 9491 9492 llvm_unreachable("Unknown SCEV type!"); 9493 } 9494 9495 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) { 9496 return getSCEVAtScope(getSCEV(V), L); 9497 } 9498 9499 const SCEV *ScalarEvolution::stripInjectiveFunctions(const SCEV *S) const { 9500 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) 9501 return stripInjectiveFunctions(ZExt->getOperand()); 9502 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) 9503 return stripInjectiveFunctions(SExt->getOperand()); 9504 return S; 9505 } 9506 9507 /// Finds the minimum unsigned root of the following equation: 9508 /// 9509 /// A * X = B (mod N) 9510 /// 9511 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of 9512 /// A and B isn't important. 9513 /// 9514 /// If the equation does not have a solution, SCEVCouldNotCompute is returned. 9515 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const SCEV *B, 9516 ScalarEvolution &SE) { 9517 uint32_t BW = A.getBitWidth(); 9518 assert(BW == SE.getTypeSizeInBits(B->getType())); 9519 assert(A != 0 && "A must be non-zero."); 9520 9521 // 1. D = gcd(A, N) 9522 // 9523 // The gcd of A and N may have only one prime factor: 2. The number of 9524 // trailing zeros in A is its multiplicity 9525 uint32_t Mult2 = A.countTrailingZeros(); 9526 // D = 2^Mult2 9527 9528 // 2. Check if B is divisible by D. 9529 // 9530 // B is divisible by D if and only if the multiplicity of prime factor 2 for B 9531 // is not less than multiplicity of this prime factor for D. 9532 if (SE.GetMinTrailingZeros(B) < Mult2) 9533 return SE.getCouldNotCompute(); 9534 9535 // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic 9536 // modulo (N / D). 9537 // 9538 // If D == 1, (N / D) == N == 2^BW, so we need one extra bit to represent 9539 // (N / D) in general. The inverse itself always fits into BW bits, though, 9540 // so we immediately truncate it. 9541 APInt AD = A.lshr(Mult2).zext(BW + 1); // AD = A / D 9542 APInt Mod(BW + 1, 0); 9543 Mod.setBit(BW - Mult2); // Mod = N / D 9544 APInt I = AD.multiplicativeInverse(Mod).trunc(BW); 9545 9546 // 4. Compute the minimum unsigned root of the equation: 9547 // I * (B / D) mod (N / D) 9548 // To simplify the computation, we factor out the divide by D: 9549 // (I * B mod N) / D 9550 const SCEV *D = SE.getConstant(APInt::getOneBitSet(BW, Mult2)); 9551 return SE.getUDivExactExpr(SE.getMulExpr(B, SE.getConstant(I)), D); 9552 } 9553 9554 /// For a given quadratic addrec, generate coefficients of the corresponding 9555 /// quadratic equation, multiplied by a common value to ensure that they are 9556 /// integers. 9557 /// The returned value is a tuple { A, B, C, M, BitWidth }, where 9558 /// Ax^2 + Bx + C is the quadratic function, M is the value that A, B and C 9559 /// were multiplied by, and BitWidth is the bit width of the original addrec 9560 /// coefficients. 9561 /// This function returns None if the addrec coefficients are not compile- 9562 /// time constants. 9563 static Optional<std::tuple<APInt, APInt, APInt, APInt, unsigned>> 9564 GetQuadraticEquation(const SCEVAddRecExpr *AddRec) { 9565 assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!"); 9566 const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0)); 9567 const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1)); 9568 const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2)); 9569 LLVM_DEBUG(dbgs() << __func__ << ": analyzing quadratic addrec: " 9570 << *AddRec << '\n'); 9571 9572 // We currently can only solve this if the coefficients are constants. 9573 if (!LC || !MC || !NC) { 9574 LLVM_DEBUG(dbgs() << __func__ << ": coefficients are not constant\n"); 9575 return None; 9576 } 9577 9578 APInt L = LC->getAPInt(); 9579 APInt M = MC->getAPInt(); 9580 APInt N = NC->getAPInt(); 9581 assert(!N.isZero() && "This is not a quadratic addrec"); 9582 9583 unsigned BitWidth = LC->getAPInt().getBitWidth(); 9584 unsigned NewWidth = BitWidth + 1; 9585 LLVM_DEBUG(dbgs() << __func__ << ": addrec coeff bw: " 9586 << BitWidth << '\n'); 9587 // The sign-extension (as opposed to a zero-extension) here matches the 9588 // extension used in SolveQuadraticEquationWrap (with the same motivation). 9589 N = N.sext(NewWidth); 9590 M = M.sext(NewWidth); 9591 L = L.sext(NewWidth); 9592 9593 // The increments are M, M+N, M+2N, ..., so the accumulated values are 9594 // L+M, (L+M)+(M+N), (L+M)+(M+N)+(M+2N), ..., that is, 9595 // L+M, L+2M+N, L+3M+3N, ... 9596 // After n iterations the accumulated value Acc is L + nM + n(n-1)/2 N. 9597 // 9598 // The equation Acc = 0 is then 9599 // L + nM + n(n-1)/2 N = 0, or 2L + 2M n + n(n-1) N = 0. 9600 // In a quadratic form it becomes: 9601 // N n^2 + (2M-N) n + 2L = 0. 9602 9603 APInt A = N; 9604 APInt B = 2 * M - A; 9605 APInt C = 2 * L; 9606 APInt T = APInt(NewWidth, 2); 9607 LLVM_DEBUG(dbgs() << __func__ << ": equation " << A << "x^2 + " << B 9608 << "x + " << C << ", coeff bw: " << NewWidth 9609 << ", multiplied by " << T << '\n'); 9610 return std::make_tuple(A, B, C, T, BitWidth); 9611 } 9612 9613 /// Helper function to compare optional APInts: 9614 /// (a) if X and Y both exist, return min(X, Y), 9615 /// (b) if neither X nor Y exist, return None, 9616 /// (c) if exactly one of X and Y exists, return that value. 9617 static Optional<APInt> MinOptional(Optional<APInt> X, Optional<APInt> Y) { 9618 if (X.hasValue() && Y.hasValue()) { 9619 unsigned W = std::max(X->getBitWidth(), Y->getBitWidth()); 9620 APInt XW = X->sextOrSelf(W); 9621 APInt YW = Y->sextOrSelf(W); 9622 return XW.slt(YW) ? *X : *Y; 9623 } 9624 if (!X.hasValue() && !Y.hasValue()) 9625 return None; 9626 return X.hasValue() ? *X : *Y; 9627 } 9628 9629 /// Helper function to truncate an optional APInt to a given BitWidth. 9630 /// When solving addrec-related equations, it is preferable to return a value 9631 /// that has the same bit width as the original addrec's coefficients. If the 9632 /// solution fits in the original bit width, truncate it (except for i1). 9633 /// Returning a value of a different bit width may inhibit some optimizations. 9634 /// 9635 /// In general, a solution to a quadratic equation generated from an addrec 9636 /// may require BW+1 bits, where BW is the bit width of the addrec's 9637 /// coefficients. The reason is that the coefficients of the quadratic 9638 /// equation are BW+1 bits wide (to avoid truncation when converting from 9639 /// the addrec to the equation). 9640 static Optional<APInt> TruncIfPossible(Optional<APInt> X, unsigned BitWidth) { 9641 if (!X.hasValue()) 9642 return None; 9643 unsigned W = X->getBitWidth(); 9644 if (BitWidth > 1 && BitWidth < W && X->isIntN(BitWidth)) 9645 return X->trunc(BitWidth); 9646 return X; 9647 } 9648 9649 /// Let c(n) be the value of the quadratic chrec {L,+,M,+,N} after n 9650 /// iterations. The values L, M, N are assumed to be signed, and they 9651 /// should all have the same bit widths. 9652 /// Find the least n >= 0 such that c(n) = 0 in the arithmetic modulo 2^BW, 9653 /// where BW is the bit width of the addrec's coefficients. 9654 /// If the calculated value is a BW-bit integer (for BW > 1), it will be 9655 /// returned as such, otherwise the bit width of the returned value may 9656 /// be greater than BW. 9657 /// 9658 /// This function returns None if 9659 /// (a) the addrec coefficients are not constant, or 9660 /// (b) SolveQuadraticEquationWrap was unable to find a solution. For cases 9661 /// like x^2 = 5, no integer solutions exist, in other cases an integer 9662 /// solution may exist, but SolveQuadraticEquationWrap may fail to find it. 9663 static Optional<APInt> 9664 SolveQuadraticAddRecExact(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) { 9665 APInt A, B, C, M; 9666 unsigned BitWidth; 9667 auto T = GetQuadraticEquation(AddRec); 9668 if (!T.hasValue()) 9669 return None; 9670 9671 std::tie(A, B, C, M, BitWidth) = *T; 9672 LLVM_DEBUG(dbgs() << __func__ << ": solving for unsigned overflow\n"); 9673 Optional<APInt> X = APIntOps::SolveQuadraticEquationWrap(A, B, C, BitWidth+1); 9674 if (!X.hasValue()) 9675 return None; 9676 9677 ConstantInt *CX = ConstantInt::get(SE.getContext(), *X); 9678 ConstantInt *V = EvaluateConstantChrecAtConstant(AddRec, CX, SE); 9679 if (!V->isZero()) 9680 return None; 9681 9682 return TruncIfPossible(X, BitWidth); 9683 } 9684 9685 /// Let c(n) be the value of the quadratic chrec {0,+,M,+,N} after n 9686 /// iterations. The values M, N are assumed to be signed, and they 9687 /// should all have the same bit widths. 9688 /// Find the least n such that c(n) does not belong to the given range, 9689 /// while c(n-1) does. 9690 /// 9691 /// This function returns None if 9692 /// (a) the addrec coefficients are not constant, or 9693 /// (b) SolveQuadraticEquationWrap was unable to find a solution for the 9694 /// bounds of the range. 9695 static Optional<APInt> 9696 SolveQuadraticAddRecRange(const SCEVAddRecExpr *AddRec, 9697 const ConstantRange &Range, ScalarEvolution &SE) { 9698 assert(AddRec->getOperand(0)->isZero() && 9699 "Starting value of addrec should be 0"); 9700 LLVM_DEBUG(dbgs() << __func__ << ": solving boundary crossing for range " 9701 << Range << ", addrec " << *AddRec << '\n'); 9702 // This case is handled in getNumIterationsInRange. Here we can assume that 9703 // we start in the range. 9704 assert(Range.contains(APInt(SE.getTypeSizeInBits(AddRec->getType()), 0)) && 9705 "Addrec's initial value should be in range"); 9706 9707 APInt A, B, C, M; 9708 unsigned BitWidth; 9709 auto T = GetQuadraticEquation(AddRec); 9710 if (!T.hasValue()) 9711 return None; 9712 9713 // Be careful about the return value: there can be two reasons for not 9714 // returning an actual number. First, if no solutions to the equations 9715 // were found, and second, if the solutions don't leave the given range. 9716 // The first case means that the actual solution is "unknown", the second 9717 // means that it's known, but not valid. If the solution is unknown, we 9718 // cannot make any conclusions. 9719 // Return a pair: the optional solution and a flag indicating if the 9720 // solution was found. 9721 auto SolveForBoundary = [&](APInt Bound) -> std::pair<Optional<APInt>,bool> { 9722 // Solve for signed overflow and unsigned overflow, pick the lower 9723 // solution. 9724 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: checking boundary " 9725 << Bound << " (before multiplying by " << M << ")\n"); 9726 Bound *= M; // The quadratic equation multiplier. 9727 9728 Optional<APInt> SO = None; 9729 if (BitWidth > 1) { 9730 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: solving for " 9731 "signed overflow\n"); 9732 SO = APIntOps::SolveQuadraticEquationWrap(A, B, -Bound, BitWidth); 9733 } 9734 LLVM_DEBUG(dbgs() << "SolveQuadraticAddRecRange: solving for " 9735 "unsigned overflow\n"); 9736 Optional<APInt> UO = APIntOps::SolveQuadraticEquationWrap(A, B, -Bound, 9737 BitWidth+1); 9738 9739 auto LeavesRange = [&] (const APInt &X) { 9740 ConstantInt *C0 = ConstantInt::get(SE.getContext(), X); 9741 ConstantInt *V0 = EvaluateConstantChrecAtConstant(AddRec, C0, SE); 9742 if (Range.contains(V0->getValue())) 9743 return false; 9744 // X should be at least 1, so X-1 is non-negative. 9745 ConstantInt *C1 = ConstantInt::get(SE.getContext(), X-1); 9746 ConstantInt *V1 = EvaluateConstantChrecAtConstant(AddRec, C1, SE); 9747 if (Range.contains(V1->getValue())) 9748 return true; 9749 return false; 9750 }; 9751 9752 // If SolveQuadraticEquationWrap returns None, it means that there can 9753 // be a solution, but the function failed to find it. We cannot treat it 9754 // as "no solution". 9755 if (!SO.hasValue() || !UO.hasValue()) 9756 return { None, false }; 9757 9758 // Check the smaller value first to see if it leaves the range. 9759 // At this point, both SO and UO must have values. 9760 Optional<APInt> Min = MinOptional(SO, UO); 9761 if (LeavesRange(*Min)) 9762 return { Min, true }; 9763 Optional<APInt> Max = Min == SO ? UO : SO; 9764 if (LeavesRange(*Max)) 9765 return { Max, true }; 9766 9767 // Solutions were found, but were eliminated, hence the "true". 9768 return { None, true }; 9769 }; 9770 9771 std::tie(A, B, C, M, BitWidth) = *T; 9772 // Lower bound is inclusive, subtract 1 to represent the exiting value. 9773 APInt Lower = Range.getLower().sextOrSelf(A.getBitWidth()) - 1; 9774 APInt Upper = Range.getUpper().sextOrSelf(A.getBitWidth()); 9775 auto SL = SolveForBoundary(Lower); 9776 auto SU = SolveForBoundary(Upper); 9777 // If any of the solutions was unknown, no meaninigful conclusions can 9778 // be made. 9779 if (!SL.second || !SU.second) 9780 return None; 9781 9782 // Claim: The correct solution is not some value between Min and Max. 9783 // 9784 // Justification: Assuming that Min and Max are different values, one of 9785 // them is when the first signed overflow happens, the other is when the 9786 // first unsigned overflow happens. Crossing the range boundary is only 9787 // possible via an overflow (treating 0 as a special case of it, modeling 9788 // an overflow as crossing k*2^W for some k). 9789 // 9790 // The interesting case here is when Min was eliminated as an invalid 9791 // solution, but Max was not. The argument is that if there was another 9792 // overflow between Min and Max, it would also have been eliminated if 9793 // it was considered. 9794 // 9795 // For a given boundary, it is possible to have two overflows of the same 9796 // type (signed/unsigned) without having the other type in between: this 9797 // can happen when the vertex of the parabola is between the iterations 9798 // corresponding to the overflows. This is only possible when the two 9799 // overflows cross k*2^W for the same k. In such case, if the second one 9800 // left the range (and was the first one to do so), the first overflow 9801 // would have to enter the range, which would mean that either we had left 9802 // the range before or that we started outside of it. Both of these cases 9803 // are contradictions. 9804 // 9805 // Claim: In the case where SolveForBoundary returns None, the correct 9806 // solution is not some value between the Max for this boundary and the 9807 // Min of the other boundary. 9808 // 9809 // Justification: Assume that we had such Max_A and Min_B corresponding 9810 // to range boundaries A and B and such that Max_A < Min_B. If there was 9811 // a solution between Max_A and Min_B, it would have to be caused by an 9812 // overflow corresponding to either A or B. It cannot correspond to B, 9813 // since Min_B is the first occurrence of such an overflow. If it 9814 // corresponded to A, it would have to be either a signed or an unsigned 9815 // overflow that is larger than both eliminated overflows for A. But 9816 // between the eliminated overflows and this overflow, the values would 9817 // cover the entire value space, thus crossing the other boundary, which 9818 // is a contradiction. 9819 9820 return TruncIfPossible(MinOptional(SL.first, SU.first), BitWidth); 9821 } 9822 9823 ScalarEvolution::ExitLimit 9824 ScalarEvolution::howFarToZero(const SCEV *V, const Loop *L, bool ControlsExit, 9825 bool AllowPredicates) { 9826 9827 // This is only used for loops with a "x != y" exit test. The exit condition 9828 // is now expressed as a single expression, V = x-y. So the exit test is 9829 // effectively V != 0. We know and take advantage of the fact that this 9830 // expression only being used in a comparison by zero context. 9831 9832 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 9833 // If the value is a constant 9834 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) { 9835 // If the value is already zero, the branch will execute zero times. 9836 if (C->getValue()->isZero()) return C; 9837 return getCouldNotCompute(); // Otherwise it will loop infinitely. 9838 } 9839 9840 const SCEVAddRecExpr *AddRec = 9841 dyn_cast<SCEVAddRecExpr>(stripInjectiveFunctions(V)); 9842 9843 if (!AddRec && AllowPredicates) 9844 // Try to make this an AddRec using runtime tests, in the first X 9845 // iterations of this loop, where X is the SCEV expression found by the 9846 // algorithm below. 9847 AddRec = convertSCEVToAddRecWithPredicates(V, L, Predicates); 9848 9849 if (!AddRec || AddRec->getLoop() != L) 9850 return getCouldNotCompute(); 9851 9852 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of 9853 // the quadratic equation to solve it. 9854 if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) { 9855 // We can only use this value if the chrec ends up with an exact zero 9856 // value at this index. When solving for "X*X != 5", for example, we 9857 // should not accept a root of 2. 9858 if (auto S = SolveQuadraticAddRecExact(AddRec, *this)) { 9859 const auto *R = cast<SCEVConstant>(getConstant(S.getValue())); 9860 return ExitLimit(R, R, false, Predicates); 9861 } 9862 return getCouldNotCompute(); 9863 } 9864 9865 // Otherwise we can only handle this if it is affine. 9866 if (!AddRec->isAffine()) 9867 return getCouldNotCompute(); 9868 9869 // If this is an affine expression, the execution count of this branch is 9870 // the minimum unsigned root of the following equation: 9871 // 9872 // Start + Step*N = 0 (mod 2^BW) 9873 // 9874 // equivalent to: 9875 // 9876 // Step*N = -Start (mod 2^BW) 9877 // 9878 // where BW is the common bit width of Start and Step. 9879 9880 // Get the initial value for the loop. 9881 const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop()); 9882 const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop()); 9883 9884 // For now we handle only constant steps. 9885 // 9886 // TODO: Handle a nonconstant Step given AddRec<NUW>. If the 9887 // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap 9888 // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step. 9889 // We have not yet seen any such cases. 9890 const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step); 9891 if (!StepC || StepC->getValue()->isZero()) 9892 return getCouldNotCompute(); 9893 9894 // For positive steps (counting up until unsigned overflow): 9895 // N = -Start/Step (as unsigned) 9896 // For negative steps (counting down to zero): 9897 // N = Start/-Step 9898 // First compute the unsigned distance from zero in the direction of Step. 9899 bool CountDown = StepC->getAPInt().isNegative(); 9900 const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start); 9901 9902 // Handle unitary steps, which cannot wraparound. 9903 // 1*N = -Start; -1*N = Start (mod 2^BW), so: 9904 // N = Distance (as unsigned) 9905 if (StepC->getValue()->isOne() || StepC->getValue()->isMinusOne()) { 9906 APInt MaxBECount = getUnsignedRangeMax(applyLoopGuards(Distance, L)); 9907 MaxBECount = APIntOps::umin(MaxBECount, getUnsignedRangeMax(Distance)); 9908 9909 // When a loop like "for (int i = 0; i != n; ++i) { /* body */ }" is rotated, 9910 // we end up with a loop whose backedge-taken count is n - 1. Detect this 9911 // case, and see if we can improve the bound. 9912 // 9913 // Explicitly handling this here is necessary because getUnsignedRange 9914 // isn't context-sensitive; it doesn't know that we only care about the 9915 // range inside the loop. 9916 const SCEV *Zero = getZero(Distance->getType()); 9917 const SCEV *One = getOne(Distance->getType()); 9918 const SCEV *DistancePlusOne = getAddExpr(Distance, One); 9919 if (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_NE, DistancePlusOne, Zero)) { 9920 // If Distance + 1 doesn't overflow, we can compute the maximum distance 9921 // as "unsigned_max(Distance + 1) - 1". 9922 ConstantRange CR = getUnsignedRange(DistancePlusOne); 9923 MaxBECount = APIntOps::umin(MaxBECount, CR.getUnsignedMax() - 1); 9924 } 9925 return ExitLimit(Distance, getConstant(MaxBECount), false, Predicates); 9926 } 9927 9928 // If the condition controls loop exit (the loop exits only if the expression 9929 // is true) and the addition is no-wrap we can use unsigned divide to 9930 // compute the backedge count. In this case, the step may not divide the 9931 // distance, but we don't care because if the condition is "missed" the loop 9932 // will have undefined behavior due to wrapping. 9933 if (ControlsExit && AddRec->hasNoSelfWrap() && 9934 loopHasNoAbnormalExits(AddRec->getLoop())) { 9935 const SCEV *Exact = 9936 getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step); 9937 const SCEV *Max = getCouldNotCompute(); 9938 if (Exact != getCouldNotCompute()) { 9939 APInt MaxInt = getUnsignedRangeMax(applyLoopGuards(Exact, L)); 9940 Max = getConstant(APIntOps::umin(MaxInt, getUnsignedRangeMax(Exact))); 9941 } 9942 return ExitLimit(Exact, Max, false, Predicates); 9943 } 9944 9945 // Solve the general equation. 9946 const SCEV *E = SolveLinEquationWithOverflow(StepC->getAPInt(), 9947 getNegativeSCEV(Start), *this); 9948 9949 const SCEV *M = E; 9950 if (E != getCouldNotCompute()) { 9951 APInt MaxWithGuards = getUnsignedRangeMax(applyLoopGuards(E, L)); 9952 M = getConstant(APIntOps::umin(MaxWithGuards, getUnsignedRangeMax(E))); 9953 } 9954 return ExitLimit(E, M, false, Predicates); 9955 } 9956 9957 ScalarEvolution::ExitLimit 9958 ScalarEvolution::howFarToNonZero(const SCEV *V, const Loop *L) { 9959 // Loops that look like: while (X == 0) are very strange indeed. We don't 9960 // handle them yet except for the trivial case. This could be expanded in the 9961 // future as needed. 9962 9963 // If the value is a constant, check to see if it is known to be non-zero 9964 // already. If so, the backedge will execute zero times. 9965 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) { 9966 if (!C->getValue()->isZero()) 9967 return getZero(C->getType()); 9968 return getCouldNotCompute(); // Otherwise it will loop infinitely. 9969 } 9970 9971 // We could implement others, but I really doubt anyone writes loops like 9972 // this, and if they did, they would already be constant folded. 9973 return getCouldNotCompute(); 9974 } 9975 9976 std::pair<const BasicBlock *, const BasicBlock *> 9977 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(const BasicBlock *BB) 9978 const { 9979 // If the block has a unique predecessor, then there is no path from the 9980 // predecessor to the block that does not go through the direct edge 9981 // from the predecessor to the block. 9982 if (const BasicBlock *Pred = BB->getSinglePredecessor()) 9983 return {Pred, BB}; 9984 9985 // A loop's header is defined to be a block that dominates the loop. 9986 // If the header has a unique predecessor outside the loop, it must be 9987 // a block that has exactly one successor that can reach the loop. 9988 if (const Loop *L = LI.getLoopFor(BB)) 9989 return {L->getLoopPredecessor(), L->getHeader()}; 9990 9991 return {nullptr, nullptr}; 9992 } 9993 9994 /// SCEV structural equivalence is usually sufficient for testing whether two 9995 /// expressions are equal, however for the purposes of looking for a condition 9996 /// guarding a loop, it can be useful to be a little more general, since a 9997 /// front-end may have replicated the controlling expression. 9998 static bool HasSameValue(const SCEV *A, const SCEV *B) { 9999 // Quick check to see if they are the same SCEV. 10000 if (A == B) return true; 10001 10002 auto ComputesEqualValues = [](const Instruction *A, const Instruction *B) { 10003 // Not all instructions that are "identical" compute the same value. For 10004 // instance, two distinct alloca instructions allocating the same type are 10005 // identical and do not read memory; but compute distinct values. 10006 return A->isIdenticalTo(B) && (isa<BinaryOperator>(A) || isa<GetElementPtrInst>(A)); 10007 }; 10008 10009 // Otherwise, if they're both SCEVUnknown, it's possible that they hold 10010 // two different instructions with the same value. Check for this case. 10011 if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A)) 10012 if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B)) 10013 if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue())) 10014 if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue())) 10015 if (ComputesEqualValues(AI, BI)) 10016 return true; 10017 10018 // Otherwise assume they may have a different value. 10019 return false; 10020 } 10021 10022 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred, 10023 const SCEV *&LHS, const SCEV *&RHS, 10024 unsigned Depth, 10025 bool ControllingFiniteLoop) { 10026 bool Changed = false; 10027 // Simplifies ICMP to trivial true or false by turning it into '0 == 0' or 10028 // '0 != 0'. 10029 auto TrivialCase = [&](bool TriviallyTrue) { 10030 LHS = RHS = getConstant(ConstantInt::getFalse(getContext())); 10031 Pred = TriviallyTrue ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE; 10032 return true; 10033 }; 10034 // If we hit the max recursion limit bail out. 10035 if (Depth >= 3) 10036 return false; 10037 10038 // Canonicalize a constant to the right side. 10039 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) { 10040 // Check for both operands constant. 10041 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) { 10042 if (ConstantExpr::getICmp(Pred, 10043 LHSC->getValue(), 10044 RHSC->getValue())->isNullValue()) 10045 return TrivialCase(false); 10046 else 10047 return TrivialCase(true); 10048 } 10049 // Otherwise swap the operands to put the constant on the right. 10050 std::swap(LHS, RHS); 10051 Pred = ICmpInst::getSwappedPredicate(Pred); 10052 Changed = true; 10053 } 10054 10055 // If we're comparing an addrec with a value which is loop-invariant in the 10056 // addrec's loop, put the addrec on the left. Also make a dominance check, 10057 // as both operands could be addrecs loop-invariant in each other's loop. 10058 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) { 10059 const Loop *L = AR->getLoop(); 10060 if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) { 10061 std::swap(LHS, RHS); 10062 Pred = ICmpInst::getSwappedPredicate(Pred); 10063 Changed = true; 10064 } 10065 } 10066 10067 // If there's a constant operand, canonicalize comparisons with boundary 10068 // cases, and canonicalize *-or-equal comparisons to regular comparisons. 10069 if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) { 10070 const APInt &RA = RC->getAPInt(); 10071 10072 bool SimplifiedByConstantRange = false; 10073 10074 if (!ICmpInst::isEquality(Pred)) { 10075 ConstantRange ExactCR = ConstantRange::makeExactICmpRegion(Pred, RA); 10076 if (ExactCR.isFullSet()) 10077 return TrivialCase(true); 10078 else if (ExactCR.isEmptySet()) 10079 return TrivialCase(false); 10080 10081 APInt NewRHS; 10082 CmpInst::Predicate NewPred; 10083 if (ExactCR.getEquivalentICmp(NewPred, NewRHS) && 10084 ICmpInst::isEquality(NewPred)) { 10085 // We were able to convert an inequality to an equality. 10086 Pred = NewPred; 10087 RHS = getConstant(NewRHS); 10088 Changed = SimplifiedByConstantRange = true; 10089 } 10090 } 10091 10092 if (!SimplifiedByConstantRange) { 10093 switch (Pred) { 10094 default: 10095 break; 10096 case ICmpInst::ICMP_EQ: 10097 case ICmpInst::ICMP_NE: 10098 // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b. 10099 if (!RA) 10100 if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS)) 10101 if (const SCEVMulExpr *ME = 10102 dyn_cast<SCEVMulExpr>(AE->getOperand(0))) 10103 if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 && 10104 ME->getOperand(0)->isAllOnesValue()) { 10105 RHS = AE->getOperand(1); 10106 LHS = ME->getOperand(1); 10107 Changed = true; 10108 } 10109 break; 10110 10111 10112 // The "Should have been caught earlier!" messages refer to the fact 10113 // that the ExactCR.isFullSet() or ExactCR.isEmptySet() check above 10114 // should have fired on the corresponding cases, and canonicalized the 10115 // check to trivial case. 10116 10117 case ICmpInst::ICMP_UGE: 10118 assert(!RA.isMinValue() && "Should have been caught earlier!"); 10119 Pred = ICmpInst::ICMP_UGT; 10120 RHS = getConstant(RA - 1); 10121 Changed = true; 10122 break; 10123 case ICmpInst::ICMP_ULE: 10124 assert(!RA.isMaxValue() && "Should have been caught earlier!"); 10125 Pred = ICmpInst::ICMP_ULT; 10126 RHS = getConstant(RA + 1); 10127 Changed = true; 10128 break; 10129 case ICmpInst::ICMP_SGE: 10130 assert(!RA.isMinSignedValue() && "Should have been caught earlier!"); 10131 Pred = ICmpInst::ICMP_SGT; 10132 RHS = getConstant(RA - 1); 10133 Changed = true; 10134 break; 10135 case ICmpInst::ICMP_SLE: 10136 assert(!RA.isMaxSignedValue() && "Should have been caught earlier!"); 10137 Pred = ICmpInst::ICMP_SLT; 10138 RHS = getConstant(RA + 1); 10139 Changed = true; 10140 break; 10141 } 10142 } 10143 } 10144 10145 // Check for obvious equality. 10146 if (HasSameValue(LHS, RHS)) { 10147 if (ICmpInst::isTrueWhenEqual(Pred)) 10148 return TrivialCase(true); 10149 if (ICmpInst::isFalseWhenEqual(Pred)) 10150 return TrivialCase(false); 10151 } 10152 10153 // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by 10154 // adding or subtracting 1 from one of the operands. This can be done for 10155 // one of two reasons: 10156 // 1) The range of the RHS does not include the (signed/unsigned) boundaries 10157 // 2) The loop is finite, with this comparison controlling the exit. Since the 10158 // loop is finite, the bound cannot include the corresponding boundary 10159 // (otherwise it would loop forever). 10160 switch (Pred) { 10161 case ICmpInst::ICMP_SLE: 10162 if (ControllingFiniteLoop || !getSignedRangeMax(RHS).isMaxSignedValue()) { 10163 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS, 10164 SCEV::FlagNSW); 10165 Pred = ICmpInst::ICMP_SLT; 10166 Changed = true; 10167 } else if (!getSignedRangeMin(LHS).isMinSignedValue()) { 10168 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS, 10169 SCEV::FlagNSW); 10170 Pred = ICmpInst::ICMP_SLT; 10171 Changed = true; 10172 } 10173 break; 10174 case ICmpInst::ICMP_SGE: 10175 if (ControllingFiniteLoop || !getSignedRangeMin(RHS).isMinSignedValue()) { 10176 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS, 10177 SCEV::FlagNSW); 10178 Pred = ICmpInst::ICMP_SGT; 10179 Changed = true; 10180 } else if (!getSignedRangeMax(LHS).isMaxSignedValue()) { 10181 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS, 10182 SCEV::FlagNSW); 10183 Pred = ICmpInst::ICMP_SGT; 10184 Changed = true; 10185 } 10186 break; 10187 case ICmpInst::ICMP_ULE: 10188 if (ControllingFiniteLoop || !getUnsignedRangeMax(RHS).isMaxValue()) { 10189 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS, 10190 SCEV::FlagNUW); 10191 Pred = ICmpInst::ICMP_ULT; 10192 Changed = true; 10193 } else if (!getUnsignedRangeMin(LHS).isMinValue()) { 10194 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS); 10195 Pred = ICmpInst::ICMP_ULT; 10196 Changed = true; 10197 } 10198 break; 10199 case ICmpInst::ICMP_UGE: 10200 if (ControllingFiniteLoop || !getUnsignedRangeMin(RHS).isMinValue()) { 10201 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS); 10202 Pred = ICmpInst::ICMP_UGT; 10203 Changed = true; 10204 } else if (!getUnsignedRangeMax(LHS).isMaxValue()) { 10205 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS, 10206 SCEV::FlagNUW); 10207 Pred = ICmpInst::ICMP_UGT; 10208 Changed = true; 10209 } 10210 break; 10211 default: 10212 break; 10213 } 10214 10215 // TODO: More simplifications are possible here. 10216 10217 // Recursively simplify until we either hit a recursion limit or nothing 10218 // changes. 10219 if (Changed) 10220 return SimplifyICmpOperands(Pred, LHS, RHS, Depth + 1, 10221 ControllingFiniteLoop); 10222 10223 return Changed; 10224 } 10225 10226 bool ScalarEvolution::isKnownNegative(const SCEV *S) { 10227 return getSignedRangeMax(S).isNegative(); 10228 } 10229 10230 bool ScalarEvolution::isKnownPositive(const SCEV *S) { 10231 return getSignedRangeMin(S).isStrictlyPositive(); 10232 } 10233 10234 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) { 10235 return !getSignedRangeMin(S).isNegative(); 10236 } 10237 10238 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) { 10239 return !getSignedRangeMax(S).isStrictlyPositive(); 10240 } 10241 10242 bool ScalarEvolution::isKnownNonZero(const SCEV *S) { 10243 return getUnsignedRangeMin(S) != 0; 10244 } 10245 10246 std::pair<const SCEV *, const SCEV *> 10247 ScalarEvolution::SplitIntoInitAndPostInc(const Loop *L, const SCEV *S) { 10248 // Compute SCEV on entry of loop L. 10249 const SCEV *Start = SCEVInitRewriter::rewrite(S, L, *this); 10250 if (Start == getCouldNotCompute()) 10251 return { Start, Start }; 10252 // Compute post increment SCEV for loop L. 10253 const SCEV *PostInc = SCEVPostIncRewriter::rewrite(S, L, *this); 10254 assert(PostInc != getCouldNotCompute() && "Unexpected could not compute"); 10255 return { Start, PostInc }; 10256 } 10257 10258 bool ScalarEvolution::isKnownViaInduction(ICmpInst::Predicate Pred, 10259 const SCEV *LHS, const SCEV *RHS) { 10260 // First collect all loops. 10261 SmallPtrSet<const Loop *, 8> LoopsUsed; 10262 getUsedLoops(LHS, LoopsUsed); 10263 getUsedLoops(RHS, LoopsUsed); 10264 10265 if (LoopsUsed.empty()) 10266 return false; 10267 10268 // Domination relationship must be a linear order on collected loops. 10269 #ifndef NDEBUG 10270 for (auto *L1 : LoopsUsed) 10271 for (auto *L2 : LoopsUsed) 10272 assert((DT.dominates(L1->getHeader(), L2->getHeader()) || 10273 DT.dominates(L2->getHeader(), L1->getHeader())) && 10274 "Domination relationship is not a linear order"); 10275 #endif 10276 10277 const Loop *MDL = 10278 *std::max_element(LoopsUsed.begin(), LoopsUsed.end(), 10279 [&](const Loop *L1, const Loop *L2) { 10280 return DT.properlyDominates(L1->getHeader(), L2->getHeader()); 10281 }); 10282 10283 // Get init and post increment value for LHS. 10284 auto SplitLHS = SplitIntoInitAndPostInc(MDL, LHS); 10285 // if LHS contains unknown non-invariant SCEV then bail out. 10286 if (SplitLHS.first == getCouldNotCompute()) 10287 return false; 10288 assert (SplitLHS.second != getCouldNotCompute() && "Unexpected CNC"); 10289 // Get init and post increment value for RHS. 10290 auto SplitRHS = SplitIntoInitAndPostInc(MDL, RHS); 10291 // if RHS contains unknown non-invariant SCEV then bail out. 10292 if (SplitRHS.first == getCouldNotCompute()) 10293 return false; 10294 assert (SplitRHS.second != getCouldNotCompute() && "Unexpected CNC"); 10295 // It is possible that init SCEV contains an invariant load but it does 10296 // not dominate MDL and is not available at MDL loop entry, so we should 10297 // check it here. 10298 if (!isAvailableAtLoopEntry(SplitLHS.first, MDL) || 10299 !isAvailableAtLoopEntry(SplitRHS.first, MDL)) 10300 return false; 10301 10302 // It seems backedge guard check is faster than entry one so in some cases 10303 // it can speed up whole estimation by short circuit 10304 return isLoopBackedgeGuardedByCond(MDL, Pred, SplitLHS.second, 10305 SplitRHS.second) && 10306 isLoopEntryGuardedByCond(MDL, Pred, SplitLHS.first, SplitRHS.first); 10307 } 10308 10309 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred, 10310 const SCEV *LHS, const SCEV *RHS) { 10311 // Canonicalize the inputs first. 10312 (void)SimplifyICmpOperands(Pred, LHS, RHS); 10313 10314 if (isKnownViaInduction(Pred, LHS, RHS)) 10315 return true; 10316 10317 if (isKnownPredicateViaSplitting(Pred, LHS, RHS)) 10318 return true; 10319 10320 // Otherwise see what can be done with some simple reasoning. 10321 return isKnownViaNonRecursiveReasoning(Pred, LHS, RHS); 10322 } 10323 10324 Optional<bool> ScalarEvolution::evaluatePredicate(ICmpInst::Predicate Pred, 10325 const SCEV *LHS, 10326 const SCEV *RHS) { 10327 if (isKnownPredicate(Pred, LHS, RHS)) 10328 return true; 10329 else if (isKnownPredicate(ICmpInst::getInversePredicate(Pred), LHS, RHS)) 10330 return false; 10331 return None; 10332 } 10333 10334 bool ScalarEvolution::isKnownPredicateAt(ICmpInst::Predicate Pred, 10335 const SCEV *LHS, const SCEV *RHS, 10336 const Instruction *CtxI) { 10337 // TODO: Analyze guards and assumes from Context's block. 10338 return isKnownPredicate(Pred, LHS, RHS) || 10339 isBasicBlockEntryGuardedByCond(CtxI->getParent(), Pred, LHS, RHS); 10340 } 10341 10342 Optional<bool> ScalarEvolution::evaluatePredicateAt(ICmpInst::Predicate Pred, 10343 const SCEV *LHS, 10344 const SCEV *RHS, 10345 const Instruction *CtxI) { 10346 Optional<bool> KnownWithoutContext = evaluatePredicate(Pred, LHS, RHS); 10347 if (KnownWithoutContext) 10348 return KnownWithoutContext; 10349 10350 if (isBasicBlockEntryGuardedByCond(CtxI->getParent(), Pred, LHS, RHS)) 10351 return true; 10352 else if (isBasicBlockEntryGuardedByCond(CtxI->getParent(), 10353 ICmpInst::getInversePredicate(Pred), 10354 LHS, RHS)) 10355 return false; 10356 return None; 10357 } 10358 10359 bool ScalarEvolution::isKnownOnEveryIteration(ICmpInst::Predicate Pred, 10360 const SCEVAddRecExpr *LHS, 10361 const SCEV *RHS) { 10362 const Loop *L = LHS->getLoop(); 10363 return isLoopEntryGuardedByCond(L, Pred, LHS->getStart(), RHS) && 10364 isLoopBackedgeGuardedByCond(L, Pred, LHS->getPostIncExpr(*this), RHS); 10365 } 10366 10367 Optional<ScalarEvolution::MonotonicPredicateType> 10368 ScalarEvolution::getMonotonicPredicateType(const SCEVAddRecExpr *LHS, 10369 ICmpInst::Predicate Pred) { 10370 auto Result = getMonotonicPredicateTypeImpl(LHS, Pred); 10371 10372 #ifndef NDEBUG 10373 // Verify an invariant: inverting the predicate should turn a monotonically 10374 // increasing change to a monotonically decreasing one, and vice versa. 10375 if (Result) { 10376 auto ResultSwapped = 10377 getMonotonicPredicateTypeImpl(LHS, ICmpInst::getSwappedPredicate(Pred)); 10378 10379 assert(ResultSwapped.hasValue() && "should be able to analyze both!"); 10380 assert(ResultSwapped.getValue() != Result.getValue() && 10381 "monotonicity should flip as we flip the predicate"); 10382 } 10383 #endif 10384 10385 return Result; 10386 } 10387 10388 Optional<ScalarEvolution::MonotonicPredicateType> 10389 ScalarEvolution::getMonotonicPredicateTypeImpl(const SCEVAddRecExpr *LHS, 10390 ICmpInst::Predicate Pred) { 10391 // A zero step value for LHS means the induction variable is essentially a 10392 // loop invariant value. We don't really depend on the predicate actually 10393 // flipping from false to true (for increasing predicates, and the other way 10394 // around for decreasing predicates), all we care about is that *if* the 10395 // predicate changes then it only changes from false to true. 10396 // 10397 // A zero step value in itself is not very useful, but there may be places 10398 // where SCEV can prove X >= 0 but not prove X > 0, so it is helpful to be 10399 // as general as possible. 10400 10401 // Only handle LE/LT/GE/GT predicates. 10402 if (!ICmpInst::isRelational(Pred)) 10403 return None; 10404 10405 bool IsGreater = ICmpInst::isGE(Pred) || ICmpInst::isGT(Pred); 10406 assert((IsGreater || ICmpInst::isLE(Pred) || ICmpInst::isLT(Pred)) && 10407 "Should be greater or less!"); 10408 10409 // Check that AR does not wrap. 10410 if (ICmpInst::isUnsigned(Pred)) { 10411 if (!LHS->hasNoUnsignedWrap()) 10412 return None; 10413 return IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 10414 } else { 10415 assert(ICmpInst::isSigned(Pred) && 10416 "Relational predicate is either signed or unsigned!"); 10417 if (!LHS->hasNoSignedWrap()) 10418 return None; 10419 10420 const SCEV *Step = LHS->getStepRecurrence(*this); 10421 10422 if (isKnownNonNegative(Step)) 10423 return IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 10424 10425 if (isKnownNonPositive(Step)) 10426 return !IsGreater ? MonotonicallyIncreasing : MonotonicallyDecreasing; 10427 10428 return None; 10429 } 10430 } 10431 10432 Optional<ScalarEvolution::LoopInvariantPredicate> 10433 ScalarEvolution::getLoopInvariantPredicate(ICmpInst::Predicate Pred, 10434 const SCEV *LHS, const SCEV *RHS, 10435 const Loop *L) { 10436 10437 // If there is a loop-invariant, force it into the RHS, otherwise bail out. 10438 if (!isLoopInvariant(RHS, L)) { 10439 if (!isLoopInvariant(LHS, L)) 10440 return None; 10441 10442 std::swap(LHS, RHS); 10443 Pred = ICmpInst::getSwappedPredicate(Pred); 10444 } 10445 10446 const SCEVAddRecExpr *ArLHS = dyn_cast<SCEVAddRecExpr>(LHS); 10447 if (!ArLHS || ArLHS->getLoop() != L) 10448 return None; 10449 10450 auto MonotonicType = getMonotonicPredicateType(ArLHS, Pred); 10451 if (!MonotonicType) 10452 return None; 10453 // If the predicate "ArLHS `Pred` RHS" monotonically increases from false to 10454 // true as the loop iterates, and the backedge is control dependent on 10455 // "ArLHS `Pred` RHS" == true then we can reason as follows: 10456 // 10457 // * if the predicate was false in the first iteration then the predicate 10458 // is never evaluated again, since the loop exits without taking the 10459 // backedge. 10460 // * if the predicate was true in the first iteration then it will 10461 // continue to be true for all future iterations since it is 10462 // monotonically increasing. 10463 // 10464 // For both the above possibilities, we can replace the loop varying 10465 // predicate with its value on the first iteration of the loop (which is 10466 // loop invariant). 10467 // 10468 // A similar reasoning applies for a monotonically decreasing predicate, by 10469 // replacing true with false and false with true in the above two bullets. 10470 bool Increasing = *MonotonicType == ScalarEvolution::MonotonicallyIncreasing; 10471 auto P = Increasing ? Pred : ICmpInst::getInversePredicate(Pred); 10472 10473 if (!isLoopBackedgeGuardedByCond(L, P, LHS, RHS)) 10474 return None; 10475 10476 return ScalarEvolution::LoopInvariantPredicate(Pred, ArLHS->getStart(), RHS); 10477 } 10478 10479 Optional<ScalarEvolution::LoopInvariantPredicate> 10480 ScalarEvolution::getLoopInvariantExitCondDuringFirstIterations( 10481 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, const Loop *L, 10482 const Instruction *CtxI, const SCEV *MaxIter) { 10483 // Try to prove the following set of facts: 10484 // - The predicate is monotonic in the iteration space. 10485 // - If the check does not fail on the 1st iteration: 10486 // - No overflow will happen during first MaxIter iterations; 10487 // - It will not fail on the MaxIter'th iteration. 10488 // If the check does fail on the 1st iteration, we leave the loop and no 10489 // other checks matter. 10490 10491 // If there is a loop-invariant, force it into the RHS, otherwise bail out. 10492 if (!isLoopInvariant(RHS, L)) { 10493 if (!isLoopInvariant(LHS, L)) 10494 return None; 10495 10496 std::swap(LHS, RHS); 10497 Pred = ICmpInst::getSwappedPredicate(Pred); 10498 } 10499 10500 auto *AR = dyn_cast<SCEVAddRecExpr>(LHS); 10501 if (!AR || AR->getLoop() != L) 10502 return None; 10503 10504 // The predicate must be relational (i.e. <, <=, >=, >). 10505 if (!ICmpInst::isRelational(Pred)) 10506 return None; 10507 10508 // TODO: Support steps other than +/- 1. 10509 const SCEV *Step = AR->getStepRecurrence(*this); 10510 auto *One = getOne(Step->getType()); 10511 auto *MinusOne = getNegativeSCEV(One); 10512 if (Step != One && Step != MinusOne) 10513 return None; 10514 10515 // Type mismatch here means that MaxIter is potentially larger than max 10516 // unsigned value in start type, which mean we cannot prove no wrap for the 10517 // indvar. 10518 if (AR->getType() != MaxIter->getType()) 10519 return None; 10520 10521 // Value of IV on suggested last iteration. 10522 const SCEV *Last = AR->evaluateAtIteration(MaxIter, *this); 10523 // Does it still meet the requirement? 10524 if (!isLoopBackedgeGuardedByCond(L, Pred, Last, RHS)) 10525 return None; 10526 // Because step is +/- 1 and MaxIter has same type as Start (i.e. it does 10527 // not exceed max unsigned value of this type), this effectively proves 10528 // that there is no wrap during the iteration. To prove that there is no 10529 // signed/unsigned wrap, we need to check that 10530 // Start <= Last for step = 1 or Start >= Last for step = -1. 10531 ICmpInst::Predicate NoOverflowPred = 10532 CmpInst::isSigned(Pred) ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE; 10533 if (Step == MinusOne) 10534 NoOverflowPred = CmpInst::getSwappedPredicate(NoOverflowPred); 10535 const SCEV *Start = AR->getStart(); 10536 if (!isKnownPredicateAt(NoOverflowPred, Start, Last, CtxI)) 10537 return None; 10538 10539 // Everything is fine. 10540 return ScalarEvolution::LoopInvariantPredicate(Pred, Start, RHS); 10541 } 10542 10543 bool ScalarEvolution::isKnownPredicateViaConstantRanges( 10544 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) { 10545 if (HasSameValue(LHS, RHS)) 10546 return ICmpInst::isTrueWhenEqual(Pred); 10547 10548 // This code is split out from isKnownPredicate because it is called from 10549 // within isLoopEntryGuardedByCond. 10550 10551 auto CheckRanges = [&](const ConstantRange &RangeLHS, 10552 const ConstantRange &RangeRHS) { 10553 return RangeLHS.icmp(Pred, RangeRHS); 10554 }; 10555 10556 // The check at the top of the function catches the case where the values are 10557 // known to be equal. 10558 if (Pred == CmpInst::ICMP_EQ) 10559 return false; 10560 10561 if (Pred == CmpInst::ICMP_NE) { 10562 if (CheckRanges(getSignedRange(LHS), getSignedRange(RHS)) || 10563 CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS))) 10564 return true; 10565 auto *Diff = getMinusSCEV(LHS, RHS); 10566 return !isa<SCEVCouldNotCompute>(Diff) && isKnownNonZero(Diff); 10567 } 10568 10569 if (CmpInst::isSigned(Pred)) 10570 return CheckRanges(getSignedRange(LHS), getSignedRange(RHS)); 10571 10572 return CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS)); 10573 } 10574 10575 bool ScalarEvolution::isKnownPredicateViaNoOverflow(ICmpInst::Predicate Pred, 10576 const SCEV *LHS, 10577 const SCEV *RHS) { 10578 // Match X to (A + C1)<ExpectedFlags> and Y to (A + C2)<ExpectedFlags>, where 10579 // C1 and C2 are constant integers. If either X or Y are not add expressions, 10580 // consider them as X + 0 and Y + 0 respectively. C1 and C2 are returned via 10581 // OutC1 and OutC2. 10582 auto MatchBinaryAddToConst = [this](const SCEV *X, const SCEV *Y, 10583 APInt &OutC1, APInt &OutC2, 10584 SCEV::NoWrapFlags ExpectedFlags) { 10585 const SCEV *XNonConstOp, *XConstOp; 10586 const SCEV *YNonConstOp, *YConstOp; 10587 SCEV::NoWrapFlags XFlagsPresent; 10588 SCEV::NoWrapFlags YFlagsPresent; 10589 10590 if (!splitBinaryAdd(X, XConstOp, XNonConstOp, XFlagsPresent)) { 10591 XConstOp = getZero(X->getType()); 10592 XNonConstOp = X; 10593 XFlagsPresent = ExpectedFlags; 10594 } 10595 if (!isa<SCEVConstant>(XConstOp) || 10596 (XFlagsPresent & ExpectedFlags) != ExpectedFlags) 10597 return false; 10598 10599 if (!splitBinaryAdd(Y, YConstOp, YNonConstOp, YFlagsPresent)) { 10600 YConstOp = getZero(Y->getType()); 10601 YNonConstOp = Y; 10602 YFlagsPresent = ExpectedFlags; 10603 } 10604 10605 if (!isa<SCEVConstant>(YConstOp) || 10606 (YFlagsPresent & ExpectedFlags) != ExpectedFlags) 10607 return false; 10608 10609 if (YNonConstOp != XNonConstOp) 10610 return false; 10611 10612 OutC1 = cast<SCEVConstant>(XConstOp)->getAPInt(); 10613 OutC2 = cast<SCEVConstant>(YConstOp)->getAPInt(); 10614 10615 return true; 10616 }; 10617 10618 APInt C1; 10619 APInt C2; 10620 10621 switch (Pred) { 10622 default: 10623 break; 10624 10625 case ICmpInst::ICMP_SGE: 10626 std::swap(LHS, RHS); 10627 LLVM_FALLTHROUGH; 10628 case ICmpInst::ICMP_SLE: 10629 // (X + C1)<nsw> s<= (X + C2)<nsw> if C1 s<= C2. 10630 if (MatchBinaryAddToConst(LHS, RHS, C1, C2, SCEV::FlagNSW) && C1.sle(C2)) 10631 return true; 10632 10633 break; 10634 10635 case ICmpInst::ICMP_SGT: 10636 std::swap(LHS, RHS); 10637 LLVM_FALLTHROUGH; 10638 case ICmpInst::ICMP_SLT: 10639 // (X + C1)<nsw> s< (X + C2)<nsw> if C1 s< C2. 10640 if (MatchBinaryAddToConst(LHS, RHS, C1, C2, SCEV::FlagNSW) && C1.slt(C2)) 10641 return true; 10642 10643 break; 10644 10645 case ICmpInst::ICMP_UGE: 10646 std::swap(LHS, RHS); 10647 LLVM_FALLTHROUGH; 10648 case ICmpInst::ICMP_ULE: 10649 // (X + C1)<nuw> u<= (X + C2)<nuw> for C1 u<= C2. 10650 if (MatchBinaryAddToConst(RHS, LHS, C2, C1, SCEV::FlagNUW) && C1.ule(C2)) 10651 return true; 10652 10653 break; 10654 10655 case ICmpInst::ICMP_UGT: 10656 std::swap(LHS, RHS); 10657 LLVM_FALLTHROUGH; 10658 case ICmpInst::ICMP_ULT: 10659 // (X + C1)<nuw> u< (X + C2)<nuw> if C1 u< C2. 10660 if (MatchBinaryAddToConst(RHS, LHS, C2, C1, SCEV::FlagNUW) && C1.ult(C2)) 10661 return true; 10662 break; 10663 } 10664 10665 return false; 10666 } 10667 10668 bool ScalarEvolution::isKnownPredicateViaSplitting(ICmpInst::Predicate Pred, 10669 const SCEV *LHS, 10670 const SCEV *RHS) { 10671 if (Pred != ICmpInst::ICMP_ULT || ProvingSplitPredicate) 10672 return false; 10673 10674 // Allowing arbitrary number of activations of isKnownPredicateViaSplitting on 10675 // the stack can result in exponential time complexity. 10676 SaveAndRestore<bool> Restore(ProvingSplitPredicate, true); 10677 10678 // If L >= 0 then I `ult` L <=> I >= 0 && I `slt` L 10679 // 10680 // To prove L >= 0 we use isKnownNonNegative whereas to prove I >= 0 we use 10681 // isKnownPredicate. isKnownPredicate is more powerful, but also more 10682 // expensive; and using isKnownNonNegative(RHS) is sufficient for most of the 10683 // interesting cases seen in practice. We can consider "upgrading" L >= 0 to 10684 // use isKnownPredicate later if needed. 10685 return isKnownNonNegative(RHS) && 10686 isKnownPredicate(CmpInst::ICMP_SGE, LHS, getZero(LHS->getType())) && 10687 isKnownPredicate(CmpInst::ICMP_SLT, LHS, RHS); 10688 } 10689 10690 bool ScalarEvolution::isImpliedViaGuard(const BasicBlock *BB, 10691 ICmpInst::Predicate Pred, 10692 const SCEV *LHS, const SCEV *RHS) { 10693 // No need to even try if we know the module has no guards. 10694 if (!HasGuards) 10695 return false; 10696 10697 return any_of(*BB, [&](const Instruction &I) { 10698 using namespace llvm::PatternMatch; 10699 10700 Value *Condition; 10701 return match(&I, m_Intrinsic<Intrinsic::experimental_guard>( 10702 m_Value(Condition))) && 10703 isImpliedCond(Pred, LHS, RHS, Condition, false); 10704 }); 10705 } 10706 10707 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is 10708 /// protected by a conditional between LHS and RHS. This is used to 10709 /// to eliminate casts. 10710 bool 10711 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L, 10712 ICmpInst::Predicate Pred, 10713 const SCEV *LHS, const SCEV *RHS) { 10714 // Interpret a null as meaning no loop, where there is obviously no guard 10715 // (interprocedural conditions notwithstanding). 10716 if (!L) return true; 10717 10718 if (VerifyIR) 10719 assert(!verifyFunction(*L->getHeader()->getParent(), &dbgs()) && 10720 "This cannot be done on broken IR!"); 10721 10722 10723 if (isKnownViaNonRecursiveReasoning(Pred, LHS, RHS)) 10724 return true; 10725 10726 BasicBlock *Latch = L->getLoopLatch(); 10727 if (!Latch) 10728 return false; 10729 10730 BranchInst *LoopContinuePredicate = 10731 dyn_cast<BranchInst>(Latch->getTerminator()); 10732 if (LoopContinuePredicate && LoopContinuePredicate->isConditional() && 10733 isImpliedCond(Pred, LHS, RHS, 10734 LoopContinuePredicate->getCondition(), 10735 LoopContinuePredicate->getSuccessor(0) != L->getHeader())) 10736 return true; 10737 10738 // We don't want more than one activation of the following loops on the stack 10739 // -- that can lead to O(n!) time complexity. 10740 if (WalkingBEDominatingConds) 10741 return false; 10742 10743 SaveAndRestore<bool> ClearOnExit(WalkingBEDominatingConds, true); 10744 10745 // See if we can exploit a trip count to prove the predicate. 10746 const auto &BETakenInfo = getBackedgeTakenInfo(L); 10747 const SCEV *LatchBECount = BETakenInfo.getExact(Latch, this); 10748 if (LatchBECount != getCouldNotCompute()) { 10749 // We know that Latch branches back to the loop header exactly 10750 // LatchBECount times. This means the backdege condition at Latch is 10751 // equivalent to "{0,+,1} u< LatchBECount". 10752 Type *Ty = LatchBECount->getType(); 10753 auto NoWrapFlags = SCEV::NoWrapFlags(SCEV::FlagNUW | SCEV::FlagNW); 10754 const SCEV *LoopCounter = 10755 getAddRecExpr(getZero(Ty), getOne(Ty), L, NoWrapFlags); 10756 if (isImpliedCond(Pred, LHS, RHS, ICmpInst::ICMP_ULT, LoopCounter, 10757 LatchBECount)) 10758 return true; 10759 } 10760 10761 // Check conditions due to any @llvm.assume intrinsics. 10762 for (auto &AssumeVH : AC.assumptions()) { 10763 if (!AssumeVH) 10764 continue; 10765 auto *CI = cast<CallInst>(AssumeVH); 10766 if (!DT.dominates(CI, Latch->getTerminator())) 10767 continue; 10768 10769 if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false)) 10770 return true; 10771 } 10772 10773 // If the loop is not reachable from the entry block, we risk running into an 10774 // infinite loop as we walk up into the dom tree. These loops do not matter 10775 // anyway, so we just return a conservative answer when we see them. 10776 if (!DT.isReachableFromEntry(L->getHeader())) 10777 return false; 10778 10779 if (isImpliedViaGuard(Latch, Pred, LHS, RHS)) 10780 return true; 10781 10782 for (DomTreeNode *DTN = DT[Latch], *HeaderDTN = DT[L->getHeader()]; 10783 DTN != HeaderDTN; DTN = DTN->getIDom()) { 10784 assert(DTN && "should reach the loop header before reaching the root!"); 10785 10786 BasicBlock *BB = DTN->getBlock(); 10787 if (isImpliedViaGuard(BB, Pred, LHS, RHS)) 10788 return true; 10789 10790 BasicBlock *PBB = BB->getSinglePredecessor(); 10791 if (!PBB) 10792 continue; 10793 10794 BranchInst *ContinuePredicate = dyn_cast<BranchInst>(PBB->getTerminator()); 10795 if (!ContinuePredicate || !ContinuePredicate->isConditional()) 10796 continue; 10797 10798 Value *Condition = ContinuePredicate->getCondition(); 10799 10800 // If we have an edge `E` within the loop body that dominates the only 10801 // latch, the condition guarding `E` also guards the backedge. This 10802 // reasoning works only for loops with a single latch. 10803 10804 BasicBlockEdge DominatingEdge(PBB, BB); 10805 if (DominatingEdge.isSingleEdge()) { 10806 // We're constructively (and conservatively) enumerating edges within the 10807 // loop body that dominate the latch. The dominator tree better agree 10808 // with us on this: 10809 assert(DT.dominates(DominatingEdge, Latch) && "should be!"); 10810 10811 if (isImpliedCond(Pred, LHS, RHS, Condition, 10812 BB != ContinuePredicate->getSuccessor(0))) 10813 return true; 10814 } 10815 } 10816 10817 return false; 10818 } 10819 10820 bool ScalarEvolution::isBasicBlockEntryGuardedByCond(const BasicBlock *BB, 10821 ICmpInst::Predicate Pred, 10822 const SCEV *LHS, 10823 const SCEV *RHS) { 10824 if (VerifyIR) 10825 assert(!verifyFunction(*BB->getParent(), &dbgs()) && 10826 "This cannot be done on broken IR!"); 10827 10828 // If we cannot prove strict comparison (e.g. a > b), maybe we can prove 10829 // the facts (a >= b && a != b) separately. A typical situation is when the 10830 // non-strict comparison is known from ranges and non-equality is known from 10831 // dominating predicates. If we are proving strict comparison, we always try 10832 // to prove non-equality and non-strict comparison separately. 10833 auto NonStrictPredicate = ICmpInst::getNonStrictPredicate(Pred); 10834 const bool ProvingStrictComparison = (Pred != NonStrictPredicate); 10835 bool ProvedNonStrictComparison = false; 10836 bool ProvedNonEquality = false; 10837 10838 auto SplitAndProve = 10839 [&](std::function<bool(ICmpInst::Predicate)> Fn) -> bool { 10840 if (!ProvedNonStrictComparison) 10841 ProvedNonStrictComparison = Fn(NonStrictPredicate); 10842 if (!ProvedNonEquality) 10843 ProvedNonEquality = Fn(ICmpInst::ICMP_NE); 10844 if (ProvedNonStrictComparison && ProvedNonEquality) 10845 return true; 10846 return false; 10847 }; 10848 10849 if (ProvingStrictComparison) { 10850 auto ProofFn = [&](ICmpInst::Predicate P) { 10851 return isKnownViaNonRecursiveReasoning(P, LHS, RHS); 10852 }; 10853 if (SplitAndProve(ProofFn)) 10854 return true; 10855 } 10856 10857 // Try to prove (Pred, LHS, RHS) using isImpliedViaGuard. 10858 auto ProveViaGuard = [&](const BasicBlock *Block) { 10859 if (isImpliedViaGuard(Block, Pred, LHS, RHS)) 10860 return true; 10861 if (ProvingStrictComparison) { 10862 auto ProofFn = [&](ICmpInst::Predicate P) { 10863 return isImpliedViaGuard(Block, P, LHS, RHS); 10864 }; 10865 if (SplitAndProve(ProofFn)) 10866 return true; 10867 } 10868 return false; 10869 }; 10870 10871 // Try to prove (Pred, LHS, RHS) using isImpliedCond. 10872 auto ProveViaCond = [&](const Value *Condition, bool Inverse) { 10873 const Instruction *CtxI = &BB->front(); 10874 if (isImpliedCond(Pred, LHS, RHS, Condition, Inverse, CtxI)) 10875 return true; 10876 if (ProvingStrictComparison) { 10877 auto ProofFn = [&](ICmpInst::Predicate P) { 10878 return isImpliedCond(P, LHS, RHS, Condition, Inverse, CtxI); 10879 }; 10880 if (SplitAndProve(ProofFn)) 10881 return true; 10882 } 10883 return false; 10884 }; 10885 10886 // Starting at the block's predecessor, climb up the predecessor chain, as long 10887 // as there are predecessors that can be found that have unique successors 10888 // leading to the original block. 10889 const Loop *ContainingLoop = LI.getLoopFor(BB); 10890 const BasicBlock *PredBB; 10891 if (ContainingLoop && ContainingLoop->getHeader() == BB) 10892 PredBB = ContainingLoop->getLoopPredecessor(); 10893 else 10894 PredBB = BB->getSinglePredecessor(); 10895 for (std::pair<const BasicBlock *, const BasicBlock *> Pair(PredBB, BB); 10896 Pair.first; Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) { 10897 if (ProveViaGuard(Pair.first)) 10898 return true; 10899 10900 const BranchInst *LoopEntryPredicate = 10901 dyn_cast<BranchInst>(Pair.first->getTerminator()); 10902 if (!LoopEntryPredicate || 10903 LoopEntryPredicate->isUnconditional()) 10904 continue; 10905 10906 if (ProveViaCond(LoopEntryPredicate->getCondition(), 10907 LoopEntryPredicate->getSuccessor(0) != Pair.second)) 10908 return true; 10909 } 10910 10911 // Check conditions due to any @llvm.assume intrinsics. 10912 for (auto &AssumeVH : AC.assumptions()) { 10913 if (!AssumeVH) 10914 continue; 10915 auto *CI = cast<CallInst>(AssumeVH); 10916 if (!DT.dominates(CI, BB)) 10917 continue; 10918 10919 if (ProveViaCond(CI->getArgOperand(0), false)) 10920 return true; 10921 } 10922 10923 return false; 10924 } 10925 10926 bool ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L, 10927 ICmpInst::Predicate Pred, 10928 const SCEV *LHS, 10929 const SCEV *RHS) { 10930 // Interpret a null as meaning no loop, where there is obviously no guard 10931 // (interprocedural conditions notwithstanding). 10932 if (!L) 10933 return false; 10934 10935 // Both LHS and RHS must be available at loop entry. 10936 assert(isAvailableAtLoopEntry(LHS, L) && 10937 "LHS is not available at Loop Entry"); 10938 assert(isAvailableAtLoopEntry(RHS, L) && 10939 "RHS is not available at Loop Entry"); 10940 10941 if (isKnownViaNonRecursiveReasoning(Pred, LHS, RHS)) 10942 return true; 10943 10944 return isBasicBlockEntryGuardedByCond(L->getHeader(), Pred, LHS, RHS); 10945 } 10946 10947 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS, 10948 const SCEV *RHS, 10949 const Value *FoundCondValue, bool Inverse, 10950 const Instruction *CtxI) { 10951 // False conditions implies anything. Do not bother analyzing it further. 10952 if (FoundCondValue == 10953 ConstantInt::getBool(FoundCondValue->getContext(), Inverse)) 10954 return true; 10955 10956 if (!PendingLoopPredicates.insert(FoundCondValue).second) 10957 return false; 10958 10959 auto ClearOnExit = 10960 make_scope_exit([&]() { PendingLoopPredicates.erase(FoundCondValue); }); 10961 10962 // Recursively handle And and Or conditions. 10963 const Value *Op0, *Op1; 10964 if (match(FoundCondValue, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) { 10965 if (!Inverse) 10966 return isImpliedCond(Pred, LHS, RHS, Op0, Inverse, CtxI) || 10967 isImpliedCond(Pred, LHS, RHS, Op1, Inverse, CtxI); 10968 } else if (match(FoundCondValue, m_LogicalOr(m_Value(Op0), m_Value(Op1)))) { 10969 if (Inverse) 10970 return isImpliedCond(Pred, LHS, RHS, Op0, Inverse, CtxI) || 10971 isImpliedCond(Pred, LHS, RHS, Op1, Inverse, CtxI); 10972 } 10973 10974 const ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue); 10975 if (!ICI) return false; 10976 10977 // Now that we found a conditional branch that dominates the loop or controls 10978 // the loop latch. Check to see if it is the comparison we are looking for. 10979 ICmpInst::Predicate FoundPred; 10980 if (Inverse) 10981 FoundPred = ICI->getInversePredicate(); 10982 else 10983 FoundPred = ICI->getPredicate(); 10984 10985 const SCEV *FoundLHS = getSCEV(ICI->getOperand(0)); 10986 const SCEV *FoundRHS = getSCEV(ICI->getOperand(1)); 10987 10988 return isImpliedCond(Pred, LHS, RHS, FoundPred, FoundLHS, FoundRHS, CtxI); 10989 } 10990 10991 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS, 10992 const SCEV *RHS, 10993 ICmpInst::Predicate FoundPred, 10994 const SCEV *FoundLHS, const SCEV *FoundRHS, 10995 const Instruction *CtxI) { 10996 // Balance the types. 10997 if (getTypeSizeInBits(LHS->getType()) < 10998 getTypeSizeInBits(FoundLHS->getType())) { 10999 // For unsigned and equality predicates, try to prove that both found 11000 // operands fit into narrow unsigned range. If so, try to prove facts in 11001 // narrow types. 11002 if (!CmpInst::isSigned(FoundPred) && !FoundLHS->getType()->isPointerTy() && 11003 !FoundRHS->getType()->isPointerTy()) { 11004 auto *NarrowType = LHS->getType(); 11005 auto *WideType = FoundLHS->getType(); 11006 auto BitWidth = getTypeSizeInBits(NarrowType); 11007 const SCEV *MaxValue = getZeroExtendExpr( 11008 getConstant(APInt::getMaxValue(BitWidth)), WideType); 11009 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, FoundLHS, 11010 MaxValue) && 11011 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, FoundRHS, 11012 MaxValue)) { 11013 const SCEV *TruncFoundLHS = getTruncateExpr(FoundLHS, NarrowType); 11014 const SCEV *TruncFoundRHS = getTruncateExpr(FoundRHS, NarrowType); 11015 if (isImpliedCondBalancedTypes(Pred, LHS, RHS, FoundPred, TruncFoundLHS, 11016 TruncFoundRHS, CtxI)) 11017 return true; 11018 } 11019 } 11020 11021 if (LHS->getType()->isPointerTy() || RHS->getType()->isPointerTy()) 11022 return false; 11023 if (CmpInst::isSigned(Pred)) { 11024 LHS = getSignExtendExpr(LHS, FoundLHS->getType()); 11025 RHS = getSignExtendExpr(RHS, FoundLHS->getType()); 11026 } else { 11027 LHS = getZeroExtendExpr(LHS, FoundLHS->getType()); 11028 RHS = getZeroExtendExpr(RHS, FoundLHS->getType()); 11029 } 11030 } else if (getTypeSizeInBits(LHS->getType()) > 11031 getTypeSizeInBits(FoundLHS->getType())) { 11032 if (FoundLHS->getType()->isPointerTy() || FoundRHS->getType()->isPointerTy()) 11033 return false; 11034 if (CmpInst::isSigned(FoundPred)) { 11035 FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType()); 11036 FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType()); 11037 } else { 11038 FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType()); 11039 FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType()); 11040 } 11041 } 11042 return isImpliedCondBalancedTypes(Pred, LHS, RHS, FoundPred, FoundLHS, 11043 FoundRHS, CtxI); 11044 } 11045 11046 bool ScalarEvolution::isImpliedCondBalancedTypes( 11047 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 11048 ICmpInst::Predicate FoundPred, const SCEV *FoundLHS, const SCEV *FoundRHS, 11049 const Instruction *CtxI) { 11050 assert(getTypeSizeInBits(LHS->getType()) == 11051 getTypeSizeInBits(FoundLHS->getType()) && 11052 "Types should be balanced!"); 11053 // Canonicalize the query to match the way instcombine will have 11054 // canonicalized the comparison. 11055 if (SimplifyICmpOperands(Pred, LHS, RHS)) 11056 if (LHS == RHS) 11057 return CmpInst::isTrueWhenEqual(Pred); 11058 if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS)) 11059 if (FoundLHS == FoundRHS) 11060 return CmpInst::isFalseWhenEqual(FoundPred); 11061 11062 // Check to see if we can make the LHS or RHS match. 11063 if (LHS == FoundRHS || RHS == FoundLHS) { 11064 if (isa<SCEVConstant>(RHS)) { 11065 std::swap(FoundLHS, FoundRHS); 11066 FoundPred = ICmpInst::getSwappedPredicate(FoundPred); 11067 } else { 11068 std::swap(LHS, RHS); 11069 Pred = ICmpInst::getSwappedPredicate(Pred); 11070 } 11071 } 11072 11073 // Check whether the found predicate is the same as the desired predicate. 11074 if (FoundPred == Pred) 11075 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, CtxI); 11076 11077 // Check whether swapping the found predicate makes it the same as the 11078 // desired predicate. 11079 if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) { 11080 // We can write the implication 11081 // 0. LHS Pred RHS <- FoundLHS SwapPred FoundRHS 11082 // using one of the following ways: 11083 // 1. LHS Pred RHS <- FoundRHS Pred FoundLHS 11084 // 2. RHS SwapPred LHS <- FoundLHS SwapPred FoundRHS 11085 // 3. LHS Pred RHS <- ~FoundLHS Pred ~FoundRHS 11086 // 4. ~LHS SwapPred ~RHS <- FoundLHS SwapPred FoundRHS 11087 // Forms 1. and 2. require swapping the operands of one condition. Don't 11088 // do this if it would break canonical constant/addrec ordering. 11089 if (!isa<SCEVConstant>(RHS) && !isa<SCEVAddRecExpr>(LHS)) 11090 return isImpliedCondOperands(FoundPred, RHS, LHS, FoundLHS, FoundRHS, 11091 CtxI); 11092 if (!isa<SCEVConstant>(FoundRHS) && !isa<SCEVAddRecExpr>(FoundLHS)) 11093 return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS, CtxI); 11094 11095 // There's no clear preference between forms 3. and 4., try both. Avoid 11096 // forming getNotSCEV of pointer values as the resulting subtract is 11097 // not legal. 11098 if (!LHS->getType()->isPointerTy() && !RHS->getType()->isPointerTy() && 11099 isImpliedCondOperands(FoundPred, getNotSCEV(LHS), getNotSCEV(RHS), 11100 FoundLHS, FoundRHS, CtxI)) 11101 return true; 11102 11103 if (!FoundLHS->getType()->isPointerTy() && 11104 !FoundRHS->getType()->isPointerTy() && 11105 isImpliedCondOperands(Pred, LHS, RHS, getNotSCEV(FoundLHS), 11106 getNotSCEV(FoundRHS), CtxI)) 11107 return true; 11108 11109 return false; 11110 } 11111 11112 auto IsSignFlippedPredicate = [](CmpInst::Predicate P1, 11113 CmpInst::Predicate P2) { 11114 assert(P1 != P2 && "Handled earlier!"); 11115 return CmpInst::isRelational(P2) && 11116 P1 == CmpInst::getFlippedSignednessPredicate(P2); 11117 }; 11118 if (IsSignFlippedPredicate(Pred, FoundPred)) { 11119 // Unsigned comparison is the same as signed comparison when both the 11120 // operands are non-negative or negative. 11121 if ((isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS)) || 11122 (isKnownNegative(FoundLHS) && isKnownNegative(FoundRHS))) 11123 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, CtxI); 11124 // Create local copies that we can freely swap and canonicalize our 11125 // conditions to "le/lt". 11126 ICmpInst::Predicate CanonicalPred = Pred, CanonicalFoundPred = FoundPred; 11127 const SCEV *CanonicalLHS = LHS, *CanonicalRHS = RHS, 11128 *CanonicalFoundLHS = FoundLHS, *CanonicalFoundRHS = FoundRHS; 11129 if (ICmpInst::isGT(CanonicalPred) || ICmpInst::isGE(CanonicalPred)) { 11130 CanonicalPred = ICmpInst::getSwappedPredicate(CanonicalPred); 11131 CanonicalFoundPred = ICmpInst::getSwappedPredicate(CanonicalFoundPred); 11132 std::swap(CanonicalLHS, CanonicalRHS); 11133 std::swap(CanonicalFoundLHS, CanonicalFoundRHS); 11134 } 11135 assert((ICmpInst::isLT(CanonicalPred) || ICmpInst::isLE(CanonicalPred)) && 11136 "Must be!"); 11137 assert((ICmpInst::isLT(CanonicalFoundPred) || 11138 ICmpInst::isLE(CanonicalFoundPred)) && 11139 "Must be!"); 11140 if (ICmpInst::isSigned(CanonicalPred) && isKnownNonNegative(CanonicalRHS)) 11141 // Use implication: 11142 // x <u y && y >=s 0 --> x <s y. 11143 // If we can prove the left part, the right part is also proven. 11144 return isImpliedCondOperands(CanonicalFoundPred, CanonicalLHS, 11145 CanonicalRHS, CanonicalFoundLHS, 11146 CanonicalFoundRHS); 11147 if (ICmpInst::isUnsigned(CanonicalPred) && isKnownNegative(CanonicalRHS)) 11148 // Use implication: 11149 // x <s y && y <s 0 --> x <u y. 11150 // If we can prove the left part, the right part is also proven. 11151 return isImpliedCondOperands(CanonicalFoundPred, CanonicalLHS, 11152 CanonicalRHS, CanonicalFoundLHS, 11153 CanonicalFoundRHS); 11154 } 11155 11156 // Check if we can make progress by sharpening ranges. 11157 if (FoundPred == ICmpInst::ICMP_NE && 11158 (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) { 11159 11160 const SCEVConstant *C = nullptr; 11161 const SCEV *V = nullptr; 11162 11163 if (isa<SCEVConstant>(FoundLHS)) { 11164 C = cast<SCEVConstant>(FoundLHS); 11165 V = FoundRHS; 11166 } else { 11167 C = cast<SCEVConstant>(FoundRHS); 11168 V = FoundLHS; 11169 } 11170 11171 // The guarding predicate tells us that C != V. If the known range 11172 // of V is [C, t), we can sharpen the range to [C + 1, t). The 11173 // range we consider has to correspond to same signedness as the 11174 // predicate we're interested in folding. 11175 11176 APInt Min = ICmpInst::isSigned(Pred) ? 11177 getSignedRangeMin(V) : getUnsignedRangeMin(V); 11178 11179 if (Min == C->getAPInt()) { 11180 // Given (V >= Min && V != Min) we conclude V >= (Min + 1). 11181 // This is true even if (Min + 1) wraps around -- in case of 11182 // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)). 11183 11184 APInt SharperMin = Min + 1; 11185 11186 switch (Pred) { 11187 case ICmpInst::ICMP_SGE: 11188 case ICmpInst::ICMP_UGE: 11189 // We know V `Pred` SharperMin. If this implies LHS `Pred` 11190 // RHS, we're done. 11191 if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(SharperMin), 11192 CtxI)) 11193 return true; 11194 LLVM_FALLTHROUGH; 11195 11196 case ICmpInst::ICMP_SGT: 11197 case ICmpInst::ICMP_UGT: 11198 // We know from the range information that (V `Pred` Min || 11199 // V == Min). We know from the guarding condition that !(V 11200 // == Min). This gives us 11201 // 11202 // V `Pred` Min || V == Min && !(V == Min) 11203 // => V `Pred` Min 11204 // 11205 // If V `Pred` Min implies LHS `Pred` RHS, we're done. 11206 11207 if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min), CtxI)) 11208 return true; 11209 break; 11210 11211 // `LHS < RHS` and `LHS <= RHS` are handled in the same way as `RHS > LHS` and `RHS >= LHS` respectively. 11212 case ICmpInst::ICMP_SLE: 11213 case ICmpInst::ICMP_ULE: 11214 if (isImpliedCondOperands(CmpInst::getSwappedPredicate(Pred), RHS, 11215 LHS, V, getConstant(SharperMin), CtxI)) 11216 return true; 11217 LLVM_FALLTHROUGH; 11218 11219 case ICmpInst::ICMP_SLT: 11220 case ICmpInst::ICMP_ULT: 11221 if (isImpliedCondOperands(CmpInst::getSwappedPredicate(Pred), RHS, 11222 LHS, V, getConstant(Min), CtxI)) 11223 return true; 11224 break; 11225 11226 default: 11227 // No change 11228 break; 11229 } 11230 } 11231 } 11232 11233 // Check whether the actual condition is beyond sufficient. 11234 if (FoundPred == ICmpInst::ICMP_EQ) 11235 if (ICmpInst::isTrueWhenEqual(Pred)) 11236 if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS, CtxI)) 11237 return true; 11238 if (Pred == ICmpInst::ICMP_NE) 11239 if (!ICmpInst::isTrueWhenEqual(FoundPred)) 11240 if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS, CtxI)) 11241 return true; 11242 11243 // Otherwise assume the worst. 11244 return false; 11245 } 11246 11247 bool ScalarEvolution::splitBinaryAdd(const SCEV *Expr, 11248 const SCEV *&L, const SCEV *&R, 11249 SCEV::NoWrapFlags &Flags) { 11250 const auto *AE = dyn_cast<SCEVAddExpr>(Expr); 11251 if (!AE || AE->getNumOperands() != 2) 11252 return false; 11253 11254 L = AE->getOperand(0); 11255 R = AE->getOperand(1); 11256 Flags = AE->getNoWrapFlags(); 11257 return true; 11258 } 11259 11260 Optional<APInt> ScalarEvolution::computeConstantDifference(const SCEV *More, 11261 const SCEV *Less) { 11262 // We avoid subtracting expressions here because this function is usually 11263 // fairly deep in the call stack (i.e. is called many times). 11264 11265 // X - X = 0. 11266 if (More == Less) 11267 return APInt(getTypeSizeInBits(More->getType()), 0); 11268 11269 if (isa<SCEVAddRecExpr>(Less) && isa<SCEVAddRecExpr>(More)) { 11270 const auto *LAR = cast<SCEVAddRecExpr>(Less); 11271 const auto *MAR = cast<SCEVAddRecExpr>(More); 11272 11273 if (LAR->getLoop() != MAR->getLoop()) 11274 return None; 11275 11276 // We look at affine expressions only; not for correctness but to keep 11277 // getStepRecurrence cheap. 11278 if (!LAR->isAffine() || !MAR->isAffine()) 11279 return None; 11280 11281 if (LAR->getStepRecurrence(*this) != MAR->getStepRecurrence(*this)) 11282 return None; 11283 11284 Less = LAR->getStart(); 11285 More = MAR->getStart(); 11286 11287 // fall through 11288 } 11289 11290 if (isa<SCEVConstant>(Less) && isa<SCEVConstant>(More)) { 11291 const auto &M = cast<SCEVConstant>(More)->getAPInt(); 11292 const auto &L = cast<SCEVConstant>(Less)->getAPInt(); 11293 return M - L; 11294 } 11295 11296 SCEV::NoWrapFlags Flags; 11297 const SCEV *LLess = nullptr, *RLess = nullptr; 11298 const SCEV *LMore = nullptr, *RMore = nullptr; 11299 const SCEVConstant *C1 = nullptr, *C2 = nullptr; 11300 // Compare (X + C1) vs X. 11301 if (splitBinaryAdd(Less, LLess, RLess, Flags)) 11302 if ((C1 = dyn_cast<SCEVConstant>(LLess))) 11303 if (RLess == More) 11304 return -(C1->getAPInt()); 11305 11306 // Compare X vs (X + C2). 11307 if (splitBinaryAdd(More, LMore, RMore, Flags)) 11308 if ((C2 = dyn_cast<SCEVConstant>(LMore))) 11309 if (RMore == Less) 11310 return C2->getAPInt(); 11311 11312 // Compare (X + C1) vs (X + C2). 11313 if (C1 && C2 && RLess == RMore) 11314 return C2->getAPInt() - C1->getAPInt(); 11315 11316 return None; 11317 } 11318 11319 bool ScalarEvolution::isImpliedCondOperandsViaAddRecStart( 11320 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 11321 const SCEV *FoundLHS, const SCEV *FoundRHS, const Instruction *CtxI) { 11322 // Try to recognize the following pattern: 11323 // 11324 // FoundRHS = ... 11325 // ... 11326 // loop: 11327 // FoundLHS = {Start,+,W} 11328 // context_bb: // Basic block from the same loop 11329 // known(Pred, FoundLHS, FoundRHS) 11330 // 11331 // If some predicate is known in the context of a loop, it is also known on 11332 // each iteration of this loop, including the first iteration. Therefore, in 11333 // this case, `FoundLHS Pred FoundRHS` implies `Start Pred FoundRHS`. Try to 11334 // prove the original pred using this fact. 11335 if (!CtxI) 11336 return false; 11337 const BasicBlock *ContextBB = CtxI->getParent(); 11338 // Make sure AR varies in the context block. 11339 if (auto *AR = dyn_cast<SCEVAddRecExpr>(FoundLHS)) { 11340 const Loop *L = AR->getLoop(); 11341 // Make sure that context belongs to the loop and executes on 1st iteration 11342 // (if it ever executes at all). 11343 if (!L->contains(ContextBB) || !DT.dominates(ContextBB, L->getLoopLatch())) 11344 return false; 11345 if (!isAvailableAtLoopEntry(FoundRHS, AR->getLoop())) 11346 return false; 11347 return isImpliedCondOperands(Pred, LHS, RHS, AR->getStart(), FoundRHS); 11348 } 11349 11350 if (auto *AR = dyn_cast<SCEVAddRecExpr>(FoundRHS)) { 11351 const Loop *L = AR->getLoop(); 11352 // Make sure that context belongs to the loop and executes on 1st iteration 11353 // (if it ever executes at all). 11354 if (!L->contains(ContextBB) || !DT.dominates(ContextBB, L->getLoopLatch())) 11355 return false; 11356 if (!isAvailableAtLoopEntry(FoundLHS, AR->getLoop())) 11357 return false; 11358 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, AR->getStart()); 11359 } 11360 11361 return false; 11362 } 11363 11364 bool ScalarEvolution::isImpliedCondOperandsViaNoOverflow( 11365 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, 11366 const SCEV *FoundLHS, const SCEV *FoundRHS) { 11367 if (Pred != CmpInst::ICMP_SLT && Pred != CmpInst::ICMP_ULT) 11368 return false; 11369 11370 const auto *AddRecLHS = dyn_cast<SCEVAddRecExpr>(LHS); 11371 if (!AddRecLHS) 11372 return false; 11373 11374 const auto *AddRecFoundLHS = dyn_cast<SCEVAddRecExpr>(FoundLHS); 11375 if (!AddRecFoundLHS) 11376 return false; 11377 11378 // We'd like to let SCEV reason about control dependencies, so we constrain 11379 // both the inequalities to be about add recurrences on the same loop. This 11380 // way we can use isLoopEntryGuardedByCond later. 11381 11382 const Loop *L = AddRecFoundLHS->getLoop(); 11383 if (L != AddRecLHS->getLoop()) 11384 return false; 11385 11386 // FoundLHS u< FoundRHS u< -C => (FoundLHS + C) u< (FoundRHS + C) ... (1) 11387 // 11388 // FoundLHS s< FoundRHS s< INT_MIN - C => (FoundLHS + C) s< (FoundRHS + C) 11389 // ... (2) 11390 // 11391 // Informal proof for (2), assuming (1) [*]: 11392 // 11393 // We'll also assume (A s< B) <=> ((A + INT_MIN) u< (B + INT_MIN)) ... (3)[**] 11394 // 11395 // Then 11396 // 11397 // FoundLHS s< FoundRHS s< INT_MIN - C 11398 // <=> (FoundLHS + INT_MIN) u< (FoundRHS + INT_MIN) u< -C [ using (3) ] 11399 // <=> (FoundLHS + INT_MIN + C) u< (FoundRHS + INT_MIN + C) [ using (1) ] 11400 // <=> (FoundLHS + INT_MIN + C + INT_MIN) s< 11401 // (FoundRHS + INT_MIN + C + INT_MIN) [ using (3) ] 11402 // <=> FoundLHS + C s< FoundRHS + C 11403 // 11404 // [*]: (1) can be proved by ruling out overflow. 11405 // 11406 // [**]: This can be proved by analyzing all the four possibilities: 11407 // (A s< 0, B s< 0), (A s< 0, B s>= 0), (A s>= 0, B s< 0) and 11408 // (A s>= 0, B s>= 0). 11409 // 11410 // Note: 11411 // Despite (2), "FoundRHS s< INT_MIN - C" does not mean that "FoundRHS + C" 11412 // will not sign underflow. For instance, say FoundLHS = (i8 -128), FoundRHS 11413 // = (i8 -127) and C = (i8 -100). Then INT_MIN - C = (i8 -28), and FoundRHS 11414 // s< (INT_MIN - C). Lack of sign overflow / underflow in "FoundRHS + C" is 11415 // neither necessary nor sufficient to prove "(FoundLHS + C) s< (FoundRHS + 11416 // C)". 11417 11418 Optional<APInt> LDiff = computeConstantDifference(LHS, FoundLHS); 11419 Optional<APInt> RDiff = computeConstantDifference(RHS, FoundRHS); 11420 if (!LDiff || !RDiff || *LDiff != *RDiff) 11421 return false; 11422 11423 if (LDiff->isMinValue()) 11424 return true; 11425 11426 APInt FoundRHSLimit; 11427 11428 if (Pred == CmpInst::ICMP_ULT) { 11429 FoundRHSLimit = -(*RDiff); 11430 } else { 11431 assert(Pred == CmpInst::ICMP_SLT && "Checked above!"); 11432 FoundRHSLimit = APInt::getSignedMinValue(getTypeSizeInBits(RHS->getType())) - *RDiff; 11433 } 11434 11435 // Try to prove (1) or (2), as needed. 11436 return isAvailableAtLoopEntry(FoundRHS, L) && 11437 isLoopEntryGuardedByCond(L, Pred, FoundRHS, 11438 getConstant(FoundRHSLimit)); 11439 } 11440 11441 bool ScalarEvolution::isImpliedViaMerge(ICmpInst::Predicate Pred, 11442 const SCEV *LHS, const SCEV *RHS, 11443 const SCEV *FoundLHS, 11444 const SCEV *FoundRHS, unsigned Depth) { 11445 const PHINode *LPhi = nullptr, *RPhi = nullptr; 11446 11447 auto ClearOnExit = make_scope_exit([&]() { 11448 if (LPhi) { 11449 bool Erased = PendingMerges.erase(LPhi); 11450 assert(Erased && "Failed to erase LPhi!"); 11451 (void)Erased; 11452 } 11453 if (RPhi) { 11454 bool Erased = PendingMerges.erase(RPhi); 11455 assert(Erased && "Failed to erase RPhi!"); 11456 (void)Erased; 11457 } 11458 }); 11459 11460 // Find respective Phis and check that they are not being pending. 11461 if (const SCEVUnknown *LU = dyn_cast<SCEVUnknown>(LHS)) 11462 if (auto *Phi = dyn_cast<PHINode>(LU->getValue())) { 11463 if (!PendingMerges.insert(Phi).second) 11464 return false; 11465 LPhi = Phi; 11466 } 11467 if (const SCEVUnknown *RU = dyn_cast<SCEVUnknown>(RHS)) 11468 if (auto *Phi = dyn_cast<PHINode>(RU->getValue())) { 11469 // If we detect a loop of Phi nodes being processed by this method, for 11470 // example: 11471 // 11472 // %a = phi i32 [ %some1, %preheader ], [ %b, %latch ] 11473 // %b = phi i32 [ %some2, %preheader ], [ %a, %latch ] 11474 // 11475 // we don't want to deal with a case that complex, so return conservative 11476 // answer false. 11477 if (!PendingMerges.insert(Phi).second) 11478 return false; 11479 RPhi = Phi; 11480 } 11481 11482 // If none of LHS, RHS is a Phi, nothing to do here. 11483 if (!LPhi && !RPhi) 11484 return false; 11485 11486 // If there is a SCEVUnknown Phi we are interested in, make it left. 11487 if (!LPhi) { 11488 std::swap(LHS, RHS); 11489 std::swap(FoundLHS, FoundRHS); 11490 std::swap(LPhi, RPhi); 11491 Pred = ICmpInst::getSwappedPredicate(Pred); 11492 } 11493 11494 assert(LPhi && "LPhi should definitely be a SCEVUnknown Phi!"); 11495 const BasicBlock *LBB = LPhi->getParent(); 11496 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS); 11497 11498 auto ProvedEasily = [&](const SCEV *S1, const SCEV *S2) { 11499 return isKnownViaNonRecursiveReasoning(Pred, S1, S2) || 11500 isImpliedCondOperandsViaRanges(Pred, S1, S2, FoundLHS, FoundRHS) || 11501 isImpliedViaOperations(Pred, S1, S2, FoundLHS, FoundRHS, Depth); 11502 }; 11503 11504 if (RPhi && RPhi->getParent() == LBB) { 11505 // Case one: RHS is also a SCEVUnknown Phi from the same basic block. 11506 // If we compare two Phis from the same block, and for each entry block 11507 // the predicate is true for incoming values from this block, then the 11508 // predicate is also true for the Phis. 11509 for (const BasicBlock *IncBB : predecessors(LBB)) { 11510 const SCEV *L = getSCEV(LPhi->getIncomingValueForBlock(IncBB)); 11511 const SCEV *R = getSCEV(RPhi->getIncomingValueForBlock(IncBB)); 11512 if (!ProvedEasily(L, R)) 11513 return false; 11514 } 11515 } else if (RAR && RAR->getLoop()->getHeader() == LBB) { 11516 // Case two: RHS is also a Phi from the same basic block, and it is an 11517 // AddRec. It means that there is a loop which has both AddRec and Unknown 11518 // PHIs, for it we can compare incoming values of AddRec from above the loop 11519 // and latch with their respective incoming values of LPhi. 11520 // TODO: Generalize to handle loops with many inputs in a header. 11521 if (LPhi->getNumIncomingValues() != 2) return false; 11522 11523 auto *RLoop = RAR->getLoop(); 11524 auto *Predecessor = RLoop->getLoopPredecessor(); 11525 assert(Predecessor && "Loop with AddRec with no predecessor?"); 11526 const SCEV *L1 = getSCEV(LPhi->getIncomingValueForBlock(Predecessor)); 11527 if (!ProvedEasily(L1, RAR->getStart())) 11528 return false; 11529 auto *Latch = RLoop->getLoopLatch(); 11530 assert(Latch && "Loop with AddRec with no latch?"); 11531 const SCEV *L2 = getSCEV(LPhi->getIncomingValueForBlock(Latch)); 11532 if (!ProvedEasily(L2, RAR->getPostIncExpr(*this))) 11533 return false; 11534 } else { 11535 // In all other cases go over inputs of LHS and compare each of them to RHS, 11536 // the predicate is true for (LHS, RHS) if it is true for all such pairs. 11537 // At this point RHS is either a non-Phi, or it is a Phi from some block 11538 // different from LBB. 11539 for (const BasicBlock *IncBB : predecessors(LBB)) { 11540 // Check that RHS is available in this block. 11541 if (!dominates(RHS, IncBB)) 11542 return false; 11543 const SCEV *L = getSCEV(LPhi->getIncomingValueForBlock(IncBB)); 11544 // Make sure L does not refer to a value from a potentially previous 11545 // iteration of a loop. 11546 if (!properlyDominates(L, IncBB)) 11547 return false; 11548 if (!ProvedEasily(L, RHS)) 11549 return false; 11550 } 11551 } 11552 return true; 11553 } 11554 11555 bool ScalarEvolution::isImpliedCondOperandsViaShift(ICmpInst::Predicate Pred, 11556 const SCEV *LHS, 11557 const SCEV *RHS, 11558 const SCEV *FoundLHS, 11559 const SCEV *FoundRHS) { 11560 // We want to imply LHS < RHS from LHS < (RHS >> shiftvalue). First, make 11561 // sure that we are dealing with same LHS. 11562 if (RHS == FoundRHS) { 11563 std::swap(LHS, RHS); 11564 std::swap(FoundLHS, FoundRHS); 11565 Pred = ICmpInst::getSwappedPredicate(Pred); 11566 } 11567 if (LHS != FoundLHS) 11568 return false; 11569 11570 auto *SUFoundRHS = dyn_cast<SCEVUnknown>(FoundRHS); 11571 if (!SUFoundRHS) 11572 return false; 11573 11574 Value *Shiftee, *ShiftValue; 11575 11576 using namespace PatternMatch; 11577 if (match(SUFoundRHS->getValue(), 11578 m_LShr(m_Value(Shiftee), m_Value(ShiftValue)))) { 11579 auto *ShifteeS = getSCEV(Shiftee); 11580 // Prove one of the following: 11581 // LHS <u (shiftee >> shiftvalue) && shiftee <=u RHS ---> LHS <u RHS 11582 // LHS <=u (shiftee >> shiftvalue) && shiftee <=u RHS ---> LHS <=u RHS 11583 // LHS <s (shiftee >> shiftvalue) && shiftee <=s RHS && shiftee >=s 0 11584 // ---> LHS <s RHS 11585 // LHS <=s (shiftee >> shiftvalue) && shiftee <=s RHS && shiftee >=s 0 11586 // ---> LHS <=s RHS 11587 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) 11588 return isKnownPredicate(ICmpInst::ICMP_ULE, ShifteeS, RHS); 11589 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) 11590 if (isKnownNonNegative(ShifteeS)) 11591 return isKnownPredicate(ICmpInst::ICMP_SLE, ShifteeS, RHS); 11592 } 11593 11594 return false; 11595 } 11596 11597 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred, 11598 const SCEV *LHS, const SCEV *RHS, 11599 const SCEV *FoundLHS, 11600 const SCEV *FoundRHS, 11601 const Instruction *CtxI) { 11602 if (isImpliedCondOperandsViaRanges(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11603 return true; 11604 11605 if (isImpliedCondOperandsViaNoOverflow(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11606 return true; 11607 11608 if (isImpliedCondOperandsViaShift(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11609 return true; 11610 11611 if (isImpliedCondOperandsViaAddRecStart(Pred, LHS, RHS, FoundLHS, FoundRHS, 11612 CtxI)) 11613 return true; 11614 11615 return isImpliedCondOperandsHelper(Pred, LHS, RHS, 11616 FoundLHS, FoundRHS); 11617 } 11618 11619 /// Is MaybeMinMaxExpr an (U|S)(Min|Max) of Candidate and some other values? 11620 template <typename MinMaxExprType> 11621 static bool IsMinMaxConsistingOf(const SCEV *MaybeMinMaxExpr, 11622 const SCEV *Candidate) { 11623 const MinMaxExprType *MinMaxExpr = dyn_cast<MinMaxExprType>(MaybeMinMaxExpr); 11624 if (!MinMaxExpr) 11625 return false; 11626 11627 return is_contained(MinMaxExpr->operands(), Candidate); 11628 } 11629 11630 static bool IsKnownPredicateViaAddRecStart(ScalarEvolution &SE, 11631 ICmpInst::Predicate Pred, 11632 const SCEV *LHS, const SCEV *RHS) { 11633 // If both sides are affine addrecs for the same loop, with equal 11634 // steps, and we know the recurrences don't wrap, then we only 11635 // need to check the predicate on the starting values. 11636 11637 if (!ICmpInst::isRelational(Pred)) 11638 return false; 11639 11640 const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS); 11641 if (!LAR) 11642 return false; 11643 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS); 11644 if (!RAR) 11645 return false; 11646 if (LAR->getLoop() != RAR->getLoop()) 11647 return false; 11648 if (!LAR->isAffine() || !RAR->isAffine()) 11649 return false; 11650 11651 if (LAR->getStepRecurrence(SE) != RAR->getStepRecurrence(SE)) 11652 return false; 11653 11654 SCEV::NoWrapFlags NW = ICmpInst::isSigned(Pred) ? 11655 SCEV::FlagNSW : SCEV::FlagNUW; 11656 if (!LAR->getNoWrapFlags(NW) || !RAR->getNoWrapFlags(NW)) 11657 return false; 11658 11659 return SE.isKnownPredicate(Pred, LAR->getStart(), RAR->getStart()); 11660 } 11661 11662 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max 11663 /// expression? 11664 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE, 11665 ICmpInst::Predicate Pred, 11666 const SCEV *LHS, const SCEV *RHS) { 11667 switch (Pred) { 11668 default: 11669 return false; 11670 11671 case ICmpInst::ICMP_SGE: 11672 std::swap(LHS, RHS); 11673 LLVM_FALLTHROUGH; 11674 case ICmpInst::ICMP_SLE: 11675 return 11676 // min(A, ...) <= A 11677 IsMinMaxConsistingOf<SCEVSMinExpr>(LHS, RHS) || 11678 // A <= max(A, ...) 11679 IsMinMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS); 11680 11681 case ICmpInst::ICMP_UGE: 11682 std::swap(LHS, RHS); 11683 LLVM_FALLTHROUGH; 11684 case ICmpInst::ICMP_ULE: 11685 return 11686 // min(A, ...) <= A 11687 // FIXME: what about umin_seq? 11688 IsMinMaxConsistingOf<SCEVUMinExpr>(LHS, RHS) || 11689 // A <= max(A, ...) 11690 IsMinMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS); 11691 } 11692 11693 llvm_unreachable("covered switch fell through?!"); 11694 } 11695 11696 bool ScalarEvolution::isImpliedViaOperations(ICmpInst::Predicate Pred, 11697 const SCEV *LHS, const SCEV *RHS, 11698 const SCEV *FoundLHS, 11699 const SCEV *FoundRHS, 11700 unsigned Depth) { 11701 assert(getTypeSizeInBits(LHS->getType()) == 11702 getTypeSizeInBits(RHS->getType()) && 11703 "LHS and RHS have different sizes?"); 11704 assert(getTypeSizeInBits(FoundLHS->getType()) == 11705 getTypeSizeInBits(FoundRHS->getType()) && 11706 "FoundLHS and FoundRHS have different sizes?"); 11707 // We want to avoid hurting the compile time with analysis of too big trees. 11708 if (Depth > MaxSCEVOperationsImplicationDepth) 11709 return false; 11710 11711 // We only want to work with GT comparison so far. 11712 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_SLT) { 11713 Pred = CmpInst::getSwappedPredicate(Pred); 11714 std::swap(LHS, RHS); 11715 std::swap(FoundLHS, FoundRHS); 11716 } 11717 11718 // For unsigned, try to reduce it to corresponding signed comparison. 11719 if (Pred == ICmpInst::ICMP_UGT) 11720 // We can replace unsigned predicate with its signed counterpart if all 11721 // involved values are non-negative. 11722 // TODO: We could have better support for unsigned. 11723 if (isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS)) { 11724 // Knowing that both FoundLHS and FoundRHS are non-negative, and knowing 11725 // FoundLHS >u FoundRHS, we also know that FoundLHS >s FoundRHS. Let us 11726 // use this fact to prove that LHS and RHS are non-negative. 11727 const SCEV *MinusOne = getMinusOne(LHS->getType()); 11728 if (isImpliedCondOperands(ICmpInst::ICMP_SGT, LHS, MinusOne, FoundLHS, 11729 FoundRHS) && 11730 isImpliedCondOperands(ICmpInst::ICMP_SGT, RHS, MinusOne, FoundLHS, 11731 FoundRHS)) 11732 Pred = ICmpInst::ICMP_SGT; 11733 } 11734 11735 if (Pred != ICmpInst::ICMP_SGT) 11736 return false; 11737 11738 auto GetOpFromSExt = [&](const SCEV *S) { 11739 if (auto *Ext = dyn_cast<SCEVSignExtendExpr>(S)) 11740 return Ext->getOperand(); 11741 // TODO: If S is a SCEVConstant then you can cheaply "strip" the sext off 11742 // the constant in some cases. 11743 return S; 11744 }; 11745 11746 // Acquire values from extensions. 11747 auto *OrigLHS = LHS; 11748 auto *OrigFoundLHS = FoundLHS; 11749 LHS = GetOpFromSExt(LHS); 11750 FoundLHS = GetOpFromSExt(FoundLHS); 11751 11752 // Is the SGT predicate can be proved trivially or using the found context. 11753 auto IsSGTViaContext = [&](const SCEV *S1, const SCEV *S2) { 11754 return isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGT, S1, S2) || 11755 isImpliedViaOperations(ICmpInst::ICMP_SGT, S1, S2, OrigFoundLHS, 11756 FoundRHS, Depth + 1); 11757 }; 11758 11759 if (auto *LHSAddExpr = dyn_cast<SCEVAddExpr>(LHS)) { 11760 // We want to avoid creation of any new non-constant SCEV. Since we are 11761 // going to compare the operands to RHS, we should be certain that we don't 11762 // need any size extensions for this. So let's decline all cases when the 11763 // sizes of types of LHS and RHS do not match. 11764 // TODO: Maybe try to get RHS from sext to catch more cases? 11765 if (getTypeSizeInBits(LHS->getType()) != getTypeSizeInBits(RHS->getType())) 11766 return false; 11767 11768 // Should not overflow. 11769 if (!LHSAddExpr->hasNoSignedWrap()) 11770 return false; 11771 11772 auto *LL = LHSAddExpr->getOperand(0); 11773 auto *LR = LHSAddExpr->getOperand(1); 11774 auto *MinusOne = getMinusOne(RHS->getType()); 11775 11776 // Checks that S1 >= 0 && S2 > RHS, trivially or using the found context. 11777 auto IsSumGreaterThanRHS = [&](const SCEV *S1, const SCEV *S2) { 11778 return IsSGTViaContext(S1, MinusOne) && IsSGTViaContext(S2, RHS); 11779 }; 11780 // Try to prove the following rule: 11781 // (LHS = LL + LR) && (LL >= 0) && (LR > RHS) => (LHS > RHS). 11782 // (LHS = LL + LR) && (LR >= 0) && (LL > RHS) => (LHS > RHS). 11783 if (IsSumGreaterThanRHS(LL, LR) || IsSumGreaterThanRHS(LR, LL)) 11784 return true; 11785 } else if (auto *LHSUnknownExpr = dyn_cast<SCEVUnknown>(LHS)) { 11786 Value *LL, *LR; 11787 // FIXME: Once we have SDiv implemented, we can get rid of this matching. 11788 11789 using namespace llvm::PatternMatch; 11790 11791 if (match(LHSUnknownExpr->getValue(), m_SDiv(m_Value(LL), m_Value(LR)))) { 11792 // Rules for division. 11793 // We are going to perform some comparisons with Denominator and its 11794 // derivative expressions. In general case, creating a SCEV for it may 11795 // lead to a complex analysis of the entire graph, and in particular it 11796 // can request trip count recalculation for the same loop. This would 11797 // cache as SCEVCouldNotCompute to avoid the infinite recursion. To avoid 11798 // this, we only want to create SCEVs that are constants in this section. 11799 // So we bail if Denominator is not a constant. 11800 if (!isa<ConstantInt>(LR)) 11801 return false; 11802 11803 auto *Denominator = cast<SCEVConstant>(getSCEV(LR)); 11804 11805 // We want to make sure that LHS = FoundLHS / Denominator. If it is so, 11806 // then a SCEV for the numerator already exists and matches with FoundLHS. 11807 auto *Numerator = getExistingSCEV(LL); 11808 if (!Numerator || Numerator->getType() != FoundLHS->getType()) 11809 return false; 11810 11811 // Make sure that the numerator matches with FoundLHS and the denominator 11812 // is positive. 11813 if (!HasSameValue(Numerator, FoundLHS) || !isKnownPositive(Denominator)) 11814 return false; 11815 11816 auto *DTy = Denominator->getType(); 11817 auto *FRHSTy = FoundRHS->getType(); 11818 if (DTy->isPointerTy() != FRHSTy->isPointerTy()) 11819 // One of types is a pointer and another one is not. We cannot extend 11820 // them properly to a wider type, so let us just reject this case. 11821 // TODO: Usage of getEffectiveSCEVType for DTy, FRHSTy etc should help 11822 // to avoid this check. 11823 return false; 11824 11825 // Given that: 11826 // FoundLHS > FoundRHS, LHS = FoundLHS / Denominator, Denominator > 0. 11827 auto *WTy = getWiderType(DTy, FRHSTy); 11828 auto *DenominatorExt = getNoopOrSignExtend(Denominator, WTy); 11829 auto *FoundRHSExt = getNoopOrSignExtend(FoundRHS, WTy); 11830 11831 // Try to prove the following rule: 11832 // (FoundRHS > Denominator - 2) && (RHS <= 0) => (LHS > RHS). 11833 // For example, given that FoundLHS > 2. It means that FoundLHS is at 11834 // least 3. If we divide it by Denominator < 4, we will have at least 1. 11835 auto *DenomMinusTwo = getMinusSCEV(DenominatorExt, getConstant(WTy, 2)); 11836 if (isKnownNonPositive(RHS) && 11837 IsSGTViaContext(FoundRHSExt, DenomMinusTwo)) 11838 return true; 11839 11840 // Try to prove the following rule: 11841 // (FoundRHS > -1 - Denominator) && (RHS < 0) => (LHS > RHS). 11842 // For example, given that FoundLHS > -3. Then FoundLHS is at least -2. 11843 // If we divide it by Denominator > 2, then: 11844 // 1. If FoundLHS is negative, then the result is 0. 11845 // 2. If FoundLHS is non-negative, then the result is non-negative. 11846 // Anyways, the result is non-negative. 11847 auto *MinusOne = getMinusOne(WTy); 11848 auto *NegDenomMinusOne = getMinusSCEV(MinusOne, DenominatorExt); 11849 if (isKnownNegative(RHS) && 11850 IsSGTViaContext(FoundRHSExt, NegDenomMinusOne)) 11851 return true; 11852 } 11853 } 11854 11855 // If our expression contained SCEVUnknown Phis, and we split it down and now 11856 // need to prove something for them, try to prove the predicate for every 11857 // possible incoming values of those Phis. 11858 if (isImpliedViaMerge(Pred, OrigLHS, RHS, OrigFoundLHS, FoundRHS, Depth + 1)) 11859 return true; 11860 11861 return false; 11862 } 11863 11864 static bool isKnownPredicateExtendIdiom(ICmpInst::Predicate Pred, 11865 const SCEV *LHS, const SCEV *RHS) { 11866 // zext x u<= sext x, sext x s<= zext x 11867 switch (Pred) { 11868 case ICmpInst::ICMP_SGE: 11869 std::swap(LHS, RHS); 11870 LLVM_FALLTHROUGH; 11871 case ICmpInst::ICMP_SLE: { 11872 // If operand >=s 0 then ZExt == SExt. If operand <s 0 then SExt <s ZExt. 11873 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(LHS); 11874 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(RHS); 11875 if (SExt && ZExt && SExt->getOperand() == ZExt->getOperand()) 11876 return true; 11877 break; 11878 } 11879 case ICmpInst::ICMP_UGE: 11880 std::swap(LHS, RHS); 11881 LLVM_FALLTHROUGH; 11882 case ICmpInst::ICMP_ULE: { 11883 // If operand >=s 0 then ZExt == SExt. If operand <s 0 then ZExt <u SExt. 11884 const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(LHS); 11885 const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(RHS); 11886 if (SExt && ZExt && SExt->getOperand() == ZExt->getOperand()) 11887 return true; 11888 break; 11889 } 11890 default: 11891 break; 11892 }; 11893 return false; 11894 } 11895 11896 bool 11897 ScalarEvolution::isKnownViaNonRecursiveReasoning(ICmpInst::Predicate Pred, 11898 const SCEV *LHS, const SCEV *RHS) { 11899 return isKnownPredicateExtendIdiom(Pred, LHS, RHS) || 11900 isKnownPredicateViaConstantRanges(Pred, LHS, RHS) || 11901 IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS) || 11902 IsKnownPredicateViaAddRecStart(*this, Pred, LHS, RHS) || 11903 isKnownPredicateViaNoOverflow(Pred, LHS, RHS); 11904 } 11905 11906 bool 11907 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred, 11908 const SCEV *LHS, const SCEV *RHS, 11909 const SCEV *FoundLHS, 11910 const SCEV *FoundRHS) { 11911 switch (Pred) { 11912 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!"); 11913 case ICmpInst::ICMP_EQ: 11914 case ICmpInst::ICMP_NE: 11915 if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS)) 11916 return true; 11917 break; 11918 case ICmpInst::ICMP_SLT: 11919 case ICmpInst::ICMP_SLE: 11920 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SLE, LHS, FoundLHS) && 11921 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGE, RHS, FoundRHS)) 11922 return true; 11923 break; 11924 case ICmpInst::ICMP_SGT: 11925 case ICmpInst::ICMP_SGE: 11926 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SGE, LHS, FoundLHS) && 11927 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_SLE, RHS, FoundRHS)) 11928 return true; 11929 break; 11930 case ICmpInst::ICMP_ULT: 11931 case ICmpInst::ICMP_ULE: 11932 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, LHS, FoundLHS) && 11933 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_UGE, RHS, FoundRHS)) 11934 return true; 11935 break; 11936 case ICmpInst::ICMP_UGT: 11937 case ICmpInst::ICMP_UGE: 11938 if (isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_UGE, LHS, FoundLHS) && 11939 isKnownViaNonRecursiveReasoning(ICmpInst::ICMP_ULE, RHS, FoundRHS)) 11940 return true; 11941 break; 11942 } 11943 11944 // Maybe it can be proved via operations? 11945 if (isImpliedViaOperations(Pred, LHS, RHS, FoundLHS, FoundRHS)) 11946 return true; 11947 11948 return false; 11949 } 11950 11951 bool ScalarEvolution::isImpliedCondOperandsViaRanges(ICmpInst::Predicate Pred, 11952 const SCEV *LHS, 11953 const SCEV *RHS, 11954 const SCEV *FoundLHS, 11955 const SCEV *FoundRHS) { 11956 if (!isa<SCEVConstant>(RHS) || !isa<SCEVConstant>(FoundRHS)) 11957 // The restriction on `FoundRHS` be lifted easily -- it exists only to 11958 // reduce the compile time impact of this optimization. 11959 return false; 11960 11961 Optional<APInt> Addend = computeConstantDifference(LHS, FoundLHS); 11962 if (!Addend) 11963 return false; 11964 11965 const APInt &ConstFoundRHS = cast<SCEVConstant>(FoundRHS)->getAPInt(); 11966 11967 // `FoundLHSRange` is the range we know `FoundLHS` to be in by virtue of the 11968 // antecedent "`FoundLHS` `Pred` `FoundRHS`". 11969 ConstantRange FoundLHSRange = 11970 ConstantRange::makeExactICmpRegion(Pred, ConstFoundRHS); 11971 11972 // Since `LHS` is `FoundLHS` + `Addend`, we can compute a range for `LHS`: 11973 ConstantRange LHSRange = FoundLHSRange.add(ConstantRange(*Addend)); 11974 11975 // We can also compute the range of values for `LHS` that satisfy the 11976 // consequent, "`LHS` `Pred` `RHS`": 11977 const APInt &ConstRHS = cast<SCEVConstant>(RHS)->getAPInt(); 11978 // The antecedent implies the consequent if every value of `LHS` that 11979 // satisfies the antecedent also satisfies the consequent. 11980 return LHSRange.icmp(Pred, ConstRHS); 11981 } 11982 11983 bool ScalarEvolution::canIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride, 11984 bool IsSigned) { 11985 assert(isKnownPositive(Stride) && "Positive stride expected!"); 11986 11987 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 11988 const SCEV *One = getOne(Stride->getType()); 11989 11990 if (IsSigned) { 11991 APInt MaxRHS = getSignedRangeMax(RHS); 11992 APInt MaxValue = APInt::getSignedMaxValue(BitWidth); 11993 APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One)); 11994 11995 // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow! 11996 return (std::move(MaxValue) - MaxStrideMinusOne).slt(MaxRHS); 11997 } 11998 11999 APInt MaxRHS = getUnsignedRangeMax(RHS); 12000 APInt MaxValue = APInt::getMaxValue(BitWidth); 12001 APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One)); 12002 12003 // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow! 12004 return (std::move(MaxValue) - MaxStrideMinusOne).ult(MaxRHS); 12005 } 12006 12007 bool ScalarEvolution::canIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride, 12008 bool IsSigned) { 12009 12010 unsigned BitWidth = getTypeSizeInBits(RHS->getType()); 12011 const SCEV *One = getOne(Stride->getType()); 12012 12013 if (IsSigned) { 12014 APInt MinRHS = getSignedRangeMin(RHS); 12015 APInt MinValue = APInt::getSignedMinValue(BitWidth); 12016 APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One)); 12017 12018 // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow! 12019 return (std::move(MinValue) + MaxStrideMinusOne).sgt(MinRHS); 12020 } 12021 12022 APInt MinRHS = getUnsignedRangeMin(RHS); 12023 APInt MinValue = APInt::getMinValue(BitWidth); 12024 APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One)); 12025 12026 // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow! 12027 return (std::move(MinValue) + MaxStrideMinusOne).ugt(MinRHS); 12028 } 12029 12030 const SCEV *ScalarEvolution::getUDivCeilSCEV(const SCEV *N, const SCEV *D) { 12031 // umin(N, 1) + floor((N - umin(N, 1)) / D) 12032 // This is equivalent to "1 + floor((N - 1) / D)" for N != 0. The umin 12033 // expression fixes the case of N=0. 12034 const SCEV *MinNOne = getUMinExpr(N, getOne(N->getType())); 12035 const SCEV *NMinusOne = getMinusSCEV(N, MinNOne); 12036 return getAddExpr(MinNOne, getUDivExpr(NMinusOne, D)); 12037 } 12038 12039 const SCEV *ScalarEvolution::computeMaxBECountForLT(const SCEV *Start, 12040 const SCEV *Stride, 12041 const SCEV *End, 12042 unsigned BitWidth, 12043 bool IsSigned) { 12044 // The logic in this function assumes we can represent a positive stride. 12045 // If we can't, the backedge-taken count must be zero. 12046 if (IsSigned && BitWidth == 1) 12047 return getZero(Stride->getType()); 12048 12049 // This code has only been closely audited for negative strides in the 12050 // unsigned comparison case, it may be correct for signed comparison, but 12051 // that needs to be established. 12052 assert((!IsSigned || !isKnownNonPositive(Stride)) && 12053 "Stride is expected strictly positive for signed case!"); 12054 12055 // Calculate the maximum backedge count based on the range of values 12056 // permitted by Start, End, and Stride. 12057 APInt MinStart = 12058 IsSigned ? getSignedRangeMin(Start) : getUnsignedRangeMin(Start); 12059 12060 APInt MinStride = 12061 IsSigned ? getSignedRangeMin(Stride) : getUnsignedRangeMin(Stride); 12062 12063 // We assume either the stride is positive, or the backedge-taken count 12064 // is zero. So force StrideForMaxBECount to be at least one. 12065 APInt One(BitWidth, 1); 12066 APInt StrideForMaxBECount = IsSigned ? APIntOps::smax(One, MinStride) 12067 : APIntOps::umax(One, MinStride); 12068 12069 APInt MaxValue = IsSigned ? APInt::getSignedMaxValue(BitWidth) 12070 : APInt::getMaxValue(BitWidth); 12071 APInt Limit = MaxValue - (StrideForMaxBECount - 1); 12072 12073 // Although End can be a MAX expression we estimate MaxEnd considering only 12074 // the case End = RHS of the loop termination condition. This is safe because 12075 // in the other case (End - Start) is zero, leading to a zero maximum backedge 12076 // taken count. 12077 APInt MaxEnd = IsSigned ? APIntOps::smin(getSignedRangeMax(End), Limit) 12078 : APIntOps::umin(getUnsignedRangeMax(End), Limit); 12079 12080 // MaxBECount = ceil((max(MaxEnd, MinStart) - MinStart) / Stride) 12081 MaxEnd = IsSigned ? APIntOps::smax(MaxEnd, MinStart) 12082 : APIntOps::umax(MaxEnd, MinStart); 12083 12084 return getUDivCeilSCEV(getConstant(MaxEnd - MinStart) /* Delta */, 12085 getConstant(StrideForMaxBECount) /* Step */); 12086 } 12087 12088 ScalarEvolution::ExitLimit 12089 ScalarEvolution::howManyLessThans(const SCEV *LHS, const SCEV *RHS, 12090 const Loop *L, bool IsSigned, 12091 bool ControlsExit, bool AllowPredicates) { 12092 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 12093 12094 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS); 12095 bool PredicatedIV = false; 12096 12097 auto canAssumeNoSelfWrap = [&](const SCEVAddRecExpr *AR) { 12098 // Can we prove this loop *must* be UB if overflow of IV occurs? 12099 // Reasoning goes as follows: 12100 // * Suppose the IV did self wrap. 12101 // * If Stride evenly divides the iteration space, then once wrap 12102 // occurs, the loop must revisit the same values. 12103 // * We know that RHS is invariant, and that none of those values 12104 // caused this exit to be taken previously. Thus, this exit is 12105 // dynamically dead. 12106 // * If this is the sole exit, then a dead exit implies the loop 12107 // must be infinite if there are no abnormal exits. 12108 // * If the loop were infinite, then it must either not be mustprogress 12109 // or have side effects. Otherwise, it must be UB. 12110 // * It can't (by assumption), be UB so we have contradicted our 12111 // premise and can conclude the IV did not in fact self-wrap. 12112 if (!isLoopInvariant(RHS, L)) 12113 return false; 12114 12115 auto *StrideC = dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this)); 12116 if (!StrideC || !StrideC->getAPInt().isPowerOf2()) 12117 return false; 12118 12119 if (!ControlsExit || !loopHasNoAbnormalExits(L)) 12120 return false; 12121 12122 return loopIsFiniteByAssumption(L); 12123 }; 12124 12125 if (!IV) { 12126 if (auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(LHS)) { 12127 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(ZExt->getOperand()); 12128 if (AR && AR->getLoop() == L && AR->isAffine()) { 12129 auto canProveNUW = [&]() { 12130 if (!isLoopInvariant(RHS, L)) 12131 return false; 12132 12133 if (!isKnownNonZero(AR->getStepRecurrence(*this))) 12134 // We need the sequence defined by AR to strictly increase in the 12135 // unsigned integer domain for the logic below to hold. 12136 return false; 12137 12138 const unsigned InnerBitWidth = getTypeSizeInBits(AR->getType()); 12139 const unsigned OuterBitWidth = getTypeSizeInBits(RHS->getType()); 12140 // If RHS <=u Limit, then there must exist a value V in the sequence 12141 // defined by AR (e.g. {Start,+,Step}) such that V >u RHS, and 12142 // V <=u UINT_MAX. Thus, we must exit the loop before unsigned 12143 // overflow occurs. This limit also implies that a signed comparison 12144 // (in the wide bitwidth) is equivalent to an unsigned comparison as 12145 // the high bits on both sides must be zero. 12146 APInt StrideMax = getUnsignedRangeMax(AR->getStepRecurrence(*this)); 12147 APInt Limit = APInt::getMaxValue(InnerBitWidth) - (StrideMax - 1); 12148 Limit = Limit.zext(OuterBitWidth); 12149 return getUnsignedRangeMax(applyLoopGuards(RHS, L)).ule(Limit); 12150 }; 12151 auto Flags = AR->getNoWrapFlags(); 12152 if (!hasFlags(Flags, SCEV::FlagNUW) && canProveNUW()) 12153 Flags = setFlags(Flags, SCEV::FlagNUW); 12154 12155 setNoWrapFlags(const_cast<SCEVAddRecExpr *>(AR), Flags); 12156 if (AR->hasNoUnsignedWrap()) { 12157 // Emulate what getZeroExtendExpr would have done during construction 12158 // if we'd been able to infer the fact just above at that time. 12159 const SCEV *Step = AR->getStepRecurrence(*this); 12160 Type *Ty = ZExt->getType(); 12161 auto *S = getAddRecExpr( 12162 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, 0), 12163 getZeroExtendExpr(Step, Ty, 0), L, AR->getNoWrapFlags()); 12164 IV = dyn_cast<SCEVAddRecExpr>(S); 12165 } 12166 } 12167 } 12168 } 12169 12170 12171 if (!IV && AllowPredicates) { 12172 // Try to make this an AddRec using runtime tests, in the first X 12173 // iterations of this loop, where X is the SCEV expression found by the 12174 // algorithm below. 12175 IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates); 12176 PredicatedIV = true; 12177 } 12178 12179 // Avoid weird loops 12180 if (!IV || IV->getLoop() != L || !IV->isAffine()) 12181 return getCouldNotCompute(); 12182 12183 // A precondition of this method is that the condition being analyzed 12184 // reaches an exiting branch which dominates the latch. Given that, we can 12185 // assume that an increment which violates the nowrap specification and 12186 // produces poison must cause undefined behavior when the resulting poison 12187 // value is branched upon and thus we can conclude that the backedge is 12188 // taken no more often than would be required to produce that poison value. 12189 // Note that a well defined loop can exit on the iteration which violates 12190 // the nowrap specification if there is another exit (either explicit or 12191 // implicit/exceptional) which causes the loop to execute before the 12192 // exiting instruction we're analyzing would trigger UB. 12193 auto WrapType = IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW; 12194 bool NoWrap = ControlsExit && IV->getNoWrapFlags(WrapType); 12195 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT; 12196 12197 const SCEV *Stride = IV->getStepRecurrence(*this); 12198 12199 bool PositiveStride = isKnownPositive(Stride); 12200 12201 // Avoid negative or zero stride values. 12202 if (!PositiveStride) { 12203 // We can compute the correct backedge taken count for loops with unknown 12204 // strides if we can prove that the loop is not an infinite loop with side 12205 // effects. Here's the loop structure we are trying to handle - 12206 // 12207 // i = start 12208 // do { 12209 // A[i] = i; 12210 // i += s; 12211 // } while (i < end); 12212 // 12213 // The backedge taken count for such loops is evaluated as - 12214 // (max(end, start + stride) - start - 1) /u stride 12215 // 12216 // The additional preconditions that we need to check to prove correctness 12217 // of the above formula is as follows - 12218 // 12219 // a) IV is either nuw or nsw depending upon signedness (indicated by the 12220 // NoWrap flag). 12221 // b) the loop is guaranteed to be finite (e.g. is mustprogress and has 12222 // no side effects within the loop) 12223 // c) loop has a single static exit (with no abnormal exits) 12224 // 12225 // Precondition a) implies that if the stride is negative, this is a single 12226 // trip loop. The backedge taken count formula reduces to zero in this case. 12227 // 12228 // Precondition b) and c) combine to imply that if rhs is invariant in L, 12229 // then a zero stride means the backedge can't be taken without executing 12230 // undefined behavior. 12231 // 12232 // The positive stride case is the same as isKnownPositive(Stride) returning 12233 // true (original behavior of the function). 12234 // 12235 if (PredicatedIV || !NoWrap || !loopIsFiniteByAssumption(L) || 12236 !loopHasNoAbnormalExits(L)) 12237 return getCouldNotCompute(); 12238 12239 // This bailout is protecting the logic in computeMaxBECountForLT which 12240 // has not yet been sufficiently auditted or tested with negative strides. 12241 // We used to filter out all known-non-positive cases here, we're in the 12242 // process of being less restrictive bit by bit. 12243 if (IsSigned && isKnownNonPositive(Stride)) 12244 return getCouldNotCompute(); 12245 12246 if (!isKnownNonZero(Stride)) { 12247 // If we have a step of zero, and RHS isn't invariant in L, we don't know 12248 // if it might eventually be greater than start and if so, on which 12249 // iteration. We can't even produce a useful upper bound. 12250 if (!isLoopInvariant(RHS, L)) 12251 return getCouldNotCompute(); 12252 12253 // We allow a potentially zero stride, but we need to divide by stride 12254 // below. Since the loop can't be infinite and this check must control 12255 // the sole exit, we can infer the exit must be taken on the first 12256 // iteration (e.g. backedge count = 0) if the stride is zero. Given that, 12257 // we know the numerator in the divides below must be zero, so we can 12258 // pick an arbitrary non-zero value for the denominator (e.g. stride) 12259 // and produce the right result. 12260 // FIXME: Handle the case where Stride is poison? 12261 auto wouldZeroStrideBeUB = [&]() { 12262 // Proof by contradiction. Suppose the stride were zero. If we can 12263 // prove that the backedge *is* taken on the first iteration, then since 12264 // we know this condition controls the sole exit, we must have an 12265 // infinite loop. We can't have a (well defined) infinite loop per 12266 // check just above. 12267 // Note: The (Start - Stride) term is used to get the start' term from 12268 // (start' + stride,+,stride). Remember that we only care about the 12269 // result of this expression when stride == 0 at runtime. 12270 auto *StartIfZero = getMinusSCEV(IV->getStart(), Stride); 12271 return isLoopEntryGuardedByCond(L, Cond, StartIfZero, RHS); 12272 }; 12273 if (!wouldZeroStrideBeUB()) { 12274 Stride = getUMaxExpr(Stride, getOne(Stride->getType())); 12275 } 12276 } 12277 } else if (!Stride->isOne() && !NoWrap) { 12278 auto isUBOnWrap = [&]() { 12279 // From no-self-wrap, we need to then prove no-(un)signed-wrap. This 12280 // follows trivially from the fact that every (un)signed-wrapped, but 12281 // not self-wrapped value must be LT than the last value before 12282 // (un)signed wrap. Since we know that last value didn't exit, nor 12283 // will any smaller one. 12284 return canAssumeNoSelfWrap(IV); 12285 }; 12286 12287 // Avoid proven overflow cases: this will ensure that the backedge taken 12288 // count will not generate any unsigned overflow. Relaxed no-overflow 12289 // conditions exploit NoWrapFlags, allowing to optimize in presence of 12290 // undefined behaviors like the case of C language. 12291 if (canIVOverflowOnLT(RHS, Stride, IsSigned) && !isUBOnWrap()) 12292 return getCouldNotCompute(); 12293 } 12294 12295 // On all paths just preceeding, we established the following invariant: 12296 // IV can be assumed not to overflow up to and including the exiting 12297 // iteration. We proved this in one of two ways: 12298 // 1) We can show overflow doesn't occur before the exiting iteration 12299 // 1a) canIVOverflowOnLT, and b) step of one 12300 // 2) We can show that if overflow occurs, the loop must execute UB 12301 // before any possible exit. 12302 // Note that we have not yet proved RHS invariant (in general). 12303 12304 const SCEV *Start = IV->getStart(); 12305 12306 // Preserve pointer-typed Start/RHS to pass to isLoopEntryGuardedByCond. 12307 // If we convert to integers, isLoopEntryGuardedByCond will miss some cases. 12308 // Use integer-typed versions for actual computation; we can't subtract 12309 // pointers in general. 12310 const SCEV *OrigStart = Start; 12311 const SCEV *OrigRHS = RHS; 12312 if (Start->getType()->isPointerTy()) { 12313 Start = getLosslessPtrToIntExpr(Start); 12314 if (isa<SCEVCouldNotCompute>(Start)) 12315 return Start; 12316 } 12317 if (RHS->getType()->isPointerTy()) { 12318 RHS = getLosslessPtrToIntExpr(RHS); 12319 if (isa<SCEVCouldNotCompute>(RHS)) 12320 return RHS; 12321 } 12322 12323 // When the RHS is not invariant, we do not know the end bound of the loop and 12324 // cannot calculate the ExactBECount needed by ExitLimit. However, we can 12325 // calculate the MaxBECount, given the start, stride and max value for the end 12326 // bound of the loop (RHS), and the fact that IV does not overflow (which is 12327 // checked above). 12328 if (!isLoopInvariant(RHS, L)) { 12329 const SCEV *MaxBECount = computeMaxBECountForLT( 12330 Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned); 12331 return ExitLimit(getCouldNotCompute() /* ExactNotTaken */, MaxBECount, 12332 false /*MaxOrZero*/, Predicates); 12333 } 12334 12335 // We use the expression (max(End,Start)-Start)/Stride to describe the 12336 // backedge count, as if the backedge is taken at least once max(End,Start) 12337 // is End and so the result is as above, and if not max(End,Start) is Start 12338 // so we get a backedge count of zero. 12339 const SCEV *BECount = nullptr; 12340 auto *OrigStartMinusStride = getMinusSCEV(OrigStart, Stride); 12341 assert(isAvailableAtLoopEntry(OrigStartMinusStride, L) && "Must be!"); 12342 assert(isAvailableAtLoopEntry(OrigStart, L) && "Must be!"); 12343 assert(isAvailableAtLoopEntry(OrigRHS, L) && "Must be!"); 12344 // Can we prove (max(RHS,Start) > Start - Stride? 12345 if (isLoopEntryGuardedByCond(L, Cond, OrigStartMinusStride, OrigStart) && 12346 isLoopEntryGuardedByCond(L, Cond, OrigStartMinusStride, OrigRHS)) { 12347 // In this case, we can use a refined formula for computing backedge taken 12348 // count. The general formula remains: 12349 // "End-Start /uceiling Stride" where "End = max(RHS,Start)" 12350 // We want to use the alternate formula: 12351 // "((End - 1) - (Start - Stride)) /u Stride" 12352 // Let's do a quick case analysis to show these are equivalent under 12353 // our precondition that max(RHS,Start) > Start - Stride. 12354 // * For RHS <= Start, the backedge-taken count must be zero. 12355 // "((End - 1) - (Start - Stride)) /u Stride" reduces to 12356 // "((Start - 1) - (Start - Stride)) /u Stride" which simplies to 12357 // "Stride - 1 /u Stride" which is indeed zero for all non-zero values 12358 // of Stride. For 0 stride, we've use umin(1,Stride) above, reducing 12359 // this to the stride of 1 case. 12360 // * For RHS >= Start, the backedge count must be "RHS-Start /uceil Stride". 12361 // "((End - 1) - (Start - Stride)) /u Stride" reduces to 12362 // "((RHS - 1) - (Start - Stride)) /u Stride" reassociates to 12363 // "((RHS - (Start - Stride) - 1) /u Stride". 12364 // Our preconditions trivially imply no overflow in that form. 12365 const SCEV *MinusOne = getMinusOne(Stride->getType()); 12366 const SCEV *Numerator = 12367 getMinusSCEV(getAddExpr(RHS, MinusOne), getMinusSCEV(Start, Stride)); 12368 BECount = getUDivExpr(Numerator, Stride); 12369 } 12370 12371 const SCEV *BECountIfBackedgeTaken = nullptr; 12372 if (!BECount) { 12373 auto canProveRHSGreaterThanEqualStart = [&]() { 12374 auto CondGE = IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE; 12375 if (isLoopEntryGuardedByCond(L, CondGE, OrigRHS, OrigStart)) 12376 return true; 12377 12378 // (RHS > Start - 1) implies RHS >= Start. 12379 // * "RHS >= Start" is trivially equivalent to "RHS > Start - 1" if 12380 // "Start - 1" doesn't overflow. 12381 // * For signed comparison, if Start - 1 does overflow, it's equal 12382 // to INT_MAX, and "RHS >s INT_MAX" is trivially false. 12383 // * For unsigned comparison, if Start - 1 does overflow, it's equal 12384 // to UINT_MAX, and "RHS >u UINT_MAX" is trivially false. 12385 // 12386 // FIXME: Should isLoopEntryGuardedByCond do this for us? 12387 auto CondGT = IsSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT; 12388 auto *StartMinusOne = getAddExpr(OrigStart, 12389 getMinusOne(OrigStart->getType())); 12390 return isLoopEntryGuardedByCond(L, CondGT, OrigRHS, StartMinusOne); 12391 }; 12392 12393 // If we know that RHS >= Start in the context of loop, then we know that 12394 // max(RHS, Start) = RHS at this point. 12395 const SCEV *End; 12396 if (canProveRHSGreaterThanEqualStart()) { 12397 End = RHS; 12398 } else { 12399 // If RHS < Start, the backedge will be taken zero times. So in 12400 // general, we can write the backedge-taken count as: 12401 // 12402 // RHS >= Start ? ceil(RHS - Start) / Stride : 0 12403 // 12404 // We convert it to the following to make it more convenient for SCEV: 12405 // 12406 // ceil(max(RHS, Start) - Start) / Stride 12407 End = IsSigned ? getSMaxExpr(RHS, Start) : getUMaxExpr(RHS, Start); 12408 12409 // See what would happen if we assume the backedge is taken. This is 12410 // used to compute MaxBECount. 12411 BECountIfBackedgeTaken = getUDivCeilSCEV(getMinusSCEV(RHS, Start), Stride); 12412 } 12413 12414 // At this point, we know: 12415 // 12416 // 1. If IsSigned, Start <=s End; otherwise, Start <=u End 12417 // 2. The index variable doesn't overflow. 12418 // 12419 // Therefore, we know N exists such that 12420 // (Start + Stride * N) >= End, and computing "(Start + Stride * N)" 12421 // doesn't overflow. 12422 // 12423 // Using this information, try to prove whether the addition in 12424 // "(Start - End) + (Stride - 1)" has unsigned overflow. 12425 const SCEV *One = getOne(Stride->getType()); 12426 bool MayAddOverflow = [&] { 12427 if (auto *StrideC = dyn_cast<SCEVConstant>(Stride)) { 12428 if (StrideC->getAPInt().isPowerOf2()) { 12429 // Suppose Stride is a power of two, and Start/End are unsigned 12430 // integers. Let UMAX be the largest representable unsigned 12431 // integer. 12432 // 12433 // By the preconditions of this function, we know 12434 // "(Start + Stride * N) >= End", and this doesn't overflow. 12435 // As a formula: 12436 // 12437 // End <= (Start + Stride * N) <= UMAX 12438 // 12439 // Subtracting Start from all the terms: 12440 // 12441 // End - Start <= Stride * N <= UMAX - Start 12442 // 12443 // Since Start is unsigned, UMAX - Start <= UMAX. Therefore: 12444 // 12445 // End - Start <= Stride * N <= UMAX 12446 // 12447 // Stride * N is a multiple of Stride. Therefore, 12448 // 12449 // End - Start <= Stride * N <= UMAX - (UMAX mod Stride) 12450 // 12451 // Since Stride is a power of two, UMAX + 1 is divisible by Stride. 12452 // Therefore, UMAX mod Stride == Stride - 1. So we can write: 12453 // 12454 // End - Start <= Stride * N <= UMAX - Stride - 1 12455 // 12456 // Dropping the middle term: 12457 // 12458 // End - Start <= UMAX - Stride - 1 12459 // 12460 // Adding Stride - 1 to both sides: 12461 // 12462 // (End - Start) + (Stride - 1) <= UMAX 12463 // 12464 // In other words, the addition doesn't have unsigned overflow. 12465 // 12466 // A similar proof works if we treat Start/End as signed values. 12467 // Just rewrite steps before "End - Start <= Stride * N <= UMAX" to 12468 // use signed max instead of unsigned max. Note that we're trying 12469 // to prove a lack of unsigned overflow in either case. 12470 return false; 12471 } 12472 } 12473 if (Start == Stride || Start == getMinusSCEV(Stride, One)) { 12474 // If Start is equal to Stride, (End - Start) + (Stride - 1) == End - 1. 12475 // If !IsSigned, 0 <u Stride == Start <=u End; so 0 <u End - 1 <u End. 12476 // If IsSigned, 0 <s Stride == Start <=s End; so 0 <s End - 1 <s End. 12477 // 12478 // If Start is equal to Stride - 1, (End - Start) + Stride - 1 == End. 12479 return false; 12480 } 12481 return true; 12482 }(); 12483 12484 const SCEV *Delta = getMinusSCEV(End, Start); 12485 if (!MayAddOverflow) { 12486 // floor((D + (S - 1)) / S) 12487 // We prefer this formulation if it's legal because it's fewer operations. 12488 BECount = 12489 getUDivExpr(getAddExpr(Delta, getMinusSCEV(Stride, One)), Stride); 12490 } else { 12491 BECount = getUDivCeilSCEV(Delta, Stride); 12492 } 12493 } 12494 12495 const SCEV *MaxBECount; 12496 bool MaxOrZero = false; 12497 if (isa<SCEVConstant>(BECount)) { 12498 MaxBECount = BECount; 12499 } else if (BECountIfBackedgeTaken && 12500 isa<SCEVConstant>(BECountIfBackedgeTaken)) { 12501 // If we know exactly how many times the backedge will be taken if it's 12502 // taken at least once, then the backedge count will either be that or 12503 // zero. 12504 MaxBECount = BECountIfBackedgeTaken; 12505 MaxOrZero = true; 12506 } else { 12507 MaxBECount = computeMaxBECountForLT( 12508 Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned); 12509 } 12510 12511 if (isa<SCEVCouldNotCompute>(MaxBECount) && 12512 !isa<SCEVCouldNotCompute>(BECount)) 12513 MaxBECount = getConstant(getUnsignedRangeMax(BECount)); 12514 12515 return ExitLimit(BECount, MaxBECount, MaxOrZero, Predicates); 12516 } 12517 12518 ScalarEvolution::ExitLimit 12519 ScalarEvolution::howManyGreaterThans(const SCEV *LHS, const SCEV *RHS, 12520 const Loop *L, bool IsSigned, 12521 bool ControlsExit, bool AllowPredicates) { 12522 SmallPtrSet<const SCEVPredicate *, 4> Predicates; 12523 // We handle only IV > Invariant 12524 if (!isLoopInvariant(RHS, L)) 12525 return getCouldNotCompute(); 12526 12527 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS); 12528 if (!IV && AllowPredicates) 12529 // Try to make this an AddRec using runtime tests, in the first X 12530 // iterations of this loop, where X is the SCEV expression found by the 12531 // algorithm below. 12532 IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates); 12533 12534 // Avoid weird loops 12535 if (!IV || IV->getLoop() != L || !IV->isAffine()) 12536 return getCouldNotCompute(); 12537 12538 auto WrapType = IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW; 12539 bool NoWrap = ControlsExit && IV->getNoWrapFlags(WrapType); 12540 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT; 12541 12542 const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this)); 12543 12544 // Avoid negative or zero stride values 12545 if (!isKnownPositive(Stride)) 12546 return getCouldNotCompute(); 12547 12548 // Avoid proven overflow cases: this will ensure that the backedge taken count 12549 // will not generate any unsigned overflow. Relaxed no-overflow conditions 12550 // exploit NoWrapFlags, allowing to optimize in presence of undefined 12551 // behaviors like the case of C language. 12552 if (!Stride->isOne() && !NoWrap) 12553 if (canIVOverflowOnGT(RHS, Stride, IsSigned)) 12554 return getCouldNotCompute(); 12555 12556 const SCEV *Start = IV->getStart(); 12557 const SCEV *End = RHS; 12558 if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS)) { 12559 // If we know that Start >= RHS in the context of loop, then we know that 12560 // min(RHS, Start) = RHS at this point. 12561 if (isLoopEntryGuardedByCond( 12562 L, IsSigned ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_UGE, Start, RHS)) 12563 End = RHS; 12564 else 12565 End = IsSigned ? getSMinExpr(RHS, Start) : getUMinExpr(RHS, Start); 12566 } 12567 12568 if (Start->getType()->isPointerTy()) { 12569 Start = getLosslessPtrToIntExpr(Start); 12570 if (isa<SCEVCouldNotCompute>(Start)) 12571 return Start; 12572 } 12573 if (End->getType()->isPointerTy()) { 12574 End = getLosslessPtrToIntExpr(End); 12575 if (isa<SCEVCouldNotCompute>(End)) 12576 return End; 12577 } 12578 12579 // Compute ((Start - End) + (Stride - 1)) / Stride. 12580 // FIXME: This can overflow. Holding off on fixing this for now; 12581 // howManyGreaterThans will hopefully be gone soon. 12582 const SCEV *One = getOne(Stride->getType()); 12583 const SCEV *BECount = getUDivExpr( 12584 getAddExpr(getMinusSCEV(Start, End), getMinusSCEV(Stride, One)), Stride); 12585 12586 APInt MaxStart = IsSigned ? getSignedRangeMax(Start) 12587 : getUnsignedRangeMax(Start); 12588 12589 APInt MinStride = IsSigned ? getSignedRangeMin(Stride) 12590 : getUnsignedRangeMin(Stride); 12591 12592 unsigned BitWidth = getTypeSizeInBits(LHS->getType()); 12593 APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1) 12594 : APInt::getMinValue(BitWidth) + (MinStride - 1); 12595 12596 // Although End can be a MIN expression we estimate MinEnd considering only 12597 // the case End = RHS. This is safe because in the other case (Start - End) 12598 // is zero, leading to a zero maximum backedge taken count. 12599 APInt MinEnd = 12600 IsSigned ? APIntOps::smax(getSignedRangeMin(RHS), Limit) 12601 : APIntOps::umax(getUnsignedRangeMin(RHS), Limit); 12602 12603 const SCEV *MaxBECount = isa<SCEVConstant>(BECount) 12604 ? BECount 12605 : getUDivCeilSCEV(getConstant(MaxStart - MinEnd), 12606 getConstant(MinStride)); 12607 12608 if (isa<SCEVCouldNotCompute>(MaxBECount)) 12609 MaxBECount = BECount; 12610 12611 return ExitLimit(BECount, MaxBECount, false, Predicates); 12612 } 12613 12614 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(const ConstantRange &Range, 12615 ScalarEvolution &SE) const { 12616 if (Range.isFullSet()) // Infinite loop. 12617 return SE.getCouldNotCompute(); 12618 12619 // If the start is a non-zero constant, shift the range to simplify things. 12620 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart())) 12621 if (!SC->getValue()->isZero()) { 12622 SmallVector<const SCEV *, 4> Operands(operands()); 12623 Operands[0] = SE.getZero(SC->getType()); 12624 const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(), 12625 getNoWrapFlags(FlagNW)); 12626 if (const auto *ShiftedAddRec = dyn_cast<SCEVAddRecExpr>(Shifted)) 12627 return ShiftedAddRec->getNumIterationsInRange( 12628 Range.subtract(SC->getAPInt()), SE); 12629 // This is strange and shouldn't happen. 12630 return SE.getCouldNotCompute(); 12631 } 12632 12633 // The only time we can solve this is when we have all constant indices. 12634 // Otherwise, we cannot determine the overflow conditions. 12635 if (any_of(operands(), [](const SCEV *Op) { return !isa<SCEVConstant>(Op); })) 12636 return SE.getCouldNotCompute(); 12637 12638 // Okay at this point we know that all elements of the chrec are constants and 12639 // that the start element is zero. 12640 12641 // First check to see if the range contains zero. If not, the first 12642 // iteration exits. 12643 unsigned BitWidth = SE.getTypeSizeInBits(getType()); 12644 if (!Range.contains(APInt(BitWidth, 0))) 12645 return SE.getZero(getType()); 12646 12647 if (isAffine()) { 12648 // If this is an affine expression then we have this situation: 12649 // Solve {0,+,A} in Range === Ax in Range 12650 12651 // We know that zero is in the range. If A is positive then we know that 12652 // the upper value of the range must be the first possible exit value. 12653 // If A is negative then the lower of the range is the last possible loop 12654 // value. Also note that we already checked for a full range. 12655 APInt A = cast<SCEVConstant>(getOperand(1))->getAPInt(); 12656 APInt End = A.sge(1) ? (Range.getUpper() - 1) : Range.getLower(); 12657 12658 // The exit value should be (End+A)/A. 12659 APInt ExitVal = (End + A).udiv(A); 12660 ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal); 12661 12662 // Evaluate at the exit value. If we really did fall out of the valid 12663 // range, then we computed our trip count, otherwise wrap around or other 12664 // things must have happened. 12665 ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE); 12666 if (Range.contains(Val->getValue())) 12667 return SE.getCouldNotCompute(); // Something strange happened 12668 12669 // Ensure that the previous value is in the range. 12670 assert(Range.contains( 12671 EvaluateConstantChrecAtConstant(this, 12672 ConstantInt::get(SE.getContext(), ExitVal - 1), SE)->getValue()) && 12673 "Linear scev computation is off in a bad way!"); 12674 return SE.getConstant(ExitValue); 12675 } 12676 12677 if (isQuadratic()) { 12678 if (auto S = SolveQuadraticAddRecRange(this, Range, SE)) 12679 return SE.getConstant(S.getValue()); 12680 } 12681 12682 return SE.getCouldNotCompute(); 12683 } 12684 12685 const SCEVAddRecExpr * 12686 SCEVAddRecExpr::getPostIncExpr(ScalarEvolution &SE) const { 12687 assert(getNumOperands() > 1 && "AddRec with zero step?"); 12688 // There is a temptation to just call getAddExpr(this, getStepRecurrence(SE)), 12689 // but in this case we cannot guarantee that the value returned will be an 12690 // AddRec because SCEV does not have a fixed point where it stops 12691 // simplification: it is legal to return ({rec1} + {rec2}). For example, it 12692 // may happen if we reach arithmetic depth limit while simplifying. So we 12693 // construct the returned value explicitly. 12694 SmallVector<const SCEV *, 3> Ops; 12695 // If this is {A,+,B,+,C,...,+,N}, then its step is {B,+,C,+,...,+,N}, and 12696 // (this + Step) is {A+B,+,B+C,+...,+,N}. 12697 for (unsigned i = 0, e = getNumOperands() - 1; i < e; ++i) 12698 Ops.push_back(SE.getAddExpr(getOperand(i), getOperand(i + 1))); 12699 // We know that the last operand is not a constant zero (otherwise it would 12700 // have been popped out earlier). This guarantees us that if the result has 12701 // the same last operand, then it will also not be popped out, meaning that 12702 // the returned value will be an AddRec. 12703 const SCEV *Last = getOperand(getNumOperands() - 1); 12704 assert(!Last->isZero() && "Recurrency with zero step?"); 12705 Ops.push_back(Last); 12706 return cast<SCEVAddRecExpr>(SE.getAddRecExpr(Ops, getLoop(), 12707 SCEV::FlagAnyWrap)); 12708 } 12709 12710 // Return true when S contains at least an undef value. 12711 bool ScalarEvolution::containsUndefs(const SCEV *S) const { 12712 return SCEVExprContains(S, [](const SCEV *S) { 12713 if (const auto *SU = dyn_cast<SCEVUnknown>(S)) 12714 return isa<UndefValue>(SU->getValue()); 12715 return false; 12716 }); 12717 } 12718 12719 // Return true when S contains a value that is a nullptr. 12720 bool ScalarEvolution::containsErasedValue(const SCEV *S) const { 12721 return SCEVExprContains(S, [](const SCEV *S) { 12722 if (const auto *SU = dyn_cast<SCEVUnknown>(S)) 12723 return SU->getValue() == nullptr; 12724 return false; 12725 }); 12726 } 12727 12728 /// Return the size of an element read or written by Inst. 12729 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) { 12730 Type *Ty; 12731 if (StoreInst *Store = dyn_cast<StoreInst>(Inst)) 12732 Ty = Store->getValueOperand()->getType(); 12733 else if (LoadInst *Load = dyn_cast<LoadInst>(Inst)) 12734 Ty = Load->getType(); 12735 else 12736 return nullptr; 12737 12738 Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty)); 12739 return getSizeOfExpr(ETy, Ty); 12740 } 12741 12742 //===----------------------------------------------------------------------===// 12743 // SCEVCallbackVH Class Implementation 12744 //===----------------------------------------------------------------------===// 12745 12746 void ScalarEvolution::SCEVCallbackVH::deleted() { 12747 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!"); 12748 if (PHINode *PN = dyn_cast<PHINode>(getValPtr())) 12749 SE->ConstantEvolutionLoopExitValue.erase(PN); 12750 SE->eraseValueFromMap(getValPtr()); 12751 // this now dangles! 12752 } 12753 12754 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) { 12755 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!"); 12756 12757 // Forget all the expressions associated with users of the old value, 12758 // so that future queries will recompute the expressions using the new 12759 // value. 12760 Value *Old = getValPtr(); 12761 SmallVector<User *, 16> Worklist(Old->users()); 12762 SmallPtrSet<User *, 8> Visited; 12763 while (!Worklist.empty()) { 12764 User *U = Worklist.pop_back_val(); 12765 // Deleting the Old value will cause this to dangle. Postpone 12766 // that until everything else is done. 12767 if (U == Old) 12768 continue; 12769 if (!Visited.insert(U).second) 12770 continue; 12771 if (PHINode *PN = dyn_cast<PHINode>(U)) 12772 SE->ConstantEvolutionLoopExitValue.erase(PN); 12773 SE->eraseValueFromMap(U); 12774 llvm::append_range(Worklist, U->users()); 12775 } 12776 // Delete the Old value. 12777 if (PHINode *PN = dyn_cast<PHINode>(Old)) 12778 SE->ConstantEvolutionLoopExitValue.erase(PN); 12779 SE->eraseValueFromMap(Old); 12780 // this now dangles! 12781 } 12782 12783 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se) 12784 : CallbackVH(V), SE(se) {} 12785 12786 //===----------------------------------------------------------------------===// 12787 // ScalarEvolution Class Implementation 12788 //===----------------------------------------------------------------------===// 12789 12790 ScalarEvolution::ScalarEvolution(Function &F, TargetLibraryInfo &TLI, 12791 AssumptionCache &AC, DominatorTree &DT, 12792 LoopInfo &LI) 12793 : F(F), TLI(TLI), AC(AC), DT(DT), LI(LI), 12794 CouldNotCompute(new SCEVCouldNotCompute()), ValuesAtScopes(64), 12795 LoopDispositions(64), BlockDispositions(64) { 12796 // To use guards for proving predicates, we need to scan every instruction in 12797 // relevant basic blocks, and not just terminators. Doing this is a waste of 12798 // time if the IR does not actually contain any calls to 12799 // @llvm.experimental.guard, so do a quick check and remember this beforehand. 12800 // 12801 // This pessimizes the case where a pass that preserves ScalarEvolution wants 12802 // to _add_ guards to the module when there weren't any before, and wants 12803 // ScalarEvolution to optimize based on those guards. For now we prefer to be 12804 // efficient in lieu of being smart in that rather obscure case. 12805 12806 auto *GuardDecl = F.getParent()->getFunction( 12807 Intrinsic::getName(Intrinsic::experimental_guard)); 12808 HasGuards = GuardDecl && !GuardDecl->use_empty(); 12809 } 12810 12811 ScalarEvolution::ScalarEvolution(ScalarEvolution &&Arg) 12812 : F(Arg.F), HasGuards(Arg.HasGuards), TLI(Arg.TLI), AC(Arg.AC), DT(Arg.DT), 12813 LI(Arg.LI), CouldNotCompute(std::move(Arg.CouldNotCompute)), 12814 ValueExprMap(std::move(Arg.ValueExprMap)), 12815 PendingLoopPredicates(std::move(Arg.PendingLoopPredicates)), 12816 PendingPhiRanges(std::move(Arg.PendingPhiRanges)), 12817 PendingMerges(std::move(Arg.PendingMerges)), 12818 MinTrailingZerosCache(std::move(Arg.MinTrailingZerosCache)), 12819 BackedgeTakenCounts(std::move(Arg.BackedgeTakenCounts)), 12820 PredicatedBackedgeTakenCounts( 12821 std::move(Arg.PredicatedBackedgeTakenCounts)), 12822 BECountUsers(std::move(Arg.BECountUsers)), 12823 ConstantEvolutionLoopExitValue( 12824 std::move(Arg.ConstantEvolutionLoopExitValue)), 12825 ValuesAtScopes(std::move(Arg.ValuesAtScopes)), 12826 ValuesAtScopesUsers(std::move(Arg.ValuesAtScopesUsers)), 12827 LoopDispositions(std::move(Arg.LoopDispositions)), 12828 LoopPropertiesCache(std::move(Arg.LoopPropertiesCache)), 12829 BlockDispositions(std::move(Arg.BlockDispositions)), 12830 SCEVUsers(std::move(Arg.SCEVUsers)), 12831 UnsignedRanges(std::move(Arg.UnsignedRanges)), 12832 SignedRanges(std::move(Arg.SignedRanges)), 12833 UniqueSCEVs(std::move(Arg.UniqueSCEVs)), 12834 UniquePreds(std::move(Arg.UniquePreds)), 12835 SCEVAllocator(std::move(Arg.SCEVAllocator)), 12836 LoopUsers(std::move(Arg.LoopUsers)), 12837 PredicatedSCEVRewrites(std::move(Arg.PredicatedSCEVRewrites)), 12838 FirstUnknown(Arg.FirstUnknown) { 12839 Arg.FirstUnknown = nullptr; 12840 } 12841 12842 ScalarEvolution::~ScalarEvolution() { 12843 // Iterate through all the SCEVUnknown instances and call their 12844 // destructors, so that they release their references to their values. 12845 for (SCEVUnknown *U = FirstUnknown; U;) { 12846 SCEVUnknown *Tmp = U; 12847 U = U->Next; 12848 Tmp->~SCEVUnknown(); 12849 } 12850 FirstUnknown = nullptr; 12851 12852 ExprValueMap.clear(); 12853 ValueExprMap.clear(); 12854 HasRecMap.clear(); 12855 BackedgeTakenCounts.clear(); 12856 PredicatedBackedgeTakenCounts.clear(); 12857 12858 assert(PendingLoopPredicates.empty() && "isImpliedCond garbage"); 12859 assert(PendingPhiRanges.empty() && "getRangeRef garbage"); 12860 assert(PendingMerges.empty() && "isImpliedViaMerge garbage"); 12861 assert(!WalkingBEDominatingConds && "isLoopBackedgeGuardedByCond garbage!"); 12862 assert(!ProvingSplitPredicate && "ProvingSplitPredicate garbage!"); 12863 } 12864 12865 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) { 12866 return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L)); 12867 } 12868 12869 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE, 12870 const Loop *L) { 12871 // Print all inner loops first 12872 for (Loop *I : *L) 12873 PrintLoopInfo(OS, SE, I); 12874 12875 OS << "Loop "; 12876 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12877 OS << ": "; 12878 12879 SmallVector<BasicBlock *, 8> ExitingBlocks; 12880 L->getExitingBlocks(ExitingBlocks); 12881 if (ExitingBlocks.size() != 1) 12882 OS << "<multiple exits> "; 12883 12884 if (SE->hasLoopInvariantBackedgeTakenCount(L)) 12885 OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L) << "\n"; 12886 else 12887 OS << "Unpredictable backedge-taken count.\n"; 12888 12889 if (ExitingBlocks.size() > 1) 12890 for (BasicBlock *ExitingBlock : ExitingBlocks) { 12891 OS << " exit count for " << ExitingBlock->getName() << ": " 12892 << *SE->getExitCount(L, ExitingBlock) << "\n"; 12893 } 12894 12895 OS << "Loop "; 12896 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12897 OS << ": "; 12898 12899 if (!isa<SCEVCouldNotCompute>(SE->getConstantMaxBackedgeTakenCount(L))) { 12900 OS << "max backedge-taken count is " << *SE->getConstantMaxBackedgeTakenCount(L); 12901 if (SE->isBackedgeTakenCountMaxOrZero(L)) 12902 OS << ", actual taken count either this or zero."; 12903 } else { 12904 OS << "Unpredictable max backedge-taken count. "; 12905 } 12906 12907 OS << "\n" 12908 "Loop "; 12909 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12910 OS << ": "; 12911 12912 SmallVector<const SCEVPredicate *, 4> Preds; 12913 auto PBT = SE->getPredicatedBackedgeTakenCount(L, Preds); 12914 if (!isa<SCEVCouldNotCompute>(PBT)) { 12915 OS << "Predicated backedge-taken count is " << *PBT << "\n"; 12916 OS << " Predicates:\n"; 12917 for (auto *P : Preds) 12918 P->print(OS, 4); 12919 } else { 12920 OS << "Unpredictable predicated backedge-taken count. "; 12921 } 12922 OS << "\n"; 12923 12924 if (SE->hasLoopInvariantBackedgeTakenCount(L)) { 12925 OS << "Loop "; 12926 L->getHeader()->printAsOperand(OS, /*PrintType=*/false); 12927 OS << ": "; 12928 OS << "Trip multiple is " << SE->getSmallConstantTripMultiple(L) << "\n"; 12929 } 12930 } 12931 12932 static StringRef loopDispositionToStr(ScalarEvolution::LoopDisposition LD) { 12933 switch (LD) { 12934 case ScalarEvolution::LoopVariant: 12935 return "Variant"; 12936 case ScalarEvolution::LoopInvariant: 12937 return "Invariant"; 12938 case ScalarEvolution::LoopComputable: 12939 return "Computable"; 12940 } 12941 llvm_unreachable("Unknown ScalarEvolution::LoopDisposition kind!"); 12942 } 12943 12944 void ScalarEvolution::print(raw_ostream &OS) const { 12945 // ScalarEvolution's implementation of the print method is to print 12946 // out SCEV values of all instructions that are interesting. Doing 12947 // this potentially causes it to create new SCEV objects though, 12948 // which technically conflicts with the const qualifier. This isn't 12949 // observable from outside the class though, so casting away the 12950 // const isn't dangerous. 12951 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this); 12952 12953 if (ClassifyExpressions) { 12954 OS << "Classifying expressions for: "; 12955 F.printAsOperand(OS, /*PrintType=*/false); 12956 OS << "\n"; 12957 for (Instruction &I : instructions(F)) 12958 if (isSCEVable(I.getType()) && !isa<CmpInst>(I)) { 12959 OS << I << '\n'; 12960 OS << " --> "; 12961 const SCEV *SV = SE.getSCEV(&I); 12962 SV->print(OS); 12963 if (!isa<SCEVCouldNotCompute>(SV)) { 12964 OS << " U: "; 12965 SE.getUnsignedRange(SV).print(OS); 12966 OS << " S: "; 12967 SE.getSignedRange(SV).print(OS); 12968 } 12969 12970 const Loop *L = LI.getLoopFor(I.getParent()); 12971 12972 const SCEV *AtUse = SE.getSCEVAtScope(SV, L); 12973 if (AtUse != SV) { 12974 OS << " --> "; 12975 AtUse->print(OS); 12976 if (!isa<SCEVCouldNotCompute>(AtUse)) { 12977 OS << " U: "; 12978 SE.getUnsignedRange(AtUse).print(OS); 12979 OS << " S: "; 12980 SE.getSignedRange(AtUse).print(OS); 12981 } 12982 } 12983 12984 if (L) { 12985 OS << "\t\t" "Exits: "; 12986 const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop()); 12987 if (!SE.isLoopInvariant(ExitValue, L)) { 12988 OS << "<<Unknown>>"; 12989 } else { 12990 OS << *ExitValue; 12991 } 12992 12993 bool First = true; 12994 for (auto *Iter = L; Iter; Iter = Iter->getParentLoop()) { 12995 if (First) { 12996 OS << "\t\t" "LoopDispositions: { "; 12997 First = false; 12998 } else { 12999 OS << ", "; 13000 } 13001 13002 Iter->getHeader()->printAsOperand(OS, /*PrintType=*/false); 13003 OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, Iter)); 13004 } 13005 13006 for (auto *InnerL : depth_first(L)) { 13007 if (InnerL == L) 13008 continue; 13009 if (First) { 13010 OS << "\t\t" "LoopDispositions: { "; 13011 First = false; 13012 } else { 13013 OS << ", "; 13014 } 13015 13016 InnerL->getHeader()->printAsOperand(OS, /*PrintType=*/false); 13017 OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, InnerL)); 13018 } 13019 13020 OS << " }"; 13021 } 13022 13023 OS << "\n"; 13024 } 13025 } 13026 13027 OS << "Determining loop execution counts for: "; 13028 F.printAsOperand(OS, /*PrintType=*/false); 13029 OS << "\n"; 13030 for (Loop *I : LI) 13031 PrintLoopInfo(OS, &SE, I); 13032 } 13033 13034 ScalarEvolution::LoopDisposition 13035 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) { 13036 auto &Values = LoopDispositions[S]; 13037 for (auto &V : Values) { 13038 if (V.getPointer() == L) 13039 return V.getInt(); 13040 } 13041 Values.emplace_back(L, LoopVariant); 13042 LoopDisposition D = computeLoopDisposition(S, L); 13043 auto &Values2 = LoopDispositions[S]; 13044 for (auto &V : llvm::reverse(Values2)) { 13045 if (V.getPointer() == L) { 13046 V.setInt(D); 13047 break; 13048 } 13049 } 13050 return D; 13051 } 13052 13053 ScalarEvolution::LoopDisposition 13054 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) { 13055 switch (S->getSCEVType()) { 13056 case scConstant: 13057 return LoopInvariant; 13058 case scPtrToInt: 13059 case scTruncate: 13060 case scZeroExtend: 13061 case scSignExtend: 13062 return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L); 13063 case scAddRecExpr: { 13064 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S); 13065 13066 // If L is the addrec's loop, it's computable. 13067 if (AR->getLoop() == L) 13068 return LoopComputable; 13069 13070 // Add recurrences are never invariant in the function-body (null loop). 13071 if (!L) 13072 return LoopVariant; 13073 13074 // Everything that is not defined at loop entry is variant. 13075 if (DT.dominates(L->getHeader(), AR->getLoop()->getHeader())) 13076 return LoopVariant; 13077 assert(!L->contains(AR->getLoop()) && "Containing loop's header does not" 13078 " dominate the contained loop's header?"); 13079 13080 // This recurrence is invariant w.r.t. L if AR's loop contains L. 13081 if (AR->getLoop()->contains(L)) 13082 return LoopInvariant; 13083 13084 // This recurrence is variant w.r.t. L if any of its operands 13085 // are variant. 13086 for (auto *Op : AR->operands()) 13087 if (!isLoopInvariant(Op, L)) 13088 return LoopVariant; 13089 13090 // Otherwise it's loop-invariant. 13091 return LoopInvariant; 13092 } 13093 case scAddExpr: 13094 case scMulExpr: 13095 case scUMaxExpr: 13096 case scSMaxExpr: 13097 case scUMinExpr: 13098 case scSMinExpr: 13099 case scSequentialUMinExpr: { 13100 bool HasVarying = false; 13101 for (auto *Op : cast<SCEVNAryExpr>(S)->operands()) { 13102 LoopDisposition D = getLoopDisposition(Op, L); 13103 if (D == LoopVariant) 13104 return LoopVariant; 13105 if (D == LoopComputable) 13106 HasVarying = true; 13107 } 13108 return HasVarying ? LoopComputable : LoopInvariant; 13109 } 13110 case scUDivExpr: { 13111 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S); 13112 LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L); 13113 if (LD == LoopVariant) 13114 return LoopVariant; 13115 LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L); 13116 if (RD == LoopVariant) 13117 return LoopVariant; 13118 return (LD == LoopInvariant && RD == LoopInvariant) ? 13119 LoopInvariant : LoopComputable; 13120 } 13121 case scUnknown: 13122 // All non-instruction values are loop invariant. All instructions are loop 13123 // invariant if they are not contained in the specified loop. 13124 // Instructions are never considered invariant in the function body 13125 // (null loop) because they are defined within the "loop". 13126 if (auto *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) 13127 return (L && !L->contains(I)) ? LoopInvariant : LoopVariant; 13128 return LoopInvariant; 13129 case scCouldNotCompute: 13130 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 13131 } 13132 llvm_unreachable("Unknown SCEV kind!"); 13133 } 13134 13135 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) { 13136 return getLoopDisposition(S, L) == LoopInvariant; 13137 } 13138 13139 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) { 13140 return getLoopDisposition(S, L) == LoopComputable; 13141 } 13142 13143 ScalarEvolution::BlockDisposition 13144 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) { 13145 auto &Values = BlockDispositions[S]; 13146 for (auto &V : Values) { 13147 if (V.getPointer() == BB) 13148 return V.getInt(); 13149 } 13150 Values.emplace_back(BB, DoesNotDominateBlock); 13151 BlockDisposition D = computeBlockDisposition(S, BB); 13152 auto &Values2 = BlockDispositions[S]; 13153 for (auto &V : llvm::reverse(Values2)) { 13154 if (V.getPointer() == BB) { 13155 V.setInt(D); 13156 break; 13157 } 13158 } 13159 return D; 13160 } 13161 13162 ScalarEvolution::BlockDisposition 13163 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) { 13164 switch (S->getSCEVType()) { 13165 case scConstant: 13166 return ProperlyDominatesBlock; 13167 case scPtrToInt: 13168 case scTruncate: 13169 case scZeroExtend: 13170 case scSignExtend: 13171 return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB); 13172 case scAddRecExpr: { 13173 // This uses a "dominates" query instead of "properly dominates" query 13174 // to test for proper dominance too, because the instruction which 13175 // produces the addrec's value is a PHI, and a PHI effectively properly 13176 // dominates its entire containing block. 13177 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S); 13178 if (!DT.dominates(AR->getLoop()->getHeader(), BB)) 13179 return DoesNotDominateBlock; 13180 13181 // Fall through into SCEVNAryExpr handling. 13182 LLVM_FALLTHROUGH; 13183 } 13184 case scAddExpr: 13185 case scMulExpr: 13186 case scUMaxExpr: 13187 case scSMaxExpr: 13188 case scUMinExpr: 13189 case scSMinExpr: 13190 case scSequentialUMinExpr: { 13191 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S); 13192 bool Proper = true; 13193 for (const SCEV *NAryOp : NAry->operands()) { 13194 BlockDisposition D = getBlockDisposition(NAryOp, BB); 13195 if (D == DoesNotDominateBlock) 13196 return DoesNotDominateBlock; 13197 if (D == DominatesBlock) 13198 Proper = false; 13199 } 13200 return Proper ? ProperlyDominatesBlock : DominatesBlock; 13201 } 13202 case scUDivExpr: { 13203 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S); 13204 const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS(); 13205 BlockDisposition LD = getBlockDisposition(LHS, BB); 13206 if (LD == DoesNotDominateBlock) 13207 return DoesNotDominateBlock; 13208 BlockDisposition RD = getBlockDisposition(RHS, BB); 13209 if (RD == DoesNotDominateBlock) 13210 return DoesNotDominateBlock; 13211 return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ? 13212 ProperlyDominatesBlock : DominatesBlock; 13213 } 13214 case scUnknown: 13215 if (Instruction *I = 13216 dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) { 13217 if (I->getParent() == BB) 13218 return DominatesBlock; 13219 if (DT.properlyDominates(I->getParent(), BB)) 13220 return ProperlyDominatesBlock; 13221 return DoesNotDominateBlock; 13222 } 13223 return ProperlyDominatesBlock; 13224 case scCouldNotCompute: 13225 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!"); 13226 } 13227 llvm_unreachable("Unknown SCEV kind!"); 13228 } 13229 13230 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) { 13231 return getBlockDisposition(S, BB) >= DominatesBlock; 13232 } 13233 13234 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) { 13235 return getBlockDisposition(S, BB) == ProperlyDominatesBlock; 13236 } 13237 13238 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const { 13239 return SCEVExprContains(S, [&](const SCEV *Expr) { return Expr == Op; }); 13240 } 13241 13242 void ScalarEvolution::forgetBackedgeTakenCounts(const Loop *L, 13243 bool Predicated) { 13244 auto &BECounts = 13245 Predicated ? PredicatedBackedgeTakenCounts : BackedgeTakenCounts; 13246 auto It = BECounts.find(L); 13247 if (It != BECounts.end()) { 13248 for (const ExitNotTakenInfo &ENT : It->second.ExitNotTaken) { 13249 if (!isa<SCEVConstant>(ENT.ExactNotTaken)) { 13250 auto UserIt = BECountUsers.find(ENT.ExactNotTaken); 13251 assert(UserIt != BECountUsers.end()); 13252 UserIt->second.erase({L, Predicated}); 13253 } 13254 } 13255 BECounts.erase(It); 13256 } 13257 } 13258 13259 void ScalarEvolution::forgetMemoizedResults(ArrayRef<const SCEV *> SCEVs) { 13260 SmallPtrSet<const SCEV *, 8> ToForget(SCEVs.begin(), SCEVs.end()); 13261 SmallVector<const SCEV *, 8> Worklist(ToForget.begin(), ToForget.end()); 13262 13263 while (!Worklist.empty()) { 13264 const SCEV *Curr = Worklist.pop_back_val(); 13265 auto Users = SCEVUsers.find(Curr); 13266 if (Users != SCEVUsers.end()) 13267 for (auto *User : Users->second) 13268 if (ToForget.insert(User).second) 13269 Worklist.push_back(User); 13270 } 13271 13272 for (auto *S : ToForget) 13273 forgetMemoizedResultsImpl(S); 13274 13275 for (auto I = PredicatedSCEVRewrites.begin(); 13276 I != PredicatedSCEVRewrites.end();) { 13277 std::pair<const SCEV *, const Loop *> Entry = I->first; 13278 if (ToForget.count(Entry.first)) 13279 PredicatedSCEVRewrites.erase(I++); 13280 else 13281 ++I; 13282 } 13283 } 13284 13285 void ScalarEvolution::forgetMemoizedResultsImpl(const SCEV *S) { 13286 LoopDispositions.erase(S); 13287 BlockDispositions.erase(S); 13288 UnsignedRanges.erase(S); 13289 SignedRanges.erase(S); 13290 HasRecMap.erase(S); 13291 MinTrailingZerosCache.erase(S); 13292 13293 auto ExprIt = ExprValueMap.find(S); 13294 if (ExprIt != ExprValueMap.end()) { 13295 for (Value *V : ExprIt->second) { 13296 auto ValueIt = ValueExprMap.find_as(V); 13297 if (ValueIt != ValueExprMap.end()) 13298 ValueExprMap.erase(ValueIt); 13299 } 13300 ExprValueMap.erase(ExprIt); 13301 } 13302 13303 auto ScopeIt = ValuesAtScopes.find(S); 13304 if (ScopeIt != ValuesAtScopes.end()) { 13305 for (const auto &Pair : ScopeIt->second) 13306 if (!isa_and_nonnull<SCEVConstant>(Pair.second)) 13307 erase_value(ValuesAtScopesUsers[Pair.second], 13308 std::make_pair(Pair.first, S)); 13309 ValuesAtScopes.erase(ScopeIt); 13310 } 13311 13312 auto ScopeUserIt = ValuesAtScopesUsers.find(S); 13313 if (ScopeUserIt != ValuesAtScopesUsers.end()) { 13314 for (const auto &Pair : ScopeUserIt->second) 13315 erase_value(ValuesAtScopes[Pair.second], std::make_pair(Pair.first, S)); 13316 ValuesAtScopesUsers.erase(ScopeUserIt); 13317 } 13318 13319 auto BEUsersIt = BECountUsers.find(S); 13320 if (BEUsersIt != BECountUsers.end()) { 13321 // Work on a copy, as forgetBackedgeTakenCounts() will modify the original. 13322 auto Copy = BEUsersIt->second; 13323 for (const auto &Pair : Copy) 13324 forgetBackedgeTakenCounts(Pair.getPointer(), Pair.getInt()); 13325 BECountUsers.erase(BEUsersIt); 13326 } 13327 } 13328 13329 void 13330 ScalarEvolution::getUsedLoops(const SCEV *S, 13331 SmallPtrSetImpl<const Loop *> &LoopsUsed) { 13332 struct FindUsedLoops { 13333 FindUsedLoops(SmallPtrSetImpl<const Loop *> &LoopsUsed) 13334 : LoopsUsed(LoopsUsed) {} 13335 SmallPtrSetImpl<const Loop *> &LoopsUsed; 13336 bool follow(const SCEV *S) { 13337 if (auto *AR = dyn_cast<SCEVAddRecExpr>(S)) 13338 LoopsUsed.insert(AR->getLoop()); 13339 return true; 13340 } 13341 13342 bool isDone() const { return false; } 13343 }; 13344 13345 FindUsedLoops F(LoopsUsed); 13346 SCEVTraversal<FindUsedLoops>(F).visitAll(S); 13347 } 13348 13349 void ScalarEvolution::getReachableBlocks( 13350 SmallPtrSetImpl<BasicBlock *> &Reachable, Function &F) { 13351 SmallVector<BasicBlock *> Worklist; 13352 Worklist.push_back(&F.getEntryBlock()); 13353 while (!Worklist.empty()) { 13354 BasicBlock *BB = Worklist.pop_back_val(); 13355 if (!Reachable.insert(BB).second) 13356 continue; 13357 13358 Value *Cond; 13359 BasicBlock *TrueBB, *FalseBB; 13360 if (match(BB->getTerminator(), m_Br(m_Value(Cond), m_BasicBlock(TrueBB), 13361 m_BasicBlock(FalseBB)))) { 13362 if (auto *C = dyn_cast<ConstantInt>(Cond)) { 13363 Worklist.push_back(C->isOne() ? TrueBB : FalseBB); 13364 continue; 13365 } 13366 13367 if (auto *Cmp = dyn_cast<ICmpInst>(Cond)) { 13368 const SCEV *L = getSCEV(Cmp->getOperand(0)); 13369 const SCEV *R = getSCEV(Cmp->getOperand(1)); 13370 if (isKnownPredicateViaConstantRanges(Cmp->getPredicate(), L, R)) { 13371 Worklist.push_back(TrueBB); 13372 continue; 13373 } 13374 if (isKnownPredicateViaConstantRanges(Cmp->getInversePredicate(), L, 13375 R)) { 13376 Worklist.push_back(FalseBB); 13377 continue; 13378 } 13379 } 13380 } 13381 13382 append_range(Worklist, successors(BB)); 13383 } 13384 } 13385 13386 void ScalarEvolution::verify() const { 13387 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this); 13388 ScalarEvolution SE2(F, TLI, AC, DT, LI); 13389 13390 SmallVector<Loop *, 8> LoopStack(LI.begin(), LI.end()); 13391 13392 // Map's SCEV expressions from one ScalarEvolution "universe" to another. 13393 struct SCEVMapper : public SCEVRewriteVisitor<SCEVMapper> { 13394 SCEVMapper(ScalarEvolution &SE) : SCEVRewriteVisitor<SCEVMapper>(SE) {} 13395 13396 const SCEV *visitConstant(const SCEVConstant *Constant) { 13397 return SE.getConstant(Constant->getAPInt()); 13398 } 13399 13400 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 13401 return SE.getUnknown(Expr->getValue()); 13402 } 13403 13404 const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) { 13405 return SE.getCouldNotCompute(); 13406 } 13407 }; 13408 13409 SCEVMapper SCM(SE2); 13410 SmallPtrSet<BasicBlock *, 16> ReachableBlocks; 13411 SE2.getReachableBlocks(ReachableBlocks, F); 13412 13413 auto GetDelta = [&](const SCEV *Old, const SCEV *New) -> const SCEV * { 13414 if (containsUndefs(Old) || containsUndefs(New)) { 13415 // SCEV treats "undef" as an unknown but consistent value (i.e. it does 13416 // not propagate undef aggressively). This means we can (and do) fail 13417 // verification in cases where a transform makes a value go from "undef" 13418 // to "undef+1" (say). The transform is fine, since in both cases the 13419 // result is "undef", but SCEV thinks the value increased by 1. 13420 return nullptr; 13421 } 13422 13423 // Unless VerifySCEVStrict is set, we only compare constant deltas. 13424 const SCEV *Delta = SE2.getMinusSCEV(Old, New); 13425 if (!VerifySCEVStrict && !isa<SCEVConstant>(Delta)) 13426 return nullptr; 13427 13428 return Delta; 13429 }; 13430 13431 while (!LoopStack.empty()) { 13432 auto *L = LoopStack.pop_back_val(); 13433 llvm::append_range(LoopStack, *L); 13434 13435 // Only verify BECounts in reachable loops. For an unreachable loop, 13436 // any BECount is legal. 13437 if (!ReachableBlocks.contains(L->getHeader())) 13438 continue; 13439 13440 // Only verify cached BECounts. Computing new BECounts may change the 13441 // results of subsequent SCEV uses. 13442 auto It = BackedgeTakenCounts.find(L); 13443 if (It == BackedgeTakenCounts.end()) 13444 continue; 13445 13446 auto *CurBECount = 13447 SCM.visit(It->second.getExact(L, const_cast<ScalarEvolution *>(this))); 13448 auto *NewBECount = SE2.getBackedgeTakenCount(L); 13449 13450 if (CurBECount == SE2.getCouldNotCompute() || 13451 NewBECount == SE2.getCouldNotCompute()) { 13452 // NB! This situation is legal, but is very suspicious -- whatever pass 13453 // change the loop to make a trip count go from could not compute to 13454 // computable or vice-versa *should have* invalidated SCEV. However, we 13455 // choose not to assert here (for now) since we don't want false 13456 // positives. 13457 continue; 13458 } 13459 13460 if (SE.getTypeSizeInBits(CurBECount->getType()) > 13461 SE.getTypeSizeInBits(NewBECount->getType())) 13462 NewBECount = SE2.getZeroExtendExpr(NewBECount, CurBECount->getType()); 13463 else if (SE.getTypeSizeInBits(CurBECount->getType()) < 13464 SE.getTypeSizeInBits(NewBECount->getType())) 13465 CurBECount = SE2.getZeroExtendExpr(CurBECount, NewBECount->getType()); 13466 13467 const SCEV *Delta = GetDelta(CurBECount, NewBECount); 13468 if (Delta && !Delta->isZero()) { 13469 dbgs() << "Trip Count for " << *L << " Changed!\n"; 13470 dbgs() << "Old: " << *CurBECount << "\n"; 13471 dbgs() << "New: " << *NewBECount << "\n"; 13472 dbgs() << "Delta: " << *Delta << "\n"; 13473 std::abort(); 13474 } 13475 } 13476 13477 // Collect all valid loops currently in LoopInfo. 13478 SmallPtrSet<Loop *, 32> ValidLoops; 13479 SmallVector<Loop *, 32> Worklist(LI.begin(), LI.end()); 13480 while (!Worklist.empty()) { 13481 Loop *L = Worklist.pop_back_val(); 13482 if (ValidLoops.insert(L).second) 13483 Worklist.append(L->begin(), L->end()); 13484 } 13485 for (auto &KV : ValueExprMap) { 13486 #ifndef NDEBUG 13487 // Check for SCEV expressions referencing invalid/deleted loops. 13488 if (auto *AR = dyn_cast<SCEVAddRecExpr>(KV.second)) { 13489 assert(ValidLoops.contains(AR->getLoop()) && 13490 "AddRec references invalid loop"); 13491 } 13492 #endif 13493 13494 // Check that the value is also part of the reverse map. 13495 auto It = ExprValueMap.find(KV.second); 13496 if (It == ExprValueMap.end() || !It->second.contains(KV.first)) { 13497 dbgs() << "Value " << *KV.first 13498 << " is in ValueExprMap but not in ExprValueMap\n"; 13499 std::abort(); 13500 } 13501 13502 if (auto *I = dyn_cast<Instruction>(&*KV.first)) { 13503 if (!ReachableBlocks.contains(I->getParent())) 13504 continue; 13505 const SCEV *OldSCEV = SCM.visit(KV.second); 13506 const SCEV *NewSCEV = SE2.getSCEV(I); 13507 const SCEV *Delta = GetDelta(OldSCEV, NewSCEV); 13508 if (Delta && !Delta->isZero()) { 13509 dbgs() << "SCEV for value " << *I << " changed!\n" 13510 << "Old: " << *OldSCEV << "\n" 13511 << "New: " << *NewSCEV << "\n" 13512 << "Delta: " << *Delta << "\n"; 13513 std::abort(); 13514 } 13515 } 13516 } 13517 13518 for (const auto &KV : ExprValueMap) { 13519 for (Value *V : KV.second) { 13520 auto It = ValueExprMap.find_as(V); 13521 if (It == ValueExprMap.end()) { 13522 dbgs() << "Value " << *V 13523 << " is in ExprValueMap but not in ValueExprMap\n"; 13524 std::abort(); 13525 } 13526 if (It->second != KV.first) { 13527 dbgs() << "Value " << *V << " mapped to " << *It->second 13528 << " rather than " << *KV.first << "\n"; 13529 std::abort(); 13530 } 13531 } 13532 } 13533 13534 // Verify integrity of SCEV users. 13535 for (const auto &S : UniqueSCEVs) { 13536 SmallVector<const SCEV *, 4> Ops; 13537 collectUniqueOps(&S, Ops); 13538 for (const auto *Op : Ops) { 13539 // We do not store dependencies of constants. 13540 if (isa<SCEVConstant>(Op)) 13541 continue; 13542 auto It = SCEVUsers.find(Op); 13543 if (It != SCEVUsers.end() && It->second.count(&S)) 13544 continue; 13545 dbgs() << "Use of operand " << *Op << " by user " << S 13546 << " is not being tracked!\n"; 13547 std::abort(); 13548 } 13549 } 13550 13551 // Verify integrity of ValuesAtScopes users. 13552 for (const auto &ValueAndVec : ValuesAtScopes) { 13553 const SCEV *Value = ValueAndVec.first; 13554 for (const auto &LoopAndValueAtScope : ValueAndVec.second) { 13555 const Loop *L = LoopAndValueAtScope.first; 13556 const SCEV *ValueAtScope = LoopAndValueAtScope.second; 13557 if (!isa<SCEVConstant>(ValueAtScope)) { 13558 auto It = ValuesAtScopesUsers.find(ValueAtScope); 13559 if (It != ValuesAtScopesUsers.end() && 13560 is_contained(It->second, std::make_pair(L, Value))) 13561 continue; 13562 dbgs() << "Value: " << *Value << ", Loop: " << *L << ", ValueAtScope: " 13563 << *ValueAtScope << " missing in ValuesAtScopesUsers\n"; 13564 std::abort(); 13565 } 13566 } 13567 } 13568 13569 for (const auto &ValueAtScopeAndVec : ValuesAtScopesUsers) { 13570 const SCEV *ValueAtScope = ValueAtScopeAndVec.first; 13571 for (const auto &LoopAndValue : ValueAtScopeAndVec.second) { 13572 const Loop *L = LoopAndValue.first; 13573 const SCEV *Value = LoopAndValue.second; 13574 assert(!isa<SCEVConstant>(Value)); 13575 auto It = ValuesAtScopes.find(Value); 13576 if (It != ValuesAtScopes.end() && 13577 is_contained(It->second, std::make_pair(L, ValueAtScope))) 13578 continue; 13579 dbgs() << "Value: " << *Value << ", Loop: " << *L << ", ValueAtScope: " 13580 << *ValueAtScope << " missing in ValuesAtScopes\n"; 13581 std::abort(); 13582 } 13583 } 13584 13585 // Verify integrity of BECountUsers. 13586 auto VerifyBECountUsers = [&](bool Predicated) { 13587 auto &BECounts = 13588 Predicated ? PredicatedBackedgeTakenCounts : BackedgeTakenCounts; 13589 for (const auto &LoopAndBEInfo : BECounts) { 13590 for (const ExitNotTakenInfo &ENT : LoopAndBEInfo.second.ExitNotTaken) { 13591 if (!isa<SCEVConstant>(ENT.ExactNotTaken)) { 13592 auto UserIt = BECountUsers.find(ENT.ExactNotTaken); 13593 if (UserIt != BECountUsers.end() && 13594 UserIt->second.contains({ LoopAndBEInfo.first, Predicated })) 13595 continue; 13596 dbgs() << "Value " << *ENT.ExactNotTaken << " for loop " 13597 << *LoopAndBEInfo.first << " missing from BECountUsers\n"; 13598 std::abort(); 13599 } 13600 } 13601 } 13602 }; 13603 VerifyBECountUsers(/* Predicated */ false); 13604 VerifyBECountUsers(/* Predicated */ true); 13605 } 13606 13607 bool ScalarEvolution::invalidate( 13608 Function &F, const PreservedAnalyses &PA, 13609 FunctionAnalysisManager::Invalidator &Inv) { 13610 // Invalidate the ScalarEvolution object whenever it isn't preserved or one 13611 // of its dependencies is invalidated. 13612 auto PAC = PA.getChecker<ScalarEvolutionAnalysis>(); 13613 return !(PAC.preserved() || PAC.preservedSet<AllAnalysesOn<Function>>()) || 13614 Inv.invalidate<AssumptionAnalysis>(F, PA) || 13615 Inv.invalidate<DominatorTreeAnalysis>(F, PA) || 13616 Inv.invalidate<LoopAnalysis>(F, PA); 13617 } 13618 13619 AnalysisKey ScalarEvolutionAnalysis::Key; 13620 13621 ScalarEvolution ScalarEvolutionAnalysis::run(Function &F, 13622 FunctionAnalysisManager &AM) { 13623 return ScalarEvolution(F, AM.getResult<TargetLibraryAnalysis>(F), 13624 AM.getResult<AssumptionAnalysis>(F), 13625 AM.getResult<DominatorTreeAnalysis>(F), 13626 AM.getResult<LoopAnalysis>(F)); 13627 } 13628 13629 PreservedAnalyses 13630 ScalarEvolutionVerifierPass::run(Function &F, FunctionAnalysisManager &AM) { 13631 AM.getResult<ScalarEvolutionAnalysis>(F).verify(); 13632 return PreservedAnalyses::all(); 13633 } 13634 13635 PreservedAnalyses 13636 ScalarEvolutionPrinterPass::run(Function &F, FunctionAnalysisManager &AM) { 13637 // For compatibility with opt's -analyze feature under legacy pass manager 13638 // which was not ported to NPM. This keeps tests using 13639 // update_analyze_test_checks.py working. 13640 OS << "Printing analysis 'Scalar Evolution Analysis' for function '" 13641 << F.getName() << "':\n"; 13642 AM.getResult<ScalarEvolutionAnalysis>(F).print(OS); 13643 return PreservedAnalyses::all(); 13644 } 13645 13646 INITIALIZE_PASS_BEGIN(ScalarEvolutionWrapperPass, "scalar-evolution", 13647 "Scalar Evolution Analysis", false, true) 13648 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 13649 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass) 13650 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 13651 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass) 13652 INITIALIZE_PASS_END(ScalarEvolutionWrapperPass, "scalar-evolution", 13653 "Scalar Evolution Analysis", false, true) 13654 13655 char ScalarEvolutionWrapperPass::ID = 0; 13656 13657 ScalarEvolutionWrapperPass::ScalarEvolutionWrapperPass() : FunctionPass(ID) { 13658 initializeScalarEvolutionWrapperPassPass(*PassRegistry::getPassRegistry()); 13659 } 13660 13661 bool ScalarEvolutionWrapperPass::runOnFunction(Function &F) { 13662 SE.reset(new ScalarEvolution( 13663 F, getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(F), 13664 getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F), 13665 getAnalysis<DominatorTreeWrapperPass>().getDomTree(), 13666 getAnalysis<LoopInfoWrapperPass>().getLoopInfo())); 13667 return false; 13668 } 13669 13670 void ScalarEvolutionWrapperPass::releaseMemory() { SE.reset(); } 13671 13672 void ScalarEvolutionWrapperPass::print(raw_ostream &OS, const Module *) const { 13673 SE->print(OS); 13674 } 13675 13676 void ScalarEvolutionWrapperPass::verifyAnalysis() const { 13677 if (!VerifySCEV) 13678 return; 13679 13680 SE->verify(); 13681 } 13682 13683 void ScalarEvolutionWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const { 13684 AU.setPreservesAll(); 13685 AU.addRequiredTransitive<AssumptionCacheTracker>(); 13686 AU.addRequiredTransitive<LoopInfoWrapperPass>(); 13687 AU.addRequiredTransitive<DominatorTreeWrapperPass>(); 13688 AU.addRequiredTransitive<TargetLibraryInfoWrapperPass>(); 13689 } 13690 13691 const SCEVPredicate *ScalarEvolution::getEqualPredicate(const SCEV *LHS, 13692 const SCEV *RHS) { 13693 return getComparePredicate(ICmpInst::ICMP_EQ, LHS, RHS); 13694 } 13695 13696 const SCEVPredicate * 13697 ScalarEvolution::getComparePredicate(const ICmpInst::Predicate Pred, 13698 const SCEV *LHS, const SCEV *RHS) { 13699 FoldingSetNodeID ID; 13700 assert(LHS->getType() == RHS->getType() && 13701 "Type mismatch between LHS and RHS"); 13702 // Unique this node based on the arguments 13703 ID.AddInteger(SCEVPredicate::P_Compare); 13704 ID.AddInteger(Pred); 13705 ID.AddPointer(LHS); 13706 ID.AddPointer(RHS); 13707 void *IP = nullptr; 13708 if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP)) 13709 return S; 13710 SCEVComparePredicate *Eq = new (SCEVAllocator) 13711 SCEVComparePredicate(ID.Intern(SCEVAllocator), Pred, LHS, RHS); 13712 UniquePreds.InsertNode(Eq, IP); 13713 return Eq; 13714 } 13715 13716 const SCEVPredicate *ScalarEvolution::getWrapPredicate( 13717 const SCEVAddRecExpr *AR, 13718 SCEVWrapPredicate::IncrementWrapFlags AddedFlags) { 13719 FoldingSetNodeID ID; 13720 // Unique this node based on the arguments 13721 ID.AddInteger(SCEVPredicate::P_Wrap); 13722 ID.AddPointer(AR); 13723 ID.AddInteger(AddedFlags); 13724 void *IP = nullptr; 13725 if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP)) 13726 return S; 13727 auto *OF = new (SCEVAllocator) 13728 SCEVWrapPredicate(ID.Intern(SCEVAllocator), AR, AddedFlags); 13729 UniquePreds.InsertNode(OF, IP); 13730 return OF; 13731 } 13732 13733 namespace { 13734 13735 class SCEVPredicateRewriter : public SCEVRewriteVisitor<SCEVPredicateRewriter> { 13736 public: 13737 13738 /// Rewrites \p S in the context of a loop L and the SCEV predication 13739 /// infrastructure. 13740 /// 13741 /// If \p Pred is non-null, the SCEV expression is rewritten to respect the 13742 /// equivalences present in \p Pred. 13743 /// 13744 /// If \p NewPreds is non-null, rewrite is free to add further predicates to 13745 /// \p NewPreds such that the result will be an AddRecExpr. 13746 static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE, 13747 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds, 13748 const SCEVPredicate *Pred) { 13749 SCEVPredicateRewriter Rewriter(L, SE, NewPreds, Pred); 13750 return Rewriter.visit(S); 13751 } 13752 13753 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 13754 if (Pred) { 13755 if (auto *U = dyn_cast<SCEVUnionPredicate>(Pred)) { 13756 for (auto *Pred : U->getPredicates()) 13757 if (const auto *IPred = dyn_cast<SCEVComparePredicate>(Pred)) 13758 if (IPred->getLHS() == Expr && 13759 IPred->getPredicate() == ICmpInst::ICMP_EQ) 13760 return IPred->getRHS(); 13761 } else if (const auto *IPred = dyn_cast<SCEVComparePredicate>(Pred)) { 13762 if (IPred->getLHS() == Expr && 13763 IPred->getPredicate() == ICmpInst::ICMP_EQ) 13764 return IPred->getRHS(); 13765 } 13766 } 13767 return convertToAddRecWithPreds(Expr); 13768 } 13769 13770 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) { 13771 const SCEV *Operand = visit(Expr->getOperand()); 13772 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand); 13773 if (AR && AR->getLoop() == L && AR->isAffine()) { 13774 // This couldn't be folded because the operand didn't have the nuw 13775 // flag. Add the nusw flag as an assumption that we could make. 13776 const SCEV *Step = AR->getStepRecurrence(SE); 13777 Type *Ty = Expr->getType(); 13778 if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNUSW)) 13779 return SE.getAddRecExpr(SE.getZeroExtendExpr(AR->getStart(), Ty), 13780 SE.getSignExtendExpr(Step, Ty), L, 13781 AR->getNoWrapFlags()); 13782 } 13783 return SE.getZeroExtendExpr(Operand, Expr->getType()); 13784 } 13785 13786 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) { 13787 const SCEV *Operand = visit(Expr->getOperand()); 13788 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand); 13789 if (AR && AR->getLoop() == L && AR->isAffine()) { 13790 // This couldn't be folded because the operand didn't have the nsw 13791 // flag. Add the nssw flag as an assumption that we could make. 13792 const SCEV *Step = AR->getStepRecurrence(SE); 13793 Type *Ty = Expr->getType(); 13794 if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNSSW)) 13795 return SE.getAddRecExpr(SE.getSignExtendExpr(AR->getStart(), Ty), 13796 SE.getSignExtendExpr(Step, Ty), L, 13797 AR->getNoWrapFlags()); 13798 } 13799 return SE.getSignExtendExpr(Operand, Expr->getType()); 13800 } 13801 13802 private: 13803 explicit SCEVPredicateRewriter(const Loop *L, ScalarEvolution &SE, 13804 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds, 13805 const SCEVPredicate *Pred) 13806 : SCEVRewriteVisitor(SE), NewPreds(NewPreds), Pred(Pred), L(L) {} 13807 13808 bool addOverflowAssumption(const SCEVPredicate *P) { 13809 if (!NewPreds) { 13810 // Check if we've already made this assumption. 13811 return Pred && Pred->implies(P); 13812 } 13813 NewPreds->insert(P); 13814 return true; 13815 } 13816 13817 bool addOverflowAssumption(const SCEVAddRecExpr *AR, 13818 SCEVWrapPredicate::IncrementWrapFlags AddedFlags) { 13819 auto *A = SE.getWrapPredicate(AR, AddedFlags); 13820 return addOverflowAssumption(A); 13821 } 13822 13823 // If \p Expr represents a PHINode, we try to see if it can be represented 13824 // as an AddRec, possibly under a predicate (PHISCEVPred). If it is possible 13825 // to add this predicate as a runtime overflow check, we return the AddRec. 13826 // If \p Expr does not meet these conditions (is not a PHI node, or we 13827 // couldn't create an AddRec for it, or couldn't add the predicate), we just 13828 // return \p Expr. 13829 const SCEV *convertToAddRecWithPreds(const SCEVUnknown *Expr) { 13830 if (!isa<PHINode>(Expr->getValue())) 13831 return Expr; 13832 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>> 13833 PredicatedRewrite = SE.createAddRecFromPHIWithCasts(Expr); 13834 if (!PredicatedRewrite) 13835 return Expr; 13836 for (auto *P : PredicatedRewrite->second){ 13837 // Wrap predicates from outer loops are not supported. 13838 if (auto *WP = dyn_cast<const SCEVWrapPredicate>(P)) { 13839 if (L != WP->getExpr()->getLoop()) 13840 return Expr; 13841 } 13842 if (!addOverflowAssumption(P)) 13843 return Expr; 13844 } 13845 return PredicatedRewrite->first; 13846 } 13847 13848 SmallPtrSetImpl<const SCEVPredicate *> *NewPreds; 13849 const SCEVPredicate *Pred; 13850 const Loop *L; 13851 }; 13852 13853 } // end anonymous namespace 13854 13855 const SCEV * 13856 ScalarEvolution::rewriteUsingPredicate(const SCEV *S, const Loop *L, 13857 const SCEVPredicate &Preds) { 13858 return SCEVPredicateRewriter::rewrite(S, L, *this, nullptr, &Preds); 13859 } 13860 13861 const SCEVAddRecExpr *ScalarEvolution::convertSCEVToAddRecWithPredicates( 13862 const SCEV *S, const Loop *L, 13863 SmallPtrSetImpl<const SCEVPredicate *> &Preds) { 13864 SmallPtrSet<const SCEVPredicate *, 4> TransformPreds; 13865 S = SCEVPredicateRewriter::rewrite(S, L, *this, &TransformPreds, nullptr); 13866 auto *AddRec = dyn_cast<SCEVAddRecExpr>(S); 13867 13868 if (!AddRec) 13869 return nullptr; 13870 13871 // Since the transformation was successful, we can now transfer the SCEV 13872 // predicates. 13873 for (auto *P : TransformPreds) 13874 Preds.insert(P); 13875 13876 return AddRec; 13877 } 13878 13879 /// SCEV predicates 13880 SCEVPredicate::SCEVPredicate(const FoldingSetNodeIDRef ID, 13881 SCEVPredicateKind Kind) 13882 : FastID(ID), Kind(Kind) {} 13883 13884 SCEVComparePredicate::SCEVComparePredicate(const FoldingSetNodeIDRef ID, 13885 const ICmpInst::Predicate Pred, 13886 const SCEV *LHS, const SCEV *RHS) 13887 : SCEVPredicate(ID, P_Compare), Pred(Pred), LHS(LHS), RHS(RHS) { 13888 assert(LHS->getType() == RHS->getType() && "LHS and RHS types don't match"); 13889 assert(LHS != RHS && "LHS and RHS are the same SCEV"); 13890 } 13891 13892 bool SCEVComparePredicate::implies(const SCEVPredicate *N) const { 13893 const auto *Op = dyn_cast<SCEVComparePredicate>(N); 13894 13895 if (!Op) 13896 return false; 13897 13898 if (Pred != ICmpInst::ICMP_EQ) 13899 return false; 13900 13901 return Op->LHS == LHS && Op->RHS == RHS; 13902 } 13903 13904 bool SCEVComparePredicate::isAlwaysTrue() const { return false; } 13905 13906 void SCEVComparePredicate::print(raw_ostream &OS, unsigned Depth) const { 13907 if (Pred == ICmpInst::ICMP_EQ) 13908 OS.indent(Depth) << "Equal predicate: " << *LHS << " == " << *RHS << "\n"; 13909 else 13910 OS.indent(Depth) << "Compare predicate: " << *LHS 13911 << " " << CmpInst::getPredicateName(Pred) << ") " 13912 << *RHS << "\n"; 13913 13914 } 13915 13916 SCEVWrapPredicate::SCEVWrapPredicate(const FoldingSetNodeIDRef ID, 13917 const SCEVAddRecExpr *AR, 13918 IncrementWrapFlags Flags) 13919 : SCEVPredicate(ID, P_Wrap), AR(AR), Flags(Flags) {} 13920 13921 const SCEVAddRecExpr *SCEVWrapPredicate::getExpr() const { return AR; } 13922 13923 bool SCEVWrapPredicate::implies(const SCEVPredicate *N) const { 13924 const auto *Op = dyn_cast<SCEVWrapPredicate>(N); 13925 13926 return Op && Op->AR == AR && setFlags(Flags, Op->Flags) == Flags; 13927 } 13928 13929 bool SCEVWrapPredicate::isAlwaysTrue() const { 13930 SCEV::NoWrapFlags ScevFlags = AR->getNoWrapFlags(); 13931 IncrementWrapFlags IFlags = Flags; 13932 13933 if (ScalarEvolution::setFlags(ScevFlags, SCEV::FlagNSW) == ScevFlags) 13934 IFlags = clearFlags(IFlags, IncrementNSSW); 13935 13936 return IFlags == IncrementAnyWrap; 13937 } 13938 13939 void SCEVWrapPredicate::print(raw_ostream &OS, unsigned Depth) const { 13940 OS.indent(Depth) << *getExpr() << " Added Flags: "; 13941 if (SCEVWrapPredicate::IncrementNUSW & getFlags()) 13942 OS << "<nusw>"; 13943 if (SCEVWrapPredicate::IncrementNSSW & getFlags()) 13944 OS << "<nssw>"; 13945 OS << "\n"; 13946 } 13947 13948 SCEVWrapPredicate::IncrementWrapFlags 13949 SCEVWrapPredicate::getImpliedFlags(const SCEVAddRecExpr *AR, 13950 ScalarEvolution &SE) { 13951 IncrementWrapFlags ImpliedFlags = IncrementAnyWrap; 13952 SCEV::NoWrapFlags StaticFlags = AR->getNoWrapFlags(); 13953 13954 // We can safely transfer the NSW flag as NSSW. 13955 if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNSW) == StaticFlags) 13956 ImpliedFlags = IncrementNSSW; 13957 13958 if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNUW) == StaticFlags) { 13959 // If the increment is positive, the SCEV NUW flag will also imply the 13960 // WrapPredicate NUSW flag. 13961 if (const auto *Step = dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE))) 13962 if (Step->getValue()->getValue().isNonNegative()) 13963 ImpliedFlags = setFlags(ImpliedFlags, IncrementNUSW); 13964 } 13965 13966 return ImpliedFlags; 13967 } 13968 13969 /// Union predicates don't get cached so create a dummy set ID for it. 13970 SCEVUnionPredicate::SCEVUnionPredicate(ArrayRef<const SCEVPredicate *> Preds) 13971 : SCEVPredicate(FoldingSetNodeIDRef(nullptr, 0), P_Union) { 13972 for (auto *P : Preds) 13973 add(P); 13974 } 13975 13976 bool SCEVUnionPredicate::isAlwaysTrue() const { 13977 return all_of(Preds, 13978 [](const SCEVPredicate *I) { return I->isAlwaysTrue(); }); 13979 } 13980 13981 bool SCEVUnionPredicate::implies(const SCEVPredicate *N) const { 13982 if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N)) 13983 return all_of(Set->Preds, 13984 [this](const SCEVPredicate *I) { return this->implies(I); }); 13985 13986 return any_of(Preds, 13987 [N](const SCEVPredicate *I) { return I->implies(N); }); 13988 } 13989 13990 void SCEVUnionPredicate::print(raw_ostream &OS, unsigned Depth) const { 13991 for (auto Pred : Preds) 13992 Pred->print(OS, Depth); 13993 } 13994 13995 void SCEVUnionPredicate::add(const SCEVPredicate *N) { 13996 if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N)) { 13997 for (auto Pred : Set->Preds) 13998 add(Pred); 13999 return; 14000 } 14001 14002 Preds.push_back(N); 14003 } 14004 14005 PredicatedScalarEvolution::PredicatedScalarEvolution(ScalarEvolution &SE, 14006 Loop &L) 14007 : SE(SE), L(L) { 14008 SmallVector<const SCEVPredicate*, 4> Empty; 14009 Preds = std::make_unique<SCEVUnionPredicate>(Empty); 14010 } 14011 14012 void ScalarEvolution::registerUser(const SCEV *User, 14013 ArrayRef<const SCEV *> Ops) { 14014 for (auto *Op : Ops) 14015 // We do not expect that forgetting cached data for SCEVConstants will ever 14016 // open any prospects for sharpening or introduce any correctness issues, 14017 // so we don't bother storing their dependencies. 14018 if (!isa<SCEVConstant>(Op)) 14019 SCEVUsers[Op].insert(User); 14020 } 14021 14022 const SCEV *PredicatedScalarEvolution::getSCEV(Value *V) { 14023 const SCEV *Expr = SE.getSCEV(V); 14024 RewriteEntry &Entry = RewriteMap[Expr]; 14025 14026 // If we already have an entry and the version matches, return it. 14027 if (Entry.second && Generation == Entry.first) 14028 return Entry.second; 14029 14030 // We found an entry but it's stale. Rewrite the stale entry 14031 // according to the current predicate. 14032 if (Entry.second) 14033 Expr = Entry.second; 14034 14035 const SCEV *NewSCEV = SE.rewriteUsingPredicate(Expr, &L, *Preds); 14036 Entry = {Generation, NewSCEV}; 14037 14038 return NewSCEV; 14039 } 14040 14041 const SCEV *PredicatedScalarEvolution::getBackedgeTakenCount() { 14042 if (!BackedgeCount) { 14043 SmallVector<const SCEVPredicate *, 4> Preds; 14044 BackedgeCount = SE.getPredicatedBackedgeTakenCount(&L, Preds); 14045 for (auto *P : Preds) 14046 addPredicate(*P); 14047 } 14048 return BackedgeCount; 14049 } 14050 14051 void PredicatedScalarEvolution::addPredicate(const SCEVPredicate &Pred) { 14052 if (Preds->implies(&Pred)) 14053 return; 14054 14055 auto &OldPreds = Preds->getPredicates(); 14056 SmallVector<const SCEVPredicate*, 4> NewPreds(OldPreds.begin(), OldPreds.end()); 14057 NewPreds.push_back(&Pred); 14058 Preds = std::make_unique<SCEVUnionPredicate>(NewPreds); 14059 updateGeneration(); 14060 } 14061 14062 const SCEVPredicate &PredicatedScalarEvolution::getPredicate() const { 14063 return *Preds; 14064 } 14065 14066 void PredicatedScalarEvolution::updateGeneration() { 14067 // If the generation number wrapped recompute everything. 14068 if (++Generation == 0) { 14069 for (auto &II : RewriteMap) { 14070 const SCEV *Rewritten = II.second.second; 14071 II.second = {Generation, SE.rewriteUsingPredicate(Rewritten, &L, *Preds)}; 14072 } 14073 } 14074 } 14075 14076 void PredicatedScalarEvolution::setNoOverflow( 14077 Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) { 14078 const SCEV *Expr = getSCEV(V); 14079 const auto *AR = cast<SCEVAddRecExpr>(Expr); 14080 14081 auto ImpliedFlags = SCEVWrapPredicate::getImpliedFlags(AR, SE); 14082 14083 // Clear the statically implied flags. 14084 Flags = SCEVWrapPredicate::clearFlags(Flags, ImpliedFlags); 14085 addPredicate(*SE.getWrapPredicate(AR, Flags)); 14086 14087 auto II = FlagsMap.insert({V, Flags}); 14088 if (!II.second) 14089 II.first->second = SCEVWrapPredicate::setFlags(Flags, II.first->second); 14090 } 14091 14092 bool PredicatedScalarEvolution::hasNoOverflow( 14093 Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) { 14094 const SCEV *Expr = getSCEV(V); 14095 const auto *AR = cast<SCEVAddRecExpr>(Expr); 14096 14097 Flags = SCEVWrapPredicate::clearFlags( 14098 Flags, SCEVWrapPredicate::getImpliedFlags(AR, SE)); 14099 14100 auto II = FlagsMap.find(V); 14101 14102 if (II != FlagsMap.end()) 14103 Flags = SCEVWrapPredicate::clearFlags(Flags, II->second); 14104 14105 return Flags == SCEVWrapPredicate::IncrementAnyWrap; 14106 } 14107 14108 const SCEVAddRecExpr *PredicatedScalarEvolution::getAsAddRec(Value *V) { 14109 const SCEV *Expr = this->getSCEV(V); 14110 SmallPtrSet<const SCEVPredicate *, 4> NewPreds; 14111 auto *New = SE.convertSCEVToAddRecWithPredicates(Expr, &L, NewPreds); 14112 14113 if (!New) 14114 return nullptr; 14115 14116 for (auto *P : NewPreds) 14117 addPredicate(*P); 14118 14119 RewriteMap[SE.getSCEV(V)] = {Generation, New}; 14120 return New; 14121 } 14122 14123 PredicatedScalarEvolution::PredicatedScalarEvolution( 14124 const PredicatedScalarEvolution &Init) 14125 : RewriteMap(Init.RewriteMap), SE(Init.SE), L(Init.L), 14126 Preds(std::make_unique<SCEVUnionPredicate>(Init.Preds->getPredicates())), 14127 Generation(Init.Generation), BackedgeCount(Init.BackedgeCount) { 14128 for (auto I : Init.FlagsMap) 14129 FlagsMap.insert(I); 14130 } 14131 14132 void PredicatedScalarEvolution::print(raw_ostream &OS, unsigned Depth) const { 14133 // For each block. 14134 for (auto *BB : L.getBlocks()) 14135 for (auto &I : *BB) { 14136 if (!SE.isSCEVable(I.getType())) 14137 continue; 14138 14139 auto *Expr = SE.getSCEV(&I); 14140 auto II = RewriteMap.find(Expr); 14141 14142 if (II == RewriteMap.end()) 14143 continue; 14144 14145 // Don't print things that are not interesting. 14146 if (II->second.second == Expr) 14147 continue; 14148 14149 OS.indent(Depth) << "[PSE]" << I << ":\n"; 14150 OS.indent(Depth + 2) << *Expr << "\n"; 14151 OS.indent(Depth + 2) << "--> " << *II->second.second << "\n"; 14152 } 14153 } 14154 14155 // Match the mathematical pattern A - (A / B) * B, where A and B can be 14156 // arbitrary expressions. Also match zext (trunc A to iB) to iY, which is used 14157 // for URem with constant power-of-2 second operands. 14158 // It's not always easy, as A and B can be folded (imagine A is X / 2, and B is 14159 // 4, A / B becomes X / 8). 14160 bool ScalarEvolution::matchURem(const SCEV *Expr, const SCEV *&LHS, 14161 const SCEV *&RHS) { 14162 // Try to match 'zext (trunc A to iB) to iY', which is used 14163 // for URem with constant power-of-2 second operands. Make sure the size of 14164 // the operand A matches the size of the whole expressions. 14165 if (const auto *ZExt = dyn_cast<SCEVZeroExtendExpr>(Expr)) 14166 if (const auto *Trunc = dyn_cast<SCEVTruncateExpr>(ZExt->getOperand(0))) { 14167 LHS = Trunc->getOperand(); 14168 // Bail out if the type of the LHS is larger than the type of the 14169 // expression for now. 14170 if (getTypeSizeInBits(LHS->getType()) > 14171 getTypeSizeInBits(Expr->getType())) 14172 return false; 14173 if (LHS->getType() != Expr->getType()) 14174 LHS = getZeroExtendExpr(LHS, Expr->getType()); 14175 RHS = getConstant(APInt(getTypeSizeInBits(Expr->getType()), 1) 14176 << getTypeSizeInBits(Trunc->getType())); 14177 return true; 14178 } 14179 const auto *Add = dyn_cast<SCEVAddExpr>(Expr); 14180 if (Add == nullptr || Add->getNumOperands() != 2) 14181 return false; 14182 14183 const SCEV *A = Add->getOperand(1); 14184 const auto *Mul = dyn_cast<SCEVMulExpr>(Add->getOperand(0)); 14185 14186 if (Mul == nullptr) 14187 return false; 14188 14189 const auto MatchURemWithDivisor = [&](const SCEV *B) { 14190 // (SomeExpr + (-(SomeExpr / B) * B)). 14191 if (Expr == getURemExpr(A, B)) { 14192 LHS = A; 14193 RHS = B; 14194 return true; 14195 } 14196 return false; 14197 }; 14198 14199 // (SomeExpr + (-1 * (SomeExpr / B) * B)). 14200 if (Mul->getNumOperands() == 3 && isa<SCEVConstant>(Mul->getOperand(0))) 14201 return MatchURemWithDivisor(Mul->getOperand(1)) || 14202 MatchURemWithDivisor(Mul->getOperand(2)); 14203 14204 // (SomeExpr + ((-SomeExpr / B) * B)) or (SomeExpr + ((SomeExpr / B) * -B)). 14205 if (Mul->getNumOperands() == 2) 14206 return MatchURemWithDivisor(Mul->getOperand(1)) || 14207 MatchURemWithDivisor(Mul->getOperand(0)) || 14208 MatchURemWithDivisor(getNegativeSCEV(Mul->getOperand(1))) || 14209 MatchURemWithDivisor(getNegativeSCEV(Mul->getOperand(0))); 14210 return false; 14211 } 14212 14213 const SCEV * 14214 ScalarEvolution::computeSymbolicMaxBackedgeTakenCount(const Loop *L) { 14215 SmallVector<BasicBlock*, 16> ExitingBlocks; 14216 L->getExitingBlocks(ExitingBlocks); 14217 14218 // Form an expression for the maximum exit count possible for this loop. We 14219 // merge the max and exact information to approximate a version of 14220 // getConstantMaxBackedgeTakenCount which isn't restricted to just constants. 14221 SmallVector<const SCEV*, 4> ExitCounts; 14222 for (BasicBlock *ExitingBB : ExitingBlocks) { 14223 const SCEV *ExitCount = getExitCount(L, ExitingBB); 14224 if (isa<SCEVCouldNotCompute>(ExitCount)) 14225 ExitCount = getExitCount(L, ExitingBB, 14226 ScalarEvolution::ConstantMaximum); 14227 if (!isa<SCEVCouldNotCompute>(ExitCount)) { 14228 assert(DT.dominates(ExitingBB, L->getLoopLatch()) && 14229 "We should only have known counts for exiting blocks that " 14230 "dominate latch!"); 14231 ExitCounts.push_back(ExitCount); 14232 } 14233 } 14234 if (ExitCounts.empty()) 14235 return getCouldNotCompute(); 14236 return getUMinFromMismatchedTypes(ExitCounts); 14237 } 14238 14239 /// A rewriter to replace SCEV expressions in Map with the corresponding entry 14240 /// in the map. It skips AddRecExpr because we cannot guarantee that the 14241 /// replacement is loop invariant in the loop of the AddRec. 14242 /// 14243 /// At the moment only rewriting SCEVUnknown and SCEVZeroExtendExpr is 14244 /// supported. 14245 class SCEVLoopGuardRewriter : public SCEVRewriteVisitor<SCEVLoopGuardRewriter> { 14246 const DenseMap<const SCEV *, const SCEV *> ⤅ 14247 14248 public: 14249 SCEVLoopGuardRewriter(ScalarEvolution &SE, 14250 DenseMap<const SCEV *, const SCEV *> &M) 14251 : SCEVRewriteVisitor(SE), Map(M) {} 14252 14253 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) { return Expr; } 14254 14255 const SCEV *visitUnknown(const SCEVUnknown *Expr) { 14256 auto I = Map.find(Expr); 14257 if (I == Map.end()) 14258 return Expr; 14259 return I->second; 14260 } 14261 14262 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) { 14263 auto I = Map.find(Expr); 14264 if (I == Map.end()) 14265 return SCEVRewriteVisitor<SCEVLoopGuardRewriter>::visitZeroExtendExpr( 14266 Expr); 14267 return I->second; 14268 } 14269 }; 14270 14271 const SCEV *ScalarEvolution::applyLoopGuards(const SCEV *Expr, const Loop *L) { 14272 SmallVector<const SCEV *> ExprsToRewrite; 14273 auto CollectCondition = [&](ICmpInst::Predicate Predicate, const SCEV *LHS, 14274 const SCEV *RHS, 14275 DenseMap<const SCEV *, const SCEV *> 14276 &RewriteMap) { 14277 // WARNING: It is generally unsound to apply any wrap flags to the proposed 14278 // replacement SCEV which isn't directly implied by the structure of that 14279 // SCEV. In particular, using contextual facts to imply flags is *NOT* 14280 // legal. See the scoping rules for flags in the header to understand why. 14281 14282 // If LHS is a constant, apply information to the other expression. 14283 if (isa<SCEVConstant>(LHS)) { 14284 std::swap(LHS, RHS); 14285 Predicate = CmpInst::getSwappedPredicate(Predicate); 14286 } 14287 14288 // Check for a condition of the form (-C1 + X < C2). InstCombine will 14289 // create this form when combining two checks of the form (X u< C2 + C1) and 14290 // (X >=u C1). 14291 auto MatchRangeCheckIdiom = [this, Predicate, LHS, RHS, &RewriteMap, 14292 &ExprsToRewrite]() { 14293 auto *AddExpr = dyn_cast<SCEVAddExpr>(LHS); 14294 if (!AddExpr || AddExpr->getNumOperands() != 2) 14295 return false; 14296 14297 auto *C1 = dyn_cast<SCEVConstant>(AddExpr->getOperand(0)); 14298 auto *LHSUnknown = dyn_cast<SCEVUnknown>(AddExpr->getOperand(1)); 14299 auto *C2 = dyn_cast<SCEVConstant>(RHS); 14300 if (!C1 || !C2 || !LHSUnknown) 14301 return false; 14302 14303 auto ExactRegion = 14304 ConstantRange::makeExactICmpRegion(Predicate, C2->getAPInt()) 14305 .sub(C1->getAPInt()); 14306 14307 // Bail out, unless we have a non-wrapping, monotonic range. 14308 if (ExactRegion.isWrappedSet() || ExactRegion.isFullSet()) 14309 return false; 14310 auto I = RewriteMap.find(LHSUnknown); 14311 const SCEV *RewrittenLHS = I != RewriteMap.end() ? I->second : LHSUnknown; 14312 RewriteMap[LHSUnknown] = getUMaxExpr( 14313 getConstant(ExactRegion.getUnsignedMin()), 14314 getUMinExpr(RewrittenLHS, getConstant(ExactRegion.getUnsignedMax()))); 14315 ExprsToRewrite.push_back(LHSUnknown); 14316 return true; 14317 }; 14318 if (MatchRangeCheckIdiom()) 14319 return; 14320 14321 // If we have LHS == 0, check if LHS is computing a property of some unknown 14322 // SCEV %v which we can rewrite %v to express explicitly. 14323 const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS); 14324 if (Predicate == CmpInst::ICMP_EQ && RHSC && 14325 RHSC->getValue()->isNullValue()) { 14326 // If LHS is A % B, i.e. A % B == 0, rewrite A to (A /u B) * B to 14327 // explicitly express that. 14328 const SCEV *URemLHS = nullptr; 14329 const SCEV *URemRHS = nullptr; 14330 if (matchURem(LHS, URemLHS, URemRHS)) { 14331 if (const SCEVUnknown *LHSUnknown = dyn_cast<SCEVUnknown>(URemLHS)) { 14332 auto Multiple = getMulExpr(getUDivExpr(URemLHS, URemRHS), URemRHS); 14333 RewriteMap[LHSUnknown] = Multiple; 14334 ExprsToRewrite.push_back(LHSUnknown); 14335 return; 14336 } 14337 } 14338 } 14339 14340 // Do not apply information for constants or if RHS contains an AddRec. 14341 if (isa<SCEVConstant>(LHS) || containsAddRecurrence(RHS)) 14342 return; 14343 14344 // If RHS is SCEVUnknown, make sure the information is applied to it. 14345 if (!isa<SCEVUnknown>(LHS) && isa<SCEVUnknown>(RHS)) { 14346 std::swap(LHS, RHS); 14347 Predicate = CmpInst::getSwappedPredicate(Predicate); 14348 } 14349 14350 // Limit to expressions that can be rewritten. 14351 if (!isa<SCEVUnknown>(LHS) && !isa<SCEVZeroExtendExpr>(LHS)) 14352 return; 14353 14354 // Check whether LHS has already been rewritten. In that case we want to 14355 // chain further rewrites onto the already rewritten value. 14356 auto I = RewriteMap.find(LHS); 14357 const SCEV *RewrittenLHS = I != RewriteMap.end() ? I->second : LHS; 14358 14359 const SCEV *RewrittenRHS = nullptr; 14360 switch (Predicate) { 14361 case CmpInst::ICMP_ULT: 14362 RewrittenRHS = 14363 getUMinExpr(RewrittenLHS, getMinusSCEV(RHS, getOne(RHS->getType()))); 14364 break; 14365 case CmpInst::ICMP_SLT: 14366 RewrittenRHS = 14367 getSMinExpr(RewrittenLHS, getMinusSCEV(RHS, getOne(RHS->getType()))); 14368 break; 14369 case CmpInst::ICMP_ULE: 14370 RewrittenRHS = getUMinExpr(RewrittenLHS, RHS); 14371 break; 14372 case CmpInst::ICMP_SLE: 14373 RewrittenRHS = getSMinExpr(RewrittenLHS, RHS); 14374 break; 14375 case CmpInst::ICMP_UGT: 14376 RewrittenRHS = 14377 getUMaxExpr(RewrittenLHS, getAddExpr(RHS, getOne(RHS->getType()))); 14378 break; 14379 case CmpInst::ICMP_SGT: 14380 RewrittenRHS = 14381 getSMaxExpr(RewrittenLHS, getAddExpr(RHS, getOne(RHS->getType()))); 14382 break; 14383 case CmpInst::ICMP_UGE: 14384 RewrittenRHS = getUMaxExpr(RewrittenLHS, RHS); 14385 break; 14386 case CmpInst::ICMP_SGE: 14387 RewrittenRHS = getSMaxExpr(RewrittenLHS, RHS); 14388 break; 14389 case CmpInst::ICMP_EQ: 14390 if (isa<SCEVConstant>(RHS)) 14391 RewrittenRHS = RHS; 14392 break; 14393 case CmpInst::ICMP_NE: 14394 if (isa<SCEVConstant>(RHS) && 14395 cast<SCEVConstant>(RHS)->getValue()->isNullValue()) 14396 RewrittenRHS = getUMaxExpr(RewrittenLHS, getOne(RHS->getType())); 14397 break; 14398 default: 14399 break; 14400 } 14401 14402 if (RewrittenRHS) { 14403 RewriteMap[LHS] = RewrittenRHS; 14404 if (LHS == RewrittenLHS) 14405 ExprsToRewrite.push_back(LHS); 14406 } 14407 }; 14408 // First, collect conditions from dominating branches. Starting at the loop 14409 // predecessor, climb up the predecessor chain, as long as there are 14410 // predecessors that can be found that have unique successors leading to the 14411 // original header. 14412 // TODO: share this logic with isLoopEntryGuardedByCond. 14413 SmallVector<std::pair<Value *, bool>> Terms; 14414 for (std::pair<const BasicBlock *, const BasicBlock *> Pair( 14415 L->getLoopPredecessor(), L->getHeader()); 14416 Pair.first; Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) { 14417 14418 const BranchInst *LoopEntryPredicate = 14419 dyn_cast<BranchInst>(Pair.first->getTerminator()); 14420 if (!LoopEntryPredicate || LoopEntryPredicate->isUnconditional()) 14421 continue; 14422 14423 Terms.emplace_back(LoopEntryPredicate->getCondition(), 14424 LoopEntryPredicate->getSuccessor(0) == Pair.second); 14425 } 14426 14427 // Now apply the information from the collected conditions to RewriteMap. 14428 // Conditions are processed in reverse order, so the earliest conditions is 14429 // processed first. This ensures the SCEVs with the shortest dependency chains 14430 // are constructed first. 14431 DenseMap<const SCEV *, const SCEV *> RewriteMap; 14432 for (auto &E : reverse(Terms)) { 14433 bool EnterIfTrue = E.second; 14434 SmallVector<Value *, 8> Worklist; 14435 SmallPtrSet<Value *, 8> Visited; 14436 Worklist.push_back(E.first); 14437 while (!Worklist.empty()) { 14438 Value *Cond = Worklist.pop_back_val(); 14439 if (!Visited.insert(Cond).second) 14440 continue; 14441 14442 if (auto *Cmp = dyn_cast<ICmpInst>(Cond)) { 14443 auto Predicate = 14444 EnterIfTrue ? Cmp->getPredicate() : Cmp->getInversePredicate(); 14445 CollectCondition(Predicate, getSCEV(Cmp->getOperand(0)), 14446 getSCEV(Cmp->getOperand(1)), RewriteMap); 14447 continue; 14448 } 14449 14450 Value *L, *R; 14451 if (EnterIfTrue ? match(Cond, m_LogicalAnd(m_Value(L), m_Value(R))) 14452 : match(Cond, m_LogicalOr(m_Value(L), m_Value(R)))) { 14453 Worklist.push_back(L); 14454 Worklist.push_back(R); 14455 } 14456 } 14457 } 14458 14459 // Also collect information from assumptions dominating the loop. 14460 for (auto &AssumeVH : AC.assumptions()) { 14461 if (!AssumeVH) 14462 continue; 14463 auto *AssumeI = cast<CallInst>(AssumeVH); 14464 auto *Cmp = dyn_cast<ICmpInst>(AssumeI->getOperand(0)); 14465 if (!Cmp || !DT.dominates(AssumeI, L->getHeader())) 14466 continue; 14467 CollectCondition(Cmp->getPredicate(), getSCEV(Cmp->getOperand(0)), 14468 getSCEV(Cmp->getOperand(1)), RewriteMap); 14469 } 14470 14471 if (RewriteMap.empty()) 14472 return Expr; 14473 14474 // Now that all rewrite information is collect, rewrite the collected 14475 // expressions with the information in the map. This applies information to 14476 // sub-expressions. 14477 if (ExprsToRewrite.size() > 1) { 14478 for (const SCEV *Expr : ExprsToRewrite) { 14479 const SCEV *RewriteTo = RewriteMap[Expr]; 14480 RewriteMap.erase(Expr); 14481 SCEVLoopGuardRewriter Rewriter(*this, RewriteMap); 14482 RewriteMap.insert({Expr, Rewriter.visit(RewriteTo)}); 14483 } 14484 } 14485 14486 SCEVLoopGuardRewriter Rewriter(*this, RewriteMap); 14487 return Rewriter.visit(Expr); 14488 } 14489