lib/Analysis/InstructionSimplify.cpp

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