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