1 //===-- ConstraintElimination.cpp - Eliminate conds using constraints. ----===// 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 // Eliminate conditions based on constraints collected from dominating 10 // conditions. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "llvm/Transforms/Scalar/ConstraintElimination.h" 15 #include "llvm/ADT/STLExtras.h" 16 #include "llvm/ADT/ScopeExit.h" 17 #include "llvm/ADT/SmallVector.h" 18 #include "llvm/ADT/Statistic.h" 19 #include "llvm/Analysis/ConstraintSystem.h" 20 #include "llvm/Analysis/GlobalsModRef.h" 21 #include "llvm/Analysis/LoopInfo.h" 22 #include "llvm/Analysis/OptimizationRemarkEmitter.h" 23 #include "llvm/Analysis/ScalarEvolution.h" 24 #include "llvm/Analysis/ScalarEvolutionExpressions.h" 25 #include "llvm/Analysis/ValueTracking.h" 26 #include "llvm/IR/DataLayout.h" 27 #include "llvm/IR/Dominators.h" 28 #include "llvm/IR/Function.h" 29 #include "llvm/IR/IRBuilder.h" 30 #include "llvm/IR/InstrTypes.h" 31 #include "llvm/IR/Instructions.h" 32 #include "llvm/IR/PatternMatch.h" 33 #include "llvm/IR/Verifier.h" 34 #include "llvm/Pass.h" 35 #include "llvm/Support/CommandLine.h" 36 #include "llvm/Support/Debug.h" 37 #include "llvm/Support/DebugCounter.h" 38 #include "llvm/Support/MathExtras.h" 39 #include "llvm/Transforms/Utils/Cloning.h" 40 #include "llvm/Transforms/Utils/ValueMapper.h" 41 42 #include <cmath> 43 #include <optional> 44 #include <string> 45 46 using namespace llvm; 47 using namespace PatternMatch; 48 49 #define DEBUG_TYPE "constraint-elimination" 50 51 STATISTIC(NumCondsRemoved, "Number of instructions removed"); 52 DEBUG_COUNTER(EliminatedCounter, "conds-eliminated", 53 "Controls which conditions are eliminated"); 54 55 static cl::opt<unsigned> 56 MaxRows("constraint-elimination-max-rows", cl::init(500), cl::Hidden, 57 cl::desc("Maximum number of rows to keep in constraint system")); 58 59 static cl::opt<bool> DumpReproducers( 60 "constraint-elimination-dump-reproducers", cl::init(false), cl::Hidden, 61 cl::desc("Dump IR to reproduce successful transformations.")); 62 63 static int64_t MaxConstraintValue = std::numeric_limits<int64_t>::max(); 64 static int64_t MinSignedConstraintValue = std::numeric_limits<int64_t>::min(); 65 66 // A helper to multiply 2 signed integers where overflowing is allowed. 67 static int64_t multiplyWithOverflow(int64_t A, int64_t B) { 68 int64_t Result; 69 MulOverflow(A, B, Result); 70 return Result; 71 } 72 73 // A helper to add 2 signed integers where overflowing is allowed. 74 static int64_t addWithOverflow(int64_t A, int64_t B) { 75 int64_t Result; 76 AddOverflow(A, B, Result); 77 return Result; 78 } 79 80 static Instruction *getContextInstForUse(Use &U) { 81 Instruction *UserI = cast<Instruction>(U.getUser()); 82 if (auto *Phi = dyn_cast<PHINode>(UserI)) 83 UserI = Phi->getIncomingBlock(U)->getTerminator(); 84 return UserI; 85 } 86 87 namespace { 88 /// Struct to express a condition of the form %Op0 Pred %Op1. 89 struct ConditionTy { 90 CmpInst::Predicate Pred; 91 Value *Op0; 92 Value *Op1; 93 94 ConditionTy() 95 : Pred(CmpInst::BAD_ICMP_PREDICATE), Op0(nullptr), Op1(nullptr) {} 96 ConditionTy(CmpInst::Predicate Pred, Value *Op0, Value *Op1) 97 : Pred(Pred), Op0(Op0), Op1(Op1) {} 98 }; 99 100 /// Represents either 101 /// * a condition that holds on entry to a block (=condition fact) 102 /// * an assume (=assume fact) 103 /// * a use of a compare instruction to simplify. 104 /// It also tracks the Dominator DFS in and out numbers for each entry. 105 struct FactOrCheck { 106 enum class EntryTy { 107 ConditionFact, /// A condition that holds on entry to a block. 108 InstFact, /// A fact that holds after Inst executed (e.g. an assume or 109 /// min/mix intrinsic. 110 InstCheck, /// An instruction to simplify (e.g. an overflow math 111 /// intrinsics). 112 UseCheck /// An use of a compare instruction to simplify. 113 }; 114 115 union { 116 Instruction *Inst; 117 Use *U; 118 ConditionTy Cond; 119 }; 120 121 /// A pre-condition that must hold for the current fact to be added to the 122 /// system. 123 ConditionTy DoesHold; 124 125 unsigned NumIn; 126 unsigned NumOut; 127 EntryTy Ty; 128 129 FactOrCheck(EntryTy Ty, DomTreeNode *DTN, Instruction *Inst) 130 : Inst(Inst), NumIn(DTN->getDFSNumIn()), NumOut(DTN->getDFSNumOut()), 131 Ty(Ty) {} 132 133 FactOrCheck(DomTreeNode *DTN, Use *U) 134 : U(U), DoesHold(CmpInst::BAD_ICMP_PREDICATE, nullptr, nullptr), 135 NumIn(DTN->getDFSNumIn()), NumOut(DTN->getDFSNumOut()), 136 Ty(EntryTy::UseCheck) {} 137 138 FactOrCheck(DomTreeNode *DTN, CmpInst::Predicate Pred, Value *Op0, Value *Op1, 139 ConditionTy Precond = ConditionTy()) 140 : Cond(Pred, Op0, Op1), DoesHold(Precond), NumIn(DTN->getDFSNumIn()), 141 NumOut(DTN->getDFSNumOut()), Ty(EntryTy::ConditionFact) {} 142 143 static FactOrCheck getConditionFact(DomTreeNode *DTN, CmpInst::Predicate Pred, 144 Value *Op0, Value *Op1, 145 ConditionTy Precond = ConditionTy()) { 146 return FactOrCheck(DTN, Pred, Op0, Op1, Precond); 147 } 148 149 static FactOrCheck getInstFact(DomTreeNode *DTN, Instruction *Inst) { 150 return FactOrCheck(EntryTy::InstFact, DTN, Inst); 151 } 152 153 static FactOrCheck getCheck(DomTreeNode *DTN, Use *U) { 154 return FactOrCheck(DTN, U); 155 } 156 157 static FactOrCheck getCheck(DomTreeNode *DTN, CallInst *CI) { 158 return FactOrCheck(EntryTy::InstCheck, DTN, CI); 159 } 160 161 bool isCheck() const { 162 return Ty == EntryTy::InstCheck || Ty == EntryTy::UseCheck; 163 } 164 165 Instruction *getContextInst() const { 166 if (Ty == EntryTy::UseCheck) 167 return getContextInstForUse(*U); 168 return Inst; 169 } 170 171 Instruction *getInstructionToSimplify() const { 172 assert(isCheck()); 173 if (Ty == EntryTy::InstCheck) 174 return Inst; 175 // The use may have been simplified to a constant already. 176 return dyn_cast<Instruction>(*U); 177 } 178 179 bool isConditionFact() const { return Ty == EntryTy::ConditionFact; } 180 }; 181 182 /// Keep state required to build worklist. 183 struct State { 184 DominatorTree &DT; 185 LoopInfo &LI; 186 ScalarEvolution &SE; 187 SmallVector<FactOrCheck, 64> WorkList; 188 189 State(DominatorTree &DT, LoopInfo &LI, ScalarEvolution &SE) 190 : DT(DT), LI(LI), SE(SE) {} 191 192 /// Process block \p BB and add known facts to work-list. 193 void addInfoFor(BasicBlock &BB); 194 195 /// Try to add facts for loop inductions (AddRecs) in EQ/NE compares 196 /// controlling the loop header. 197 void addInfoForInductions(BasicBlock &BB); 198 199 /// Returns true if we can add a known condition from BB to its successor 200 /// block Succ. 201 bool canAddSuccessor(BasicBlock &BB, BasicBlock *Succ) const { 202 return DT.dominates(BasicBlockEdge(&BB, Succ), Succ); 203 } 204 }; 205 206 class ConstraintInfo; 207 208 struct StackEntry { 209 unsigned NumIn; 210 unsigned NumOut; 211 bool IsSigned = false; 212 /// Variables that can be removed from the system once the stack entry gets 213 /// removed. 214 SmallVector<Value *, 2> ValuesToRelease; 215 216 StackEntry(unsigned NumIn, unsigned NumOut, bool IsSigned, 217 SmallVector<Value *, 2> ValuesToRelease) 218 : NumIn(NumIn), NumOut(NumOut), IsSigned(IsSigned), 219 ValuesToRelease(ValuesToRelease) {} 220 }; 221 222 struct ConstraintTy { 223 SmallVector<int64_t, 8> Coefficients; 224 SmallVector<ConditionTy, 2> Preconditions; 225 226 SmallVector<SmallVector<int64_t, 8>> ExtraInfo; 227 228 bool IsSigned = false; 229 230 ConstraintTy() = default; 231 232 ConstraintTy(SmallVector<int64_t, 8> Coefficients, bool IsSigned, bool IsEq, 233 bool IsNe) 234 : Coefficients(Coefficients), IsSigned(IsSigned), IsEq(IsEq), IsNe(IsNe) { 235 } 236 237 unsigned size() const { return Coefficients.size(); } 238 239 unsigned empty() const { return Coefficients.empty(); } 240 241 /// Returns true if all preconditions for this list of constraints are 242 /// satisfied given \p CS and the corresponding \p Value2Index mapping. 243 bool isValid(const ConstraintInfo &Info) const; 244 245 bool isEq() const { return IsEq; } 246 247 bool isNe() const { return IsNe; } 248 249 /// Check if the current constraint is implied by the given ConstraintSystem. 250 /// 251 /// \return true or false if the constraint is proven to be respectively true, 252 /// or false. When the constraint cannot be proven to be either true or false, 253 /// std::nullopt is returned. 254 std::optional<bool> isImpliedBy(const ConstraintSystem &CS) const; 255 256 private: 257 bool IsEq = false; 258 bool IsNe = false; 259 }; 260 261 /// Wrapper encapsulating separate constraint systems and corresponding value 262 /// mappings for both unsigned and signed information. Facts are added to and 263 /// conditions are checked against the corresponding system depending on the 264 /// signed-ness of their predicates. While the information is kept separate 265 /// based on signed-ness, certain conditions can be transferred between the two 266 /// systems. 267 class ConstraintInfo { 268 269 ConstraintSystem UnsignedCS; 270 ConstraintSystem SignedCS; 271 272 const DataLayout &DL; 273 274 public: 275 ConstraintInfo(const DataLayout &DL, ArrayRef<Value *> FunctionArgs) 276 : UnsignedCS(FunctionArgs), SignedCS(FunctionArgs), DL(DL) { 277 auto &Value2Index = getValue2Index(false); 278 // Add Arg > -1 constraints to unsigned system for all function arguments. 279 for (Value *Arg : FunctionArgs) { 280 ConstraintTy VarPos(SmallVector<int64_t, 8>(Value2Index.size() + 1, 0), 281 false, false, false); 282 VarPos.Coefficients[Value2Index[Arg]] = -1; 283 UnsignedCS.addVariableRow(VarPos.Coefficients); 284 } 285 } 286 287 DenseMap<Value *, unsigned> &getValue2Index(bool Signed) { 288 return Signed ? SignedCS.getValue2Index() : UnsignedCS.getValue2Index(); 289 } 290 const DenseMap<Value *, unsigned> &getValue2Index(bool Signed) const { 291 return Signed ? SignedCS.getValue2Index() : UnsignedCS.getValue2Index(); 292 } 293 294 ConstraintSystem &getCS(bool Signed) { 295 return Signed ? SignedCS : UnsignedCS; 296 } 297 const ConstraintSystem &getCS(bool Signed) const { 298 return Signed ? SignedCS : UnsignedCS; 299 } 300 301 void popLastConstraint(bool Signed) { getCS(Signed).popLastConstraint(); } 302 void popLastNVariables(bool Signed, unsigned N) { 303 getCS(Signed).popLastNVariables(N); 304 } 305 306 bool doesHold(CmpInst::Predicate Pred, Value *A, Value *B) const; 307 308 void addFact(CmpInst::Predicate Pred, Value *A, Value *B, unsigned NumIn, 309 unsigned NumOut, SmallVectorImpl<StackEntry> &DFSInStack); 310 311 /// Turn a comparison of the form \p Op0 \p Pred \p Op1 into a vector of 312 /// constraints, using indices from the corresponding constraint system. 313 /// New variables that need to be added to the system are collected in 314 /// \p NewVariables. 315 ConstraintTy getConstraint(CmpInst::Predicate Pred, Value *Op0, Value *Op1, 316 SmallVectorImpl<Value *> &NewVariables) const; 317 318 /// Turns a comparison of the form \p Op0 \p Pred \p Op1 into a vector of 319 /// constraints using getConstraint. Returns an empty constraint if the result 320 /// cannot be used to query the existing constraint system, e.g. because it 321 /// would require adding new variables. Also tries to convert signed 322 /// predicates to unsigned ones if possible to allow using the unsigned system 323 /// which increases the effectiveness of the signed <-> unsigned transfer 324 /// logic. 325 ConstraintTy getConstraintForSolving(CmpInst::Predicate Pred, Value *Op0, 326 Value *Op1) const; 327 328 /// Try to add information from \p A \p Pred \p B to the unsigned/signed 329 /// system if \p Pred is signed/unsigned. 330 void transferToOtherSystem(CmpInst::Predicate Pred, Value *A, Value *B, 331 unsigned NumIn, unsigned NumOut, 332 SmallVectorImpl<StackEntry> &DFSInStack); 333 }; 334 335 /// Represents a (Coefficient * Variable) entry after IR decomposition. 336 struct DecompEntry { 337 int64_t Coefficient; 338 Value *Variable; 339 /// True if the variable is known positive in the current constraint. 340 bool IsKnownNonNegative; 341 342 DecompEntry(int64_t Coefficient, Value *Variable, 343 bool IsKnownNonNegative = false) 344 : Coefficient(Coefficient), Variable(Variable), 345 IsKnownNonNegative(IsKnownNonNegative) {} 346 }; 347 348 /// Represents an Offset + Coefficient1 * Variable1 + ... decomposition. 349 struct Decomposition { 350 int64_t Offset = 0; 351 SmallVector<DecompEntry, 3> Vars; 352 353 Decomposition(int64_t Offset) : Offset(Offset) {} 354 Decomposition(Value *V, bool IsKnownNonNegative = false) { 355 Vars.emplace_back(1, V, IsKnownNonNegative); 356 } 357 Decomposition(int64_t Offset, ArrayRef<DecompEntry> Vars) 358 : Offset(Offset), Vars(Vars) {} 359 360 void add(int64_t OtherOffset) { 361 Offset = addWithOverflow(Offset, OtherOffset); 362 } 363 364 void add(const Decomposition &Other) { 365 add(Other.Offset); 366 append_range(Vars, Other.Vars); 367 } 368 369 void sub(const Decomposition &Other) { 370 Decomposition Tmp = Other; 371 Tmp.mul(-1); 372 add(Tmp.Offset); 373 append_range(Vars, Tmp.Vars); 374 } 375 376 void mul(int64_t Factor) { 377 Offset = multiplyWithOverflow(Offset, Factor); 378 for (auto &Var : Vars) 379 Var.Coefficient = multiplyWithOverflow(Var.Coefficient, Factor); 380 } 381 }; 382 383 // Variable and constant offsets for a chain of GEPs, with base pointer BasePtr. 384 struct OffsetResult { 385 Value *BasePtr; 386 APInt ConstantOffset; 387 MapVector<Value *, APInt> VariableOffsets; 388 bool AllInbounds; 389 390 OffsetResult() : BasePtr(nullptr), ConstantOffset(0, uint64_t(0)) {} 391 392 OffsetResult(GEPOperator &GEP, const DataLayout &DL) 393 : BasePtr(GEP.getPointerOperand()), AllInbounds(GEP.isInBounds()) { 394 ConstantOffset = APInt(DL.getIndexTypeSizeInBits(BasePtr->getType()), 0); 395 } 396 }; 397 } // namespace 398 399 // Try to collect variable and constant offsets for \p GEP, partly traversing 400 // nested GEPs. Returns an OffsetResult with nullptr as BasePtr of collecting 401 // the offset fails. 402 static OffsetResult collectOffsets(GEPOperator &GEP, const DataLayout &DL) { 403 OffsetResult Result(GEP, DL); 404 unsigned BitWidth = Result.ConstantOffset.getBitWidth(); 405 if (!GEP.collectOffset(DL, BitWidth, Result.VariableOffsets, 406 Result.ConstantOffset)) 407 return {}; 408 409 // If we have a nested GEP, check if we can combine the constant offset of the 410 // inner GEP with the outer GEP. 411 if (auto *InnerGEP = dyn_cast<GetElementPtrInst>(Result.BasePtr)) { 412 MapVector<Value *, APInt> VariableOffsets2; 413 APInt ConstantOffset2(BitWidth, 0); 414 bool CanCollectInner = InnerGEP->collectOffset( 415 DL, BitWidth, VariableOffsets2, ConstantOffset2); 416 // TODO: Support cases with more than 1 variable offset. 417 if (!CanCollectInner || Result.VariableOffsets.size() > 1 || 418 VariableOffsets2.size() > 1 || 419 (Result.VariableOffsets.size() >= 1 && VariableOffsets2.size() >= 1)) { 420 // More than 1 variable index, use outer result. 421 return Result; 422 } 423 Result.BasePtr = InnerGEP->getPointerOperand(); 424 Result.ConstantOffset += ConstantOffset2; 425 if (Result.VariableOffsets.size() == 0 && VariableOffsets2.size() == 1) 426 Result.VariableOffsets = VariableOffsets2; 427 Result.AllInbounds &= InnerGEP->isInBounds(); 428 } 429 return Result; 430 } 431 432 static Decomposition decompose(Value *V, 433 SmallVectorImpl<ConditionTy> &Preconditions, 434 bool IsSigned, const DataLayout &DL); 435 436 static bool canUseSExt(ConstantInt *CI) { 437 const APInt &Val = CI->getValue(); 438 return Val.sgt(MinSignedConstraintValue) && Val.slt(MaxConstraintValue); 439 } 440 441 static Decomposition decomposeGEP(GEPOperator &GEP, 442 SmallVectorImpl<ConditionTy> &Preconditions, 443 bool IsSigned, const DataLayout &DL) { 444 // Do not reason about pointers where the index size is larger than 64 bits, 445 // as the coefficients used to encode constraints are 64 bit integers. 446 if (DL.getIndexTypeSizeInBits(GEP.getPointerOperand()->getType()) > 64) 447 return &GEP; 448 449 assert(!IsSigned && "The logic below only supports decomposition for " 450 "unsigned predicates at the moment."); 451 const auto &[BasePtr, ConstantOffset, VariableOffsets, AllInbounds] = 452 collectOffsets(GEP, DL); 453 if (!BasePtr || !AllInbounds) 454 return &GEP; 455 456 Decomposition Result(ConstantOffset.getSExtValue(), DecompEntry(1, BasePtr)); 457 for (auto [Index, Scale] : VariableOffsets) { 458 auto IdxResult = decompose(Index, Preconditions, IsSigned, DL); 459 IdxResult.mul(Scale.getSExtValue()); 460 Result.add(IdxResult); 461 462 // If Op0 is signed non-negative, the GEP is increasing monotonically and 463 // can be de-composed. 464 if (!isKnownNonNegative(Index, DL, /*Depth=*/MaxAnalysisRecursionDepth - 1)) 465 Preconditions.emplace_back(CmpInst::ICMP_SGE, Index, 466 ConstantInt::get(Index->getType(), 0)); 467 } 468 return Result; 469 } 470 471 // Decomposes \p V into a constant offset + list of pairs { Coefficient, 472 // Variable } where Coefficient * Variable. The sum of the constant offset and 473 // pairs equals \p V. 474 static Decomposition decompose(Value *V, 475 SmallVectorImpl<ConditionTy> &Preconditions, 476 bool IsSigned, const DataLayout &DL) { 477 478 auto MergeResults = [&Preconditions, IsSigned, &DL](Value *A, Value *B, 479 bool IsSignedB) { 480 auto ResA = decompose(A, Preconditions, IsSigned, DL); 481 auto ResB = decompose(B, Preconditions, IsSignedB, DL); 482 ResA.add(ResB); 483 return ResA; 484 }; 485 486 Type *Ty = V->getType()->getScalarType(); 487 if (Ty->isPointerTy() && !IsSigned) { 488 if (auto *GEP = dyn_cast<GEPOperator>(V)) 489 return decomposeGEP(*GEP, Preconditions, IsSigned, DL); 490 if (isa<ConstantPointerNull>(V)) 491 return int64_t(0); 492 493 return V; 494 } 495 496 // Don't handle integers > 64 bit. Our coefficients are 64-bit large, so 497 // coefficient add/mul may wrap, while the operation in the full bit width 498 // would not. 499 if (!Ty->isIntegerTy() || Ty->getIntegerBitWidth() > 64) 500 return V; 501 502 // Decompose \p V used with a signed predicate. 503 if (IsSigned) { 504 if (auto *CI = dyn_cast<ConstantInt>(V)) { 505 if (canUseSExt(CI)) 506 return CI->getSExtValue(); 507 } 508 Value *Op0; 509 Value *Op1; 510 if (match(V, m_NSWAdd(m_Value(Op0), m_Value(Op1)))) 511 return MergeResults(Op0, Op1, IsSigned); 512 513 ConstantInt *CI; 514 if (match(V, m_NSWMul(m_Value(Op0), m_ConstantInt(CI))) && canUseSExt(CI)) { 515 auto Result = decompose(Op0, Preconditions, IsSigned, DL); 516 Result.mul(CI->getSExtValue()); 517 return Result; 518 } 519 520 // (shl nsw x, shift) is (mul nsw x, (1<<shift)), with the exception of 521 // shift == bw-1. 522 if (match(V, m_NSWShl(m_Value(Op0), m_ConstantInt(CI)))) { 523 uint64_t Shift = CI->getValue().getLimitedValue(); 524 if (Shift < Ty->getIntegerBitWidth() - 1) { 525 assert(Shift < 64 && "Would overflow"); 526 auto Result = decompose(Op0, Preconditions, IsSigned, DL); 527 Result.mul(int64_t(1) << Shift); 528 return Result; 529 } 530 } 531 532 return V; 533 } 534 535 if (auto *CI = dyn_cast<ConstantInt>(V)) { 536 if (CI->uge(MaxConstraintValue)) 537 return V; 538 return int64_t(CI->getZExtValue()); 539 } 540 541 Value *Op0; 542 bool IsKnownNonNegative = false; 543 if (match(V, m_ZExt(m_Value(Op0)))) { 544 IsKnownNonNegative = true; 545 V = Op0; 546 } 547 548 Value *Op1; 549 ConstantInt *CI; 550 if (match(V, m_NUWAdd(m_Value(Op0), m_Value(Op1)))) { 551 return MergeResults(Op0, Op1, IsSigned); 552 } 553 if (match(V, m_NSWAdd(m_Value(Op0), m_Value(Op1)))) { 554 if (!isKnownNonNegative(Op0, DL, /*Depth=*/MaxAnalysisRecursionDepth - 1)) 555 Preconditions.emplace_back(CmpInst::ICMP_SGE, Op0, 556 ConstantInt::get(Op0->getType(), 0)); 557 if (!isKnownNonNegative(Op1, DL, /*Depth=*/MaxAnalysisRecursionDepth - 1)) 558 Preconditions.emplace_back(CmpInst::ICMP_SGE, Op1, 559 ConstantInt::get(Op1->getType(), 0)); 560 561 return MergeResults(Op0, Op1, IsSigned); 562 } 563 564 if (match(V, m_Add(m_Value(Op0), m_ConstantInt(CI))) && CI->isNegative() && 565 canUseSExt(CI)) { 566 Preconditions.emplace_back( 567 CmpInst::ICMP_UGE, Op0, 568 ConstantInt::get(Op0->getType(), CI->getSExtValue() * -1)); 569 return MergeResults(Op0, CI, true); 570 } 571 572 // Decompose or as an add if there are no common bits between the operands. 573 if (match(V, m_DisjointOr(m_Value(Op0), m_ConstantInt(CI)))) 574 return MergeResults(Op0, CI, IsSigned); 575 576 if (match(V, m_NUWShl(m_Value(Op1), m_ConstantInt(CI))) && canUseSExt(CI)) { 577 if (CI->getSExtValue() < 0 || CI->getSExtValue() >= 64) 578 return {V, IsKnownNonNegative}; 579 auto Result = decompose(Op1, Preconditions, IsSigned, DL); 580 Result.mul(int64_t{1} << CI->getSExtValue()); 581 return Result; 582 } 583 584 if (match(V, m_NUWMul(m_Value(Op1), m_ConstantInt(CI))) && canUseSExt(CI) && 585 (!CI->isNegative())) { 586 auto Result = decompose(Op1, Preconditions, IsSigned, DL); 587 Result.mul(CI->getSExtValue()); 588 return Result; 589 } 590 591 if (match(V, m_NUWSub(m_Value(Op0), m_Value(Op1)))) { 592 auto ResA = decompose(Op0, Preconditions, IsSigned, DL); 593 auto ResB = decompose(Op1, Preconditions, IsSigned, DL); 594 ResA.sub(ResB); 595 return ResA; 596 } 597 598 return {V, IsKnownNonNegative}; 599 } 600 601 ConstraintTy 602 ConstraintInfo::getConstraint(CmpInst::Predicate Pred, Value *Op0, Value *Op1, 603 SmallVectorImpl<Value *> &NewVariables) const { 604 assert(NewVariables.empty() && "NewVariables must be empty when passed in"); 605 bool IsEq = false; 606 bool IsNe = false; 607 608 // Try to convert Pred to one of ULE/SLT/SLE/SLT. 609 switch (Pred) { 610 case CmpInst::ICMP_UGT: 611 case CmpInst::ICMP_UGE: 612 case CmpInst::ICMP_SGT: 613 case CmpInst::ICMP_SGE: { 614 Pred = CmpInst::getSwappedPredicate(Pred); 615 std::swap(Op0, Op1); 616 break; 617 } 618 case CmpInst::ICMP_EQ: 619 if (match(Op1, m_Zero())) { 620 Pred = CmpInst::ICMP_ULE; 621 } else { 622 IsEq = true; 623 Pred = CmpInst::ICMP_ULE; 624 } 625 break; 626 case CmpInst::ICMP_NE: 627 if (match(Op1, m_Zero())) { 628 Pred = CmpInst::getSwappedPredicate(CmpInst::ICMP_UGT); 629 std::swap(Op0, Op1); 630 } else { 631 IsNe = true; 632 Pred = CmpInst::ICMP_ULE; 633 } 634 break; 635 default: 636 break; 637 } 638 639 if (Pred != CmpInst::ICMP_ULE && Pred != CmpInst::ICMP_ULT && 640 Pred != CmpInst::ICMP_SLE && Pred != CmpInst::ICMP_SLT) 641 return {}; 642 643 SmallVector<ConditionTy, 4> Preconditions; 644 bool IsSigned = CmpInst::isSigned(Pred); 645 auto &Value2Index = getValue2Index(IsSigned); 646 auto ADec = decompose(Op0->stripPointerCastsSameRepresentation(), 647 Preconditions, IsSigned, DL); 648 auto BDec = decompose(Op1->stripPointerCastsSameRepresentation(), 649 Preconditions, IsSigned, DL); 650 int64_t Offset1 = ADec.Offset; 651 int64_t Offset2 = BDec.Offset; 652 Offset1 *= -1; 653 654 auto &VariablesA = ADec.Vars; 655 auto &VariablesB = BDec.Vars; 656 657 // First try to look up \p V in Value2Index and NewVariables. Otherwise add a 658 // new entry to NewVariables. 659 SmallDenseMap<Value *, unsigned> NewIndexMap; 660 auto GetOrAddIndex = [&Value2Index, &NewVariables, 661 &NewIndexMap](Value *V) -> unsigned { 662 auto V2I = Value2Index.find(V); 663 if (V2I != Value2Index.end()) 664 return V2I->second; 665 auto Insert = 666 NewIndexMap.insert({V, Value2Index.size() + NewVariables.size() + 1}); 667 if (Insert.second) 668 NewVariables.push_back(V); 669 return Insert.first->second; 670 }; 671 672 // Make sure all variables have entries in Value2Index or NewVariables. 673 for (const auto &KV : concat<DecompEntry>(VariablesA, VariablesB)) 674 GetOrAddIndex(KV.Variable); 675 676 // Build result constraint, by first adding all coefficients from A and then 677 // subtracting all coefficients from B. 678 ConstraintTy Res( 679 SmallVector<int64_t, 8>(Value2Index.size() + NewVariables.size() + 1, 0), 680 IsSigned, IsEq, IsNe); 681 // Collect variables that are known to be positive in all uses in the 682 // constraint. 683 SmallDenseMap<Value *, bool> KnownNonNegativeVariables; 684 auto &R = Res.Coefficients; 685 for (const auto &KV : VariablesA) { 686 R[GetOrAddIndex(KV.Variable)] += KV.Coefficient; 687 auto I = 688 KnownNonNegativeVariables.insert({KV.Variable, KV.IsKnownNonNegative}); 689 I.first->second &= KV.IsKnownNonNegative; 690 } 691 692 for (const auto &KV : VariablesB) { 693 if (SubOverflow(R[GetOrAddIndex(KV.Variable)], KV.Coefficient, 694 R[GetOrAddIndex(KV.Variable)])) 695 return {}; 696 auto I = 697 KnownNonNegativeVariables.insert({KV.Variable, KV.IsKnownNonNegative}); 698 I.first->second &= KV.IsKnownNonNegative; 699 } 700 701 int64_t OffsetSum; 702 if (AddOverflow(Offset1, Offset2, OffsetSum)) 703 return {}; 704 if (Pred == (IsSigned ? CmpInst::ICMP_SLT : CmpInst::ICMP_ULT)) 705 if (AddOverflow(OffsetSum, int64_t(-1), OffsetSum)) 706 return {}; 707 R[0] = OffsetSum; 708 Res.Preconditions = std::move(Preconditions); 709 710 // Remove any (Coefficient, Variable) entry where the Coefficient is 0 for new 711 // variables. 712 while (!NewVariables.empty()) { 713 int64_t Last = R.back(); 714 if (Last != 0) 715 break; 716 R.pop_back(); 717 Value *RemovedV = NewVariables.pop_back_val(); 718 NewIndexMap.erase(RemovedV); 719 } 720 721 // Add extra constraints for variables that are known positive. 722 for (auto &KV : KnownNonNegativeVariables) { 723 if (!KV.second || 724 (!Value2Index.contains(KV.first) && !NewIndexMap.contains(KV.first))) 725 continue; 726 SmallVector<int64_t, 8> C(Value2Index.size() + NewVariables.size() + 1, 0); 727 C[GetOrAddIndex(KV.first)] = -1; 728 Res.ExtraInfo.push_back(C); 729 } 730 return Res; 731 } 732 733 ConstraintTy ConstraintInfo::getConstraintForSolving(CmpInst::Predicate Pred, 734 Value *Op0, 735 Value *Op1) const { 736 Constant *NullC = Constant::getNullValue(Op0->getType()); 737 // Handle trivially true compares directly to avoid adding V UGE 0 constraints 738 // for all variables in the unsigned system. 739 if ((Pred == CmpInst::ICMP_ULE && Op0 == NullC) || 740 (Pred == CmpInst::ICMP_UGE && Op1 == NullC)) { 741 auto &Value2Index = getValue2Index(false); 742 // Return constraint that's trivially true. 743 return ConstraintTy(SmallVector<int64_t, 8>(Value2Index.size(), 0), false, 744 false, false); 745 } 746 747 // If both operands are known to be non-negative, change signed predicates to 748 // unsigned ones. This increases the reasoning effectiveness in combination 749 // with the signed <-> unsigned transfer logic. 750 if (CmpInst::isSigned(Pred) && 751 isKnownNonNegative(Op0, DL, /*Depth=*/MaxAnalysisRecursionDepth - 1) && 752 isKnownNonNegative(Op1, DL, /*Depth=*/MaxAnalysisRecursionDepth - 1)) 753 Pred = CmpInst::getUnsignedPredicate(Pred); 754 755 SmallVector<Value *> NewVariables; 756 ConstraintTy R = getConstraint(Pred, Op0, Op1, NewVariables); 757 if (!NewVariables.empty()) 758 return {}; 759 return R; 760 } 761 762 bool ConstraintTy::isValid(const ConstraintInfo &Info) const { 763 return Coefficients.size() > 0 && 764 all_of(Preconditions, [&Info](const ConditionTy &C) { 765 return Info.doesHold(C.Pred, C.Op0, C.Op1); 766 }); 767 } 768 769 std::optional<bool> 770 ConstraintTy::isImpliedBy(const ConstraintSystem &CS) const { 771 bool IsConditionImplied = CS.isConditionImplied(Coefficients); 772 773 if (IsEq || IsNe) { 774 auto NegatedOrEqual = ConstraintSystem::negateOrEqual(Coefficients); 775 bool IsNegatedOrEqualImplied = 776 !NegatedOrEqual.empty() && CS.isConditionImplied(NegatedOrEqual); 777 778 // In order to check that `%a == %b` is true (equality), both conditions `%a 779 // >= %b` and `%a <= %b` must hold true. When checking for equality (`IsEq` 780 // is true), we return true if they both hold, false in the other cases. 781 if (IsConditionImplied && IsNegatedOrEqualImplied) 782 return IsEq; 783 784 auto Negated = ConstraintSystem::negate(Coefficients); 785 bool IsNegatedImplied = !Negated.empty() && CS.isConditionImplied(Negated); 786 787 auto StrictLessThan = ConstraintSystem::toStrictLessThan(Coefficients); 788 bool IsStrictLessThanImplied = 789 !StrictLessThan.empty() && CS.isConditionImplied(StrictLessThan); 790 791 // In order to check that `%a != %b` is true (non-equality), either 792 // condition `%a > %b` or `%a < %b` must hold true. When checking for 793 // non-equality (`IsNe` is true), we return true if one of the two holds, 794 // false in the other cases. 795 if (IsNegatedImplied || IsStrictLessThanImplied) 796 return IsNe; 797 798 return std::nullopt; 799 } 800 801 if (IsConditionImplied) 802 return true; 803 804 auto Negated = ConstraintSystem::negate(Coefficients); 805 auto IsNegatedImplied = !Negated.empty() && CS.isConditionImplied(Negated); 806 if (IsNegatedImplied) 807 return false; 808 809 // Neither the condition nor its negated holds, did not prove anything. 810 return std::nullopt; 811 } 812 813 bool ConstraintInfo::doesHold(CmpInst::Predicate Pred, Value *A, 814 Value *B) const { 815 auto R = getConstraintForSolving(Pred, A, B); 816 return R.isValid(*this) && 817 getCS(R.IsSigned).isConditionImplied(R.Coefficients); 818 } 819 820 void ConstraintInfo::transferToOtherSystem( 821 CmpInst::Predicate Pred, Value *A, Value *B, unsigned NumIn, 822 unsigned NumOut, SmallVectorImpl<StackEntry> &DFSInStack) { 823 auto IsKnownNonNegative = [this](Value *V) { 824 return doesHold(CmpInst::ICMP_SGE, V, ConstantInt::get(V->getType(), 0)) || 825 isKnownNonNegative(V, DL, /*Depth=*/MaxAnalysisRecursionDepth - 1); 826 }; 827 // Check if we can combine facts from the signed and unsigned systems to 828 // derive additional facts. 829 if (!A->getType()->isIntegerTy()) 830 return; 831 // FIXME: This currently depends on the order we add facts. Ideally we 832 // would first add all known facts and only then try to add additional 833 // facts. 834 switch (Pred) { 835 default: 836 break; 837 case CmpInst::ICMP_ULT: 838 case CmpInst::ICMP_ULE: 839 // If B is a signed positive constant, then A >=s 0 and A <s (or <=s) B. 840 if (IsKnownNonNegative(B)) { 841 addFact(CmpInst::ICMP_SGE, A, ConstantInt::get(B->getType(), 0), NumIn, 842 NumOut, DFSInStack); 843 addFact(CmpInst::getSignedPredicate(Pred), A, B, NumIn, NumOut, 844 DFSInStack); 845 } 846 break; 847 case CmpInst::ICMP_UGE: 848 case CmpInst::ICMP_UGT: 849 // If A is a signed positive constant, then B >=s 0 and A >s (or >=s) B. 850 if (IsKnownNonNegative(A)) { 851 addFact(CmpInst::ICMP_SGE, B, ConstantInt::get(B->getType(), 0), NumIn, 852 NumOut, DFSInStack); 853 addFact(CmpInst::getSignedPredicate(Pred), A, B, NumIn, NumOut, 854 DFSInStack); 855 } 856 break; 857 case CmpInst::ICMP_SLT: 858 if (IsKnownNonNegative(A)) 859 addFact(CmpInst::ICMP_ULT, A, B, NumIn, NumOut, DFSInStack); 860 break; 861 case CmpInst::ICMP_SGT: { 862 if (doesHold(CmpInst::ICMP_SGE, B, ConstantInt::get(B->getType(), -1))) 863 addFact(CmpInst::ICMP_UGE, A, ConstantInt::get(B->getType(), 0), NumIn, 864 NumOut, DFSInStack); 865 if (IsKnownNonNegative(B)) 866 addFact(CmpInst::ICMP_UGT, A, B, NumIn, NumOut, DFSInStack); 867 868 break; 869 } 870 case CmpInst::ICMP_SGE: 871 if (IsKnownNonNegative(B)) 872 addFact(CmpInst::ICMP_UGE, A, B, NumIn, NumOut, DFSInStack); 873 break; 874 } 875 } 876 877 #ifndef NDEBUG 878 879 static void dumpConstraint(ArrayRef<int64_t> C, 880 const DenseMap<Value *, unsigned> &Value2Index) { 881 ConstraintSystem CS(Value2Index); 882 CS.addVariableRowFill(C); 883 CS.dump(); 884 } 885 #endif 886 887 void State::addInfoForInductions(BasicBlock &BB) { 888 auto *L = LI.getLoopFor(&BB); 889 if (!L || L->getHeader() != &BB) 890 return; 891 892 Value *A; 893 Value *B; 894 CmpInst::Predicate Pred; 895 896 if (!match(BB.getTerminator(), 897 m_Br(m_ICmp(Pred, m_Value(A), m_Value(B)), m_Value(), m_Value()))) 898 return; 899 PHINode *PN = dyn_cast<PHINode>(A); 900 if (!PN) { 901 Pred = CmpInst::getSwappedPredicate(Pred); 902 std::swap(A, B); 903 PN = dyn_cast<PHINode>(A); 904 } 905 906 if (!PN || PN->getParent() != &BB || PN->getNumIncomingValues() != 2 || 907 !SE.isSCEVable(PN->getType())) 908 return; 909 910 BasicBlock *InLoopSucc = nullptr; 911 if (Pred == CmpInst::ICMP_NE) 912 InLoopSucc = cast<BranchInst>(BB.getTerminator())->getSuccessor(0); 913 else if (Pred == CmpInst::ICMP_EQ) 914 InLoopSucc = cast<BranchInst>(BB.getTerminator())->getSuccessor(1); 915 else 916 return; 917 918 if (!L->contains(InLoopSucc) || !L->isLoopExiting(&BB) || InLoopSucc == &BB) 919 return; 920 921 auto *AR = dyn_cast_or_null<SCEVAddRecExpr>(SE.getSCEV(PN)); 922 BasicBlock *LoopPred = L->getLoopPredecessor(); 923 if (!AR || AR->getLoop() != L || !LoopPred) 924 return; 925 926 const SCEV *StartSCEV = AR->getStart(); 927 Value *StartValue = nullptr; 928 if (auto *C = dyn_cast<SCEVConstant>(StartSCEV)) { 929 StartValue = C->getValue(); 930 } else { 931 StartValue = PN->getIncomingValueForBlock(LoopPred); 932 assert(SE.getSCEV(StartValue) == StartSCEV && "inconsistent start value"); 933 } 934 935 DomTreeNode *DTN = DT.getNode(InLoopSucc); 936 auto IncUnsigned = SE.getMonotonicPredicateType(AR, CmpInst::ICMP_UGT); 937 auto IncSigned = SE.getMonotonicPredicateType(AR, CmpInst::ICMP_SGT); 938 bool MonotonicallyIncreasingUnsigned = 939 IncUnsigned && *IncUnsigned == ScalarEvolution::MonotonicallyIncreasing; 940 bool MonotonicallyIncreasingSigned = 941 IncSigned && *IncSigned == ScalarEvolution::MonotonicallyIncreasing; 942 // If SCEV guarantees that AR does not wrap, PN >= StartValue can be added 943 // unconditionally. 944 if (MonotonicallyIncreasingUnsigned) 945 WorkList.push_back( 946 FactOrCheck::getConditionFact(DTN, CmpInst::ICMP_UGE, PN, StartValue)); 947 if (MonotonicallyIncreasingSigned) 948 WorkList.push_back( 949 FactOrCheck::getConditionFact(DTN, CmpInst::ICMP_SGE, PN, StartValue)); 950 951 APInt StepOffset; 952 if (auto *C = dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE))) 953 StepOffset = C->getAPInt(); 954 else 955 return; 956 957 // Make sure the bound B is loop-invariant. 958 if (!L->isLoopInvariant(B)) 959 return; 960 961 // Handle negative steps. 962 if (StepOffset.isNegative()) { 963 // TODO: Extend to allow steps > -1. 964 if (!(-StepOffset).isOne()) 965 return; 966 967 // AR may wrap. 968 // Add StartValue >= PN conditional on B <= StartValue which guarantees that 969 // the loop exits before wrapping with a step of -1. 970 WorkList.push_back(FactOrCheck::getConditionFact( 971 DTN, CmpInst::ICMP_UGE, StartValue, PN, 972 ConditionTy(CmpInst::ICMP_ULE, B, StartValue))); 973 WorkList.push_back(FactOrCheck::getConditionFact( 974 DTN, CmpInst::ICMP_SGE, StartValue, PN, 975 ConditionTy(CmpInst::ICMP_SLE, B, StartValue))); 976 // Add PN > B conditional on B <= StartValue which guarantees that the loop 977 // exits when reaching B with a step of -1. 978 WorkList.push_back(FactOrCheck::getConditionFact( 979 DTN, CmpInst::ICMP_UGT, PN, B, 980 ConditionTy(CmpInst::ICMP_ULE, B, StartValue))); 981 WorkList.push_back(FactOrCheck::getConditionFact( 982 DTN, CmpInst::ICMP_SGT, PN, B, 983 ConditionTy(CmpInst::ICMP_SLE, B, StartValue))); 984 return; 985 } 986 987 // Make sure AR either steps by 1 or that the value we compare against is a 988 // GEP based on the same start value and all offsets are a multiple of the 989 // step size, to guarantee that the induction will reach the value. 990 if (StepOffset.isZero() || StepOffset.isNegative()) 991 return; 992 993 if (!StepOffset.isOne()) { 994 // Check whether B-Start is known to be a multiple of StepOffset. 995 const SCEV *BMinusStart = SE.getMinusSCEV(SE.getSCEV(B), StartSCEV); 996 if (isa<SCEVCouldNotCompute>(BMinusStart) || 997 !SE.getConstantMultiple(BMinusStart).urem(StepOffset).isZero()) 998 return; 999 } 1000 1001 // AR may wrap. Add PN >= StartValue conditional on StartValue <= B which 1002 // guarantees that the loop exits before wrapping in combination with the 1003 // restrictions on B and the step above. 1004 if (!MonotonicallyIncreasingUnsigned) 1005 WorkList.push_back(FactOrCheck::getConditionFact( 1006 DTN, CmpInst::ICMP_UGE, PN, StartValue, 1007 ConditionTy(CmpInst::ICMP_ULE, StartValue, B))); 1008 if (!MonotonicallyIncreasingSigned) 1009 WorkList.push_back(FactOrCheck::getConditionFact( 1010 DTN, CmpInst::ICMP_SGE, PN, StartValue, 1011 ConditionTy(CmpInst::ICMP_SLE, StartValue, B))); 1012 1013 WorkList.push_back(FactOrCheck::getConditionFact( 1014 DTN, CmpInst::ICMP_ULT, PN, B, 1015 ConditionTy(CmpInst::ICMP_ULE, StartValue, B))); 1016 WorkList.push_back(FactOrCheck::getConditionFact( 1017 DTN, CmpInst::ICMP_SLT, PN, B, 1018 ConditionTy(CmpInst::ICMP_SLE, StartValue, B))); 1019 } 1020 1021 void State::addInfoFor(BasicBlock &BB) { 1022 addInfoForInductions(BB); 1023 1024 // True as long as long as the current instruction is guaranteed to execute. 1025 bool GuaranteedToExecute = true; 1026 // Queue conditions and assumes. 1027 for (Instruction &I : BB) { 1028 if (auto Cmp = dyn_cast<ICmpInst>(&I)) { 1029 for (Use &U : Cmp->uses()) { 1030 auto *UserI = getContextInstForUse(U); 1031 auto *DTN = DT.getNode(UserI->getParent()); 1032 if (!DTN) 1033 continue; 1034 WorkList.push_back(FactOrCheck::getCheck(DTN, &U)); 1035 } 1036 continue; 1037 } 1038 1039 auto *II = dyn_cast<IntrinsicInst>(&I); 1040 Intrinsic::ID ID = II ? II->getIntrinsicID() : Intrinsic::not_intrinsic; 1041 switch (ID) { 1042 case Intrinsic::assume: { 1043 Value *A, *B; 1044 CmpInst::Predicate Pred; 1045 if (!match(I.getOperand(0), m_ICmp(Pred, m_Value(A), m_Value(B)))) 1046 break; 1047 if (GuaranteedToExecute) { 1048 // The assume is guaranteed to execute when BB is entered, hence Cond 1049 // holds on entry to BB. 1050 WorkList.emplace_back(FactOrCheck::getConditionFact( 1051 DT.getNode(I.getParent()), Pred, A, B)); 1052 } else { 1053 WorkList.emplace_back( 1054 FactOrCheck::getInstFact(DT.getNode(I.getParent()), &I)); 1055 } 1056 break; 1057 } 1058 // Enqueue ssub_with_overflow for simplification. 1059 case Intrinsic::ssub_with_overflow: 1060 WorkList.push_back( 1061 FactOrCheck::getCheck(DT.getNode(&BB), cast<CallInst>(&I))); 1062 break; 1063 // Enqueue the intrinsics to add extra info. 1064 case Intrinsic::abs: 1065 case Intrinsic::umin: 1066 case Intrinsic::umax: 1067 case Intrinsic::smin: 1068 case Intrinsic::smax: 1069 WorkList.push_back(FactOrCheck::getInstFact(DT.getNode(&BB), &I)); 1070 break; 1071 } 1072 1073 GuaranteedToExecute &= isGuaranteedToTransferExecutionToSuccessor(&I); 1074 } 1075 1076 if (auto *Switch = dyn_cast<SwitchInst>(BB.getTerminator())) { 1077 for (auto &Case : Switch->cases()) { 1078 BasicBlock *Succ = Case.getCaseSuccessor(); 1079 Value *V = Case.getCaseValue(); 1080 if (!canAddSuccessor(BB, Succ)) 1081 continue; 1082 WorkList.emplace_back(FactOrCheck::getConditionFact( 1083 DT.getNode(Succ), CmpInst::ICMP_EQ, Switch->getCondition(), V)); 1084 } 1085 return; 1086 } 1087 1088 auto *Br = dyn_cast<BranchInst>(BB.getTerminator()); 1089 if (!Br || !Br->isConditional()) 1090 return; 1091 1092 Value *Cond = Br->getCondition(); 1093 1094 // If the condition is a chain of ORs/AND and the successor only has the 1095 // current block as predecessor, queue conditions for the successor. 1096 Value *Op0, *Op1; 1097 if (match(Cond, m_LogicalOr(m_Value(Op0), m_Value(Op1))) || 1098 match(Cond, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) { 1099 bool IsOr = match(Cond, m_LogicalOr()); 1100 bool IsAnd = match(Cond, m_LogicalAnd()); 1101 // If there's a select that matches both AND and OR, we need to commit to 1102 // one of the options. Arbitrarily pick OR. 1103 if (IsOr && IsAnd) 1104 IsAnd = false; 1105 1106 BasicBlock *Successor = Br->getSuccessor(IsOr ? 1 : 0); 1107 if (canAddSuccessor(BB, Successor)) { 1108 SmallVector<Value *> CondWorkList; 1109 SmallPtrSet<Value *, 8> SeenCond; 1110 auto QueueValue = [&CondWorkList, &SeenCond](Value *V) { 1111 if (SeenCond.insert(V).second) 1112 CondWorkList.push_back(V); 1113 }; 1114 QueueValue(Op1); 1115 QueueValue(Op0); 1116 while (!CondWorkList.empty()) { 1117 Value *Cur = CondWorkList.pop_back_val(); 1118 if (auto *Cmp = dyn_cast<ICmpInst>(Cur)) { 1119 WorkList.emplace_back(FactOrCheck::getConditionFact( 1120 DT.getNode(Successor), 1121 IsOr ? CmpInst::getInversePredicate(Cmp->getPredicate()) 1122 : Cmp->getPredicate(), 1123 Cmp->getOperand(0), Cmp->getOperand(1))); 1124 continue; 1125 } 1126 if (IsOr && match(Cur, m_LogicalOr(m_Value(Op0), m_Value(Op1)))) { 1127 QueueValue(Op1); 1128 QueueValue(Op0); 1129 continue; 1130 } 1131 if (IsAnd && match(Cur, m_LogicalAnd(m_Value(Op0), m_Value(Op1)))) { 1132 QueueValue(Op1); 1133 QueueValue(Op0); 1134 continue; 1135 } 1136 } 1137 } 1138 return; 1139 } 1140 1141 auto *CmpI = dyn_cast<ICmpInst>(Br->getCondition()); 1142 if (!CmpI) 1143 return; 1144 if (canAddSuccessor(BB, Br->getSuccessor(0))) 1145 WorkList.emplace_back(FactOrCheck::getConditionFact( 1146 DT.getNode(Br->getSuccessor(0)), CmpI->getPredicate(), 1147 CmpI->getOperand(0), CmpI->getOperand(1))); 1148 if (canAddSuccessor(BB, Br->getSuccessor(1))) 1149 WorkList.emplace_back(FactOrCheck::getConditionFact( 1150 DT.getNode(Br->getSuccessor(1)), 1151 CmpInst::getInversePredicate(CmpI->getPredicate()), CmpI->getOperand(0), 1152 CmpI->getOperand(1))); 1153 } 1154 1155 #ifndef NDEBUG 1156 static void dumpUnpackedICmp(raw_ostream &OS, ICmpInst::Predicate Pred, 1157 Value *LHS, Value *RHS) { 1158 OS << "icmp " << Pred << ' '; 1159 LHS->printAsOperand(OS, /*PrintType=*/true); 1160 OS << ", "; 1161 RHS->printAsOperand(OS, /*PrintType=*/false); 1162 } 1163 #endif 1164 1165 namespace { 1166 /// Helper to keep track of a condition and if it should be treated as negated 1167 /// for reproducer construction. 1168 /// Pred == Predicate::BAD_ICMP_PREDICATE indicates that this entry is a 1169 /// placeholder to keep the ReproducerCondStack in sync with DFSInStack. 1170 struct ReproducerEntry { 1171 ICmpInst::Predicate Pred; 1172 Value *LHS; 1173 Value *RHS; 1174 1175 ReproducerEntry(ICmpInst::Predicate Pred, Value *LHS, Value *RHS) 1176 : Pred(Pred), LHS(LHS), RHS(RHS) {} 1177 }; 1178 } // namespace 1179 1180 /// Helper function to generate a reproducer function for simplifying \p Cond. 1181 /// The reproducer function contains a series of @llvm.assume calls, one for 1182 /// each condition in \p Stack. For each condition, the operand instruction are 1183 /// cloned until we reach operands that have an entry in \p Value2Index. Those 1184 /// will then be added as function arguments. \p DT is used to order cloned 1185 /// instructions. The reproducer function will get added to \p M, if it is 1186 /// non-null. Otherwise no reproducer function is generated. 1187 static void generateReproducer(CmpInst *Cond, Module *M, 1188 ArrayRef<ReproducerEntry> Stack, 1189 ConstraintInfo &Info, DominatorTree &DT) { 1190 if (!M) 1191 return; 1192 1193 LLVMContext &Ctx = Cond->getContext(); 1194 1195 LLVM_DEBUG(dbgs() << "Creating reproducer for " << *Cond << "\n"); 1196 1197 ValueToValueMapTy Old2New; 1198 SmallVector<Value *> Args; 1199 SmallPtrSet<Value *, 8> Seen; 1200 // Traverse Cond and its operands recursively until we reach a value that's in 1201 // Value2Index or not an instruction, or not a operation that 1202 // ConstraintElimination can decompose. Such values will be considered as 1203 // external inputs to the reproducer, they are collected and added as function 1204 // arguments later. 1205 auto CollectArguments = [&](ArrayRef<Value *> Ops, bool IsSigned) { 1206 auto &Value2Index = Info.getValue2Index(IsSigned); 1207 SmallVector<Value *, 4> WorkList(Ops); 1208 while (!WorkList.empty()) { 1209 Value *V = WorkList.pop_back_val(); 1210 if (!Seen.insert(V).second) 1211 continue; 1212 if (Old2New.find(V) != Old2New.end()) 1213 continue; 1214 if (isa<Constant>(V)) 1215 continue; 1216 1217 auto *I = dyn_cast<Instruction>(V); 1218 if (Value2Index.contains(V) || !I || 1219 !isa<CmpInst, BinaryOperator, GEPOperator, CastInst>(V)) { 1220 Old2New[V] = V; 1221 Args.push_back(V); 1222 LLVM_DEBUG(dbgs() << " found external input " << *V << "\n"); 1223 } else { 1224 append_range(WorkList, I->operands()); 1225 } 1226 } 1227 }; 1228 1229 for (auto &Entry : Stack) 1230 if (Entry.Pred != ICmpInst::BAD_ICMP_PREDICATE) 1231 CollectArguments({Entry.LHS, Entry.RHS}, ICmpInst::isSigned(Entry.Pred)); 1232 CollectArguments(Cond, ICmpInst::isSigned(Cond->getPredicate())); 1233 1234 SmallVector<Type *> ParamTys; 1235 for (auto *P : Args) 1236 ParamTys.push_back(P->getType()); 1237 1238 FunctionType *FTy = FunctionType::get(Cond->getType(), ParamTys, 1239 /*isVarArg=*/false); 1240 Function *F = Function::Create(FTy, Function::ExternalLinkage, 1241 Cond->getModule()->getName() + 1242 Cond->getFunction()->getName() + "repro", 1243 M); 1244 // Add arguments to the reproducer function for each external value collected. 1245 for (unsigned I = 0; I < Args.size(); ++I) { 1246 F->getArg(I)->setName(Args[I]->getName()); 1247 Old2New[Args[I]] = F->getArg(I); 1248 } 1249 1250 BasicBlock *Entry = BasicBlock::Create(Ctx, "entry", F); 1251 IRBuilder<> Builder(Entry); 1252 Builder.CreateRet(Builder.getTrue()); 1253 Builder.SetInsertPoint(Entry->getTerminator()); 1254 1255 // Clone instructions in \p Ops and their operands recursively until reaching 1256 // an value in Value2Index (external input to the reproducer). Update Old2New 1257 // mapping for the original and cloned instructions. Sort instructions to 1258 // clone by dominance, then insert the cloned instructions in the function. 1259 auto CloneInstructions = [&](ArrayRef<Value *> Ops, bool IsSigned) { 1260 SmallVector<Value *, 4> WorkList(Ops); 1261 SmallVector<Instruction *> ToClone; 1262 auto &Value2Index = Info.getValue2Index(IsSigned); 1263 while (!WorkList.empty()) { 1264 Value *V = WorkList.pop_back_val(); 1265 if (Old2New.find(V) != Old2New.end()) 1266 continue; 1267 1268 auto *I = dyn_cast<Instruction>(V); 1269 if (!Value2Index.contains(V) && I) { 1270 Old2New[V] = nullptr; 1271 ToClone.push_back(I); 1272 append_range(WorkList, I->operands()); 1273 } 1274 } 1275 1276 sort(ToClone, 1277 [&DT](Instruction *A, Instruction *B) { return DT.dominates(A, B); }); 1278 for (Instruction *I : ToClone) { 1279 Instruction *Cloned = I->clone(); 1280 Old2New[I] = Cloned; 1281 Old2New[I]->setName(I->getName()); 1282 Cloned->insertBefore(&*Builder.GetInsertPoint()); 1283 Cloned->dropUnknownNonDebugMetadata(); 1284 Cloned->setDebugLoc({}); 1285 } 1286 }; 1287 1288 // Materialize the assumptions for the reproducer using the entries in Stack. 1289 // That is, first clone the operands of the condition recursively until we 1290 // reach an external input to the reproducer and add them to the reproducer 1291 // function. Then add an ICmp for the condition (with the inverse predicate if 1292 // the entry is negated) and an assert using the ICmp. 1293 for (auto &Entry : Stack) { 1294 if (Entry.Pred == ICmpInst::BAD_ICMP_PREDICATE) 1295 continue; 1296 1297 LLVM_DEBUG(dbgs() << " Materializing assumption "; 1298 dumpUnpackedICmp(dbgs(), Entry.Pred, Entry.LHS, Entry.RHS); 1299 dbgs() << "\n"); 1300 CloneInstructions({Entry.LHS, Entry.RHS}, CmpInst::isSigned(Entry.Pred)); 1301 1302 auto *Cmp = Builder.CreateICmp(Entry.Pred, Entry.LHS, Entry.RHS); 1303 Builder.CreateAssumption(Cmp); 1304 } 1305 1306 // Finally, clone the condition to reproduce and remap instruction operands in 1307 // the reproducer using Old2New. 1308 CloneInstructions(Cond, CmpInst::isSigned(Cond->getPredicate())); 1309 Entry->getTerminator()->setOperand(0, Cond); 1310 remapInstructionsInBlocks({Entry}, Old2New); 1311 1312 assert(!verifyFunction(*F, &dbgs())); 1313 } 1314 1315 static std::optional<bool> checkCondition(CmpInst::Predicate Pred, Value *A, 1316 Value *B, Instruction *CheckInst, 1317 ConstraintInfo &Info, unsigned NumIn, 1318 unsigned NumOut, 1319 Instruction *ContextInst) { 1320 LLVM_DEBUG(dbgs() << "Checking " << *CheckInst << "\n"); 1321 1322 auto R = Info.getConstraintForSolving(Pred, A, B); 1323 if (R.empty() || !R.isValid(Info)){ 1324 LLVM_DEBUG(dbgs() << " failed to decompose condition\n"); 1325 return std::nullopt; 1326 } 1327 1328 auto &CSToUse = Info.getCS(R.IsSigned); 1329 1330 // If there was extra information collected during decomposition, apply 1331 // it now and remove it immediately once we are done with reasoning 1332 // about the constraint. 1333 for (auto &Row : R.ExtraInfo) 1334 CSToUse.addVariableRow(Row); 1335 auto InfoRestorer = make_scope_exit([&]() { 1336 for (unsigned I = 0; I < R.ExtraInfo.size(); ++I) 1337 CSToUse.popLastConstraint(); 1338 }); 1339 1340 if (auto ImpliedCondition = R.isImpliedBy(CSToUse)) { 1341 if (!DebugCounter::shouldExecute(EliminatedCounter)) 1342 return std::nullopt; 1343 1344 LLVM_DEBUG({ 1345 dbgs() << "Condition "; 1346 dumpUnpackedICmp( 1347 dbgs(), *ImpliedCondition ? Pred : CmpInst::getInversePredicate(Pred), 1348 A, B); 1349 dbgs() << " implied by dominating constraints\n"; 1350 CSToUse.dump(); 1351 }); 1352 return ImpliedCondition; 1353 } 1354 1355 return std::nullopt; 1356 } 1357 1358 static bool checkAndReplaceCondition( 1359 CmpInst *Cmp, ConstraintInfo &Info, unsigned NumIn, unsigned NumOut, 1360 Instruction *ContextInst, Module *ReproducerModule, 1361 ArrayRef<ReproducerEntry> ReproducerCondStack, DominatorTree &DT, 1362 SmallVectorImpl<Instruction *> &ToRemove) { 1363 auto ReplaceCmpWithConstant = [&](CmpInst *Cmp, bool IsTrue) { 1364 generateReproducer(Cmp, ReproducerModule, ReproducerCondStack, Info, DT); 1365 Constant *ConstantC = ConstantInt::getBool( 1366 CmpInst::makeCmpResultType(Cmp->getType()), IsTrue); 1367 Cmp->replaceUsesWithIf(ConstantC, [&DT, NumIn, NumOut, 1368 ContextInst](Use &U) { 1369 auto *UserI = getContextInstForUse(U); 1370 auto *DTN = DT.getNode(UserI->getParent()); 1371 if (!DTN || DTN->getDFSNumIn() < NumIn || DTN->getDFSNumOut() > NumOut) 1372 return false; 1373 if (UserI->getParent() == ContextInst->getParent() && 1374 UserI->comesBefore(ContextInst)) 1375 return false; 1376 1377 // Conditions in an assume trivially simplify to true. Skip uses 1378 // in assume calls to not destroy the available information. 1379 auto *II = dyn_cast<IntrinsicInst>(U.getUser()); 1380 return !II || II->getIntrinsicID() != Intrinsic::assume; 1381 }); 1382 NumCondsRemoved++; 1383 if (Cmp->use_empty()) 1384 ToRemove.push_back(Cmp); 1385 return true; 1386 }; 1387 1388 if (auto ImpliedCondition = checkCondition( 1389 Cmp->getPredicate(), Cmp->getOperand(0), Cmp->getOperand(1), Cmp, 1390 Info, NumIn, NumOut, ContextInst)) 1391 return ReplaceCmpWithConstant(Cmp, *ImpliedCondition); 1392 return false; 1393 } 1394 1395 static void 1396 removeEntryFromStack(const StackEntry &E, ConstraintInfo &Info, 1397 Module *ReproducerModule, 1398 SmallVectorImpl<ReproducerEntry> &ReproducerCondStack, 1399 SmallVectorImpl<StackEntry> &DFSInStack) { 1400 Info.popLastConstraint(E.IsSigned); 1401 // Remove variables in the system that went out of scope. 1402 auto &Mapping = Info.getValue2Index(E.IsSigned); 1403 for (Value *V : E.ValuesToRelease) 1404 Mapping.erase(V); 1405 Info.popLastNVariables(E.IsSigned, E.ValuesToRelease.size()); 1406 DFSInStack.pop_back(); 1407 if (ReproducerModule) 1408 ReproducerCondStack.pop_back(); 1409 } 1410 1411 /// Check if either the first condition of an AND or OR is implied by the 1412 /// (negated in case of OR) second condition or vice versa. 1413 static bool checkOrAndOpImpliedByOther( 1414 FactOrCheck &CB, ConstraintInfo &Info, Module *ReproducerModule, 1415 SmallVectorImpl<ReproducerEntry> &ReproducerCondStack, 1416 SmallVectorImpl<StackEntry> &DFSInStack) { 1417 1418 CmpInst::Predicate Pred; 1419 Value *A, *B; 1420 Instruction *JoinOp = CB.getContextInst(); 1421 CmpInst *CmpToCheck = cast<CmpInst>(CB.getInstructionToSimplify()); 1422 unsigned OtherOpIdx = JoinOp->getOperand(0) == CmpToCheck ? 1 : 0; 1423 1424 // Don't try to simplify the first condition of a select by the second, as 1425 // this may make the select more poisonous than the original one. 1426 // TODO: check if the first operand may be poison. 1427 if (OtherOpIdx != 0 && isa<SelectInst>(JoinOp)) 1428 return false; 1429 1430 if (!match(JoinOp->getOperand(OtherOpIdx), 1431 m_ICmp(Pred, m_Value(A), m_Value(B)))) 1432 return false; 1433 1434 // For OR, check if the negated condition implies CmpToCheck. 1435 bool IsOr = match(JoinOp, m_LogicalOr()); 1436 if (IsOr) 1437 Pred = CmpInst::getInversePredicate(Pred); 1438 1439 // Optimistically add fact from first condition. 1440 unsigned OldSize = DFSInStack.size(); 1441 Info.addFact(Pred, A, B, CB.NumIn, CB.NumOut, DFSInStack); 1442 if (OldSize == DFSInStack.size()) 1443 return false; 1444 1445 bool Changed = false; 1446 // Check if the second condition can be simplified now. 1447 if (auto ImpliedCondition = 1448 checkCondition(CmpToCheck->getPredicate(), CmpToCheck->getOperand(0), 1449 CmpToCheck->getOperand(1), CmpToCheck, Info, CB.NumIn, 1450 CB.NumOut, CB.getContextInst())) { 1451 if (IsOr && isa<SelectInst>(JoinOp)) { 1452 JoinOp->setOperand( 1453 OtherOpIdx == 0 ? 2 : 0, 1454 ConstantInt::getBool(JoinOp->getType(), *ImpliedCondition)); 1455 } else 1456 JoinOp->setOperand( 1457 1 - OtherOpIdx, 1458 ConstantInt::getBool(JoinOp->getType(), *ImpliedCondition)); 1459 1460 Changed = true; 1461 } 1462 1463 // Remove entries again. 1464 while (OldSize < DFSInStack.size()) { 1465 StackEntry E = DFSInStack.back(); 1466 removeEntryFromStack(E, Info, ReproducerModule, ReproducerCondStack, 1467 DFSInStack); 1468 } 1469 return Changed; 1470 } 1471 1472 void ConstraintInfo::addFact(CmpInst::Predicate Pred, Value *A, Value *B, 1473 unsigned NumIn, unsigned NumOut, 1474 SmallVectorImpl<StackEntry> &DFSInStack) { 1475 // If the constraint has a pre-condition, skip the constraint if it does not 1476 // hold. 1477 SmallVector<Value *> NewVariables; 1478 auto R = getConstraint(Pred, A, B, NewVariables); 1479 1480 // TODO: Support non-equality for facts as well. 1481 if (!R.isValid(*this) || R.isNe()) 1482 return; 1483 1484 LLVM_DEBUG(dbgs() << "Adding '"; dumpUnpackedICmp(dbgs(), Pred, A, B); 1485 dbgs() << "'\n"); 1486 bool Added = false; 1487 auto &CSToUse = getCS(R.IsSigned); 1488 if (R.Coefficients.empty()) 1489 return; 1490 1491 Added |= CSToUse.addVariableRowFill(R.Coefficients); 1492 1493 // If R has been added to the system, add the new variables and queue it for 1494 // removal once it goes out-of-scope. 1495 if (Added) { 1496 SmallVector<Value *, 2> ValuesToRelease; 1497 auto &Value2Index = getValue2Index(R.IsSigned); 1498 for (Value *V : NewVariables) { 1499 Value2Index.insert({V, Value2Index.size() + 1}); 1500 ValuesToRelease.push_back(V); 1501 } 1502 1503 LLVM_DEBUG({ 1504 dbgs() << " constraint: "; 1505 dumpConstraint(R.Coefficients, getValue2Index(R.IsSigned)); 1506 dbgs() << "\n"; 1507 }); 1508 1509 DFSInStack.emplace_back(NumIn, NumOut, R.IsSigned, 1510 std::move(ValuesToRelease)); 1511 1512 if (!R.IsSigned) { 1513 for (Value *V : NewVariables) { 1514 ConstraintTy VarPos(SmallVector<int64_t, 8>(Value2Index.size() + 1, 0), 1515 false, false, false); 1516 VarPos.Coefficients[Value2Index[V]] = -1; 1517 CSToUse.addVariableRow(VarPos.Coefficients); 1518 DFSInStack.emplace_back(NumIn, NumOut, R.IsSigned, 1519 SmallVector<Value *, 2>()); 1520 } 1521 } 1522 1523 if (R.isEq()) { 1524 // Also add the inverted constraint for equality constraints. 1525 for (auto &Coeff : R.Coefficients) 1526 Coeff *= -1; 1527 CSToUse.addVariableRowFill(R.Coefficients); 1528 1529 DFSInStack.emplace_back(NumIn, NumOut, R.IsSigned, 1530 SmallVector<Value *, 2>()); 1531 } 1532 } 1533 } 1534 1535 static bool replaceSubOverflowUses(IntrinsicInst *II, Value *A, Value *B, 1536 SmallVectorImpl<Instruction *> &ToRemove) { 1537 bool Changed = false; 1538 IRBuilder<> Builder(II->getParent(), II->getIterator()); 1539 Value *Sub = nullptr; 1540 for (User *U : make_early_inc_range(II->users())) { 1541 if (match(U, m_ExtractValue<0>(m_Value()))) { 1542 if (!Sub) 1543 Sub = Builder.CreateSub(A, B); 1544 U->replaceAllUsesWith(Sub); 1545 Changed = true; 1546 } else if (match(U, m_ExtractValue<1>(m_Value()))) { 1547 U->replaceAllUsesWith(Builder.getFalse()); 1548 Changed = true; 1549 } else 1550 continue; 1551 1552 if (U->use_empty()) { 1553 auto *I = cast<Instruction>(U); 1554 ToRemove.push_back(I); 1555 I->setOperand(0, PoisonValue::get(II->getType())); 1556 Changed = true; 1557 } 1558 } 1559 1560 if (II->use_empty()) { 1561 II->eraseFromParent(); 1562 Changed = true; 1563 } 1564 return Changed; 1565 } 1566 1567 static bool 1568 tryToSimplifyOverflowMath(IntrinsicInst *II, ConstraintInfo &Info, 1569 SmallVectorImpl<Instruction *> &ToRemove) { 1570 auto DoesConditionHold = [](CmpInst::Predicate Pred, Value *A, Value *B, 1571 ConstraintInfo &Info) { 1572 auto R = Info.getConstraintForSolving(Pred, A, B); 1573 if (R.size() < 2 || !R.isValid(Info)) 1574 return false; 1575 1576 auto &CSToUse = Info.getCS(R.IsSigned); 1577 return CSToUse.isConditionImplied(R.Coefficients); 1578 }; 1579 1580 bool Changed = false; 1581 if (II->getIntrinsicID() == Intrinsic::ssub_with_overflow) { 1582 // If A s>= B && B s>= 0, ssub.with.overflow(a, b) should not overflow and 1583 // can be simplified to a regular sub. 1584 Value *A = II->getArgOperand(0); 1585 Value *B = II->getArgOperand(1); 1586 if (!DoesConditionHold(CmpInst::ICMP_SGE, A, B, Info) || 1587 !DoesConditionHold(CmpInst::ICMP_SGE, B, 1588 ConstantInt::get(A->getType(), 0), Info)) 1589 return false; 1590 Changed = replaceSubOverflowUses(II, A, B, ToRemove); 1591 } 1592 return Changed; 1593 } 1594 1595 static bool eliminateConstraints(Function &F, DominatorTree &DT, LoopInfo &LI, 1596 ScalarEvolution &SE, 1597 OptimizationRemarkEmitter &ORE) { 1598 bool Changed = false; 1599 DT.updateDFSNumbers(); 1600 SmallVector<Value *> FunctionArgs; 1601 for (Value &Arg : F.args()) 1602 FunctionArgs.push_back(&Arg); 1603 ConstraintInfo Info(F.getParent()->getDataLayout(), FunctionArgs); 1604 State S(DT, LI, SE); 1605 std::unique_ptr<Module> ReproducerModule( 1606 DumpReproducers ? new Module(F.getName(), F.getContext()) : nullptr); 1607 1608 // First, collect conditions implied by branches and blocks with their 1609 // Dominator DFS in and out numbers. 1610 for (BasicBlock &BB : F) { 1611 if (!DT.getNode(&BB)) 1612 continue; 1613 S.addInfoFor(BB); 1614 } 1615 1616 // Next, sort worklist by dominance, so that dominating conditions to check 1617 // and facts come before conditions and facts dominated by them. If a 1618 // condition to check and a fact have the same numbers, conditional facts come 1619 // first. Assume facts and checks are ordered according to their relative 1620 // order in the containing basic block. Also make sure conditions with 1621 // constant operands come before conditions without constant operands. This 1622 // increases the effectiveness of the current signed <-> unsigned fact 1623 // transfer logic. 1624 stable_sort(S.WorkList, [](const FactOrCheck &A, const FactOrCheck &B) { 1625 auto HasNoConstOp = [](const FactOrCheck &B) { 1626 Value *V0 = B.isConditionFact() ? B.Cond.Op0 : B.Inst->getOperand(0); 1627 Value *V1 = B.isConditionFact() ? B.Cond.Op1 : B.Inst->getOperand(1); 1628 return !isa<ConstantInt>(V0) && !isa<ConstantInt>(V1); 1629 }; 1630 // If both entries have the same In numbers, conditional facts come first. 1631 // Otherwise use the relative order in the basic block. 1632 if (A.NumIn == B.NumIn) { 1633 if (A.isConditionFact() && B.isConditionFact()) { 1634 bool NoConstOpA = HasNoConstOp(A); 1635 bool NoConstOpB = HasNoConstOp(B); 1636 return NoConstOpA < NoConstOpB; 1637 } 1638 if (A.isConditionFact()) 1639 return true; 1640 if (B.isConditionFact()) 1641 return false; 1642 auto *InstA = A.getContextInst(); 1643 auto *InstB = B.getContextInst(); 1644 return InstA->comesBefore(InstB); 1645 } 1646 return A.NumIn < B.NumIn; 1647 }); 1648 1649 SmallVector<Instruction *> ToRemove; 1650 1651 // Finally, process ordered worklist and eliminate implied conditions. 1652 SmallVector<StackEntry, 16> DFSInStack; 1653 SmallVector<ReproducerEntry> ReproducerCondStack; 1654 for (FactOrCheck &CB : S.WorkList) { 1655 // First, pop entries from the stack that are out-of-scope for CB. Remove 1656 // the corresponding entry from the constraint system. 1657 while (!DFSInStack.empty()) { 1658 auto &E = DFSInStack.back(); 1659 LLVM_DEBUG(dbgs() << "Top of stack : " << E.NumIn << " " << E.NumOut 1660 << "\n"); 1661 LLVM_DEBUG(dbgs() << "CB: " << CB.NumIn << " " << CB.NumOut << "\n"); 1662 assert(E.NumIn <= CB.NumIn); 1663 if (CB.NumOut <= E.NumOut) 1664 break; 1665 LLVM_DEBUG({ 1666 dbgs() << "Removing "; 1667 dumpConstraint(Info.getCS(E.IsSigned).getLastConstraint(), 1668 Info.getValue2Index(E.IsSigned)); 1669 dbgs() << "\n"; 1670 }); 1671 removeEntryFromStack(E, Info, ReproducerModule.get(), ReproducerCondStack, 1672 DFSInStack); 1673 } 1674 1675 // For a block, check if any CmpInsts become known based on the current set 1676 // of constraints. 1677 if (CB.isCheck()) { 1678 Instruction *Inst = CB.getInstructionToSimplify(); 1679 if (!Inst) 1680 continue; 1681 LLVM_DEBUG(dbgs() << "Processing condition to simplify: " << *Inst 1682 << "\n"); 1683 if (auto *II = dyn_cast<WithOverflowInst>(Inst)) { 1684 Changed |= tryToSimplifyOverflowMath(II, Info, ToRemove); 1685 } else if (auto *Cmp = dyn_cast<ICmpInst>(Inst)) { 1686 bool Simplified = checkAndReplaceCondition( 1687 Cmp, Info, CB.NumIn, CB.NumOut, CB.getContextInst(), 1688 ReproducerModule.get(), ReproducerCondStack, S.DT, ToRemove); 1689 if (!Simplified && 1690 match(CB.getContextInst(), m_LogicalOp(m_Value(), m_Value()))) { 1691 Simplified = 1692 checkOrAndOpImpliedByOther(CB, Info, ReproducerModule.get(), 1693 ReproducerCondStack, DFSInStack); 1694 } 1695 Changed |= Simplified; 1696 } 1697 continue; 1698 } 1699 1700 auto AddFact = [&](CmpInst::Predicate Pred, Value *A, Value *B) { 1701 LLVM_DEBUG(dbgs() << "Processing fact to add to the system: "; 1702 dumpUnpackedICmp(dbgs(), Pred, A, B); dbgs() << "\n"); 1703 if (Info.getCS(CmpInst::isSigned(Pred)).size() > MaxRows) { 1704 LLVM_DEBUG( 1705 dbgs() 1706 << "Skip adding constraint because system has too many rows.\n"); 1707 return; 1708 } 1709 1710 Info.addFact(Pred, A, B, CB.NumIn, CB.NumOut, DFSInStack); 1711 if (ReproducerModule && DFSInStack.size() > ReproducerCondStack.size()) 1712 ReproducerCondStack.emplace_back(Pred, A, B); 1713 1714 Info.transferToOtherSystem(Pred, A, B, CB.NumIn, CB.NumOut, DFSInStack); 1715 if (ReproducerModule && DFSInStack.size() > ReproducerCondStack.size()) { 1716 // Add dummy entries to ReproducerCondStack to keep it in sync with 1717 // DFSInStack. 1718 for (unsigned I = 0, 1719 E = (DFSInStack.size() - ReproducerCondStack.size()); 1720 I < E; ++I) { 1721 ReproducerCondStack.emplace_back(ICmpInst::BAD_ICMP_PREDICATE, 1722 nullptr, nullptr); 1723 } 1724 } 1725 }; 1726 1727 ICmpInst::Predicate Pred; 1728 if (!CB.isConditionFact()) { 1729 Value *X; 1730 if (match(CB.Inst, m_Intrinsic<Intrinsic::abs>(m_Value(X)))) { 1731 // TODO: Add CB.Inst >= 0 fact. 1732 AddFact(CmpInst::ICMP_SGE, CB.Inst, X); 1733 continue; 1734 } 1735 1736 if (auto *MinMax = dyn_cast<MinMaxIntrinsic>(CB.Inst)) { 1737 Pred = ICmpInst::getNonStrictPredicate(MinMax->getPredicate()); 1738 AddFact(Pred, MinMax, MinMax->getLHS()); 1739 AddFact(Pred, MinMax, MinMax->getRHS()); 1740 continue; 1741 } 1742 } 1743 1744 Value *A = nullptr, *B = nullptr; 1745 if (CB.isConditionFact()) { 1746 Pred = CB.Cond.Pred; 1747 A = CB.Cond.Op0; 1748 B = CB.Cond.Op1; 1749 if (CB.DoesHold.Pred != CmpInst::BAD_ICMP_PREDICATE && 1750 !Info.doesHold(CB.DoesHold.Pred, CB.DoesHold.Op0, CB.DoesHold.Op1)) { 1751 LLVM_DEBUG({ 1752 dbgs() << "Not adding fact "; 1753 dumpUnpackedICmp(dbgs(), Pred, A, B); 1754 dbgs() << " because precondition "; 1755 dumpUnpackedICmp(dbgs(), CB.DoesHold.Pred, CB.DoesHold.Op0, 1756 CB.DoesHold.Op1); 1757 dbgs() << " does not hold.\n"; 1758 }); 1759 continue; 1760 } 1761 } else { 1762 bool Matched = match(CB.Inst, m_Intrinsic<Intrinsic::assume>( 1763 m_ICmp(Pred, m_Value(A), m_Value(B)))); 1764 (void)Matched; 1765 assert(Matched && "Must have an assume intrinsic with a icmp operand"); 1766 } 1767 AddFact(Pred, A, B); 1768 } 1769 1770 if (ReproducerModule && !ReproducerModule->functions().empty()) { 1771 std::string S; 1772 raw_string_ostream StringS(S); 1773 ReproducerModule->print(StringS, nullptr); 1774 StringS.flush(); 1775 OptimizationRemark Rem(DEBUG_TYPE, "Reproducer", &F); 1776 Rem << ore::NV("module") << S; 1777 ORE.emit(Rem); 1778 } 1779 1780 #ifndef NDEBUG 1781 unsigned SignedEntries = 1782 count_if(DFSInStack, [](const StackEntry &E) { return E.IsSigned; }); 1783 assert(Info.getCS(false).size() - FunctionArgs.size() == 1784 DFSInStack.size() - SignedEntries && 1785 "updates to CS and DFSInStack are out of sync"); 1786 assert(Info.getCS(true).size() == SignedEntries && 1787 "updates to CS and DFSInStack are out of sync"); 1788 #endif 1789 1790 for (Instruction *I : ToRemove) 1791 I->eraseFromParent(); 1792 return Changed; 1793 } 1794 1795 PreservedAnalyses ConstraintEliminationPass::run(Function &F, 1796 FunctionAnalysisManager &AM) { 1797 auto &DT = AM.getResult<DominatorTreeAnalysis>(F); 1798 auto &LI = AM.getResult<LoopAnalysis>(F); 1799 auto &SE = AM.getResult<ScalarEvolutionAnalysis>(F); 1800 auto &ORE = AM.getResult<OptimizationRemarkEmitterAnalysis>(F); 1801 if (!eliminateConstraints(F, DT, LI, SE, ORE)) 1802 return PreservedAnalyses::all(); 1803 1804 PreservedAnalyses PA; 1805 PA.preserve<DominatorTreeAnalysis>(); 1806 PA.preserve<LoopAnalysis>(); 1807 PA.preserve<ScalarEvolutionAnalysis>(); 1808 PA.preserveSet<CFGAnalyses>(); 1809 return PA; 1810 } 1811