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