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