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/AssumptionCache.h"
25 #include "llvm/Analysis/CaptureTracking.h"
26 #include "llvm/Analysis/ConstantFolding.h"
27 #include "llvm/Analysis/LoopAnalysisManager.h"
28 #include "llvm/Analysis/MemoryBuiltins.h"
29 #include "llvm/Analysis/OptimizationDiagnosticInfo.h"
30 #include "llvm/Analysis/ValueTracking.h"
31 #include "llvm/Analysis/VectorUtils.h"
32 #include "llvm/IR/ConstantRange.h"
33 #include "llvm/IR/DataLayout.h"
34 #include "llvm/IR/Dominators.h"
35 #include "llvm/IR/GetElementPtrTypeIterator.h"
36 #include "llvm/IR/GlobalAlias.h"
37 #include "llvm/IR/Operator.h"
38 #include "llvm/IR/PatternMatch.h"
39 #include "llvm/IR/ValueHandle.h"
40 #include "llvm/Support/KnownBits.h"
41 #include <algorithm>
42 using namespace llvm;
43 using namespace llvm::PatternMatch;
44 
45 #define DEBUG_TYPE "instsimplify"
46 
47 enum { RecursionLimit = 3 };
48 
49 STATISTIC(NumExpand,  "Number of expansions");
50 STATISTIC(NumReassoc, "Number of reassociations");
51 
52 static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
53 static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
54                             unsigned);
55 static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
56                               const SimplifyQuery &, unsigned);
57 static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
58                               unsigned);
59 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
60                                const SimplifyQuery &Q, unsigned MaxRecurse);
61 static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
62 static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
63 static Value *SimplifyCastInst(unsigned, Value *, Type *,
64                                const SimplifyQuery &, unsigned);
65 
66 /// For a boolean type or a vector of boolean type, return false or a vector
67 /// with every element false.
68 static Constant *getFalse(Type *Ty) {
69   return ConstantInt::getFalse(Ty);
70 }
71 
72 /// For a boolean type or a vector of boolean type, return true or a vector
73 /// with every element true.
74 static Constant *getTrue(Type *Ty) {
75   return ConstantInt::getTrue(Ty);
76 }
77 
78 /// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
79 static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
80                           Value *RHS) {
81   CmpInst *Cmp = dyn_cast<CmpInst>(V);
82   if (!Cmp)
83     return false;
84   CmpInst::Predicate CPred = Cmp->getPredicate();
85   Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
86   if (CPred == Pred && CLHS == LHS && CRHS == RHS)
87     return true;
88   return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
89     CRHS == LHS;
90 }
91 
92 /// Does the given value dominate the specified phi node?
93 static bool ValueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
94   Instruction *I = dyn_cast<Instruction>(V);
95   if (!I)
96     // Arguments and constants dominate all instructions.
97     return true;
98 
99   // If we are processing instructions (and/or basic blocks) that have not been
100   // fully added to a function, the parent nodes may still be null. Simply
101   // return the conservative answer in these cases.
102   if (!I->getParent() || !P->getParent() || !I->getParent()->getParent())
103     return false;
104 
105   // If we have a DominatorTree then do a precise test.
106   if (DT) {
107     if (!DT->isReachableFromEntry(P->getParent()))
108       return true;
109     if (!DT->isReachableFromEntry(I->getParent()))
110       return false;
111     return DT->dominates(I, P);
112   }
113 
114   // Otherwise, if the instruction is in the entry block and is not an invoke,
115   // then it obviously dominates all phi nodes.
116   if (I->getParent() == &I->getParent()->getParent()->getEntryBlock() &&
117       !isa<InvokeInst>(I))
118     return true;
119 
120   return false;
121 }
122 
123 /// Simplify "A op (B op' C)" by distributing op over op', turning it into
124 /// "(A op B) op' (A op C)".  Here "op" is given by Opcode and "op'" is
125 /// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
126 /// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
127 /// Returns the simplified value, or null if no simplification was performed.
128 static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
129                           Instruction::BinaryOps OpcodeToExpand, const SimplifyQuery &Q,
130                           unsigned MaxRecurse) {
131   // Recursion is always used, so bail out at once if we already hit the limit.
132   if (!MaxRecurse--)
133     return nullptr;
134 
135   // Check whether the expression has the form "(A op' B) op C".
136   if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
137     if (Op0->getOpcode() == OpcodeToExpand) {
138       // It does!  Try turning it into "(A op C) op' (B op C)".
139       Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
140       // Do "A op C" and "B op C" both simplify?
141       if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
142         if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
143           // They do! Return "L op' R" if it simplifies or is already available.
144           // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
145           if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
146                                      && L == B && R == A)) {
147             ++NumExpand;
148             return LHS;
149           }
150           // Otherwise return "L op' R" if it simplifies.
151           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
152             ++NumExpand;
153             return V;
154           }
155         }
156     }
157 
158   // Check whether the expression has the form "A op (B op' C)".
159   if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
160     if (Op1->getOpcode() == OpcodeToExpand) {
161       // It does!  Try turning it into "(A op B) op' (A op C)".
162       Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
163       // Do "A op B" and "A op C" both simplify?
164       if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
165         if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
166           // They do! Return "L op' R" if it simplifies or is already available.
167           // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
168           if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
169                                      && L == C && R == B)) {
170             ++NumExpand;
171             return RHS;
172           }
173           // Otherwise return "L op' R" if it simplifies.
174           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
175             ++NumExpand;
176             return V;
177           }
178         }
179     }
180 
181   return nullptr;
182 }
183 
184 /// Generic simplifications for associative binary operations.
185 /// Returns the simpler value, or null if none was found.
186 static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
187                                        Value *LHS, Value *RHS, const SimplifyQuery &Q,
188                                        unsigned MaxRecurse) {
189   assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
190 
191   // Recursion is always used, so bail out at once if we already hit the limit.
192   if (!MaxRecurse--)
193     return nullptr;
194 
195   BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
196   BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
197 
198   // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
199   if (Op0 && Op0->getOpcode() == Opcode) {
200     Value *A = Op0->getOperand(0);
201     Value *B = Op0->getOperand(1);
202     Value *C = RHS;
203 
204     // Does "B op C" simplify?
205     if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
206       // It does!  Return "A op V" if it simplifies or is already available.
207       // If V equals B then "A op V" is just the LHS.
208       if (V == B) return LHS;
209       // Otherwise return "A op V" if it simplifies.
210       if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
211         ++NumReassoc;
212         return W;
213       }
214     }
215   }
216 
217   // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
218   if (Op1 && Op1->getOpcode() == Opcode) {
219     Value *A = LHS;
220     Value *B = Op1->getOperand(0);
221     Value *C = Op1->getOperand(1);
222 
223     // Does "A op B" simplify?
224     if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
225       // It does!  Return "V op C" if it simplifies or is already available.
226       // If V equals B then "V op C" is just the RHS.
227       if (V == B) return RHS;
228       // Otherwise return "V op C" if it simplifies.
229       if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
230         ++NumReassoc;
231         return W;
232       }
233     }
234   }
235 
236   // The remaining transforms require commutativity as well as associativity.
237   if (!Instruction::isCommutative(Opcode))
238     return nullptr;
239 
240   // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
241   if (Op0 && Op0->getOpcode() == Opcode) {
242     Value *A = Op0->getOperand(0);
243     Value *B = Op0->getOperand(1);
244     Value *C = RHS;
245 
246     // Does "C op A" simplify?
247     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
248       // It does!  Return "V op B" if it simplifies or is already available.
249       // If V equals A then "V op B" is just the LHS.
250       if (V == A) return LHS;
251       // Otherwise return "V op B" if it simplifies.
252       if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
253         ++NumReassoc;
254         return W;
255       }
256     }
257   }
258 
259   // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
260   if (Op1 && Op1->getOpcode() == Opcode) {
261     Value *A = LHS;
262     Value *B = Op1->getOperand(0);
263     Value *C = Op1->getOperand(1);
264 
265     // Does "C op A" simplify?
266     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
267       // It does!  Return "B op V" if it simplifies or is already available.
268       // If V equals C then "B op V" is just the RHS.
269       if (V == C) return RHS;
270       // Otherwise return "B op V" if it simplifies.
271       if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
272         ++NumReassoc;
273         return W;
274       }
275     }
276   }
277 
278   return nullptr;
279 }
280 
281 /// In the case of a binary operation with a select instruction as an operand,
282 /// try to simplify the binop by seeing whether evaluating it on both branches
283 /// of the select results in the same value. Returns the common value if so,
284 /// otherwise returns null.
285 static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
286                                     Value *RHS, const SimplifyQuery &Q,
287                                     unsigned MaxRecurse) {
288   // Recursion is always used, so bail out at once if we already hit the limit.
289   if (!MaxRecurse--)
290     return nullptr;
291 
292   SelectInst *SI;
293   if (isa<SelectInst>(LHS)) {
294     SI = cast<SelectInst>(LHS);
295   } else {
296     assert(isa<SelectInst>(RHS) && "No select instruction operand!");
297     SI = cast<SelectInst>(RHS);
298   }
299 
300   // Evaluate the BinOp on the true and false branches of the select.
301   Value *TV;
302   Value *FV;
303   if (SI == LHS) {
304     TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
305     FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
306   } else {
307     TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
308     FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
309   }
310 
311   // If they simplified to the same value, then return the common value.
312   // If they both failed to simplify then return null.
313   if (TV == FV)
314     return TV;
315 
316   // If one branch simplified to undef, return the other one.
317   if (TV && isa<UndefValue>(TV))
318     return FV;
319   if (FV && isa<UndefValue>(FV))
320     return TV;
321 
322   // If applying the operation did not change the true and false select values,
323   // then the result of the binop is the select itself.
324   if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
325     return SI;
326 
327   // If one branch simplified and the other did not, and the simplified
328   // value is equal to the unsimplified one, return the simplified value.
329   // For example, select (cond, X, X & Z) & Z -> X & Z.
330   if ((FV && !TV) || (TV && !FV)) {
331     // Check that the simplified value has the form "X op Y" where "op" is the
332     // same as the original operation.
333     Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
334     if (Simplified && Simplified->getOpcode() == Opcode) {
335       // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
336       // We already know that "op" is the same as for the simplified value.  See
337       // if the operands match too.  If so, return the simplified value.
338       Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
339       Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
340       Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
341       if (Simplified->getOperand(0) == UnsimplifiedLHS &&
342           Simplified->getOperand(1) == UnsimplifiedRHS)
343         return Simplified;
344       if (Simplified->isCommutative() &&
345           Simplified->getOperand(1) == UnsimplifiedLHS &&
346           Simplified->getOperand(0) == UnsimplifiedRHS)
347         return Simplified;
348     }
349   }
350 
351   return nullptr;
352 }
353 
354 /// In the case of a comparison with a select instruction, try to simplify the
355 /// comparison by seeing whether both branches of the select result in the same
356 /// value. Returns the common value if so, otherwise returns null.
357 static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
358                                   Value *RHS, const SimplifyQuery &Q,
359                                   unsigned MaxRecurse) {
360   // Recursion is always used, so bail out at once if we already hit the limit.
361   if (!MaxRecurse--)
362     return nullptr;
363 
364   // Make sure the select is on the LHS.
365   if (!isa<SelectInst>(LHS)) {
366     std::swap(LHS, RHS);
367     Pred = CmpInst::getSwappedPredicate(Pred);
368   }
369   assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
370   SelectInst *SI = cast<SelectInst>(LHS);
371   Value *Cond = SI->getCondition();
372   Value *TV = SI->getTrueValue();
373   Value *FV = SI->getFalseValue();
374 
375   // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
376   // Does "cmp TV, RHS" simplify?
377   Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
378   if (TCmp == Cond) {
379     // It not only simplified, it simplified to the select condition.  Replace
380     // it with 'true'.
381     TCmp = getTrue(Cond->getType());
382   } else if (!TCmp) {
383     // It didn't simplify.  However if "cmp TV, RHS" is equal to the select
384     // condition then we can replace it with 'true'.  Otherwise give up.
385     if (!isSameCompare(Cond, Pred, TV, RHS))
386       return nullptr;
387     TCmp = getTrue(Cond->getType());
388   }
389 
390   // Does "cmp FV, RHS" simplify?
391   Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
392   if (FCmp == Cond) {
393     // It not only simplified, it simplified to the select condition.  Replace
394     // it with 'false'.
395     FCmp = getFalse(Cond->getType());
396   } else if (!FCmp) {
397     // It didn't simplify.  However if "cmp FV, RHS" is equal to the select
398     // condition then we can replace it with 'false'.  Otherwise give up.
399     if (!isSameCompare(Cond, Pred, FV, RHS))
400       return nullptr;
401     FCmp = getFalse(Cond->getType());
402   }
403 
404   // If both sides simplified to the same value, then use it as the result of
405   // the original comparison.
406   if (TCmp == FCmp)
407     return TCmp;
408 
409   // The remaining cases only make sense if the select condition has the same
410   // type as the result of the comparison, so bail out if this is not so.
411   if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
412     return nullptr;
413   // If the false value simplified to false, then the result of the compare
414   // is equal to "Cond && TCmp".  This also catches the case when the false
415   // value simplified to false and the true value to true, returning "Cond".
416   if (match(FCmp, m_Zero()))
417     if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
418       return V;
419   // If the true value simplified to true, then the result of the compare
420   // is equal to "Cond || FCmp".
421   if (match(TCmp, m_One()))
422     if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
423       return V;
424   // Finally, if the false value simplified to true and the true value to
425   // false, then the result of the compare is equal to "!Cond".
426   if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
427     if (Value *V =
428         SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
429                         Q, MaxRecurse))
430       return V;
431 
432   return nullptr;
433 }
434 
435 /// In the case of a binary operation with an operand that is a PHI instruction,
436 /// try to simplify the binop by seeing whether evaluating it on the incoming
437 /// phi values yields the same result for every value. If so returns the common
438 /// value, otherwise returns null.
439 static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
440                                  Value *RHS, const SimplifyQuery &Q,
441                                  unsigned MaxRecurse) {
442   // Recursion is always used, so bail out at once if we already hit the limit.
443   if (!MaxRecurse--)
444     return nullptr;
445 
446   PHINode *PI;
447   if (isa<PHINode>(LHS)) {
448     PI = cast<PHINode>(LHS);
449     // Bail out if RHS and the phi may be mutually interdependent due to a loop.
450     if (!ValueDominatesPHI(RHS, PI, Q.DT))
451       return nullptr;
452   } else {
453     assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
454     PI = cast<PHINode>(RHS);
455     // Bail out if LHS and the phi may be mutually interdependent due to a loop.
456     if (!ValueDominatesPHI(LHS, PI, Q.DT))
457       return nullptr;
458   }
459 
460   // Evaluate the BinOp on the incoming phi values.
461   Value *CommonValue = nullptr;
462   for (Value *Incoming : PI->incoming_values()) {
463     // If the incoming value is the phi node itself, it can safely be skipped.
464     if (Incoming == PI) continue;
465     Value *V = PI == LHS ?
466       SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
467       SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
468     // If the operation failed to simplify, or simplified to a different value
469     // to previously, then give up.
470     if (!V || (CommonValue && V != CommonValue))
471       return nullptr;
472     CommonValue = V;
473   }
474 
475   return CommonValue;
476 }
477 
478 /// In the case of a comparison with a PHI instruction, try to simplify the
479 /// comparison by seeing whether comparing with all of the incoming phi values
480 /// yields the same result every time. If so returns the common result,
481 /// otherwise returns null.
482 static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
483                                const SimplifyQuery &Q, unsigned MaxRecurse) {
484   // Recursion is always used, so bail out at once if we already hit the limit.
485   if (!MaxRecurse--)
486     return nullptr;
487 
488   // Make sure the phi is on the LHS.
489   if (!isa<PHINode>(LHS)) {
490     std::swap(LHS, RHS);
491     Pred = CmpInst::getSwappedPredicate(Pred);
492   }
493   assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
494   PHINode *PI = cast<PHINode>(LHS);
495 
496   // Bail out if RHS and the phi may be mutually interdependent due to a loop.
497   if (!ValueDominatesPHI(RHS, PI, Q.DT))
498     return nullptr;
499 
500   // Evaluate the BinOp on the incoming phi values.
501   Value *CommonValue = nullptr;
502   for (Value *Incoming : PI->incoming_values()) {
503     // If the incoming value is the phi node itself, it can safely be skipped.
504     if (Incoming == PI) continue;
505     Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
506     // If the operation failed to simplify, or simplified to a different value
507     // to previously, then give up.
508     if (!V || (CommonValue && V != CommonValue))
509       return nullptr;
510     CommonValue = V;
511   }
512 
513   return CommonValue;
514 }
515 
516 static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
517                                        Value *&Op0, Value *&Op1,
518                                        const SimplifyQuery &Q) {
519   if (auto *CLHS = dyn_cast<Constant>(Op0)) {
520     if (auto *CRHS = dyn_cast<Constant>(Op1))
521       return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
522 
523     // Canonicalize the constant to the RHS if this is a commutative operation.
524     if (Instruction::isCommutative(Opcode))
525       std::swap(Op0, Op1);
526   }
527   return nullptr;
528 }
529 
530 /// Given operands for an Add, see if we can fold the result.
531 /// If not, this returns null.
532 static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
533                               const SimplifyQuery &Q, unsigned MaxRecurse) {
534   if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
535     return C;
536 
537   // X + undef -> undef
538   if (match(Op1, m_Undef()))
539     return Op1;
540 
541   // X + 0 -> X
542   if (match(Op1, m_Zero()))
543     return Op0;
544 
545   // X + (Y - X) -> Y
546   // (Y - X) + X -> Y
547   // Eg: X + -X -> 0
548   Value *Y = nullptr;
549   if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
550       match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
551     return Y;
552 
553   // X + ~X -> -1   since   ~X = -X-1
554   Type *Ty = Op0->getType();
555   if (match(Op0, m_Not(m_Specific(Op1))) ||
556       match(Op1, m_Not(m_Specific(Op0))))
557     return Constant::getAllOnesValue(Ty);
558 
559   // add nsw/nuw (xor Y, signmask), signmask --> Y
560   // The no-wrapping add guarantees that the top bit will be set by the add.
561   // Therefore, the xor must be clearing the already set sign bit of Y.
562   if ((isNSW || isNUW) && match(Op1, m_SignMask()) &&
563       match(Op0, m_Xor(m_Value(Y), m_SignMask())))
564     return Y;
565 
566   /// i1 add -> xor.
567   if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
568     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
569       return V;
570 
571   // Try some generic simplifications for associative operations.
572   if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
573                                           MaxRecurse))
574     return V;
575 
576   // Threading Add over selects and phi nodes is pointless, so don't bother.
577   // Threading over the select in "A + select(cond, B, C)" means evaluating
578   // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
579   // only if B and C are equal.  If B and C are equal then (since we assume
580   // that operands have already been simplified) "select(cond, B, C)" should
581   // have been simplified to the common value of B and C already.  Analysing
582   // "A+B" and "A+C" thus gains nothing, but costs compile time.  Similarly
583   // for threading over phi nodes.
584 
585   return nullptr;
586 }
587 
588 Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
589                              const SimplifyQuery &Query) {
590   return ::SimplifyAddInst(Op0, Op1, isNSW, isNUW, Query, RecursionLimit);
591 }
592 
593 /// \brief Compute the base pointer and cumulative constant offsets for V.
594 ///
595 /// This strips all constant offsets off of V, leaving it the base pointer, and
596 /// accumulates the total constant offset applied in the returned constant. It
597 /// returns 0 if V is not a pointer, and returns the constant '0' if there are
598 /// no constant offsets applied.
599 ///
600 /// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
601 /// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
602 /// folding.
603 static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
604                                                 bool AllowNonInbounds = false) {
605   assert(V->getType()->getScalarType()->isPointerTy());
606 
607   Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
608   APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
609 
610   // Even though we don't look through PHI nodes, we could be called on an
611   // instruction in an unreachable block, which may be on a cycle.
612   SmallPtrSet<Value *, 4> Visited;
613   Visited.insert(V);
614   do {
615     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
616       if ((!AllowNonInbounds && !GEP->isInBounds()) ||
617           !GEP->accumulateConstantOffset(DL, Offset))
618         break;
619       V = GEP->getPointerOperand();
620     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
621       V = cast<Operator>(V)->getOperand(0);
622     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
623       if (GA->isInterposable())
624         break;
625       V = GA->getAliasee();
626     } else {
627       if (auto CS = CallSite(V))
628         if (Value *RV = CS.getReturnedArgOperand()) {
629           V = RV;
630           continue;
631         }
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, Value *LHS,
648                                           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 /// Given operands for a Sub, see if we can fold the result.
665 /// If not, this returns null.
666 static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
667                               const SimplifyQuery &Q, unsigned MaxRecurse) {
668   if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
669     return C;
670 
671   // X - undef -> undef
672   // undef - X -> undef
673   if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
674     return UndefValue::get(Op0->getType());
675 
676   // X - 0 -> X
677   if (match(Op1, m_Zero()))
678     return Op0;
679 
680   // X - X -> 0
681   if (Op0 == Op1)
682     return Constant::getNullValue(Op0->getType());
683 
684   // Is this a negation?
685   if (match(Op0, m_Zero())) {
686     // 0 - X -> 0 if the sub is NUW.
687     if (isNUW)
688       return Op0;
689 
690     unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
691     KnownBits Known(BitWidth);
692     computeKnownBits(Op1, Known, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
693     if (Known.Zero.isMaxSignedValue()) {
694       // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
695       // Op1 must be 0 because negating the minimum signed value is undefined.
696       if (isNSW)
697         return Op0;
698 
699       // 0 - X -> X if X is 0 or the minimum signed value.
700       return Op1;
701     }
702   }
703 
704   // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
705   // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
706   Value *X = nullptr, *Y = nullptr, *Z = Op1;
707   if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
708     // See if "V === Y - Z" simplifies.
709     if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
710       // It does!  Now see if "X + V" simplifies.
711       if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
712         // It does, we successfully reassociated!
713         ++NumReassoc;
714         return W;
715       }
716     // See if "V === X - Z" simplifies.
717     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
718       // It does!  Now see if "Y + V" simplifies.
719       if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
720         // It does, we successfully reassociated!
721         ++NumReassoc;
722         return W;
723       }
724   }
725 
726   // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
727   // For example, X - (X + 1) -> -1
728   X = Op0;
729   if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
730     // See if "V === X - Y" simplifies.
731     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
732       // It does!  Now see if "V - Z" simplifies.
733       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
734         // It does, we successfully reassociated!
735         ++NumReassoc;
736         return W;
737       }
738     // See if "V === X - Z" simplifies.
739     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
740       // It does!  Now see if "V - Y" simplifies.
741       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
742         // It does, we successfully reassociated!
743         ++NumReassoc;
744         return W;
745       }
746   }
747 
748   // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
749   // For example, X - (X - Y) -> Y.
750   Z = Op0;
751   if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
752     // See if "V === Z - X" simplifies.
753     if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
754       // It does!  Now see if "V + Y" simplifies.
755       if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
756         // It does, we successfully reassociated!
757         ++NumReassoc;
758         return W;
759       }
760 
761   // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
762   if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
763       match(Op1, m_Trunc(m_Value(Y))))
764     if (X->getType() == Y->getType())
765       // See if "V === X - Y" simplifies.
766       if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
767         // It does!  Now see if "trunc V" simplifies.
768         if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
769                                         Q, MaxRecurse - 1))
770           // It does, return the simplified "trunc V".
771           return W;
772 
773   // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
774   if (match(Op0, m_PtrToInt(m_Value(X))) &&
775       match(Op1, m_PtrToInt(m_Value(Y))))
776     if (Constant *Result = computePointerDifference(Q.DL, X, Y))
777       return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
778 
779   // i1 sub -> xor.
780   if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
781     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
782       return V;
783 
784   // Threading Sub over selects and phi nodes is pointless, so don't bother.
785   // Threading over the select in "A - select(cond, B, C)" means evaluating
786   // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
787   // only if B and C are equal.  If B and C are equal then (since we assume
788   // that operands have already been simplified) "select(cond, B, C)" should
789   // have been simplified to the common value of B and C already.  Analysing
790   // "A-B" and "A-C" thus gains nothing, but costs compile time.  Similarly
791   // for threading over phi nodes.
792 
793   return nullptr;
794 }
795 
796 Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
797                              const SimplifyQuery &Q) {
798   return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
799 }
800 
801 /// Given operands for an FAdd, see if we can fold the result.  If not, this
802 /// returns null.
803 static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
804                               const SimplifyQuery &Q, unsigned MaxRecurse) {
805   if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
806     return C;
807 
808   // fadd X, -0 ==> X
809   if (match(Op1, m_NegZero()))
810     return Op0;
811 
812   // fadd X, 0 ==> X, when we know X is not -0
813   if (match(Op1, m_Zero()) &&
814       (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
815     return Op0;
816 
817   // fadd [nnan ninf] X, (fsub [nnan ninf] 0, X) ==> 0
818   //   where nnan and ninf have to occur at least once somewhere in this
819   //   expression
820   Value *SubOp = nullptr;
821   if (match(Op1, m_FSub(m_AnyZero(), m_Specific(Op0))))
822     SubOp = Op1;
823   else if (match(Op0, m_FSub(m_AnyZero(), m_Specific(Op1))))
824     SubOp = Op0;
825   if (SubOp) {
826     Instruction *FSub = cast<Instruction>(SubOp);
827     if ((FMF.noNaNs() || FSub->hasNoNaNs()) &&
828         (FMF.noInfs() || FSub->hasNoInfs()))
829       return Constant::getNullValue(Op0->getType());
830   }
831 
832   return nullptr;
833 }
834 
835 /// Given operands for an FSub, see if we can fold the result.  If not, this
836 /// returns null.
837 static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
838                               const SimplifyQuery &Q, unsigned MaxRecurse) {
839   if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
840     return C;
841 
842   // fsub X, 0 ==> X
843   if (match(Op1, m_Zero()))
844     return Op0;
845 
846   // fsub X, -0 ==> X, when we know X is not -0
847   if (match(Op1, m_NegZero()) &&
848       (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
849     return Op0;
850 
851   // fsub -0.0, (fsub -0.0, X) ==> X
852   Value *X;
853   if (match(Op0, m_NegZero()) && match(Op1, m_FSub(m_NegZero(), m_Value(X))))
854     return X;
855 
856   // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
857   if (FMF.noSignedZeros() && match(Op0, m_AnyZero()) &&
858       match(Op1, m_FSub(m_AnyZero(), m_Value(X))))
859     return X;
860 
861   // fsub nnan x, x ==> 0.0
862   if (FMF.noNaNs() && Op0 == Op1)
863     return Constant::getNullValue(Op0->getType());
864 
865   return nullptr;
866 }
867 
868 /// Given the operands for an FMul, see if we can fold the result
869 static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
870                                const SimplifyQuery &Q, unsigned MaxRecurse) {
871   if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
872     return C;
873 
874   // fmul X, 1.0 ==> X
875   if (match(Op1, m_FPOne()))
876     return Op0;
877 
878   // fmul nnan nsz X, 0 ==> 0
879   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZero()))
880     return Op1;
881 
882   return nullptr;
883 }
884 
885 /// Given operands for a Mul, see if we can fold the result.
886 /// If not, this returns null.
887 static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
888                               unsigned MaxRecurse) {
889   if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
890     return C;
891 
892   // X * undef -> 0
893   if (match(Op1, m_Undef()))
894     return Constant::getNullValue(Op0->getType());
895 
896   // X * 0 -> 0
897   if (match(Op1, m_Zero()))
898     return Op1;
899 
900   // X * 1 -> X
901   if (match(Op1, m_One()))
902     return Op0;
903 
904   // (X / Y) * Y -> X if the division is exact.
905   Value *X = nullptr;
906   if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
907       match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0)))))   // Y * (X / Y)
908     return X;
909 
910   // i1 mul -> and.
911   if (MaxRecurse && Op0->getType()->getScalarType()->isIntegerTy(1))
912     if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
913       return V;
914 
915   // Try some generic simplifications for associative operations.
916   if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
917                                           MaxRecurse))
918     return V;
919 
920   // Mul distributes over Add.  Try some generic simplifications based on this.
921   if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
922                              Q, MaxRecurse))
923     return V;
924 
925   // If the operation is with the result of a select instruction, check whether
926   // operating on either branch of the select always yields the same value.
927   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
928     if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
929                                          MaxRecurse))
930       return V;
931 
932   // If the operation is with the result of a phi instruction, check whether
933   // operating on all incoming values of the phi always yields the same value.
934   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
935     if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
936                                       MaxRecurse))
937       return V;
938 
939   return nullptr;
940 }
941 
942 Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
943                               const SimplifyQuery &Q) {
944   return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
945 }
946 
947 
948 Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
949                               const SimplifyQuery &Q) {
950   return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
951 }
952 
953 Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
954                               const SimplifyQuery &Q) {
955   return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
956 }
957 
958 Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
959   return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
960 }
961 
962 /// Check for common or similar folds of integer division or integer remainder.
963 static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
964   Type *Ty = Op0->getType();
965 
966   // X / undef -> undef
967   // X % undef -> undef
968   if (match(Op1, m_Undef()))
969     return Op1;
970 
971   // X / 0 -> undef
972   // X % 0 -> undef
973   // We don't need to preserve faults!
974   if (match(Op1, m_Zero()))
975     return UndefValue::get(Ty);
976 
977   // If any element of a constant divisor vector is zero, the whole op is undef.
978   auto *Op1C = dyn_cast<Constant>(Op1);
979   if (Op1C && Ty->isVectorTy()) {
980     unsigned NumElts = Ty->getVectorNumElements();
981     for (unsigned i = 0; i != NumElts; ++i) {
982       Constant *Elt = Op1C->getAggregateElement(i);
983       if (Elt && Elt->isNullValue())
984         return UndefValue::get(Ty);
985     }
986   }
987 
988   // undef / X -> 0
989   // undef % X -> 0
990   if (match(Op0, m_Undef()))
991     return Constant::getNullValue(Ty);
992 
993   // 0 / X -> 0
994   // 0 % X -> 0
995   if (match(Op0, m_Zero()))
996     return Op0;
997 
998   // X / X -> 1
999   // X % X -> 0
1000   if (Op0 == Op1)
1001     return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
1002 
1003   // X / 1 -> X
1004   // X % 1 -> 0
1005   // If this is a boolean op (single-bit element type), we can't have
1006   // division-by-zero or remainder-by-zero, so assume the divisor is 1.
1007   if (match(Op1, m_One()) || Ty->getScalarType()->isIntegerTy(1))
1008     return IsDiv ? Op0 : Constant::getNullValue(Ty);
1009 
1010   return nullptr;
1011 }
1012 
1013 /// Given operands for an SDiv or UDiv, see if we can fold the result.
1014 /// If not, this returns null.
1015 static Value *SimplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1016                           const SimplifyQuery &Q, unsigned MaxRecurse) {
1017   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1018     return C;
1019 
1020   if (Value *V = simplifyDivRem(Op0, Op1, true))
1021     return V;
1022 
1023   bool isSigned = Opcode == Instruction::SDiv;
1024 
1025   // (X * Y) / Y -> X if the multiplication does not overflow.
1026   Value *X = nullptr, *Y = nullptr;
1027   if (match(Op0, m_Mul(m_Value(X), m_Value(Y))) && (X == Op1 || Y == Op1)) {
1028     if (Y != Op1) std::swap(X, Y); // Ensure expression is (X * Y) / Y, Y = Op1
1029     OverflowingBinaryOperator *Mul = cast<OverflowingBinaryOperator>(Op0);
1030     // If the Mul knows it does not overflow, then we are good to go.
1031     if ((isSigned && Mul->hasNoSignedWrap()) ||
1032         (!isSigned && Mul->hasNoUnsignedWrap()))
1033       return X;
1034     // If X has the form X = A / Y then X * Y cannot overflow.
1035     if (BinaryOperator *Div = dyn_cast<BinaryOperator>(X))
1036       if (Div->getOpcode() == Opcode && Div->getOperand(1) == Y)
1037         return X;
1038   }
1039 
1040   // (X rem Y) / Y -> 0
1041   if ((isSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1042       (!isSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1043     return Constant::getNullValue(Op0->getType());
1044 
1045   // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1046   ConstantInt *C1, *C2;
1047   if (!isSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1048       match(Op1, m_ConstantInt(C2))) {
1049     bool Overflow;
1050     (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
1051     if (Overflow)
1052       return Constant::getNullValue(Op0->getType());
1053   }
1054 
1055   // If the operation is with the result of a select instruction, check whether
1056   // operating on either branch of the select always yields the same value.
1057   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1058     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1059       return V;
1060 
1061   // If the operation is with the result of a phi instruction, check whether
1062   // operating on all incoming values of the phi always yields the same value.
1063   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1064     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1065       return V;
1066 
1067   return nullptr;
1068 }
1069 
1070 /// Given operands for an SDiv, see if we can fold the result.
1071 /// If not, this returns null.
1072 static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1073                                unsigned MaxRecurse) {
1074   if (Value *V = SimplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse))
1075     return V;
1076 
1077   return nullptr;
1078 }
1079 
1080 Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1081   return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1082 }
1083 
1084 /// Given operands for a UDiv, see if we can fold the result.
1085 /// If not, this returns null.
1086 static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1087                                unsigned MaxRecurse) {
1088   if (Value *V = SimplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse))
1089     return V;
1090 
1091   // udiv %V, C -> 0 if %V < C
1092   if (MaxRecurse) {
1093     if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1094             ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1095       if (C->isAllOnesValue()) {
1096         return Constant::getNullValue(Op0->getType());
1097       }
1098     }
1099   }
1100 
1101   return nullptr;
1102 }
1103 
1104 Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1105   return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1106 }
1107 
1108 static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
1109                                const SimplifyQuery &Q, unsigned) {
1110   if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
1111     return C;
1112 
1113   // undef / X -> undef    (the undef could be a snan).
1114   if (match(Op0, m_Undef()))
1115     return Op0;
1116 
1117   // X / undef -> undef
1118   if (match(Op1, m_Undef()))
1119     return Op1;
1120 
1121   // X / 1.0 -> X
1122   if (match(Op1, m_FPOne()))
1123     return Op0;
1124 
1125   // 0 / X -> 0
1126   // Requires that NaNs are off (X could be zero) and signed zeroes are
1127   // ignored (X could be positive or negative, so the output sign is unknown).
1128   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1129     return Op0;
1130 
1131   if (FMF.noNaNs()) {
1132     // X / X -> 1.0 is legal when NaNs are ignored.
1133     if (Op0 == Op1)
1134       return ConstantFP::get(Op0->getType(), 1.0);
1135 
1136     // -X /  X -> -1.0 and
1137     //  X / -X -> -1.0 are legal when NaNs are ignored.
1138     // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
1139     if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
1140          BinaryOperator::getFNegArgument(Op0) == Op1) ||
1141         (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
1142          BinaryOperator::getFNegArgument(Op1) == Op0))
1143       return ConstantFP::get(Op0->getType(), -1.0);
1144   }
1145 
1146   return nullptr;
1147 }
1148 
1149 Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
1150                               const SimplifyQuery &Q) {
1151   return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
1152 }
1153 
1154 /// Given operands for an SRem or URem, see if we can fold the result.
1155 /// If not, this returns null.
1156 static Value *SimplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1157                           const SimplifyQuery &Q, unsigned MaxRecurse) {
1158   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1159     return C;
1160 
1161   if (Value *V = simplifyDivRem(Op0, Op1, false))
1162     return V;
1163 
1164   // (X % Y) % Y -> X % Y
1165   if ((Opcode == Instruction::SRem &&
1166        match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1167       (Opcode == Instruction::URem &&
1168        match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1169     return Op0;
1170 
1171   // If the operation is with the result of a select instruction, check whether
1172   // operating on either branch of the select always yields the same value.
1173   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1174     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1175       return V;
1176 
1177   // If the operation is with the result of a phi instruction, check whether
1178   // operating on all incoming values of the phi always yields the same value.
1179   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1180     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1181       return V;
1182 
1183   return nullptr;
1184 }
1185 
1186 /// Given operands for an SRem, see if we can fold the result.
1187 /// If not, this returns null.
1188 static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1189                                unsigned MaxRecurse) {
1190   if (Value *V = SimplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse))
1191     return V;
1192 
1193   return nullptr;
1194 }
1195 
1196 Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1197   return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1198 }
1199 
1200 /// Given operands for a URem, see if we can fold the result.
1201 /// If not, this returns null.
1202 static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1203                                unsigned MaxRecurse) {
1204   if (Value *V = SimplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse))
1205     return V;
1206 
1207   // urem %V, C -> %V if %V < C
1208   if (MaxRecurse) {
1209     if (Constant *C = dyn_cast_or_null<Constant>(SimplifyICmpInst(
1210             ICmpInst::ICMP_ULT, Op0, Op1, Q, MaxRecurse - 1))) {
1211       if (C->isAllOnesValue()) {
1212         return Op0;
1213       }
1214     }
1215   }
1216 
1217   return nullptr;
1218 }
1219 
1220 Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1221   return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1222 }
1223 
1224 static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
1225                                const SimplifyQuery &Q, unsigned) {
1226   if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
1227     return C;
1228 
1229   // undef % X -> undef    (the undef could be a snan).
1230   if (match(Op0, m_Undef()))
1231     return Op0;
1232 
1233   // X % undef -> undef
1234   if (match(Op1, m_Undef()))
1235     return Op1;
1236 
1237   // 0 % X -> 0
1238   // Requires that NaNs are off (X could be zero) and signed zeroes are
1239   // ignored (X could be positive or negative, so the output sign is unknown).
1240   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZero()))
1241     return Op0;
1242 
1243   return nullptr;
1244 }
1245 
1246 Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
1247                               const SimplifyQuery &Q) {
1248   return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
1249 }
1250 
1251 /// Returns true if a shift by \c Amount always yields undef.
1252 static bool isUndefShift(Value *Amount) {
1253   Constant *C = dyn_cast<Constant>(Amount);
1254   if (!C)
1255     return false;
1256 
1257   // X shift by undef -> undef because it may shift by the bitwidth.
1258   if (isa<UndefValue>(C))
1259     return true;
1260 
1261   // Shifting by the bitwidth or more is undefined.
1262   if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1263     if (CI->getValue().getLimitedValue() >=
1264         CI->getType()->getScalarSizeInBits())
1265       return true;
1266 
1267   // If all lanes of a vector shift are undefined the whole shift is.
1268   if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1269     for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1270       if (!isUndefShift(C->getAggregateElement(I)))
1271         return false;
1272     return true;
1273   }
1274 
1275   return false;
1276 }
1277 
1278 /// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1279 /// If not, this returns null.
1280 static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
1281                             Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
1282   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1283     return C;
1284 
1285   // 0 shift by X -> 0
1286   if (match(Op0, m_Zero()))
1287     return Op0;
1288 
1289   // X shift by 0 -> X
1290   if (match(Op1, m_Zero()))
1291     return Op0;
1292 
1293   // Fold undefined shifts.
1294   if (isUndefShift(Op1))
1295     return UndefValue::get(Op0->getType());
1296 
1297   // If the operation is with the result of a select instruction, check whether
1298   // operating on either branch of the select always yields the same value.
1299   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1300     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1301       return V;
1302 
1303   // If the operation is with the result of a phi instruction, check whether
1304   // operating on all incoming values of the phi always yields the same value.
1305   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1306     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1307       return V;
1308 
1309   // If any bits in the shift amount make that value greater than or equal to
1310   // the number of bits in the type, the shift is undefined.
1311   unsigned BitWidth = Op1->getType()->getScalarSizeInBits();
1312   KnownBits Known(BitWidth);
1313   computeKnownBits(Op1, Known, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1314   if (Known.One.getLimitedValue() >= BitWidth)
1315     return UndefValue::get(Op0->getType());
1316 
1317   // If all valid bits in the shift amount are known zero, the first operand is
1318   // unchanged.
1319   unsigned NumValidShiftBits = Log2_32_Ceil(BitWidth);
1320   if (Known.Zero.countTrailingOnes() >= NumValidShiftBits)
1321     return Op0;
1322 
1323   return nullptr;
1324 }
1325 
1326 /// \brief Given operands for an Shl, LShr or AShr, see if we can
1327 /// fold the result.  If not, this returns null.
1328 static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
1329                                  Value *Op1, bool isExact, const SimplifyQuery &Q,
1330                                  unsigned MaxRecurse) {
1331   if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1332     return V;
1333 
1334   // X >> X -> 0
1335   if (Op0 == Op1)
1336     return Constant::getNullValue(Op0->getType());
1337 
1338   // undef >> X -> 0
1339   // undef >> X -> undef (if it's exact)
1340   if (match(Op0, m_Undef()))
1341     return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1342 
1343   // The low bit cannot be shifted out of an exact shift if it is set.
1344   if (isExact) {
1345     unsigned BitWidth = Op0->getType()->getScalarSizeInBits();
1346     KnownBits Op0Known(BitWidth);
1347     computeKnownBits(Op0, Op0Known, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
1348     if (Op0Known.One[0])
1349       return Op0;
1350   }
1351 
1352   return nullptr;
1353 }
1354 
1355 /// Given operands for an Shl, see if we can fold the result.
1356 /// If not, this returns null.
1357 static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1358                               const SimplifyQuery &Q, unsigned MaxRecurse) {
1359   if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
1360     return V;
1361 
1362   // undef << X -> 0
1363   // undef << X -> undef if (if it's NSW/NUW)
1364   if (match(Op0, m_Undef()))
1365     return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
1366 
1367   // (X >> A) << A -> X
1368   Value *X;
1369   if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
1370     return X;
1371   return nullptr;
1372 }
1373 
1374 Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1375                              const SimplifyQuery &Q) {
1376   return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1377 }
1378 
1379 /// Given operands for an LShr, see if we can fold the result.
1380 /// If not, this returns null.
1381 static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1382                                const SimplifyQuery &Q, unsigned MaxRecurse) {
1383   if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1384                                     MaxRecurse))
1385       return V;
1386 
1387   // (X << A) >> A -> X
1388   Value *X;
1389   if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
1390     return X;
1391 
1392   return nullptr;
1393 }
1394 
1395 Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1396                               const SimplifyQuery &Q) {
1397   return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1398 }
1399 
1400 /// Given operands for an AShr, see if we can fold the result.
1401 /// If not, this returns null.
1402 static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1403                                const SimplifyQuery &Q, unsigned MaxRecurse) {
1404   if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1405                                     MaxRecurse))
1406     return V;
1407 
1408   // all ones >>a X -> all ones
1409   if (match(Op0, m_AllOnes()))
1410     return Op0;
1411 
1412   // (X << A) >> A -> X
1413   Value *X;
1414   if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
1415     return X;
1416 
1417   // Arithmetic shifting an all-sign-bit value is a no-op.
1418   unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1419   if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1420     return Op0;
1421 
1422   return nullptr;
1423 }
1424 
1425 Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1426                               const SimplifyQuery &Q) {
1427   return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1428 }
1429 
1430 static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1431                                          ICmpInst *UnsignedICmp, bool IsAnd) {
1432   Value *X, *Y;
1433 
1434   ICmpInst::Predicate EqPred;
1435   if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1436       !ICmpInst::isEquality(EqPred))
1437     return nullptr;
1438 
1439   ICmpInst::Predicate UnsignedPred;
1440   if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1441       ICmpInst::isUnsigned(UnsignedPred))
1442     ;
1443   else if (match(UnsignedICmp,
1444                  m_ICmp(UnsignedPred, m_Value(Y), m_Specific(X))) &&
1445            ICmpInst::isUnsigned(UnsignedPred))
1446     UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1447   else
1448     return nullptr;
1449 
1450   // X < Y && Y != 0  -->  X < Y
1451   // X < Y || Y != 0  -->  Y != 0
1452   if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1453     return IsAnd ? UnsignedICmp : ZeroICmp;
1454 
1455   // X >= Y || Y != 0  -->  true
1456   // X >= Y || Y == 0  -->  X >= Y
1457   if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1458     if (EqPred == ICmpInst::ICMP_NE)
1459       return getTrue(UnsignedICmp->getType());
1460     return UnsignedICmp;
1461   }
1462 
1463   // X < Y && Y == 0  -->  false
1464   if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1465       IsAnd)
1466     return getFalse(UnsignedICmp->getType());
1467 
1468   return nullptr;
1469 }
1470 
1471 /// Commuted variants are assumed to be handled by calling this function again
1472 /// with the parameters swapped.
1473 static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1474   ICmpInst::Predicate Pred0, Pred1;
1475   Value *A ,*B;
1476   if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1477       !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1478     return nullptr;
1479 
1480   // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1481   // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1482   // can eliminate Op1 from this 'and'.
1483   if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1484     return Op0;
1485 
1486   // Check for any combination of predicates that are guaranteed to be disjoint.
1487   if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1488       (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1489       (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1490       (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1491     return getFalse(Op0->getType());
1492 
1493   return nullptr;
1494 }
1495 
1496 /// Commuted variants are assumed to be handled by calling this function again
1497 /// with the parameters swapped.
1498 static Value *SimplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1499   if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1500     return X;
1501 
1502   if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1503     return X;
1504 
1505   // FIXME: This should be shared with or-of-icmps.
1506   // Look for this pattern: (icmp V, C0) & (icmp V, C1)).
1507   Type *ITy = Op0->getType();
1508   ICmpInst::Predicate Pred0, Pred1;
1509   const APInt *C0, *C1;
1510   Value *V;
1511   if (match(Op0, m_ICmp(Pred0, m_Value(V), m_APInt(C0))) &&
1512       match(Op1, m_ICmp(Pred1, m_Specific(V), m_APInt(C1)))) {
1513     // Make a constant range that's the intersection of the two icmp ranges.
1514     // If the intersection is empty, we know that the result is false.
1515     auto Range0 = ConstantRange::makeExactICmpRegion(Pred0, *C0);
1516     auto Range1 = ConstantRange::makeExactICmpRegion(Pred1, *C1);
1517     if (Range0.intersectWith(Range1).isEmptySet())
1518       return getFalse(ITy);
1519 
1520     // If a range is a superset of the other, the smaller set is all we need.
1521     if (Range0.contains(Range1))
1522       return Op1;
1523     if (Range1.contains(Range0))
1524       return Op0;
1525   }
1526 
1527   // (icmp (add V, C0), C1) & (icmp V, C0)
1528   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1529     return nullptr;
1530 
1531   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1532     return nullptr;
1533 
1534   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1535   if (AddInst->getOperand(1) != Op1->getOperand(1))
1536     return nullptr;
1537 
1538   bool isNSW = AddInst->hasNoSignedWrap();
1539   bool isNUW = AddInst->hasNoUnsignedWrap();
1540 
1541   const APInt Delta = *C1 - *C0;
1542   if (C0->isStrictlyPositive()) {
1543     if (Delta == 2) {
1544       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1545         return getFalse(ITy);
1546       if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1547         return getFalse(ITy);
1548     }
1549     if (Delta == 1) {
1550       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1551         return getFalse(ITy);
1552       if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1553         return getFalse(ITy);
1554     }
1555   }
1556   if (C0->getBoolValue() && isNUW) {
1557     if (Delta == 2)
1558       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1559         return getFalse(ITy);
1560     if (Delta == 1)
1561       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1562         return getFalse(ITy);
1563   }
1564 
1565   return nullptr;
1566 }
1567 
1568 /// Given operands for an And, see if we can fold the result.
1569 /// If not, this returns null.
1570 static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1571                               unsigned MaxRecurse) {
1572   if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1573     return C;
1574 
1575   // X & undef -> 0
1576   if (match(Op1, m_Undef()))
1577     return Constant::getNullValue(Op0->getType());
1578 
1579   // X & X = X
1580   if (Op0 == Op1)
1581     return Op0;
1582 
1583   // X & 0 = 0
1584   if (match(Op1, m_Zero()))
1585     return Op1;
1586 
1587   // X & -1 = X
1588   if (match(Op1, m_AllOnes()))
1589     return Op0;
1590 
1591   // A & ~A  =  ~A & A  =  0
1592   if (match(Op0, m_Not(m_Specific(Op1))) ||
1593       match(Op1, m_Not(m_Specific(Op0))))
1594     return Constant::getNullValue(Op0->getType());
1595 
1596   // (A | ?) & A = A
1597   Value *A = nullptr, *B = nullptr;
1598   if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
1599       (A == Op1 || B == Op1))
1600     return Op1;
1601 
1602   // A & (A | ?) = A
1603   if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
1604       (A == Op0 || B == Op0))
1605     return Op0;
1606 
1607   // A & (-A) = A if A is a power of two or zero.
1608   if (match(Op0, m_Neg(m_Specific(Op1))) ||
1609       match(Op1, m_Neg(m_Specific(Op0)))) {
1610     if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1611                                Q.DT))
1612       return Op0;
1613     if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1614                                Q.DT))
1615       return Op1;
1616   }
1617 
1618   if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1619     if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1620       if (Value *V = SimplifyAndOfICmps(ICILHS, ICIRHS))
1621         return V;
1622       if (Value *V = SimplifyAndOfICmps(ICIRHS, ICILHS))
1623         return V;
1624     }
1625   }
1626 
1627   // The compares may be hidden behind casts. Look through those and try the
1628   // same folds as above.
1629   auto *Cast0 = dyn_cast<CastInst>(Op0);
1630   auto *Cast1 = dyn_cast<CastInst>(Op1);
1631   if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1632       Cast0->getSrcTy() == Cast1->getSrcTy()) {
1633     auto *Cmp0 = dyn_cast<ICmpInst>(Cast0->getOperand(0));
1634     auto *Cmp1 = dyn_cast<ICmpInst>(Cast1->getOperand(0));
1635     if (Cmp0 && Cmp1) {
1636       Instruction::CastOps CastOpc = Cast0->getOpcode();
1637       Type *ResultType = Cast0->getType();
1638       if (auto *V = dyn_cast_or_null<Constant>(SimplifyAndOfICmps(Cmp0, Cmp1)))
1639         return ConstantExpr::getCast(CastOpc, V, ResultType);
1640       if (auto *V = dyn_cast_or_null<Constant>(SimplifyAndOfICmps(Cmp1, Cmp0)))
1641         return ConstantExpr::getCast(CastOpc, V, ResultType);
1642     }
1643   }
1644 
1645   // Try some generic simplifications for associative operations.
1646   if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1647                                           MaxRecurse))
1648     return V;
1649 
1650   // And distributes over Or.  Try some generic simplifications based on this.
1651   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
1652                              Q, MaxRecurse))
1653     return V;
1654 
1655   // And distributes over Xor.  Try some generic simplifications based on this.
1656   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
1657                              Q, MaxRecurse))
1658     return V;
1659 
1660   // If the operation is with the result of a select instruction, check whether
1661   // operating on either branch of the select always yields the same value.
1662   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1663     if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1664                                          MaxRecurse))
1665       return V;
1666 
1667   // If the operation is with the result of a phi instruction, check whether
1668   // operating on all incoming values of the phi always yields the same value.
1669   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1670     if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
1671                                       MaxRecurse))
1672       return V;
1673 
1674   return nullptr;
1675 }
1676 
1677 Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1678   return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1679 }
1680 
1681 /// Commuted variants are assumed to be handled by calling this function again
1682 /// with the parameters swapped.
1683 static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1684   ICmpInst::Predicate Pred0, Pred1;
1685   Value *A ,*B;
1686   if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1687       !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1688     return nullptr;
1689 
1690   // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1691   // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1692   // can eliminate Op0 from this 'or'.
1693   if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1694     return Op1;
1695 
1696   // Check for any combination of predicates that cover the entire range of
1697   // possibilities.
1698   if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1699       (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1700       (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1701       (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1702     return getTrue(Op0->getType());
1703 
1704   return nullptr;
1705 }
1706 
1707 /// Commuted variants are assumed to be handled by calling this function again
1708 /// with the parameters swapped.
1709 static Value *SimplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1710   if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1711     return X;
1712 
1713   if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1714     return X;
1715 
1716   // (icmp (add V, C0), C1) | (icmp V, C0)
1717   ICmpInst::Predicate Pred0, Pred1;
1718   const APInt *C0, *C1;
1719   Value *V;
1720   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1721     return nullptr;
1722 
1723   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1724     return nullptr;
1725 
1726   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1727   if (AddInst->getOperand(1) != Op1->getOperand(1))
1728     return nullptr;
1729 
1730   Type *ITy = Op0->getType();
1731   bool isNSW = AddInst->hasNoSignedWrap();
1732   bool isNUW = AddInst->hasNoUnsignedWrap();
1733 
1734   const APInt Delta = *C1 - *C0;
1735   if (C0->isStrictlyPositive()) {
1736     if (Delta == 2) {
1737       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1738         return getTrue(ITy);
1739       if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1740         return getTrue(ITy);
1741     }
1742     if (Delta == 1) {
1743       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1744         return getTrue(ITy);
1745       if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1746         return getTrue(ITy);
1747     }
1748   }
1749   if (C0->getBoolValue() && isNUW) {
1750     if (Delta == 2)
1751       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1752         return getTrue(ITy);
1753     if (Delta == 1)
1754       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1755         return getTrue(ITy);
1756   }
1757 
1758   return nullptr;
1759 }
1760 
1761 /// Given operands for an Or, see if we can fold the result.
1762 /// If not, this returns null.
1763 static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1764                              unsigned MaxRecurse) {
1765   if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1766     return C;
1767 
1768   // X | undef -> -1
1769   if (match(Op1, m_Undef()))
1770     return Constant::getAllOnesValue(Op0->getType());
1771 
1772   // X | X = X
1773   if (Op0 == Op1)
1774     return Op0;
1775 
1776   // X | 0 = X
1777   if (match(Op1, m_Zero()))
1778     return Op0;
1779 
1780   // X | -1 = -1
1781   if (match(Op1, m_AllOnes()))
1782     return Op1;
1783 
1784   // A | ~A  =  ~A | A  =  -1
1785   if (match(Op0, m_Not(m_Specific(Op1))) ||
1786       match(Op1, m_Not(m_Specific(Op0))))
1787     return Constant::getAllOnesValue(Op0->getType());
1788 
1789   // (A & ?) | A = A
1790   Value *A = nullptr, *B = nullptr;
1791   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1792       (A == Op1 || B == Op1))
1793     return Op1;
1794 
1795   // A | (A & ?) = A
1796   if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1797       (A == Op0 || B == Op0))
1798     return Op0;
1799 
1800   // ~(A & ?) | A = -1
1801   if (match(Op0, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1802       (A == Op1 || B == Op1))
1803     return Constant::getAllOnesValue(Op1->getType());
1804 
1805   // A | ~(A & ?) = -1
1806   if (match(Op1, m_Not(m_And(m_Value(A), m_Value(B)))) &&
1807       (A == Op0 || B == Op0))
1808     return Constant::getAllOnesValue(Op0->getType());
1809 
1810   // (A & ~B) | (A ^ B) -> (A ^ B)
1811   // (~B & A) | (A ^ B) -> (A ^ B)
1812   // (A & ~B) | (B ^ A) -> (B ^ A)
1813   // (~B & A) | (B ^ A) -> (B ^ A)
1814   if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1815       (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1816        match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
1817     return Op1;
1818 
1819   // Commute the 'or' operands.
1820   // (A ^ B) | (A & ~B) -> (A ^ B)
1821   // (A ^ B) | (~B & A) -> (A ^ B)
1822   // (B ^ A) | (A & ~B) -> (B ^ A)
1823   // (B ^ A) | (~B & A) -> (B ^ A)
1824   if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1825       (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1826        match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
1827     return Op0;
1828 
1829   if (auto *ICILHS = dyn_cast<ICmpInst>(Op0)) {
1830     if (auto *ICIRHS = dyn_cast<ICmpInst>(Op1)) {
1831       if (Value *V = SimplifyOrOfICmps(ICILHS, ICIRHS))
1832         return V;
1833       if (Value *V = SimplifyOrOfICmps(ICIRHS, ICILHS))
1834         return V;
1835     }
1836   }
1837 
1838   // Try some generic simplifications for associative operations.
1839   if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1840                                           MaxRecurse))
1841     return V;
1842 
1843   // Or distributes over And.  Try some generic simplifications based on this.
1844   if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1845                              MaxRecurse))
1846     return V;
1847 
1848   // If the operation is with the result of a select instruction, check whether
1849   // operating on either branch of the select always yields the same value.
1850   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1851     if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
1852                                          MaxRecurse))
1853       return V;
1854 
1855   // (A & C)|(B & D)
1856   Value *C = nullptr, *D = nullptr;
1857   if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
1858       match(Op1, m_And(m_Value(B), m_Value(D)))) {
1859     ConstantInt *C1 = dyn_cast<ConstantInt>(C);
1860     ConstantInt *C2 = dyn_cast<ConstantInt>(D);
1861     if (C1 && C2 && (C1->getValue() == ~C2->getValue())) {
1862       // (A & C1)|(B & C2)
1863       // If we have: ((V + N) & C1) | (V & C2)
1864       // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1865       // replace with V+N.
1866       Value *V1, *V2;
1867       if ((C2->getValue() & (C2->getValue() + 1)) == 0 && // C2 == 0+1+
1868           match(A, m_Add(m_Value(V1), m_Value(V2)))) {
1869         // Add commutes, try both ways.
1870         if (V1 == B &&
1871             MaskedValueIsZero(V2, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
1872           return A;
1873         if (V2 == B &&
1874             MaskedValueIsZero(V1, C2->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
1875           return A;
1876       }
1877       // Or commutes, try both ways.
1878       if ((C1->getValue() & (C1->getValue() + 1)) == 0 &&
1879           match(B, m_Add(m_Value(V1), m_Value(V2)))) {
1880         // Add commutes, try both ways.
1881         if (V1 == A &&
1882             MaskedValueIsZero(V2, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
1883           return B;
1884         if (V2 == A &&
1885             MaskedValueIsZero(V1, C1->getValue(), Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
1886           return B;
1887       }
1888     }
1889   }
1890 
1891   // If the operation is with the result of a phi instruction, check whether
1892   // operating on all incoming values of the phi always yields the same value.
1893   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1894     if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
1895       return V;
1896 
1897   return nullptr;
1898 }
1899 
1900 Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1901   return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
1902 }
1903 
1904 /// Given operands for a Xor, see if we can fold the result.
1905 /// If not, this returns null.
1906 static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1907                               unsigned MaxRecurse) {
1908   if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1909     return C;
1910 
1911   // A ^ undef -> undef
1912   if (match(Op1, m_Undef()))
1913     return Op1;
1914 
1915   // A ^ 0 = A
1916   if (match(Op1, m_Zero()))
1917     return Op0;
1918 
1919   // A ^ A = 0
1920   if (Op0 == Op1)
1921     return Constant::getNullValue(Op0->getType());
1922 
1923   // A ^ ~A  =  ~A ^ A  =  -1
1924   if (match(Op0, m_Not(m_Specific(Op1))) ||
1925       match(Op1, m_Not(m_Specific(Op0))))
1926     return Constant::getAllOnesValue(Op0->getType());
1927 
1928   // Try some generic simplifications for associative operations.
1929   if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
1930                                           MaxRecurse))
1931     return V;
1932 
1933   // Threading Xor over selects and phi nodes is pointless, so don't bother.
1934   // Threading over the select in "A ^ select(cond, B, C)" means evaluating
1935   // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
1936   // only if B and C are equal.  If B and C are equal then (since we assume
1937   // that operands have already been simplified) "select(cond, B, C)" should
1938   // have been simplified to the common value of B and C already.  Analysing
1939   // "A^B" and "A^C" thus gains nothing, but costs compile time.  Similarly
1940   // for threading over phi nodes.
1941 
1942   return nullptr;
1943 }
1944 
1945 Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1946   return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
1947 }
1948 
1949 
1950 static Type *GetCompareTy(Value *Op) {
1951   return CmpInst::makeCmpResultType(Op->getType());
1952 }
1953 
1954 /// Rummage around inside V looking for something equivalent to the comparison
1955 /// "LHS Pred RHS". Return such a value if found, otherwise return null.
1956 /// Helper function for analyzing max/min idioms.
1957 static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
1958                                          Value *LHS, Value *RHS) {
1959   SelectInst *SI = dyn_cast<SelectInst>(V);
1960   if (!SI)
1961     return nullptr;
1962   CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
1963   if (!Cmp)
1964     return nullptr;
1965   Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
1966   if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
1967     return Cmp;
1968   if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
1969       LHS == CmpRHS && RHS == CmpLHS)
1970     return Cmp;
1971   return nullptr;
1972 }
1973 
1974 // A significant optimization not implemented here is assuming that alloca
1975 // addresses are not equal to incoming argument values. They don't *alias*,
1976 // as we say, but that doesn't mean they aren't equal, so we take a
1977 // conservative approach.
1978 //
1979 // This is inspired in part by C++11 5.10p1:
1980 //   "Two pointers of the same type compare equal if and only if they are both
1981 //    null, both point to the same function, or both represent the same
1982 //    address."
1983 //
1984 // This is pretty permissive.
1985 //
1986 // It's also partly due to C11 6.5.9p6:
1987 //   "Two pointers compare equal if and only if both are null pointers, both are
1988 //    pointers to the same object (including a pointer to an object and a
1989 //    subobject at its beginning) or function, both are pointers to one past the
1990 //    last element of the same array object, or one is a pointer to one past the
1991 //    end of one array object and the other is a pointer to the start of a
1992 //    different array object that happens to immediately follow the first array
1993 //    object in the address space.)
1994 //
1995 // C11's version is more restrictive, however there's no reason why an argument
1996 // couldn't be a one-past-the-end value for a stack object in the caller and be
1997 // equal to the beginning of a stack object in the callee.
1998 //
1999 // If the C and C++ standards are ever made sufficiently restrictive in this
2000 // area, it may be possible to update LLVM's semantics accordingly and reinstate
2001 // this optimization.
2002 static Constant *
2003 computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2004                    const DominatorTree *DT, CmpInst::Predicate Pred,
2005                    const Instruction *CxtI, Value *LHS, Value *RHS) {
2006   // First, skip past any trivial no-ops.
2007   LHS = LHS->stripPointerCasts();
2008   RHS = RHS->stripPointerCasts();
2009 
2010   // A non-null pointer is not equal to a null pointer.
2011   if (llvm::isKnownNonNull(LHS) && isa<ConstantPointerNull>(RHS) &&
2012       (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2013     return ConstantInt::get(GetCompareTy(LHS),
2014                             !CmpInst::isTrueWhenEqual(Pred));
2015 
2016   // We can only fold certain predicates on pointer comparisons.
2017   switch (Pred) {
2018   default:
2019     return nullptr;
2020 
2021     // Equality comaprisons are easy to fold.
2022   case CmpInst::ICMP_EQ:
2023   case CmpInst::ICMP_NE:
2024     break;
2025 
2026     // We can only handle unsigned relational comparisons because 'inbounds' on
2027     // a GEP only protects against unsigned wrapping.
2028   case CmpInst::ICMP_UGT:
2029   case CmpInst::ICMP_UGE:
2030   case CmpInst::ICMP_ULT:
2031   case CmpInst::ICMP_ULE:
2032     // However, we have to switch them to their signed variants to handle
2033     // negative indices from the base pointer.
2034     Pred = ICmpInst::getSignedPredicate(Pred);
2035     break;
2036   }
2037 
2038   // Strip off any constant offsets so that we can reason about them.
2039   // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2040   // here and compare base addresses like AliasAnalysis does, however there are
2041   // numerous hazards. AliasAnalysis and its utilities rely on special rules
2042   // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2043   // doesn't need to guarantee pointer inequality when it says NoAlias.
2044   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2045   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
2046 
2047   // If LHS and RHS are related via constant offsets to the same base
2048   // value, we can replace it with an icmp which just compares the offsets.
2049   if (LHS == RHS)
2050     return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
2051 
2052   // Various optimizations for (in)equality comparisons.
2053   if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2054     // Different non-empty allocations that exist at the same time have
2055     // different addresses (if the program can tell). Global variables always
2056     // exist, so they always exist during the lifetime of each other and all
2057     // allocas. Two different allocas usually have different addresses...
2058     //
2059     // However, if there's an @llvm.stackrestore dynamically in between two
2060     // allocas, they may have the same address. It's tempting to reduce the
2061     // scope of the problem by only looking at *static* allocas here. That would
2062     // cover the majority of allocas while significantly reducing the likelihood
2063     // of having an @llvm.stackrestore pop up in the middle. However, it's not
2064     // actually impossible for an @llvm.stackrestore to pop up in the middle of
2065     // an entry block. Also, if we have a block that's not attached to a
2066     // function, we can't tell if it's "static" under the current definition.
2067     // Theoretically, this problem could be fixed by creating a new kind of
2068     // instruction kind specifically for static allocas. Such a new instruction
2069     // could be required to be at the top of the entry block, thus preventing it
2070     // from being subject to a @llvm.stackrestore. Instcombine could even
2071     // convert regular allocas into these special allocas. It'd be nifty.
2072     // However, until then, this problem remains open.
2073     //
2074     // So, we'll assume that two non-empty allocas have different addresses
2075     // for now.
2076     //
2077     // With all that, if the offsets are within the bounds of their allocations
2078     // (and not one-past-the-end! so we can't use inbounds!), and their
2079     // allocations aren't the same, the pointers are not equal.
2080     //
2081     // Note that it's not necessary to check for LHS being a global variable
2082     // address, due to canonicalization and constant folding.
2083     if (isa<AllocaInst>(LHS) &&
2084         (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
2085       ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2086       ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
2087       uint64_t LHSSize, RHSSize;
2088       if (LHSOffsetCI && RHSOffsetCI &&
2089           getObjectSize(LHS, LHSSize, DL, TLI) &&
2090           getObjectSize(RHS, RHSSize, DL, TLI)) {
2091         const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2092         const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
2093         if (!LHSOffsetValue.isNegative() &&
2094             !RHSOffsetValue.isNegative() &&
2095             LHSOffsetValue.ult(LHSSize) &&
2096             RHSOffsetValue.ult(RHSSize)) {
2097           return ConstantInt::get(GetCompareTy(LHS),
2098                                   !CmpInst::isTrueWhenEqual(Pred));
2099         }
2100       }
2101 
2102       // Repeat the above check but this time without depending on DataLayout
2103       // or being able to compute a precise size.
2104       if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2105           !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2106           LHSOffset->isNullValue() &&
2107           RHSOffset->isNullValue())
2108         return ConstantInt::get(GetCompareTy(LHS),
2109                                 !CmpInst::isTrueWhenEqual(Pred));
2110     }
2111 
2112     // Even if an non-inbounds GEP occurs along the path we can still optimize
2113     // equality comparisons concerning the result. We avoid walking the whole
2114     // chain again by starting where the last calls to
2115     // stripAndComputeConstantOffsets left off and accumulate the offsets.
2116     Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2117     Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
2118     if (LHS == RHS)
2119       return ConstantExpr::getICmp(Pred,
2120                                    ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2121                                    ConstantExpr::getAdd(RHSOffset, RHSNoBound));
2122 
2123     // If one side of the equality comparison must come from a noalias call
2124     // (meaning a system memory allocation function), and the other side must
2125     // come from a pointer that cannot overlap with dynamically-allocated
2126     // memory within the lifetime of the current function (allocas, byval
2127     // arguments, globals), then determine the comparison result here.
2128     SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2129     GetUnderlyingObjects(LHS, LHSUObjs, DL);
2130     GetUnderlyingObjects(RHS, RHSUObjs, DL);
2131 
2132     // Is the set of underlying objects all noalias calls?
2133     auto IsNAC = [](ArrayRef<Value *> Objects) {
2134       return all_of(Objects, isNoAliasCall);
2135     };
2136 
2137     // Is the set of underlying objects all things which must be disjoint from
2138     // noalias calls. For allocas, we consider only static ones (dynamic
2139     // allocas might be transformed into calls to malloc not simultaneously
2140     // live with the compared-to allocation). For globals, we exclude symbols
2141     // that might be resolve lazily to symbols in another dynamically-loaded
2142     // library (and, thus, could be malloc'ed by the implementation).
2143     auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2144       return all_of(Objects, [](Value *V) {
2145         if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2146           return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2147         if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2148           return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
2149                   GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
2150                  !GV->isThreadLocal();
2151         if (const Argument *A = dyn_cast<Argument>(V))
2152           return A->hasByValAttr();
2153         return false;
2154       });
2155     };
2156 
2157     if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2158         (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2159         return ConstantInt::get(GetCompareTy(LHS),
2160                                 !CmpInst::isTrueWhenEqual(Pred));
2161 
2162     // Fold comparisons for non-escaping pointer even if the allocation call
2163     // cannot be elided. We cannot fold malloc comparison to null. Also, the
2164     // dynamic allocation call could be either of the operands.
2165     Value *MI = nullptr;
2166     if (isAllocLikeFn(LHS, TLI) && llvm::isKnownNonNullAt(RHS, CxtI, DT))
2167       MI = LHS;
2168     else if (isAllocLikeFn(RHS, TLI) && llvm::isKnownNonNullAt(LHS, CxtI, DT))
2169       MI = RHS;
2170     // FIXME: We should also fold the compare when the pointer escapes, but the
2171     // compare dominates the pointer escape
2172     if (MI && !PointerMayBeCaptured(MI, true, true))
2173       return ConstantInt::get(GetCompareTy(LHS),
2174                               CmpInst::isFalseWhenEqual(Pred));
2175   }
2176 
2177   // Otherwise, fail.
2178   return nullptr;
2179 }
2180 
2181 /// Fold an icmp when its operands have i1 scalar type.
2182 static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
2183                                   Value *RHS, const SimplifyQuery &Q) {
2184   Type *ITy = GetCompareTy(LHS); // The return type.
2185   Type *OpTy = LHS->getType();   // The operand type.
2186   if (!OpTy->getScalarType()->isIntegerTy(1))
2187     return nullptr;
2188 
2189   switch (Pred) {
2190   default:
2191     break;
2192   case ICmpInst::ICMP_EQ:
2193     // X == 1 -> X
2194     if (match(RHS, m_One()))
2195       return LHS;
2196     break;
2197   case ICmpInst::ICMP_NE:
2198     // X != 0 -> X
2199     if (match(RHS, m_Zero()))
2200       return LHS;
2201     break;
2202   case ICmpInst::ICMP_UGT:
2203     // X >u 0 -> X
2204     if (match(RHS, m_Zero()))
2205       return LHS;
2206     break;
2207   case ICmpInst::ICMP_UGE:
2208     // X >=u 1 -> X
2209     if (match(RHS, m_One()))
2210       return LHS;
2211     if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2212       return getTrue(ITy);
2213     break;
2214   case ICmpInst::ICMP_SGE:
2215     /// For signed comparison, the values for an i1 are 0 and -1
2216     /// respectively. This maps into a truth table of:
2217     /// LHS | RHS | LHS >=s RHS   | LHS implies RHS
2218     ///  0  |  0  |  1 (0 >= 0)   |  1
2219     ///  0  |  1  |  1 (0 >= -1)  |  1
2220     ///  1  |  0  |  0 (-1 >= 0)  |  0
2221     ///  1  |  1  |  1 (-1 >= -1) |  1
2222     if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2223       return getTrue(ITy);
2224     break;
2225   case ICmpInst::ICMP_SLT:
2226     // X <s 0 -> X
2227     if (match(RHS, m_Zero()))
2228       return LHS;
2229     break;
2230   case ICmpInst::ICMP_SLE:
2231     // X <=s -1 -> X
2232     if (match(RHS, m_One()))
2233       return LHS;
2234     break;
2235   case ICmpInst::ICMP_ULE:
2236     if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2237       return getTrue(ITy);
2238     break;
2239   }
2240 
2241   return nullptr;
2242 }
2243 
2244 /// Try hard to fold icmp with zero RHS because this is a common case.
2245 static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
2246                                    Value *RHS, const SimplifyQuery &Q) {
2247   if (!match(RHS, m_Zero()))
2248     return nullptr;
2249 
2250   Type *ITy = GetCompareTy(LHS); // The return type.
2251   bool LHSKnownNonNegative, LHSKnownNegative;
2252   switch (Pred) {
2253   default:
2254     llvm_unreachable("Unknown ICmp predicate!");
2255   case ICmpInst::ICMP_ULT:
2256     return getFalse(ITy);
2257   case ICmpInst::ICMP_UGE:
2258     return getTrue(ITy);
2259   case ICmpInst::ICMP_EQ:
2260   case ICmpInst::ICMP_ULE:
2261     if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2262       return getFalse(ITy);
2263     break;
2264   case ICmpInst::ICMP_NE:
2265   case ICmpInst::ICMP_UGT:
2266     if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2267       return getTrue(ITy);
2268     break;
2269   case ICmpInst::ICMP_SLT:
2270     ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2271                    Q.CxtI, Q.DT);
2272     if (LHSKnownNegative)
2273       return getTrue(ITy);
2274     if (LHSKnownNonNegative)
2275       return getFalse(ITy);
2276     break;
2277   case ICmpInst::ICMP_SLE:
2278     ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2279                    Q.CxtI, Q.DT);
2280     if (LHSKnownNegative)
2281       return getTrue(ITy);
2282     if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2283       return getFalse(ITy);
2284     break;
2285   case ICmpInst::ICMP_SGE:
2286     ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2287                    Q.CxtI, Q.DT);
2288     if (LHSKnownNegative)
2289       return getFalse(ITy);
2290     if (LHSKnownNonNegative)
2291       return getTrue(ITy);
2292     break;
2293   case ICmpInst::ICMP_SGT:
2294     ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0, Q.AC,
2295                    Q.CxtI, Q.DT);
2296     if (LHSKnownNegative)
2297       return getFalse(ITy);
2298     if (LHSKnownNonNegative && isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2299       return getTrue(ITy);
2300     break;
2301   }
2302 
2303   return nullptr;
2304 }
2305 
2306 /// Many binary operators with a constant operand have an easy-to-compute
2307 /// range of outputs. This can be used to fold a comparison to always true or
2308 /// always false.
2309 static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2310   unsigned Width = Lower.getBitWidth();
2311   const APInt *C;
2312   switch (BO.getOpcode()) {
2313   case Instruction::Add:
2314     if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2315       // FIXME: If we have both nuw and nsw, we should reduce the range further.
2316       if (BO.hasNoUnsignedWrap()) {
2317         // 'add nuw x, C' produces [C, UINT_MAX].
2318         Lower = *C;
2319       } else if (BO.hasNoSignedWrap()) {
2320         if (C->isNegative()) {
2321           // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2322           Lower = APInt::getSignedMinValue(Width);
2323           Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2324         } else {
2325           // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2326           Lower = APInt::getSignedMinValue(Width) + *C;
2327           Upper = APInt::getSignedMaxValue(Width) + 1;
2328         }
2329       }
2330     }
2331     break;
2332 
2333   case Instruction::And:
2334     if (match(BO.getOperand(1), m_APInt(C)))
2335       // 'and x, C' produces [0, C].
2336       Upper = *C + 1;
2337     break;
2338 
2339   case Instruction::Or:
2340     if (match(BO.getOperand(1), m_APInt(C)))
2341       // 'or x, C' produces [C, UINT_MAX].
2342       Lower = *C;
2343     break;
2344 
2345   case Instruction::AShr:
2346     if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2347       // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2348       Lower = APInt::getSignedMinValue(Width).ashr(*C);
2349       Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2350     } else if (match(BO.getOperand(0), m_APInt(C))) {
2351       unsigned ShiftAmount = Width - 1;
2352       if (*C != 0 && BO.isExact())
2353         ShiftAmount = C->countTrailingZeros();
2354       if (C->isNegative()) {
2355         // 'ashr C, x' produces [C, C >> (Width-1)]
2356         Lower = *C;
2357         Upper = C->ashr(ShiftAmount) + 1;
2358       } else {
2359         // 'ashr C, x' produces [C >> (Width-1), C]
2360         Lower = C->ashr(ShiftAmount);
2361         Upper = *C + 1;
2362       }
2363     }
2364     break;
2365 
2366   case Instruction::LShr:
2367     if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2368       // 'lshr x, C' produces [0, UINT_MAX >> C].
2369       Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2370     } else if (match(BO.getOperand(0), m_APInt(C))) {
2371       // 'lshr C, x' produces [C >> (Width-1), C].
2372       unsigned ShiftAmount = Width - 1;
2373       if (*C != 0 && BO.isExact())
2374         ShiftAmount = C->countTrailingZeros();
2375       Lower = C->lshr(ShiftAmount);
2376       Upper = *C + 1;
2377     }
2378     break;
2379 
2380   case Instruction::Shl:
2381     if (match(BO.getOperand(0), m_APInt(C))) {
2382       if (BO.hasNoUnsignedWrap()) {
2383         // 'shl nuw C, x' produces [C, C << CLZ(C)]
2384         Lower = *C;
2385         Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2386       } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2387         if (C->isNegative()) {
2388           // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2389           unsigned ShiftAmount = C->countLeadingOnes() - 1;
2390           Lower = C->shl(ShiftAmount);
2391           Upper = *C + 1;
2392         } else {
2393           // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2394           unsigned ShiftAmount = C->countLeadingZeros() - 1;
2395           Lower = *C;
2396           Upper = C->shl(ShiftAmount) + 1;
2397         }
2398       }
2399     }
2400     break;
2401 
2402   case Instruction::SDiv:
2403     if (match(BO.getOperand(1), m_APInt(C))) {
2404       APInt IntMin = APInt::getSignedMinValue(Width);
2405       APInt IntMax = APInt::getSignedMaxValue(Width);
2406       if (C->isAllOnesValue()) {
2407         // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2408         //    where C != -1 and C != 0 and C != 1
2409         Lower = IntMin + 1;
2410         Upper = IntMax + 1;
2411       } else if (C->countLeadingZeros() < Width - 1) {
2412         // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2413         //    where C != -1 and C != 0 and C != 1
2414         Lower = IntMin.sdiv(*C);
2415         Upper = IntMax.sdiv(*C);
2416         if (Lower.sgt(Upper))
2417           std::swap(Lower, Upper);
2418         Upper = Upper + 1;
2419         assert(Upper != Lower && "Upper part of range has wrapped!");
2420       }
2421     } else if (match(BO.getOperand(0), m_APInt(C))) {
2422       if (C->isMinSignedValue()) {
2423         // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2424         Lower = *C;
2425         Upper = Lower.lshr(1) + 1;
2426       } else {
2427         // 'sdiv C, x' produces [-|C|, |C|].
2428         Upper = C->abs() + 1;
2429         Lower = (-Upper) + 1;
2430       }
2431     }
2432     break;
2433 
2434   case Instruction::UDiv:
2435     if (match(BO.getOperand(1), m_APInt(C)) && *C != 0) {
2436       // 'udiv x, C' produces [0, UINT_MAX / C].
2437       Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2438     } else if (match(BO.getOperand(0), m_APInt(C))) {
2439       // 'udiv C, x' produces [0, C].
2440       Upper = *C + 1;
2441     }
2442     break;
2443 
2444   case Instruction::SRem:
2445     if (match(BO.getOperand(1), m_APInt(C))) {
2446       // 'srem x, C' produces (-|C|, |C|).
2447       Upper = C->abs();
2448       Lower = (-Upper) + 1;
2449     }
2450     break;
2451 
2452   case Instruction::URem:
2453     if (match(BO.getOperand(1), m_APInt(C)))
2454       // 'urem x, C' produces [0, C).
2455       Upper = *C;
2456     break;
2457 
2458   default:
2459     break;
2460   }
2461 }
2462 
2463 static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2464                                        Value *RHS) {
2465   const APInt *C;
2466   if (!match(RHS, m_APInt(C)))
2467     return nullptr;
2468 
2469   // Rule out tautological comparisons (eg., ult 0 or uge 0).
2470   ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
2471   if (RHS_CR.isEmptySet())
2472     return ConstantInt::getFalse(GetCompareTy(RHS));
2473   if (RHS_CR.isFullSet())
2474     return ConstantInt::getTrue(GetCompareTy(RHS));
2475 
2476   // Find the range of possible values for binary operators.
2477   unsigned Width = C->getBitWidth();
2478   APInt Lower = APInt(Width, 0);
2479   APInt Upper = APInt(Width, 0);
2480   if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2481     setLimitsForBinOp(*BO, Lower, Upper);
2482 
2483   ConstantRange LHS_CR =
2484       Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2485 
2486   if (auto *I = dyn_cast<Instruction>(LHS))
2487     if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2488       LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2489 
2490   if (!LHS_CR.isFullSet()) {
2491     if (RHS_CR.contains(LHS_CR))
2492       return ConstantInt::getTrue(GetCompareTy(RHS));
2493     if (RHS_CR.inverse().contains(LHS_CR))
2494       return ConstantInt::getFalse(GetCompareTy(RHS));
2495   }
2496 
2497   return nullptr;
2498 }
2499 
2500 static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
2501                                     Value *RHS, const SimplifyQuery &Q,
2502                                     unsigned MaxRecurse) {
2503   Type *ITy = GetCompareTy(LHS); // The return type.
2504 
2505   BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2506   BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2507   if (MaxRecurse && (LBO || RBO)) {
2508     // Analyze the case when either LHS or RHS is an add instruction.
2509     Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2510     // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2511     bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2512     if (LBO && LBO->getOpcode() == Instruction::Add) {
2513       A = LBO->getOperand(0);
2514       B = LBO->getOperand(1);
2515       NoLHSWrapProblem =
2516           ICmpInst::isEquality(Pred) ||
2517           (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2518           (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2519     }
2520     if (RBO && RBO->getOpcode() == Instruction::Add) {
2521       C = RBO->getOperand(0);
2522       D = RBO->getOperand(1);
2523       NoRHSWrapProblem =
2524           ICmpInst::isEquality(Pred) ||
2525           (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2526           (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2527     }
2528 
2529     // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2530     if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2531       if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2532                                       Constant::getNullValue(RHS->getType()), Q,
2533                                       MaxRecurse - 1))
2534         return V;
2535 
2536     // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2537     if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2538       if (Value *V =
2539               SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2540                                C == LHS ? D : C, Q, MaxRecurse - 1))
2541         return V;
2542 
2543     // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2544     if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2545         NoRHSWrapProblem) {
2546       // Determine Y and Z in the form icmp (X+Y), (X+Z).
2547       Value *Y, *Z;
2548       if (A == C) {
2549         // C + B == C + D  ->  B == D
2550         Y = B;
2551         Z = D;
2552       } else if (A == D) {
2553         // D + B == C + D  ->  B == C
2554         Y = B;
2555         Z = C;
2556       } else if (B == C) {
2557         // A + C == C + D  ->  A == D
2558         Y = A;
2559         Z = D;
2560       } else {
2561         assert(B == D);
2562         // A + D == C + D  ->  A == C
2563         Y = A;
2564         Z = C;
2565       }
2566       if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2567         return V;
2568     }
2569   }
2570 
2571   {
2572     Value *Y = nullptr;
2573     // icmp pred (or X, Y), X
2574     if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2575       if (Pred == ICmpInst::ICMP_ULT)
2576         return getFalse(ITy);
2577       if (Pred == ICmpInst::ICMP_UGE)
2578         return getTrue(ITy);
2579 
2580       if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
2581         bool RHSKnownNonNegative, RHSKnownNegative;
2582         bool YKnownNonNegative, YKnownNegative;
2583         ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, Q.DL, 0,
2584                        Q.AC, Q.CxtI, Q.DT);
2585         ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
2586                        Q.CxtI, Q.DT);
2587         if (RHSKnownNonNegative && YKnownNegative)
2588           return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
2589         if (RHSKnownNegative || YKnownNonNegative)
2590           return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2591       }
2592     }
2593     // icmp pred X, (or X, Y)
2594     if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2595       if (Pred == ICmpInst::ICMP_ULE)
2596         return getTrue(ITy);
2597       if (Pred == ICmpInst::ICMP_UGT)
2598         return getFalse(ITy);
2599 
2600       if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
2601         bool LHSKnownNonNegative, LHSKnownNegative;
2602         bool YKnownNonNegative, YKnownNegative;
2603         ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, Q.DL, 0,
2604                        Q.AC, Q.CxtI, Q.DT);
2605         ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Q.DL, 0, Q.AC,
2606                        Q.CxtI, Q.DT);
2607         if (LHSKnownNonNegative && YKnownNegative)
2608           return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
2609         if (LHSKnownNegative || YKnownNonNegative)
2610           return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2611       }
2612     }
2613   }
2614 
2615   // icmp pred (and X, Y), X
2616   if (LBO && match(LBO, m_CombineOr(m_And(m_Value(), m_Specific(RHS)),
2617                                     m_And(m_Specific(RHS), m_Value())))) {
2618     if (Pred == ICmpInst::ICMP_UGT)
2619       return getFalse(ITy);
2620     if (Pred == ICmpInst::ICMP_ULE)
2621       return getTrue(ITy);
2622   }
2623   // icmp pred X, (and X, Y)
2624   if (RBO && match(RBO, m_CombineOr(m_And(m_Value(), m_Specific(LHS)),
2625                                     m_And(m_Specific(LHS), m_Value())))) {
2626     if (Pred == ICmpInst::ICMP_UGE)
2627       return getTrue(ITy);
2628     if (Pred == ICmpInst::ICMP_ULT)
2629       return getFalse(ITy);
2630   }
2631 
2632   // 0 - (zext X) pred C
2633   if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2634     if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2635       if (RHSC->getValue().isStrictlyPositive()) {
2636         if (Pred == ICmpInst::ICMP_SLT)
2637           return ConstantInt::getTrue(RHSC->getContext());
2638         if (Pred == ICmpInst::ICMP_SGE)
2639           return ConstantInt::getFalse(RHSC->getContext());
2640         if (Pred == ICmpInst::ICMP_EQ)
2641           return ConstantInt::getFalse(RHSC->getContext());
2642         if (Pred == ICmpInst::ICMP_NE)
2643           return ConstantInt::getTrue(RHSC->getContext());
2644       }
2645       if (RHSC->getValue().isNonNegative()) {
2646         if (Pred == ICmpInst::ICMP_SLE)
2647           return ConstantInt::getTrue(RHSC->getContext());
2648         if (Pred == ICmpInst::ICMP_SGT)
2649           return ConstantInt::getFalse(RHSC->getContext());
2650       }
2651     }
2652   }
2653 
2654   // icmp pred (urem X, Y), Y
2655   if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2656     bool KnownNonNegative, KnownNegative;
2657     switch (Pred) {
2658     default:
2659       break;
2660     case ICmpInst::ICMP_SGT:
2661     case ICmpInst::ICMP_SGE:
2662       ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2663                      Q.CxtI, Q.DT);
2664       if (!KnownNonNegative)
2665         break;
2666       LLVM_FALLTHROUGH;
2667     case ICmpInst::ICMP_EQ:
2668     case ICmpInst::ICMP_UGT:
2669     case ICmpInst::ICMP_UGE:
2670       return getFalse(ITy);
2671     case ICmpInst::ICMP_SLT:
2672     case ICmpInst::ICMP_SLE:
2673       ComputeSignBit(RHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2674                      Q.CxtI, Q.DT);
2675       if (!KnownNonNegative)
2676         break;
2677       LLVM_FALLTHROUGH;
2678     case ICmpInst::ICMP_NE:
2679     case ICmpInst::ICMP_ULT:
2680     case ICmpInst::ICMP_ULE:
2681       return getTrue(ITy);
2682     }
2683   }
2684 
2685   // icmp pred X, (urem Y, X)
2686   if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2687     bool KnownNonNegative, KnownNegative;
2688     switch (Pred) {
2689     default:
2690       break;
2691     case ICmpInst::ICMP_SGT:
2692     case ICmpInst::ICMP_SGE:
2693       ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2694                      Q.CxtI, Q.DT);
2695       if (!KnownNonNegative)
2696         break;
2697       LLVM_FALLTHROUGH;
2698     case ICmpInst::ICMP_NE:
2699     case ICmpInst::ICMP_UGT:
2700     case ICmpInst::ICMP_UGE:
2701       return getTrue(ITy);
2702     case ICmpInst::ICMP_SLT:
2703     case ICmpInst::ICMP_SLE:
2704       ComputeSignBit(LHS, KnownNonNegative, KnownNegative, Q.DL, 0, Q.AC,
2705                      Q.CxtI, Q.DT);
2706       if (!KnownNonNegative)
2707         break;
2708       LLVM_FALLTHROUGH;
2709     case ICmpInst::ICMP_EQ:
2710     case ICmpInst::ICMP_ULT:
2711     case ICmpInst::ICMP_ULE:
2712       return getFalse(ITy);
2713     }
2714   }
2715 
2716   // x >> y <=u x
2717   // x udiv y <=u x.
2718   if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2719               match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2720     // icmp pred (X op Y), X
2721     if (Pred == ICmpInst::ICMP_UGT)
2722       return getFalse(ITy);
2723     if (Pred == ICmpInst::ICMP_ULE)
2724       return getTrue(ITy);
2725   }
2726 
2727   // x >=u x >> y
2728   // x >=u x udiv y.
2729   if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2730               match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2731     // icmp pred X, (X op Y)
2732     if (Pred == ICmpInst::ICMP_ULT)
2733       return getFalse(ITy);
2734     if (Pred == ICmpInst::ICMP_UGE)
2735       return getTrue(ITy);
2736   }
2737 
2738   // handle:
2739   //   CI2 << X == CI
2740   //   CI2 << X != CI
2741   //
2742   //   where CI2 is a power of 2 and CI isn't
2743   if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2744     const APInt *CI2Val, *CIVal = &CI->getValue();
2745     if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2746         CI2Val->isPowerOf2()) {
2747       if (!CIVal->isPowerOf2()) {
2748         // CI2 << X can equal zero in some circumstances,
2749         // this simplification is unsafe if CI is zero.
2750         //
2751         // We know it is safe if:
2752         // - The shift is nsw, we can't shift out the one bit.
2753         // - The shift is nuw, we can't shift out the one bit.
2754         // - CI2 is one
2755         // - CI isn't zero
2756         if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2757             *CI2Val == 1 || !CI->isZero()) {
2758           if (Pred == ICmpInst::ICMP_EQ)
2759             return ConstantInt::getFalse(RHS->getContext());
2760           if (Pred == ICmpInst::ICMP_NE)
2761             return ConstantInt::getTrue(RHS->getContext());
2762         }
2763       }
2764       if (CIVal->isSignMask() && *CI2Val == 1) {
2765         if (Pred == ICmpInst::ICMP_UGT)
2766           return ConstantInt::getFalse(RHS->getContext());
2767         if (Pred == ICmpInst::ICMP_ULE)
2768           return ConstantInt::getTrue(RHS->getContext());
2769       }
2770     }
2771   }
2772 
2773   if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2774       LBO->getOperand(1) == RBO->getOperand(1)) {
2775     switch (LBO->getOpcode()) {
2776     default:
2777       break;
2778     case Instruction::UDiv:
2779     case Instruction::LShr:
2780       if (ICmpInst::isSigned(Pred))
2781         break;
2782       LLVM_FALLTHROUGH;
2783     case Instruction::SDiv:
2784     case Instruction::AShr:
2785       if (!LBO->isExact() || !RBO->isExact())
2786         break;
2787       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2788                                       RBO->getOperand(0), Q, MaxRecurse - 1))
2789         return V;
2790       break;
2791     case Instruction::Shl: {
2792       bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2793       bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2794       if (!NUW && !NSW)
2795         break;
2796       if (!NSW && ICmpInst::isSigned(Pred))
2797         break;
2798       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2799                                       RBO->getOperand(0), Q, MaxRecurse - 1))
2800         return V;
2801       break;
2802     }
2803     }
2804   }
2805   return nullptr;
2806 }
2807 
2808 /// Simplify integer comparisons where at least one operand of the compare
2809 /// matches an integer min/max idiom.
2810 static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
2811                                      Value *RHS, const SimplifyQuery &Q,
2812                                      unsigned MaxRecurse) {
2813   Type *ITy = GetCompareTy(LHS); // The return type.
2814   Value *A, *B;
2815   CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2816   CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2817 
2818   // Signed variants on "max(a,b)>=a -> true".
2819   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2820     if (A != RHS)
2821       std::swap(A, B);       // smax(A, B) pred A.
2822     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2823     // We analyze this as smax(A, B) pred A.
2824     P = Pred;
2825   } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2826              (A == LHS || B == LHS)) {
2827     if (A != LHS)
2828       std::swap(A, B);       // A pred smax(A, B).
2829     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2830     // We analyze this as smax(A, B) swapped-pred A.
2831     P = CmpInst::getSwappedPredicate(Pred);
2832   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2833              (A == RHS || B == RHS)) {
2834     if (A != RHS)
2835       std::swap(A, B);       // smin(A, B) pred A.
2836     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2837     // We analyze this as smax(-A, -B) swapped-pred -A.
2838     // Note that we do not need to actually form -A or -B thanks to EqP.
2839     P = CmpInst::getSwappedPredicate(Pred);
2840   } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2841              (A == LHS || B == LHS)) {
2842     if (A != LHS)
2843       std::swap(A, B);       // A pred smin(A, B).
2844     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2845     // We analyze this as smax(-A, -B) pred -A.
2846     // Note that we do not need to actually form -A or -B thanks to EqP.
2847     P = Pred;
2848   }
2849   if (P != CmpInst::BAD_ICMP_PREDICATE) {
2850     // Cases correspond to "max(A, B) p A".
2851     switch (P) {
2852     default:
2853       break;
2854     case CmpInst::ICMP_EQ:
2855     case CmpInst::ICMP_SLE:
2856       // Equivalent to "A EqP B".  This may be the same as the condition tested
2857       // in the max/min; if so, we can just return that.
2858       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2859         return V;
2860       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2861         return V;
2862       // Otherwise, see if "A EqP B" simplifies.
2863       if (MaxRecurse)
2864         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2865           return V;
2866       break;
2867     case CmpInst::ICMP_NE:
2868     case CmpInst::ICMP_SGT: {
2869       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2870       // Equivalent to "A InvEqP B".  This may be the same as the condition
2871       // tested in the max/min; if so, we can just return that.
2872       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2873         return V;
2874       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2875         return V;
2876       // Otherwise, see if "A InvEqP B" simplifies.
2877       if (MaxRecurse)
2878         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2879           return V;
2880       break;
2881     }
2882     case CmpInst::ICMP_SGE:
2883       // Always true.
2884       return getTrue(ITy);
2885     case CmpInst::ICMP_SLT:
2886       // Always false.
2887       return getFalse(ITy);
2888     }
2889   }
2890 
2891   // Unsigned variants on "max(a,b)>=a -> true".
2892   P = CmpInst::BAD_ICMP_PREDICATE;
2893   if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2894     if (A != RHS)
2895       std::swap(A, B);       // umax(A, B) pred A.
2896     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2897     // We analyze this as umax(A, B) pred A.
2898     P = Pred;
2899   } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
2900              (A == LHS || B == LHS)) {
2901     if (A != LHS)
2902       std::swap(A, B);       // A pred umax(A, B).
2903     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
2904     // We analyze this as umax(A, B) swapped-pred A.
2905     P = CmpInst::getSwappedPredicate(Pred);
2906   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2907              (A == RHS || B == RHS)) {
2908     if (A != RHS)
2909       std::swap(A, B);       // umin(A, B) pred A.
2910     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2911     // We analyze this as umax(-A, -B) swapped-pred -A.
2912     // Note that we do not need to actually form -A or -B thanks to EqP.
2913     P = CmpInst::getSwappedPredicate(Pred);
2914   } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
2915              (A == LHS || B == LHS)) {
2916     if (A != LHS)
2917       std::swap(A, B);       // A pred umin(A, B).
2918     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
2919     // We analyze this as umax(-A, -B) pred -A.
2920     // Note that we do not need to actually form -A or -B thanks to EqP.
2921     P = Pred;
2922   }
2923   if (P != CmpInst::BAD_ICMP_PREDICATE) {
2924     // Cases correspond to "max(A, B) p A".
2925     switch (P) {
2926     default:
2927       break;
2928     case CmpInst::ICMP_EQ:
2929     case CmpInst::ICMP_ULE:
2930       // Equivalent to "A EqP B".  This may be the same as the condition tested
2931       // in the max/min; if so, we can just return that.
2932       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2933         return V;
2934       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2935         return V;
2936       // Otherwise, see if "A EqP B" simplifies.
2937       if (MaxRecurse)
2938         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2939           return V;
2940       break;
2941     case CmpInst::ICMP_NE:
2942     case CmpInst::ICMP_UGT: {
2943       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2944       // Equivalent to "A InvEqP B".  This may be the same as the condition
2945       // tested in the max/min; if so, we can just return that.
2946       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2947         return V;
2948       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2949         return V;
2950       // Otherwise, see if "A InvEqP B" simplifies.
2951       if (MaxRecurse)
2952         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2953           return V;
2954       break;
2955     }
2956     case CmpInst::ICMP_UGE:
2957       // Always true.
2958       return getTrue(ITy);
2959     case CmpInst::ICMP_ULT:
2960       // Always false.
2961       return getFalse(ITy);
2962     }
2963   }
2964 
2965   // Variants on "max(x,y) >= min(x,z)".
2966   Value *C, *D;
2967   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
2968       match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
2969       (A == C || A == D || B == C || B == D)) {
2970     // max(x, ?) pred min(x, ?).
2971     if (Pred == CmpInst::ICMP_SGE)
2972       // Always true.
2973       return getTrue(ITy);
2974     if (Pred == CmpInst::ICMP_SLT)
2975       // Always false.
2976       return getFalse(ITy);
2977   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2978              match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
2979              (A == C || A == D || B == C || B == D)) {
2980     // min(x, ?) pred max(x, ?).
2981     if (Pred == CmpInst::ICMP_SLE)
2982       // Always true.
2983       return getTrue(ITy);
2984     if (Pred == CmpInst::ICMP_SGT)
2985       // Always false.
2986       return getFalse(ITy);
2987   } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
2988              match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
2989              (A == C || A == D || B == C || B == D)) {
2990     // max(x, ?) pred min(x, ?).
2991     if (Pred == CmpInst::ICMP_UGE)
2992       // Always true.
2993       return getTrue(ITy);
2994     if (Pred == CmpInst::ICMP_ULT)
2995       // Always false.
2996       return getFalse(ITy);
2997   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
2998              match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
2999              (A == C || A == D || B == C || B == D)) {
3000     // min(x, ?) pred max(x, ?).
3001     if (Pred == CmpInst::ICMP_ULE)
3002       // Always true.
3003       return getTrue(ITy);
3004     if (Pred == CmpInst::ICMP_UGT)
3005       // Always false.
3006       return getFalse(ITy);
3007   }
3008 
3009   return nullptr;
3010 }
3011 
3012 /// Given operands for an ICmpInst, see if we can fold the result.
3013 /// If not, this returns null.
3014 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3015                                const SimplifyQuery &Q, unsigned MaxRecurse) {
3016   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3017   assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
3018 
3019   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
3020     if (Constant *CRHS = dyn_cast<Constant>(RHS))
3021       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
3022 
3023     // If we have a constant, make sure it is on the RHS.
3024     std::swap(LHS, RHS);
3025     Pred = CmpInst::getSwappedPredicate(Pred);
3026   }
3027 
3028   Type *ITy = GetCompareTy(LHS); // The return type.
3029 
3030   // icmp X, X -> true/false
3031   // X icmp undef -> true/false.  For example, icmp ugt %X, undef -> false
3032   // because X could be 0.
3033   if (LHS == RHS || isa<UndefValue>(RHS))
3034     return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
3035 
3036   if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3037     return V;
3038 
3039   if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3040     return V;
3041 
3042   if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3043     return V;
3044 
3045   // If both operands have range metadata, use the metadata
3046   // to simplify the comparison.
3047   if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
3048     auto RHS_Instr = cast<Instruction>(RHS);
3049     auto LHS_Instr = cast<Instruction>(LHS);
3050 
3051     if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3052         LHS_Instr->getMetadata(LLVMContext::MD_range)) {
3053       auto RHS_CR = getConstantRangeFromMetadata(
3054           *RHS_Instr->getMetadata(LLVMContext::MD_range));
3055       auto LHS_CR = getConstantRangeFromMetadata(
3056           *LHS_Instr->getMetadata(LLVMContext::MD_range));
3057 
3058       auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3059       if (Satisfied_CR.contains(LHS_CR))
3060         return ConstantInt::getTrue(RHS->getContext());
3061 
3062       auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3063                 CmpInst::getInversePredicate(Pred), RHS_CR);
3064       if (InversedSatisfied_CR.contains(LHS_CR))
3065         return ConstantInt::getFalse(RHS->getContext());
3066     }
3067   }
3068 
3069   // Compare of cast, for example (zext X) != 0 -> X != 0
3070   if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3071     Instruction *LI = cast<CastInst>(LHS);
3072     Value *SrcOp = LI->getOperand(0);
3073     Type *SrcTy = SrcOp->getType();
3074     Type *DstTy = LI->getType();
3075 
3076     // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3077     // if the integer type is the same size as the pointer type.
3078     if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3079         Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
3080       if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3081         // Transfer the cast to the constant.
3082         if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3083                                         ConstantExpr::getIntToPtr(RHSC, SrcTy),
3084                                         Q, MaxRecurse-1))
3085           return V;
3086       } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3087         if (RI->getOperand(0)->getType() == SrcTy)
3088           // Compare without the cast.
3089           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
3090                                           Q, MaxRecurse-1))
3091             return V;
3092       }
3093     }
3094 
3095     if (isa<ZExtInst>(LHS)) {
3096       // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3097       // same type.
3098       if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3099         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3100           // Compare X and Y.  Note that signed predicates become unsigned.
3101           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
3102                                           SrcOp, RI->getOperand(0), Q,
3103                                           MaxRecurse-1))
3104             return V;
3105       }
3106       // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3107       // too.  If not, then try to deduce the result of the comparison.
3108       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3109         // Compute the constant that would happen if we truncated to SrcTy then
3110         // reextended to DstTy.
3111         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3112         Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3113 
3114         // If the re-extended constant didn't change then this is effectively
3115         // also a case of comparing two zero-extended values.
3116         if (RExt == CI && MaxRecurse)
3117           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
3118                                         SrcOp, Trunc, Q, MaxRecurse-1))
3119             return V;
3120 
3121         // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3122         // there.  Use this to work out the result of the comparison.
3123         if (RExt != CI) {
3124           switch (Pred) {
3125           default: llvm_unreachable("Unknown ICmp predicate!");
3126           // LHS <u RHS.
3127           case ICmpInst::ICMP_EQ:
3128           case ICmpInst::ICMP_UGT:
3129           case ICmpInst::ICMP_UGE:
3130             return ConstantInt::getFalse(CI->getContext());
3131 
3132           case ICmpInst::ICMP_NE:
3133           case ICmpInst::ICMP_ULT:
3134           case ICmpInst::ICMP_ULE:
3135             return ConstantInt::getTrue(CI->getContext());
3136 
3137           // LHS is non-negative.  If RHS is negative then LHS >s LHS.  If RHS
3138           // is non-negative then LHS <s RHS.
3139           case ICmpInst::ICMP_SGT:
3140           case ICmpInst::ICMP_SGE:
3141             return CI->getValue().isNegative() ?
3142               ConstantInt::getTrue(CI->getContext()) :
3143               ConstantInt::getFalse(CI->getContext());
3144 
3145           case ICmpInst::ICMP_SLT:
3146           case ICmpInst::ICMP_SLE:
3147             return CI->getValue().isNegative() ?
3148               ConstantInt::getFalse(CI->getContext()) :
3149               ConstantInt::getTrue(CI->getContext());
3150           }
3151         }
3152       }
3153     }
3154 
3155     if (isa<SExtInst>(LHS)) {
3156       // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3157       // same type.
3158       if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3159         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3160           // Compare X and Y.  Note that the predicate does not change.
3161           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
3162                                           Q, MaxRecurse-1))
3163             return V;
3164       }
3165       // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3166       // too.  If not, then try to deduce the result of the comparison.
3167       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3168         // Compute the constant that would happen if we truncated to SrcTy then
3169         // reextended to DstTy.
3170         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3171         Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3172 
3173         // If the re-extended constant didn't change then this is effectively
3174         // also a case of comparing two sign-extended values.
3175         if (RExt == CI && MaxRecurse)
3176           if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
3177             return V;
3178 
3179         // Otherwise the upper bits of LHS are all equal, while RHS has varying
3180         // bits there.  Use this to work out the result of the comparison.
3181         if (RExt != CI) {
3182           switch (Pred) {
3183           default: llvm_unreachable("Unknown ICmp predicate!");
3184           case ICmpInst::ICMP_EQ:
3185             return ConstantInt::getFalse(CI->getContext());
3186           case ICmpInst::ICMP_NE:
3187             return ConstantInt::getTrue(CI->getContext());
3188 
3189           // If RHS is non-negative then LHS <s RHS.  If RHS is negative then
3190           // LHS >s RHS.
3191           case ICmpInst::ICMP_SGT:
3192           case ICmpInst::ICMP_SGE:
3193             return CI->getValue().isNegative() ?
3194               ConstantInt::getTrue(CI->getContext()) :
3195               ConstantInt::getFalse(CI->getContext());
3196           case ICmpInst::ICMP_SLT:
3197           case ICmpInst::ICMP_SLE:
3198             return CI->getValue().isNegative() ?
3199               ConstantInt::getFalse(CI->getContext()) :
3200               ConstantInt::getTrue(CI->getContext());
3201 
3202           // If LHS is non-negative then LHS <u RHS.  If LHS is negative then
3203           // LHS >u RHS.
3204           case ICmpInst::ICMP_UGT:
3205           case ICmpInst::ICMP_UGE:
3206             // Comparison is true iff the LHS <s 0.
3207             if (MaxRecurse)
3208               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3209                                               Constant::getNullValue(SrcTy),
3210                                               Q, MaxRecurse-1))
3211                 return V;
3212             break;
3213           case ICmpInst::ICMP_ULT:
3214           case ICmpInst::ICMP_ULE:
3215             // Comparison is true iff the LHS >=s 0.
3216             if (MaxRecurse)
3217               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3218                                               Constant::getNullValue(SrcTy),
3219                                               Q, MaxRecurse-1))
3220                 return V;
3221             break;
3222           }
3223         }
3224       }
3225     }
3226   }
3227 
3228   // icmp eq|ne X, Y -> false|true if X != Y
3229   if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
3230       isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
3231     LLVMContext &Ctx = LHS->getType()->getContext();
3232     return Pred == ICmpInst::ICMP_NE ?
3233       ConstantInt::getTrue(Ctx) : ConstantInt::getFalse(Ctx);
3234   }
3235 
3236   if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3237     return V;
3238 
3239   if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
3240     return V;
3241 
3242   // Simplify comparisons of related pointers using a powerful, recursive
3243   // GEP-walk when we have target data available..
3244   if (LHS->getType()->isPointerTy())
3245     if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI, LHS, RHS))
3246       return C;
3247   if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3248     if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3249       if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3250               Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3251           Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3252               Q.DL.getTypeSizeInBits(CRHS->getType()))
3253         if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.CxtI,
3254                                          CLHS->getPointerOperand(),
3255                                          CRHS->getPointerOperand()))
3256           return C;
3257 
3258   if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3259     if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3260       if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3261           GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3262           (ICmpInst::isEquality(Pred) ||
3263            (GLHS->isInBounds() && GRHS->isInBounds() &&
3264             Pred == ICmpInst::getSignedPredicate(Pred)))) {
3265         // The bases are equal and the indices are constant.  Build a constant
3266         // expression GEP with the same indices and a null base pointer to see
3267         // what constant folding can make out of it.
3268         Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3269         SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
3270         Constant *NewLHS = ConstantExpr::getGetElementPtr(
3271             GLHS->getSourceElementType(), Null, IndicesLHS);
3272 
3273         SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
3274         Constant *NewRHS = ConstantExpr::getGetElementPtr(
3275             GLHS->getSourceElementType(), Null, IndicesRHS);
3276         return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3277       }
3278     }
3279   }
3280 
3281   // If a bit is known to be zero for A and known to be one for B,
3282   // then A and B cannot be equal.
3283   if (ICmpInst::isEquality(Pred)) {
3284     const APInt *RHSVal;
3285     if (match(RHS, m_APInt(RHSVal))) {
3286       unsigned BitWidth = RHSVal->getBitWidth();
3287       KnownBits LHSKnown(BitWidth);
3288       computeKnownBits(LHS, LHSKnown, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
3289       if (LHSKnown.Zero.intersects(*RHSVal) ||
3290           !LHSKnown.One.isSubsetOf(*RHSVal))
3291         return Pred == ICmpInst::ICMP_EQ ? ConstantInt::getFalse(ITy)
3292                                          : ConstantInt::getTrue(ITy);
3293     }
3294   }
3295 
3296   // If the comparison is with the result of a select instruction, check whether
3297   // comparing with either branch of the select always yields the same value.
3298   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3299     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3300       return V;
3301 
3302   // If the comparison is with the result of a phi instruction, check whether
3303   // doing the compare with each incoming phi value yields a common result.
3304   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3305     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3306       return V;
3307 
3308   return nullptr;
3309 }
3310 
3311 Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3312                               const SimplifyQuery &Q) {
3313   return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3314 }
3315 
3316 /// Given operands for an FCmpInst, see if we can fold the result.
3317 /// If not, this returns null.
3318 static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3319                                FastMathFlags FMF, const SimplifyQuery &Q,
3320                                unsigned MaxRecurse) {
3321   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3322   assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3323 
3324   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
3325     if (Constant *CRHS = dyn_cast<Constant>(RHS))
3326       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
3327 
3328     // If we have a constant, make sure it is on the RHS.
3329     std::swap(LHS, RHS);
3330     Pred = CmpInst::getSwappedPredicate(Pred);
3331   }
3332 
3333   // Fold trivial predicates.
3334   Type *RetTy = GetCompareTy(LHS);
3335   if (Pred == FCmpInst::FCMP_FALSE)
3336     return getFalse(RetTy);
3337   if (Pred == FCmpInst::FCMP_TRUE)
3338     return getTrue(RetTy);
3339 
3340   // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3341   if (FMF.noNaNs()) {
3342     if (Pred == FCmpInst::FCMP_UNO)
3343       return getFalse(RetTy);
3344     if (Pred == FCmpInst::FCMP_ORD)
3345       return getTrue(RetTy);
3346   }
3347 
3348   // fcmp pred x, undef  and  fcmp pred undef, x
3349   // fold to true if unordered, false if ordered
3350   if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3351     // Choosing NaN for the undef will always make unordered comparison succeed
3352     // and ordered comparison fail.
3353     return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3354   }
3355 
3356   // fcmp x,x -> true/false.  Not all compares are foldable.
3357   if (LHS == RHS) {
3358     if (CmpInst::isTrueWhenEqual(Pred))
3359       return getTrue(RetTy);
3360     if (CmpInst::isFalseWhenEqual(Pred))
3361       return getFalse(RetTy);
3362   }
3363 
3364   // Handle fcmp with constant RHS
3365   const ConstantFP *CFP = nullptr;
3366   if (const auto *RHSC = dyn_cast<Constant>(RHS)) {
3367     if (RHS->getType()->isVectorTy())
3368       CFP = dyn_cast_or_null<ConstantFP>(RHSC->getSplatValue());
3369     else
3370       CFP = dyn_cast<ConstantFP>(RHSC);
3371   }
3372   if (CFP) {
3373     // If the constant is a nan, see if we can fold the comparison based on it.
3374     if (CFP->getValueAPF().isNaN()) {
3375       if (FCmpInst::isOrdered(Pred)) // True "if ordered and foo"
3376         return getFalse(RetTy);
3377       assert(FCmpInst::isUnordered(Pred) &&
3378              "Comparison must be either ordered or unordered!");
3379       // True if unordered.
3380       return getTrue(RetTy);
3381     }
3382     // Check whether the constant is an infinity.
3383     if (CFP->getValueAPF().isInfinity()) {
3384       if (CFP->getValueAPF().isNegative()) {
3385         switch (Pred) {
3386         case FCmpInst::FCMP_OLT:
3387           // No value is ordered and less than negative infinity.
3388           return getFalse(RetTy);
3389         case FCmpInst::FCMP_UGE:
3390           // All values are unordered with or at least negative infinity.
3391           return getTrue(RetTy);
3392         default:
3393           break;
3394         }
3395       } else {
3396         switch (Pred) {
3397         case FCmpInst::FCMP_OGT:
3398           // No value is ordered and greater than infinity.
3399           return getFalse(RetTy);
3400         case FCmpInst::FCMP_ULE:
3401           // All values are unordered with and at most infinity.
3402           return getTrue(RetTy);
3403         default:
3404           break;
3405         }
3406       }
3407     }
3408     if (CFP->getValueAPF().isZero()) {
3409       switch (Pred) {
3410       case FCmpInst::FCMP_UGE:
3411         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3412           return getTrue(RetTy);
3413         break;
3414       case FCmpInst::FCMP_OLT:
3415         // X < 0
3416         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3417           return getFalse(RetTy);
3418         break;
3419       default:
3420         break;
3421       }
3422     }
3423   }
3424 
3425   // If the comparison is with the result of a select instruction, check whether
3426   // comparing with either branch of the select always yields the same value.
3427   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3428     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3429       return V;
3430 
3431   // If the comparison is with the result of a phi instruction, check whether
3432   // doing the compare with each incoming phi value yields a common result.
3433   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3434     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3435       return V;
3436 
3437   return nullptr;
3438 }
3439 
3440 Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3441                               FastMathFlags FMF, const SimplifyQuery &Q) {
3442   return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
3443 }
3444 
3445 /// See if V simplifies when its operand Op is replaced with RepOp.
3446 static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
3447                                            const SimplifyQuery &Q,
3448                                            unsigned MaxRecurse) {
3449   // Trivial replacement.
3450   if (V == Op)
3451     return RepOp;
3452 
3453   auto *I = dyn_cast<Instruction>(V);
3454   if (!I)
3455     return nullptr;
3456 
3457   // If this is a binary operator, try to simplify it with the replaced op.
3458   if (auto *B = dyn_cast<BinaryOperator>(I)) {
3459     // Consider:
3460     //   %cmp = icmp eq i32 %x, 2147483647
3461     //   %add = add nsw i32 %x, 1
3462     //   %sel = select i1 %cmp, i32 -2147483648, i32 %add
3463     //
3464     // We can't replace %sel with %add unless we strip away the flags.
3465     if (isa<OverflowingBinaryOperator>(B))
3466       if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3467         return nullptr;
3468     if (isa<PossiblyExactOperator>(B))
3469       if (B->isExact())
3470         return nullptr;
3471 
3472     if (MaxRecurse) {
3473       if (B->getOperand(0) == Op)
3474         return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3475                              MaxRecurse - 1);
3476       if (B->getOperand(1) == Op)
3477         return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3478                              MaxRecurse - 1);
3479     }
3480   }
3481 
3482   // Same for CmpInsts.
3483   if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3484     if (MaxRecurse) {
3485       if (C->getOperand(0) == Op)
3486         return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3487                                MaxRecurse - 1);
3488       if (C->getOperand(1) == Op)
3489         return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3490                                MaxRecurse - 1);
3491     }
3492   }
3493 
3494   // TODO: We could hand off more cases to instsimplify here.
3495 
3496   // If all operands are constant after substituting Op for RepOp then we can
3497   // constant fold the instruction.
3498   if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3499     // Build a list of all constant operands.
3500     SmallVector<Constant *, 8> ConstOps;
3501     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3502       if (I->getOperand(i) == Op)
3503         ConstOps.push_back(CRepOp);
3504       else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3505         ConstOps.push_back(COp);
3506       else
3507         break;
3508     }
3509 
3510     // All operands were constants, fold it.
3511     if (ConstOps.size() == I->getNumOperands()) {
3512       if (CmpInst *C = dyn_cast<CmpInst>(I))
3513         return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3514                                                ConstOps[1], Q.DL, Q.TLI);
3515 
3516       if (LoadInst *LI = dyn_cast<LoadInst>(I))
3517         if (!LI->isVolatile())
3518           return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
3519 
3520       return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
3521     }
3522   }
3523 
3524   return nullptr;
3525 }
3526 
3527 /// Try to simplify a select instruction when its condition operand is an
3528 /// integer comparison where one operand of the compare is a constant.
3529 static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3530                                     const APInt *Y, bool TrueWhenUnset) {
3531   const APInt *C;
3532 
3533   // (X & Y) == 0 ? X & ~Y : X  --> X
3534   // (X & Y) != 0 ? X & ~Y : X  --> X & ~Y
3535   if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3536       *Y == ~*C)
3537     return TrueWhenUnset ? FalseVal : TrueVal;
3538 
3539   // (X & Y) == 0 ? X : X & ~Y  --> X & ~Y
3540   // (X & Y) != 0 ? X : X & ~Y  --> X
3541   if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3542       *Y == ~*C)
3543     return TrueWhenUnset ? FalseVal : TrueVal;
3544 
3545   if (Y->isPowerOf2()) {
3546     // (X & Y) == 0 ? X | Y : X  --> X | Y
3547     // (X & Y) != 0 ? X | Y : X  --> X
3548     if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3549         *Y == *C)
3550       return TrueWhenUnset ? TrueVal : FalseVal;
3551 
3552     // (X & Y) == 0 ? X : X | Y  --> X
3553     // (X & Y) != 0 ? X : X | Y  --> X | Y
3554     if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3555         *Y == *C)
3556       return TrueWhenUnset ? TrueVal : FalseVal;
3557   }
3558 
3559   return nullptr;
3560 }
3561 
3562 /// An alternative way to test if a bit is set or not uses sgt/slt instead of
3563 /// eq/ne.
3564 static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *TrueVal,
3565                                            Value *FalseVal,
3566                                            bool TrueWhenUnset) {
3567   unsigned BitWidth = TrueVal->getType()->getScalarSizeInBits();
3568   if (!BitWidth)
3569     return nullptr;
3570 
3571   APInt MinSignedValue;
3572   Value *X;
3573   if (match(CmpLHS, m_Trunc(m_Value(X))) && (X == TrueVal || X == FalseVal)) {
3574     // icmp slt (trunc X), 0  <--> icmp ne (and X, C), 0
3575     // icmp sgt (trunc X), -1 <--> icmp eq (and X, C), 0
3576     unsigned DestSize = CmpLHS->getType()->getScalarSizeInBits();
3577     MinSignedValue = APInt::getSignedMinValue(DestSize).zext(BitWidth);
3578   } else {
3579     // icmp slt X, 0  <--> icmp ne (and X, C), 0
3580     // icmp sgt X, -1 <--> icmp eq (and X, C), 0
3581     X = CmpLHS;
3582     MinSignedValue = APInt::getSignedMinValue(BitWidth);
3583   }
3584 
3585   if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, &MinSignedValue,
3586                                        TrueWhenUnset))
3587     return V;
3588 
3589   return nullptr;
3590 }
3591 
3592 /// Try to simplify a select instruction when its condition operand is an
3593 /// integer comparison.
3594 static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
3595                                          Value *FalseVal, const SimplifyQuery &Q,
3596                                          unsigned MaxRecurse) {
3597   ICmpInst::Predicate Pred;
3598   Value *CmpLHS, *CmpRHS;
3599   if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3600     return nullptr;
3601 
3602   // FIXME: This code is nearly duplicated in InstCombine. Using/refactoring
3603   // decomposeBitTestICmp() might help.
3604   if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3605     Value *X;
3606     const APInt *Y;
3607     if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3608       if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3609                                            Pred == ICmpInst::ICMP_EQ))
3610         return V;
3611   } else if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, m_Zero())) {
3612     // Comparing signed-less-than 0 checks if the sign bit is set.
3613     if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3614                                                 false))
3615       return V;
3616   } else if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, m_AllOnes())) {
3617     // Comparing signed-greater-than -1 checks if the sign bit is not set.
3618     if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, TrueVal, FalseVal,
3619                                                 true))
3620       return V;
3621   }
3622 
3623   if (CondVal->hasOneUse()) {
3624     const APInt *C;
3625     if (match(CmpRHS, m_APInt(C))) {
3626       // X < MIN ? T : F  -->  F
3627       if (Pred == ICmpInst::ICMP_SLT && C->isMinSignedValue())
3628         return FalseVal;
3629       // X < MIN ? T : F  -->  F
3630       if (Pred == ICmpInst::ICMP_ULT && C->isMinValue())
3631         return FalseVal;
3632       // X > MAX ? T : F  -->  F
3633       if (Pred == ICmpInst::ICMP_SGT && C->isMaxSignedValue())
3634         return FalseVal;
3635       // X > MAX ? T : F  -->  F
3636       if (Pred == ICmpInst::ICMP_UGT && C->isMaxValue())
3637         return FalseVal;
3638     }
3639   }
3640 
3641   // If we have an equality comparison, then we know the value in one of the
3642   // arms of the select. See if substituting this value into the arm and
3643   // simplifying the result yields the same value as the other arm.
3644   if (Pred == ICmpInst::ICMP_EQ) {
3645     if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3646             TrueVal ||
3647         SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3648             TrueVal)
3649       return FalseVal;
3650     if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3651             FalseVal ||
3652         SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3653             FalseVal)
3654       return FalseVal;
3655   } else if (Pred == ICmpInst::ICMP_NE) {
3656     if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3657             FalseVal ||
3658         SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3659             FalseVal)
3660       return TrueVal;
3661     if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3662             TrueVal ||
3663         SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3664             TrueVal)
3665       return TrueVal;
3666   }
3667 
3668   return nullptr;
3669 }
3670 
3671 /// Given operands for a SelectInst, see if we can fold the result.
3672 /// If not, this returns null.
3673 static Value *SimplifySelectInst(Value *CondVal, Value *TrueVal,
3674                                  Value *FalseVal, const SimplifyQuery &Q,
3675                                  unsigned MaxRecurse) {
3676   // select true, X, Y  -> X
3677   // select false, X, Y -> Y
3678   if (Constant *CB = dyn_cast<Constant>(CondVal)) {
3679     if (CB->isAllOnesValue())
3680       return TrueVal;
3681     if (CB->isNullValue())
3682       return FalseVal;
3683   }
3684 
3685   // select C, X, X -> X
3686   if (TrueVal == FalseVal)
3687     return TrueVal;
3688 
3689   if (isa<UndefValue>(CondVal)) {  // select undef, X, Y -> X or Y
3690     if (isa<Constant>(FalseVal))
3691       return FalseVal;
3692     return TrueVal;
3693   }
3694   if (isa<UndefValue>(TrueVal))   // select C, undef, X -> X
3695     return FalseVal;
3696   if (isa<UndefValue>(FalseVal))   // select C, X, undef -> X
3697     return TrueVal;
3698 
3699   if (Value *V =
3700           simplifySelectWithICmpCond(CondVal, TrueVal, FalseVal, Q, MaxRecurse))
3701     return V;
3702 
3703   return nullptr;
3704 }
3705 
3706 Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3707                                 const SimplifyQuery &Q) {
3708   return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
3709 }
3710 
3711 /// Given operands for an GetElementPtrInst, see if we can fold the result.
3712 /// If not, this returns null.
3713 static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3714                               const SimplifyQuery &Q, unsigned) {
3715   // The type of the GEP pointer operand.
3716   unsigned AS =
3717       cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
3718 
3719   // getelementptr P -> P.
3720   if (Ops.size() == 1)
3721     return Ops[0];
3722 
3723   // Compute the (pointer) type returned by the GEP instruction.
3724   Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
3725   Type *GEPTy = PointerType::get(LastType, AS);
3726   if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3727     GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3728   else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3729     GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3730 
3731   if (isa<UndefValue>(Ops[0]))
3732     return UndefValue::get(GEPTy);
3733 
3734   if (Ops.size() == 2) {
3735     // getelementptr P, 0 -> P.
3736     if (match(Ops[1], m_Zero()))
3737       return Ops[0];
3738 
3739     Type *Ty = SrcTy;
3740     if (Ty->isSized()) {
3741       Value *P;
3742       uint64_t C;
3743       uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
3744       // getelementptr P, N -> P if P points to a type of zero size.
3745       if (TyAllocSize == 0)
3746         return Ops[0];
3747 
3748       // The following transforms are only safe if the ptrtoint cast
3749       // doesn't truncate the pointers.
3750       if (Ops[1]->getType()->getScalarSizeInBits() ==
3751           Q.DL.getPointerSizeInBits(AS)) {
3752         auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3753           if (match(P, m_Zero()))
3754             return Constant::getNullValue(GEPTy);
3755           Value *Temp;
3756           if (match(P, m_PtrToInt(m_Value(Temp))))
3757             if (Temp->getType() == GEPTy)
3758               return Temp;
3759           return nullptr;
3760         };
3761 
3762         // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3763         if (TyAllocSize == 1 &&
3764             match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3765           if (Value *R = PtrToIntOrZero(P))
3766             return R;
3767 
3768         // getelementptr V, (ashr (sub P, V), C) -> Q
3769         // if P points to a type of size 1 << C.
3770         if (match(Ops[1],
3771                   m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3772                          m_ConstantInt(C))) &&
3773             TyAllocSize == 1ULL << C)
3774           if (Value *R = PtrToIntOrZero(P))
3775             return R;
3776 
3777         // getelementptr V, (sdiv (sub P, V), C) -> Q
3778         // if P points to a type of size C.
3779         if (match(Ops[1],
3780                   m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3781                          m_SpecificInt(TyAllocSize))))
3782           if (Value *R = PtrToIntOrZero(P))
3783             return R;
3784       }
3785     }
3786   }
3787 
3788   if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3789       all_of(Ops.slice(1).drop_back(1),
3790              [](Value *Idx) { return match(Idx, m_Zero()); })) {
3791     unsigned PtrWidth =
3792         Q.DL.getPointerSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3793     if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == PtrWidth) {
3794       APInt BasePtrOffset(PtrWidth, 0);
3795       Value *StrippedBasePtr =
3796           Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3797                                                             BasePtrOffset);
3798 
3799       // gep (gep V, C), (sub 0, V) -> C
3800       if (match(Ops.back(),
3801                 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3802         auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3803         return ConstantExpr::getIntToPtr(CI, GEPTy);
3804       }
3805       // gep (gep V, C), (xor V, -1) -> C-1
3806       if (match(Ops.back(),
3807                 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3808         auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3809         return ConstantExpr::getIntToPtr(CI, GEPTy);
3810       }
3811     }
3812   }
3813 
3814   // Check to see if this is constant foldable.
3815   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3816     if (!isa<Constant>(Ops[i]))
3817       return nullptr;
3818 
3819   return ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3820                                         Ops.slice(1));
3821 }
3822 
3823 Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3824                              const SimplifyQuery &Q) {
3825   return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
3826 }
3827 
3828 /// Given operands for an InsertValueInst, see if we can fold the result.
3829 /// If not, this returns null.
3830 static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
3831                                       ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
3832                                       unsigned) {
3833   if (Constant *CAgg = dyn_cast<Constant>(Agg))
3834     if (Constant *CVal = dyn_cast<Constant>(Val))
3835       return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3836 
3837   // insertvalue x, undef, n -> x
3838   if (match(Val, m_Undef()))
3839     return Agg;
3840 
3841   // insertvalue x, (extractvalue y, n), n
3842   if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
3843     if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3844         EV->getIndices() == Idxs) {
3845       // insertvalue undef, (extractvalue y, n), n -> y
3846       if (match(Agg, m_Undef()))
3847         return EV->getAggregateOperand();
3848 
3849       // insertvalue y, (extractvalue y, n), n -> y
3850       if (Agg == EV->getAggregateOperand())
3851         return Agg;
3852     }
3853 
3854   return nullptr;
3855 }
3856 
3857 Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3858                                      ArrayRef<unsigned> Idxs,
3859                                      const SimplifyQuery &Q) {
3860   return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
3861 }
3862 
3863 /// Given operands for an ExtractValueInst, see if we can fold the result.
3864 /// If not, this returns null.
3865 static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
3866                                        const SimplifyQuery &, unsigned) {
3867   if (auto *CAgg = dyn_cast<Constant>(Agg))
3868     return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3869 
3870   // extractvalue x, (insertvalue y, elt, n), n -> elt
3871   unsigned NumIdxs = Idxs.size();
3872   for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3873        IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3874     ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3875     unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3876     unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3877     if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
3878         Idxs.slice(0, NumCommonIdxs)) {
3879       if (NumIdxs == NumInsertValueIdxs)
3880         return IVI->getInsertedValueOperand();
3881       break;
3882     }
3883   }
3884 
3885   return nullptr;
3886 }
3887 
3888 Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
3889                                       const SimplifyQuery &Q) {
3890   return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
3891 }
3892 
3893 /// Given operands for an ExtractElementInst, see if we can fold the result.
3894 /// If not, this returns null.
3895 static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
3896                                          unsigned) {
3897   if (auto *CVec = dyn_cast<Constant>(Vec)) {
3898     if (auto *CIdx = dyn_cast<Constant>(Idx))
3899       return ConstantFoldExtractElementInstruction(CVec, CIdx);
3900 
3901     // The index is not relevant if our vector is a splat.
3902     if (auto *Splat = CVec->getSplatValue())
3903       return Splat;
3904 
3905     if (isa<UndefValue>(Vec))
3906       return UndefValue::get(Vec->getType()->getVectorElementType());
3907   }
3908 
3909   // If extracting a specified index from the vector, see if we can recursively
3910   // find a previously computed scalar that was inserted into the vector.
3911   if (auto *IdxC = dyn_cast<ConstantInt>(Idx))
3912     if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
3913       return Elt;
3914 
3915   return nullptr;
3916 }
3917 
3918 Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
3919                                         const SimplifyQuery &Q) {
3920   return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
3921 }
3922 
3923 /// See if we can fold the given phi. If not, returns null.
3924 static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
3925   // If all of the PHI's incoming values are the same then replace the PHI node
3926   // with the common value.
3927   Value *CommonValue = nullptr;
3928   bool HasUndefInput = false;
3929   for (Value *Incoming : PN->incoming_values()) {
3930     // If the incoming value is the phi node itself, it can safely be skipped.
3931     if (Incoming == PN) continue;
3932     if (isa<UndefValue>(Incoming)) {
3933       // Remember that we saw an undef value, but otherwise ignore them.
3934       HasUndefInput = true;
3935       continue;
3936     }
3937     if (CommonValue && Incoming != CommonValue)
3938       return nullptr;  // Not the same, bail out.
3939     CommonValue = Incoming;
3940   }
3941 
3942   // If CommonValue is null then all of the incoming values were either undef or
3943   // equal to the phi node itself.
3944   if (!CommonValue)
3945     return UndefValue::get(PN->getType());
3946 
3947   // If we have a PHI node like phi(X, undef, X), where X is defined by some
3948   // instruction, we cannot return X as the result of the PHI node unless it
3949   // dominates the PHI block.
3950   if (HasUndefInput)
3951     return ValueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
3952 
3953   return CommonValue;
3954 }
3955 
3956 static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
3957                                Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
3958   if (auto *C = dyn_cast<Constant>(Op))
3959     return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
3960 
3961   if (auto *CI = dyn_cast<CastInst>(Op)) {
3962     auto *Src = CI->getOperand(0);
3963     Type *SrcTy = Src->getType();
3964     Type *MidTy = CI->getType();
3965     Type *DstTy = Ty;
3966     if (Src->getType() == Ty) {
3967       auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
3968       auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
3969       Type *SrcIntPtrTy =
3970           SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
3971       Type *MidIntPtrTy =
3972           MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
3973       Type *DstIntPtrTy =
3974           DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
3975       if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
3976                                          SrcIntPtrTy, MidIntPtrTy,
3977                                          DstIntPtrTy) == Instruction::BitCast)
3978         return Src;
3979     }
3980   }
3981 
3982   // bitcast x -> x
3983   if (CastOpc == Instruction::BitCast)
3984     if (Op->getType() == Ty)
3985       return Op;
3986 
3987   return nullptr;
3988 }
3989 
3990 Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
3991                               const SimplifyQuery &Q) {
3992   return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
3993 }
3994 
3995 /// For the given destination element of a shuffle, peek through shuffles to
3996 /// match a root vector source operand that contains that element in the same
3997 /// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
3998 static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
3999                                    Constant *Mask, Value *RootVec, int RootElt,
4000                                    unsigned MaxRecurse) {
4001   if (!MaxRecurse--)
4002     return nullptr;
4003 
4004   // Bail out if any mask value is undefined. That kind of shuffle may be
4005   // simplified further based on demanded bits or other folds.
4006   int MaskVal = ShuffleVectorInst::getMaskValue(Mask, RootElt);
4007   if (MaskVal == -1)
4008     return nullptr;
4009 
4010   // The mask value chooses which source operand we need to look at next.
4011   Value *SourceOp;
4012   int InVecNumElts = Op0->getType()->getVectorNumElements();
4013   if (MaskVal < InVecNumElts) {
4014     RootElt = MaskVal;
4015     SourceOp = Op0;
4016   } else {
4017     RootElt = MaskVal - InVecNumElts;
4018     SourceOp = Op1;
4019   }
4020 
4021   // If the source operand is a shuffle itself, look through it to find the
4022   // matching root vector.
4023   if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4024     return foldIdentityShuffles(
4025         DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
4026         SourceShuf->getMask(), RootVec, RootElt, MaxRecurse);
4027   }
4028 
4029   // TODO: Look through bitcasts? What if the bitcast changes the vector element
4030   // size?
4031 
4032   // The source operand is not a shuffle. Initialize the root vector value for
4033   // this shuffle if that has not been done yet.
4034   if (!RootVec)
4035     RootVec = SourceOp;
4036 
4037   // Give up as soon as a source operand does not match the existing root value.
4038   if (RootVec != SourceOp)
4039     return nullptr;
4040 
4041   // The element must be coming from the same lane in the source vector
4042   // (although it may have crossed lanes in intermediate shuffles).
4043   if (RootElt != DestElt)
4044     return nullptr;
4045 
4046   return RootVec;
4047 }
4048 
4049 static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4050                                         Type *RetTy, const SimplifyQuery &Q,
4051                                         unsigned MaxRecurse) {
4052   if (isa<UndefValue>(Mask))
4053     return UndefValue::get(RetTy);
4054 
4055   Type *InVecTy = Op0->getType();
4056   unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
4057   unsigned InVecNumElts = InVecTy->getVectorNumElements();
4058 
4059   auto *Op0Const = dyn_cast<Constant>(Op0);
4060   auto *Op1Const = dyn_cast<Constant>(Op1);
4061 
4062   // If all operands are constant, constant fold the shuffle.
4063   if (Op0Const && Op1Const)
4064     return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4065 
4066   SmallVector<int, 32> Indices;
4067   ShuffleVectorInst::getShuffleMask(Mask, Indices);
4068   assert(MaskNumElts == Indices.size() &&
4069          "Size of Indices not same as number of mask elements?");
4070 
4071   // If only one of the operands is constant, constant fold the shuffle if the
4072   // mask does not select elements from the variable operand.
4073   bool MaskSelects0 = false, MaskSelects1 = false;
4074   for (unsigned i = 0; i != MaskNumElts; ++i) {
4075     if (Indices[i] == -1)
4076       continue;
4077     if ((unsigned)Indices[i] < InVecNumElts)
4078       MaskSelects0 = true;
4079     else
4080       MaskSelects1 = true;
4081   }
4082   if (!MaskSelects0 && Op1Const)
4083     return ConstantFoldShuffleVectorInstruction(UndefValue::get(InVecTy),
4084                                                 Op1Const, Mask);
4085   if (!MaskSelects1 && Op0Const)
4086     return ConstantFoldShuffleVectorInstruction(Op0Const,
4087                                                 UndefValue::get(InVecTy), Mask);
4088 
4089   // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4090   // value type is same as the input vectors' type.
4091   if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
4092     if (!MaskSelects1 && RetTy == InVecTy &&
4093         OpShuf->getMask()->getSplatValue())
4094       return Op0;
4095   if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op1))
4096     if (!MaskSelects0 && RetTy == InVecTy &&
4097         OpShuf->getMask()->getSplatValue())
4098       return Op1;
4099 
4100   // Don't fold a shuffle with undef mask elements. This may get folded in a
4101   // better way using demanded bits or other analysis.
4102   // TODO: Should we allow this?
4103   if (find(Indices, -1) != Indices.end())
4104     return nullptr;
4105 
4106   // Check if every element of this shuffle can be mapped back to the
4107   // corresponding element of a single root vector. If so, we don't need this
4108   // shuffle. This handles simple identity shuffles as well as chains of
4109   // shuffles that may widen/narrow and/or move elements across lanes and back.
4110   Value *RootVec = nullptr;
4111   for (unsigned i = 0; i != MaskNumElts; ++i) {
4112     // Note that recursion is limited for each vector element, so if any element
4113     // exceeds the limit, this will fail to simplify.
4114     RootVec = foldIdentityShuffles(i, Op0, Op1, Mask, RootVec, i, MaxRecurse);
4115 
4116     // We can't replace a widening/narrowing shuffle with one of its operands.
4117     if (!RootVec || RootVec->getType() != RetTy)
4118       return nullptr;
4119   }
4120   return RootVec;
4121 }
4122 
4123 /// Given operands for a ShuffleVectorInst, fold the result or return null.
4124 Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4125                                        Type *RetTy, const SimplifyQuery &Q) {
4126   return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
4127 }
4128 
4129 //=== Helper functions for higher up the class hierarchy.
4130 
4131 /// Given operands for a BinaryOperator, see if we can fold the result.
4132 /// If not, this returns null.
4133 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4134                             const SimplifyQuery &Q, unsigned MaxRecurse) {
4135   switch (Opcode) {
4136   case Instruction::Add:
4137     return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
4138   case Instruction::FAdd:
4139     return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4140   case Instruction::Sub:
4141     return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
4142   case Instruction::FSub:
4143     return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4144   case Instruction::Mul:
4145     return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
4146   case Instruction::FMul:
4147     return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4148   case Instruction::SDiv:
4149     return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4150   case Instruction::UDiv:
4151     return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
4152   case Instruction::FDiv:
4153     return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4154   case Instruction::SRem:
4155     return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4156   case Instruction::URem:
4157     return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
4158   case Instruction::FRem:
4159     return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4160   case Instruction::Shl:
4161     return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
4162   case Instruction::LShr:
4163     return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
4164   case Instruction::AShr:
4165     return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4166   case Instruction::And:
4167     return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4168   case Instruction::Or:
4169     return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4170   case Instruction::Xor:
4171     return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
4172   default:
4173     llvm_unreachable("Unexpected opcode");
4174   }
4175 }
4176 
4177 /// Given operands for a BinaryOperator, see if we can fold the result.
4178 /// If not, this returns null.
4179 /// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4180 /// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4181 static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4182                               const FastMathFlags &FMF, const SimplifyQuery &Q,
4183                               unsigned MaxRecurse) {
4184   switch (Opcode) {
4185   case Instruction::FAdd:
4186     return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4187   case Instruction::FSub:
4188     return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4189   case Instruction::FMul:
4190     return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
4191   case Instruction::FDiv:
4192     return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
4193   default:
4194     return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4195   }
4196 }
4197 
4198 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4199                            const SimplifyQuery &Q) {
4200   return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4201 }
4202 
4203 Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4204                              FastMathFlags FMF, const SimplifyQuery &Q) {
4205   return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4206 }
4207 
4208 /// Given operands for a CmpInst, see if we can fold the result.
4209 static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
4210                               const SimplifyQuery &Q, unsigned MaxRecurse) {
4211   if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
4212     return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
4213   return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4214 }
4215 
4216 Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
4217                              const SimplifyQuery &Q) {
4218   return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4219 }
4220 
4221 static bool IsIdempotent(Intrinsic::ID ID) {
4222   switch (ID) {
4223   default: return false;
4224 
4225   // Unary idempotent: f(f(x)) = f(x)
4226   case Intrinsic::fabs:
4227   case Intrinsic::floor:
4228   case Intrinsic::ceil:
4229   case Intrinsic::trunc:
4230   case Intrinsic::rint:
4231   case Intrinsic::nearbyint:
4232   case Intrinsic::round:
4233     return true;
4234   }
4235 }
4236 
4237 static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4238                                    const DataLayout &DL) {
4239   GlobalValue *PtrSym;
4240   APInt PtrOffset;
4241   if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4242     return nullptr;
4243 
4244   Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4245   Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4246   Type *Int32PtrTy = Int32Ty->getPointerTo();
4247   Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4248 
4249   auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4250   if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4251     return nullptr;
4252 
4253   uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4254   if (OffsetInt % 4 != 0)
4255     return nullptr;
4256 
4257   Constant *C = ConstantExpr::getGetElementPtr(
4258       Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4259       ConstantInt::get(Int64Ty, OffsetInt / 4));
4260   Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4261   if (!Loaded)
4262     return nullptr;
4263 
4264   auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4265   if (!LoadedCE)
4266     return nullptr;
4267 
4268   if (LoadedCE->getOpcode() == Instruction::Trunc) {
4269     LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4270     if (!LoadedCE)
4271       return nullptr;
4272   }
4273 
4274   if (LoadedCE->getOpcode() != Instruction::Sub)
4275     return nullptr;
4276 
4277   auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4278   if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4279     return nullptr;
4280   auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4281 
4282   Constant *LoadedRHS = LoadedCE->getOperand(1);
4283   GlobalValue *LoadedRHSSym;
4284   APInt LoadedRHSOffset;
4285   if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4286                                   DL) ||
4287       PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4288     return nullptr;
4289 
4290   return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4291 }
4292 
4293 static bool maskIsAllZeroOrUndef(Value *Mask) {
4294   auto *ConstMask = dyn_cast<Constant>(Mask);
4295   if (!ConstMask)
4296     return false;
4297   if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4298     return true;
4299   for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4300        ++I) {
4301     if (auto *MaskElt = ConstMask->getAggregateElement(I))
4302       if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4303         continue;
4304     return false;
4305   }
4306   return true;
4307 }
4308 
4309 template <typename IterTy>
4310 static Value *SimplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
4311                                 const SimplifyQuery &Q, unsigned MaxRecurse) {
4312   Intrinsic::ID IID = F->getIntrinsicID();
4313   unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
4314 
4315   // Unary Ops
4316   if (NumOperands == 1) {
4317     // Perform idempotent optimizations
4318     if (IsIdempotent(IID)) {
4319       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(*ArgBegin)) {
4320         if (II->getIntrinsicID() == IID)
4321           return II;
4322       }
4323     }
4324 
4325     switch (IID) {
4326     case Intrinsic::fabs: {
4327       if (SignBitMustBeZero(*ArgBegin, Q.TLI))
4328         return *ArgBegin;
4329       return nullptr;
4330     }
4331     default:
4332       return nullptr;
4333     }
4334   }
4335 
4336   // Binary Ops
4337   if (NumOperands == 2) {
4338     Value *LHS = *ArgBegin;
4339     Value *RHS = *(ArgBegin + 1);
4340     Type *ReturnType = F->getReturnType();
4341 
4342     switch (IID) {
4343     case Intrinsic::usub_with_overflow:
4344     case Intrinsic::ssub_with_overflow: {
4345       // X - X -> { 0, false }
4346       if (LHS == RHS)
4347         return Constant::getNullValue(ReturnType);
4348 
4349       // X - undef -> undef
4350       // undef - X -> undef
4351       if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS))
4352         return UndefValue::get(ReturnType);
4353 
4354       return nullptr;
4355     }
4356     case Intrinsic::uadd_with_overflow:
4357     case Intrinsic::sadd_with_overflow: {
4358       // X + undef -> undef
4359       if (isa<UndefValue>(RHS))
4360         return UndefValue::get(ReturnType);
4361 
4362       return nullptr;
4363     }
4364     case Intrinsic::umul_with_overflow:
4365     case Intrinsic::smul_with_overflow: {
4366       // X * 0 -> { 0, false }
4367       if (match(RHS, m_Zero()))
4368         return Constant::getNullValue(ReturnType);
4369 
4370       // X * undef -> { 0, false }
4371       if (match(RHS, m_Undef()))
4372         return Constant::getNullValue(ReturnType);
4373 
4374       return nullptr;
4375     }
4376     case Intrinsic::load_relative: {
4377       Constant *C0 = dyn_cast<Constant>(LHS);
4378       Constant *C1 = dyn_cast<Constant>(RHS);
4379       if (C0 && C1)
4380         return SimplifyRelativeLoad(C0, C1, Q.DL);
4381       return nullptr;
4382     }
4383     default:
4384       return nullptr;
4385     }
4386   }
4387 
4388   // Simplify calls to llvm.masked.load.*
4389   switch (IID) {
4390   case Intrinsic::masked_load: {
4391     Value *MaskArg = ArgBegin[2];
4392     Value *PassthruArg = ArgBegin[3];
4393     // If the mask is all zeros or undef, the "passthru" argument is the result.
4394     if (maskIsAllZeroOrUndef(MaskArg))
4395       return PassthruArg;
4396     return nullptr;
4397   }
4398   default:
4399     return nullptr;
4400   }
4401 }
4402 
4403 template <typename IterTy>
4404 static Value *SimplifyCall(Value *V, IterTy ArgBegin, IterTy ArgEnd,
4405                            const SimplifyQuery &Q, unsigned MaxRecurse) {
4406   Type *Ty = V->getType();
4407   if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4408     Ty = PTy->getElementType();
4409   FunctionType *FTy = cast<FunctionType>(Ty);
4410 
4411   // call undef -> undef
4412   // call null -> undef
4413   if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
4414     return UndefValue::get(FTy->getReturnType());
4415 
4416   Function *F = dyn_cast<Function>(V);
4417   if (!F)
4418     return nullptr;
4419 
4420   if (F->isIntrinsic())
4421     if (Value *Ret = SimplifyIntrinsic(F, ArgBegin, ArgEnd, Q, MaxRecurse))
4422       return Ret;
4423 
4424   if (!canConstantFoldCallTo(F))
4425     return nullptr;
4426 
4427   SmallVector<Constant *, 4> ConstantArgs;
4428   ConstantArgs.reserve(ArgEnd - ArgBegin);
4429   for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4430     Constant *C = dyn_cast<Constant>(*I);
4431     if (!C)
4432       return nullptr;
4433     ConstantArgs.push_back(C);
4434   }
4435 
4436   return ConstantFoldCall(F, ConstantArgs, Q.TLI);
4437 }
4438 
4439 Value *llvm::SimplifyCall(Value *V, User::op_iterator ArgBegin,
4440                           User::op_iterator ArgEnd, const SimplifyQuery &Q) {
4441   return ::SimplifyCall(V, ArgBegin, ArgEnd, Q, RecursionLimit);
4442 }
4443 
4444 Value *llvm::SimplifyCall(Value *V, ArrayRef<Value *> Args,
4445                           const SimplifyQuery &Q) {
4446   return ::SimplifyCall(V, Args.begin(), Args.end(), Q, RecursionLimit);
4447 }
4448 
4449 /// See if we can compute a simplified version of this instruction.
4450 /// If not, this returns null.
4451 
4452 Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
4453                                  OptimizationRemarkEmitter *ORE) {
4454   const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
4455   Value *Result;
4456 
4457   switch (I->getOpcode()) {
4458   default:
4459     Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
4460     break;
4461   case Instruction::FAdd:
4462     Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
4463                               I->getFastMathFlags(), Q);
4464     break;
4465   case Instruction::Add:
4466     Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4467                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
4468                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
4469     break;
4470   case Instruction::FSub:
4471     Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
4472                               I->getFastMathFlags(), Q);
4473     break;
4474   case Instruction::Sub:
4475     Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4476                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
4477                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
4478     break;
4479   case Instruction::FMul:
4480     Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
4481                               I->getFastMathFlags(), Q);
4482     break;
4483   case Instruction::Mul:
4484     Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
4485     break;
4486   case Instruction::SDiv:
4487     Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
4488     break;
4489   case Instruction::UDiv:
4490     Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
4491     break;
4492   case Instruction::FDiv:
4493     Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
4494                               I->getFastMathFlags(), Q);
4495     break;
4496   case Instruction::SRem:
4497     Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
4498     break;
4499   case Instruction::URem:
4500     Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
4501     break;
4502   case Instruction::FRem:
4503     Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
4504                               I->getFastMathFlags(), Q);
4505     break;
4506   case Instruction::Shl:
4507     Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4508                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
4509                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
4510     break;
4511   case Instruction::LShr:
4512     Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
4513                               cast<BinaryOperator>(I)->isExact(), Q);
4514     break;
4515   case Instruction::AShr:
4516     Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
4517                               cast<BinaryOperator>(I)->isExact(), Q);
4518     break;
4519   case Instruction::And:
4520     Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
4521     break;
4522   case Instruction::Or:
4523     Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
4524     break;
4525   case Instruction::Xor:
4526     Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
4527     break;
4528   case Instruction::ICmp:
4529     Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
4530                               I->getOperand(0), I->getOperand(1), Q);
4531     break;
4532   case Instruction::FCmp:
4533     Result =
4534         SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
4535                          I->getOperand(1), I->getFastMathFlags(), Q);
4536     break;
4537   case Instruction::Select:
4538     Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
4539                                 I->getOperand(2), Q);
4540     break;
4541   case Instruction::GetElementPtr: {
4542     SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
4543     Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
4544                              Ops, Q);
4545     break;
4546   }
4547   case Instruction::InsertValue: {
4548     InsertValueInst *IV = cast<InsertValueInst>(I);
4549     Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4550                                      IV->getInsertedValueOperand(),
4551                                      IV->getIndices(), Q);
4552     break;
4553   }
4554   case Instruction::ExtractValue: {
4555     auto *EVI = cast<ExtractValueInst>(I);
4556     Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
4557                                       EVI->getIndices(), Q);
4558     break;
4559   }
4560   case Instruction::ExtractElement: {
4561     auto *EEI = cast<ExtractElementInst>(I);
4562     Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
4563                                         EEI->getIndexOperand(), Q);
4564     break;
4565   }
4566   case Instruction::ShuffleVector: {
4567     auto *SVI = cast<ShuffleVectorInst>(I);
4568     Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
4569                                        SVI->getMask(), SVI->getType(), Q);
4570     break;
4571   }
4572   case Instruction::PHI:
4573     Result = SimplifyPHINode(cast<PHINode>(I), Q);
4574     break;
4575   case Instruction::Call: {
4576     CallSite CS(cast<CallInst>(I));
4577     Result = SimplifyCall(CS.getCalledValue(), CS.arg_begin(), CS.arg_end(), Q);
4578     break;
4579   }
4580 #define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4581 #include "llvm/IR/Instruction.def"
4582 #undef HANDLE_CAST_INST
4583     Result =
4584         SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
4585     break;
4586   case Instruction::Alloca:
4587     // No simplifications for Alloca and it can't be constant folded.
4588     Result = nullptr;
4589     break;
4590   }
4591 
4592   // In general, it is possible for computeKnownBits to determine all bits in a
4593   // value even when the operands are not all constants.
4594   if (!Result && I->getType()->isIntOrIntVectorTy()) {
4595     unsigned BitWidth = I->getType()->getScalarSizeInBits();
4596     KnownBits Known(BitWidth);
4597     computeKnownBits(I, Known, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
4598     if (Known.isConstant())
4599       Result = ConstantInt::get(I->getType(), Known.getConstant());
4600   }
4601 
4602   /// If called on unreachable code, the above logic may report that the
4603   /// instruction simplified to itself.  Make life easier for users by
4604   /// detecting that case here, returning a safe value instead.
4605   return Result == I ? UndefValue::get(I->getType()) : Result;
4606 }
4607 
4608 /// \brief Implementation of recursive simplification through an instruction's
4609 /// uses.
4610 ///
4611 /// This is the common implementation of the recursive simplification routines.
4612 /// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
4613 /// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
4614 /// instructions to process and attempt to simplify it using
4615 /// InstructionSimplify.
4616 ///
4617 /// This routine returns 'true' only when *it* simplifies something. The passed
4618 /// in simplified value does not count toward this.
4619 static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
4620                                               const TargetLibraryInfo *TLI,
4621                                               const DominatorTree *DT,
4622                                               AssumptionCache *AC) {
4623   bool Simplified = false;
4624   SmallSetVector<Instruction *, 8> Worklist;
4625   const DataLayout &DL = I->getModule()->getDataLayout();
4626 
4627   // If we have an explicit value to collapse to, do that round of the
4628   // simplification loop by hand initially.
4629   if (SimpleV) {
4630     for (User *U : I->users())
4631       if (U != I)
4632         Worklist.insert(cast<Instruction>(U));
4633 
4634     // Replace the instruction with its simplified value.
4635     I->replaceAllUsesWith(SimpleV);
4636 
4637     // Gracefully handle edge cases where the instruction is not wired into any
4638     // parent block.
4639     if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4640         !I->mayHaveSideEffects())
4641       I->eraseFromParent();
4642   } else {
4643     Worklist.insert(I);
4644   }
4645 
4646   // Note that we must test the size on each iteration, the worklist can grow.
4647   for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
4648     I = Worklist[Idx];
4649 
4650     // See if this instruction simplifies.
4651     SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
4652     if (!SimpleV)
4653       continue;
4654 
4655     Simplified = true;
4656 
4657     // Stash away all the uses of the old instruction so we can check them for
4658     // recursive simplifications after a RAUW. This is cheaper than checking all
4659     // uses of To on the recursive step in most cases.
4660     for (User *U : I->users())
4661       Worklist.insert(cast<Instruction>(U));
4662 
4663     // Replace the instruction with its simplified value.
4664     I->replaceAllUsesWith(SimpleV);
4665 
4666     // Gracefully handle edge cases where the instruction is not wired into any
4667     // parent block.
4668     if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
4669         !I->mayHaveSideEffects())
4670       I->eraseFromParent();
4671   }
4672   return Simplified;
4673 }
4674 
4675 bool llvm::recursivelySimplifyInstruction(Instruction *I,
4676                                           const TargetLibraryInfo *TLI,
4677                                           const DominatorTree *DT,
4678                                           AssumptionCache *AC) {
4679   return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
4680 }
4681 
4682 bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
4683                                          const TargetLibraryInfo *TLI,
4684                                          const DominatorTree *DT,
4685                                          AssumptionCache *AC) {
4686   assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
4687   assert(SimpleV && "Must provide a simplified value.");
4688   return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
4689 }
4690 
4691 namespace llvm {
4692 const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
4693   auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
4694   auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
4695   auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
4696   auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
4697   auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
4698   auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
4699   return {F.getParent()->getDataLayout(), TLI, DT, AC};
4700 }
4701 
4702 const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
4703                                          const DataLayout &DL) {
4704   return {DL, &AR.TLI, &AR.DT, &AR.AC};
4705 }
4706 
4707 template <class T, class... TArgs>
4708 const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
4709                                          Function &F) {
4710   auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
4711   auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
4712   auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
4713   return {F.getParent()->getDataLayout(), TLI, DT, AC};
4714 }
4715 template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
4716                                                   Function &);
4717 }
4718