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