lib/Analysis/InstructionSimplify.cpp

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