lib/Analysis/InstructionSimplify.cpp

   1 //===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements routines for folding instructions into simpler forms
  11 // that do not require creating new instructions.  This does constant folding
  12 // ("add i32 1, 1" -> "2") but can also handle non-constant operands, either
  13 // returning a constant ("and i32 %x, 0" -> "0") or an already existing value
  14 // ("and i32 %x, %x" -> "%x").  All operands are assumed to have already been
  15 // simplified: This is usually true and assuming it simplifies the logic (if
  16 // they have not been simplified then results are correct but maybe suboptimal).
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #include "llvm/Analysis/InstructionSimplify.h"
  21 #include "llvm/ADT/SetVector.h"
  22 #include "llvm/ADT/Statistic.h"
  23 #include "llvm/Analysis/ConstantFolding.h"
  24 #include "llvm/Analysis/MemoryBuiltins.h"
  25 #include "llvm/Analysis/ValueTracking.h"
  26 #include "llvm/IR/ConstantRange.h"
  27 #include "llvm/IR/DataLayout.h"
  28 #include "llvm/IR/Dominators.h"
  29 #include "llvm/IR/GetElementPtrTypeIterator.h"
  30 #include "llvm/IR/GlobalAlias.h"
  31 #include "llvm/IR/Operator.h"
  32 #include "llvm/IR/PatternMatch.h"
  33 #include "llvm/IR/ValueHandle.h"
  34 using namespace llvm;
  35 using namespace llvm::PatternMatch;
  36
  37 #define DEBUG_TYPE "instsimplify"
  38
  39 enum { RecursionLimit = 3 };
  40
  41 STATISTIC(NumExpand,  "Number of expansions");
  42 STATISTIC(NumReassoc, "Number of reassociations");
  43
  44 namespace {
  45 struct Query {
  46   const DataLayout *DL;
  47   const TargetLibraryInfo *TLI;
  48   const DominatorTree *DT;
  49   AssumptionTracker *AT;
  50   const Instruction *CxtI;
  51
  52   Query(const DataLayout *DL, const TargetLibraryInfo *tli,
  53         const DominatorTree *dt, AssumptionTracker *at = nullptr,
  54         const Instruction *cxti = nullptr)
  55     : DL(DL), TLI(tli), DT(dt), AT(at), CxtI(cxti) {}
  56 };
  57 } // end anonymous namespace
  58
  59 static Value *SimplifyAndInst(Value *, Value *, const Query &, unsigned);
  60 static Value *SimplifyBinOp(unsigned, Value *, Value *, const Query &,
  61                             unsigned);
  62 static Value *SimplifyCmpInst(unsigned, Value *, Value *, const Query &,
  63                               unsigned);
  64 static Value *SimplifyOrInst(Value *, Value *, const Query &, unsigned);
  65 static Value *SimplifyXorInst(Value *, Value *, const Query &, unsigned);
  66 static Value *SimplifyTruncInst(Value *, Type *, const Query &, unsigned);
  67
  68 /// getFalse - For a boolean type, or a vector of boolean type, return false, or
  69 /// a vector with every element false, as appropriate for the type.
  70 static Constant *getFalse(Type *Ty) {
  71   assert(Ty->getScalarType()->isIntegerTy(1) &&
  72          "Expected i1 type or a vector of i1!");
  73   return Constant::getNullValue(Ty);
  74 }
  75
  76 /// getTrue - For a boolean type, or a vector of boolean type, return true, or
  77 /// a vector with every element true, as appropriate for the type.
  78 static Constant *getTrue(Type *Ty) {
  79   assert(Ty->getScalarType()->isIntegerTy(1) &&
  80          "Expected i1 type or a vector of i1!");
  81   return Constant::getAllOnesValue(Ty);
  82 }
  83
  84 /// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
  85 static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
  86                           Value *RHS) {
  87   CmpInst *Cmp = dyn_cast<CmpInst>(V);
  88   if (!Cmp)
  89     return false;
  90   CmpInst::Predicate CPred = Cmp->getPredicate();
  91   Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
  92   if (CPred == Pred && CLHS == LHS && CRHS == RHS)
  93     return true;
  94   return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
  95     CRHS == LHS;
  96 }
  97
  98 /// ValueDominatesPHI - Does the given value dominate the specified phi node?
  99 static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
 100   Instruction *I = dyn_cast<Instruction>(V);
 101   if (!I)
 102     // Arguments and constants dominate all instructions.
 103     return true;
 104
 105   // If we are processing instructions (and/or basic blocks) that have not been
 106   // fully added to a function, the parent nodes may still be null. Simply
 107   // return the conservative answer in these cases.
 108   if (!I->getParent() || !P->getParent() || !I->getParent()->getParent())
 109     return false;
 110
 111   // If we have a DominatorTree then do a precise test.
 112   if (DT) {
 113     if (!DT->isReachableFromEntry(P->getParent()))
 114       return true;
 115     if (!DT->isReachableFromEntry(I->getParent()))
 116       return false;
 117     return DT->dominates(I, P);
 118   }
 119
 120   // Otherwise, if the instruction is in the entry block, and is not an invoke,
 121   // then it obviously dominates all phi nodes.
 122   if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
 123       !isa<InvokeInst>(I))
 124     return true;
 125
 126   return false;
 127 }
 128
 129 /// ExpandBinOp - Simplify "A op (B op' C)" by distributing op over op', turning
 130 /// it into "(A op B) op' (A op C)".  Here "op" is given by Opcode and "op'" is
 131 /// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
 132 /// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
 133 /// Returns the simplified value, or null if no simplification was performed.
 134 static Value *ExpandBinOp(unsigned Opcode, Value *LHS, Value *RHS,
 135                           unsigned OpcToExpand, const Query &Q,
 136                           unsigned MaxRecurse) {
 137   Instruction::BinaryOps OpcodeToExpand = (Instruction::BinaryOps)OpcToExpand;
 138   // Recursion is always used, so bail out at once if we already hit the limit.
 139   if (!MaxRecurse--)
 140     return nullptr;
 141
 142   // Check whether the expression has the form "(A op' B) op C".
 143   if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
 144     if (Op0->getOpcode() == OpcodeToExpand) {
 145       // It does!  Try turning it into "(A op C) op' (B op C)".
 146       Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
 147       // Do "A op C" and "B op C" both simplify?
 148       if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
 149         if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
 150           // They do! Return "L op' R" if it simplifies or is already available.
 151           // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
 152           if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
 153                                      && L == B && R == A)) {
 154             ++NumExpand;
 155             return LHS;
 156           }
 157           // Otherwise return "L op' R" if it simplifies.
 158           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
 159             ++NumExpand;
 160             return V;
 161           }
 162         }
 163     }
 164
 165   // Check whether the expression has the form "A op (B op' C)".
 166   if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
 167     if (Op1->getOpcode() == OpcodeToExpand) {
 168       // It does!  Try turning it into "(A op B) op' (A op C)".
 169       Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
 170       // Do "A op B" and "A op C" both simplify?
 171       if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
 172         if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
 173           // They do! Return "L op' R" if it simplifies or is already available.
 174           // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
 175           if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
 176                                      && L == C && R == B)) {
 177             ++NumExpand;
 178             return RHS;
 179           }
 180           // Otherwise return "L op' R" if it simplifies.
 181           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
 182             ++NumExpand;
 183             return V;
 184           }
 185         }
 186     }
 187
 188   return nullptr;
 189 }
 190
 191 /// SimplifyAssociativeBinOp - Generic simplifications for associative binary
 192 /// operations.  Returns the simpler value, or null if none was found.
 193 static Value *SimplifyAssociativeBinOp(unsigned Opc, Value *LHS, Value *RHS,
 194                                        const Query &Q, unsigned MaxRecurse) {
 195   Instruction::BinaryOps Opcode = (Instruction::BinaryOps)Opc;
 196   assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
 197
 198   // Recursion is always used, so bail out at once if we already hit the limit.
 199   if (!MaxRecurse--)
 200     return nullptr;
 201
 202   BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
 203   BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
 204
 205   // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
 206   if (Op0 && Op0->getOpcode() == Opcode) {
 207     Value *A = Op0->getOperand(0);
 208     Value *B = Op0->getOperand(1);
 209     Value *C = RHS;
 210
 211     // Does "B op C" simplify?
 212     if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
 213       // It does!  Return "A op V" if it simplifies or is already available.
 214       // If V equals B then "A op V" is just the LHS.
 215       if (V == B) return LHS;
 216       // Otherwise return "A op V" if it simplifies.
 217       if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
 218         ++NumReassoc;
 219         return W;
 220       }
 221     }
 222   }
 223
 224   // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
 225   if (Op1 && Op1->getOpcode() == Opcode) {
 226     Value *A = LHS;
 227     Value *B = Op1->getOperand(0);
 228     Value *C = Op1->getOperand(1);
 229
 230     // Does "A op B" simplify?
 231     if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
 232       // It does!  Return "V op C" if it simplifies or is already available.
 233       // If V equals B then "V op C" is just the RHS.
 234       if (V == B) return RHS;
 235       // Otherwise return "V op C" if it simplifies.
 236       if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
 237         ++NumReassoc;
 238         return W;
 239       }
 240     }
 241   }
 242
 243   // The remaining transforms require commutativity as well as associativity.
 244   if (!Instruction::isCommutative(Opcode))
 245     return nullptr;
 246
 247   // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
 248   if (Op0 && Op0->getOpcode() == Opcode) {
 249     Value *A = Op0->getOperand(0);
 250     Value *B = Op0->getOperand(1);
 251     Value *C = RHS;
 252
 253     // Does "C op A" simplify?
 254     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
 255       // It does!  Return "V op B" if it simplifies or is already available.
 256       // If V equals A then "V op B" is just the LHS.
 257       if (V == A) return LHS;
 258       // Otherwise return "V op B" if it simplifies.
 259       if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
 260         ++NumReassoc;
 261         return W;
 262       }
 263     }
 264   }
 265
 266   // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
 267   if (Op1 && Op1->getOpcode() == Opcode) {
 268     Value *A = LHS;
 269     Value *B = Op1->getOperand(0);
 270     Value *C = Op1->getOperand(1);
 271
 272     // Does "C op A" simplify?
 273     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
 274       // It does!  Return "B op V" if it simplifies or is already available.
 275       // If V equals C then "B op V" is just the RHS.
 276       if (V == C) return RHS;
 277       // Otherwise return "B op V" if it simplifies.
 278       if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
 279         ++NumReassoc;
 280         return W;
 281       }
 282     }
 283   }
 284
 285   return nullptr;
 286 }
 287
 288 /// ThreadBinOpOverSelect - In the case of a binary operation with a select
 289 /// instruction as an operand, try to simplify the binop by seeing whether
 290 /// evaluating it on both branches of the select results in the same value.
 291 /// Returns the common value if so, otherwise returns null.
 292 static Value *ThreadBinOpOverSelect(unsigned Opcode, Value *LHS, Value *RHS,
 293                                     const Query &Q, unsigned MaxRecurse) {
 294   // Recursion is always used, so bail out at once if we already hit the limit.
 295   if (!MaxRecurse--)
 296     return nullptr;
 297
 298   SelectInst *SI;
 299   if (isa<SelectInst>(LHS)) {
 300     SI = cast<SelectInst>(LHS);
 301   } else {
 302     assert(isa<SelectInst>(RHS) && "No select instruction operand!");
 303     SI = cast<SelectInst>(RHS);
 304   }
 305
 306   // Evaluate the BinOp on the true and false branches of the select.
 307   Value *TV;
 308   Value *FV;
 309   if (SI == LHS) {
 310     TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
 311     FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
 312   } else {
 313     TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
 314     FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
 315   }
 316
 317   // If they simplified to the same value, then return the common value.
 318   // If they both failed to simplify then return null.
 319   if (TV == FV)
 320     return TV;
 321
 322   // If one branch simplified to undef, return the other one.
 323   if (TV && isa<UndefValue>(TV))
 324     return FV;
 325   if (FV && isa<UndefValue>(FV))
 326     return TV;
 327
 328   // If applying the operation did not change the true and false select values,
 329   // then the result of the binop is the select itself.
 330   if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
 331     return SI;
 332
 333   // If one branch simplified and the other did not, and the simplified
 334   // value is equal to the unsimplified one, return the simplified value.
 335   // For example, select (cond, X, X & Z) & Z -> X & Z.
 336   if ((FV && !TV) || (TV && !FV)) {
 337     // Check that the simplified value has the form "X op Y" where "op" is the
 338     // same as the original operation.
 339     Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
 340     if (Simplified && Simplified->getOpcode() == Opcode) {
 341       // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
 342       // We already know that "op" is the same as for the simplified value.  See
 343       // if the operands match too.  If so, return the simplified value.
 344       Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
 345       Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
 346       Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
 347       if (Simplified->getOperand(0) == UnsimplifiedLHS &&
 348           Simplified->getOperand(1) == UnsimplifiedRHS)
 349         return Simplified;
 350       if (Simplified->isCommutative() &&
 351           Simplified->getOperand(1) == UnsimplifiedLHS &&
 352           Simplified->getOperand(0) == UnsimplifiedRHS)
 353         return Simplified;
 354     }
 355   }
 356
 357   return nullptr;
 358 }
 359
 360 /// ThreadCmpOverSelect - In the case of a comparison with a select instruction,
 361 /// try to simplify the comparison by seeing whether both branches of the select
 362 /// result in the same value.  Returns the common value if so, otherwise returns
 363 /// null.
 364 static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
 365                                   Value *RHS, const Query &Q,
 366                                   unsigned MaxRecurse) {
 367   // Recursion is always used, so bail out at once if we already hit the limit.
 368   if (!MaxRecurse--)
 369     return nullptr;
 370
 371   // Make sure the select is on the LHS.
 372   if (!isa<SelectInst>(LHS)) {
 373     std::swap(LHS, RHS);
 374     Pred = CmpInst::getSwappedPredicate(Pred);
 375   }
 376   assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
 377   SelectInst *SI = cast<SelectInst>(LHS);
 378   Value *Cond = SI->getCondition();
 379   Value *TV = SI->getTrueValue();
 380   Value *FV = SI->getFalseValue();
 381
 382   // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
 383   // Does "cmp TV, RHS" simplify?
 384   Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
 385   if (TCmp == Cond) {
 386     // It not only simplified, it simplified to the select condition.  Replace
 387     // it with 'true'.
 388     TCmp = getTrue(Cond->getType());
 389   } else if (!TCmp) {
 390     // It didn't simplify.  However if "cmp TV, RHS" is equal to the select
 391     // condition then we can replace it with 'true'.  Otherwise give up.
 392     if (!isSameCompare(Cond, Pred, TV, RHS))
 393       return nullptr;
 394     TCmp = getTrue(Cond->getType());
 395   }
 396
 397   // Does "cmp FV, RHS" simplify?
 398   Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
 399   if (FCmp == Cond) {
 400     // It not only simplified, it simplified to the select condition.  Replace
 401     // it with 'false'.
 402     FCmp = getFalse(Cond->getType());
 403   } else if (!FCmp) {
 404     // It didn't simplify.  However if "cmp FV, RHS" is equal to the select
 405     // condition then we can replace it with 'false'.  Otherwise give up.
 406     if (!isSameCompare(Cond, Pred, FV, RHS))
 407       return nullptr;
 408     FCmp = getFalse(Cond->getType());
 409   }
 410
 411   // If both sides simplified to the same value, then use it as the result of
 412   // the original comparison.
 413   if (TCmp == FCmp)
 414     return TCmp;
 415
 416   // The remaining cases only make sense if the select condition has the same
 417   // type as the result of the comparison, so bail out if this is not so.
 418   if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
 419     return nullptr;
 420   // If the false value simplified to false, then the result of the compare
 421   // is equal to "Cond && TCmp".  This also catches the case when the false
 422   // value simplified to false and the true value to true, returning "Cond".
 423   if (match(FCmp, m_Zero()))
 424     if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
 425       return V;
 426   // If the true value simplified to true, then the result of the compare
 427   // is equal to "Cond || FCmp".
 428   if (match(TCmp, m_One()))
 429     if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
 430       return V;
 431   // Finally, if the false value simplified to true and the true value to
 432   // false, then the result of the compare is equal to "!Cond".
 433   if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
 434     if (Value *V =
 435         SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
 436                         Q, MaxRecurse))
 437       return V;
 438
 439   return nullptr;
 440 }
 441
 442 /// ThreadBinOpOverPHI - In the case of a binary operation with an operand that
 443 /// is a PHI instruction, try to simplify the binop by seeing whether evaluating
 444 /// it on the incoming phi values yields the same result for every value.  If so
 445 /// returns the common value, otherwise returns null.
 446 static Value *ThreadBinOpOverPHI(unsigned Opcode, Value *LHS, Value *RHS,
 447                                  const Query &Q, unsigned MaxRecurse) {
 448   // Recursion is always used, so bail out at once if we already hit the limit.
 449   if (!MaxRecurse--)
 450     return nullptr;
 451
 452   PHINode *PI;
 453   if (isa<PHINode>(LHS)) {
 454     PI = cast<PHINode>(LHS);
 455     // Bail out if RHS and the phi may be mutually interdependent due to a loop.
 456     if (!ValueDominatesPHI(RHS, PI, Q.DT))
 457       return nullptr;
 458   } else {
 459     assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
 460     PI = cast<PHINode>(RHS);
 461     // Bail out if LHS and the phi may be mutually interdependent due to a loop.
 462     if (!ValueDominatesPHI(LHS, PI, Q.DT))
 463       return nullptr;
 464   }
 465
 466   // Evaluate the BinOp on the incoming phi values.
 467   Value *CommonValue = nullptr;
 468   for (unsigned i = 0, e = PI->getNumIncomingValues(); i != e; ++i) {
 469     Value *Incoming = PI->getIncomingValue(i);
 470     // If the incoming value is the phi node itself, it can safely be skipped.
 471     if (Incoming == PI) continue;
 472     Value *V = PI == LHS ?
 473       SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
 474       SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
 475     // If the operation failed to simplify, or simplified to a different value
 476     // to previously, then give up.
 477     if (!V || (CommonValue && V != CommonValue))
 478       return nullptr;
 479     CommonValue = V;
 480   }
 481
 482   return CommonValue;
 483 }
 484
 485 /// ThreadCmpOverPHI - In the case of a comparison with a PHI instruction, try
 486 /// try to simplify the comparison by seeing whether comparing with all of the
 487 /// incoming phi values yields the same result every time.  If so returns the
 488 /// common result, otherwise returns null.
 489 static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
 490                                const Query &Q, unsigned MaxRecurse) {
 491   // Recursion is always used, so bail out at once if we already hit the limit.
 492   if (!MaxRecurse--)
 493     return nullptr;
 494
 495   // Make sure the phi is on the LHS.
 496   if (!isa<PHINode>(LHS)) {
 497     std::swap(LHS, RHS);
 498     Pred = CmpInst::getSwappedPredicate(Pred);
 499   }
 500   assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
 501   PHINode *PI = cast<PHINode>(LHS);
 502
 503   // Bail out if RHS and the phi may be mutually interdependent due to a loop.
 504   if (!ValueDominatesPHI(RHS, PI, Q.DT))
 505     return nullptr;
 506
 507   // Evaluate the BinOp on the incoming phi values.
 508   Value *CommonValue = nullptr;
 509   for (unsigned i = 0, e = PI->getNumIncomingValues(); i != e; ++i) {
 510     Value *Incoming = PI->getIncomingValue(i);
 511     // If the incoming value is the phi node itself, it can safely be skipped.
 512     if (Incoming == PI) continue;
 513     Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
 514     // If the operation failed to simplify, or simplified to a different value
 515     // to previously, then give up.
 516     if (!V || (CommonValue && V != CommonValue))
 517       return nullptr;
 518     CommonValue = V;
 519   }
 520
 521   return CommonValue;
 522 }
 523
 524 /// SimplifyAddInst - Given operands for an Add, see if we can
 525 /// fold the result.  If not, this returns null.
 526 static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 527                               const Query &Q, unsigned MaxRecurse) {
 528   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
 529     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 530       Constant *Ops[] = { CLHS, CRHS };
 531       return ConstantFoldInstOperands(Instruction::Add, CLHS->getType(), Ops,
 532                                       Q.DL, Q.TLI);
 533     }
 534
 535     // Canonicalize the constant to the RHS.
 536     std::swap(Op0, Op1);
 537   }
 538
 539   // X + undef -> undef
 540   if (match(Op1, m_Undef()))
 541     return Op1;
 542
 543   // X + 0 -> X
 544   if (match(Op1, m_Zero()))
 545     return Op0;
 546
 547   // X + (Y - X) -> Y
 548   // (Y - X) + X -> Y
 549   // Eg: X + -X -> 0
 550   Value *Y = nullptr;
 551   if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
 552       match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
 553     return Y;
 554
 555   // X + ~X -> -1   since   ~X = -X-1
 556   if (match(Op0, m_Not(m_Specific(Op1))) ||
 557       match(Op1, m_Not(m_Specific(Op0))))
 558     return Constant::getAllOnesValue(Op0->getType());
 559
 560   /// i1 add -> xor.
 561   if (MaxRecurse && Op0->getType()->isIntegerTy(1))
 562     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
 563       return V;
 564
 565   // Try some generic simplifications for associative operations.
 566   if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
 567                                           MaxRecurse))
 568     return V;
 569
 570   // Threading Add over selects and phi nodes is pointless, so don't bother.
 571   // Threading over the select in "A + select(cond, B, C)" means evaluating
 572   // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
 573   // only if B and C are equal.  If B and C are equal then (since we assume
 574   // that operands have already been simplified) "select(cond, B, C)" should
 575   // have been simplified to the common value of B and C already.  Analysing
 576   // "A+B" and "A+C" thus gains nothing, but costs compile time.  Similarly
 577   // for threading over phi nodes.
 578
 579   return nullptr;
 580 }
 581
 582 Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 583                              const DataLayout *DL, const TargetLibraryInfo *TLI,
 584                              const DominatorTree *DT, AssumptionTracker *AT,
 585                              const Instruction *CxtI) {
 586   return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW,
 587                            Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
 588 }
 589
 590 /// \brief Compute the base pointer and cumulative constant offsets for V.
 591 ///
 592 /// This strips all constant offsets off of V, leaving it the base pointer, and
 593 /// accumulates the total constant offset applied in the returned constant. It
 594 /// returns 0 if V is not a pointer, and returns the constant '0' if there are
 595 /// no constant offsets applied.
 596 ///
 597 /// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
 598 /// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
 599 /// folding.
 600 static Constant *stripAndComputeConstantOffsets(const DataLayout *DL,
 601                                                 Value *&V,
 602                                                 bool AllowNonInbounds = false) {
 603   assert(V->getType()->getScalarType()->isPointerTy());
 604
 605   // Without DataLayout, just be conservative for now. Theoretically, more could
 606   // be done in this case.
 607   if (!DL)
 608     return ConstantInt::get(IntegerType::get(V->getContext(), 64), 0);
 609
 610   Type *IntPtrTy = DL->getIntPtrType(V->getType())->getScalarType();
 611   APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
 612
 613   // Even though we don't look through PHI nodes, we could be called on an
 614   // instruction in an unreachable block, which may be on a cycle.
 615   SmallPtrSet<Value *, 4> Visited;
 616   Visited.insert(V);
 617   do {
 618     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 619       if ((!AllowNonInbounds && !GEP->isInBounds()) ||
 620           !GEP->accumulateConstantOffset(*DL, Offset))
 621         break;
 622       V = GEP->getPointerOperand();
 623     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 624       V = cast<Operator>(V)->getOperand(0);
 625     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
 626       if (GA->mayBeOverridden())
 627         break;
 628       V = GA->getAliasee();
 629     } else {
 630       break;
 631     }
 632     assert(V->getType()->getScalarType()->isPointerTy() &&
 633            "Unexpected operand type!");
 634   } while (Visited.insert(V));
 635
 636   Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
 637   if (V->getType()->isVectorTy())
 638     return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
 639                                     OffsetIntPtr);
 640   return OffsetIntPtr;
 641 }
 642
 643 /// \brief Compute the constant difference between two pointer values.
 644 /// If the difference is not a constant, returns zero.
 645 static Constant *computePointerDifference(const DataLayout *DL,
 646                                           Value *LHS, Value *RHS) {
 647   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
 648   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
 649
 650   // If LHS and RHS are not related via constant offsets to the same base
 651   // value, there is nothing we can do here.
 652   if (LHS != RHS)
 653     return nullptr;
 654
 655   // Otherwise, the difference of LHS - RHS can be computed as:
 656   //    LHS - RHS
 657   //  = (LHSOffset + Base) - (RHSOffset + Base)
 658   //  = LHSOffset - RHSOffset
 659   return ConstantExpr::getSub(LHSOffset, RHSOffset);
 660 }
 661
 662 /// SimplifySubInst - Given operands for a Sub, see if we can
 663 /// fold the result.  If not, this returns null.
 664 static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 665                               const Query &Q, unsigned MaxRecurse) {
 666   if (Constant *CLHS = dyn_cast<Constant>(Op0))
 667     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 668       Constant *Ops[] = { CLHS, CRHS };
 669       return ConstantFoldInstOperands(Instruction::Sub, CLHS->getType(),
 670                                       Ops, Q.DL, Q.TLI);
 671     }
 672
 673   // X - undef -> undef
 674   // undef - X -> undef
 675   if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
 676     return UndefValue::get(Op0->getType());
 677
 678   // X - 0 -> X
 679   if (match(Op1, m_Zero()))
 680     return Op0;
 681
 682   // X - X -> 0
 683   if (Op0 == Op1)
 684     return Constant::getNullValue(Op0->getType());
 685
 686   // X - (0 - Y) -> X if the second sub is NUW.
 687   // If Y != 0, 0 - Y is a poison value.
 688   // If Y == 0, 0 - Y simplifies to 0.
 689   if (BinaryOperator::isNeg(Op1)) {
 690     if (const auto *BO = dyn_cast<BinaryOperator>(Op1)) {
 691       assert(BO->getOpcode() == Instruction::Sub &&
 692              "Expected a subtraction operator!");
 693       if (BO->hasNoUnsignedWrap())
 694         return Op0;
 695     }
 696   }
 697
 698   // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
 699   // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
 700   Value *X = nullptr, *Y = nullptr, *Z = Op1;
 701   if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
 702     // See if "V === Y - Z" simplifies.
 703     if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
 704       // It does!  Now see if "X + V" simplifies.
 705       if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
 706         // It does, we successfully reassociated!
 707         ++NumReassoc;
 708         return W;
 709       }
 710     // See if "V === X - Z" simplifies.
 711     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
 712       // It does!  Now see if "Y + V" simplifies.
 713       if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
 714         // It does, we successfully reassociated!
 715         ++NumReassoc;
 716         return W;
 717       }
 718   }
 719
 720   // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
 721   // For example, X - (X + 1) -> -1
 722   X = Op0;
 723   if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
 724     // See if "V === X - Y" simplifies.
 725     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
 726       // It does!  Now see if "V - Z" simplifies.
 727       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
 728         // It does, we successfully reassociated!
 729         ++NumReassoc;
 730         return W;
 731       }
 732     // See if "V === X - Z" simplifies.
 733     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
 734       // It does!  Now see if "V - Y" simplifies.
 735       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
 736         // It does, we successfully reassociated!
 737         ++NumReassoc;
 738         return W;
 739       }
 740   }
 741
 742   // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
 743   // For example, X - (X - Y) -> Y.
 744   Z = Op0;
 745   if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
 746     // See if "V === Z - X" simplifies.
 747     if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
 748       // It does!  Now see if "V + Y" simplifies.
 749       if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
 750         // It does, we successfully reassociated!
 751         ++NumReassoc;
 752         return W;
 753       }
 754
 755   // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
 756   if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
 757       match(Op1, m_Trunc(m_Value(Y))))
 758     if (X->getType() == Y->getType())
 759       // See if "V === X - Y" simplifies.
 760       if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
 761         // It does!  Now see if "trunc V" simplifies.
 762         if (Value *W = SimplifyTruncInst(V, Op0->getType(), Q, MaxRecurse-1))
 763           // It does, return the simplified "trunc V".
 764           return W;
 765
 766   // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
 767   if (match(Op0, m_PtrToInt(m_Value(X))) &&
 768       match(Op1, m_PtrToInt(m_Value(Y))))
 769     if (Constant *Result = computePointerDifference(Q.DL, X, Y))
 770       return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
 771
 772   // i1 sub -> xor.
 773   if (MaxRecurse && Op0->getType()->isIntegerTy(1))
 774     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
 775       return V;
 776
 777   // Threading Sub over selects and phi nodes is pointless, so don't bother.
 778   // Threading over the select in "A - select(cond, B, C)" means evaluating
 779   // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
 780   // only if B and C are equal.  If B and C are equal then (since we assume
 781   // that operands have already been simplified) "select(cond, B, C)" should
 782   // have been simplified to the common value of B and C already.  Analysing
 783   // "A-B" and "A-C" thus gains nothing, but costs compile time.  Similarly
 784   // for threading over phi nodes.
 785
 786   return nullptr;
 787 }
 788
 789 Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 790                              const DataLayout *DL, const TargetLibraryInfo *TLI,
 791                              const DominatorTree *DT, AssumptionTracker *AT,
 792                              const Instruction *CxtI) {
 793   return ::SimplifySubInst(Op0, Op1, isNSW, isNUW,
 794                            Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
 795 }
 796
 797 /// Given operands for an FAdd, see if we can fold the result.  If not, this
 798 /// returns null.
 799 static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
 800                               const Query &Q, unsigned MaxRecurse) {
 801   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
 802     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 803       Constant *Ops[] = { CLHS, CRHS };
 804       return ConstantFoldInstOperands(Instruction::FAdd, CLHS->getType(),
 805                                       Ops, Q.DL, Q.TLI);
 806     }
 807
 808     // Canonicalize the constant to the RHS.
 809     std::swap(Op0, Op1);
 810   }
 811
 812   // fadd X, -0 ==> X
 813   if (match(Op1, m_NegZero()))
 814     return Op0;
 815
 816   // fadd X, 0 ==> X, when we know X is not -0
 817   if (match(Op1, m_Zero()) &&
 818       (FMF.noSignedZeros() || CannotBeNegativeZero(Op0)))
 819     return Op0;
 820
 821   // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
 822   //   where nnan and ninf have to occur at least once somewhere in this
 823   //   expression
 824   Value *SubOp = nullptr;
 825   if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
 826     SubOp = Op1;
 827   else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
 828     SubOp = Op0;
 829   if (SubOp) {
 830     Instruction *FSub = cast<Instruction>(SubOp);
 831     if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
 832         (FMF.noInfs() || FSub->hasNoInfs()))
 833       return Constant::getNullValue(Op0->getType());
 834   }
 835
 836   return nullptr;
 837 }
 838
 839 /// Given operands for an FSub, see if we can fold the result.  If not, this
 840 /// returns null.
 841 static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
 842                               const Query &Q, unsigned MaxRecurse) {
 843   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
 844     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 845       Constant *Ops[] = { CLHS, CRHS };
 846       return ConstantFoldInstOperands(Instruction::FSub, CLHS->getType(),
 847                                       Ops, Q.DL, Q.TLI);
 848     }
 849   }
 850
 851   // fsub X, 0 ==> X
 852   if (match(Op1, m_Zero()))
 853     return Op0;
 854
 855   // fsub X, -0 ==> X, when we know X is not -0
 856   if (match(Op1, m_NegZero()) &&
 857       (FMF.noSignedZeros() || CannotBeNegativeZero(Op0)))
 858     return Op0;
 859
 860   // fsub 0, (fsub -0.0, X) ==> X
 861   Value *X;
 862   if (match(Op0, m_AnyZero())) {
 863     if (match(Op1, m_FSub(m_NegZero(), m_Value(X))))
 864       return X;
 865     if (FMF.noSignedZeros() && match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
 866       return X;
 867   }
 868
 869   // fsub nnan ninf x, x ==> 0.0
 870   if (FMF.noNaNs() && FMF.noInfs() && Op0 == Op1)
 871     return Constant::getNullValue(Op0->getType());
 872
 873   return nullptr;
 874 }
 875
 876 /// Given the operands for an FMul, see if we can fold the result
 877 static Value *SimplifyFMulInst(Value *Op0, Value *Op1,
 878                                FastMathFlags FMF,
 879                                const Query &Q,
 880                                unsigned MaxRecurse) {
 881  if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
 882     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 883       Constant *Ops[] = { CLHS, CRHS };
 884       return ConstantFoldInstOperands(Instruction::FMul, CLHS->getType(),
 885                                       Ops, Q.DL, Q.TLI);
 886     }
 887
 888     // Canonicalize the constant to the RHS.
 889     std::swap(Op0, Op1);
 890  }
 891
 892  // fmul X, 1.0 ==> X
 893  if (match(Op1, m_FPOne()))
 894    return Op0;
 895
 896  // fmul nnan nsz X, 0 ==> 0
 897  if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
 898    return Op1;
 899
 900  return nullptr;
 901 }
 902
 903 /// SimplifyMulInst - Given operands for a Mul, see if we can
 904 /// fold the result.  If not, this returns null.
 905 static Value *SimplifyMulInst(Value *Op0, Value *Op1, const Query &Q,
 906                               unsigned MaxRecurse) {
 907   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
 908     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 909       Constant *Ops[] = { CLHS, CRHS };
 910       return ConstantFoldInstOperands(Instruction::Mul, CLHS->getType(),
 911                                       Ops, Q.DL, Q.TLI);
 912     }
 913
 914     // Canonicalize the constant to the RHS.
 915     std::swap(Op0, Op1);
 916   }
 917
 918   // X * undef -> 0
 919   if (match(Op1, m_Undef()))
 920     return Constant::getNullValue(Op0->getType());
 921
 922   // X * 0 -> 0
 923   if (match(Op1, m_Zero()))
 924     return Op1;
 925
 926   // X * 1 -> X
 927   if (match(Op1, m_One()))
 928     return Op0;
 929
 930   // (X / Y) * Y -> X if the division is exact.
 931   Value *X = nullptr;
 932   if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
 933       match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0)))))   // Y * (X / Y)
 934     return X;
 935
 936   // i1 mul -> and.
 937   if (MaxRecurse && Op0->getType()->isIntegerTy(1))
 938     if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
 939       return V;
 940
 941   // Try some generic simplifications for associative operations.
 942   if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
 943                                           MaxRecurse))
 944     return V;
 945
 946   // Mul distributes over Add.  Try some generic simplifications based on this.
 947   if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
 948                              Q, MaxRecurse))
 949     return V;
 950
 951   // If the operation is with the result of a select instruction, check whether
 952   // operating on either branch of the select always yields the same value.
 953   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
 954     if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
 955                                          MaxRecurse))
 956       return V;
 957
 958   // If the operation is with the result of a phi instruction, check whether
 959   // operating on all incoming values of the phi always yields the same value.
 960   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
 961     if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
 962                                       MaxRecurse))
 963       return V;
 964
 965   return nullptr;
 966 }
 967
 968 Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
 969                              const DataLayout *DL, const TargetLibraryInfo *TLI,
 970                              const DominatorTree *DT, AssumptionTracker *AT,
 971                              const Instruction *CxtI) {
 972   return ::SimplifyFAddInst(Op0, Op1, FMF, Query (DL, TLI, DT, AT, CxtI),
 973                             RecursionLimit);
 974 }
 975
 976 Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
 977                              const DataLayout *DL, const TargetLibraryInfo *TLI,
 978                              const DominatorTree *DT, AssumptionTracker *AT,
 979                              const Instruction *CxtI) {
 980   return ::SimplifyFSubInst(Op0, Op1, FMF, Query (DL, TLI, DT, AT, CxtI),
 981                             RecursionLimit);
 982 }
 983
 984 Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1,
 985                               FastMathFlags FMF,
 986                               const DataLayout *DL,
 987                               const TargetLibraryInfo *TLI,
 988                               const DominatorTree *DT,
 989                               AssumptionTracker *AT,
 990                               const Instruction *CxtI) {
 991   return ::SimplifyFMulInst(Op0, Op1, FMF, Query (DL, TLI, DT, AT, CxtI),
 992                             RecursionLimit);
 993 }
 994
 995 Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const DataLayout *DL,
 996                              const TargetLibraryInfo *TLI,
 997                              const DominatorTree *DT, AssumptionTracker *AT,
 998                              const Instruction *CxtI) {
 999   return ::SimplifyMulInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1000                            RecursionLimit);
1001 }
1002
1003 /// SimplifyDiv - Given operands for an SDiv or UDiv, see if we can
1004 /// fold the result.  If not, this returns null.
1005 static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1006                           const Query &Q, unsigned MaxRecurse) {
1007   if (Constant *C0 = dyn_cast<Constant>(Op0)) {
1008     if (Constant *C1 = dyn_cast<Constant>(Op1)) {
1009       Constant *Ops[] = { C0, C1 };
1010       return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, Q.DL, Q.TLI);
1011     }
1012   }
1013
1014   bool isSigned = Opcode == Instruction::SDiv;
1015
1016   // X / undef -> undef
1017   if (match(Op1, m_Undef()))
1018     return Op1;
1019
1020   // undef / X -> 0
1021   if (match(Op0, m_Undef()))
1022     return Constant::getNullValue(Op0->getType());
1023
1024   // 0 / X -> 0, we don't need to preserve faults!
1025   if (match(Op0, m_Zero()))
1026     return Op0;
1027
1028   // X / 1 -> X
1029   if (match(Op1, m_One()))
1030     return Op0;
1031
1032   if (Op0->getType()->isIntegerTy(1))
1033     // It can't be division by zero, hence it must be division by one.
1034     return Op0;
1035
1036   // X / X -> 1
1037   if (Op0 == Op1)
1038     return ConstantInt::get(Op0->getType(), 1);
1039
1040   // (X * Y) / Y -> X if the multiplication does not overflow.
1041   Value *X = nullptr, *Y = nullptr;
1042   if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
1043     if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
1044     OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
1045     // If the Mul knows it does not overflow, then we are good to go.
1046     if ((isSigned && Mul->hasNoSignedWrap()) ||
1047         (!isSigned && Mul->hasNoUnsignedWrap()))
1048       return X;
1049     // If X has the form X = A / Y then X * Y cannot overflow.
1050     if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
1051       if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
1052         return X;
1053   }
1054
1055   // (X rem Y) / Y -> 0
1056   if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1057       (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1058     return Constant::getNullValue(Op0->getType());
1059
1060   // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1061   ConstantInt *C1, *C2;
1062   if (!isSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1063       match(Op1, m_ConstantInt(C2))) {
1064     bool Overflow;
1065     C1->getValue().umul_ov(C2->getValue(), Overflow);
1066     if (Overflow)
1067       return Constant::getNullValue(Op0->getType());
1068   }
1069
1070   // If the operation is with the result of a select instruction, check whether
1071   // operating on either branch of the select always yields the same value.
1072   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1073     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1074       return V;
1075
1076   // If the operation is with the result of a phi instruction, check whether
1077   // operating on all incoming values of the phi always yields the same value.
1078   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1079     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1080       return V;
1081
1082   return nullptr;
1083 }
1084
1085 /// SimplifySDivInst - Given operands for an SDiv, see if we can
1086 /// fold the result.  If not, this returns null.
1087 static Value *SimplifySDivInst(Value *Op0, Value *Op1, const Query &Q,
1088                                unsigned MaxRecurse) {
1089   if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse))
1090     return V;
1091
1092   return nullptr;
1093 }
1094
1095 Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const DataLayout *DL,
1096                               const TargetLibraryInfo *TLI,
1097                               const DominatorTree *DT,
1098                               AssumptionTracker *AT,
1099                               const Instruction *CxtI) {
1100   return ::SimplifySDivInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1101                             RecursionLimit);
1102 }
1103
1104 /// SimplifyUDivInst - Given operands for a UDiv, see if we can
1105 /// fold the result.  If not, this returns null.
1106 static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const Query &Q,
1107                                unsigned MaxRecurse) {
1108   if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse))
1109     return V;
1110
1111   return nullptr;
1112 }
1113
1114 Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const DataLayout *DL,
1115                               const TargetLibraryInfo *TLI,
1116                               const DominatorTree *DT,
1117                               AssumptionTracker *AT,
1118                               const Instruction *CxtI) {
1119   return ::SimplifyUDivInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1120                             RecursionLimit);
1121 }
1122
1123 static Value *SimplifyFDivInst(Value *Op0, Value *Op1, const Query &Q,
1124                                unsigned) {
1125   // undef / X -> undef    (the undef could be a snan).
1126   if (match(Op0, m_Undef()))
1127     return Op0;
1128
1129   // X / undef -> undef
1130   if (match(Op1, m_Undef()))
1131     return Op1;
1132
1133   return nullptr;
1134 }
1135
1136 Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, const DataLayout *DL,
1137                               const TargetLibraryInfo *TLI,
1138                               const DominatorTree *DT,
1139                               AssumptionTracker *AT,
1140                               const Instruction *CxtI) {
1141   return ::SimplifyFDivInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1142                             RecursionLimit);
1143 }
1144
1145 /// SimplifyRem - Given operands for an SRem or URem, see if we can
1146 /// fold the result.  If not, this returns null.
1147 static Value *SimplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1148                           const Query &Q, unsigned MaxRecurse) {
1149   if (Constant *C0 = dyn_cast<Constant>(Op0)) {
1150     if (Constant *C1 = dyn_cast<Constant>(Op1)) {
1151       Constant *Ops[] = { C0, C1 };
1152       return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, Q.DL, Q.TLI);
1153     }
1154   }
1155
1156   // X % undef -> undef
1157   if (match(Op1, m_Undef()))
1158     return Op1;
1159
1160   // undef % X -> 0
1161   if (match(Op0, m_Undef()))
1162     return Constant::getNullValue(Op0->getType());
1163
1164   // 0 % X -> 0, we don't need to preserve faults!
1165   if (match(Op0, m_Zero()))
1166     return Op0;
1167
1168   // X % 0 -> undef, we don't need to preserve faults!
1169   if (match(Op1, m_Zero()))
1170     return UndefValue::get(Op0->getType());
1171
1172   // X % 1 -> 0
1173   if (match(Op1, m_One()))
1174     return Constant::getNullValue(Op0->getType());
1175
1176   if (Op0->getType()->isIntegerTy(1))
1177     // It can't be remainder by zero, hence it must be remainder by one.
1178     return Constant::getNullValue(Op0->getType());
1179
1180   // X % X -> 0
1181   if (Op0 == Op1)
1182     return Constant::getNullValue(Op0->getType());
1183
1184   // (X % Y) % Y -> X % Y
1185   if ((Opcode == Instruction::SRem &&
1186        match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1187       (Opcode == Instruction::URem &&
1188        match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1189     return Op0;
1190
1191   // If the operation is with the result of a select instruction, check whether
1192   // operating on either branch of the select always yields the same value.
1193   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1194     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1195       return V;
1196
1197   // If the operation is with the result of a phi instruction, check whether
1198   // operating on all incoming values of the phi always yields the same value.
1199   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1200     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1201       return V;
1202
1203   return nullptr;
1204 }
1205
1206 /// SimplifySRemInst - Given operands for an SRem, see if we can
1207 /// fold the result.  If not, this returns null.
1208 static Value *SimplifySRemInst(Value *Op0, Value *Op1, const Query &Q,
1209                                unsigned MaxRecurse) {
1210   if (Value *V = SimplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse))
1211     return V;
1212
1213   return nullptr;
1214 }
1215
1216 Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const DataLayout *DL,
1217                               const TargetLibraryInfo *TLI,
1218                               const DominatorTree *DT,
1219                               AssumptionTracker *AT,
1220                               const Instruction *CxtI) {
1221   return ::SimplifySRemInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1222                             RecursionLimit);
1223 }
1224
1225 /// SimplifyURemInst - Given operands for a URem, see if we can
1226 /// fold the result.  If not, this returns null.
1227 static Value *SimplifyURemInst(Value *Op0, Value *Op1, const Query &Q,
1228                                unsigned MaxRecurse) {
1229   if (Value *V = SimplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse))
1230     return V;
1231
1232   return nullptr;
1233 }
1234
1235 Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const DataLayout *DL,
1236                               const TargetLibraryInfo *TLI,
1237                               const DominatorTree *DT,
1238                               AssumptionTracker *AT,
1239                               const Instruction *CxtI) {
1240   return ::SimplifyURemInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1241                             RecursionLimit);
1242 }
1243
1244 static Value *SimplifyFRemInst(Value *Op0, Value *Op1, const Query &,
1245                                unsigned) {
1246   // undef % X -> undef    (the undef could be a snan).
1247   if (match(Op0, m_Undef()))
1248     return Op0;
1249
1250   // X % undef -> undef
1251   if (match(Op1, m_Undef()))
1252     return Op1;
1253
1254   return nullptr;
1255 }
1256
1257 Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, const DataLayout *DL,
1258                               const TargetLibraryInfo *TLI,
1259                               const DominatorTree *DT,
1260                               AssumptionTracker *AT,
1261                               const Instruction *CxtI) {
1262   return ::SimplifyFRemInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1263                             RecursionLimit);
1264 }
1265
1266 /// isUndefShift - Returns true if a shift by \c Amount always yields undef.
1267 static bool isUndefShift(Value *Amount) {
1268   Constant *C = dyn_cast<Constant>(Amount);
1269   if (!C)
1270     return false;
1271
1272   // X shift by undef -> undef because it may shift by the bitwidth.
1273   if (isa<UndefValue>(C))
1274     return true;
1275
1276   // Shifting by the bitwidth or more is undefined.
1277   if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1278     if (CI->getValue().getLimitedValue() >=
1279         CI->getType()->getScalarSizeInBits())
1280       return true;
1281
1282   // If all lanes of a vector shift are undefined the whole shift is.
1283   if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1284     for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1285       if (!isUndefShift(C->getAggregateElement(I)))
1286         return false;
1287     return true;
1288   }
1289
1290   return false;
1291 }
1292
1293 /// SimplifyShift - Given operands for an Shl, LShr or AShr, see if we can
1294 /// fold the result.  If not, this returns null.
1295 static Value *SimplifyShift(unsigned Opcode, Value *Op0, Value *Op1,
1296                             const Query &Q, unsigned MaxRecurse) {
1297   if (Constant *C0 = dyn_cast<Constant>(Op0)) {
1298     if (Constant *C1 = dyn_cast<Constant>(Op1)) {
1299       Constant *Ops[] = { C0, C1 };
1300       return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, Q.DL, Q.TLI);
1301     }
1302   }
1303
1304   // 0 shift by X -> 0
1305   if (match(Op0, m_Zero()))
1306     return Op0;
1307
1308   // X shift by 0 -> X
1309   if (match(Op1, m_Zero()))
1310     return Op0;
1311
1312   // Fold undefined shifts.
1313   if (isUndefShift(Op1))
1314     return UndefValue::get(Op0->getType());
1315
1316   // If the operation is with the result of a select instruction, check whether
1317   // operating on either branch of the select always yields the same value.
1318   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1319     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1320       return V;
1321
1322   // If the operation is with the result of a phi instruction, check whether
1323   // operating on all incoming values of the phi always yields the same value.
1324   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1325     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1326       return V;
1327
1328   return nullptr;
1329 }
1330
1331 /// SimplifyShlInst - Given operands for an Shl, see if we can
1332 /// fold the result.  If not, this returns null.
1333 static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1334                               const Query &Q, unsigned MaxRecurse) {
1335   if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
1336     return V;
1337
1338   // undef << X -> 0
1339   if (match(Op0, m_Undef()))
1340     return Constant::getNullValue(Op0->getType());
1341
1342   // (X >> A) << A -> X
1343   Value *X;
1344   if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
1345     return X;
1346   return nullptr;
1347 }
1348
1349 Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1350                              const DataLayout *DL, const TargetLibraryInfo *TLI,
1351                              const DominatorTree *DT, AssumptionTracker *AT,
1352                              const Instruction *CxtI) {
1353   return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Query (DL, TLI, DT, AT, CxtI),
1354                            RecursionLimit);
1355 }
1356
1357 /// SimplifyLShrInst - Given operands for an LShr, see if we can
1358 /// fold the result.  If not, this returns null.
1359 static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1360                                const Query &Q, unsigned MaxRecurse) {
1361   if (Value *V = SimplifyShift(Instruction::LShr, Op0, Op1, Q, MaxRecurse))
1362     return V;
1363
1364   // X >> X -> 0
1365   if (Op0 == Op1)
1366     return Constant::getNullValue(Op0->getType());
1367
1368   // undef >>l X -> 0
1369   if (match(Op0, m_Undef()))
1370     return Constant::getNullValue(Op0->getType());
1371
1372   // (X << A) >> A -> X
1373   Value *X;
1374   if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
1375     return X;
1376
1377   return nullptr;
1378 }
1379
1380 Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1381                               const DataLayout *DL,
1382                               const TargetLibraryInfo *TLI,
1383                               const DominatorTree *DT,
1384                               AssumptionTracker *AT,
1385                               const Instruction *CxtI) {
1386   return ::SimplifyLShrInst(Op0, Op1, isExact, Query (DL, TLI, DT, AT, CxtI),
1387                             RecursionLimit);
1388 }
1389
1390 /// SimplifyAShrInst - Given operands for an AShr, see if we can
1391 /// fold the result.  If not, this returns null.
1392 static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1393                                const Query &Q, unsigned MaxRecurse) {
1394   if (Value *V = SimplifyShift(Instruction::AShr, Op0, Op1, Q, MaxRecurse))
1395     return V;
1396
1397   // X >> X -> 0
1398   if (Op0 == Op1)
1399     return Constant::getNullValue(Op0->getType());
1400
1401   // all ones >>a X -> all ones
1402   if (match(Op0, m_AllOnes()))
1403     return Op0;
1404
1405   // undef >>a X -> all ones
1406   if (match(Op0, m_Undef()))
1407     return Constant::getAllOnesValue(Op0->getType());
1408
1409   // (X << A) >> A -> X
1410   Value *X;
1411   if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
1412     return X;
1413
1414   // Arithmetic shifting an all-sign-bit value is a no-op.
1415   unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AT, Q.CxtI, Q.DT);
1416   if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1417     return Op0;
1418
1419   return nullptr;
1420 }
1421
1422 Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1423                               const DataLayout *DL,
1424                               const TargetLibraryInfo *TLI,
1425                               const DominatorTree *DT,
1426                               AssumptionTracker *AT,
1427                               const Instruction *CxtI) {
1428   return ::SimplifyAShrInst(Op0, Op1, isExact, Query (DL, TLI, DT, AT, CxtI),
1429                             RecursionLimit);
1430 }
1431
1432 // Simplify (and (icmp ...) (icmp ...)) to true when we can tell that the range
1433 // of possible values cannot be satisfied.
1434 static Value *SimplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1435   ICmpInst::Predicate Pred0, Pred1;
1436   ConstantInt *CI1, *CI2;
1437   Value *V;
1438   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_ConstantInt(CI1)),
1439                          m_ConstantInt(CI2))))
1440    return nullptr;
1441
1442   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Specific(CI1))))
1443     return nullptr;
1444
1445   Type *ITy = Op0->getType();
1446
1447   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1448   bool isNSW = AddInst->hasNoSignedWrap();
1449   bool isNUW = AddInst->hasNoUnsignedWrap();
1450
1451   const APInt &CI1V = CI1->getValue();
1452   const APInt &CI2V = CI2->getValue();
1453   const APInt Delta = CI2V - CI1V;
1454   if (CI1V.isStrictlyPositive()) {
1455     if (Delta == 2) {
1456       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1457         return getFalse(ITy);
1458       if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1459         return getFalse(ITy);
1460     }
1461     if (Delta == 1) {
1462       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1463         return getFalse(ITy);
1464       if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1465         return getFalse(ITy);
1466     }
1467   }
1468   if (CI1V.getBoolValue() && isNUW) {
1469     if (Delta == 2)
1470       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1471         return getFalse(ITy);
1472     if (Delta == 1)
1473       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1474         return getFalse(ITy);
1475   }
1476
1477   return nullptr;
1478 }
1479
1480 /// SimplifyAndInst - Given operands for an And, see if we can
1481 /// fold the result.  If not, this returns null.
1482 static Value *SimplifyAndInst(Value *Op0, Value *Op1, const Query &Q,
1483                               unsigned MaxRecurse) {
1484   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1485     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1486       Constant *Ops[] = { CLHS, CRHS };
1487       return ConstantFoldInstOperands(Instruction::And, CLHS->getType(),
1488                                       Ops, Q.DL, Q.TLI);
1489     }
1490
1491     // Canonicalize the constant to the RHS.
1492     std::swap(Op0, Op1);
1493   }
1494
1495   // X & undef -> 0
1496   if (match(Op1, m_Undef()))
1497     return Constant::getNullValue(Op0->getType());
1498
1499   // X & X = X
1500   if (Op0 == Op1)
1501     return Op0;
1502
1503   // X & 0 = 0
1504   if (match(Op1, m_Zero()))
1505     return Op1;
1506
1507   // X & -1 = X
1508   if (match(Op1, m_AllOnes()))
1509     return Op0;
1510
1511   // A & ~A  =  ~A & A  =  0
1512   if (match(Op0, m_Not(m_Specific(Op1))) ||
1513       match(Op1, m_Not(m_Specific(Op0))))
1514     return Constant::getNullValue(Op0->getType());
1515
1516   // (A | ?) & A = A
1517   Value *A = nullptr, *B = nullptr;
1518   if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
1519       (A == Op1 || B == Op1))
1520     return Op1;
1521
1522   // A & (A | ?) = A
1523   if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
1524       (A == Op0 || B == Op0))
1525     return Op0;
1526
1527   // A & (-A) = A if A is a power of two or zero.
1528   if (match(Op0, m_Neg(m_Specific(Op1))) ||
1529       match(Op1, m_Neg(m_Specific(Op0)))) {
1530     if (isKnownToBeAPowerOfTwo(Op0, /*OrZero*/true, 0, Q.AT, Q.CxtI, Q.DT))
1531       return Op0;
1532     if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/true, 0, Q.AT, Q.CxtI, Q.DT))
1533       return Op1;
1534   }
1535
1536   if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1537     if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1538       if (Value *V = SimplifyAndOfICmps(ICILHS, ICIRHS))
1539         return V;
1540       if (Value *V = SimplifyAndOfICmps(ICIRHS, ICILHS))
1541         return V;
1542     }
1543   }
1544
1545   // Try some generic simplifications for associative operations.
1546   if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1547                                           MaxRecurse))
1548     return V;
1549
1550   // And distributes over Or.  Try some generic simplifications based on this.
1551   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
1552                              Q, MaxRecurse))
1553     return V;
1554
1555   // And distributes over Xor.  Try some generic simplifications based on this.
1556   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
1557                              Q, MaxRecurse))
1558     return V;
1559
1560   // If the operation is with the result of a select instruction, check whether
1561   // operating on either branch of the select always yields the same value.
1562   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1563     if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1564                                          MaxRecurse))
1565       return V;
1566
1567   // If the operation is with the result of a phi instruction, check whether
1568   // operating on all incoming values of the phi always yields the same value.
1569   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1570     if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
1571                                       MaxRecurse))
1572       return V;
1573
1574   return nullptr;
1575 }
1576
1577 Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const DataLayout *DL,
1578                              const TargetLibraryInfo *TLI,
1579                              const DominatorTree *DT, AssumptionTracker *AT,
1580                              const Instruction *CxtI) {
1581   return ::SimplifyAndInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1582                            RecursionLimit);
1583 }
1584
1585 // Simplify (or (icmp ...) (icmp ...)) to true when we can tell that the union
1586 // contains all possible values.
1587 static Value *SimplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1588   ICmpInst::Predicate Pred0, Pred1;
1589   ConstantInt *CI1, *CI2;
1590   Value *V;
1591   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_ConstantInt(CI1)),
1592                          m_ConstantInt(CI2))))
1593    return nullptr;
1594
1595   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Specific(CI1))))
1596     return nullptr;
1597
1598   Type *ITy = Op0->getType();
1599
1600   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1601   bool isNSW = AddInst->hasNoSignedWrap();
1602   bool isNUW = AddInst->hasNoUnsignedWrap();
1603
1604   const APInt &CI1V = CI1->getValue();
1605   const APInt &CI2V = CI2->getValue();
1606   const APInt Delta = CI2V - CI1V;
1607   if (CI1V.isStrictlyPositive()) {
1608     if (Delta == 2) {
1609       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1610         return getTrue(ITy);
1611       if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1612         return getTrue(ITy);
1613     }
1614     if (Delta == 1) {
1615       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1616         return getTrue(ITy);
1617       if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1618         return getTrue(ITy);
1619     }
1620   }
1621   if (CI1V.getBoolValue() && isNUW) {
1622     if (Delta == 2)
1623       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1624         return getTrue(ITy);
1625     if (Delta == 1)
1626       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1627         return getTrue(ITy);
1628   }
1629
1630   return nullptr;
1631 }
1632
1633 /// SimplifyOrInst - Given operands for an Or, see if we can
1634 /// fold the result.  If not, this returns null.
1635 static Value *SimplifyOrInst(Value *Op0, Value *Op1, const Query &Q,
1636                              unsigned MaxRecurse) {
1637   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1638     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1639       Constant *Ops[] = { CLHS, CRHS };
1640       return ConstantFoldInstOperands(Instruction::Or, CLHS->getType(),
1641                                       Ops, Q.DL, Q.TLI);
1642     }
1643
1644     // Canonicalize the constant to the RHS.
1645     std::swap(Op0, Op1);
1646   }
1647
1648   // X | undef -> -1
1649   if (match(Op1, m_Undef()))
1650     return Constant::getAllOnesValue(Op0->getType());
1651
1652   // X | X = X
1653   if (Op0 == Op1)
1654     return Op0;
1655
1656   // X | 0 = X
1657   if (match(Op1, m_Zero()))
1658     return Op0;
1659
1660   // X | -1 = -1
1661   if (match(Op1, m_AllOnes()))
1662     return Op1;
1663
1664   // A | ~A  =  ~A | A  =  -1
1665   if (match(Op0, m_Not(m_Specific(Op1))) ||
1666       match(Op1, m_Not(m_Specific(Op0))))
1667     return Constant::getAllOnesValue(Op0->getType());
1668
1669   // (A & ?) | A = A
1670   Value *A = nullptr, *B = nullptr;
1671   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1672       (A == Op1 || B == Op1))
1673     return Op1;
1674
1675   // A | (A & ?) = A
1676   if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1677       (A == Op0 || B == Op0))
1678     return Op0;
1679
1680   // ~(A & ?) | A = -1
1681   if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1682       (A == Op1 || B == Op1))
1683     return Constant::getAllOnesValue(Op1->getType());
1684
1685   // A | ~(A & ?) = -1
1686   if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1687       (A == Op0 || B == Op0))
1688     return Constant::getAllOnesValue(Op0->getType());
1689
1690   if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1691     if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1692       if (Value *V = SimplifyOrOfICmps(ICILHS, ICIRHS))
1693         return V;
1694       if (Value *V = SimplifyOrOfICmps(ICIRHS, ICILHS))
1695         return V;
1696     }
1697   }
1698
1699   // Try some generic simplifications for associative operations.
1700   if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1701                                           MaxRecurse))
1702     return V;
1703
1704   // Or distributes over And.  Try some generic simplifications based on this.
1705   if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1706                              MaxRecurse))
1707     return V;
1708
1709   // If the operation is with the result of a select instruction, check whether
1710   // operating on either branch of the select always yields the same value.
1711   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1712     if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
1713                                          MaxRecurse))
1714       return V;
1715
1716   // (A & C)|(B & D)
1717   Value *C = nullptr, *D = nullptr;
1718   if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1719       match(Op1, m_And(m_Value(B), m_Value(D)))) {
1720     ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1721     ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1722     if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1723       // (A & C1)|(B & C2)
1724       // If we have: ((V + N) & C1) | (V & C2)
1725       // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1726       // replace with V+N.
1727       Value *V1, *V2;
1728       if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1729           match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1730         // Add commutes, try both ways.
1731         if (V1 == B && MaskedValueIsZero(V2, C2->getValue(), Q.DL,
1732                                          0, Q.AT, Q.CxtI, Q.DT))
1733           return A;
1734         if (V2 == B && MaskedValueIsZero(V1, C2->getValue(), Q.DL,
1735                                          0, Q.AT, Q.CxtI, Q.DT))
1736           return A;
1737       }
1738       // Or commutes, try both ways.
1739       if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1740           match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1741         // Add commutes, try both ways.
1742         if (V1 == A && MaskedValueIsZero(V2, C1->getValue(), Q.DL,
1743                                          0, Q.AT, Q.CxtI, Q.DT))
1744           return B;
1745         if (V2 == A && MaskedValueIsZero(V1, C1->getValue(), Q.DL,
1746                                          0, Q.AT, Q.CxtI, Q.DT))
1747           return B;
1748       }
1749     }
1750   }
1751
1752   // If the operation is with the result of a phi instruction, check whether
1753   // operating on all incoming values of the phi always yields the same value.
1754   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1755     if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
1756       return V;
1757
1758   return nullptr;
1759 }
1760
1761 Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const DataLayout *DL,
1762                             const TargetLibraryInfo *TLI,
1763                             const DominatorTree *DT, AssumptionTracker *AT,
1764                             const Instruction *CxtI) {
1765   return ::SimplifyOrInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1766                           RecursionLimit);
1767 }
1768
1769 /// SimplifyXorInst - Given operands for a Xor, see if we can
1770 /// fold the result.  If not, this returns null.
1771 static Value *SimplifyXorInst(Value *Op0, Value *Op1, const Query &Q,
1772                               unsigned MaxRecurse) {
1773   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1774     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1775       Constant *Ops[] = { CLHS, CRHS };
1776       return ConstantFoldInstOperands(Instruction::Xor, CLHS->getType(),
1777                                       Ops, Q.DL, Q.TLI);
1778     }
1779
1780     // Canonicalize the constant to the RHS.
1781     std::swap(Op0, Op1);
1782   }
1783
1784   // A ^ undef -> undef
1785   if (match(Op1, m_Undef()))
1786     return Op1;
1787
1788   // A ^ 0 = A
1789   if (match(Op1, m_Zero()))
1790     return Op0;
1791
1792   // A ^ A = 0
1793   if (Op0 == Op1)
1794     return Constant::getNullValue(Op0->getType());
1795
1796   // A ^ ~A  =  ~A ^ A  =  -1
1797   if (match(Op0, m_Not(m_Specific(Op1))) ||
1798       match(Op1, m_Not(m_Specific(Op0))))
1799     return Constant::getAllOnesValue(Op0->getType());
1800
1801   // Try some generic simplifications for associative operations.
1802   if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1803                                           MaxRecurse))
1804     return V;
1805
1806   // Threading Xor over selects and phi nodes is pointless, so don't bother.
1807   // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1808   // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1809   // only if B and C are equal.  If B and C are equal then (since we assume
1810   // that operands have already been simplified) "select(cond, B, C)" should
1811   // have been simplified to the common value of B and C already.  Analysing
1812   // "A^B" and "A^C" thus gains nothing, but costs compile time.  Similarly
1813   // for threading over phi nodes.
1814
1815   return nullptr;
1816 }
1817
1818 Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const DataLayout *DL,
1819                              const TargetLibraryInfo *TLI,
1820                              const DominatorTree *DT, AssumptionTracker *AT,
1821                              const Instruction *CxtI) {
1822   return ::SimplifyXorInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1823                            RecursionLimit);
1824 }
1825
1826 static Type *GetCompareTy(Value *Op) {
1827   return CmpInst::makeCmpResultType(Op->getType());
1828 }
1829
1830 /// ExtractEquivalentCondition - Rummage around inside V looking for something
1831 /// equivalent to the comparison "LHS Pred RHS".  Return such a value if found,
1832 /// otherwise return null.  Helper function for analyzing max/min idioms.
1833 static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
1834                                          Value *LHS, Value *RHS) {
1835   SelectInst *SI = dyn_cast<SelectInst>(V);
1836   if (!SI)
1837     return nullptr;
1838   CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
1839   if (!Cmp)
1840     return nullptr;
1841   Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
1842   if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
1843     return Cmp;
1844   if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
1845       LHS == CmpRHS && RHS == CmpLHS)
1846     return Cmp;
1847   return nullptr;
1848 }
1849
1850 // A significant optimization not implemented here is assuming that alloca
1851 // addresses are not equal to incoming argument values. They don't *alias*,
1852 // as we say, but that doesn't mean they aren't equal, so we take a
1853 // conservative approach.
1854 //
1855 // This is inspired in part by C++11 5.10p1:
1856 //   "Two pointers of the same type compare equal if and only if they are both
1857 //    null, both point to the same function, or both represent the same
1858 //    address."
1859 //
1860 // This is pretty permissive.
1861 //
1862 // It's also partly due to C11 6.5.9p6:
1863 //   "Two pointers compare equal if and only if both are null pointers, both are
1864 //    pointers to the same object (including a pointer to an object and a
1865 //    subobject at its beginning) or function, both are pointers to one past the
1866 //    last element of the same array object, or one is a pointer to one past the
1867 //    end of one array object and the other is a pointer to the start of a
1868 //    different array object that happens to immediately follow the first array
1869 //    object in the address space.)
1870 //
1871 // C11's version is more restrictive, however there's no reason why an argument
1872 // couldn't be a one-past-the-end value for a stack object in the caller and be
1873 // equal to the beginning of a stack object in the callee.
1874 //
1875 // If the C and C++ standards are ever made sufficiently restrictive in this
1876 // area, it may be possible to update LLVM's semantics accordingly and reinstate
1877 // this optimization.
1878 static Constant *computePointerICmp(const DataLayout *DL,
1879                                     const TargetLibraryInfo *TLI,
1880                                     CmpInst::Predicate Pred,
1881                                     Value *LHS, Value *RHS) {
1882   // First, skip past any trivial no-ops.
1883   LHS = LHS->stripPointerCasts();
1884   RHS = RHS->stripPointerCasts();
1885
1886   // A non-null pointer is not equal to a null pointer.
1887   if (llvm::isKnownNonNull(LHS, TLI) && isa<ConstantPointerNull>(RHS) &&
1888       (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
1889     return ConstantInt::get(GetCompareTy(LHS),
1890                             !CmpInst::isTrueWhenEqual(Pred));
1891
1892   // We can only fold certain predicates on pointer comparisons.
1893   switch (Pred) {
1894   default:
1895     return nullptr;
1896
1897     // Equality comaprisons are easy to fold.
1898   case CmpInst::ICMP_EQ:
1899   case CmpInst::ICMP_NE:
1900     break;
1901
1902     // We can only handle unsigned relational comparisons because 'inbounds' on
1903     // a GEP only protects against unsigned wrapping.
1904   case CmpInst::ICMP_UGT:
1905   case CmpInst::ICMP_UGE:
1906   case CmpInst::ICMP_ULT:
1907   case CmpInst::ICMP_ULE:
1908     // However, we have to switch them to their signed variants to handle
1909     // negative indices from the base pointer.
1910     Pred = ICmpInst::getSignedPredicate(Pred);
1911     break;
1912   }
1913
1914   // Strip off any constant offsets so that we can reason about them.
1915   // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
1916   // here and compare base addresses like AliasAnalysis does, however there are
1917   // numerous hazards. AliasAnalysis and its utilities rely on special rules
1918   // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
1919   // doesn't need to guarantee pointer inequality when it says NoAlias.
1920   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
1921   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
1922
1923   // If LHS and RHS are related via constant offsets to the same base
1924   // value, we can replace it with an icmp which just compares the offsets.
1925   if (LHS == RHS)
1926     return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
1927
1928   // Various optimizations for (in)equality comparisons.
1929   if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
1930     // Different non-empty allocations that exist at the same time have
1931     // different addresses (if the program can tell). Global variables always
1932     // exist, so they always exist during the lifetime of each other and all
1933     // allocas. Two different allocas usually have different addresses...
1934     //
1935     // However, if there's an @llvm.stackrestore dynamically in between two
1936     // allocas, they may have the same address. It's tempting to reduce the
1937     // scope of the problem by only looking at *static* allocas here. That would
1938     // cover the majority of allocas while significantly reducing the likelihood
1939     // of having an @llvm.stackrestore pop up in the middle. However, it's not
1940     // actually impossible for an @llvm.stackrestore to pop up in the middle of
1941     // an entry block. Also, if we have a block that's not attached to a
1942     // function, we can't tell if it's "static" under the current definition.
1943     // Theoretically, this problem could be fixed by creating a new kind of
1944     // instruction kind specifically for static allocas. Such a new instruction
1945     // could be required to be at the top of the entry block, thus preventing it
1946     // from being subject to a @llvm.stackrestore. Instcombine could even
1947     // convert regular allocas into these special allocas. It'd be nifty.
1948     // However, until then, this problem remains open.
1949     //
1950     // So, we'll assume that two non-empty allocas have different addresses
1951     // for now.
1952     //
1953     // With all that, if the offsets are within the bounds of their allocations
1954     // (and not one-past-the-end! so we can't use inbounds!), and their
1955     // allocations aren't the same, the pointers are not equal.
1956     //
1957     // Note that it's not necessary to check for LHS being a global variable
1958     // address, due to canonicalization and constant folding.
1959     if (isa<AllocaInst>(LHS) &&
1960         (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
1961       ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
1962       ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
1963       uint64_t LHSSize, RHSSize;
1964       if (LHSOffsetCI && RHSOffsetCI &&
1965           getObjectSize(LHS, LHSSize, DL, TLI) &&
1966           getObjectSize(RHS, RHSSize, DL, TLI)) {
1967         const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
1968         const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
1969         if (!LHSOffsetValue.isNegative() &&
1970             !RHSOffsetValue.isNegative() &&
1971             LHSOffsetValue.ult(LHSSize) &&
1972             RHSOffsetValue.ult(RHSSize)) {
1973           return ConstantInt::get(GetCompareTy(LHS),
1974                                   !CmpInst::isTrueWhenEqual(Pred));
1975         }
1976       }
1977
1978       // Repeat the above check but this time without depending on DataLayout
1979       // or being able to compute a precise size.
1980       if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
1981           !cast<PointerType>(RHS->getType())->isEmptyTy() &&
1982           LHSOffset->isNullValue() &&
1983           RHSOffset->isNullValue())
1984         return ConstantInt::get(GetCompareTy(LHS),
1985                                 !CmpInst::isTrueWhenEqual(Pred));
1986     }
1987
1988     // Even if an non-inbounds GEP occurs along the path we can still optimize
1989     // equality comparisons concerning the result. We avoid walking the whole
1990     // chain again by starting where the last calls to
1991     // stripAndComputeConstantOffsets left off and accumulate the offsets.
1992     Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
1993     Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
1994     if (LHS == RHS)
1995       return ConstantExpr::getICmp(Pred,
1996                                    ConstantExpr::getAdd(LHSOffset, LHSNoBound),
1997                                    ConstantExpr::getAdd(RHSOffset, RHSNoBound));
1998   }
1999
2000   // Otherwise, fail.
2001   return nullptr;
2002 }
2003
2004 /// SimplifyICmpInst - Given operands for an ICmpInst, see if we can
2005 /// fold the result.  If not, this returns null.
2006 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2007                                const Query &Q, unsigned MaxRecurse) {
2008   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
2009   assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
2010
2011   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
2012     if (Constant *CRHS = dyn_cast<Constant>(RHS))
2013       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
2014
2015     // If we have a constant, make sure it is on the RHS.
2016     std::swap(LHS, RHS);
2017     Pred = CmpInst::getSwappedPredicate(Pred);
2018   }
2019
2020   Type *ITy = GetCompareTy(LHS); // The return type.
2021   Type *OpTy = LHS->getType();   // The operand type.
2022
2023   // icmp X, X -> true/false
2024   // X icmp undef -> true/false.  For example, icmp ugt %X, undef -> false
2025   // because X could be 0.
2026   if (LHS == RHS || isa<UndefValue>(RHS))
2027     return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
2028
2029   // Special case logic when the operands have i1 type.
2030   if (OpTy->getScalarType()->isIntegerTy(1)) {
2031     switch (Pred) {
2032     default: break;
2033     case ICmpInst::ICMP_EQ:
2034       // X == 1 -> X
2035       if (match(RHS, m_One()))
2036         return LHS;
2037       break;
2038     case ICmpInst::ICMP_NE:
2039       // X != 0 -> X
2040       if (match(RHS, m_Zero()))
2041         return LHS;
2042       break;
2043     case ICmpInst::ICMP_UGT:
2044       // X >u 0 -> X
2045       if (match(RHS, m_Zero()))
2046         return LHS;
2047       break;
2048     case ICmpInst::ICMP_UGE:
2049       // X >=u 1 -> X
2050       if (match(RHS, m_One()))
2051         return LHS;
2052       break;
2053     case ICmpInst::ICMP_SLT:
2054       // X <s 0 -> X
2055       if (match(RHS, m_Zero()))
2056         return LHS;
2057       break;
2058     case ICmpInst::ICMP_SLE:
2059       // X <=s -1 -> X
2060       if (match(RHS, m_One()))
2061         return LHS;
2062       break;
2063     }
2064   }
2065
2066   // If we are comparing with zero then try hard since this is a common case.
2067   if (match(RHS, m_Zero())) {
2068     bool LHSKnownNonNegative, LHSKnownNegative;
2069     switch (Pred) {
2070     default: llvm_unreachable("Unknown ICmp predicate!");
2071     case ICmpInst::ICMP_ULT:
2072       return getFalse(ITy);
2073     case ICmpInst::ICMP_UGE:
2074       return getTrue(ITy);
2075     case ICmpInst::ICMP_EQ:
2076     case ICmpInst::ICMP_ULE:
2077       if (isKnownNonZero(LHS, Q.DL, 0, Q.AT, Q.CxtI, Q.DT))
2078         return getFalse(ITy);
2079       break;
2080     case ICmpInst::ICMP_NE:
2081     case ICmpInst::ICMP_UGT:
2082       if (isKnownNonZero(LHS, Q.DL, 0, Q.AT, Q.CxtI, Q.DT))
2083         return getTrue(ITy);
2084       break;
2085     case ICmpInst::ICMP_SLT:
2086       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2087                      0, Q.AT, Q.CxtI, Q.DT);
2088       if (LHSKnownNegative)
2089         return getTrue(ITy);
2090       if (LHSKnownNonNegative)
2091         return getFalse(ITy);
2092       break;
2093     case ICmpInst::ICMP_SLE:
2094       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2095                      0, Q.AT, Q.CxtI, Q.DT);
2096       if (LHSKnownNegative)
2097         return getTrue(ITy);
2098       if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL,
2099                                                 0, Q.AT, Q.CxtI, Q.DT))
2100         return getFalse(ITy);
2101       break;
2102     case ICmpInst::ICMP_SGE:
2103       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2104                      0, Q.AT, Q.CxtI, Q.DT);
2105       if (LHSKnownNegative)
2106         return getFalse(ITy);
2107       if (LHSKnownNonNegative)
2108         return getTrue(ITy);
2109       break;
2110     case ICmpInst::ICMP_SGT:
2111       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2112                      0, Q.AT, Q.CxtI, Q.DT);
2113       if (LHSKnownNegative)
2114         return getFalse(ITy);
2115       if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL,
2116                                                 0, Q.AT, Q.CxtI, Q.DT))
2117         return getTrue(ITy);
2118       break;
2119     }
2120   }
2121
2122   // See if we are doing a comparison with a constant integer.
2123   if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2124     // Rule out tautological comparisons (eg., ult 0 or uge 0).
2125     ConstantRange RHS_CR = ICmpInst::makeConstantRange(Pred, CI->getValue());
2126     if (RHS_CR.isEmptySet())
2127       return ConstantInt::getFalse(CI->getContext());
2128     if (RHS_CR.isFullSet())
2129       return ConstantInt::getTrue(CI->getContext());
2130
2131     // Many binary operators with constant RHS have easy to compute constant
2132     // range.  Use them to check whether the comparison is a tautology.
2133     unsigned Width = CI->getBitWidth();
2134     APInt Lower = APInt(Width, 0);
2135     APInt Upper = APInt(Width, 0);
2136     ConstantInt *CI2;
2137     if (match(LHS, m_URem(m_Value(), m_ConstantInt(CI2)))) {
2138       // 'urem x, CI2' produces [0, CI2).
2139       Upper = CI2->getValue();
2140     } else if (match(LHS, m_SRem(m_Value(), m_ConstantInt(CI2)))) {
2141       // 'srem x, CI2' produces (-|CI2|, |CI2|).
2142       Upper = CI2->getValue().abs();
2143       Lower = (-Upper) + 1;
2144     } else if (match(LHS, m_UDiv(m_ConstantInt(CI2), m_Value()))) {
2145       // 'udiv CI2, x' produces [0, CI2].
2146       Upper = CI2->getValue() + 1;
2147     } else if (match(LHS, m_UDiv(m_Value(), m_ConstantInt(CI2)))) {
2148       // 'udiv x, CI2' produces [0, UINT_MAX / CI2].
2149       APInt NegOne = APInt::getAllOnesValue(Width);
2150       if (!CI2->isZero())
2151         Upper = NegOne.udiv(CI2->getValue()) + 1;
2152     } else if (match(LHS, m_SDiv(m_ConstantInt(CI2), m_Value()))) {
2153       if (CI2->isMinSignedValue()) {
2154         // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2155         Lower = CI2->getValue();
2156         Upper = Lower.lshr(1) + 1;
2157       } else {
2158         // 'sdiv CI2, x' produces [-|CI2|, |CI2|].
2159         Upper = CI2->getValue().abs() + 1;
2160         Lower = (-Upper) + 1;
2161       }
2162     } else if (match(LHS, m_SDiv(m_Value(), m_ConstantInt(CI2)))) {
2163       APInt IntMin = APInt::getSignedMinValue(Width);
2164       APInt IntMax = APInt::getSignedMaxValue(Width);
2165       APInt Val = CI2->getValue();
2166       if (Val.isAllOnesValue()) {
2167         // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2168         //    where CI2 != -1 and CI2 != 0 and CI2 != 1
2169         Lower = IntMin + 1;
2170         Upper = IntMax + 1;
2171       } else if (Val.countLeadingZeros() < Width - 1) {
2172         // 'sdiv x, CI2' produces [INT_MIN / CI2, INT_MAX / CI2]
2173         //    where CI2 != -1 and CI2 != 0 and CI2 != 1
2174         Lower = IntMin.sdiv(Val);
2175         Upper = IntMax.sdiv(Val);
2176         if (Lower.sgt(Upper))
2177           std::swap(Lower, Upper);
2178         Upper = Upper + 1;
2179         assert(Upper != Lower && "Upper part of range has wrapped!");
2180       }
2181     } else if (match(LHS, m_NUWShl(m_ConstantInt(CI2), m_Value()))) {
2182       // 'shl nuw CI2, x' produces [CI2, CI2 << CLZ(CI2)]
2183       Lower = CI2->getValue();
2184       Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2185     } else if (match(LHS, m_NSWShl(m_ConstantInt(CI2), m_Value()))) {
2186       if (CI2->isNegative()) {
2187         // 'shl nsw CI2, x' produces [CI2 << CLO(CI2)-1, CI2]
2188         unsigned ShiftAmount = CI2->getValue().countLeadingOnes() - 1;
2189         Lower = CI2->getValue().shl(ShiftAmount);
2190         Upper = CI2->getValue() + 1;
2191       } else {
2192         // 'shl nsw CI2, x' produces [CI2, CI2 << CLZ(CI2)-1]
2193         unsigned ShiftAmount = CI2->getValue().countLeadingZeros() - 1;
2194         Lower = CI2->getValue();
2195         Upper = CI2->getValue().shl(ShiftAmount) + 1;
2196       }
2197     } else if (match(LHS, m_LShr(m_Value(), m_ConstantInt(CI2)))) {
2198       // 'lshr x, CI2' produces [0, UINT_MAX >> CI2].
2199       APInt NegOne = APInt::getAllOnesValue(Width);
2200       if (CI2->getValue().ult(Width))
2201         Upper = NegOne.lshr(CI2->getValue()) + 1;
2202     } else if (match(LHS, m_LShr(m_ConstantInt(CI2), m_Value()))) {
2203       // 'lshr CI2, x' produces [CI2 >> (Width-1), CI2].
2204       unsigned ShiftAmount = Width - 1;
2205       if (!CI2->isZero() && cast<BinaryOperator>(LHS)->isExact())
2206         ShiftAmount = CI2->getValue().countTrailingZeros();
2207       Lower = CI2->getValue().lshr(ShiftAmount);
2208       Upper = CI2->getValue() + 1;
2209     } else if (match(LHS, m_AShr(m_Value(), m_ConstantInt(CI2)))) {
2210       // 'ashr x, CI2' produces [INT_MIN >> CI2, INT_MAX >> CI2].
2211       APInt IntMin = APInt::getSignedMinValue(Width);
2212       APInt IntMax = APInt::getSignedMaxValue(Width);
2213       if (CI2->getValue().ult(Width)) {
2214         Lower = IntMin.ashr(CI2->getValue());
2215         Upper = IntMax.ashr(CI2->getValue()) + 1;
2216       }
2217     } else if (match(LHS, m_AShr(m_ConstantInt(CI2), m_Value()))) {
2218       unsigned ShiftAmount = Width - 1;
2219       if (!CI2->isZero() && cast<BinaryOperator>(LHS)->isExact())
2220         ShiftAmount = CI2->getValue().countTrailingZeros();
2221       if (CI2->isNegative()) {
2222         // 'ashr CI2, x' produces [CI2, CI2 >> (Width-1)]
2223         Lower = CI2->getValue();
2224         Upper = CI2->getValue().ashr(ShiftAmount) + 1;
2225       } else {
2226         // 'ashr CI2, x' produces [CI2 >> (Width-1), CI2]
2227         Lower = CI2->getValue().ashr(ShiftAmount);
2228         Upper = CI2->getValue() + 1;
2229       }
2230     } else if (match(LHS, m_Or(m_Value(), m_ConstantInt(CI2)))) {
2231       // 'or x, CI2' produces [CI2, UINT_MAX].
2232       Lower = CI2->getValue();
2233     } else if (match(LHS, m_And(m_Value(), m_ConstantInt(CI2)))) {
2234       // 'and x, CI2' produces [0, CI2].
2235       Upper = CI2->getValue() + 1;
2236     }
2237     if (Lower != Upper) {
2238       ConstantRange LHS_CR = ConstantRange(Lower, Upper);
2239       if (RHS_CR.contains(LHS_CR))
2240         return ConstantInt::getTrue(RHS->getContext());
2241       if (RHS_CR.inverse().contains(LHS_CR))
2242         return ConstantInt::getFalse(RHS->getContext());
2243     }
2244   }
2245
2246   // Compare of cast, for example (zext X) != 0 -> X != 0
2247   if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
2248     Instruction *LI = cast<CastInst>(LHS);
2249     Value *SrcOp = LI->getOperand(0);
2250     Type *SrcTy = SrcOp->getType();
2251     Type *DstTy = LI->getType();
2252
2253     // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
2254     // if the integer type is the same size as the pointer type.
2255     if (MaxRecurse && Q.DL && isa<PtrToIntInst>(LI) &&
2256         Q.DL->getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
2257       if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
2258         // Transfer the cast to the constant.
2259         if (Value *V = SimplifyICmpInst(Pred, SrcOp,
2260                                         ConstantExpr::getIntToPtr(RHSC, SrcTy),
2261                                         Q, MaxRecurse-1))
2262           return V;
2263       } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
2264         if (RI->getOperand(0)->getType() == SrcTy)
2265           // Compare without the cast.
2266           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
2267                                           Q, MaxRecurse-1))
2268             return V;
2269       }
2270     }
2271
2272     if (isa<ZExtInst>(LHS)) {
2273       // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
2274       // same type.
2275       if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
2276         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
2277           // Compare X and Y.  Note that signed predicates become unsigned.
2278           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
2279                                           SrcOp, RI->getOperand(0), Q,
2280                                           MaxRecurse-1))
2281             return V;
2282       }
2283       // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
2284       // too.  If not, then try to deduce the result of the comparison.
2285       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2286         // Compute the constant that would happen if we truncated to SrcTy then
2287         // reextended to DstTy.
2288         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
2289         Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
2290
2291         // If the re-extended constant didn't change then this is effectively
2292         // also a case of comparing two zero-extended values.
2293         if (RExt == CI && MaxRecurse)
2294           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
2295                                         SrcOp, Trunc, Q, MaxRecurse-1))
2296             return V;
2297
2298         // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
2299         // there.  Use this to work out the result of the comparison.
2300         if (RExt != CI) {
2301           switch (Pred) {
2302           default: llvm_unreachable("Unknown ICmp predicate!");
2303           // LHS <u RHS.
2304           case ICmpInst::ICMP_EQ:
2305           case ICmpInst::ICMP_UGT:
2306           case ICmpInst::ICMP_UGE:
2307             return ConstantInt::getFalse(CI->getContext());
2308
2309           case ICmpInst::ICMP_NE:
2310           case ICmpInst::ICMP_ULT:
2311           case ICmpInst::ICMP_ULE:
2312             return ConstantInt::getTrue(CI->getContext());
2313
2314           // LHS is non-negative.  If RHS is negative then LHS >s LHS.  If RHS
2315           // is non-negative then LHS <s RHS.
2316           case ICmpInst::ICMP_SGT:
2317           case ICmpInst::ICMP_SGE:
2318             return CI->getValue().isNegative() ?
2319               ConstantInt::getTrue(CI->getContext()) :
2320               ConstantInt::getFalse(CI->getContext());
2321
2322           case ICmpInst::ICMP_SLT:
2323           case ICmpInst::ICMP_SLE:
2324             return CI->getValue().isNegative() ?
2325               ConstantInt::getFalse(CI->getContext()) :
2326               ConstantInt::getTrue(CI->getContext());
2327           }
2328         }
2329       }
2330     }
2331
2332     if (isa<SExtInst>(LHS)) {
2333       // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
2334       // same type.
2335       if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
2336         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
2337           // Compare X and Y.  Note that the predicate does not change.
2338           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
2339                                           Q, MaxRecurse-1))
2340             return V;
2341       }
2342       // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
2343       // too.  If not, then try to deduce the result of the comparison.
2344       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2345         // Compute the constant that would happen if we truncated to SrcTy then
2346         // reextended to DstTy.
2347         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
2348         Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
2349
2350         // If the re-extended constant didn't change then this is effectively
2351         // also a case of comparing two sign-extended values.
2352         if (RExt == CI && MaxRecurse)
2353           if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
2354             return V;
2355
2356         // Otherwise the upper bits of LHS are all equal, while RHS has varying
2357         // bits there.  Use this to work out the result of the comparison.
2358         if (RExt != CI) {
2359           switch (Pred) {
2360           default: llvm_unreachable("Unknown ICmp predicate!");
2361           case ICmpInst::ICMP_EQ:
2362             return ConstantInt::getFalse(CI->getContext());
2363           case ICmpInst::ICMP_NE:
2364             return ConstantInt::getTrue(CI->getContext());
2365
2366           // If RHS is non-negative then LHS <s RHS.  If RHS is negative then
2367           // LHS >s RHS.
2368           case ICmpInst::ICMP_SGT:
2369           case ICmpInst::ICMP_SGE:
2370             return CI->getValue().isNegative() ?
2371               ConstantInt::getTrue(CI->getContext()) :
2372               ConstantInt::getFalse(CI->getContext());
2373           case ICmpInst::ICMP_SLT:
2374           case ICmpInst::ICMP_SLE:
2375             return CI->getValue().isNegative() ?
2376               ConstantInt::getFalse(CI->getContext()) :
2377               ConstantInt::getTrue(CI->getContext());
2378
2379           // If LHS is non-negative then LHS <u RHS.  If LHS is negative then
2380           // LHS >u RHS.
2381           case ICmpInst::ICMP_UGT:
2382           case ICmpInst::ICMP_UGE:
2383             // Comparison is true iff the LHS <s 0.
2384             if (MaxRecurse)
2385               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
2386                                               Constant::getNullValue(SrcTy),
2387                                               Q, MaxRecurse-1))
2388                 return V;
2389             break;
2390           case ICmpInst::ICMP_ULT:
2391           case ICmpInst::ICMP_ULE:
2392             // Comparison is true iff the LHS >=s 0.
2393             if (MaxRecurse)
2394               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
2395                                               Constant::getNullValue(SrcTy),
2396                                               Q, MaxRecurse-1))
2397                 return V;
2398             break;
2399           }
2400         }
2401       }
2402     }
2403   }
2404
2405   // If a bit is known to be zero for A and known to be one for B,
2406   // then A and B cannot be equal.
2407   if (ICmpInst::isEquality(Pred)) {
2408     if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2409       uint32_t BitWidth = CI->getBitWidth();
2410       APInt LHSKnownZero(BitWidth, 0);
2411       APInt LHSKnownOne(BitWidth, 0);
2412       computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, Q.DL,
2413                        0, Q.AT, Q.CxtI, Q.DT);
2414       APInt RHSKnownZero(BitWidth, 0);
2415       APInt RHSKnownOne(BitWidth, 0);
2416       computeKnownBits(RHS, RHSKnownZero, RHSKnownOne, Q.DL,
2417                        0, Q.AT, Q.CxtI, Q.DT);
2418       if (((LHSKnownOne & RHSKnownZero) != 0) ||
2419           ((LHSKnownZero & RHSKnownOne) != 0))
2420         return (Pred == ICmpInst::ICMP_EQ)
2421                    ? ConstantInt::getFalse(CI->getContext())
2422                    : ConstantInt::getTrue(CI->getContext());
2423     }
2424   }
2425
2426   // Special logic for binary operators.
2427   BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2428   BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2429   if (MaxRecurse && (LBO || RBO)) {
2430     // Analyze the case when either LHS or RHS is an add instruction.
2431     Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2432     // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2433     bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2434     if (LBO && LBO->getOpcode() == Instruction::Add) {
2435       A = LBO->getOperand(0); B = LBO->getOperand(1);
2436       NoLHSWrapProblem = ICmpInst::isEquality(Pred) ||
2437         (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2438         (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2439     }
2440     if (RBO && RBO->getOpcode() == Instruction::Add) {
2441       C = RBO->getOperand(0); D = RBO->getOperand(1);
2442       NoRHSWrapProblem = ICmpInst::isEquality(Pred) ||
2443         (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2444         (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2445     }
2446
2447     // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2448     if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2449       if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2450                                       Constant::getNullValue(RHS->getType()),
2451                                       Q, MaxRecurse-1))
2452         return V;
2453
2454     // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2455     if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2456       if (Value *V = SimplifyICmpInst(Pred,
2457                                       Constant::getNullValue(LHS->getType()),
2458                                       C == LHS ? D : C, Q, MaxRecurse-1))
2459         return V;
2460
2461     // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2462     if (A && C && (A == C || A == D || B == C || B == D) &&
2463         NoLHSWrapProblem && NoRHSWrapProblem) {
2464       // Determine Y and Z in the form icmp (X+Y), (X+Z).
2465       Value *Y, *Z;
2466       if (A == C) {
2467         // C + B == C + D  ->  B == D
2468         Y = B;
2469         Z = D;
2470       } else if (A == D) {
2471         // D + B == C + D  ->  B == C
2472         Y = B;
2473         Z = C;
2474       } else if (B == C) {
2475         // A + C == C + D  ->  A == D
2476         Y = A;
2477         Z = D;
2478       } else {
2479         assert(B == D);
2480         // A + D == C + D  ->  A == C
2481         Y = A;
2482         Z = C;
2483       }
2484       if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse-1))
2485         return V;
2486     }
2487   }
2488
2489   // 0 - (zext X) pred C
2490   if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2491     if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2492       if (RHSC->getValue().isStrictlyPositive()) {
2493         if (Pred == ICmpInst::ICMP_SLT)
2494           return ConstantInt::getTrue(RHSC->getContext());
2495         if (Pred == ICmpInst::ICMP_SGE)
2496           return ConstantInt::getFalse(RHSC->getContext());
2497         if (Pred == ICmpInst::ICMP_EQ)
2498           return ConstantInt::getFalse(RHSC->getContext());
2499         if (Pred == ICmpInst::ICMP_NE)
2500           return ConstantInt::getTrue(RHSC->getContext());
2501       }
2502       if (RHSC->getValue().isNonNegative()) {
2503         if (Pred == ICmpInst::ICMP_SLE)
2504           return ConstantInt::getTrue(RHSC->getContext());
2505         if (Pred == ICmpInst::ICMP_SGT)
2506           return ConstantInt::getFalse(RHSC->getContext());
2507       }
2508     }
2509   }
2510
2511   // icmp pred (urem X, Y), Y
2512   if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2513     bool KnownNonNegative, KnownNegative;
2514     switch (Pred) {
2515     default:
2516       break;
2517     case ICmpInst::ICMP_SGT:
2518     case ICmpInst::ICMP_SGE:
2519       ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL,
2520                      0, Q.AT, Q.CxtI, Q.DT);
2521       if (!KnownNonNegative)
2522         break;
2523       // fall-through
2524     case ICmpInst::ICMP_EQ:
2525     case ICmpInst::ICMP_UGT:
2526     case ICmpInst::ICMP_UGE:
2527       return getFalse(ITy);
2528     case ICmpInst::ICMP_SLT:
2529     case ICmpInst::ICMP_SLE:
2530       ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL,
2531                      0, Q.AT, Q.CxtI, Q.DT);
2532       if (!KnownNonNegative)
2533         break;
2534       // fall-through
2535     case ICmpInst::ICMP_NE:
2536     case ICmpInst::ICMP_ULT:
2537     case ICmpInst::ICMP_ULE:
2538       return getTrue(ITy);
2539     }
2540   }
2541
2542   // icmp pred X, (urem Y, X)
2543   if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2544     bool KnownNonNegative, KnownNegative;
2545     switch (Pred) {
2546     default:
2547       break;
2548     case ICmpInst::ICMP_SGT:
2549     case ICmpInst::ICMP_SGE:
2550       ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL,
2551                      0, Q.AT, Q.CxtI, Q.DT);
2552       if (!KnownNonNegative)
2553         break;
2554       // fall-through
2555     case ICmpInst::ICMP_NE:
2556     case ICmpInst::ICMP_UGT:
2557     case ICmpInst::ICMP_UGE:
2558       return getTrue(ITy);
2559     case ICmpInst::ICMP_SLT:
2560     case ICmpInst::ICMP_SLE:
2561       ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL,
2562                      0, Q.AT, Q.CxtI, Q.DT);
2563       if (!KnownNonNegative)
2564         break;
2565       // fall-through
2566     case ICmpInst::ICMP_EQ:
2567     case ICmpInst::ICMP_ULT:
2568     case ICmpInst::ICMP_ULE:
2569       return getFalse(ITy);
2570     }
2571   }
2572
2573   // x udiv y <=u x.
2574   if (LBO && match(LBO, m_UDiv(m_Specific(RHS), m_Value()))) {
2575     // icmp pred (X /u Y), X
2576     if (Pred == ICmpInst::ICMP_UGT)
2577       return getFalse(ITy);
2578     if (Pred == ICmpInst::ICMP_ULE)
2579       return getTrue(ITy);
2580   }
2581
2582   // handle:
2583   //   CI2 << X == CI
2584   //   CI2 << X != CI
2585   //
2586   //   where CI2 is a power of 2 and CI isn't
2587   if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2588     const APInt *CI2Val, *CIVal = &CI->getValue();
2589     if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2590         CI2Val->isPowerOf2()) {
2591       if (!CIVal->isPowerOf2()) {
2592         // CI2 << X can equal zero in some circumstances,
2593         // this simplification is unsafe if CI is zero.
2594         //
2595         // We know it is safe if:
2596         // - The shift is nsw, we can't shift out the one bit.
2597         // - The shift is nuw, we can't shift out the one bit.
2598         // - CI2 is one
2599         // - CI isn't zero
2600         if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2601             *CI2Val == 1 || !CI->isZero()) {
2602           if (Pred == ICmpInst::ICMP_EQ)
2603             return ConstantInt::getFalse(RHS->getContext());
2604           if (Pred == ICmpInst::ICMP_NE)
2605             return ConstantInt::getTrue(RHS->getContext());
2606         }
2607       }
2608       if (CIVal->isSignBit() && *CI2Val == 1) {
2609         if (Pred == ICmpInst::ICMP_UGT)
2610           return ConstantInt::getFalse(RHS->getContext());
2611         if (Pred == ICmpInst::ICMP_ULE)
2612           return ConstantInt::getTrue(RHS->getContext());
2613       }
2614     }
2615   }
2616
2617   if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2618       LBO->getOperand(1) == RBO->getOperand(1)) {
2619     switch (LBO->getOpcode()) {
2620     default: break;
2621     case Instruction::UDiv:
2622     case Instruction::LShr:
2623       if (ICmpInst::isSigned(Pred))
2624         break;
2625       // fall-through
2626     case Instruction::SDiv:
2627     case Instruction::AShr:
2628       if (!LBO->isExact() || !RBO->isExact())
2629         break;
2630       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2631                                       RBO->getOperand(0), Q, MaxRecurse-1))
2632         return V;
2633       break;
2634     case Instruction::Shl: {
2635       bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2636       bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2637       if (!NUW && !NSW)
2638         break;
2639       if (!NSW && ICmpInst::isSigned(Pred))
2640         break;
2641       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2642                                       RBO->getOperand(0), Q, MaxRecurse-1))
2643         return V;
2644       break;
2645     }
2646     }
2647   }
2648
2649   // Simplify comparisons involving max/min.
2650   Value *A, *B;
2651   CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2652   CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2653
2654   // Signed variants on "max(a,b)>=a -> true".
2655   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2656     if (A != RHS) std::swap(A, B); // smax(A, B) pred A.
2657     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2658     // We analyze this as smax(A, B) pred A.
2659     P = Pred;
2660   } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2661              (A == LHS || B == LHS)) {
2662     if (A != LHS) std::swap(A, B); // A pred smax(A, B).
2663     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2664     // We analyze this as smax(A, B) swapped-pred A.
2665     P = CmpInst::getSwappedPredicate(Pred);
2666   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2667              (A == RHS || B == RHS)) {
2668     if (A != RHS) std::swap(A, B); // smin(A, B) pred A.
2669     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2670     // We analyze this as smax(-A, -B) swapped-pred -A.
2671     // Note that we do not need to actually form -A or -B thanks to EqP.
2672     P = CmpInst::getSwappedPredicate(Pred);
2673   } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2674              (A == LHS || B == LHS)) {
2675     if (A != LHS) std::swap(A, B); // A pred smin(A, B).
2676     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2677     // We analyze this as smax(-A, -B) pred -A.
2678     // Note that we do not need to actually form -A or -B thanks to EqP.
2679     P = Pred;
2680   }
2681   if (P != CmpInst::BAD_ICMP_PREDICATE) {
2682     // Cases correspond to "max(A, B) p A".
2683     switch (P) {
2684     default:
2685       break;
2686     case CmpInst::ICMP_EQ:
2687     case CmpInst::ICMP_SLE:
2688       // Equivalent to "A EqP B".  This may be the same as the condition tested
2689       // in the max/min; if so, we can just return that.
2690       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2691         return V;
2692       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2693         return V;
2694       // Otherwise, see if "A EqP B" simplifies.
2695       if (MaxRecurse)
2696         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse-1))
2697           return V;
2698       break;
2699     case CmpInst::ICMP_NE:
2700     case CmpInst::ICMP_SGT: {
2701       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2702       // Equivalent to "A InvEqP B".  This may be the same as the condition
2703       // tested in the max/min; if so, we can just return that.
2704       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2705         return V;
2706       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2707         return V;
2708       // Otherwise, see if "A InvEqP B" simplifies.
2709       if (MaxRecurse)
2710         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse-1))
2711           return V;
2712       break;
2713     }
2714     case CmpInst::ICMP_SGE:
2715       // Always true.
2716       return getTrue(ITy);
2717     case CmpInst::ICMP_SLT:
2718       // Always false.
2719       return getFalse(ITy);
2720     }
2721   }
2722
2723   // Unsigned variants on "max(a,b)>=a -> true".
2724   P = CmpInst::BAD_ICMP_PREDICATE;
2725   if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2726     if (A != RHS) std::swap(A, B); // umax(A, B) pred A.
2727     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2728     // We analyze this as umax(A, B) pred A.
2729     P = Pred;
2730   } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2731              (A == LHS || B == LHS)) {
2732     if (A != LHS) std::swap(A, B); // A pred umax(A, B).
2733     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2734     // We analyze this as umax(A, B) swapped-pred A.
2735     P = CmpInst::getSwappedPredicate(Pred);
2736   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2737              (A == RHS || B == RHS)) {
2738     if (A != RHS) std::swap(A, B); // umin(A, B) pred A.
2739     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2740     // We analyze this as umax(-A, -B) swapped-pred -A.
2741     // Note that we do not need to actually form -A or -B thanks to EqP.
2742     P = CmpInst::getSwappedPredicate(Pred);
2743   } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2744              (A == LHS || B == LHS)) {
2745     if (A != LHS) std::swap(A, B); // A pred umin(A, B).
2746     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2747     // We analyze this as umax(-A, -B) pred -A.
2748     // Note that we do not need to actually form -A or -B thanks to EqP.
2749     P = Pred;
2750   }
2751   if (P != CmpInst::BAD_ICMP_PREDICATE) {
2752     // Cases correspond to "max(A, B) p A".
2753     switch (P) {
2754     default:
2755       break;
2756     case CmpInst::ICMP_EQ:
2757     case CmpInst::ICMP_ULE:
2758       // Equivalent to "A EqP B".  This may be the same as the condition tested
2759       // in the max/min; if so, we can just return that.
2760       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2761         return V;
2762       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2763         return V;
2764       // Otherwise, see if "A EqP B" simplifies.
2765       if (MaxRecurse)
2766         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse-1))
2767           return V;
2768       break;
2769     case CmpInst::ICMP_NE:
2770     case CmpInst::ICMP_UGT: {
2771       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2772       // Equivalent to "A InvEqP B".  This may be the same as the condition
2773       // tested in the max/min; if so, we can just return that.
2774       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2775         return V;
2776       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2777         return V;
2778       // Otherwise, see if "A InvEqP B" simplifies.
2779       if (MaxRecurse)
2780         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse-1))
2781           return V;
2782       break;
2783     }
2784     case CmpInst::ICMP_UGE:
2785       // Always true.
2786       return getTrue(ITy);
2787     case CmpInst::ICMP_ULT:
2788       // Always false.
2789       return getFalse(ITy);
2790     }
2791   }
2792
2793   // Variants on "max(x,y) >= min(x,z)".
2794   Value *C, *D;
2795   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
2796       match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
2797       (A == C || A == D || B == C || B == D)) {
2798     // max(x, ?) pred min(x, ?).
2799     if (Pred == CmpInst::ICMP_SGE)
2800       // Always true.
2801       return getTrue(ITy);
2802     if (Pred == CmpInst::ICMP_SLT)
2803       // Always false.
2804       return getFalse(ITy);
2805   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2806              match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
2807              (A == C || A == D || B == C || B == D)) {
2808     // min(x, ?) pred max(x, ?).
2809     if (Pred == CmpInst::ICMP_SLE)
2810       // Always true.
2811       return getTrue(ITy);
2812     if (Pred == CmpInst::ICMP_SGT)
2813       // Always false.
2814       return getFalse(ITy);
2815   } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
2816              match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
2817              (A == C || A == D || B == C || B == D)) {
2818     // max(x, ?) pred min(x, ?).
2819     if (Pred == CmpInst::ICMP_UGE)
2820       // Always true.
2821       return getTrue(ITy);
2822     if (Pred == CmpInst::ICMP_ULT)
2823       // Always false.
2824       return getFalse(ITy);
2825   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2826              match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
2827              (A == C || A == D || B == C || B == D)) {
2828     // min(x, ?) pred max(x, ?).
2829     if (Pred == CmpInst::ICMP_ULE)
2830       // Always true.
2831       return getTrue(ITy);
2832     if (Pred == CmpInst::ICMP_UGT)
2833       // Always false.
2834       return getFalse(ITy);
2835   }
2836
2837   // Simplify comparisons of related pointers using a powerful, recursive
2838   // GEP-walk when we have target data available..
2839   if (LHS->getType()->isPointerTy())
2840     if (Constant *C = computePointerICmp(Q.DL, Q.TLI, Pred, LHS, RHS))
2841       return C;
2842
2843   if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
2844     if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
2845       if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
2846           GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
2847           (ICmpInst::isEquality(Pred) ||
2848            (GLHS->isInBounds() && GRHS->isInBounds() &&
2849             Pred == ICmpInst::getSignedPredicate(Pred)))) {
2850         // The bases are equal and the indices are constant.  Build a constant
2851         // expression GEP with the same indices and a null base pointer to see
2852         // what constant folding can make out of it.
2853         Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
2854         SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
2855         Constant *NewLHS = ConstantExpr::getGetElementPtr(Null, IndicesLHS);
2856
2857         SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
2858         Constant *NewRHS = ConstantExpr::getGetElementPtr(Null, IndicesRHS);
2859         return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
2860       }
2861     }
2862   }
2863
2864   // If the comparison is with the result of a select instruction, check whether
2865   // comparing with either branch of the select always yields the same value.
2866   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
2867     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
2868       return V;
2869
2870   // If the comparison is with the result of a phi instruction, check whether
2871   // doing the compare with each incoming phi value yields a common result.
2872   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
2873     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
2874       return V;
2875
2876   return nullptr;
2877 }
2878
2879 Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2880                               const DataLayout *DL,
2881                               const TargetLibraryInfo *TLI,
2882                               const DominatorTree *DT,
2883                               AssumptionTracker *AT,
2884                               Instruction *CxtI) {
2885   return ::SimplifyICmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
2886                             RecursionLimit);
2887 }
2888
2889 /// SimplifyFCmpInst - Given operands for an FCmpInst, see if we can
2890 /// fold the result.  If not, this returns null.
2891 static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2892                                const Query &Q, unsigned MaxRecurse) {
2893   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
2894   assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
2895
2896   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
2897     if (Constant *CRHS = dyn_cast<Constant>(RHS))
2898       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
2899
2900     // If we have a constant, make sure it is on the RHS.
2901     std::swap(LHS, RHS);
2902     Pred = CmpInst::getSwappedPredicate(Pred);
2903   }
2904
2905   // Fold trivial predicates.
2906   if (Pred == FCmpInst::FCMP_FALSE)
2907     return ConstantInt::get(GetCompareTy(LHS), 0);
2908   if (Pred == FCmpInst::FCMP_TRUE)
2909     return ConstantInt::get(GetCompareTy(LHS), 1);
2910
2911   if (isa<UndefValue>(RHS))                  // fcmp pred X, undef -> undef
2912     return UndefValue::get(GetCompareTy(LHS));
2913
2914   // fcmp x,x -> true/false.  Not all compares are foldable.
2915   if (LHS == RHS) {
2916     if (CmpInst::isTrueWhenEqual(Pred))
2917       return ConstantInt::get(GetCompareTy(LHS), 1);
2918     if (CmpInst::isFalseWhenEqual(Pred))
2919       return ConstantInt::get(GetCompareTy(LHS), 0);
2920   }
2921
2922   // Handle fcmp with constant RHS
2923   if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
2924     // If the constant is a nan, see if we can fold the comparison based on it.
2925     if (ConstantFP *CFP = dyn_cast<ConstantFP>(RHSC)) {
2926       if (CFP->getValueAPF().isNaN()) {
2927         if (FCmpInst::isOrdered(Pred))   // True "if ordered and foo"
2928           return ConstantInt::getFalse(CFP->getContext());
2929         assert(FCmpInst::isUnordered(Pred) &&
2930                "Comparison must be either ordered or unordered!");
2931         // True if unordered.
2932         return ConstantInt::getTrue(CFP->getContext());
2933       }
2934       // Check whether the constant is an infinity.
2935       if (CFP->getValueAPF().isInfinity()) {
2936         if (CFP->getValueAPF().isNegative()) {
2937           switch (Pred) {
2938           case FCmpInst::FCMP_OLT:
2939             // No value is ordered and less than negative infinity.
2940             return ConstantInt::getFalse(CFP->getContext());
2941           case FCmpInst::FCMP_UGE:
2942             // All values are unordered with or at least negative infinity.
2943             return ConstantInt::getTrue(CFP->getContext());
2944           default:
2945             break;
2946           }
2947         } else {
2948           switch (Pred) {
2949           case FCmpInst::FCMP_OGT:
2950             // No value is ordered and greater than infinity.
2951             return ConstantInt::getFalse(CFP->getContext());
2952           case FCmpInst::FCMP_ULE:
2953             // All values are unordered with and at most infinity.
2954             return ConstantInt::getTrue(CFP->getContext());
2955           default:
2956             break;
2957           }
2958         }
2959       }
2960     }
2961   }
2962
2963   // If the comparison is with the result of a select instruction, check whether
2964   // comparing with either branch of the select always yields the same value.
2965   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
2966     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
2967       return V;
2968
2969   // If the comparison is with the result of a phi instruction, check whether
2970   // doing the compare with each incoming phi value yields a common result.
2971   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
2972     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
2973       return V;
2974
2975   return nullptr;
2976 }
2977
2978 Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2979                               const DataLayout *DL,
2980                               const TargetLibraryInfo *TLI,
2981                               const DominatorTree *DT,
2982                               AssumptionTracker *AT,
2983                               const Instruction *CxtI) {
2984   return ::SimplifyFCmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
2985                             RecursionLimit);
2986 }
2987
2988 /// SimplifySelectInst - Given operands for a SelectInst, see if we can fold
2989 /// the result.  If not, this returns null.
2990 static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
2991                                  Value *FalseVal, const Query &Q,
2992                                  unsigned MaxRecurse) {
2993   // select true, X, Y  -> X
2994   // select false, X, Y -> Y
2995   if (Constant *CB = dyn_cast<Constant>(CondVal)) {
2996     if (CB->isAllOnesValue())
2997       return TrueVal;
2998     if (CB->isNullValue())
2999       return FalseVal;
3000   }
3001
3002   // select C, X, X -> X
3003   if (TrueVal == FalseVal)
3004     return TrueVal;
3005
3006   if (isa<UndefValue>(CondVal)) {  // select undef, X, Y -> X or Y
3007     if (isa<Constant>(TrueVal))
3008       return TrueVal;
3009     return FalseVal;
3010   }
3011   if (isa<UndefValue>(TrueVal))   // select C, undef, X -> X
3012     return FalseVal;
3013   if (isa<UndefValue>(FalseVal))   // select C, X, undef -> X
3014     return TrueVal;
3015
3016   return nullptr;
3017 }
3018
3019 Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3020                                 const DataLayout *DL,
3021                                 const TargetLibraryInfo *TLI,
3022                                 const DominatorTree *DT,
3023                                 AssumptionTracker *AT,
3024                                 const Instruction *CxtI) {
3025   return ::SimplifySelectInst(Cond, TrueVal, FalseVal,
3026                               Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
3027 }
3028
3029 /// SimplifyGEPInst - Given operands for an GetElementPtrInst, see if we can
3030 /// fold the result.  If not, this returns null.
3031 static Value *SimplifyGEPInst(ArrayRef<Value *> Ops, const Query &Q, unsigned) {
3032   // The type of the GEP pointer operand.
3033   PointerType *PtrTy = cast<PointerType>(Ops[0]->getType()->getScalarType());
3034   unsigned AS = PtrTy->getAddressSpace();
3035
3036   // getelementptr P -> P.
3037   if (Ops.size() == 1)
3038     return Ops[0];
3039
3040   // Compute the (pointer) type returned by the GEP instruction.
3041   Type *LastType = GetElementPtrInst::getIndexedType(PtrTy, Ops.slice(1));
3042   Type *GEPTy = PointerType::get(LastType, AS);
3043   if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3044     GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3045
3046   if (isa<UndefValue>(Ops[0]))
3047     return UndefValue::get(GEPTy);
3048
3049   if (Ops.size() == 2) {
3050     // getelementptr P, 0 -> P.
3051     if (match(Ops[1], m_Zero()))
3052       return Ops[0];
3053
3054     Type *Ty = PtrTy->getElementType();
3055     if (Q.DL && Ty->isSized()) {
3056       Value *P;
3057       uint64_t C;
3058       uint64_t TyAllocSize = Q.DL->getTypeAllocSize(Ty);
3059       // getelementptr P, N -> P if P points to a type of zero size.
3060       if (TyAllocSize == 0)
3061         return Ops[0];
3062
3063       // The following transforms are only safe if the ptrtoint cast
3064       // doesn't truncate the pointers.
3065       if (Ops[1]->getType()->getScalarSizeInBits() ==
3066           Q.DL->getPointerSizeInBits(AS)) {
3067         auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3068           if (match(P, m_Zero()))
3069             return Constant::getNullValue(GEPTy);
3070           Value *Temp;
3071           if (match(P, m_PtrToInt(m_Value(Temp))))
3072             if (Temp->getType() == GEPTy)
3073               return Temp;
3074           return nullptr;
3075         };
3076
3077         // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3078         if (TyAllocSize == 1 &&
3079             match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3080           if (Value *R = PtrToIntOrZero(P))
3081             return R;
3082
3083         // getelementptr V, (ashr (sub P, V), C) -> Q
3084         // if P points to a type of size 1 << C.
3085         if (match(Ops[1],
3086                   m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3087                          m_ConstantInt(C))) &&
3088             TyAllocSize == 1ULL << C)
3089           if (Value *R = PtrToIntOrZero(P))
3090             return R;
3091
3092         // getelementptr V, (sdiv (sub P, V), C) -> Q
3093         // if P points to a type of size C.
3094         if (match(Ops[1],
3095                   m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3096                          m_SpecificInt(TyAllocSize))))
3097           if (Value *R = PtrToIntOrZero(P))
3098             return R;
3099       }
3100     }
3101   }
3102
3103   // Check to see if this is constant foldable.
3104   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3105     if (!isa<Constant>(Ops[i]))
3106       return nullptr;
3107
3108   return ConstantExpr::getGetElementPtr(cast<Constant>(Ops[0]), Ops.slice(1));
3109 }
3110
3111 Value *llvm::SimplifyGEPInst(ArrayRef<Value *> Ops, const DataLayout *DL,
3112                              const TargetLibraryInfo *TLI,
3113                              const DominatorTree *DT, AssumptionTracker *AT,
3114                              const Instruction *CxtI) {
3115   return ::SimplifyGEPInst(Ops, Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
3116 }
3117
3118 /// SimplifyInsertValueInst - Given operands for an InsertValueInst, see if we
3119 /// can fold the result.  If not, this returns null.
3120 static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
3121                                       ArrayRef<unsigned> Idxs, const Query &Q,
3122                                       unsigned) {
3123   if (Constant *CAgg = dyn_cast<Constant>(Agg))
3124     if (Constant *CVal = dyn_cast<Constant>(Val))
3125       return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3126
3127   // insertvalue x, undef, n -> x
3128   if (match(Val, m_Undef()))
3129     return Agg;
3130
3131   // insertvalue x, (extractvalue y, n), n
3132   if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
3133     if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3134         EV->getIndices() == Idxs) {
3135       // insertvalue undef, (extractvalue y, n), n -> y
3136       if (match(Agg, m_Undef()))
3137         return EV->getAggregateOperand();
3138
3139       // insertvalue y, (extractvalue y, n), n -> y
3140       if (Agg == EV->getAggregateOperand())
3141         return Agg;
3142     }
3143
3144   return nullptr;
3145 }
3146
3147 Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3148                                      ArrayRef<unsigned> Idxs,
3149                                      const DataLayout *DL,
3150                                      const TargetLibraryInfo *TLI,
3151                                      const DominatorTree *DT,
3152                                      AssumptionTracker *AT,
3153                                      const Instruction *CxtI) {
3154   return ::SimplifyInsertValueInst(Agg, Val, Idxs,
3155                                    Query (DL, TLI, DT, AT, CxtI),
3156                                    RecursionLimit);
3157 }
3158
3159 /// SimplifyPHINode - See if we can fold the given phi.  If not, returns null.
3160 static Value *SimplifyPHINode(PHINode *PN, const Query &Q) {
3161   // If all of the PHI's incoming values are the same then replace the PHI node
3162   // with the common value.
3163   Value *CommonValue = nullptr;
3164   bool HasUndefInput = false;
3165   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3166     Value *Incoming = PN->getIncomingValue(i);
3167     // If the incoming value is the phi node itself, it can safely be skipped.
3168     if (Incoming == PN) continue;
3169     if (isa<UndefValue>(Incoming)) {
3170       // Remember that we saw an undef value, but otherwise ignore them.
3171       HasUndefInput = true;
3172       continue;
3173     }
3174     if (CommonValue && Incoming != CommonValue)
3175       return nullptr;  // Not the same, bail out.
3176     CommonValue = Incoming;
3177   }
3178
3179   // If CommonValue is null then all of the incoming values were either undef or
3180   // equal to the phi node itself.
3181   if (!CommonValue)
3182     return UndefValue::get(PN->getType());
3183
3184   // If we have a PHI node like phi(X, undef, X), where X is defined by some
3185   // instruction, we cannot return X as the result of the PHI node unless it
3186   // dominates the PHI block.
3187   if (HasUndefInput)
3188     return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
3189
3190   return CommonValue;
3191 }
3192
3193 static Value *SimplifyTruncInst(Value *Op, Type *Ty, const Query &Q, unsigned) {
3194   if (Constant *C = dyn_cast<Constant>(Op))
3195     return ConstantFoldInstOperands(Instruction::Trunc, Ty, C, Q.DL, Q.TLI);
3196
3197   return nullptr;
3198 }
3199
3200 Value *llvm::SimplifyTruncInst(Value *Op, Type *Ty, const DataLayout *DL,
3201                                const TargetLibraryInfo *TLI,
3202                                const DominatorTree *DT,
3203                                AssumptionTracker *AT,
3204                                const Instruction *CxtI) {
3205   return ::SimplifyTruncInst(Op, Ty, Query (DL, TLI, DT, AT, CxtI),
3206                              RecursionLimit);
3207 }
3208
3209 //=== Helper functions for higher up the class hierarchy.
3210
3211 /// SimplifyBinOp - Given operands for a BinaryOperator, see if we can
3212 /// fold the result.  If not, this returns null.
3213 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
3214                             const Query &Q, unsigned MaxRecurse) {
3215   switch (Opcode) {
3216   case Instruction::Add:
3217     return SimplifyAddInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3218                            Q, MaxRecurse);
3219   case Instruction::FAdd:
3220     return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3221
3222   case Instruction::Sub:
3223     return SimplifySubInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3224                            Q, MaxRecurse);
3225   case Instruction::FSub:
3226     return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3227
3228   case Instruction::Mul:  return SimplifyMulInst (LHS, RHS, Q, MaxRecurse);
3229   case Instruction::FMul:
3230     return SimplifyFMulInst (LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3231   case Instruction::SDiv: return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
3232   case Instruction::UDiv: return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
3233   case Instruction::FDiv: return SimplifyFDivInst(LHS, RHS, Q, MaxRecurse);
3234   case Instruction::SRem: return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
3235   case Instruction::URem: return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
3236   case Instruction::FRem: return SimplifyFRemInst(LHS, RHS, Q, MaxRecurse);
3237   case Instruction::Shl:
3238     return SimplifyShlInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3239                            Q, MaxRecurse);
3240   case Instruction::LShr:
3241     return SimplifyLShrInst(LHS, RHS, /*isExact*/false, Q, MaxRecurse);
3242   case Instruction::AShr:
3243     return SimplifyAShrInst(LHS, RHS, /*isExact*/false, Q, MaxRecurse);
3244   case Instruction::And: return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
3245   case Instruction::Or:  return SimplifyOrInst (LHS, RHS, Q, MaxRecurse);
3246   case Instruction::Xor: return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
3247   default:
3248     if (Constant *CLHS = dyn_cast<Constant>(LHS))
3249       if (Constant *CRHS = dyn_cast<Constant>(RHS)) {
3250         Constant *COps[] = {CLHS, CRHS};
3251         return ConstantFoldInstOperands(Opcode, LHS->getType(), COps, Q.DL,
3252                                         Q.TLI);
3253       }
3254
3255     // If the operation is associative, try some generic simplifications.
3256     if (Instruction::isAssociative(Opcode))
3257       if (Value *V = SimplifyAssociativeBinOp(Opcode, LHS, RHS, Q, MaxRecurse))
3258         return V;
3259
3260     // If the operation is with the result of a select instruction check whether
3261     // operating on either branch of the select always yields the same value.
3262     if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3263       if (Value *V = ThreadBinOpOverSelect(Opcode, LHS, RHS, Q, MaxRecurse))
3264         return V;
3265
3266     // If the operation is with the result of a phi instruction, check whether
3267     // operating on all incoming values of the phi always yields the same value.
3268     if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3269       if (Value *V = ThreadBinOpOverPHI(Opcode, LHS, RHS, Q, MaxRecurse))
3270         return V;
3271
3272     return nullptr;
3273   }
3274 }
3275
3276 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
3277                            const DataLayout *DL, const TargetLibraryInfo *TLI,
3278                            const DominatorTree *DT, AssumptionTracker *AT,
3279                            const Instruction *CxtI) {
3280   return ::SimplifyBinOp(Opcode, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3281                          RecursionLimit);
3282 }
3283
3284 /// SimplifyCmpInst - Given operands for a CmpInst, see if we can
3285 /// fold the result.
3286 static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3287                               const Query &Q, unsigned MaxRecurse) {
3288   if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
3289     return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
3290   return SimplifyFCmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
3291 }
3292
3293 Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3294                              const DataLayout *DL, const TargetLibraryInfo *TLI,
3295                              const DominatorTree *DT, AssumptionTracker *AT,
3296                              const Instruction *CxtI) {
3297   return ::SimplifyCmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3298                            RecursionLimit);
3299 }
3300
3301 static bool IsIdempotent(Intrinsic::ID ID) {
3302   switch (ID) {
3303   default: return false;
3304
3305   // Unary idempotent: f(f(x)) = f(x)
3306   case Intrinsic::fabs:
3307   case Intrinsic::floor:
3308   case Intrinsic::ceil:
3309   case Intrinsic::trunc:
3310   case Intrinsic::rint:
3311   case Intrinsic::nearbyint:
3312   case Intrinsic::round:
3313     return true;
3314   }
3315 }
3316
3317 template <typename IterTy>
3318 static Value *SimplifyIntrinsic(Intrinsic::ID IID, IterTy ArgBegin, IterTy ArgEnd,
3319                                 const Query &Q, unsigned MaxRecurse) {
3320   // Perform idempotent optimizations
3321   if (!IsIdempotent(IID))
3322     return nullptr;
3323
3324   // Unary Ops
3325   if (std::distance(ArgBegin, ArgEnd) == 1)
3326     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin))
3327       if (II->getIntrinsicID() == IID)
3328         return II;
3329
3330   return nullptr;
3331 }
3332
3333 template <typename IterTy>
3334 static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
3335                            const Query &Q, unsigned MaxRecurse) {
3336   Type *Ty = V->getType();
3337   if (PointerType *PTy = dyn_cast<PointerType>(Ty))
3338     Ty = PTy->getElementType();
3339   FunctionType *FTy = cast<FunctionType>(Ty);
3340
3341   // call undef -> undef
3342   if (isa<UndefValue>(V))
3343     return UndefValue::get(FTy->getReturnType());
3344
3345   Function *F = dyn_cast<Function>(V);
3346   if (!F)
3347     return nullptr;
3348
3349   if (unsigned IID = F->getIntrinsicID())
3350     if (Value *Ret =
3351         SimplifyIntrinsic((Intrinsic::ID) IID, ArgBegin, ArgEnd, Q, MaxRecurse))
3352       return Ret;
3353
3354   if (!canConstantFoldCallTo(F))
3355     return nullptr;
3356
3357   SmallVector<Constant *, 4> ConstantArgs;
3358   ConstantArgs.reserve(ArgEnd - ArgBegin);
3359   for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
3360     Constant *C = dyn_cast<Constant>(*I);
3361     if (!C)
3362       return nullptr;
3363     ConstantArgs.push_back(C);
3364   }
3365
3366   return ConstantFoldCall(F, ConstantArgs, Q.TLI);
3367 }
3368
3369 Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
3370                           User::op_iterator ArgEnd, const DataLayout *DL,
3371                           const TargetLibraryInfo *TLI,
3372                           const DominatorTree *DT, AssumptionTracker *AT,
3373                           const Instruction *CxtI) {
3374   return ::SimplifyCall(V, ArgBegin, ArgEnd, Query(DL, TLI, DT, AT, CxtI),
3375                         RecursionLimit);
3376 }
3377
3378 Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
3379                           const DataLayout *DL, const TargetLibraryInfo *TLI,
3380                           const DominatorTree *DT, AssumptionTracker *AT,
3381                           const Instruction *CxtI) {
3382   return ::SimplifyCall(V, Args.begin(), Args.end(),
3383                         Query(DL, TLI, DT, AT, CxtI), RecursionLimit);
3384 }
3385
3386 /// SimplifyInstruction - See if we can compute a simplified version of this
3387 /// instruction.  If not, this returns null.
3388 Value *llvm::SimplifyInstruction(Instruction *I, const DataLayout *DL,
3389                                  const TargetLibraryInfo *TLI,
3390                                  const DominatorTree *DT,
3391                                  AssumptionTracker *AT) {
3392   Value *Result;
3393
3394   switch (I->getOpcode()) {
3395   default:
3396     Result = ConstantFoldInstruction(I, DL, TLI);
3397     break;
3398   case Instruction::FAdd:
3399     Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
3400                               I->getFastMathFlags(), DL, TLI, DT, AT, I);
3401     break;
3402   case Instruction::Add:
3403     Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
3404                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
3405                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3406                              DL, TLI, DT, AT, I);
3407     break;
3408   case Instruction::FSub:
3409     Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
3410                               I->getFastMathFlags(), DL, TLI, DT, AT, I);
3411     break;
3412   case Instruction::Sub:
3413     Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
3414                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
3415                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3416                              DL, TLI, DT, AT, I);
3417     break;
3418   case Instruction::FMul:
3419     Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
3420                               I->getFastMathFlags(), DL, TLI, DT, AT, I);
3421     break;
3422   case Instruction::Mul:
3423     Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1),
3424                              DL, TLI, DT, AT, I);
3425     break;
3426   case Instruction::SDiv:
3427     Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1),
3428                               DL, TLI, DT, AT, I);
3429     break;
3430   case Instruction::UDiv:
3431     Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1),
3432                               DL, TLI, DT, AT, I);
3433     break;
3434   case Instruction::FDiv:
3435     Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
3436                               DL, TLI, DT, AT, I);
3437     break;
3438   case Instruction::SRem:
3439     Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1),
3440                               DL, TLI, DT, AT, I);
3441     break;
3442   case Instruction::URem:
3443     Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1),
3444                               DL, TLI, DT, AT, I);
3445     break;
3446   case Instruction::FRem:
3447     Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
3448                               DL, TLI, DT, AT, I);
3449     break;
3450   case Instruction::Shl:
3451     Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
3452                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
3453                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3454                              DL, TLI, DT, AT, I);
3455     break;
3456   case Instruction::LShr:
3457     Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
3458                               cast<BinaryOperator>(I)->isExact(),
3459                               DL, TLI, DT, AT, I);
3460     break;
3461   case Instruction::AShr:
3462     Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
3463                               cast<BinaryOperator>(I)->isExact(),
3464                               DL, TLI, DT, AT, I);
3465     break;
3466   case Instruction::And:
3467     Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1),
3468                              DL, TLI, DT, AT, I);
3469     break;
3470   case Instruction::Or:
3471     Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
3472                             AT, I);
3473     break;
3474   case Instruction::Xor:
3475     Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1),
3476                              DL, TLI, DT, AT, I);
3477     break;
3478   case Instruction::ICmp:
3479     Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
3480                               I->getOperand(0), I->getOperand(1),
3481                               DL, TLI, DT, AT, I);
3482     break;
3483   case Instruction::FCmp:
3484     Result = SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(),
3485                               I->getOperand(0), I->getOperand(1),
3486                               DL, TLI, DT, AT, I);
3487     break;
3488   case Instruction::Select:
3489     Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
3490                                 I->getOperand(2), DL, TLI, DT, AT, I);
3491     break;
3492   case Instruction::GetElementPtr: {
3493     SmallVector<Value*, 8> Ops(I->op_begin(), I->op_end());
3494     Result = SimplifyGEPInst(Ops, DL, TLI, DT, AT, I);
3495     break;
3496   }
3497   case Instruction::InsertValue: {
3498     InsertValueInst *IV = cast<InsertValueInst>(I);
3499     Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
3500                                      IV->getInsertedValueOperand(),
3501                                      IV->getIndices(), DL, TLI, DT, AT, I);
3502     break;
3503   }
3504   case Instruction::PHI:
3505     Result = SimplifyPHINode(cast<PHINode>(I), Query (DL, TLI, DT, AT, I));
3506     break;
3507   case Instruction::Call: {
3508     CallSite CS(cast<CallInst>(I));
3509     Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
3510                           DL, TLI, DT, AT, I);
3511     break;
3512   }
3513   case Instruction::Trunc:
3514     Result = SimplifyTruncInst(I->getOperand(0), I->getType(), DL, TLI, DT,
3515                                AT, I);
3516     break;
3517   }
3518
3519   /// If called on unreachable code, the above logic may report that the
3520   /// instruction simplified to itself.  Make life easier for users by
3521   /// detecting that case here, returning a safe value instead.
3522   return Result == I ? UndefValue::get(I->getType()) : Result;
3523 }
3524
3525 /// \brief Implementation of recursive simplification through an instructions
3526 /// uses.
3527 ///
3528 /// This is the common implementation of the recursive simplification routines.
3529 /// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
3530 /// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
3531 /// instructions to process and attempt to simplify it using
3532 /// InstructionSimplify.
3533 ///
3534 /// This routine returns 'true' only when *it* simplifies something. The passed
3535 /// in simplified value does not count toward this.
3536 static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
3537                                               const DataLayout *DL,
3538                                               const TargetLibraryInfo *TLI,
3539                                               const DominatorTree *DT,
3540                                               AssumptionTracker *AT) {
3541   bool Simplified = false;
3542   SmallSetVector<Instruction *, 8> Worklist;
3543
3544   // If we have an explicit value to collapse to, do that round of the
3545   // simplification loop by hand initially.
3546   if (SimpleV) {
3547     for (User *U : I->users())
3548       if (U != I)
3549         Worklist.insert(cast<Instruction>(U));
3550
3551     // Replace the instruction with its simplified value.
3552     I->replaceAllUsesWith(SimpleV);
3553
3554     // Gracefully handle edge cases where the instruction is not wired into any
3555     // parent block.
3556     if (I->getParent())
3557       I->eraseFromParent();
3558   } else {
3559     Worklist.insert(I);
3560   }
3561
3562   // Note that we must test the size on each iteration, the worklist can grow.
3563   for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
3564     I = Worklist[Idx];
3565
3566     // See if this instruction simplifies.
3567     SimpleV = SimplifyInstruction(I, DL, TLI, DT, AT);
3568     if (!SimpleV)
3569       continue;
3570
3571     Simplified = true;
3572
3573     // Stash away all the uses of the old instruction so we can check them for
3574     // recursive simplifications after a RAUW. This is cheaper than checking all
3575     // uses of To on the recursive step in most cases.
3576     for (User *U : I->users())
3577       Worklist.insert(cast<Instruction>(U));
3578
3579     // Replace the instruction with its simplified value.
3580     I->replaceAllUsesWith(SimpleV);
3581
3582     // Gracefully handle edge cases where the instruction is not wired into any
3583     // parent block.
3584     if (I->getParent())
3585       I->eraseFromParent();
3586   }
3587   return Simplified;
3588 }
3589
3590 bool llvm::recursivelySimplifyInstruction(Instruction *I,
3591                                           const DataLayout *DL,
3592                                           const TargetLibraryInfo *TLI,
3593                                           const DominatorTree *DT,
3594                                           AssumptionTracker *AT) {
3595   return replaceAndRecursivelySimplifyImpl(I, nullptr, DL, TLI, DT, AT);
3596 }
3597
3598 bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
3599                                          const DataLayout *DL,
3600                                          const TargetLibraryInfo *TLI,
3601                                          const DominatorTree *DT,
3602                                          AssumptionTracker *AT) {
3603   assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
3604   assert(SimpleV && "Must provide a simplified value.");
3605   return replaceAndRecursivelySimplifyImpl(I, SimpleV, DL, TLI, DT, AT);
3606 }