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/ADT/Statistic.h"
  22 #include "llvm/Analysis/InstructionSimplify.h"
  23 #include "llvm/Analysis/ConstantFolding.h"
  24 #include "llvm/Analysis/Dominators.h"
  25 #include "llvm/Analysis/ValueTracking.h"
  26 #include "llvm/Support/PatternMatch.h"
  27 #include "llvm/Support/ValueHandle.h"
  28 #include "llvm/Target/TargetData.h"
  29 using namespace llvm;
  30 using namespace llvm::PatternMatch;
  31
  32 #define RecursionLimit 3
  33
  34 STATISTIC(NumExpand,  "Number of expansions");
  35 STATISTIC(NumFactor , "Number of factorizations");
  36 STATISTIC(NumReassoc, "Number of reassociations");
  37
  38 static Value *SimplifyAndInst(Value *, Value *, const TargetData *,
  39                               const DominatorTree *, unsigned);
  40 static Value *SimplifyBinOp(unsigned, Value *, Value *, const TargetData *,
  41                             const DominatorTree *, unsigned);
  42 static Value *SimplifyCmpInst(unsigned, Value *, Value *, const TargetData *,
  43                               const DominatorTree *, unsigned);
  44 static Value *SimplifyOrInst(Value *, Value *, const TargetData *,
  45                              const DominatorTree *, unsigned);
  46 static Value *SimplifyXorInst(Value *, Value *, const TargetData *,
  47                               const DominatorTree *, unsigned);
  48
  49 /// ValueDominatesPHI - Does the given value dominate the specified phi node?
  50 static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
  51   Instruction *I = dyn_cast<Instruction>(V);
  52   if (!I)
  53     // Arguments and constants dominate all instructions.
  54     return true;
  55
  56   // If we have a DominatorTree then do a precise test.
  57   if (DT)
  58     return DT->dominates(I, P);
  59
  60   // Otherwise, if the instruction is in the entry block, and is not an invoke,
  61   // then it obviously dominates all phi nodes.
  62   if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
  63       !isa<InvokeInst>(I))
  64     return true;
  65
  66   return false;
  67 }
  68
  69 /// ExpandBinOp - Simplify "A op (B op' C)" by distributing op over op', turning
  70 /// it into "(A op B) op' (A op C)".  Here "op" is given by Opcode and "op'" is
  71 /// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
  72 /// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
  73 /// Returns the simplified value, or null if no simplification was performed.
  74 static Value *ExpandBinOp(unsigned Opcode, Value *LHS, Value *RHS,
  75                           unsigned OpcToExpand, const TargetData *TD,
  76                           const DominatorTree *DT, unsigned MaxRecurse) {
  77   Instruction::BinaryOps OpcodeToExpand = (Instruction::BinaryOps)OpcToExpand;
  78   // Recursion is always used, so bail out at once if we already hit the limit.
  79   if (!MaxRecurse--)
  80     return 0;
  81
  82   // Check whether the expression has the form "(A op' B) op C".
  83   if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
  84     if (Op0->getOpcode() == OpcodeToExpand) {
  85       // It does!  Try turning it into "(A op C) op' (B op C)".
  86       Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
  87       // Do "A op C" and "B op C" both simplify?
  88       if (Value *L = SimplifyBinOp(Opcode, A, C, TD, DT, MaxRecurse))
  89         if (Value *R = SimplifyBinOp(Opcode, B, C, TD, DT, MaxRecurse)) {
  90           // They do! Return "L op' R" if it simplifies or is already available.
  91           // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
  92           if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
  93                                      && L == B && R == A)) {
  94             ++NumExpand;
  95             return LHS;
  96           }
  97           // Otherwise return "L op' R" if it simplifies.
  98           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, TD, DT,
  99                                        MaxRecurse)) {
 100             ++NumExpand;
 101             return V;
 102           }
 103         }
 104     }
 105
 106   // Check whether the expression has the form "A op (B op' C)".
 107   if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
 108     if (Op1->getOpcode() == OpcodeToExpand) {
 109       // It does!  Try turning it into "(A op B) op' (A op C)".
 110       Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
 111       // Do "A op B" and "A op C" both simplify?
 112       if (Value *L = SimplifyBinOp(Opcode, A, B, TD, DT, MaxRecurse))
 113         if (Value *R = SimplifyBinOp(Opcode, A, C, TD, DT, MaxRecurse)) {
 114           // They do! Return "L op' R" if it simplifies or is already available.
 115           // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
 116           if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
 117                                      && L == C && R == B)) {
 118             ++NumExpand;
 119             return RHS;
 120           }
 121           // Otherwise return "L op' R" if it simplifies.
 122           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, TD, DT,
 123                                        MaxRecurse)) {
 124             ++NumExpand;
 125             return V;
 126           }
 127         }
 128     }
 129
 130   return 0;
 131 }
 132
 133 /// FactorizeBinOp - Simplify "LHS Opcode RHS" by factorizing out a common term
 134 /// using the operation OpCodeToExtract.  For example, when Opcode is Add and
 135 /// OpCodeToExtract is Mul then this tries to turn "(A*B)+(A*C)" into "A*(B+C)".
 136 /// Returns the simplified value, or null if no simplification was performed.
 137 static Value *FactorizeBinOp(unsigned Opcode, Value *LHS, Value *RHS,
 138                              unsigned OpcToExtract, const TargetData *TD,
 139                              const DominatorTree *DT, unsigned MaxRecurse) {
 140   Instruction::BinaryOps OpcodeToExtract = (Instruction::BinaryOps)OpcToExtract;
 141   // Recursion is always used, so bail out at once if we already hit the limit.
 142   if (!MaxRecurse--)
 143     return 0;
 144
 145   BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
 146   BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
 147
 148   if (!Op0 || Op0->getOpcode() != OpcodeToExtract ||
 149       !Op1 || Op1->getOpcode() != OpcodeToExtract)
 150     return 0;
 151
 152   // The expression has the form "(A op' B) op (C op' D)".
 153   Value *A = Op0->getOperand(0), *B = Op0->getOperand(1);
 154   Value *C = Op1->getOperand(0), *D = Op1->getOperand(1);
 155
 156   // Use left distributivity, i.e. "X op' (Y op Z) = (X op' Y) op (X op' Z)".
 157   // Does the instruction have the form "(A op' B) op (A op' D)" or, in the
 158   // commutative case, "(A op' B) op (C op' A)"?
 159   if (A == C || (Instruction::isCommutative(OpcodeToExtract) && A == D)) {
 160     Value *DD = A == C ? D : C;
 161     // Form "A op' (B op DD)" if it simplifies completely.
 162     // Does "B op DD" simplify?
 163     if (Value *V = SimplifyBinOp(Opcode, B, DD, TD, DT, MaxRecurse)) {
 164       // It does!  Return "A op' V" if it simplifies or is already available.
 165       // If V equals B then "A op' V" is just the LHS.  If V equals DD then
 166       // "A op' V" is just the RHS.
 167       if (V == B || V == DD) {
 168         ++NumFactor;
 169         return V == B ? LHS : RHS;
 170       }
 171       // Otherwise return "A op' V" if it simplifies.
 172       if (Value *W = SimplifyBinOp(OpcodeToExtract, A, V, TD, DT, MaxRecurse)) {
 173         ++NumFactor;
 174         return W;
 175       }
 176     }
 177   }
 178
 179   // Use right distributivity, i.e. "(X op Y) op' Z = (X op' Z) op (Y op' Z)".
 180   // Does the instruction have the form "(A op' B) op (C op' B)" or, in the
 181   // commutative case, "(A op' B) op (B op' D)"?
 182   if (B == D || (Instruction::isCommutative(OpcodeToExtract) && B == C)) {
 183     Value *CC = B == D ? C : D;
 184     // Form "(A op CC) op' B" if it simplifies completely..
 185     // Does "A op CC" simplify?
 186     if (Value *V = SimplifyBinOp(Opcode, A, CC, TD, DT, MaxRecurse)) {
 187       // It does!  Return "V op' B" if it simplifies or is already available.
 188       // If V equals A then "V op' B" is just the LHS.  If V equals CC then
 189       // "V op' B" is just the RHS.
 190       if (V == A || V == CC) {
 191         ++NumFactor;
 192         return V == A ? LHS : RHS;
 193       }
 194       // Otherwise return "V op' B" if it simplifies.
 195       if (Value *W = SimplifyBinOp(OpcodeToExtract, V, B, TD, DT, MaxRecurse)) {
 196         ++NumFactor;
 197         return W;
 198       }
 199     }
 200   }
 201
 202   return 0;
 203 }
 204
 205 /// SimplifyAssociativeBinOp - Generic simplifications for associative binary
 206 /// operations.  Returns the simpler value, or null if none was found.
 207 static Value *SimplifyAssociativeBinOp(unsigned Opc, Value *LHS, Value *RHS,
 208                                        const TargetData *TD,
 209                                        const DominatorTree *DT,
 210                                        unsigned MaxRecurse) {
 211   Instruction::BinaryOps Opcode = (Instruction::BinaryOps)Opc;
 212   assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
 213
 214   // Recursion is always used, so bail out at once if we already hit the limit.
 215   if (!MaxRecurse--)
 216     return 0;
 217
 218   BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
 219   BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
 220
 221   // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
 222   if (Op0 && Op0->getOpcode() == Opcode) {
 223     Value *A = Op0->getOperand(0);
 224     Value *B = Op0->getOperand(1);
 225     Value *C = RHS;
 226
 227     // Does "B op C" simplify?
 228     if (Value *V = SimplifyBinOp(Opcode, B, C, TD, DT, MaxRecurse)) {
 229       // It does!  Return "A op V" if it simplifies or is already available.
 230       // If V equals B then "A op V" is just the LHS.
 231       if (V == B) return LHS;
 232       // Otherwise return "A op V" if it simplifies.
 233       if (Value *W = SimplifyBinOp(Opcode, A, V, TD, DT, MaxRecurse)) {
 234         ++NumReassoc;
 235         return W;
 236       }
 237     }
 238   }
 239
 240   // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
 241   if (Op1 && Op1->getOpcode() == Opcode) {
 242     Value *A = LHS;
 243     Value *B = Op1->getOperand(0);
 244     Value *C = Op1->getOperand(1);
 245
 246     // Does "A op B" simplify?
 247     if (Value *V = SimplifyBinOp(Opcode, A, B, TD, DT, MaxRecurse)) {
 248       // It does!  Return "V op C" if it simplifies or is already available.
 249       // If V equals B then "V op C" is just the RHS.
 250       if (V == B) return RHS;
 251       // Otherwise return "V op C" if it simplifies.
 252       if (Value *W = SimplifyBinOp(Opcode, V, C, TD, DT, MaxRecurse)) {
 253         ++NumReassoc;
 254         return W;
 255       }
 256     }
 257   }
 258
 259   // The remaining transforms require commutativity as well as associativity.
 260   if (!Instruction::isCommutative(Opcode))
 261     return 0;
 262
 263   // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
 264   if (Op0 && Op0->getOpcode() == Opcode) {
 265     Value *A = Op0->getOperand(0);
 266     Value *B = Op0->getOperand(1);
 267     Value *C = RHS;
 268
 269     // Does "C op A" simplify?
 270     if (Value *V = SimplifyBinOp(Opcode, C, A, TD, DT, MaxRecurse)) {
 271       // It does!  Return "V op B" if it simplifies or is already available.
 272       // If V equals A then "V op B" is just the LHS.
 273       if (V == A) return LHS;
 274       // Otherwise return "V op B" if it simplifies.
 275       if (Value *W = SimplifyBinOp(Opcode, V, B, TD, DT, MaxRecurse)) {
 276         ++NumReassoc;
 277         return W;
 278       }
 279     }
 280   }
 281
 282   // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
 283   if (Op1 && Op1->getOpcode() == Opcode) {
 284     Value *A = LHS;
 285     Value *B = Op1->getOperand(0);
 286     Value *C = Op1->getOperand(1);
 287
 288     // Does "C op A" simplify?
 289     if (Value *V = SimplifyBinOp(Opcode, C, A, TD, DT, MaxRecurse)) {
 290       // It does!  Return "B op V" if it simplifies or is already available.
 291       // If V equals C then "B op V" is just the RHS.
 292       if (V == C) return RHS;
 293       // Otherwise return "B op V" if it simplifies.
 294       if (Value *W = SimplifyBinOp(Opcode, B, V, TD, DT, MaxRecurse)) {
 295         ++NumReassoc;
 296         return W;
 297       }
 298     }
 299   }
 300
 301   return 0;
 302 }
 303
 304 /// ThreadBinOpOverSelect - In the case of a binary operation with a select
 305 /// instruction as an operand, try to simplify the binop by seeing whether
 306 /// evaluating it on both branches of the select results in the same value.
 307 /// Returns the common value if so, otherwise returns null.
 308 static Value *ThreadBinOpOverSelect(unsigned Opcode, Value *LHS, Value *RHS,
 309                                     const TargetData *TD,
 310                                     const DominatorTree *DT,
 311                                     unsigned MaxRecurse) {
 312   // Recursion is always used, so bail out at once if we already hit the limit.
 313   if (!MaxRecurse--)
 314     return 0;
 315
 316   SelectInst *SI;
 317   if (isa<SelectInst>(LHS)) {
 318     SI = cast<SelectInst>(LHS);
 319   } else {
 320     assert(isa<SelectInst>(RHS) && "No select instruction operand!");
 321     SI = cast<SelectInst>(RHS);
 322   }
 323
 324   // Evaluate the BinOp on the true and false branches of the select.
 325   Value *TV;
 326   Value *FV;
 327   if (SI == LHS) {
 328     TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, TD, DT, MaxRecurse);
 329     FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, TD, DT, MaxRecurse);
 330   } else {
 331     TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), TD, DT, MaxRecurse);
 332     FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), TD, DT, MaxRecurse);
 333   }
 334
 335   // If they simplified to the same value, then return the common value.
 336   // If they both failed to simplify then return null.
 337   if (TV == FV)
 338     return TV;
 339
 340   // If one branch simplified to undef, return the other one.
 341   if (TV && isa<UndefValue>(TV))
 342     return FV;
 343   if (FV && isa<UndefValue>(FV))
 344     return TV;
 345
 346   // If applying the operation did not change the true and false select values,
 347   // then the result of the binop is the select itself.
 348   if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
 349     return SI;
 350
 351   // If one branch simplified and the other did not, and the simplified
 352   // value is equal to the unsimplified one, return the simplified value.
 353   // For example, select (cond, X, X & Z) & Z -> X & Z.
 354   if ((FV && !TV) || (TV && !FV)) {
 355     // Check that the simplified value has the form "X op Y" where "op" is the
 356     // same as the original operation.
 357     Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
 358     if (Simplified && Simplified->getOpcode() == Opcode) {
 359       // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
 360       // We already know that "op" is the same as for the simplified value.  See
 361       // if the operands match too.  If so, return the simplified value.
 362       Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
 363       Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
 364       Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
 365       if (Simplified->getOperand(0) == UnsimplifiedLHS &&
 366           Simplified->getOperand(1) == UnsimplifiedRHS)
 367         return Simplified;
 368       if (Simplified->isCommutative() &&
 369           Simplified->getOperand(1) == UnsimplifiedLHS &&
 370           Simplified->getOperand(0) == UnsimplifiedRHS)
 371         return Simplified;
 372     }
 373   }
 374
 375   return 0;
 376 }
 377
 378 /// ThreadCmpOverSelect - In the case of a comparison with a select instruction,
 379 /// try to simplify the comparison by seeing whether both branches of the select
 380 /// result in the same value.  Returns the common value if so, otherwise returns
 381 /// null.
 382 static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
 383                                   Value *RHS, const TargetData *TD,
 384                                   const DominatorTree *DT,
 385                                   unsigned MaxRecurse) {
 386   // Recursion is always used, so bail out at once if we already hit the limit.
 387   if (!MaxRecurse--)
 388     return 0;
 389
 390   // Make sure the select is on the LHS.
 391   if (!isa<SelectInst>(LHS)) {
 392     std::swap(LHS, RHS);
 393     Pred = CmpInst::getSwappedPredicate(Pred);
 394   }
 395   assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
 396   SelectInst *SI = cast<SelectInst>(LHS);
 397
 398   // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
 399   // Does "cmp TV, RHS" simplify?
 400   if (Value *TCmp = SimplifyCmpInst(Pred, SI->getTrueValue(), RHS, TD, DT,
 401                                     MaxRecurse)) {
 402     // It does!  Does "cmp FV, RHS" simplify?
 403     if (Value *FCmp = SimplifyCmpInst(Pred, SI->getFalseValue(), RHS, TD, DT,
 404                                       MaxRecurse)) {
 405       // It does!  If they simplified to the same value, then use it as the
 406       // result of the original comparison.
 407       if (TCmp == FCmp)
 408         return TCmp;
 409       Value *Cond = SI->getCondition();
 410       // If the false value simplified to false, then the result of the compare
 411       // is equal to "Cond && TCmp".  This also catches the case when the false
 412       // value simplified to false and the true value to true, returning "Cond".
 413       if (match(FCmp, m_Zero()))
 414         if (Value *V = SimplifyAndInst(Cond, TCmp, TD, DT, MaxRecurse))
 415           return V;
 416       // If the true value simplified to true, then the result of the compare
 417       // is equal to "Cond || FCmp".
 418       if (match(TCmp, m_One()))
 419         if (Value *V = SimplifyOrInst(Cond, FCmp, TD, DT, MaxRecurse))
 420           return V;
 421       // Finally, if the false value simplified to true and the true value to
 422       // false, then the result of the compare is equal to "!Cond".
 423       if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
 424         if (Value *V =
 425             SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
 426                             TD, DT, MaxRecurse))
 427           return V;
 428     }
 429   }
 430
 431   return 0;
 432 }
 433
 434 /// ThreadBinOpOverPHI - In the case of a binary operation with an operand that
 435 /// is a PHI instruction, try to simplify the binop by seeing whether evaluating
 436 /// it on the incoming phi values yields the same result for every value.  If so
 437 /// returns the common value, otherwise returns null.
 438 static Value *ThreadBinOpOverPHI(unsigned Opcode, Value *LHS, Value *RHS,
 439                                  const TargetData *TD, const DominatorTree *DT,
 440                                  unsigned MaxRecurse) {
 441   // Recursion is always used, so bail out at once if we already hit the limit.
 442   if (!MaxRecurse--)
 443     return 0;
 444
 445   PHINode *PI;
 446   if (isa<PHINode>(LHS)) {
 447     PI = cast<PHINode>(LHS);
 448     // Bail out if RHS and the phi may be mutually interdependent due to a loop.
 449     if (!ValueDominatesPHI(RHS, PI, DT))
 450       return 0;
 451   } else {
 452     assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
 453     PI = cast<PHINode>(RHS);
 454     // Bail out if LHS and the phi may be mutually interdependent due to a loop.
 455     if (!ValueDominatesPHI(LHS, PI, DT))
 456       return 0;
 457   }
 458
 459   // Evaluate the BinOp on the incoming phi values.
 460   Value *CommonValue = 0;
 461   for (unsigned i = 0, e = PI->getNumIncomingValues(); i != e; ++i) {
 462     Value *Incoming = PI->getIncomingValue(i);
 463     // If the incoming value is the phi node itself, it can safely be skipped.
 464     if (Incoming == PI) continue;
 465     Value *V = PI == LHS ?
 466       SimplifyBinOp(Opcode, Incoming, RHS, TD, DT, MaxRecurse) :
 467       SimplifyBinOp(Opcode, LHS, Incoming, TD, DT, MaxRecurse);
 468     // If the operation failed to simplify, or simplified to a different value
 469     // to previously, then give up.
 470     if (!V || (CommonValue && V != CommonValue))
 471       return 0;
 472     CommonValue = V;
 473   }
 474
 475   return CommonValue;
 476 }
 477
 478 /// ThreadCmpOverPHI - In the case of a comparison with a PHI instruction, try
 479 /// try to simplify the comparison by seeing whether comparing with all of the
 480 /// incoming phi values yields the same result every time.  If so returns the
 481 /// common result, otherwise returns null.
 482 static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
 483                                const TargetData *TD, const DominatorTree *DT,
 484                                unsigned MaxRecurse) {
 485   // Recursion is always used, so bail out at once if we already hit the limit.
 486   if (!MaxRecurse--)
 487     return 0;
 488
 489   // Make sure the phi is on the LHS.
 490   if (!isa<PHINode>(LHS)) {
 491     std::swap(LHS, RHS);
 492     Pred = CmpInst::getSwappedPredicate(Pred);
 493   }
 494   assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
 495   PHINode *PI = cast<PHINode>(LHS);
 496
 497   // Bail out if RHS and the phi may be mutually interdependent due to a loop.
 498   if (!ValueDominatesPHI(RHS, PI, DT))
 499     return 0;
 500
 501   // Evaluate the BinOp on the incoming phi values.
 502   Value *CommonValue = 0;
 503   for (unsigned i = 0, e = PI->getNumIncomingValues(); i != e; ++i) {
 504     Value *Incoming = PI->getIncomingValue(i);
 505     // If the incoming value is the phi node itself, it can safely be skipped.
 506     if (Incoming == PI) continue;
 507     Value *V = SimplifyCmpInst(Pred, Incoming, RHS, TD, DT, MaxRecurse);
 508     // If the operation failed to simplify, or simplified to a different value
 509     // to previously, then give up.
 510     if (!V || (CommonValue && V != CommonValue))
 511       return 0;
 512     CommonValue = V;
 513   }
 514
 515   return CommonValue;
 516 }
 517
 518 /// SimplifyAddInst - Given operands for an Add, see if we can
 519 /// fold the result.  If not, this returns null.
 520 static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 521                               const TargetData *TD, const DominatorTree *DT,
 522                               unsigned MaxRecurse) {
 523   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
 524     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 525       Constant *Ops[] = { CLHS, CRHS };
 526       return ConstantFoldInstOperands(Instruction::Add, CLHS->getType(),
 527                                       Ops, 2, TD);
 528     }
 529
 530     // Canonicalize the constant to the RHS.
 531     std::swap(Op0, Op1);
 532   }
 533
 534   // X + undef -> undef
 535   if (match(Op1, m_Undef()))
 536     return Op1;
 537
 538   // X + 0 -> X
 539   if (match(Op1, m_Zero()))
 540     return Op0;
 541
 542   // X + (Y - X) -> Y
 543   // (Y - X) + X -> Y
 544   // Eg: X + -X -> 0
 545   Value *Y = 0;
 546   if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
 547       match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
 548     return Y;
 549
 550   // X + ~X -> -1   since   ~X = -X-1
 551   if (match(Op0, m_Not(m_Specific(Op1))) ||
 552       match(Op1, m_Not(m_Specific(Op0))))
 553     return Constant::getAllOnesValue(Op0->getType());
 554
 555   /// i1 add -> xor.
 556   if (MaxRecurse && Op0->getType()->isIntegerTy(1))
 557     if (Value *V = SimplifyXorInst(Op0, Op1, TD, DT, MaxRecurse-1))
 558       return V;
 559
 560   // Try some generic simplifications for associative operations.
 561   if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, TD, DT,
 562                                           MaxRecurse))
 563     return V;
 564
 565   // Mul distributes over Add.  Try some generic simplifications based on this.
 566   if (Value *V = FactorizeBinOp(Instruction::Add, Op0, Op1, Instruction::Mul,
 567                                 TD, DT, MaxRecurse))
 568     return V;
 569
 570   // Threading Add over selects and phi nodes is pointless, so don't bother.
 571   // Threading over the select in "A + select(cond, B, C)" means evaluating
 572   // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
 573   // only if B and C are equal.  If B and C are equal then (since we assume
 574   // that operands have already been simplified) "select(cond, B, C)" should
 575   // have been simplified to the common value of B and C already.  Analysing
 576   // "A+B" and "A+C" thus gains nothing, but costs compile time.  Similarly
 577   // for threading over phi nodes.
 578
 579   return 0;
 580 }
 581
 582 Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 583                              const TargetData *TD, const DominatorTree *DT) {
 584   return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW, TD, DT, RecursionLimit);
 585 }
 586
 587 /// SimplifySubInst - Given operands for a Sub, see if we can
 588 /// fold the result.  If not, this returns null.
 589 static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 590                               const TargetData *TD, const DominatorTree *DT,
 591                               unsigned MaxRecurse) {
 592   if (Constant *CLHS = dyn_cast<Constant>(Op0))
 593     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 594       Constant *Ops[] = { CLHS, CRHS };
 595       return ConstantFoldInstOperands(Instruction::Sub, CLHS->getType(),
 596                                       Ops, 2, TD);
 597     }
 598
 599   // X - undef -> undef
 600   // undef - X -> undef
 601   if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
 602     return UndefValue::get(Op0->getType());
 603
 604   // X - 0 -> X
 605   if (match(Op1, m_Zero()))
 606     return Op0;
 607
 608   // X - X -> 0
 609   if (Op0 == Op1)
 610     return Constant::getNullValue(Op0->getType());
 611
 612   // (X*2) - X -> X
 613   // (X<<1) - X -> X
 614   Value *X = 0;
 615   if (match(Op0, m_Mul(m_Specific(Op1), m_ConstantInt<2>())) ||
 616       match(Op0, m_Shl(m_Specific(Op1), m_One())))
 617     return Op1;
 618
 619   // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
 620   // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
 621   Value *Y = 0, *Z = Op1;
 622   if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
 623     // See if "V === Y - Z" simplifies.
 624     if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, TD, DT, MaxRecurse-1))
 625       // It does!  Now see if "X + V" simplifies.
 626       if (Value *W = SimplifyBinOp(Instruction::Add, X, V, TD, DT,
 627                                    MaxRecurse-1)) {
 628         // It does, we successfully reassociated!
 629         ++NumReassoc;
 630         return W;
 631       }
 632     // See if "V === X - Z" simplifies.
 633     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, TD, DT, MaxRecurse-1))
 634       // It does!  Now see if "Y + V" simplifies.
 635       if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, TD, DT,
 636                                    MaxRecurse-1)) {
 637         // It does, we successfully reassociated!
 638         ++NumReassoc;
 639         return W;
 640       }
 641   }
 642
 643   // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
 644   // For example, X - (X + 1) -> -1
 645   X = Op0;
 646   if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
 647     // See if "V === X - Y" simplifies.
 648     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, TD, DT, MaxRecurse-1))
 649       // It does!  Now see if "V - Z" simplifies.
 650       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, TD, DT,
 651                                    MaxRecurse-1)) {
 652         // It does, we successfully reassociated!
 653         ++NumReassoc;
 654         return W;
 655       }
 656     // See if "V === X - Z" simplifies.
 657     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, TD, DT, MaxRecurse-1))
 658       // It does!  Now see if "V - Y" simplifies.
 659       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, TD, DT,
 660                                    MaxRecurse-1)) {
 661         // It does, we successfully reassociated!
 662         ++NumReassoc;
 663         return W;
 664       }
 665   }
 666
 667   // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
 668   // For example, X - (X - Y) -> Y.
 669   Z = Op0;
 670   if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
 671     // See if "V === Z - X" simplifies.
 672     if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, TD, DT, MaxRecurse-1))
 673       // It does!  Now see if "V + Y" simplifies.
 674       if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, TD, DT,
 675                                    MaxRecurse-1)) {
 676         // It does, we successfully reassociated!
 677         ++NumReassoc;
 678         return W;
 679       }
 680
 681   // Mul distributes over Sub.  Try some generic simplifications based on this.
 682   if (Value *V = FactorizeBinOp(Instruction::Sub, Op0, Op1, Instruction::Mul,
 683                                 TD, DT, MaxRecurse))
 684     return V;
 685
 686   // i1 sub -> xor.
 687   if (MaxRecurse && Op0->getType()->isIntegerTy(1))
 688     if (Value *V = SimplifyXorInst(Op0, Op1, TD, DT, MaxRecurse-1))
 689       return V;
 690
 691   // Threading Sub over selects and phi nodes is pointless, so don't bother.
 692   // Threading over the select in "A - select(cond, B, C)" means evaluating
 693   // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
 694   // only if B and C are equal.  If B and C are equal then (since we assume
 695   // that operands have already been simplified) "select(cond, B, C)" should
 696   // have been simplified to the common value of B and C already.  Analysing
 697   // "A-B" and "A-C" thus gains nothing, but costs compile time.  Similarly
 698   // for threading over phi nodes.
 699
 700   return 0;
 701 }
 702
 703 Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 704                              const TargetData *TD, const DominatorTree *DT) {
 705   return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, TD, DT, RecursionLimit);
 706 }
 707
 708 /// SimplifyMulInst - Given operands for a Mul, see if we can
 709 /// fold the result.  If not, this returns null.
 710 static Value *SimplifyMulInst(Value *Op0, Value *Op1, const TargetData *TD,
 711                               const DominatorTree *DT, unsigned MaxRecurse) {
 712   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
 713     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
 714       Constant *Ops[] = { CLHS, CRHS };
 715       return ConstantFoldInstOperands(Instruction::Mul, CLHS->getType(),
 716                                       Ops, 2, TD);
 717     }
 718
 719     // Canonicalize the constant to the RHS.
 720     std::swap(Op0, Op1);
 721   }
 722
 723   // X * undef -> 0
 724   if (match(Op1, m_Undef()))
 725     return Constant::getNullValue(Op0->getType());
 726
 727   // X * 0 -> 0
 728   if (match(Op1, m_Zero()))
 729     return Op1;
 730
 731   // X * 1 -> X
 732   if (match(Op1, m_One()))
 733     return Op0;
 734
 735   // (X / Y) * Y -> X if the division is exact.
 736   Value *X = 0, *Y = 0;
 737   if ((match(Op0, m_Div(m_Value(X), m_Value(Y))) && Y == Op1) || // (X / Y) * Y
 738       (match(Op1, m_Div(m_Value(X), m_Value(Y))) && Y == Op0)) { // Y * (X / Y)
 739     BinaryOperator *Div = cast<BinaryOperator>(Y == Op1 ? Op0 : Op1);
 740     if (Div->isExact())
 741       return X;
 742   }
 743
 744   // i1 mul -> and.
 745   if (MaxRecurse && Op0->getType()->isIntegerTy(1))
 746     if (Value *V = SimplifyAndInst(Op0, Op1, TD, DT, MaxRecurse-1))
 747       return V;
 748
 749   // Try some generic simplifications for associative operations.
 750   if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, TD, DT,
 751                                           MaxRecurse))
 752     return V;
 753
 754   // Mul distributes over Add.  Try some generic simplifications based on this.
 755   if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
 756                              TD, DT, MaxRecurse))
 757     return V;
 758
 759   // If the operation is with the result of a select instruction, check whether
 760   // operating on either branch of the select always yields the same value.
 761   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
 762     if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, TD, DT,
 763                                          MaxRecurse))
 764       return V;
 765
 766   // If the operation is with the result of a phi instruction, check whether
 767   // operating on all incoming values of the phi always yields the same value.
 768   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
 769     if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, TD, DT,
 770                                       MaxRecurse))
 771       return V;
 772
 773   return 0;
 774 }
 775
 776 Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const TargetData *TD,
 777                              const DominatorTree *DT) {
 778   return ::SimplifyMulInst(Op0, Op1, TD, DT, RecursionLimit);
 779 }
 780
 781 /// SimplifyDiv - Given operands for an SDiv or UDiv, see if we can
 782 /// fold the result.  If not, this returns null.
 783 static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
 784                           const TargetData *TD, const DominatorTree *DT,
 785                           unsigned MaxRecurse) {
 786   if (Constant *C0 = dyn_cast<Constant>(Op0)) {
 787     if (Constant *C1 = dyn_cast<Constant>(Op1)) {
 788       Constant *Ops[] = { C0, C1 };
 789       return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, 2, TD);
 790     }
 791   }
 792
 793   bool isSigned = Opcode == Instruction::SDiv;
 794
 795   // X / undef -> undef
 796   if (match(Op1, m_Undef()))
 797     return Op1;
 798
 799   // undef / X -> 0
 800   if (match(Op0, m_Undef()))
 801     return Constant::getNullValue(Op0->getType());
 802
 803   // 0 / X -> 0, we don't need to preserve faults!
 804   if (match(Op0, m_Zero()))
 805     return Op0;
 806
 807   // X / 1 -> X
 808   if (match(Op1, m_One()))
 809     return Op0;
 810
 811   if (Op0->getType()->isIntegerTy(1))
 812     // It can't be division by zero, hence it must be division by one.
 813     return Op0;
 814
 815   // X / X -> 1
 816   if (Op0 == Op1)
 817     return ConstantInt::get(Op0->getType(), 1);
 818
 819   // (X * Y) / Y -> X if the multiplication does not overflow.
 820   Value *X = 0, *Y = 0;
 821   if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
 822     if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
 823     BinaryOperator *Mul = cast<BinaryOperator>(Op0);
 824     // If the Mul knows it does not overflow, then we are good to go.
 825     if ((isSigned && Mul->hasNoSignedWrap()) ||
 826         (!isSigned && Mul->hasNoUnsignedWrap()))
 827       return X;
 828     // If X has the form X = A / Y then X * Y cannot overflow.
 829     if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
 830       if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
 831         return X;
 832   }
 833
 834   // (X rem Y) / Y -> 0
 835   if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
 836       (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
 837     return Constant::getNullValue(Op0->getType());
 838
 839   // If the operation is with the result of a select instruction, check whether
 840   // operating on either branch of the select always yields the same value.
 841   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
 842     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, TD, DT, MaxRecurse))
 843       return V;
 844
 845   // If the operation is with the result of a phi instruction, check whether
 846   // operating on all incoming values of the phi always yields the same value.
 847   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
 848     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, TD, DT, MaxRecurse))
 849       return V;
 850
 851   return 0;
 852 }
 853
 854 /// SimplifySDivInst - Given operands for an SDiv, see if we can
 855 /// fold the result.  If not, this returns null.
 856 static Value *SimplifySDivInst(Value *Op0, Value *Op1, const TargetData *TD,
 857                                const DominatorTree *DT, unsigned MaxRecurse) {
 858   if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, TD, DT, MaxRecurse))
 859     return V;
 860
 861   return 0;
 862 }
 863
 864 Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const TargetData *TD,
 865                               const DominatorTree *DT) {
 866   return ::SimplifySDivInst(Op0, Op1, TD, DT, RecursionLimit);
 867 }
 868
 869 /// SimplifyUDivInst - Given operands for a UDiv, see if we can
 870 /// fold the result.  If not, this returns null.
 871 static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const TargetData *TD,
 872                                const DominatorTree *DT, unsigned MaxRecurse) {
 873   if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, TD, DT, MaxRecurse))
 874     return V;
 875
 876   return 0;
 877 }
 878
 879 Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const TargetData *TD,
 880                               const DominatorTree *DT) {
 881   return ::SimplifyUDivInst(Op0, Op1, TD, DT, RecursionLimit);
 882 }
 883
 884 static Value *SimplifyFDivInst(Value *Op0, Value *Op1, const TargetData *,
 885                                const DominatorTree *, unsigned) {
 886   // undef / X -> undef    (the undef could be a snan).
 887   if (match(Op0, m_Undef()))
 888     return Op0;
 889
 890   // X / undef -> undef
 891   if (match(Op1, m_Undef()))
 892     return Op1;
 893
 894   return 0;
 895 }
 896
 897 Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, const TargetData *TD,
 898                               const DominatorTree *DT) {
 899   return ::SimplifyFDivInst(Op0, Op1, TD, DT, RecursionLimit);
 900 }
 901
 902 /// SimplifyShift - Given operands for an Shl, LShr or AShr, see if we can
 903 /// fold the result.  If not, this returns null.
 904 static Value *SimplifyShift(unsigned Opcode, Value *Op0, Value *Op1,
 905                             const TargetData *TD, const DominatorTree *DT,
 906                             unsigned MaxRecurse) {
 907   if (Constant *C0 = dyn_cast<Constant>(Op0)) {
 908     if (Constant *C1 = dyn_cast<Constant>(Op1)) {
 909       Constant *Ops[] = { C0, C1 };
 910       return ConstantFoldInstOperands(Opcode, C0->getType(), Ops, 2, TD);
 911     }
 912   }
 913
 914   // 0 shift by X -> 0
 915   if (match(Op0, m_Zero()))
 916     return Op0;
 917
 918   // X shift by 0 -> X
 919   if (match(Op1, m_Zero()))
 920     return Op0;
 921
 922   // X shift by undef -> undef because it may shift by the bitwidth.
 923   if (match(Op1, m_Undef()))
 924     return Op1;
 925
 926   // Shifting by the bitwidth or more is undefined.
 927   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1))
 928     if (CI->getValue().getLimitedValue() >=
 929         Op0->getType()->getScalarSizeInBits())
 930       return UndefValue::get(Op0->getType());
 931
 932   // If the operation is with the result of a select instruction, check whether
 933   // operating on either branch of the select always yields the same value.
 934   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
 935     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, TD, DT, MaxRecurse))
 936       return V;
 937
 938   // If the operation is with the result of a phi instruction, check whether
 939   // operating on all incoming values of the phi always yields the same value.
 940   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
 941     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, TD, DT, MaxRecurse))
 942       return V;
 943
 944   return 0;
 945 }
 946
 947 /// SimplifyShlInst - Given operands for an Shl, see if we can
 948 /// fold the result.  If not, this returns null.
 949 static Value *SimplifyShlInst(Value *Op0, Value *Op1, const TargetData *TD,
 950                               const DominatorTree *DT, unsigned MaxRecurse) {
 951   if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, TD, DT, MaxRecurse))
 952     return V;
 953
 954   // undef << X -> 0
 955   if (match(Op0, m_Undef()))
 956     return Constant::getNullValue(Op0->getType());
 957
 958   return 0;
 959 }
 960
 961 Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, const TargetData *TD,
 962                              const DominatorTree *DT) {
 963   return ::SimplifyShlInst(Op0, Op1, TD, DT, RecursionLimit);
 964 }
 965
 966 /// SimplifyLShrInst - Given operands for an LShr, see if we can
 967 /// fold the result.  If not, this returns null.
 968 static Value *SimplifyLShrInst(Value *Op0, Value *Op1, const TargetData *TD,
 969                                const DominatorTree *DT, unsigned MaxRecurse) {
 970   if (Value *V = SimplifyShift(Instruction::LShr, Op0, Op1, TD, DT, MaxRecurse))
 971     return V;
 972
 973   // undef >>l X -> 0
 974   if (match(Op0, m_Undef()))
 975     return Constant::getNullValue(Op0->getType());
 976
 977   return 0;
 978 }
 979
 980 Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, const TargetData *TD,
 981                               const DominatorTree *DT) {
 982   return ::SimplifyLShrInst(Op0, Op1, TD, DT, RecursionLimit);
 983 }
 984
 985 /// SimplifyAShrInst - Given operands for an AShr, see if we can
 986 /// fold the result.  If not, this returns null.
 987 static Value *SimplifyAShrInst(Value *Op0, Value *Op1, const TargetData *TD,
 988                               const DominatorTree *DT, unsigned MaxRecurse) {
 989   if (Value *V = SimplifyShift(Instruction::AShr, Op0, Op1, TD, DT, MaxRecurse))
 990     return V;
 991
 992   // all ones >>a X -> all ones
 993   if (match(Op0, m_AllOnes()))
 994     return Op0;
 995
 996   // undef >>a X -> all ones
 997   if (match(Op0, m_Undef()))
 998     return Constant::getAllOnesValue(Op0->getType());
 999
1000   return 0;
1001 }
1002
1003 Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, const TargetData *TD,
1004                               const DominatorTree *DT) {
1005   return ::SimplifyAShrInst(Op0, Op1, TD, DT, RecursionLimit);
1006 }
1007
1008 /// SimplifyAndInst - Given operands for an And, see if we can
1009 /// fold the result.  If not, this returns null.
1010 static Value *SimplifyAndInst(Value *Op0, Value *Op1, const TargetData *TD,
1011                               const DominatorTree *DT, unsigned MaxRecurse) {
1012   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1013     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1014       Constant *Ops[] = { CLHS, CRHS };
1015       return ConstantFoldInstOperands(Instruction::And, CLHS->getType(),
1016                                       Ops, 2, TD);
1017     }
1018
1019     // Canonicalize the constant to the RHS.
1020     std::swap(Op0, Op1);
1021   }
1022
1023   // X & undef -> 0
1024   if (match(Op1, m_Undef()))
1025     return Constant::getNullValue(Op0->getType());
1026
1027   // X & X = X
1028   if (Op0 == Op1)
1029     return Op0;
1030
1031   // X & 0 = 0
1032   if (match(Op1, m_Zero()))
1033     return Op1;
1034
1035   // X & -1 = X
1036   if (match(Op1, m_AllOnes()))
1037     return Op0;
1038
1039   // A & ~A  =  ~A & A  =  0
1040   Value *A = 0, *B = 0;
1041   if ((match(Op0, m_Not(m_Value(A))) && A == Op1) ||
1042       (match(Op1, m_Not(m_Value(A))) && A == Op0))
1043     return Constant::getNullValue(Op0->getType());
1044
1045   // (A | ?) & A = A
1046   if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
1047       (A == Op1 || B == Op1))
1048     return Op1;
1049
1050   // A & (A | ?) = A
1051   if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
1052       (A == Op0 || B == Op0))
1053     return Op0;
1054
1055   // Try some generic simplifications for associative operations.
1056   if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, TD, DT,
1057                                           MaxRecurse))
1058     return V;
1059
1060   // And distributes over Or.  Try some generic simplifications based on this.
1061   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
1062                              TD, DT, MaxRecurse))
1063     return V;
1064
1065   // And distributes over Xor.  Try some generic simplifications based on this.
1066   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
1067                              TD, DT, MaxRecurse))
1068     return V;
1069
1070   // Or distributes over And.  Try some generic simplifications based on this.
1071   if (Value *V = FactorizeBinOp(Instruction::And, Op0, Op1, Instruction::Or,
1072                                 TD, DT, MaxRecurse))
1073     return V;
1074
1075   // If the operation is with the result of a select instruction, check whether
1076   // operating on either branch of the select always yields the same value.
1077   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1078     if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, TD, DT,
1079                                          MaxRecurse))
1080       return V;
1081
1082   // If the operation is with the result of a phi instruction, check whether
1083   // operating on all incoming values of the phi always yields the same value.
1084   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1085     if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, TD, DT,
1086                                       MaxRecurse))
1087       return V;
1088
1089   return 0;
1090 }
1091
1092 Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const TargetData *TD,
1093                              const DominatorTree *DT) {
1094   return ::SimplifyAndInst(Op0, Op1, TD, DT, RecursionLimit);
1095 }
1096
1097 /// SimplifyOrInst - Given operands for an Or, see if we can
1098 /// fold the result.  If not, this returns null.
1099 static Value *SimplifyOrInst(Value *Op0, Value *Op1, const TargetData *TD,
1100                              const DominatorTree *DT, unsigned MaxRecurse) {
1101   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1102     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1103       Constant *Ops[] = { CLHS, CRHS };
1104       return ConstantFoldInstOperands(Instruction::Or, CLHS->getType(),
1105                                       Ops, 2, TD);
1106     }
1107
1108     // Canonicalize the constant to the RHS.
1109     std::swap(Op0, Op1);
1110   }
1111
1112   // X | undef -> -1
1113   if (match(Op1, m_Undef()))
1114     return Constant::getAllOnesValue(Op0->getType());
1115
1116   // X | X = X
1117   if (Op0 == Op1)
1118     return Op0;
1119
1120   // X | 0 = X
1121   if (match(Op1, m_Zero()))
1122     return Op0;
1123
1124   // X | -1 = -1
1125   if (match(Op1, m_AllOnes()))
1126     return Op1;
1127
1128   // A | ~A  =  ~A | A  =  -1
1129   Value *A = 0, *B = 0;
1130   if ((match(Op0, m_Not(m_Value(A))) && A == Op1) ||
1131       (match(Op1, m_Not(m_Value(A))) && A == Op0))
1132     return Constant::getAllOnesValue(Op0->getType());
1133
1134   // (A & ?) | A = A
1135   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1136       (A == Op1 || B == Op1))
1137     return Op1;
1138
1139   // A | (A & ?) = A
1140   if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1141       (A == Op0 || B == Op0))
1142     return Op0;
1143
1144   // Try some generic simplifications for associative operations.
1145   if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, TD, DT,
1146                                           MaxRecurse))
1147     return V;
1148
1149   // Or distributes over And.  Try some generic simplifications based on this.
1150   if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And,
1151                              TD, DT, MaxRecurse))
1152     return V;
1153
1154   // And distributes over Or.  Try some generic simplifications based on this.
1155   if (Value *V = FactorizeBinOp(Instruction::Or, Op0, Op1, Instruction::And,
1156                                 TD, DT, MaxRecurse))
1157     return V;
1158
1159   // If the operation is with the result of a select instruction, check whether
1160   // operating on either branch of the select always yields the same value.
1161   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1162     if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, TD, DT,
1163                                          MaxRecurse))
1164       return V;
1165
1166   // If the operation is with the result of a phi instruction, check whether
1167   // operating on all incoming values of the phi always yields the same value.
1168   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1169     if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, TD, DT,
1170                                       MaxRecurse))
1171       return V;
1172
1173   return 0;
1174 }
1175
1176 Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const TargetData *TD,
1177                             const DominatorTree *DT) {
1178   return ::SimplifyOrInst(Op0, Op1, TD, DT, RecursionLimit);
1179 }
1180
1181 /// SimplifyXorInst - Given operands for a Xor, see if we can
1182 /// fold the result.  If not, this returns null.
1183 static Value *SimplifyXorInst(Value *Op0, Value *Op1, const TargetData *TD,
1184                               const DominatorTree *DT, unsigned MaxRecurse) {
1185   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1186     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1187       Constant *Ops[] = { CLHS, CRHS };
1188       return ConstantFoldInstOperands(Instruction::Xor, CLHS->getType(),
1189                                       Ops, 2, TD);
1190     }
1191
1192     // Canonicalize the constant to the RHS.
1193     std::swap(Op0, Op1);
1194   }
1195
1196   // A ^ undef -> undef
1197   if (match(Op1, m_Undef()))
1198     return Op1;
1199
1200   // A ^ 0 = A
1201   if (match(Op1, m_Zero()))
1202     return Op0;
1203
1204   // A ^ A = 0
1205   if (Op0 == Op1)
1206     return Constant::getNullValue(Op0->getType());
1207
1208   // A ^ ~A  =  ~A ^ A  =  -1
1209   Value *A = 0;
1210   if ((match(Op0, m_Not(m_Value(A))) && A == Op1) ||
1211       (match(Op1, m_Not(m_Value(A))) && A == Op0))
1212     return Constant::getAllOnesValue(Op0->getType());
1213
1214   // Try some generic simplifications for associative operations.
1215   if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, TD, DT,
1216                                           MaxRecurse))
1217     return V;
1218
1219   // And distributes over Xor.  Try some generic simplifications based on this.
1220   if (Value *V = FactorizeBinOp(Instruction::Xor, Op0, Op1, Instruction::And,
1221                                 TD, DT, MaxRecurse))
1222     return V;
1223
1224   // Threading Xor over selects and phi nodes is pointless, so don't bother.
1225   // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1226   // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1227   // only if B and C are equal.  If B and C are equal then (since we assume
1228   // that operands have already been simplified) "select(cond, B, C)" should
1229   // have been simplified to the common value of B and C already.  Analysing
1230   // "A^B" and "A^C" thus gains nothing, but costs compile time.  Similarly
1231   // for threading over phi nodes.
1232
1233   return 0;
1234 }
1235
1236 Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const TargetData *TD,
1237                              const DominatorTree *DT) {
1238   return ::SimplifyXorInst(Op0, Op1, TD, DT, RecursionLimit);
1239 }
1240
1241 static const Type *GetCompareTy(Value *Op) {
1242   return CmpInst::makeCmpResultType(Op->getType());
1243 }
1244
1245 /// SimplifyICmpInst - Given operands for an ICmpInst, see if we can
1246 /// fold the result.  If not, this returns null.
1247 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
1248                                const TargetData *TD, const DominatorTree *DT,
1249                                unsigned MaxRecurse) {
1250   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
1251   assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
1252
1253   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
1254     if (Constant *CRHS = dyn_cast<Constant>(RHS))
1255       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, TD);
1256
1257     // If we have a constant, make sure it is on the RHS.
1258     std::swap(LHS, RHS);
1259     Pred = CmpInst::getSwappedPredicate(Pred);
1260   }
1261
1262   const Type *ITy = GetCompareTy(LHS); // The return type.
1263   const Type *OpTy = LHS->getType();   // The operand type.
1264
1265   // icmp X, X -> true/false
1266   // X icmp undef -> true/false.  For example, icmp ugt %X, undef -> false
1267   // because X could be 0.
1268   if (LHS == RHS || isa<UndefValue>(RHS))
1269     return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
1270
1271   // Special case logic when the operands have i1 type.
1272   if (OpTy->isIntegerTy(1) || (OpTy->isVectorTy() &&
1273        cast<VectorType>(OpTy)->getElementType()->isIntegerTy(1))) {
1274     switch (Pred) {
1275     default: break;
1276     case ICmpInst::ICMP_EQ:
1277       // X == 1 -> X
1278       if (match(RHS, m_One()))
1279         return LHS;
1280       break;
1281     case ICmpInst::ICMP_NE:
1282       // X != 0 -> X
1283       if (match(RHS, m_Zero()))
1284         return LHS;
1285       break;
1286     case ICmpInst::ICMP_UGT:
1287       // X >u 0 -> X
1288       if (match(RHS, m_Zero()))
1289         return LHS;
1290       break;
1291     case ICmpInst::ICMP_UGE:
1292       // X >=u 1 -> X
1293       if (match(RHS, m_One()))
1294         return LHS;
1295       break;
1296     case ICmpInst::ICMP_SLT:
1297       // X <s 0 -> X
1298       if (match(RHS, m_Zero()))
1299         return LHS;
1300       break;
1301     case ICmpInst::ICMP_SLE:
1302       // X <=s -1 -> X
1303       if (match(RHS, m_One()))
1304         return LHS;
1305       break;
1306     }
1307   }
1308
1309   // icmp <alloca*>, <global/alloca*/null> - Different stack variables have
1310   // different addresses, and what's more the address of a stack variable is
1311   // never null or equal to the address of a global.  Note that generalizing
1312   // to the case where LHS is a global variable address or null is pointless,
1313   // since if both LHS and RHS are constants then we already constant folded
1314   // the compare, and if only one of them is then we moved it to RHS already.
1315   if (isa<AllocaInst>(LHS) && (isa<GlobalValue>(RHS) || isa<AllocaInst>(RHS) ||
1316                                isa<ConstantPointerNull>(RHS)))
1317     // We already know that LHS != LHS.
1318     return ConstantInt::get(ITy, CmpInst::isFalseWhenEqual(Pred));
1319
1320   // If we are comparing with zero then try hard since this is a common case.
1321   if (match(RHS, m_Zero())) {
1322     bool LHSKnownNonNegative, LHSKnownNegative;
1323     switch (Pred) {
1324     default:
1325       assert(false && "Unknown ICmp predicate!");
1326     case ICmpInst::ICMP_ULT:
1327       return ConstantInt::getFalse(LHS->getContext());
1328     case ICmpInst::ICMP_UGE:
1329       return ConstantInt::getTrue(LHS->getContext());
1330     case ICmpInst::ICMP_EQ:
1331     case ICmpInst::ICMP_ULE:
1332       if (isKnownNonZero(LHS, TD))
1333         return ConstantInt::getFalse(LHS->getContext());
1334       break;
1335     case ICmpInst::ICMP_NE:
1336     case ICmpInst::ICMP_UGT:
1337       if (isKnownNonZero(LHS, TD))
1338         return ConstantInt::getTrue(LHS->getContext());
1339       break;
1340     case ICmpInst::ICMP_SLT:
1341       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, TD);
1342       if (LHSKnownNegative)
1343         return ConstantInt::getTrue(LHS->getContext());
1344       if (LHSKnownNonNegative)
1345         return ConstantInt::getFalse(LHS->getContext());
1346       break;
1347     case ICmpInst::ICMP_SLE:
1348       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, TD);
1349       if (LHSKnownNegative)
1350         return ConstantInt::getTrue(LHS->getContext());
1351       if (LHSKnownNonNegative && isKnownNonZero(LHS, TD))
1352         return ConstantInt::getFalse(LHS->getContext());
1353       break;
1354     case ICmpInst::ICMP_SGE:
1355       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, TD);
1356       if (LHSKnownNegative)
1357         return ConstantInt::getFalse(LHS->getContext());
1358       if (LHSKnownNonNegative)
1359         return ConstantInt::getTrue(LHS->getContext());
1360       break;
1361     case ICmpInst::ICMP_SGT:
1362       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, TD);
1363       if (LHSKnownNegative)
1364         return ConstantInt::getFalse(LHS->getContext());
1365       if (LHSKnownNonNegative && isKnownNonZero(LHS, TD))
1366         return ConstantInt::getTrue(LHS->getContext());
1367       break;
1368     }
1369   }
1370
1371   // See if we are doing a comparison with a constant integer.
1372   if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
1373     switch (Pred) {
1374     default: break;
1375     case ICmpInst::ICMP_UGT:
1376       if (CI->isMaxValue(false))                 // A >u MAX -> FALSE
1377         return ConstantInt::getFalse(CI->getContext());
1378       break;
1379     case ICmpInst::ICMP_UGE:
1380       if (CI->isMinValue(false))                 // A >=u MIN -> TRUE
1381         return ConstantInt::getTrue(CI->getContext());
1382       break;
1383     case ICmpInst::ICMP_ULT:
1384       if (CI->isMinValue(false))                 // A <u MIN -> FALSE
1385         return ConstantInt::getFalse(CI->getContext());
1386       break;
1387     case ICmpInst::ICMP_ULE:
1388       if (CI->isMaxValue(false))                 // A <=u MAX -> TRUE
1389         return ConstantInt::getTrue(CI->getContext());
1390       break;
1391     case ICmpInst::ICMP_SGT:
1392       if (CI->isMaxValue(true))                  // A >s MAX -> FALSE
1393         return ConstantInt::getFalse(CI->getContext());
1394       break;
1395     case ICmpInst::ICMP_SGE:
1396       if (CI->isMinValue(true))                  // A >=s MIN -> TRUE
1397         return ConstantInt::getTrue(CI->getContext());
1398       break;
1399     case ICmpInst::ICMP_SLT:
1400       if (CI->isMinValue(true))                  // A <s MIN -> FALSE
1401         return ConstantInt::getFalse(CI->getContext());
1402       break;
1403     case ICmpInst::ICMP_SLE:
1404       if (CI->isMaxValue(true))                  // A <=s MAX -> TRUE
1405         return ConstantInt::getTrue(CI->getContext());
1406       break;
1407     }
1408   }
1409
1410   // Compare of cast, for example (zext X) != 0 -> X != 0
1411   if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
1412     Instruction *LI = cast<CastInst>(LHS);
1413     Value *SrcOp = LI->getOperand(0);
1414     const Type *SrcTy = SrcOp->getType();
1415     const Type *DstTy = LI->getType();
1416
1417     // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
1418     // if the integer type is the same size as the pointer type.
1419     if (MaxRecurse && TD && isa<PtrToIntInst>(LI) &&
1420         TD->getPointerSizeInBits() == DstTy->getPrimitiveSizeInBits()) {
1421       if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
1422         // Transfer the cast to the constant.
1423         if (Value *V = SimplifyICmpInst(Pred, SrcOp,
1424                                         ConstantExpr::getIntToPtr(RHSC, SrcTy),
1425                                         TD, DT, MaxRecurse-1))
1426           return V;
1427       } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
1428         if (RI->getOperand(0)->getType() == SrcTy)
1429           // Compare without the cast.
1430           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
1431                                           TD, DT, MaxRecurse-1))
1432             return V;
1433       }
1434     }
1435
1436     if (isa<ZExtInst>(LHS)) {
1437       // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
1438       // same type.
1439       if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
1440         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
1441           // Compare X and Y.  Note that signed predicates become unsigned.
1442           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
1443                                           SrcOp, RI->getOperand(0), TD, DT,
1444                                           MaxRecurse-1))
1445             return V;
1446       }
1447       // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
1448       // too.  If not, then try to deduce the result of the comparison.
1449       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
1450         // Compute the constant that would happen if we truncated to SrcTy then
1451         // reextended to DstTy.
1452         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
1453         Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
1454
1455         // If the re-extended constant didn't change then this is effectively
1456         // also a case of comparing two zero-extended values.
1457         if (RExt == CI && MaxRecurse)
1458           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
1459                                           SrcOp, Trunc, TD, DT, MaxRecurse-1))
1460             return V;
1461
1462         // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
1463         // there.  Use this to work out the result of the comparison.
1464         if (RExt != CI) {
1465           switch (Pred) {
1466           default:
1467             assert(false && "Unknown ICmp predicate!");
1468           // LHS <u RHS.
1469           case ICmpInst::ICMP_EQ:
1470           case ICmpInst::ICMP_UGT:
1471           case ICmpInst::ICMP_UGE:
1472             return ConstantInt::getFalse(CI->getContext());
1473
1474           case ICmpInst::ICMP_NE:
1475           case ICmpInst::ICMP_ULT:
1476           case ICmpInst::ICMP_ULE:
1477             return ConstantInt::getTrue(CI->getContext());
1478
1479           // LHS is non-negative.  If RHS is negative then LHS >s LHS.  If RHS
1480           // is non-negative then LHS <s RHS.
1481           case ICmpInst::ICMP_SGT:
1482           case ICmpInst::ICMP_SGE:
1483             return CI->getValue().isNegative() ?
1484               ConstantInt::getTrue(CI->getContext()) :
1485               ConstantInt::getFalse(CI->getContext());
1486
1487           case ICmpInst::ICMP_SLT:
1488           case ICmpInst::ICMP_SLE:
1489             return CI->getValue().isNegative() ?
1490               ConstantInt::getFalse(CI->getContext()) :
1491               ConstantInt::getTrue(CI->getContext());
1492           }
1493         }
1494       }
1495     }
1496
1497     if (isa<SExtInst>(LHS)) {
1498       // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
1499       // same type.
1500       if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
1501         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
1502           // Compare X and Y.  Note that the predicate does not change.
1503           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
1504                                           TD, DT, MaxRecurse-1))
1505             return V;
1506       }
1507       // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
1508       // too.  If not, then try to deduce the result of the comparison.
1509       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
1510         // Compute the constant that would happen if we truncated to SrcTy then
1511         // reextended to DstTy.
1512         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
1513         Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
1514
1515         // If the re-extended constant didn't change then this is effectively
1516         // also a case of comparing two sign-extended values.
1517         if (RExt == CI && MaxRecurse)
1518           if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, TD, DT,
1519                                           MaxRecurse-1))
1520             return V;
1521
1522         // Otherwise the upper bits of LHS are all equal, while RHS has varying
1523         // bits there.  Use this to work out the result of the comparison.
1524         if (RExt != CI) {
1525           switch (Pred) {
1526           default:
1527             assert(false && "Unknown ICmp predicate!");
1528           case ICmpInst::ICMP_EQ:
1529             return ConstantInt::getFalse(CI->getContext());
1530           case ICmpInst::ICMP_NE:
1531             return ConstantInt::getTrue(CI->getContext());
1532
1533           // If RHS is non-negative then LHS <s RHS.  If RHS is negative then
1534           // LHS >s RHS.
1535           case ICmpInst::ICMP_SGT:
1536           case ICmpInst::ICMP_SGE:
1537             return CI->getValue().isNegative() ?
1538               ConstantInt::getTrue(CI->getContext()) :
1539               ConstantInt::getFalse(CI->getContext());
1540           case ICmpInst::ICMP_SLT:
1541           case ICmpInst::ICMP_SLE:
1542             return CI->getValue().isNegative() ?
1543               ConstantInt::getFalse(CI->getContext()) :
1544               ConstantInt::getTrue(CI->getContext());
1545
1546           // If LHS is non-negative then LHS <u RHS.  If LHS is negative then
1547           // LHS >u RHS.
1548           case ICmpInst::ICMP_UGT:
1549           case ICmpInst::ICMP_UGE:
1550             // Comparison is true iff the LHS <s 0.
1551             if (MaxRecurse)
1552               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
1553                                               Constant::getNullValue(SrcTy),
1554                                               TD, DT, MaxRecurse-1))
1555                 return V;
1556             break;
1557           case ICmpInst::ICMP_ULT:
1558           case ICmpInst::ICMP_ULE:
1559             // Comparison is true iff the LHS >=s 0.
1560             if (MaxRecurse)
1561               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
1562                                               Constant::getNullValue(SrcTy),
1563                                               TD, DT, MaxRecurse-1))
1564                 return V;
1565             break;
1566           }
1567         }
1568       }
1569     }
1570   }
1571
1572   // If the comparison is with the result of a select instruction, check whether
1573   // comparing with either branch of the select always yields the same value.
1574   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
1575     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, TD, DT, MaxRecurse))
1576       return V;
1577
1578   // If the comparison is with the result of a phi instruction, check whether
1579   // doing the compare with each incoming phi value yields a common result.
1580   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
1581     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, TD, DT, MaxRecurse))
1582       return V;
1583
1584   return 0;
1585 }
1586
1587 Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
1588                               const TargetData *TD, const DominatorTree *DT) {
1589   return ::SimplifyICmpInst(Predicate, LHS, RHS, TD, DT, RecursionLimit);
1590 }
1591
1592 /// SimplifyFCmpInst - Given operands for an FCmpInst, see if we can
1593 /// fold the result.  If not, this returns null.
1594 static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
1595                                const TargetData *TD, const DominatorTree *DT,
1596                                unsigned MaxRecurse) {
1597   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
1598   assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
1599
1600   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
1601     if (Constant *CRHS = dyn_cast<Constant>(RHS))
1602       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, TD);
1603
1604     // If we have a constant, make sure it is on the RHS.
1605     std::swap(LHS, RHS);
1606     Pred = CmpInst::getSwappedPredicate(Pred);
1607   }
1608
1609   // Fold trivial predicates.
1610   if (Pred == FCmpInst::FCMP_FALSE)
1611     return ConstantInt::get(GetCompareTy(LHS), 0);
1612   if (Pred == FCmpInst::FCMP_TRUE)
1613     return ConstantInt::get(GetCompareTy(LHS), 1);
1614
1615   if (isa<UndefValue>(RHS))                  // fcmp pred X, undef -> undef
1616     return UndefValue::get(GetCompareTy(LHS));
1617
1618   // fcmp x,x -> true/false.  Not all compares are foldable.
1619   if (LHS == RHS) {
1620     if (CmpInst::isTrueWhenEqual(Pred))
1621       return ConstantInt::get(GetCompareTy(LHS), 1);
1622     if (CmpInst::isFalseWhenEqual(Pred))
1623       return ConstantInt::get(GetCompareTy(LHS), 0);
1624   }
1625
1626   // Handle fcmp with constant RHS
1627   if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
1628     // If the constant is a nan, see if we can fold the comparison based on it.
1629     if (ConstantFP *CFP = dyn_cast<ConstantFP>(RHSC)) {
1630       if (CFP->getValueAPF().isNaN()) {
1631         if (FCmpInst::isOrdered(Pred))   // True "if ordered and foo"
1632           return ConstantInt::getFalse(CFP->getContext());
1633         assert(FCmpInst::isUnordered(Pred) &&
1634                "Comparison must be either ordered or unordered!");
1635         // True if unordered.
1636         return ConstantInt::getTrue(CFP->getContext());
1637       }
1638       // Check whether the constant is an infinity.
1639       if (CFP->getValueAPF().isInfinity()) {
1640         if (CFP->getValueAPF().isNegative()) {
1641           switch (Pred) {
1642           case FCmpInst::FCMP_OLT:
1643             // No value is ordered and less than negative infinity.
1644             return ConstantInt::getFalse(CFP->getContext());
1645           case FCmpInst::FCMP_UGE:
1646             // All values are unordered with or at least negative infinity.
1647             return ConstantInt::getTrue(CFP->getContext());
1648           default:
1649             break;
1650           }
1651         } else {
1652           switch (Pred) {
1653           case FCmpInst::FCMP_OGT:
1654             // No value is ordered and greater than infinity.
1655             return ConstantInt::getFalse(CFP->getContext());
1656           case FCmpInst::FCMP_ULE:
1657             // All values are unordered with and at most infinity.
1658             return ConstantInt::getTrue(CFP->getContext());
1659           default:
1660             break;
1661           }
1662         }
1663       }
1664     }
1665   }
1666
1667   // If the comparison is with the result of a select instruction, check whether
1668   // comparing with either branch of the select always yields the same value.
1669   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
1670     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, TD, DT, MaxRecurse))
1671       return V;
1672
1673   // If the comparison is with the result of a phi instruction, check whether
1674   // doing the compare with each incoming phi value yields a common result.
1675   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
1676     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, TD, DT, MaxRecurse))
1677       return V;
1678
1679   return 0;
1680 }
1681
1682 Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
1683                               const TargetData *TD, const DominatorTree *DT) {
1684   return ::SimplifyFCmpInst(Predicate, LHS, RHS, TD, DT, RecursionLimit);
1685 }
1686
1687 /// SimplifySelectInst - Given operands for a SelectInst, see if we can fold
1688 /// the result.  If not, this returns null.
1689 Value *llvm::SimplifySelectInst(Value *CondVal, Value *TrueVal, Value *FalseVal,
1690                                 const TargetData *TD, const DominatorTree *) {
1691   // select true, X, Y  -> X
1692   // select false, X, Y -> Y
1693   if (ConstantInt *CB = dyn_cast<ConstantInt>(CondVal))
1694     return CB->getZExtValue() ? TrueVal : FalseVal;
1695
1696   // select C, X, X -> X
1697   if (TrueVal == FalseVal)
1698     return TrueVal;
1699
1700   if (isa<UndefValue>(TrueVal))   // select C, undef, X -> X
1701     return FalseVal;
1702   if (isa<UndefValue>(FalseVal))   // select C, X, undef -> X
1703     return TrueVal;
1704   if (isa<UndefValue>(CondVal)) {  // select undef, X, Y -> X or Y
1705     if (isa<Constant>(TrueVal))
1706       return TrueVal;
1707     return FalseVal;
1708   }
1709
1710   return 0;
1711 }
1712
1713 /// SimplifyGEPInst - Given operands for an GetElementPtrInst, see if we can
1714 /// fold the result.  If not, this returns null.
1715 Value *llvm::SimplifyGEPInst(Value *const *Ops, unsigned NumOps,
1716                              const TargetData *TD, const DominatorTree *) {
1717   // The type of the GEP pointer operand.
1718   const PointerType *PtrTy = cast<PointerType>(Ops[0]->getType());
1719
1720   // getelementptr P -> P.
1721   if (NumOps == 1)
1722     return Ops[0];
1723
1724   if (isa<UndefValue>(Ops[0])) {
1725     // Compute the (pointer) type returned by the GEP instruction.
1726     const Type *LastType = GetElementPtrInst::getIndexedType(PtrTy, &Ops[1],
1727                                                              NumOps-1);
1728     const Type *GEPTy = PointerType::get(LastType, PtrTy->getAddressSpace());
1729     return UndefValue::get(GEPTy);
1730   }
1731
1732   if (NumOps == 2) {
1733     // getelementptr P, 0 -> P.
1734     if (ConstantInt *C = dyn_cast<ConstantInt>(Ops[1]))
1735       if (C->isZero())
1736         return Ops[0];
1737     // getelementptr P, N -> P if P points to a type of zero size.
1738     if (TD) {
1739       const Type *Ty = PtrTy->getElementType();
1740       if (Ty->isSized() && TD->getTypeAllocSize(Ty) == 0)
1741         return Ops[0];
1742     }
1743   }
1744
1745   // Check to see if this is constant foldable.
1746   for (unsigned i = 0; i != NumOps; ++i)
1747     if (!isa<Constant>(Ops[i]))
1748       return 0;
1749
1750   return ConstantExpr::getGetElementPtr(cast<Constant>(Ops[0]),
1751                                         (Constant *const*)Ops+1, NumOps-1);
1752 }
1753
1754 /// SimplifyPHINode - See if we can fold the given phi.  If not, returns null.
1755 static Value *SimplifyPHINode(PHINode *PN, const DominatorTree *DT) {
1756   // If all of the PHI's incoming values are the same then replace the PHI node
1757   // with the common value.
1758   Value *CommonValue = 0;
1759   bool HasUndefInput = false;
1760   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1761     Value *Incoming = PN->getIncomingValue(i);
1762     // If the incoming value is the phi node itself, it can safely be skipped.
1763     if (Incoming == PN) continue;
1764     if (isa<UndefValue>(Incoming)) {
1765       // Remember that we saw an undef value, but otherwise ignore them.
1766       HasUndefInput = true;
1767       continue;
1768     }
1769     if (CommonValue && Incoming != CommonValue)
1770       return 0;  // Not the same, bail out.
1771     CommonValue = Incoming;
1772   }
1773
1774   // If CommonValue is null then all of the incoming values were either undef or
1775   // equal to the phi node itself.
1776   if (!CommonValue)
1777     return UndefValue::get(PN->getType());
1778
1779   // If we have a PHI node like phi(X, undef, X), where X is defined by some
1780   // instruction, we cannot return X as the result of the PHI node unless it
1781   // dominates the PHI block.
1782   if (HasUndefInput)
1783     return ValueDominatesPHI(CommonValue, PN, DT) ? CommonValue : 0;
1784
1785   return CommonValue;
1786 }
1787
1788
1789 //=== Helper functions for higher up the class hierarchy.
1790
1791 /// SimplifyBinOp - Given operands for a BinaryOperator, see if we can
1792 /// fold the result.  If not, this returns null.
1793 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
1794                             const TargetData *TD, const DominatorTree *DT,
1795                             unsigned MaxRecurse) {
1796   switch (Opcode) {
1797   case Instruction::Add: return SimplifyAddInst(LHS, RHS, /* isNSW */ false,
1798                                                 /* isNUW */ false, TD, DT,
1799                                                 MaxRecurse);
1800   case Instruction::Sub: return SimplifySubInst(LHS, RHS, /* isNSW */ false,
1801                                                 /* isNUW */ false, TD, DT,
1802                                                 MaxRecurse);
1803   case Instruction::Mul: return SimplifyMulInst(LHS, RHS, TD, DT, MaxRecurse);
1804   case Instruction::SDiv: return SimplifySDivInst(LHS, RHS, TD, DT, MaxRecurse);
1805   case Instruction::UDiv: return SimplifyUDivInst(LHS, RHS, TD, DT, MaxRecurse);
1806   case Instruction::FDiv: return SimplifyFDivInst(LHS, RHS, TD, DT, MaxRecurse);
1807   case Instruction::Shl: return SimplifyShlInst(LHS, RHS, TD, DT, MaxRecurse);
1808   case Instruction::LShr: return SimplifyLShrInst(LHS, RHS, TD, DT, MaxRecurse);
1809   case Instruction::AShr: return SimplifyAShrInst(LHS, RHS, TD, DT, MaxRecurse);
1810   case Instruction::And: return SimplifyAndInst(LHS, RHS, TD, DT, MaxRecurse);
1811   case Instruction::Or:  return SimplifyOrInst(LHS, RHS, TD, DT, MaxRecurse);
1812   case Instruction::Xor: return SimplifyXorInst(LHS, RHS, TD, DT, MaxRecurse);
1813   default:
1814     if (Constant *CLHS = dyn_cast<Constant>(LHS))
1815       if (Constant *CRHS = dyn_cast<Constant>(RHS)) {
1816         Constant *COps[] = {CLHS, CRHS};
1817         return ConstantFoldInstOperands(Opcode, LHS->getType(), COps, 2, TD);
1818       }
1819
1820     // If the operation is associative, try some generic simplifications.
1821     if (Instruction::isAssociative(Opcode))
1822       if (Value *V = SimplifyAssociativeBinOp(Opcode, LHS, RHS, TD, DT,
1823                                               MaxRecurse))
1824         return V;
1825
1826     // If the operation is with the result of a select instruction, check whether
1827     // operating on either branch of the select always yields the same value.
1828     if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
1829       if (Value *V = ThreadBinOpOverSelect(Opcode, LHS, RHS, TD, DT,
1830                                            MaxRecurse))
1831         return V;
1832
1833     // If the operation is with the result of a phi instruction, check whether
1834     // operating on all incoming values of the phi always yields the same value.
1835     if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
1836       if (Value *V = ThreadBinOpOverPHI(Opcode, LHS, RHS, TD, DT, MaxRecurse))
1837         return V;
1838
1839     return 0;
1840   }
1841 }
1842
1843 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
1844                            const TargetData *TD, const DominatorTree *DT) {
1845   return ::SimplifyBinOp(Opcode, LHS, RHS, TD, DT, RecursionLimit);
1846 }
1847
1848 /// SimplifyCmpInst - Given operands for a CmpInst, see if we can
1849 /// fold the result.
1850 static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
1851                               const TargetData *TD, const DominatorTree *DT,
1852                               unsigned MaxRecurse) {
1853   if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
1854     return SimplifyICmpInst(Predicate, LHS, RHS, TD, DT, MaxRecurse);
1855   return SimplifyFCmpInst(Predicate, LHS, RHS, TD, DT, MaxRecurse);
1856 }
1857
1858 Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
1859                              const TargetData *TD, const DominatorTree *DT) {
1860   return ::SimplifyCmpInst(Predicate, LHS, RHS, TD, DT, RecursionLimit);
1861 }
1862
1863 /// SimplifyInstruction - See if we can compute a simplified version of this
1864 /// instruction.  If not, this returns null.
1865 Value *llvm::SimplifyInstruction(Instruction *I, const TargetData *TD,
1866                                  const DominatorTree *DT) {
1867   Value *Result;
1868
1869   switch (I->getOpcode()) {
1870   default:
1871     Result = ConstantFoldInstruction(I, TD);
1872     break;
1873   case Instruction::Add:
1874     Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
1875                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
1876                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
1877                              TD, DT);
1878     break;
1879   case Instruction::Sub:
1880     Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
1881                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
1882                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
1883                              TD, DT);
1884     break;
1885   case Instruction::Mul:
1886     Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), TD, DT);
1887     break;
1888   case Instruction::SDiv:
1889     Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), TD, DT);
1890     break;
1891   case Instruction::UDiv:
1892     Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), TD, DT);
1893     break;
1894   case Instruction::FDiv:
1895     Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1), TD, DT);
1896     break;
1897   case Instruction::Shl:
1898     Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1), TD, DT);
1899     break;
1900   case Instruction::LShr:
1901     Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1), TD, DT);
1902     break;
1903   case Instruction::AShr:
1904     Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1), TD, DT);
1905     break;
1906   case Instruction::And:
1907     Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), TD, DT);
1908     break;
1909   case Instruction::Or:
1910     Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), TD, DT);
1911     break;
1912   case Instruction::Xor:
1913     Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), TD, DT);
1914     break;
1915   case Instruction::ICmp:
1916     Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
1917                               I->getOperand(0), I->getOperand(1), TD, DT);
1918     break;
1919   case Instruction::FCmp:
1920     Result = SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(),
1921                               I->getOperand(0), I->getOperand(1), TD, DT);
1922     break;
1923   case Instruction::Select:
1924     Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
1925                                 I->getOperand(2), TD, DT);
1926     break;
1927   case Instruction::GetElementPtr: {
1928     SmallVector<Value*, 8> Ops(I->op_begin(), I->op_end());
1929     Result = SimplifyGEPInst(&Ops[0], Ops.size(), TD, DT);
1930     break;
1931   }
1932   case Instruction::PHI:
1933     Result = SimplifyPHINode(cast<PHINode>(I), DT);
1934     break;
1935   }
1936
1937   /// If called on unreachable code, the above logic may report that the
1938   /// instruction simplified to itself.  Make life easier for users by
1939   /// detecting that case here, returning a safe value instead.
1940   return Result == I ? UndefValue::get(I->getType()) : Result;
1941 }
1942
1943 /// ReplaceAndSimplifyAllUses - Perform From->replaceAllUsesWith(To) and then
1944 /// delete the From instruction.  In addition to a basic RAUW, this does a
1945 /// recursive simplification of the newly formed instructions.  This catches
1946 /// things where one simplification exposes other opportunities.  This only
1947 /// simplifies and deletes scalar operations, it does not change the CFG.
1948 ///
1949 void llvm::ReplaceAndSimplifyAllUses(Instruction *From, Value *To,
1950                                      const TargetData *TD,
1951                                      const DominatorTree *DT) {
1952   assert(From != To && "ReplaceAndSimplifyAllUses(X,X) is not valid!");
1953
1954   // FromHandle/ToHandle - This keeps a WeakVH on the from/to values so that
1955   // we can know if it gets deleted out from under us or replaced in a
1956   // recursive simplification.
1957   WeakVH FromHandle(From);
1958   WeakVH ToHandle(To);
1959
1960   while (!From->use_empty()) {
1961     // Update the instruction to use the new value.
1962     Use &TheUse = From->use_begin().getUse();
1963     Instruction *User = cast<Instruction>(TheUse.getUser());
1964     TheUse = To;
1965
1966     // Check to see if the instruction can be folded due to the operand
1967     // replacement.  For example changing (or X, Y) into (or X, -1) can replace
1968     // the 'or' with -1.
1969     Value *SimplifiedVal;
1970     {
1971       // Sanity check to make sure 'User' doesn't dangle across
1972       // SimplifyInstruction.
1973       AssertingVH<> UserHandle(User);
1974
1975       SimplifiedVal = SimplifyInstruction(User, TD, DT);
1976       if (SimplifiedVal == 0) continue;
1977     }
1978
1979     // Recursively simplify this user to the new value.
1980     ReplaceAndSimplifyAllUses(User, SimplifiedVal, TD, DT);
1981     From = dyn_cast_or_null<Instruction>((Value*)FromHandle);
1982     To = ToHandle;
1983
1984     assert(ToHandle && "To value deleted by recursive simplification?");
1985
1986     // If the recursive simplification ended up revisiting and deleting
1987     // 'From' then we're done.
1988     if (From == 0)
1989       return;
1990   }
1991
1992   // If 'From' has value handles referring to it, do a real RAUW to update them.
1993   From->replaceAllUsesWith(To);
1994
1995   From->eraseFromParent();
1996 }