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