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