Revert "r223364 - Revert r223347 which has caused crashes on bootstrap bots."
[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 // Simplify (and (icmp ...) (icmp ...)) to true when we can tell that the range
1447 // of possible values cannot be satisfied.
1448 static Value *SimplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1449   ICmpInst::Predicate Pred0, Pred1;
1450   ConstantInt *CI1, *CI2;
1451   Value *V;
1452   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_ConstantInt(CI1)),
1453                          m_ConstantInt(CI2))))
1454    return nullptr;
1455
1456   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Specific(CI1))))
1457     return nullptr;
1458
1459   Type *ITy = Op0->getType();
1460
1461   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1462   bool isNSW = AddInst->hasNoSignedWrap();
1463   bool isNUW = AddInst->hasNoUnsignedWrap();
1464
1465   const APInt &CI1V = CI1->getValue();
1466   const APInt &CI2V = CI2->getValue();
1467   const APInt Delta = CI2V - CI1V;
1468   if (CI1V.isStrictlyPositive()) {
1469     if (Delta == 2) {
1470       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1471         return getFalse(ITy);
1472       if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1473         return getFalse(ITy);
1474     }
1475     if (Delta == 1) {
1476       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1477         return getFalse(ITy);
1478       if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1479         return getFalse(ITy);
1480     }
1481   }
1482   if (CI1V.getBoolValue() && isNUW) {
1483     if (Delta == 2)
1484       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1485         return getFalse(ITy);
1486     if (Delta == 1)
1487       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1488         return getFalse(ITy);
1489   }
1490
1491   return nullptr;
1492 }
1493
1494 /// SimplifyAndInst - Given operands for an And, see if we can
1495 /// fold the result.  If not, this returns null.
1496 static Value *SimplifyAndInst(Value *Op0, Value *Op1, const Query &Q,
1497                               unsigned MaxRecurse) {
1498   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1499     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1500       Constant *Ops[] = { CLHS, CRHS };
1501       return ConstantFoldInstOperands(Instruction::And, CLHS->getType(),
1502                                       Ops, Q.DL, Q.TLI);
1503     }
1504
1505     // Canonicalize the constant to the RHS.
1506     std::swap(Op0, Op1);
1507   }
1508
1509   // X & undef -> 0
1510   if (match(Op1, m_Undef()))
1511     return Constant::getNullValue(Op0->getType());
1512
1513   // X & X = X
1514   if (Op0 == Op1)
1515     return Op0;
1516
1517   // X & 0 = 0
1518   if (match(Op1, m_Zero()))
1519     return Op1;
1520
1521   // X & -1 = X
1522   if (match(Op1, m_AllOnes()))
1523     return Op0;
1524
1525   // A & ~A  =  ~A & A  =  0
1526   if (match(Op0, m_Not(m_Specific(Op1))) ||
1527       match(Op1, m_Not(m_Specific(Op0))))
1528     return Constant::getNullValue(Op0->getType());
1529
1530   // (A | ?) & A = A
1531   Value *A = nullptr, *B = nullptr;
1532   if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
1533       (A == Op1 || B == Op1))
1534     return Op1;
1535
1536   // A & (A | ?) = A
1537   if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
1538       (A == Op0 || B == Op0))
1539     return Op0;
1540
1541   // A & (-A) = A if A is a power of two or zero.
1542   if (match(Op0, m_Neg(m_Specific(Op1))) ||
1543       match(Op1, m_Neg(m_Specific(Op0)))) {
1544     if (isKnownToBeAPowerOfTwo(Op0, /*OrZero*/true, 0, Q.AT, Q.CxtI, Q.DT))
1545       return Op0;
1546     if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/true, 0, Q.AT, Q.CxtI, Q.DT))
1547       return Op1;
1548   }
1549
1550   if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1551     if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1552       if (Value *V = SimplifyAndOfICmps(ICILHS, ICIRHS))
1553         return V;
1554       if (Value *V = SimplifyAndOfICmps(ICIRHS, ICILHS))
1555         return V;
1556     }
1557   }
1558
1559   // Try some generic simplifications for associative operations.
1560   if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1561                                           MaxRecurse))
1562     return V;
1563
1564   // And distributes over Or.  Try some generic simplifications based on this.
1565   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
1566                              Q, MaxRecurse))
1567     return V;
1568
1569   // And distributes over Xor.  Try some generic simplifications based on this.
1570   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
1571                              Q, MaxRecurse))
1572     return V;
1573
1574   // If the operation is with the result of a select instruction, check whether
1575   // operating on either branch of the select always yields the same value.
1576   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1577     if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1578                                          MaxRecurse))
1579       return V;
1580
1581   // If the operation is with the result of a phi instruction, check whether
1582   // operating on all incoming values of the phi always yields the same value.
1583   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1584     if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
1585                                       MaxRecurse))
1586       return V;
1587
1588   return nullptr;
1589 }
1590
1591 Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const DataLayout *DL,
1592                              const TargetLibraryInfo *TLI,
1593                              const DominatorTree *DT, AssumptionTracker *AT,
1594                              const Instruction *CxtI) {
1595   return ::SimplifyAndInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1596                            RecursionLimit);
1597 }
1598
1599 // Simplify (or (icmp ...) (icmp ...)) to true when we can tell that the union
1600 // contains all possible values.
1601 static Value *SimplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1602   ICmpInst::Predicate Pred0, Pred1;
1603   ConstantInt *CI1, *CI2;
1604   Value *V;
1605   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_ConstantInt(CI1)),
1606                          m_ConstantInt(CI2))))
1607    return nullptr;
1608
1609   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Specific(CI1))))
1610     return nullptr;
1611
1612   Type *ITy = Op0->getType();
1613
1614   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1615   bool isNSW = AddInst->hasNoSignedWrap();
1616   bool isNUW = AddInst->hasNoUnsignedWrap();
1617
1618   const APInt &CI1V = CI1->getValue();
1619   const APInt &CI2V = CI2->getValue();
1620   const APInt Delta = CI2V - CI1V;
1621   if (CI1V.isStrictlyPositive()) {
1622     if (Delta == 2) {
1623       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1624         return getTrue(ITy);
1625       if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1626         return getTrue(ITy);
1627     }
1628     if (Delta == 1) {
1629       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1630         return getTrue(ITy);
1631       if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1632         return getTrue(ITy);
1633     }
1634   }
1635   if (CI1V.getBoolValue() && isNUW) {
1636     if (Delta == 2)
1637       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1638         return getTrue(ITy);
1639     if (Delta == 1)
1640       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1641         return getTrue(ITy);
1642   }
1643
1644   return nullptr;
1645 }
1646
1647 /// SimplifyOrInst - Given operands for an Or, see if we can
1648 /// fold the result.  If not, this returns null.
1649 static Value *SimplifyOrInst(Value *Op0, Value *Op1, const Query &Q,
1650                              unsigned MaxRecurse) {
1651   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1652     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1653       Constant *Ops[] = { CLHS, CRHS };
1654       return ConstantFoldInstOperands(Instruction::Or, CLHS->getType(),
1655                                       Ops, Q.DL, Q.TLI);
1656     }
1657
1658     // Canonicalize the constant to the RHS.
1659     std::swap(Op0, Op1);
1660   }
1661
1662   // X | undef -> -1
1663   if (match(Op1, m_Undef()))
1664     return Constant::getAllOnesValue(Op0->getType());
1665
1666   // X | X = X
1667   if (Op0 == Op1)
1668     return Op0;
1669
1670   // X | 0 = X
1671   if (match(Op1, m_Zero()))
1672     return Op0;
1673
1674   // X | -1 = -1
1675   if (match(Op1, m_AllOnes()))
1676     return Op1;
1677
1678   // A | ~A  =  ~A | A  =  -1
1679   if (match(Op0, m_Not(m_Specific(Op1))) ||
1680       match(Op1, m_Not(m_Specific(Op0))))
1681     return Constant::getAllOnesValue(Op0->getType());
1682
1683   // (A & ?) | A = A
1684   Value *A = nullptr, *B = nullptr;
1685   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1686       (A == Op1 || B == Op1))
1687     return Op1;
1688
1689   // A | (A & ?) = A
1690   if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1691       (A == Op0 || B == Op0))
1692     return Op0;
1693
1694   // ~(A & ?) | A = -1
1695   if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1696       (A == Op1 || B == Op1))
1697     return Constant::getAllOnesValue(Op1->getType());
1698
1699   // A | ~(A & ?) = -1
1700   if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1701       (A == Op0 || B == Op0))
1702     return Constant::getAllOnesValue(Op0->getType());
1703
1704   if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1705     if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1706       if (Value *V = SimplifyOrOfICmps(ICILHS, ICIRHS))
1707         return V;
1708       if (Value *V = SimplifyOrOfICmps(ICIRHS, ICILHS))
1709         return V;
1710     }
1711   }
1712
1713   // Try some generic simplifications for associative operations.
1714   if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1715                                           MaxRecurse))
1716     return V;
1717
1718   // Or distributes over And.  Try some generic simplifications based on this.
1719   if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1720                              MaxRecurse))
1721     return V;
1722
1723   // If the operation is with the result of a select instruction, check whether
1724   // operating on either branch of the select always yields the same value.
1725   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1726     if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
1727                                          MaxRecurse))
1728       return V;
1729
1730   // (A & C)|(B & D)
1731   Value *C = nullptr, *D = nullptr;
1732   if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1733       match(Op1, m_And(m_Value(B), m_Value(D)))) {
1734     ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1735     ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1736     if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1737       // (A & C1)|(B & C2)
1738       // If we have: ((V + N) & C1) | (V & C2)
1739       // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1740       // replace with V+N.
1741       Value *V1, *V2;
1742       if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1743           match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1744         // Add commutes, try both ways.
1745         if (V1 == B && MaskedValueIsZero(V2, C2->getValue(), Q.DL,
1746                                          0, Q.AT, Q.CxtI, Q.DT))
1747           return A;
1748         if (V2 == B && MaskedValueIsZero(V1, C2->getValue(), Q.DL,
1749                                          0, Q.AT, Q.CxtI, Q.DT))
1750           return A;
1751       }
1752       // Or commutes, try both ways.
1753       if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1754           match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1755         // Add commutes, try both ways.
1756         if (V1 == A && MaskedValueIsZero(V2, C1->getValue(), Q.DL,
1757                                          0, Q.AT, Q.CxtI, Q.DT))
1758           return B;
1759         if (V2 == A && MaskedValueIsZero(V1, C1->getValue(), Q.DL,
1760                                          0, Q.AT, Q.CxtI, Q.DT))
1761           return B;
1762       }
1763     }
1764   }
1765
1766   // If the operation is with the result of a phi instruction, check whether
1767   // operating on all incoming values of the phi always yields the same value.
1768   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1769     if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
1770       return V;
1771
1772   return nullptr;
1773 }
1774
1775 Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const DataLayout *DL,
1776                             const TargetLibraryInfo *TLI,
1777                             const DominatorTree *DT, AssumptionTracker *AT,
1778                             const Instruction *CxtI) {
1779   return ::SimplifyOrInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1780                           RecursionLimit);
1781 }
1782
1783 /// SimplifyXorInst - Given operands for a Xor, see if we can
1784 /// fold the result.  If not, this returns null.
1785 static Value *SimplifyXorInst(Value *Op0, Value *Op1, const Query &Q,
1786                               unsigned MaxRecurse) {
1787   if (Constant *CLHS = dyn_cast<Constant>(Op0)) {
1788     if (Constant *CRHS = dyn_cast<Constant>(Op1)) {
1789       Constant *Ops[] = { CLHS, CRHS };
1790       return ConstantFoldInstOperands(Instruction::Xor, CLHS->getType(),
1791                                       Ops, Q.DL, Q.TLI);
1792     }
1793
1794     // Canonicalize the constant to the RHS.
1795     std::swap(Op0, Op1);
1796   }
1797
1798   // A ^ undef -> undef
1799   if (match(Op1, m_Undef()))
1800     return Op1;
1801
1802   // A ^ 0 = A
1803   if (match(Op1, m_Zero()))
1804     return Op0;
1805
1806   // A ^ A = 0
1807   if (Op0 == Op1)
1808     return Constant::getNullValue(Op0->getType());
1809
1810   // A ^ ~A  =  ~A ^ A  =  -1
1811   if (match(Op0, m_Not(m_Specific(Op1))) ||
1812       match(Op1, m_Not(m_Specific(Op0))))
1813     return Constant::getAllOnesValue(Op0->getType());
1814
1815   // Try some generic simplifications for associative operations.
1816   if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1817                                           MaxRecurse))
1818     return V;
1819
1820   // Threading Xor over selects and phi nodes is pointless, so don't bother.
1821   // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1822   // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1823   // only if B and C are equal.  If B and C are equal then (since we assume
1824   // that operands have already been simplified) "select(cond, B, C)" should
1825   // have been simplified to the common value of B and C already.  Analysing
1826   // "A^B" and "A^C" thus gains nothing, but costs compile time.  Similarly
1827   // for threading over phi nodes.
1828
1829   return nullptr;
1830 }
1831
1832 Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const DataLayout *DL,
1833                              const TargetLibraryInfo *TLI,
1834                              const DominatorTree *DT, AssumptionTracker *AT,
1835                              const Instruction *CxtI) {
1836   return ::SimplifyXorInst(Op0, Op1, Query (DL, TLI, DT, AT, CxtI),
1837                            RecursionLimit);
1838 }
1839
1840 static Type *GetCompareTy(Value *Op) {
1841   return CmpInst::makeCmpResultType(Op->getType());
1842 }
1843
1844 /// ExtractEquivalentCondition - Rummage around inside V looking for something
1845 /// equivalent to the comparison "LHS Pred RHS".  Return such a value if found,
1846 /// otherwise return null.  Helper function for analyzing max/min idioms.
1847 static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
1848                                          Value *LHS, Value *RHS) {
1849   SelectInst *SI = dyn_cast<SelectInst>(V);
1850   if (!SI)
1851     return nullptr;
1852   CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
1853   if (!Cmp)
1854     return nullptr;
1855   Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
1856   if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
1857     return Cmp;
1858   if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
1859       LHS == CmpRHS && RHS == CmpLHS)
1860     return Cmp;
1861   return nullptr;
1862 }
1863
1864 // A significant optimization not implemented here is assuming that alloca
1865 // addresses are not equal to incoming argument values. They don't *alias*,
1866 // as we say, but that doesn't mean they aren't equal, so we take a
1867 // conservative approach.
1868 //
1869 // This is inspired in part by C++11 5.10p1:
1870 //   "Two pointers of the same type compare equal if and only if they are both
1871 //    null, both point to the same function, or both represent the same
1872 //    address."
1873 //
1874 // This is pretty permissive.
1875 //
1876 // It's also partly due to C11 6.5.9p6:
1877 //   "Two pointers compare equal if and only if both are null pointers, both are
1878 //    pointers to the same object (including a pointer to an object and a
1879 //    subobject at its beginning) or function, both are pointers to one past the
1880 //    last element of the same array object, or one is a pointer to one past the
1881 //    end of one array object and the other is a pointer to the start of a
1882 //    different array object that happens to immediately follow the first array
1883 //    object in the address space.)
1884 //
1885 // C11's version is more restrictive, however there's no reason why an argument
1886 // couldn't be a one-past-the-end value for a stack object in the caller and be
1887 // equal to the beginning of a stack object in the callee.
1888 //
1889 // If the C and C++ standards are ever made sufficiently restrictive in this
1890 // area, it may be possible to update LLVM's semantics accordingly and reinstate
1891 // this optimization.
1892 static Constant *computePointerICmp(const DataLayout *DL,
1893                                     const TargetLibraryInfo *TLI,
1894                                     CmpInst::Predicate Pred,
1895                                     Value *LHS, Value *RHS) {
1896   // First, skip past any trivial no-ops.
1897   LHS = LHS->stripPointerCasts();
1898   RHS = RHS->stripPointerCasts();
1899
1900   // A non-null pointer is not equal to a null pointer.
1901   if (llvm::isKnownNonNull(LHS, TLI) && isa<ConstantPointerNull>(RHS) &&
1902       (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
1903     return ConstantInt::get(GetCompareTy(LHS),
1904                             !CmpInst::isTrueWhenEqual(Pred));
1905
1906   // We can only fold certain predicates on pointer comparisons.
1907   switch (Pred) {
1908   default:
1909     return nullptr;
1910
1911     // Equality comaprisons are easy to fold.
1912   case CmpInst::ICMP_EQ:
1913   case CmpInst::ICMP_NE:
1914     break;
1915
1916     // We can only handle unsigned relational comparisons because 'inbounds' on
1917     // a GEP only protects against unsigned wrapping.
1918   case CmpInst::ICMP_UGT:
1919   case CmpInst::ICMP_UGE:
1920   case CmpInst::ICMP_ULT:
1921   case CmpInst::ICMP_ULE:
1922     // However, we have to switch them to their signed variants to handle
1923     // negative indices from the base pointer.
1924     Pred = ICmpInst::getSignedPredicate(Pred);
1925     break;
1926   }
1927
1928   // Strip off any constant offsets so that we can reason about them.
1929   // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
1930   // here and compare base addresses like AliasAnalysis does, however there are
1931   // numerous hazards. AliasAnalysis and its utilities rely on special rules
1932   // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
1933   // doesn't need to guarantee pointer inequality when it says NoAlias.
1934   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
1935   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
1936
1937   // If LHS and RHS are related via constant offsets to the same base
1938   // value, we can replace it with an icmp which just compares the offsets.
1939   if (LHS == RHS)
1940     return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
1941
1942   // Various optimizations for (in)equality comparisons.
1943   if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
1944     // Different non-empty allocations that exist at the same time have
1945     // different addresses (if the program can tell). Global variables always
1946     // exist, so they always exist during the lifetime of each other and all
1947     // allocas. Two different allocas usually have different addresses...
1948     //
1949     // However, if there's an @llvm.stackrestore dynamically in between two
1950     // allocas, they may have the same address. It's tempting to reduce the
1951     // scope of the problem by only looking at *static* allocas here. That would
1952     // cover the majority of allocas while significantly reducing the likelihood
1953     // of having an @llvm.stackrestore pop up in the middle. However, it's not
1954     // actually impossible for an @llvm.stackrestore to pop up in the middle of
1955     // an entry block. Also, if we have a block that's not attached to a
1956     // function, we can't tell if it's "static" under the current definition.
1957     // Theoretically, this problem could be fixed by creating a new kind of
1958     // instruction kind specifically for static allocas. Such a new instruction
1959     // could be required to be at the top of the entry block, thus preventing it
1960     // from being subject to a @llvm.stackrestore. Instcombine could even
1961     // convert regular allocas into these special allocas. It'd be nifty.
1962     // However, until then, this problem remains open.
1963     //
1964     // So, we'll assume that two non-empty allocas have different addresses
1965     // for now.
1966     //
1967     // With all that, if the offsets are within the bounds of their allocations
1968     // (and not one-past-the-end! so we can't use inbounds!), and their
1969     // allocations aren't the same, the pointers are not equal.
1970     //
1971     // Note that it's not necessary to check for LHS being a global variable
1972     // address, due to canonicalization and constant folding.
1973     if (isa<AllocaInst>(LHS) &&
1974         (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
1975       ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
1976       ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
1977       uint64_t LHSSize, RHSSize;
1978       if (LHSOffsetCI && RHSOffsetCI &&
1979           getObjectSize(LHS, LHSSize, DL, TLI) &&
1980           getObjectSize(RHS, RHSSize, DL, TLI)) {
1981         const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
1982         const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
1983         if (!LHSOffsetValue.isNegative() &&
1984             !RHSOffsetValue.isNegative() &&
1985             LHSOffsetValue.ult(LHSSize) &&
1986             RHSOffsetValue.ult(RHSSize)) {
1987           return ConstantInt::get(GetCompareTy(LHS),
1988                                   !CmpInst::isTrueWhenEqual(Pred));
1989         }
1990       }
1991
1992       // Repeat the above check but this time without depending on DataLayout
1993       // or being able to compute a precise size.
1994       if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
1995           !cast<PointerType>(RHS->getType())->isEmptyTy() &&
1996           LHSOffset->isNullValue() &&
1997           RHSOffset->isNullValue())
1998         return ConstantInt::get(GetCompareTy(LHS),
1999                                 !CmpInst::isTrueWhenEqual(Pred));
2000     }
2001
2002     // Even if an non-inbounds GEP occurs along the path we can still optimize
2003     // equality comparisons concerning the result. We avoid walking the whole
2004     // chain again by starting where the last calls to
2005     // stripAndComputeConstantOffsets left off and accumulate the offsets.
2006     Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2007     Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
2008     if (LHS == RHS)
2009       return ConstantExpr::getICmp(Pred,
2010                                    ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2011                                    ConstantExpr::getAdd(RHSOffset, RHSNoBound));
2012
2013     // If one side of the equality comparison must come from a noalias call
2014     // (meaning a system memory allocation function), and the other side must
2015     // come from a pointer that cannot overlap with dynamically-allocated
2016     // memory within the lifetime of the current function (allocas, byval
2017     // arguments, globals), then determine the comparison result here.
2018     SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2019     GetUnderlyingObjects(LHS, LHSUObjs, DL);
2020     GetUnderlyingObjects(RHS, RHSUObjs, DL);
2021
2022     // Is the set of underlying objects all noalias calls?
2023     auto IsNAC = [](SmallVectorImpl<Value *> &Objects) {
2024       return std::all_of(Objects.begin(), Objects.end(),
2025                          [](Value *V){ return isNoAliasCall(V); });
2026     };
2027
2028     // Is the set of underlying objects all things which must be disjoint from
2029     // noalias calls. For allocas, we consider only static ones (dynamic
2030     // allocas might be transformed into calls to malloc not simultaneously
2031     // live with the compared-to allocation). For globals, we exclude symbols
2032     // that might be resolve lazily to symbols in another dynamically-loaded
2033     // library (and, thus, could be malloc'ed by the implementation).
2034     auto IsAllocDisjoint = [](SmallVectorImpl<Value *> &Objects) {
2035       return std::all_of(Objects.begin(), Objects.end(),
2036                          [](Value *V){
2037                            if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2038                              return AI->getParent() && AI->getParent()->getParent() &&
2039                                     AI->isStaticAlloca();
2040                            if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2041                              return (GV->hasLocalLinkage() ||
2042                                      GV->hasHiddenVisibility() ||
2043                                      GV->hasProtectedVisibility() ||
2044                                      GV->hasUnnamedAddr()) &&
2045                                     !GV->isThreadLocal();
2046                            if (const Argument *A = dyn_cast<Argument>(V))
2047                              return A->hasByValAttr();
2048                            return false;
2049                          });
2050     };
2051
2052     if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2053         (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2054         return ConstantInt::get(GetCompareTy(LHS),
2055                                 !CmpInst::isTrueWhenEqual(Pred));
2056   }
2057
2058   // Otherwise, fail.
2059   return nullptr;
2060 }
2061
2062 /// SimplifyICmpInst - Given operands for an ICmpInst, see if we can
2063 /// fold the result.  If not, this returns null.
2064 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2065                                const Query &Q, unsigned MaxRecurse) {
2066   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
2067   assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
2068
2069   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
2070     if (Constant *CRHS = dyn_cast<Constant>(RHS))
2071       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
2072
2073     // If we have a constant, make sure it is on the RHS.
2074     std::swap(LHS, RHS);
2075     Pred = CmpInst::getSwappedPredicate(Pred);
2076   }
2077
2078   Type *ITy = GetCompareTy(LHS); // The return type.
2079   Type *OpTy = LHS->getType();   // The operand type.
2080
2081   // icmp X, X -> true/false
2082   // X icmp undef -> true/false.  For example, icmp ugt %X, undef -> false
2083   // because X could be 0.
2084   if (LHS == RHS || isa<UndefValue>(RHS))
2085     return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
2086
2087   // Special case logic when the operands have i1 type.
2088   if (OpTy->getScalarType()->isIntegerTy(1)) {
2089     switch (Pred) {
2090     default: break;
2091     case ICmpInst::ICMP_EQ:
2092       // X == 1 -> X
2093       if (match(RHS, m_One()))
2094         return LHS;
2095       break;
2096     case ICmpInst::ICMP_NE:
2097       // X != 0 -> X
2098       if (match(RHS, m_Zero()))
2099         return LHS;
2100       break;
2101     case ICmpInst::ICMP_UGT:
2102       // X >u 0 -> X
2103       if (match(RHS, m_Zero()))
2104         return LHS;
2105       break;
2106     case ICmpInst::ICMP_UGE:
2107       // X >=u 1 -> X
2108       if (match(RHS, m_One()))
2109         return LHS;
2110       break;
2111     case ICmpInst::ICMP_SLT:
2112       // X <s 0 -> X
2113       if (match(RHS, m_Zero()))
2114         return LHS;
2115       break;
2116     case ICmpInst::ICMP_SLE:
2117       // X <=s -1 -> X
2118       if (match(RHS, m_One()))
2119         return LHS;
2120       break;
2121     }
2122   }
2123
2124   // If we are comparing with zero then try hard since this is a common case.
2125   if (match(RHS, m_Zero())) {
2126     bool LHSKnownNonNegative, LHSKnownNegative;
2127     switch (Pred) {
2128     default: llvm_unreachable("Unknown ICmp predicate!");
2129     case ICmpInst::ICMP_ULT:
2130       return getFalse(ITy);
2131     case ICmpInst::ICMP_UGE:
2132       return getTrue(ITy);
2133     case ICmpInst::ICMP_EQ:
2134     case ICmpInst::ICMP_ULE:
2135       if (isKnownNonZero(LHS, Q.DL, 0, Q.AT, Q.CxtI, Q.DT))
2136         return getFalse(ITy);
2137       break;
2138     case ICmpInst::ICMP_NE:
2139     case ICmpInst::ICMP_UGT:
2140       if (isKnownNonZero(LHS, Q.DL, 0, Q.AT, Q.CxtI, Q.DT))
2141         return getTrue(ITy);
2142       break;
2143     case ICmpInst::ICMP_SLT:
2144       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2145                      0, Q.AT, Q.CxtI, Q.DT);
2146       if (LHSKnownNegative)
2147         return getTrue(ITy);
2148       if (LHSKnownNonNegative)
2149         return getFalse(ITy);
2150       break;
2151     case ICmpInst::ICMP_SLE:
2152       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2153                      0, Q.AT, Q.CxtI, Q.DT);
2154       if (LHSKnownNegative)
2155         return getTrue(ITy);
2156       if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL,
2157                                                 0, Q.AT, Q.CxtI, Q.DT))
2158         return getFalse(ITy);
2159       break;
2160     case ICmpInst::ICMP_SGE:
2161       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2162                      0, Q.AT, Q.CxtI, Q.DT);
2163       if (LHSKnownNegative)
2164         return getFalse(ITy);
2165       if (LHSKnownNonNegative)
2166         return getTrue(ITy);
2167       break;
2168     case ICmpInst::ICMP_SGT:
2169       ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL,
2170                      0, Q.AT, Q.CxtI, Q.DT);
2171       if (LHSKnownNegative)
2172         return getFalse(ITy);
2173       if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 
2174                                                 0, Q.AT, Q.CxtI, Q.DT))
2175         return getTrue(ITy);
2176       break;
2177     }
2178   }
2179
2180   // See if we are doing a comparison with a constant integer.
2181   if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2182     // Rule out tautological comparisons (eg., ult 0 or uge 0).
2183     ConstantRange RHS_CR = ICmpInst::makeConstantRange(Pred, CI->getValue());
2184     if (RHS_CR.isEmptySet())
2185       return ConstantInt::getFalse(CI->getContext());
2186     if (RHS_CR.isFullSet())
2187       return ConstantInt::getTrue(CI->getContext());
2188
2189     // Many binary operators with constant RHS have easy to compute constant
2190     // range.  Use them to check whether the comparison is a tautology.
2191     unsigned Width = CI->getBitWidth();
2192     APInt Lower = APInt(Width, 0);
2193     APInt Upper = APInt(Width, 0);
2194     ConstantInt *CI2;
2195     if (match(LHS, m_URem(m_Value(), m_ConstantInt(CI2)))) {
2196       // 'urem x, CI2' produces [0, CI2).
2197       Upper = CI2->getValue();
2198     } else if (match(LHS, m_SRem(m_Value(), m_ConstantInt(CI2)))) {
2199       // 'srem x, CI2' produces (-|CI2|, |CI2|).
2200       Upper = CI2->getValue().abs();
2201       Lower = (-Upper) + 1;
2202     } else if (match(LHS, m_UDiv(m_ConstantInt(CI2), m_Value()))) {
2203       // 'udiv CI2, x' produces [0, CI2].
2204       Upper = CI2->getValue() + 1;
2205     } else if (match(LHS, m_UDiv(m_Value(), m_ConstantInt(CI2)))) {
2206       // 'udiv x, CI2' produces [0, UINT_MAX / CI2].
2207       APInt NegOne = APInt::getAllOnesValue(Width);
2208       if (!CI2->isZero())
2209         Upper = NegOne.udiv(CI2->getValue()) + 1;
2210     } else if (match(LHS, m_SDiv(m_ConstantInt(CI2), m_Value()))) {
2211       if (CI2->isMinSignedValue()) {
2212         // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2213         Lower = CI2->getValue();
2214         Upper = Lower.lshr(1) + 1;
2215       } else {
2216         // 'sdiv CI2, x' produces [-|CI2|, |CI2|].
2217         Upper = CI2->getValue().abs() + 1;
2218         Lower = (-Upper) + 1;
2219       }
2220     } else if (match(LHS, m_SDiv(m_Value(), m_ConstantInt(CI2)))) {
2221       APInt IntMin = APInt::getSignedMinValue(Width);
2222       APInt IntMax = APInt::getSignedMaxValue(Width);
2223       APInt Val = CI2->getValue();
2224       if (Val.isAllOnesValue()) {
2225         // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2226         //    where CI2 != -1 and CI2 != 0 and CI2 != 1
2227         Lower = IntMin + 1;
2228         Upper = IntMax + 1;
2229       } else if (Val.countLeadingZeros() < Width - 1) {
2230         // 'sdiv x, CI2' produces [INT_MIN / CI2, INT_MAX / CI2]
2231         //    where CI2 != -1 and CI2 != 0 and CI2 != 1
2232         Lower = IntMin.sdiv(Val);
2233         Upper = IntMax.sdiv(Val);
2234         if (Lower.sgt(Upper))
2235           std::swap(Lower, Upper);
2236         Upper = Upper + 1;
2237         assert(Upper != Lower && "Upper part of range has wrapped!");
2238       }
2239     } else if (match(LHS, m_NUWShl(m_ConstantInt(CI2), m_Value()))) {
2240       // 'shl nuw CI2, x' produces [CI2, CI2 << CLZ(CI2)]
2241       Lower = CI2->getValue();
2242       Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2243     } else if (match(LHS, m_NSWShl(m_ConstantInt(CI2), m_Value()))) {
2244       if (CI2->isNegative()) {
2245         // 'shl nsw CI2, x' produces [CI2 << CLO(CI2)-1, CI2]
2246         unsigned ShiftAmount = CI2->getValue().countLeadingOnes() - 1;
2247         Lower = CI2->getValue().shl(ShiftAmount);
2248         Upper = CI2->getValue() + 1;
2249       } else {
2250         // 'shl nsw CI2, x' produces [CI2, CI2 << CLZ(CI2)-1]
2251         unsigned ShiftAmount = CI2->getValue().countLeadingZeros() - 1;
2252         Lower = CI2->getValue();
2253         Upper = CI2->getValue().shl(ShiftAmount) + 1;
2254       }
2255     } else if (match(LHS, m_LShr(m_Value(), m_ConstantInt(CI2)))) {
2256       // 'lshr x, CI2' produces [0, UINT_MAX >> CI2].
2257       APInt NegOne = APInt::getAllOnesValue(Width);
2258       if (CI2->getValue().ult(Width))
2259         Upper = NegOne.lshr(CI2->getValue()) + 1;
2260     } else if (match(LHS, m_LShr(m_ConstantInt(CI2), m_Value()))) {
2261       // 'lshr CI2, x' produces [CI2 >> (Width-1), CI2].
2262       unsigned ShiftAmount = Width - 1;
2263       if (!CI2->isZero() && cast<BinaryOperator>(LHS)->isExact())
2264         ShiftAmount = CI2->getValue().countTrailingZeros();
2265       Lower = CI2->getValue().lshr(ShiftAmount);
2266       Upper = CI2->getValue() + 1;
2267     } else if (match(LHS, m_AShr(m_Value(), m_ConstantInt(CI2)))) {
2268       // 'ashr x, CI2' produces [INT_MIN >> CI2, INT_MAX >> CI2].
2269       APInt IntMin = APInt::getSignedMinValue(Width);
2270       APInt IntMax = APInt::getSignedMaxValue(Width);
2271       if (CI2->getValue().ult(Width)) {
2272         Lower = IntMin.ashr(CI2->getValue());
2273         Upper = IntMax.ashr(CI2->getValue()) + 1;
2274       }
2275     } else if (match(LHS, m_AShr(m_ConstantInt(CI2), m_Value()))) {
2276       unsigned ShiftAmount = Width - 1;
2277       if (!CI2->isZero() && cast<BinaryOperator>(LHS)->isExact())
2278         ShiftAmount = CI2->getValue().countTrailingZeros();
2279       if (CI2->isNegative()) {
2280         // 'ashr CI2, x' produces [CI2, CI2 >> (Width-1)]
2281         Lower = CI2->getValue();
2282         Upper = CI2->getValue().ashr(ShiftAmount) + 1;
2283       } else {
2284         // 'ashr CI2, x' produces [CI2 >> (Width-1), CI2]
2285         Lower = CI2->getValue().ashr(ShiftAmount);
2286         Upper = CI2->getValue() + 1;
2287       }
2288     } else if (match(LHS, m_Or(m_Value(), m_ConstantInt(CI2)))) {
2289       // 'or x, CI2' produces [CI2, UINT_MAX].
2290       Lower = CI2->getValue();
2291     } else if (match(LHS, m_And(m_Value(), m_ConstantInt(CI2)))) {
2292       // 'and x, CI2' produces [0, CI2].
2293       Upper = CI2->getValue() + 1;
2294     }
2295     if (Lower != Upper) {
2296       ConstantRange LHS_CR = ConstantRange(Lower, Upper);
2297       if (RHS_CR.contains(LHS_CR))
2298         return ConstantInt::getTrue(RHS->getContext());
2299       if (RHS_CR.inverse().contains(LHS_CR))
2300         return ConstantInt::getFalse(RHS->getContext());
2301     }
2302   }
2303
2304   // Compare of cast, for example (zext X) != 0 -> X != 0
2305   if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
2306     Instruction *LI = cast<CastInst>(LHS);
2307     Value *SrcOp = LI->getOperand(0);
2308     Type *SrcTy = SrcOp->getType();
2309     Type *DstTy = LI->getType();
2310
2311     // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
2312     // if the integer type is the same size as the pointer type.
2313     if (MaxRecurse && Q.DL && isa<PtrToIntInst>(LI) &&
2314         Q.DL->getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
2315       if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
2316         // Transfer the cast to the constant.
2317         if (Value *V = SimplifyICmpInst(Pred, SrcOp,
2318                                         ConstantExpr::getIntToPtr(RHSC, SrcTy),
2319                                         Q, MaxRecurse-1))
2320           return V;
2321       } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
2322         if (RI->getOperand(0)->getType() == SrcTy)
2323           // Compare without the cast.
2324           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
2325                                           Q, MaxRecurse-1))
2326             return V;
2327       }
2328     }
2329
2330     if (isa<ZExtInst>(LHS)) {
2331       // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
2332       // same type.
2333       if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
2334         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
2335           // Compare X and Y.  Note that signed predicates become unsigned.
2336           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
2337                                           SrcOp, RI->getOperand(0), Q,
2338                                           MaxRecurse-1))
2339             return V;
2340       }
2341       // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
2342       // too.  If not, then try to deduce the result of the comparison.
2343       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2344         // Compute the constant that would happen if we truncated to SrcTy then
2345         // reextended to DstTy.
2346         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
2347         Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
2348
2349         // If the re-extended constant didn't change then this is effectively
2350         // also a case of comparing two zero-extended values.
2351         if (RExt == CI && MaxRecurse)
2352           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
2353                                         SrcOp, Trunc, Q, MaxRecurse-1))
2354             return V;
2355
2356         // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
2357         // there.  Use this to work out the result of the comparison.
2358         if (RExt != CI) {
2359           switch (Pred) {
2360           default: llvm_unreachable("Unknown ICmp predicate!");
2361           // LHS <u RHS.
2362           case ICmpInst::ICMP_EQ:
2363           case ICmpInst::ICMP_UGT:
2364           case ICmpInst::ICMP_UGE:
2365             return ConstantInt::getFalse(CI->getContext());
2366
2367           case ICmpInst::ICMP_NE:
2368           case ICmpInst::ICMP_ULT:
2369           case ICmpInst::ICMP_ULE:
2370             return ConstantInt::getTrue(CI->getContext());
2371
2372           // LHS is non-negative.  If RHS is negative then LHS >s LHS.  If RHS
2373           // is non-negative then LHS <s RHS.
2374           case ICmpInst::ICMP_SGT:
2375           case ICmpInst::ICMP_SGE:
2376             return CI->getValue().isNegative() ?
2377               ConstantInt::getTrue(CI->getContext()) :
2378               ConstantInt::getFalse(CI->getContext());
2379
2380           case ICmpInst::ICMP_SLT:
2381           case ICmpInst::ICMP_SLE:
2382             return CI->getValue().isNegative() ?
2383               ConstantInt::getFalse(CI->getContext()) :
2384               ConstantInt::getTrue(CI->getContext());
2385           }
2386         }
2387       }
2388     }
2389
2390     if (isa<SExtInst>(LHS)) {
2391       // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
2392       // same type.
2393       if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
2394         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
2395           // Compare X and Y.  Note that the predicate does not change.
2396           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
2397                                           Q, MaxRecurse-1))
2398             return V;
2399       }
2400       // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
2401       // too.  If not, then try to deduce the result of the comparison.
2402       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2403         // Compute the constant that would happen if we truncated to SrcTy then
2404         // reextended to DstTy.
2405         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
2406         Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
2407
2408         // If the re-extended constant didn't change then this is effectively
2409         // also a case of comparing two sign-extended values.
2410         if (RExt == CI && MaxRecurse)
2411           if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
2412             return V;
2413
2414         // Otherwise the upper bits of LHS are all equal, while RHS has varying
2415         // bits there.  Use this to work out the result of the comparison.
2416         if (RExt != CI) {
2417           switch (Pred) {
2418           default: llvm_unreachable("Unknown ICmp predicate!");
2419           case ICmpInst::ICMP_EQ:
2420             return ConstantInt::getFalse(CI->getContext());
2421           case ICmpInst::ICMP_NE:
2422             return ConstantInt::getTrue(CI->getContext());
2423
2424           // If RHS is non-negative then LHS <s RHS.  If RHS is negative then
2425           // LHS >s RHS.
2426           case ICmpInst::ICMP_SGT:
2427           case ICmpInst::ICMP_SGE:
2428             return CI->getValue().isNegative() ?
2429               ConstantInt::getTrue(CI->getContext()) :
2430               ConstantInt::getFalse(CI->getContext());
2431           case ICmpInst::ICMP_SLT:
2432           case ICmpInst::ICMP_SLE:
2433             return CI->getValue().isNegative() ?
2434               ConstantInt::getFalse(CI->getContext()) :
2435               ConstantInt::getTrue(CI->getContext());
2436
2437           // If LHS is non-negative then LHS <u RHS.  If LHS is negative then
2438           // LHS >u RHS.
2439           case ICmpInst::ICMP_UGT:
2440           case ICmpInst::ICMP_UGE:
2441             // Comparison is true iff the LHS <s 0.
2442             if (MaxRecurse)
2443               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
2444                                               Constant::getNullValue(SrcTy),
2445                                               Q, MaxRecurse-1))
2446                 return V;
2447             break;
2448           case ICmpInst::ICMP_ULT:
2449           case ICmpInst::ICMP_ULE:
2450             // Comparison is true iff the LHS >=s 0.
2451             if (MaxRecurse)
2452               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
2453                                               Constant::getNullValue(SrcTy),
2454                                               Q, MaxRecurse-1))
2455                 return V;
2456             break;
2457           }
2458         }
2459       }
2460     }
2461   }
2462
2463   // Special logic for binary operators.
2464   BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2465   BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2466   if (MaxRecurse && (LBO || RBO)) {
2467     // Analyze the case when either LHS or RHS is an add instruction.
2468     Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2469     // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2470     bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2471     if (LBO && LBO->getOpcode() == Instruction::Add) {
2472       A = LBO->getOperand(0); B = LBO->getOperand(1);
2473       NoLHSWrapProblem = ICmpInst::isEquality(Pred) ||
2474         (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2475         (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2476     }
2477     if (RBO && RBO->getOpcode() == Instruction::Add) {
2478       C = RBO->getOperand(0); D = RBO->getOperand(1);
2479       NoRHSWrapProblem = ICmpInst::isEquality(Pred) ||
2480         (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2481         (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2482     }
2483
2484     // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2485     if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2486       if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2487                                       Constant::getNullValue(RHS->getType()),
2488                                       Q, MaxRecurse-1))
2489         return V;
2490
2491     // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2492     if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2493       if (Value *V = SimplifyICmpInst(Pred,
2494                                       Constant::getNullValue(LHS->getType()),
2495                                       C == LHS ? D : C, Q, MaxRecurse-1))
2496         return V;
2497
2498     // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2499     if (A && C && (A == C || A == D || B == C || B == D) &&
2500         NoLHSWrapProblem && NoRHSWrapProblem) {
2501       // Determine Y and Z in the form icmp (X+Y), (X+Z).
2502       Value *Y, *Z;
2503       if (A == C) {
2504         // C + B == C + D  ->  B == D
2505         Y = B;
2506         Z = D;
2507       } else if (A == D) {
2508         // D + B == C + D  ->  B == C
2509         Y = B;
2510         Z = C;
2511       } else if (B == C) {
2512         // A + C == C + D  ->  A == D
2513         Y = A;
2514         Z = D;
2515       } else {
2516         assert(B == D);
2517         // A + D == C + D  ->  A == C
2518         Y = A;
2519         Z = C;
2520       }
2521       if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse-1))
2522         return V;
2523     }
2524   }
2525
2526   // icmp pred (or X, Y), X
2527   if (LBO && match(LBO, m_CombineOr(m_Or(m_Value(), m_Specific(RHS)),
2528                                     m_Or(m_Specific(RHS), m_Value())))) {
2529     if (Pred == ICmpInst::ICMP_ULT)
2530       return getFalse(ITy);
2531     if (Pred == ICmpInst::ICMP_UGE)
2532       return getTrue(ITy);
2533   }
2534   // icmp pred X, (or X, Y)
2535   if (RBO && match(RBO, m_CombineOr(m_Or(m_Value(), m_Specific(LHS)),
2536                                     m_Or(m_Specific(LHS), m_Value())))) {
2537     if (Pred == ICmpInst::ICMP_ULE)
2538       return getTrue(ITy);
2539     if (Pred == ICmpInst::ICMP_UGT)
2540       return getFalse(ITy);
2541   }
2542
2543   // icmp pred (and X, Y), X
2544   if (LBO && match(LBO, m_CombineOr(m_And(m_Value(), m_Specific(RHS)),
2545                                     m_And(m_Specific(RHS), m_Value())))) {
2546     if (Pred == ICmpInst::ICMP_UGT)
2547       return getFalse(ITy);
2548     if (Pred == ICmpInst::ICMP_ULE)
2549       return getTrue(ITy);
2550   }
2551   // icmp pred X, (and X, Y)
2552   if (RBO && match(RBO, m_CombineOr(m_And(m_Value(), m_Specific(LHS)),
2553                                     m_And(m_Specific(LHS), m_Value())))) {
2554     if (Pred == ICmpInst::ICMP_UGE)
2555       return getTrue(ITy);
2556     if (Pred == ICmpInst::ICMP_ULT)
2557       return getFalse(ITy);
2558   }
2559
2560   // 0 - (zext X) pred C
2561   if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2562     if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2563       if (RHSC->getValue().isStrictlyPositive()) {
2564         if (Pred == ICmpInst::ICMP_SLT)
2565           return ConstantInt::getTrue(RHSC->getContext());
2566         if (Pred == ICmpInst::ICMP_SGE)
2567           return ConstantInt::getFalse(RHSC->getContext());
2568         if (Pred == ICmpInst::ICMP_EQ)
2569           return ConstantInt::getFalse(RHSC->getContext());
2570         if (Pred == ICmpInst::ICMP_NE)
2571           return ConstantInt::getTrue(RHSC->getContext());
2572       }
2573       if (RHSC->getValue().isNonNegative()) {
2574         if (Pred == ICmpInst::ICMP_SLE)
2575           return ConstantInt::getTrue(RHSC->getContext());
2576         if (Pred == ICmpInst::ICMP_SGT)
2577           return ConstantInt::getFalse(RHSC->getContext());
2578       }
2579     }
2580   }
2581
2582   // icmp pred (urem X, Y), Y
2583   if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2584     bool KnownNonNegative, KnownNegative;
2585     switch (Pred) {
2586     default:
2587       break;
2588     case ICmpInst::ICMP_SGT:
2589     case ICmpInst::ICMP_SGE:
2590       ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL,
2591                      0, Q.AT, Q.CxtI, Q.DT);
2592       if (!KnownNonNegative)
2593         break;
2594       // fall-through
2595     case ICmpInst::ICMP_EQ:
2596     case ICmpInst::ICMP_UGT:
2597     case ICmpInst::ICMP_UGE:
2598       return getFalse(ITy);
2599     case ICmpInst::ICMP_SLT:
2600     case ICmpInst::ICMP_SLE:
2601       ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL,
2602                      0, Q.AT, Q.CxtI, Q.DT);
2603       if (!KnownNonNegative)
2604         break;
2605       // fall-through
2606     case ICmpInst::ICMP_NE:
2607     case ICmpInst::ICMP_ULT:
2608     case ICmpInst::ICMP_ULE:
2609       return getTrue(ITy);
2610     }
2611   }
2612
2613   // icmp pred X, (urem Y, X)
2614   if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2615     bool KnownNonNegative, KnownNegative;
2616     switch (Pred) {
2617     default:
2618       break;
2619     case ICmpInst::ICMP_SGT:
2620     case ICmpInst::ICMP_SGE:
2621       ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL,
2622                      0, Q.AT, Q.CxtI, Q.DT);
2623       if (!KnownNonNegative)
2624         break;
2625       // fall-through
2626     case ICmpInst::ICMP_NE:
2627     case ICmpInst::ICMP_UGT:
2628     case ICmpInst::ICMP_UGE:
2629       return getTrue(ITy);
2630     case ICmpInst::ICMP_SLT:
2631     case ICmpInst::ICMP_SLE:
2632       ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL,
2633                      0, Q.AT, Q.CxtI, Q.DT);
2634       if (!KnownNonNegative)
2635         break;
2636       // fall-through
2637     case ICmpInst::ICMP_EQ:
2638     case ICmpInst::ICMP_ULT:
2639     case ICmpInst::ICMP_ULE:
2640       return getFalse(ITy);
2641     }
2642   }
2643
2644   // x udiv y <=u x.
2645   if (LBO && match(LBO, m_UDiv(m_Specific(RHS), m_Value()))) {
2646     // icmp pred (X /u Y), X
2647     if (Pred == ICmpInst::ICMP_UGT)
2648       return getFalse(ITy);
2649     if (Pred == ICmpInst::ICMP_ULE)
2650       return getTrue(ITy);
2651   }
2652
2653   // handle:
2654   //   CI2 << X == CI
2655   //   CI2 << X != CI
2656   //
2657   //   where CI2 is a power of 2 and CI isn't
2658   if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2659     const APInt *CI2Val, *CIVal = &CI->getValue();
2660     if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2661         CI2Val->isPowerOf2()) {
2662       if (!CIVal->isPowerOf2()) {
2663         // CI2 << X can equal zero in some circumstances,
2664         // this simplification is unsafe if CI is zero.
2665         //
2666         // We know it is safe if:
2667         // - The shift is nsw, we can't shift out the one bit.
2668         // - The shift is nuw, we can't shift out the one bit.
2669         // - CI2 is one
2670         // - CI isn't zero
2671         if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2672             *CI2Val == 1 || !CI->isZero()) {
2673           if (Pred == ICmpInst::ICMP_EQ)
2674             return ConstantInt::getFalse(RHS->getContext());
2675           if (Pred == ICmpInst::ICMP_NE)
2676             return ConstantInt::getTrue(RHS->getContext());
2677         }
2678       }
2679       if (CIVal->isSignBit() && *CI2Val == 1) {
2680         if (Pred == ICmpInst::ICMP_UGT)
2681           return ConstantInt::getFalse(RHS->getContext());
2682         if (Pred == ICmpInst::ICMP_ULE)
2683           return ConstantInt::getTrue(RHS->getContext());
2684       }
2685     }
2686   }
2687
2688   if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2689       LBO->getOperand(1) == RBO->getOperand(1)) {
2690     switch (LBO->getOpcode()) {
2691     default: break;
2692     case Instruction::UDiv:
2693     case Instruction::LShr:
2694       if (ICmpInst::isSigned(Pred))
2695         break;
2696       // fall-through
2697     case Instruction::SDiv:
2698     case Instruction::AShr:
2699       if (!LBO->isExact() || !RBO->isExact())
2700         break;
2701       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2702                                       RBO->getOperand(0), Q, MaxRecurse-1))
2703         return V;
2704       break;
2705     case Instruction::Shl: {
2706       bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2707       bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2708       if (!NUW && !NSW)
2709         break;
2710       if (!NSW && ICmpInst::isSigned(Pred))
2711         break;
2712       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2713                                       RBO->getOperand(0), Q, MaxRecurse-1))
2714         return V;
2715       break;
2716     }
2717     }
2718   }
2719
2720   // Simplify comparisons involving max/min.
2721   Value *A, *B;
2722   CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2723   CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2724
2725   // Signed variants on "max(a,b)>=a -> true".
2726   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2727     if (A != RHS) std::swap(A, B); // smax(A, B) pred A.
2728     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2729     // We analyze this as smax(A, B) pred A.
2730     P = Pred;
2731   } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2732              (A == LHS || B == LHS)) {
2733     if (A != LHS) std::swap(A, B); // A pred smax(A, B).
2734     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2735     // We analyze this as smax(A, B) swapped-pred A.
2736     P = CmpInst::getSwappedPredicate(Pred);
2737   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2738              (A == RHS || B == RHS)) {
2739     if (A != RHS) std::swap(A, B); // smin(A, B) pred A.
2740     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2741     // We analyze this as smax(-A, -B) swapped-pred -A.
2742     // Note that we do not need to actually form -A or -B thanks to EqP.
2743     P = CmpInst::getSwappedPredicate(Pred);
2744   } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2745              (A == LHS || B == LHS)) {
2746     if (A != LHS) std::swap(A, B); // A pred smin(A, B).
2747     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2748     // We analyze this as smax(-A, -B) pred -A.
2749     // Note that we do not need to actually form -A or -B thanks to EqP.
2750     P = Pred;
2751   }
2752   if (P != CmpInst::BAD_ICMP_PREDICATE) {
2753     // Cases correspond to "max(A, B) p A".
2754     switch (P) {
2755     default:
2756       break;
2757     case CmpInst::ICMP_EQ:
2758     case CmpInst::ICMP_SLE:
2759       // Equivalent to "A EqP B".  This may be the same as the condition tested
2760       // in the max/min; if so, we can just return that.
2761       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2762         return V;
2763       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2764         return V;
2765       // Otherwise, see if "A EqP B" simplifies.
2766       if (MaxRecurse)
2767         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse-1))
2768           return V;
2769       break;
2770     case CmpInst::ICMP_NE:
2771     case CmpInst::ICMP_SGT: {
2772       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2773       // Equivalent to "A InvEqP B".  This may be the same as the condition
2774       // tested in the max/min; if so, we can just return that.
2775       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2776         return V;
2777       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2778         return V;
2779       // Otherwise, see if "A InvEqP B" simplifies.
2780       if (MaxRecurse)
2781         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse-1))
2782           return V;
2783       break;
2784     }
2785     case CmpInst::ICMP_SGE:
2786       // Always true.
2787       return getTrue(ITy);
2788     case CmpInst::ICMP_SLT:
2789       // Always false.
2790       return getFalse(ITy);
2791     }
2792   }
2793
2794   // Unsigned variants on "max(a,b)>=a -> true".
2795   P = CmpInst::BAD_ICMP_PREDICATE;
2796   if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2797     if (A != RHS) std::swap(A, B); // umax(A, B) pred A.
2798     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2799     // We analyze this as umax(A, B) pred A.
2800     P = Pred;
2801   } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2802              (A == LHS || B == LHS)) {
2803     if (A != LHS) std::swap(A, B); // A pred umax(A, B).
2804     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2805     // We analyze this as umax(A, B) swapped-pred A.
2806     P = CmpInst::getSwappedPredicate(Pred);
2807   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2808              (A == RHS || B == RHS)) {
2809     if (A != RHS) std::swap(A, B); // umin(A, B) pred A.
2810     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2811     // We analyze this as umax(-A, -B) swapped-pred -A.
2812     // Note that we do not need to actually form -A or -B thanks to EqP.
2813     P = CmpInst::getSwappedPredicate(Pred);
2814   } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2815              (A == LHS || B == LHS)) {
2816     if (A != LHS) std::swap(A, B); // A pred umin(A, B).
2817     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2818     // We analyze this as umax(-A, -B) pred -A.
2819     // Note that we do not need to actually form -A or -B thanks to EqP.
2820     P = Pred;
2821   }
2822   if (P != CmpInst::BAD_ICMP_PREDICATE) {
2823     // Cases correspond to "max(A, B) p A".
2824     switch (P) {
2825     default:
2826       break;
2827     case CmpInst::ICMP_EQ:
2828     case CmpInst::ICMP_ULE:
2829       // Equivalent to "A EqP B".  This may be the same as the condition tested
2830       // in the max/min; if so, we can just return that.
2831       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2832         return V;
2833       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2834         return V;
2835       // Otherwise, see if "A EqP B" simplifies.
2836       if (MaxRecurse)
2837         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse-1))
2838           return V;
2839       break;
2840     case CmpInst::ICMP_NE:
2841     case CmpInst::ICMP_UGT: {
2842       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2843       // Equivalent to "A InvEqP B".  This may be the same as the condition
2844       // tested in the max/min; if so, we can just return that.
2845       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2846         return V;
2847       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2848         return V;
2849       // Otherwise, see if "A InvEqP B" simplifies.
2850       if (MaxRecurse)
2851         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse-1))
2852           return V;
2853       break;
2854     }
2855     case CmpInst::ICMP_UGE:
2856       // Always true.
2857       return getTrue(ITy);
2858     case CmpInst::ICMP_ULT:
2859       // Always false.
2860       return getFalse(ITy);
2861     }
2862   }
2863
2864   // Variants on "max(x,y) >= min(x,z)".
2865   Value *C, *D;
2866   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
2867       match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
2868       (A == C || A == D || B == C || B == D)) {
2869     // max(x, ?) pred min(x, ?).
2870     if (Pred == CmpInst::ICMP_SGE)
2871       // Always true.
2872       return getTrue(ITy);
2873     if (Pred == CmpInst::ICMP_SLT)
2874       // Always false.
2875       return getFalse(ITy);
2876   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2877              match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
2878              (A == C || A == D || B == C || B == D)) {
2879     // min(x, ?) pred max(x, ?).
2880     if (Pred == CmpInst::ICMP_SLE)
2881       // Always true.
2882       return getTrue(ITy);
2883     if (Pred == CmpInst::ICMP_SGT)
2884       // Always false.
2885       return getFalse(ITy);
2886   } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
2887              match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
2888              (A == C || A == D || B == C || B == D)) {
2889     // max(x, ?) pred min(x, ?).
2890     if (Pred == CmpInst::ICMP_UGE)
2891       // Always true.
2892       return getTrue(ITy);
2893     if (Pred == CmpInst::ICMP_ULT)
2894       // Always false.
2895       return getFalse(ITy);
2896   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2897              match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
2898              (A == C || A == D || B == C || B == D)) {
2899     // min(x, ?) pred max(x, ?).
2900     if (Pred == CmpInst::ICMP_ULE)
2901       // Always true.
2902       return getTrue(ITy);
2903     if (Pred == CmpInst::ICMP_UGT)
2904       // Always false.
2905       return getFalse(ITy);
2906   }
2907
2908   // Simplify comparisons of related pointers using a powerful, recursive
2909   // GEP-walk when we have target data available..
2910   if (LHS->getType()->isPointerTy())
2911     if (Constant *C = computePointerICmp(Q.DL, Q.TLI, Pred, LHS, RHS))
2912       return C;
2913
2914   if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
2915     if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
2916       if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
2917           GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
2918           (ICmpInst::isEquality(Pred) ||
2919            (GLHS->isInBounds() && GRHS->isInBounds() &&
2920             Pred == ICmpInst::getSignedPredicate(Pred)))) {
2921         // The bases are equal and the indices are constant.  Build a constant
2922         // expression GEP with the same indices and a null base pointer to see
2923         // what constant folding can make out of it.
2924         Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
2925         SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
2926         Constant *NewLHS = ConstantExpr::getGetElementPtr(Null, IndicesLHS);
2927
2928         SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
2929         Constant *NewRHS = ConstantExpr::getGetElementPtr(Null, IndicesRHS);
2930         return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
2931       }
2932     }
2933   }
2934
2935   // If a bit is known to be zero for A and known to be one for B,
2936   // then A and B cannot be equal.
2937   if (ICmpInst::isEquality(Pred)) {
2938     if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
2939       uint32_t BitWidth = CI->getBitWidth();
2940       APInt LHSKnownZero(BitWidth, 0);
2941       APInt LHSKnownOne(BitWidth, 0);
2942       computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, Q.DL, /*Depth=*/0, Q.AT,
2943                        Q.CxtI, Q.DT);
2944       const APInt &RHSVal = CI->getValue();
2945       if (((LHSKnownZero & RHSVal) != 0) || ((LHSKnownOne & ~RHSVal) != 0))
2946         return Pred == ICmpInst::ICMP_EQ
2947                    ? ConstantInt::getFalse(CI->getContext())
2948                    : ConstantInt::getTrue(CI->getContext());
2949     }
2950   }
2951
2952   // If the comparison is with the result of a select instruction, check whether
2953   // comparing with either branch of the select always yields the same value.
2954   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
2955     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
2956       return V;
2957
2958   // If the comparison is with the result of a phi instruction, check whether
2959   // doing the compare with each incoming phi value yields a common result.
2960   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
2961     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
2962       return V;
2963
2964   return nullptr;
2965 }
2966
2967 Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2968                               const DataLayout *DL,
2969                               const TargetLibraryInfo *TLI,
2970                               const DominatorTree *DT,
2971                               AssumptionTracker *AT,
2972                               Instruction *CxtI) {
2973   return ::SimplifyICmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
2974                             RecursionLimit);
2975 }
2976
2977 /// SimplifyFCmpInst - Given operands for an FCmpInst, see if we can
2978 /// fold the result.  If not, this returns null.
2979 static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
2980                                const Query &Q, unsigned MaxRecurse) {
2981   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
2982   assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
2983
2984   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
2985     if (Constant *CRHS = dyn_cast<Constant>(RHS))
2986       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
2987
2988     // If we have a constant, make sure it is on the RHS.
2989     std::swap(LHS, RHS);
2990     Pred = CmpInst::getSwappedPredicate(Pred);
2991   }
2992
2993   // Fold trivial predicates.
2994   if (Pred == FCmpInst::FCMP_FALSE)
2995     return ConstantInt::get(GetCompareTy(LHS), 0);
2996   if (Pred == FCmpInst::FCMP_TRUE)
2997     return ConstantInt::get(GetCompareTy(LHS), 1);
2998
2999   if (isa<UndefValue>(RHS))                  // fcmp pred X, undef -> undef
3000     return UndefValue::get(GetCompareTy(LHS));
3001
3002   // fcmp x,x -> true/false.  Not all compares are foldable.
3003   if (LHS == RHS) {
3004     if (CmpInst::isTrueWhenEqual(Pred))
3005       return ConstantInt::get(GetCompareTy(LHS), 1);
3006     if (CmpInst::isFalseWhenEqual(Pred))
3007       return ConstantInt::get(GetCompareTy(LHS), 0);
3008   }
3009
3010   // Handle fcmp with constant RHS
3011   if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3012     // If the constant is a nan, see if we can fold the comparison based on it.
3013     if (ConstantFP *CFP = dyn_cast<ConstantFP>(RHSC)) {
3014       if (CFP->getValueAPF().isNaN()) {
3015         if (FCmpInst::isOrdered(Pred))   // True "if ordered and foo"
3016           return ConstantInt::getFalse(CFP->getContext());
3017         assert(FCmpInst::isUnordered(Pred) &&
3018                "Comparison must be either ordered or unordered!");
3019         // True if unordered.
3020         return ConstantInt::getTrue(CFP->getContext());
3021       }
3022       // Check whether the constant is an infinity.
3023       if (CFP->getValueAPF().isInfinity()) {
3024         if (CFP->getValueAPF().isNegative()) {
3025           switch (Pred) {
3026           case FCmpInst::FCMP_OLT:
3027             // No value is ordered and less than negative infinity.
3028             return ConstantInt::getFalse(CFP->getContext());
3029           case FCmpInst::FCMP_UGE:
3030             // All values are unordered with or at least negative infinity.
3031             return ConstantInt::getTrue(CFP->getContext());
3032           default:
3033             break;
3034           }
3035         } else {
3036           switch (Pred) {
3037           case FCmpInst::FCMP_OGT:
3038             // No value is ordered and greater than infinity.
3039             return ConstantInt::getFalse(CFP->getContext());
3040           case FCmpInst::FCMP_ULE:
3041             // All values are unordered with and at most infinity.
3042             return ConstantInt::getTrue(CFP->getContext());
3043           default:
3044             break;
3045           }
3046         }
3047       }
3048     }
3049   }
3050
3051   // If the comparison is with the result of a select instruction, check whether
3052   // comparing with either branch of the select always yields the same value.
3053   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3054     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3055       return V;
3056
3057   // If the comparison is with the result of a phi instruction, check whether
3058   // doing the compare with each incoming phi value yields a common result.
3059   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3060     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3061       return V;
3062
3063   return nullptr;
3064 }
3065
3066 Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3067                               const DataLayout *DL,
3068                               const TargetLibraryInfo *TLI,
3069                               const DominatorTree *DT,
3070                               AssumptionTracker *AT,
3071                               const Instruction *CxtI) {
3072   return ::SimplifyFCmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3073                             RecursionLimit);
3074 }
3075
3076 /// SimplifySelectInst - Given operands for a SelectInst, see if we can fold
3077 /// the result.  If not, this returns null.
3078 static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
3079                                  Value *FalseVal, const Query &Q,
3080                                  unsigned MaxRecurse) {
3081   // select true, X, Y  -> X
3082   // select false, X, Y -> Y
3083   if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3084     if (CB->isAllOnesValue())
3085       return TrueVal;
3086     if (CB->isNullValue())
3087       return FalseVal;
3088   }
3089
3090   // select C, X, X -> X
3091   if (TrueVal == FalseVal)
3092     return TrueVal;
3093
3094   if (isa<UndefValue>(CondVal)) {  // select undef, X, Y -> X or Y
3095     if (isa<Constant>(TrueVal))
3096       return TrueVal;
3097     return FalseVal;
3098   }
3099   if (isa<UndefValue>(TrueVal))   // select C, undef, X -> X
3100     return FalseVal;
3101   if (isa<UndefValue>(FalseVal))   // select C, X, undef -> X
3102     return TrueVal;
3103
3104   if (const auto *ICI = dyn_cast<ICmpInst>(CondVal)) {
3105     Value *X;
3106     const APInt *Y;
3107     if (ICI->isEquality() &&
3108         match(ICI->getOperand(0), m_And(m_Value(X), m_APInt(Y))) &&
3109         match(ICI->getOperand(1), m_Zero())) {
3110       ICmpInst::Predicate Pred = ICI->getPredicate();
3111       const APInt *C;
3112       // (X & Y) == 0 ? X & ~Y : X  --> X
3113       // (X & Y) != 0 ? X & ~Y : X  --> X & ~Y
3114       if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3115           *Y == ~*C)
3116         return Pred == ICmpInst::ICMP_EQ ? FalseVal : TrueVal;
3117       // (X & Y) == 0 ? X : X & ~Y  --> X & ~Y
3118       // (X & Y) != 0 ? X : X & ~Y  --> X
3119       if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3120           *Y == ~*C)
3121         return Pred == ICmpInst::ICMP_EQ ? FalseVal : TrueVal;
3122
3123       if (Y->isPowerOf2()) {
3124         // (X & Y) == 0 ? X | Y : X  --> X | Y
3125         // (X & Y) != 0 ? X | Y : X  --> X
3126         if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3127             *Y == *C)
3128           return Pred == ICmpInst::ICMP_EQ ? TrueVal : FalseVal;
3129         // (X & Y) == 0 ? X : X | Y  --> X
3130         // (X & Y) != 0 ? X : X | Y  --> X | Y
3131         if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3132             *Y == *C)
3133           return Pred == ICmpInst::ICMP_EQ ? TrueVal : FalseVal;
3134       }
3135     }
3136   }
3137
3138   return nullptr;
3139 }
3140
3141 Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3142                                 const DataLayout *DL,
3143                                 const TargetLibraryInfo *TLI,
3144                                 const DominatorTree *DT,
3145                                 AssumptionTracker *AT,
3146                                 const Instruction *CxtI) {
3147   return ::SimplifySelectInst(Cond, TrueVal, FalseVal,
3148                               Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
3149 }
3150
3151 /// SimplifyGEPInst - Given operands for an GetElementPtrInst, see if we can
3152 /// fold the result.  If not, this returns null.
3153 static Value *SimplifyGEPInst(ArrayRef<Value *> Ops, const Query &Q, unsigned) {
3154   // The type of the GEP pointer operand.
3155   PointerType *PtrTy = cast<PointerType>(Ops[0]->getType()->getScalarType());
3156   unsigned AS = PtrTy->getAddressSpace();
3157
3158   // getelementptr P -> P.
3159   if (Ops.size() == 1)
3160     return Ops[0];
3161
3162   // Compute the (pointer) type returned by the GEP instruction.
3163   Type *LastType = GetElementPtrInst::getIndexedType(PtrTy, Ops.slice(1));
3164   Type *GEPTy = PointerType::get(LastType, AS);
3165   if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3166     GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3167
3168   if (isa<UndefValue>(Ops[0]))
3169     return UndefValue::get(GEPTy);
3170
3171   if (Ops.size() == 2) {
3172     // getelementptr P, 0 -> P.
3173     if (match(Ops[1], m_Zero()))
3174       return Ops[0];
3175
3176     Type *Ty = PtrTy->getElementType();
3177     if (Q.DL && Ty->isSized()) {
3178       Value *P;
3179       uint64_t C;
3180       uint64_t TyAllocSize = Q.DL->getTypeAllocSize(Ty);
3181       // getelementptr P, N -> P if P points to a type of zero size.
3182       if (TyAllocSize == 0)
3183         return Ops[0];
3184
3185       // The following transforms are only safe if the ptrtoint cast
3186       // doesn't truncate the pointers.
3187       if (Ops[1]->getType()->getScalarSizeInBits() ==
3188           Q.DL->getPointerSizeInBits(AS)) {
3189         auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3190           if (match(P, m_Zero()))
3191             return Constant::getNullValue(GEPTy);
3192           Value *Temp;
3193           if (match(P, m_PtrToInt(m_Value(Temp))))
3194             if (Temp->getType() == GEPTy)
3195               return Temp;
3196           return nullptr;
3197         };
3198
3199         // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3200         if (TyAllocSize == 1 &&
3201             match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3202           if (Value *R = PtrToIntOrZero(P))
3203             return R;
3204
3205         // getelementptr V, (ashr (sub P, V), C) -> Q
3206         // if P points to a type of size 1 << C.
3207         if (match(Ops[1],
3208                   m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3209                          m_ConstantInt(C))) &&
3210             TyAllocSize == 1ULL << C)
3211           if (Value *R = PtrToIntOrZero(P))
3212             return R;
3213
3214         // getelementptr V, (sdiv (sub P, V), C) -> Q
3215         // if P points to a type of size C.
3216         if (match(Ops[1],
3217                   m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3218                          m_SpecificInt(TyAllocSize))))
3219           if (Value *R = PtrToIntOrZero(P))
3220             return R;
3221       }
3222     }
3223   }
3224
3225   // Check to see if this is constant foldable.
3226   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3227     if (!isa<Constant>(Ops[i]))
3228       return nullptr;
3229
3230   return ConstantExpr::getGetElementPtr(cast<Constant>(Ops[0]), Ops.slice(1));
3231 }
3232
3233 Value *llvm::SimplifyGEPInst(ArrayRef<Value *> Ops, const DataLayout *DL,
3234                              const TargetLibraryInfo *TLI,
3235                              const DominatorTree *DT, AssumptionTracker *AT,
3236                              const Instruction *CxtI) {
3237   return ::SimplifyGEPInst(Ops, Query (DL, TLI, DT, AT, CxtI), RecursionLimit);
3238 }
3239
3240 /// SimplifyInsertValueInst - Given operands for an InsertValueInst, see if we
3241 /// can fold the result.  If not, this returns null.
3242 static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
3243                                       ArrayRef<unsigned> Idxs, const Query &Q,
3244                                       unsigned) {
3245   if (Constant *CAgg = dyn_cast<Constant>(Agg))
3246     if (Constant *CVal = dyn_cast<Constant>(Val))
3247       return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3248
3249   // insertvalue x, undef, n -> x
3250   if (match(Val, m_Undef()))
3251     return Agg;
3252
3253   // insertvalue x, (extractvalue y, n), n
3254   if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
3255     if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3256         EV->getIndices() == Idxs) {
3257       // insertvalue undef, (extractvalue y, n), n -> y
3258       if (match(Agg, m_Undef()))
3259         return EV->getAggregateOperand();
3260
3261       // insertvalue y, (extractvalue y, n), n -> y
3262       if (Agg == EV->getAggregateOperand())
3263         return Agg;
3264     }
3265
3266   return nullptr;
3267 }
3268
3269 Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3270                                      ArrayRef<unsigned> Idxs,
3271                                      const DataLayout *DL,
3272                                      const TargetLibraryInfo *TLI,
3273                                      const DominatorTree *DT,
3274                                      AssumptionTracker *AT,
3275                                      const Instruction *CxtI) {
3276   return ::SimplifyInsertValueInst(Agg, Val, Idxs,
3277                                    Query (DL, TLI, DT, AT, CxtI),
3278                                    RecursionLimit);
3279 }
3280
3281 /// SimplifyPHINode - See if we can fold the given phi.  If not, returns null.
3282 static Value *SimplifyPHINode(PHINode *PN, const Query &Q) {
3283   // If all of the PHI's incoming values are the same then replace the PHI node
3284   // with the common value.
3285   Value *CommonValue = nullptr;
3286   bool HasUndefInput = false;
3287   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3288     Value *Incoming = PN->getIncomingValue(i);
3289     // If the incoming value is the phi node itself, it can safely be skipped.
3290     if (Incoming == PN) continue;
3291     if (isa<UndefValue>(Incoming)) {
3292       // Remember that we saw an undef value, but otherwise ignore them.
3293       HasUndefInput = true;
3294       continue;
3295     }
3296     if (CommonValue && Incoming != CommonValue)
3297       return nullptr;  // Not the same, bail out.
3298     CommonValue = Incoming;
3299   }
3300
3301   // If CommonValue is null then all of the incoming values were either undef or
3302   // equal to the phi node itself.
3303   if (!CommonValue)
3304     return UndefValue::get(PN->getType());
3305
3306   // If we have a PHI node like phi(X, undef, X), where X is defined by some
3307   // instruction, we cannot return X as the result of the PHI node unless it
3308   // dominates the PHI block.
3309   if (HasUndefInput)
3310     return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
3311
3312   return CommonValue;
3313 }
3314
3315 static Value *SimplifyTruncInst(Value *Op, Type *Ty, const Query &Q, unsigned) {
3316   if (Constant *C = dyn_cast<Constant>(Op))
3317     return ConstantFoldInstOperands(Instruction::Trunc, Ty, C, Q.DL, Q.TLI);
3318
3319   return nullptr;
3320 }
3321
3322 Value *llvm::SimplifyTruncInst(Value *Op, Type *Ty, const DataLayout *DL,
3323                                const TargetLibraryInfo *TLI,
3324                                const DominatorTree *DT,
3325                                AssumptionTracker *AT,
3326                                const Instruction *CxtI) {
3327   return ::SimplifyTruncInst(Op, Ty, Query (DL, TLI, DT, AT, CxtI),
3328                              RecursionLimit);
3329 }
3330
3331 //=== Helper functions for higher up the class hierarchy.
3332
3333 /// SimplifyBinOp - Given operands for a BinaryOperator, see if we can
3334 /// fold the result.  If not, this returns null.
3335 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
3336                             const Query &Q, unsigned MaxRecurse) {
3337   switch (Opcode) {
3338   case Instruction::Add:
3339     return SimplifyAddInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3340                            Q, MaxRecurse);
3341   case Instruction::FAdd:
3342     return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3343
3344   case Instruction::Sub:
3345     return SimplifySubInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3346                            Q, MaxRecurse);
3347   case Instruction::FSub:
3348     return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3349
3350   case Instruction::Mul:  return SimplifyMulInst (LHS, RHS, Q, MaxRecurse);
3351   case Instruction::FMul:
3352     return SimplifyFMulInst (LHS, RHS, FastMathFlags(), Q, MaxRecurse);
3353   case Instruction::SDiv: return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
3354   case Instruction::UDiv: return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
3355   case Instruction::FDiv: return SimplifyFDivInst(LHS, RHS, Q, MaxRecurse);
3356   case Instruction::SRem: return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
3357   case Instruction::URem: return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
3358   case Instruction::FRem: return SimplifyFRemInst(LHS, RHS, Q, MaxRecurse);
3359   case Instruction::Shl:
3360     return SimplifyShlInst(LHS, RHS, /*isNSW*/false, /*isNUW*/false,
3361                            Q, MaxRecurse);
3362   case Instruction::LShr:
3363     return SimplifyLShrInst(LHS, RHS, /*isExact*/false, Q, MaxRecurse);
3364   case Instruction::AShr:
3365     return SimplifyAShrInst(LHS, RHS, /*isExact*/false, Q, MaxRecurse);
3366   case Instruction::And: return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
3367   case Instruction::Or:  return SimplifyOrInst (LHS, RHS, Q, MaxRecurse);
3368   case Instruction::Xor: return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
3369   default:
3370     if (Constant *CLHS = dyn_cast<Constant>(LHS))
3371       if (Constant *CRHS = dyn_cast<Constant>(RHS)) {
3372         Constant *COps[] = {CLHS, CRHS};
3373         return ConstantFoldInstOperands(Opcode, LHS->getType(), COps, Q.DL,
3374                                         Q.TLI);
3375       }
3376
3377     // If the operation is associative, try some generic simplifications.
3378     if (Instruction::isAssociative(Opcode))
3379       if (Value *V = SimplifyAssociativeBinOp(Opcode, LHS, RHS, Q, MaxRecurse))
3380         return V;
3381
3382     // If the operation is with the result of a select instruction check whether
3383     // operating on either branch of the select always yields the same value.
3384     if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3385       if (Value *V = ThreadBinOpOverSelect(Opcode, LHS, RHS, Q, MaxRecurse))
3386         return V;
3387
3388     // If the operation is with the result of a phi instruction, check whether
3389     // operating on all incoming values of the phi always yields the same value.
3390     if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3391       if (Value *V = ThreadBinOpOverPHI(Opcode, LHS, RHS, Q, MaxRecurse))
3392         return V;
3393
3394     return nullptr;
3395   }
3396 }
3397
3398 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
3399                            const DataLayout *DL, const TargetLibraryInfo *TLI,
3400                            const DominatorTree *DT, AssumptionTracker *AT,
3401                            const Instruction *CxtI) {
3402   return ::SimplifyBinOp(Opcode, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3403                          RecursionLimit);
3404 }
3405
3406 /// SimplifyCmpInst - Given operands for a CmpInst, see if we can
3407 /// fold the result.
3408 static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3409                               const Query &Q, unsigned MaxRecurse) {
3410   if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
3411     return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
3412   return SimplifyFCmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
3413 }
3414
3415 Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3416                              const DataLayout *DL, const TargetLibraryInfo *TLI,
3417                              const DominatorTree *DT, AssumptionTracker *AT,
3418                              const Instruction *CxtI) {
3419   return ::SimplifyCmpInst(Predicate, LHS, RHS, Query (DL, TLI, DT, AT, CxtI),
3420                            RecursionLimit);
3421 }
3422
3423 static bool IsIdempotent(Intrinsic::ID ID) {
3424   switch (ID) {
3425   default: return false;
3426
3427   // Unary idempotent: f(f(x)) = f(x)
3428   case Intrinsic::fabs:
3429   case Intrinsic::floor:
3430   case Intrinsic::ceil:
3431   case Intrinsic::trunc:
3432   case Intrinsic::rint:
3433   case Intrinsic::nearbyint:
3434   case Intrinsic::round:
3435     return true;
3436   }
3437 }
3438
3439 template <typename IterTy>
3440 static Value *SimplifyIntrinsic(Intrinsic::ID IID, IterTy ArgBegin, IterTy ArgEnd,
3441                                 const Query &Q, unsigned MaxRecurse) {
3442   // Perform idempotent optimizations
3443   if (!IsIdempotent(IID))
3444     return nullptr;
3445
3446   // Unary Ops
3447   if (std::distance(ArgBegin, ArgEnd) == 1)
3448     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin))
3449       if (II->getIntrinsicID() == IID)
3450         return II;
3451
3452   return nullptr;
3453 }
3454
3455 template <typename IterTy>
3456 static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
3457                            const Query &Q, unsigned MaxRecurse) {
3458   Type *Ty = V->getType();
3459   if (PointerType *PTy = dyn_cast<PointerType>(Ty))
3460     Ty = PTy->getElementType();
3461   FunctionType *FTy = cast<FunctionType>(Ty);
3462
3463   // call undef -> undef
3464   if (isa<UndefValue>(V))
3465     return UndefValue::get(FTy->getReturnType());
3466
3467   Function *F = dyn_cast<Function>(V);
3468   if (!F)
3469     return nullptr;
3470
3471   if (unsigned IID = F->getIntrinsicID())
3472     if (Value *Ret =
3473         SimplifyIntrinsic((Intrinsic::ID) IID, ArgBegin, ArgEnd, Q, MaxRecurse))
3474       return Ret;
3475
3476   if (!canConstantFoldCallTo(F))
3477     return nullptr;
3478
3479   SmallVector<Constant *, 4> ConstantArgs;
3480   ConstantArgs.reserve(ArgEnd - ArgBegin);
3481   for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
3482     Constant *C = dyn_cast<Constant>(*I);
3483     if (!C)
3484       return nullptr;
3485     ConstantArgs.push_back(C);
3486   }
3487
3488   return ConstantFoldCall(F, ConstantArgs, Q.TLI);
3489 }
3490
3491 Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
3492                           User::op_iterator ArgEnd, const DataLayout *DL,
3493                           const TargetLibraryInfo *TLI,
3494                           const DominatorTree *DT, AssumptionTracker *AT,
3495                           const Instruction *CxtI) {
3496   return ::SimplifyCall(V, ArgBegin, ArgEnd, Query(DL, TLI, DT, AT, CxtI),
3497                         RecursionLimit);
3498 }
3499
3500 Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
3501                           const DataLayout *DL, const TargetLibraryInfo *TLI,
3502                           const DominatorTree *DT, AssumptionTracker *AT,
3503                           const Instruction *CxtI) {
3504   return ::SimplifyCall(V, Args.begin(), Args.end(),
3505                         Query(DL, TLI, DT, AT, CxtI), RecursionLimit);
3506 }
3507
3508 /// SimplifyInstruction - See if we can compute a simplified version of this
3509 /// instruction.  If not, this returns null.
3510 Value *llvm::SimplifyInstruction(Instruction *I, const DataLayout *DL,
3511                                  const TargetLibraryInfo *TLI,
3512                                  const DominatorTree *DT,
3513                                  AssumptionTracker *AT) {
3514   Value *Result;
3515
3516   switch (I->getOpcode()) {
3517   default:
3518     Result = ConstantFoldInstruction(I, DL, TLI);
3519     break;
3520   case Instruction::FAdd:
3521     Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
3522                               I->getFastMathFlags(), DL, TLI, DT, AT, I);
3523     break;
3524   case Instruction::Add:
3525     Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
3526                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
3527                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3528                              DL, TLI, DT, AT, I);
3529     break;
3530   case Instruction::FSub:
3531     Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
3532                               I->getFastMathFlags(), DL, TLI, DT, AT, I);
3533     break;
3534   case Instruction::Sub:
3535     Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
3536                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
3537                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3538                              DL, TLI, DT, AT, I);
3539     break;
3540   case Instruction::FMul:
3541     Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
3542                               I->getFastMathFlags(), DL, TLI, DT, AT, I);
3543     break;
3544   case Instruction::Mul:
3545     Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1),
3546                              DL, TLI, DT, AT, I);
3547     break;
3548   case Instruction::SDiv:
3549     Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1),
3550                               DL, TLI, DT, AT, I);
3551     break;
3552   case Instruction::UDiv:
3553     Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1),
3554                               DL, TLI, DT, AT, I);
3555     break;
3556   case Instruction::FDiv:
3557     Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
3558                               DL, TLI, DT, AT, I);
3559     break;
3560   case Instruction::SRem:
3561     Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1),
3562                               DL, TLI, DT, AT, I);
3563     break;
3564   case Instruction::URem:
3565     Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1),
3566                               DL, TLI, DT, AT, I);
3567     break;
3568   case Instruction::FRem:
3569     Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
3570                               DL, TLI, DT, AT, I);
3571     break;
3572   case Instruction::Shl:
3573     Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
3574                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
3575                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(),
3576                              DL, TLI, DT, AT, I);
3577     break;
3578   case Instruction::LShr:
3579     Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
3580                               cast<BinaryOperator>(I)->isExact(),
3581                               DL, TLI, DT, AT, I);
3582     break;
3583   case Instruction::AShr:
3584     Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
3585                               cast<BinaryOperator>(I)->isExact(),
3586                               DL, TLI, DT, AT, I);
3587     break;
3588   case Instruction::And:
3589     Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1),
3590                              DL, TLI, DT, AT, I);
3591     break;
3592   case Instruction::Or:
3593     Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), DL, TLI, DT,
3594                             AT, I);
3595     break;
3596   case Instruction::Xor:
3597     Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1),
3598                              DL, TLI, DT, AT, I);
3599     break;
3600   case Instruction::ICmp:
3601     Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
3602                               I->getOperand(0), I->getOperand(1),
3603                               DL, TLI, DT, AT, I);
3604     break;
3605   case Instruction::FCmp:
3606     Result = SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(),
3607                               I->getOperand(0), I->getOperand(1),
3608                               DL, TLI, DT, AT, I);
3609     break;
3610   case Instruction::Select:
3611     Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
3612                                 I->getOperand(2), DL, TLI, DT, AT, I);
3613     break;
3614   case Instruction::GetElementPtr: {
3615     SmallVector<Value*, 8> Ops(I->op_begin(), I->op_end());
3616     Result = SimplifyGEPInst(Ops, DL, TLI, DT, AT, I);
3617     break;
3618   }
3619   case Instruction::InsertValue: {
3620     InsertValueInst *IV = cast<InsertValueInst>(I);
3621     Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
3622                                      IV->getInsertedValueOperand(),
3623                                      IV->getIndices(), DL, TLI, DT, AT, I);
3624     break;
3625   }
3626   case Instruction::PHI:
3627     Result = SimplifyPHINode(cast<PHINode>(I), Query (DL, TLI, DT, AT, I));
3628     break;
3629   case Instruction::Call: {
3630     CallSite CS(cast<CallInst>(I));
3631     Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
3632                           DL, TLI, DT, AT, I);
3633     break;
3634   }
3635   case Instruction::Trunc:
3636     Result = SimplifyTruncInst(I->getOperand(0), I->getType(), DL, TLI, DT,
3637                                AT, I);
3638     break;
3639   }
3640
3641   /// If called on unreachable code, the above logic may report that the
3642   /// instruction simplified to itself.  Make life easier for users by
3643   /// detecting that case here, returning a safe value instead.
3644   return Result == I ? UndefValue::get(I->getType()) : Result;
3645 }
3646
3647 /// \brief Implementation of recursive simplification through an instructions
3648 /// uses.
3649 ///
3650 /// This is the common implementation of the recursive simplification routines.
3651 /// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
3652 /// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
3653 /// instructions to process and attempt to simplify it using
3654 /// InstructionSimplify.
3655 ///
3656 /// This routine returns 'true' only when *it* simplifies something. The passed
3657 /// in simplified value does not count toward this.
3658 static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
3659                                               const DataLayout *DL,
3660                                               const TargetLibraryInfo *TLI,
3661                                               const DominatorTree *DT,
3662                                               AssumptionTracker *AT) {
3663   bool Simplified = false;
3664   SmallSetVector<Instruction *, 8> Worklist;
3665
3666   // If we have an explicit value to collapse to, do that round of the
3667   // simplification loop by hand initially.
3668   if (SimpleV) {
3669     for (User *U : I->users())
3670       if (U != I)
3671         Worklist.insert(cast<Instruction>(U));
3672
3673     // Replace the instruction with its simplified value.
3674     I->replaceAllUsesWith(SimpleV);
3675
3676     // Gracefully handle edge cases where the instruction is not wired into any
3677     // parent block.
3678     if (I->getParent())
3679       I->eraseFromParent();
3680   } else {
3681     Worklist.insert(I);
3682   }
3683
3684   // Note that we must test the size on each iteration, the worklist can grow.
3685   for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
3686     I = Worklist[Idx];
3687
3688     // See if this instruction simplifies.
3689     SimpleV = SimplifyInstruction(I, DL, TLI, DT, AT);
3690     if (!SimpleV)
3691       continue;
3692
3693     Simplified = true;
3694
3695     // Stash away all the uses of the old instruction so we can check them for
3696     // recursive simplifications after a RAUW. This is cheaper than checking all
3697     // uses of To on the recursive step in most cases.
3698     for (User *U : I->users())
3699       Worklist.insert(cast<Instruction>(U));
3700
3701     // Replace the instruction with its simplified value.
3702     I->replaceAllUsesWith(SimpleV);
3703
3704     // Gracefully handle edge cases where the instruction is not wired into any
3705     // parent block.
3706     if (I->getParent())
3707       I->eraseFromParent();
3708   }
3709   return Simplified;
3710 }
3711
3712 bool llvm::recursivelySimplifyInstruction(Instruction *I,
3713                                           const DataLayout *DL,
3714                                           const TargetLibraryInfo *TLI,
3715                                           const DominatorTree *DT,
3716                                           AssumptionTracker *AT) {
3717   return replaceAndRecursivelySimplifyImpl(I, nullptr, DL, TLI, DT, AT);
3718 }
3719
3720 bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
3721                                          const DataLayout *DL,
3722                                          const TargetLibraryInfo *TLI,
3723                                          const DominatorTree *DT,
3724                                          AssumptionTracker *AT) {
3725   assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
3726   assert(SimpleV && "Must provide a simplified value.");
3727   return replaceAndRecursivelySimplifyImpl(I, SimpleV, DL, TLI, DT, AT);
3728 }