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