1 //===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements routines for folding instructions into simpler forms
10 // that do not require creating new instructions.  This does constant folding
11 // ("add i32 1, 1" -> "2") but can also handle non-constant operands, either
12 // returning a constant ("and i32 %x, 0" -> "0") or an already existing value
13 // ("and i32 %x, %x" -> "%x").  All operands are assumed to have already been
14 // simplified: This is usually true and assuming it simplifies the logic (if
15 // they have not been simplified then results are correct but maybe suboptimal).
16 //
17 //===----------------------------------------------------------------------===//
18 
19 #include "llvm/Analysis/InstructionSimplify.h"
20 
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/SetVector.h"
23 #include "llvm/ADT/SmallPtrSet.h"
24 #include "llvm/ADT/Statistic.h"
25 #include "llvm/Analysis/AliasAnalysis.h"
26 #include "llvm/Analysis/AssumptionCache.h"
27 #include "llvm/Analysis/CaptureTracking.h"
28 #include "llvm/Analysis/CmpInstAnalysis.h"
29 #include "llvm/Analysis/ConstantFolding.h"
30 #include "llvm/Analysis/LoopAnalysisManager.h"
31 #include "llvm/Analysis/MemoryBuiltins.h"
32 #include "llvm/Analysis/OverflowInstAnalysis.h"
33 #include "llvm/Analysis/ValueTracking.h"
34 #include "llvm/Analysis/VectorUtils.h"
35 #include "llvm/IR/ConstantRange.h"
36 #include "llvm/IR/DataLayout.h"
37 #include "llvm/IR/Dominators.h"
38 #include "llvm/IR/GetElementPtrTypeIterator.h"
39 #include "llvm/IR/GlobalAlias.h"
40 #include "llvm/IR/InstrTypes.h"
41 #include "llvm/IR/Instructions.h"
42 #include "llvm/IR/Operator.h"
43 #include "llvm/IR/PatternMatch.h"
44 #include "llvm/IR/ValueHandle.h"
45 #include "llvm/Support/KnownBits.h"
46 #include <algorithm>
47 using namespace llvm;
48 using namespace llvm::PatternMatch;
49 
50 #define DEBUG_TYPE "instsimplify"
51 
52 enum { RecursionLimit = 3 };
53 
54 STATISTIC(NumExpand,  "Number of expansions");
55 STATISTIC(NumReassoc, "Number of reassociations");
56 
57 static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
58 static Value *simplifyUnOp(unsigned, Value *, const SimplifyQuery &, unsigned);
59 static Value *simplifyFPUnOp(unsigned, Value *, const FastMathFlags &,
60                              const SimplifyQuery &, unsigned);
61 static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
62                             unsigned);
63 static Value *SimplifyBinOp(unsigned, Value *, Value *, const FastMathFlags &,
64                             const SimplifyQuery &, unsigned);
65 static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
66                               unsigned);
67 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
68                                const SimplifyQuery &Q, unsigned MaxRecurse);
69 static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
70 static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
71 static Value *SimplifyCastInst(unsigned, Value *, Type *,
72                                const SimplifyQuery &, unsigned);
73 static Value *SimplifyGEPInst(Type *, ArrayRef<Value *>, bool,
74                               const SimplifyQuery &, unsigned);
75 static Value *SimplifySelectInst(Value *, Value *, Value *,
76                                  const SimplifyQuery &, unsigned);
77 
78 static Value *foldSelectWithBinaryOp(Value *Cond, Value *TrueVal,
79                                      Value *FalseVal) {
80   BinaryOperator::BinaryOps BinOpCode;
81   if (auto *BO = dyn_cast<BinaryOperator>(Cond))
82     BinOpCode = BO->getOpcode();
83   else
84     return nullptr;
85 
86   CmpInst::Predicate ExpectedPred, Pred1, Pred2;
87   if (BinOpCode == BinaryOperator::Or) {
88     ExpectedPred = ICmpInst::ICMP_NE;
89   } else if (BinOpCode == BinaryOperator::And) {
90     ExpectedPred = ICmpInst::ICMP_EQ;
91   } else
92     return nullptr;
93 
94   // %A = icmp eq %TV, %FV
95   // %B = icmp eq %X, %Y (and one of these is a select operand)
96   // %C = and %A, %B
97   // %D = select %C, %TV, %FV
98   // -->
99   // %FV
100 
101   // %A = icmp ne %TV, %FV
102   // %B = icmp ne %X, %Y (and one of these is a select operand)
103   // %C = or %A, %B
104   // %D = select %C, %TV, %FV
105   // -->
106   // %TV
107   Value *X, *Y;
108   if (!match(Cond, m_c_BinOp(m_c_ICmp(Pred1, m_Specific(TrueVal),
109                                       m_Specific(FalseVal)),
110                              m_ICmp(Pred2, m_Value(X), m_Value(Y)))) ||
111       Pred1 != Pred2 || Pred1 != ExpectedPred)
112     return nullptr;
113 
114   if (X == TrueVal || X == FalseVal || Y == TrueVal || Y == FalseVal)
115     return BinOpCode == BinaryOperator::Or ? TrueVal : FalseVal;
116 
117   return nullptr;
118 }
119 
120 /// For a boolean type or a vector of boolean type, return false or a vector
121 /// with every element false.
122 static Constant *getFalse(Type *Ty) {
123   return ConstantInt::getFalse(Ty);
124 }
125 
126 /// For a boolean type or a vector of boolean type, return true or a vector
127 /// with every element true.
128 static Constant *getTrue(Type *Ty) {
129   return ConstantInt::getTrue(Ty);
130 }
131 
132 /// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
133 static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
134                           Value *RHS) {
135   CmpInst *Cmp = dyn_cast<CmpInst>(V);
136   if (!Cmp)
137     return false;
138   CmpInst::Predicate CPred = Cmp->getPredicate();
139   Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
140   if (CPred == Pred && CLHS == LHS && CRHS == RHS)
141     return true;
142   return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
143     CRHS == LHS;
144 }
145 
146 /// Simplify comparison with true or false branch of select:
147 ///  %sel = select i1 %cond, i32 %tv, i32 %fv
148 ///  %cmp = icmp sle i32 %sel, %rhs
149 /// Compose new comparison by substituting %sel with either %tv or %fv
150 /// and see if it simplifies.
151 static Value *simplifyCmpSelCase(CmpInst::Predicate Pred, Value *LHS,
152                                  Value *RHS, Value *Cond,
153                                  const SimplifyQuery &Q, unsigned MaxRecurse,
154                                  Constant *TrueOrFalse) {
155   Value *SimplifiedCmp = SimplifyCmpInst(Pred, LHS, RHS, Q, MaxRecurse);
156   if (SimplifiedCmp == Cond) {
157     // %cmp simplified to the select condition (%cond).
158     return TrueOrFalse;
159   } else if (!SimplifiedCmp && isSameCompare(Cond, Pred, LHS, RHS)) {
160     // It didn't simplify. However, if composed comparison is equivalent
161     // to the select condition (%cond) then we can replace it.
162     return TrueOrFalse;
163   }
164   return SimplifiedCmp;
165 }
166 
167 /// Simplify comparison with true branch of select
168 static Value *simplifyCmpSelTrueCase(CmpInst::Predicate Pred, Value *LHS,
169                                      Value *RHS, Value *Cond,
170                                      const SimplifyQuery &Q,
171                                      unsigned MaxRecurse) {
172   return simplifyCmpSelCase(Pred, LHS, RHS, Cond, Q, MaxRecurse,
173                             getTrue(Cond->getType()));
174 }
175 
176 /// Simplify comparison with false branch of select
177 static Value *simplifyCmpSelFalseCase(CmpInst::Predicate Pred, Value *LHS,
178                                       Value *RHS, Value *Cond,
179                                       const SimplifyQuery &Q,
180                                       unsigned MaxRecurse) {
181   return simplifyCmpSelCase(Pred, LHS, RHS, Cond, Q, MaxRecurse,
182                             getFalse(Cond->getType()));
183 }
184 
185 /// We know comparison with both branches of select can be simplified, but they
186 /// are not equal. This routine handles some logical simplifications.
187 static Value *handleOtherCmpSelSimplifications(Value *TCmp, Value *FCmp,
188                                                Value *Cond,
189                                                const SimplifyQuery &Q,
190                                                unsigned MaxRecurse) {
191   // If the false value simplified to false, then the result of the compare
192   // is equal to "Cond && TCmp".  This also catches the case when the false
193   // value simplified to false and the true value to true, returning "Cond".
194   // Folding select to and/or isn't poison-safe in general; impliesPoison
195   // checks whether folding it does not convert a well-defined value into
196   // poison.
197   if (match(FCmp, m_Zero()) && impliesPoison(TCmp, Cond))
198     if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
199       return V;
200   // If the true value simplified to true, then the result of the compare
201   // is equal to "Cond || FCmp".
202   if (match(TCmp, m_One()) && impliesPoison(FCmp, Cond))
203     if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
204       return V;
205   // Finally, if the false value simplified to true and the true value to
206   // false, then the result of the compare is equal to "!Cond".
207   if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
208     if (Value *V = SimplifyXorInst(
209             Cond, Constant::getAllOnesValue(Cond->getType()), Q, MaxRecurse))
210       return V;
211   return nullptr;
212 }
213 
214 /// Does the given value dominate the specified phi node?
215 static bool valueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
216   Instruction *I = dyn_cast<Instruction>(V);
217   if (!I)
218     // Arguments and constants dominate all instructions.
219     return true;
220 
221   // If we are processing instructions (and/or basic blocks) that have not been
222   // fully added to a function, the parent nodes may still be null. Simply
223   // return the conservative answer in these cases.
224   if (!I->getParent() || !P->getParent() || !I->getFunction())
225     return false;
226 
227   // If we have a DominatorTree then do a precise test.
228   if (DT)
229     return DT->dominates(I, P);
230 
231   // Otherwise, if the instruction is in the entry block and is not an invoke,
232   // then it obviously dominates all phi nodes.
233   if (I->getParent()->isEntryBlock() && !isa<InvokeInst>(I) &&
234       !isa<CallBrInst>(I))
235     return true;
236 
237   return false;
238 }
239 
240 /// Try to simplify a binary operator of form "V op OtherOp" where V is
241 /// "(B0 opex B1)" by distributing 'op' across 'opex' as
242 /// "(B0 op OtherOp) opex (B1 op OtherOp)".
243 static Value *expandBinOp(Instruction::BinaryOps Opcode, Value *V,
244                           Value *OtherOp, Instruction::BinaryOps OpcodeToExpand,
245                           const SimplifyQuery &Q, unsigned MaxRecurse) {
246   auto *B = dyn_cast<BinaryOperator>(V);
247   if (!B || B->getOpcode() != OpcodeToExpand)
248     return nullptr;
249   Value *B0 = B->getOperand(0), *B1 = B->getOperand(1);
250   Value *L = SimplifyBinOp(Opcode, B0, OtherOp, Q.getWithoutUndef(),
251                            MaxRecurse);
252   if (!L)
253     return nullptr;
254   Value *R = SimplifyBinOp(Opcode, B1, OtherOp, Q.getWithoutUndef(),
255                            MaxRecurse);
256   if (!R)
257     return nullptr;
258 
259   // Does the expanded pair of binops simplify to the existing binop?
260   if ((L == B0 && R == B1) ||
261       (Instruction::isCommutative(OpcodeToExpand) && L == B1 && R == B0)) {
262     ++NumExpand;
263     return B;
264   }
265 
266   // Otherwise, return "L op' R" if it simplifies.
267   Value *S = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse);
268   if (!S)
269     return nullptr;
270 
271   ++NumExpand;
272   return S;
273 }
274 
275 /// Try to simplify binops of form "A op (B op' C)" or the commuted variant by
276 /// distributing op over op'.
277 static Value *expandCommutativeBinOp(Instruction::BinaryOps Opcode,
278                                      Value *L, Value *R,
279                                      Instruction::BinaryOps OpcodeToExpand,
280                                      const SimplifyQuery &Q,
281                                      unsigned MaxRecurse) {
282   // Recursion is always used, so bail out at once if we already hit the limit.
283   if (!MaxRecurse--)
284     return nullptr;
285 
286   if (Value *V = expandBinOp(Opcode, L, R, OpcodeToExpand, Q, MaxRecurse))
287     return V;
288   if (Value *V = expandBinOp(Opcode, R, L, OpcodeToExpand, Q, MaxRecurse))
289     return V;
290   return nullptr;
291 }
292 
293 /// Generic simplifications for associative binary operations.
294 /// Returns the simpler value, or null if none was found.
295 static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
296                                        Value *LHS, Value *RHS,
297                                        const SimplifyQuery &Q,
298                                        unsigned MaxRecurse) {
299   assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
300 
301   // Recursion is always used, so bail out at once if we already hit the limit.
302   if (!MaxRecurse--)
303     return nullptr;
304 
305   BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
306   BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
307 
308   // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
309   if (Op0 && Op0->getOpcode() == Opcode) {
310     Value *A = Op0->getOperand(0);
311     Value *B = Op0->getOperand(1);
312     Value *C = RHS;
313 
314     // Does "B op C" simplify?
315     if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
316       // It does!  Return "A op V" if it simplifies or is already available.
317       // If V equals B then "A op V" is just the LHS.
318       if (V == B) return LHS;
319       // Otherwise return "A op V" if it simplifies.
320       if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
321         ++NumReassoc;
322         return W;
323       }
324     }
325   }
326 
327   // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
328   if (Op1 && Op1->getOpcode() == Opcode) {
329     Value *A = LHS;
330     Value *B = Op1->getOperand(0);
331     Value *C = Op1->getOperand(1);
332 
333     // Does "A op B" simplify?
334     if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
335       // It does!  Return "V op C" if it simplifies or is already available.
336       // If V equals B then "V op C" is just the RHS.
337       if (V == B) return RHS;
338       // Otherwise return "V op C" if it simplifies.
339       if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
340         ++NumReassoc;
341         return W;
342       }
343     }
344   }
345 
346   // The remaining transforms require commutativity as well as associativity.
347   if (!Instruction::isCommutative(Opcode))
348     return nullptr;
349 
350   // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
351   if (Op0 && Op0->getOpcode() == Opcode) {
352     Value *A = Op0->getOperand(0);
353     Value *B = Op0->getOperand(1);
354     Value *C = RHS;
355 
356     // Does "C op A" simplify?
357     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
358       // It does!  Return "V op B" if it simplifies or is already available.
359       // If V equals A then "V op B" is just the LHS.
360       if (V == A) return LHS;
361       // Otherwise return "V op B" if it simplifies.
362       if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
363         ++NumReassoc;
364         return W;
365       }
366     }
367   }
368 
369   // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
370   if (Op1 && Op1->getOpcode() == Opcode) {
371     Value *A = LHS;
372     Value *B = Op1->getOperand(0);
373     Value *C = Op1->getOperand(1);
374 
375     // Does "C op A" simplify?
376     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
377       // It does!  Return "B op V" if it simplifies or is already available.
378       // If V equals C then "B op V" is just the RHS.
379       if (V == C) return RHS;
380       // Otherwise return "B op V" if it simplifies.
381       if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
382         ++NumReassoc;
383         return W;
384       }
385     }
386   }
387 
388   return nullptr;
389 }
390 
391 /// In the case of a binary operation with a select instruction as an operand,
392 /// try to simplify the binop by seeing whether evaluating it on both branches
393 /// of the select results in the same value. Returns the common value if so,
394 /// otherwise returns null.
395 static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
396                                     Value *RHS, const SimplifyQuery &Q,
397                                     unsigned MaxRecurse) {
398   // Recursion is always used, so bail out at once if we already hit the limit.
399   if (!MaxRecurse--)
400     return nullptr;
401 
402   SelectInst *SI;
403   if (isa<SelectInst>(LHS)) {
404     SI = cast<SelectInst>(LHS);
405   } else {
406     assert(isa<SelectInst>(RHS) && "No select instruction operand!");
407     SI = cast<SelectInst>(RHS);
408   }
409 
410   // Evaluate the BinOp on the true and false branches of the select.
411   Value *TV;
412   Value *FV;
413   if (SI == LHS) {
414     TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
415     FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
416   } else {
417     TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
418     FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
419   }
420 
421   // If they simplified to the same value, then return the common value.
422   // If they both failed to simplify then return null.
423   if (TV == FV)
424     return TV;
425 
426   // If one branch simplified to undef, return the other one.
427   if (TV && Q.isUndefValue(TV))
428     return FV;
429   if (FV && Q.isUndefValue(FV))
430     return TV;
431 
432   // If applying the operation did not change the true and false select values,
433   // then the result of the binop is the select itself.
434   if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
435     return SI;
436 
437   // If one branch simplified and the other did not, and the simplified
438   // value is equal to the unsimplified one, return the simplified value.
439   // For example, select (cond, X, X & Z) & Z -> X & Z.
440   if ((FV && !TV) || (TV && !FV)) {
441     // Check that the simplified value has the form "X op Y" where "op" is the
442     // same as the original operation.
443     Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
444     if (Simplified && Simplified->getOpcode() == unsigned(Opcode)) {
445       // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
446       // We already know that "op" is the same as for the simplified value.  See
447       // if the operands match too.  If so, return the simplified value.
448       Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
449       Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
450       Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
451       if (Simplified->getOperand(0) == UnsimplifiedLHS &&
452           Simplified->getOperand(1) == UnsimplifiedRHS)
453         return Simplified;
454       if (Simplified->isCommutative() &&
455           Simplified->getOperand(1) == UnsimplifiedLHS &&
456           Simplified->getOperand(0) == UnsimplifiedRHS)
457         return Simplified;
458     }
459   }
460 
461   return nullptr;
462 }
463 
464 /// In the case of a comparison with a select instruction, try to simplify the
465 /// comparison by seeing whether both branches of the select result in the same
466 /// value. Returns the common value if so, otherwise returns null.
467 /// For example, if we have:
468 ///  %tmp = select i1 %cmp, i32 1, i32 2
469 ///  %cmp1 = icmp sle i32 %tmp, 3
470 /// We can simplify %cmp1 to true, because both branches of select are
471 /// less than 3. We compose new comparison by substituting %tmp with both
472 /// branches of select and see if it can be simplified.
473 static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
474                                   Value *RHS, const SimplifyQuery &Q,
475                                   unsigned MaxRecurse) {
476   // Recursion is always used, so bail out at once if we already hit the limit.
477   if (!MaxRecurse--)
478     return nullptr;
479 
480   // Make sure the select is on the LHS.
481   if (!isa<SelectInst>(LHS)) {
482     std::swap(LHS, RHS);
483     Pred = CmpInst::getSwappedPredicate(Pred);
484   }
485   assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
486   SelectInst *SI = cast<SelectInst>(LHS);
487   Value *Cond = SI->getCondition();
488   Value *TV = SI->getTrueValue();
489   Value *FV = SI->getFalseValue();
490 
491   // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
492   // Does "cmp TV, RHS" simplify?
493   Value *TCmp = simplifyCmpSelTrueCase(Pred, TV, RHS, Cond, Q, MaxRecurse);
494   if (!TCmp)
495     return nullptr;
496 
497   // Does "cmp FV, RHS" simplify?
498   Value *FCmp = simplifyCmpSelFalseCase(Pred, FV, RHS, Cond, Q, MaxRecurse);
499   if (!FCmp)
500     return nullptr;
501 
502   // If both sides simplified to the same value, then use it as the result of
503   // the original comparison.
504   if (TCmp == FCmp)
505     return TCmp;
506 
507   // The remaining cases only make sense if the select condition has the same
508   // type as the result of the comparison, so bail out if this is not so.
509   if (Cond->getType()->isVectorTy() == RHS->getType()->isVectorTy())
510     return handleOtherCmpSelSimplifications(TCmp, FCmp, Cond, Q, MaxRecurse);
511 
512   return nullptr;
513 }
514 
515 /// In the case of a binary operation with an operand that is a PHI instruction,
516 /// try to simplify the binop by seeing whether evaluating it on the incoming
517 /// phi values yields the same result for every value. If so returns the common
518 /// value, otherwise returns null.
519 static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
520                                  Value *RHS, const SimplifyQuery &Q,
521                                  unsigned MaxRecurse) {
522   // Recursion is always used, so bail out at once if we already hit the limit.
523   if (!MaxRecurse--)
524     return nullptr;
525 
526   PHINode *PI;
527   if (isa<PHINode>(LHS)) {
528     PI = cast<PHINode>(LHS);
529     // Bail out if RHS and the phi may be mutually interdependent due to a loop.
530     if (!valueDominatesPHI(RHS, PI, Q.DT))
531       return nullptr;
532   } else {
533     assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
534     PI = cast<PHINode>(RHS);
535     // Bail out if LHS and the phi may be mutually interdependent due to a loop.
536     if (!valueDominatesPHI(LHS, PI, Q.DT))
537       return nullptr;
538   }
539 
540   // Evaluate the BinOp on the incoming phi values.
541   Value *CommonValue = nullptr;
542   for (Value *Incoming : PI->incoming_values()) {
543     // If the incoming value is the phi node itself, it can safely be skipped.
544     if (Incoming == PI) continue;
545     Value *V = PI == LHS ?
546       SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
547       SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
548     // If the operation failed to simplify, or simplified to a different value
549     // to previously, then give up.
550     if (!V || (CommonValue && V != CommonValue))
551       return nullptr;
552     CommonValue = V;
553   }
554 
555   return CommonValue;
556 }
557 
558 /// In the case of a comparison with a PHI instruction, try to simplify the
559 /// comparison by seeing whether comparing with all of the incoming phi values
560 /// yields the same result every time. If so returns the common result,
561 /// otherwise returns null.
562 static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
563                                const SimplifyQuery &Q, unsigned MaxRecurse) {
564   // Recursion is always used, so bail out at once if we already hit the limit.
565   if (!MaxRecurse--)
566     return nullptr;
567 
568   // Make sure the phi is on the LHS.
569   if (!isa<PHINode>(LHS)) {
570     std::swap(LHS, RHS);
571     Pred = CmpInst::getSwappedPredicate(Pred);
572   }
573   assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
574   PHINode *PI = cast<PHINode>(LHS);
575 
576   // Bail out if RHS and the phi may be mutually interdependent due to a loop.
577   if (!valueDominatesPHI(RHS, PI, Q.DT))
578     return nullptr;
579 
580   // Evaluate the BinOp on the incoming phi values.
581   Value *CommonValue = nullptr;
582   for (unsigned u = 0, e = PI->getNumIncomingValues(); u < e; ++u) {
583     Value *Incoming = PI->getIncomingValue(u);
584     Instruction *InTI = PI->getIncomingBlock(u)->getTerminator();
585     // If the incoming value is the phi node itself, it can safely be skipped.
586     if (Incoming == PI) continue;
587     // Change the context instruction to the "edge" that flows into the phi.
588     // This is important because that is where incoming is actually "evaluated"
589     // even though it is used later somewhere else.
590     Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q.getWithInstruction(InTI),
591                                MaxRecurse);
592     // If the operation failed to simplify, or simplified to a different value
593     // to previously, then give up.
594     if (!V || (CommonValue && V != CommonValue))
595       return nullptr;
596     CommonValue = V;
597   }
598 
599   return CommonValue;
600 }
601 
602 static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
603                                        Value *&Op0, Value *&Op1,
604                                        const SimplifyQuery &Q) {
605   if (auto *CLHS = dyn_cast<Constant>(Op0)) {
606     if (auto *CRHS = dyn_cast<Constant>(Op1))
607       return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
608 
609     // Canonicalize the constant to the RHS if this is a commutative operation.
610     if (Instruction::isCommutative(Opcode))
611       std::swap(Op0, Op1);
612   }
613   return nullptr;
614 }
615 
616 /// Given operands for an Add, see if we can fold the result.
617 /// If not, this returns null.
618 static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
619                               const SimplifyQuery &Q, unsigned MaxRecurse) {
620   if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
621     return C;
622 
623   // X + undef -> undef
624   if (Q.isUndefValue(Op1))
625     return Op1;
626 
627   // X + 0 -> X
628   if (match(Op1, m_Zero()))
629     return Op0;
630 
631   // If two operands are negative, return 0.
632   if (isKnownNegation(Op0, Op1))
633     return Constant::getNullValue(Op0->getType());
634 
635   // X + (Y - X) -> Y
636   // (Y - X) + X -> Y
637   // Eg: X + -X -> 0
638   Value *Y = nullptr;
639   if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
640       match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
641     return Y;
642 
643   // X + ~X -> -1   since   ~X = -X-1
644   Type *Ty = Op0->getType();
645   if (match(Op0, m_Not(m_Specific(Op1))) ||
646       match(Op1, m_Not(m_Specific(Op0))))
647     return Constant::getAllOnesValue(Ty);
648 
649   // add nsw/nuw (xor Y, signmask), signmask --> Y
650   // The no-wrapping add guarantees that the top bit will be set by the add.
651   // Therefore, the xor must be clearing the already set sign bit of Y.
652   if ((IsNSW || IsNUW) && match(Op1, m_SignMask()) &&
653       match(Op0, m_Xor(m_Value(Y), m_SignMask())))
654     return Y;
655 
656   // add nuw %x, -1  ->  -1, because %x can only be 0.
657   if (IsNUW && match(Op1, m_AllOnes()))
658     return Op1; // Which is -1.
659 
660   /// i1 add -> xor.
661   if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
662     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
663       return V;
664 
665   // Try some generic simplifications for associative operations.
666   if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
667                                           MaxRecurse))
668     return V;
669 
670   // Threading Add over selects and phi nodes is pointless, so don't bother.
671   // Threading over the select in "A + select(cond, B, C)" means evaluating
672   // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
673   // only if B and C are equal.  If B and C are equal then (since we assume
674   // that operands have already been simplified) "select(cond, B, C)" should
675   // have been simplified to the common value of B and C already.  Analysing
676   // "A+B" and "A+C" thus gains nothing, but costs compile time.  Similarly
677   // for threading over phi nodes.
678 
679   return nullptr;
680 }
681 
682 Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
683                              const SimplifyQuery &Query) {
684   return ::SimplifyAddInst(Op0, Op1, IsNSW, IsNUW, Query, RecursionLimit);
685 }
686 
687 /// Compute the base pointer and cumulative constant offsets for V.
688 ///
689 /// This strips all constant offsets off of V, leaving it the base pointer, and
690 /// accumulates the total constant offset applied in the returned constant. It
691 /// returns 0 if V is not a pointer, and returns the constant '0' if there are
692 /// no constant offsets applied.
693 ///
694 /// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
695 /// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
696 /// folding.
697 static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
698                                                 bool AllowNonInbounds = false) {
699   assert(V->getType()->isPtrOrPtrVectorTy());
700 
701   APInt Offset = APInt::getZero(DL.getIndexTypeSizeInBits(V->getType()));
702 
703   V = V->stripAndAccumulateConstantOffsets(DL, Offset, AllowNonInbounds);
704   // As that strip may trace through `addrspacecast`, need to sext or trunc
705   // the offset calculated.
706   Type *IntIdxTy = DL.getIndexType(V->getType())->getScalarType();
707   Offset = Offset.sextOrTrunc(IntIdxTy->getIntegerBitWidth());
708 
709   Constant *OffsetIntPtr = ConstantInt::get(IntIdxTy, Offset);
710   if (VectorType *VecTy = dyn_cast<VectorType>(V->getType()))
711     return ConstantVector::getSplat(VecTy->getElementCount(), OffsetIntPtr);
712   return OffsetIntPtr;
713 }
714 
715 /// Compute the constant difference between two pointer values.
716 /// If the difference is not a constant, returns zero.
717 static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
718                                           Value *RHS) {
719   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
720   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
721 
722   // If LHS and RHS are not related via constant offsets to the same base
723   // value, there is nothing we can do here.
724   if (LHS != RHS)
725     return nullptr;
726 
727   // Otherwise, the difference of LHS - RHS can be computed as:
728   //    LHS - RHS
729   //  = (LHSOffset + Base) - (RHSOffset + Base)
730   //  = LHSOffset - RHSOffset
731   return ConstantExpr::getSub(LHSOffset, RHSOffset);
732 }
733 
734 /// Given operands for a Sub, see if we can fold the result.
735 /// If not, this returns null.
736 static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
737                               const SimplifyQuery &Q, unsigned MaxRecurse) {
738   if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
739     return C;
740 
741   // X - poison -> poison
742   // poison - X -> poison
743   if (isa<PoisonValue>(Op0) || isa<PoisonValue>(Op1))
744     return PoisonValue::get(Op0->getType());
745 
746   // X - undef -> undef
747   // undef - X -> undef
748   if (Q.isUndefValue(Op0) || Q.isUndefValue(Op1))
749     return UndefValue::get(Op0->getType());
750 
751   // X - 0 -> X
752   if (match(Op1, m_Zero()))
753     return Op0;
754 
755   // X - X -> 0
756   if (Op0 == Op1)
757     return Constant::getNullValue(Op0->getType());
758 
759   // Is this a negation?
760   if (match(Op0, m_Zero())) {
761     // 0 - X -> 0 if the sub is NUW.
762     if (isNUW)
763       return Constant::getNullValue(Op0->getType());
764 
765     KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
766     if (Known.Zero.isMaxSignedValue()) {
767       // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
768       // Op1 must be 0 because negating the minimum signed value is undefined.
769       if (isNSW)
770         return Constant::getNullValue(Op0->getType());
771 
772       // 0 - X -> X if X is 0 or the minimum signed value.
773       return Op1;
774     }
775   }
776 
777   // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
778   // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
779   Value *X = nullptr, *Y = nullptr, *Z = Op1;
780   if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
781     // See if "V === Y - Z" simplifies.
782     if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
783       // It does!  Now see if "X + V" simplifies.
784       if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
785         // It does, we successfully reassociated!
786         ++NumReassoc;
787         return W;
788       }
789     // See if "V === X - Z" simplifies.
790     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
791       // It does!  Now see if "Y + V" simplifies.
792       if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
793         // It does, we successfully reassociated!
794         ++NumReassoc;
795         return W;
796       }
797   }
798 
799   // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
800   // For example, X - (X + 1) -> -1
801   X = Op0;
802   if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
803     // See if "V === X - Y" simplifies.
804     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
805       // It does!  Now see if "V - Z" simplifies.
806       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
807         // It does, we successfully reassociated!
808         ++NumReassoc;
809         return W;
810       }
811     // See if "V === X - Z" simplifies.
812     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
813       // It does!  Now see if "V - Y" simplifies.
814       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
815         // It does, we successfully reassociated!
816         ++NumReassoc;
817         return W;
818       }
819   }
820 
821   // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
822   // For example, X - (X - Y) -> Y.
823   Z = Op0;
824   if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
825     // See if "V === Z - X" simplifies.
826     if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
827       // It does!  Now see if "V + Y" simplifies.
828       if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
829         // It does, we successfully reassociated!
830         ++NumReassoc;
831         return W;
832       }
833 
834   // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
835   if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
836       match(Op1, m_Trunc(m_Value(Y))))
837     if (X->getType() == Y->getType())
838       // See if "V === X - Y" simplifies.
839       if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
840         // It does!  Now see if "trunc V" simplifies.
841         if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
842                                         Q, MaxRecurse - 1))
843           // It does, return the simplified "trunc V".
844           return W;
845 
846   // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
847   if (match(Op0, m_PtrToInt(m_Value(X))) &&
848       match(Op1, m_PtrToInt(m_Value(Y))))
849     if (Constant *Result = computePointerDifference(Q.DL, X, Y))
850       return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
851 
852   // i1 sub -> xor.
853   if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
854     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
855       return V;
856 
857   // Threading Sub over selects and phi nodes is pointless, so don't bother.
858   // Threading over the select in "A - select(cond, B, C)" means evaluating
859   // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
860   // only if B and C are equal.  If B and C are equal then (since we assume
861   // that operands have already been simplified) "select(cond, B, C)" should
862   // have been simplified to the common value of B and C already.  Analysing
863   // "A-B" and "A-C" thus gains nothing, but costs compile time.  Similarly
864   // for threading over phi nodes.
865 
866   return nullptr;
867 }
868 
869 Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
870                              const SimplifyQuery &Q) {
871   return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
872 }
873 
874 /// Given operands for a Mul, see if we can fold the result.
875 /// If not, this returns null.
876 static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
877                               unsigned MaxRecurse) {
878   if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
879     return C;
880 
881   // X * poison -> poison
882   if (isa<PoisonValue>(Op1))
883     return Op1;
884 
885   // X * undef -> 0
886   // X * 0 -> 0
887   if (Q.isUndefValue(Op1) || match(Op1, m_Zero()))
888     return Constant::getNullValue(Op0->getType());
889 
890   // X * 1 -> X
891   if (match(Op1, m_One()))
892     return Op0;
893 
894   // (X / Y) * Y -> X if the division is exact.
895   Value *X = nullptr;
896   if (Q.IIQ.UseInstrInfo &&
897       (match(Op0,
898              m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) ||     // (X / Y) * Y
899        match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0)))))) // Y * (X / Y)
900     return X;
901 
902   // i1 mul -> and.
903   if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
904     if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
905       return V;
906 
907   // Try some generic simplifications for associative operations.
908   if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
909                                           MaxRecurse))
910     return V;
911 
912   // Mul distributes over Add. Try some generic simplifications based on this.
913   if (Value *V = expandCommutativeBinOp(Instruction::Mul, Op0, Op1,
914                                         Instruction::Add, Q, MaxRecurse))
915     return V;
916 
917   // If the operation is with the result of a select instruction, check whether
918   // operating on either branch of the select always yields the same value.
919   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
920     if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
921                                          MaxRecurse))
922       return V;
923 
924   // If the operation is with the result of a phi instruction, check whether
925   // operating on all incoming values of the phi always yields the same value.
926   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
927     if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
928                                       MaxRecurse))
929       return V;
930 
931   return nullptr;
932 }
933 
934 Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
935   return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
936 }
937 
938 /// Check for common or similar folds of integer division or integer remainder.
939 /// This applies to all 4 opcodes (sdiv/udiv/srem/urem).
940 static Value *simplifyDivRem(Instruction::BinaryOps Opcode, Value *Op0,
941                              Value *Op1, const SimplifyQuery &Q) {
942   bool IsDiv = (Opcode == Instruction::SDiv || Opcode == Instruction::UDiv);
943   bool IsSigned = (Opcode == Instruction::SDiv || Opcode == Instruction::SRem);
944 
945   Type *Ty = Op0->getType();
946 
947   // X / undef -> poison
948   // X % undef -> poison
949   if (Q.isUndefValue(Op1))
950     return PoisonValue::get(Ty);
951 
952   // X / 0 -> poison
953   // X % 0 -> poison
954   // We don't need to preserve faults!
955   if (match(Op1, m_Zero()))
956     return PoisonValue::get(Ty);
957 
958   // If any element of a constant divisor fixed width vector is zero or undef
959   // the behavior is undefined and we can fold the whole op to poison.
960   auto *Op1C = dyn_cast<Constant>(Op1);
961   auto *VTy = dyn_cast<FixedVectorType>(Ty);
962   if (Op1C && VTy) {
963     unsigned NumElts = VTy->getNumElements();
964     for (unsigned i = 0; i != NumElts; ++i) {
965       Constant *Elt = Op1C->getAggregateElement(i);
966       if (Elt && (Elt->isNullValue() || Q.isUndefValue(Elt)))
967         return PoisonValue::get(Ty);
968     }
969   }
970 
971   // poison / X -> poison
972   // poison % X -> poison
973   if (isa<PoisonValue>(Op0))
974     return Op0;
975 
976   // undef / X -> 0
977   // undef % X -> 0
978   if (Q.isUndefValue(Op0))
979     return Constant::getNullValue(Ty);
980 
981   // 0 / X -> 0
982   // 0 % X -> 0
983   if (match(Op0, m_Zero()))
984     return Constant::getNullValue(Op0->getType());
985 
986   // X / X -> 1
987   // X % X -> 0
988   if (Op0 == Op1)
989     return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
990 
991   // X / 1 -> X
992   // X % 1 -> 0
993   // If this is a boolean op (single-bit element type), we can't have
994   // division-by-zero or remainder-by-zero, so assume the divisor is 1.
995   // Similarly, if we're zero-extending a boolean divisor, then assume it's a 1.
996   Value *X;
997   if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1) ||
998       (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
999     return IsDiv ? Op0 : Constant::getNullValue(Ty);
1000 
1001   // If X * Y does not overflow, then:
1002   //   X * Y / Y -> X
1003   //   X * Y % Y -> 0
1004   if (match(Op0, m_c_Mul(m_Value(X), m_Specific(Op1)))) {
1005     auto *Mul = cast<OverflowingBinaryOperator>(Op0);
1006     // The multiplication can't overflow if it is defined not to, or if
1007     // X == A / Y for some A.
1008     if ((IsSigned && Q.IIQ.hasNoSignedWrap(Mul)) ||
1009         (!IsSigned && Q.IIQ.hasNoUnsignedWrap(Mul)) ||
1010         (IsSigned && match(X, m_SDiv(m_Value(), m_Specific(Op1)))) ||
1011         (!IsSigned && match(X, m_UDiv(m_Value(), m_Specific(Op1))))) {
1012       return IsDiv ? X : Constant::getNullValue(Op0->getType());
1013     }
1014   }
1015 
1016   return nullptr;
1017 }
1018 
1019 /// Given a predicate and two operands, return true if the comparison is true.
1020 /// This is a helper for div/rem simplification where we return some other value
1021 /// when we can prove a relationship between the operands.
1022 static bool isICmpTrue(ICmpInst::Predicate Pred, Value *LHS, Value *RHS,
1023                        const SimplifyQuery &Q, unsigned MaxRecurse) {
1024   Value *V = SimplifyICmpInst(Pred, LHS, RHS, Q, MaxRecurse);
1025   Constant *C = dyn_cast_or_null<Constant>(V);
1026   return (C && C->isAllOnesValue());
1027 }
1028 
1029 /// Return true if we can simplify X / Y to 0. Remainder can adapt that answer
1030 /// to simplify X % Y to X.
1031 static bool isDivZero(Value *X, Value *Y, const SimplifyQuery &Q,
1032                       unsigned MaxRecurse, bool IsSigned) {
1033   // Recursion is always used, so bail out at once if we already hit the limit.
1034   if (!MaxRecurse--)
1035     return false;
1036 
1037   if (IsSigned) {
1038     // |X| / |Y| --> 0
1039     //
1040     // We require that 1 operand is a simple constant. That could be extended to
1041     // 2 variables if we computed the sign bit for each.
1042     //
1043     // Make sure that a constant is not the minimum signed value because taking
1044     // the abs() of that is undefined.
1045     Type *Ty = X->getType();
1046     const APInt *C;
1047     if (match(X, m_APInt(C)) && !C->isMinSignedValue()) {
1048       // Is the variable divisor magnitude always greater than the constant
1049       // dividend magnitude?
1050       // |Y| > |C| --> Y < -abs(C) or Y > abs(C)
1051       Constant *PosDividendC = ConstantInt::get(Ty, C->abs());
1052       Constant *NegDividendC = ConstantInt::get(Ty, -C->abs());
1053       if (isICmpTrue(CmpInst::ICMP_SLT, Y, NegDividendC, Q, MaxRecurse) ||
1054           isICmpTrue(CmpInst::ICMP_SGT, Y, PosDividendC, Q, MaxRecurse))
1055         return true;
1056     }
1057     if (match(Y, m_APInt(C))) {
1058       // Special-case: we can't take the abs() of a minimum signed value. If
1059       // that's the divisor, then all we have to do is prove that the dividend
1060       // is also not the minimum signed value.
1061       if (C->isMinSignedValue())
1062         return isICmpTrue(CmpInst::ICMP_NE, X, Y, Q, MaxRecurse);
1063 
1064       // Is the variable dividend magnitude always less than the constant
1065       // divisor magnitude?
1066       // |X| < |C| --> X > -abs(C) and X < abs(C)
1067       Constant *PosDivisorC = ConstantInt::get(Ty, C->abs());
1068       Constant *NegDivisorC = ConstantInt::get(Ty, -C->abs());
1069       if (isICmpTrue(CmpInst::ICMP_SGT, X, NegDivisorC, Q, MaxRecurse) &&
1070           isICmpTrue(CmpInst::ICMP_SLT, X, PosDivisorC, Q, MaxRecurse))
1071         return true;
1072     }
1073     return false;
1074   }
1075 
1076   // IsSigned == false.
1077   // Is the dividend unsigned less than the divisor?
1078   return isICmpTrue(ICmpInst::ICMP_ULT, X, Y, Q, MaxRecurse);
1079 }
1080 
1081 /// These are simplifications common to SDiv and UDiv.
1082 static Value *simplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1083                           const SimplifyQuery &Q, unsigned MaxRecurse) {
1084   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1085     return C;
1086 
1087   if (Value *V = simplifyDivRem(Opcode, Op0, Op1, Q))
1088     return V;
1089 
1090   bool IsSigned = Opcode == Instruction::SDiv;
1091 
1092   // (X rem Y) / Y -> 0
1093   if ((IsSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1094       (!IsSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1095     return Constant::getNullValue(Op0->getType());
1096 
1097   // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1098   ConstantInt *C1, *C2;
1099   if (!IsSigned && match(Op0, m_UDiv(m_Value(), m_ConstantInt(C1))) &&
1100       match(Op1, m_ConstantInt(C2))) {
1101     bool Overflow;
1102     (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
1103     if (Overflow)
1104       return Constant::getNullValue(Op0->getType());
1105   }
1106 
1107   // If the operation is with the result of a select instruction, check whether
1108   // operating on either branch of the select always yields the same value.
1109   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1110     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1111       return V;
1112 
1113   // If the operation is with the result of a phi instruction, check whether
1114   // operating on all incoming values of the phi always yields the same value.
1115   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1116     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1117       return V;
1118 
1119   if (isDivZero(Op0, Op1, Q, MaxRecurse, IsSigned))
1120     return Constant::getNullValue(Op0->getType());
1121 
1122   return nullptr;
1123 }
1124 
1125 /// These are simplifications common to SRem and URem.
1126 static Value *simplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1127                           const SimplifyQuery &Q, unsigned MaxRecurse) {
1128   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1129     return C;
1130 
1131   if (Value *V = simplifyDivRem(Opcode, Op0, Op1, Q))
1132     return V;
1133 
1134   // (X % Y) % Y -> X % Y
1135   if ((Opcode == Instruction::SRem &&
1136        match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1137       (Opcode == Instruction::URem &&
1138        match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1139     return Op0;
1140 
1141   // (X << Y) % X -> 0
1142   if (Q.IIQ.UseInstrInfo &&
1143       ((Opcode == Instruction::SRem &&
1144         match(Op0, m_NSWShl(m_Specific(Op1), m_Value()))) ||
1145        (Opcode == Instruction::URem &&
1146         match(Op0, m_NUWShl(m_Specific(Op1), m_Value())))))
1147     return Constant::getNullValue(Op0->getType());
1148 
1149   // If the operation is with the result of a select instruction, check whether
1150   // operating on either branch of the select always yields the same value.
1151   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1152     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1153       return V;
1154 
1155   // If the operation is with the result of a phi instruction, check whether
1156   // operating on all incoming values of the phi always yields the same value.
1157   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1158     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1159       return V;
1160 
1161   // If X / Y == 0, then X % Y == X.
1162   if (isDivZero(Op0, Op1, Q, MaxRecurse, Opcode == Instruction::SRem))
1163     return Op0;
1164 
1165   return nullptr;
1166 }
1167 
1168 /// Given operands for an SDiv, see if we can fold the result.
1169 /// If not, this returns null.
1170 static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1171                                unsigned MaxRecurse) {
1172   // If two operands are negated and no signed overflow, return -1.
1173   if (isKnownNegation(Op0, Op1, /*NeedNSW=*/true))
1174     return Constant::getAllOnesValue(Op0->getType());
1175 
1176   return simplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse);
1177 }
1178 
1179 Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1180   return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1181 }
1182 
1183 /// Given operands for a UDiv, see if we can fold the result.
1184 /// If not, this returns null.
1185 static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1186                                unsigned MaxRecurse) {
1187   return simplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse);
1188 }
1189 
1190 Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1191   return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1192 }
1193 
1194 /// Given operands for an SRem, see if we can fold the result.
1195 /// If not, this returns null.
1196 static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1197                                unsigned MaxRecurse) {
1198   // If the divisor is 0, the result is undefined, so assume the divisor is -1.
1199   // srem Op0, (sext i1 X) --> srem Op0, -1 --> 0
1200   Value *X;
1201   if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
1202     return ConstantInt::getNullValue(Op0->getType());
1203 
1204   // If the two operands are negated, return 0.
1205   if (isKnownNegation(Op0, Op1))
1206     return ConstantInt::getNullValue(Op0->getType());
1207 
1208   return simplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse);
1209 }
1210 
1211 Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1212   return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1213 }
1214 
1215 /// Given operands for a URem, see if we can fold the result.
1216 /// If not, this returns null.
1217 static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1218                                unsigned MaxRecurse) {
1219   return simplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse);
1220 }
1221 
1222 Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1223   return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1224 }
1225 
1226 /// Returns true if a shift by \c Amount always yields poison.
1227 static bool isPoisonShift(Value *Amount, const SimplifyQuery &Q) {
1228   Constant *C = dyn_cast<Constant>(Amount);
1229   if (!C)
1230     return false;
1231 
1232   // X shift by undef -> poison because it may shift by the bitwidth.
1233   if (Q.isUndefValue(C))
1234     return true;
1235 
1236   // Shifting by the bitwidth or more is undefined.
1237   if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1238     if (CI->getValue().uge(CI->getType()->getScalarSizeInBits()))
1239       return true;
1240 
1241   // If all lanes of a vector shift are undefined the whole shift is.
1242   if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1243     for (unsigned I = 0,
1244                   E = cast<FixedVectorType>(C->getType())->getNumElements();
1245          I != E; ++I)
1246       if (!isPoisonShift(C->getAggregateElement(I), Q))
1247         return false;
1248     return true;
1249   }
1250 
1251   return false;
1252 }
1253 
1254 /// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1255 /// If not, this returns null.
1256 static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
1257                             Value *Op1, bool IsNSW, const SimplifyQuery &Q,
1258                             unsigned MaxRecurse) {
1259   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1260     return C;
1261 
1262   // poison shift by X -> poison
1263   if (isa<PoisonValue>(Op0))
1264     return Op0;
1265 
1266   // 0 shift by X -> 0
1267   if (match(Op0, m_Zero()))
1268     return Constant::getNullValue(Op0->getType());
1269 
1270   // X shift by 0 -> X
1271   // Shift-by-sign-extended bool must be shift-by-0 because shift-by-all-ones
1272   // would be poison.
1273   Value *X;
1274   if (match(Op1, m_Zero()) ||
1275       (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
1276     return Op0;
1277 
1278   // Fold undefined shifts.
1279   if (isPoisonShift(Op1, Q))
1280     return PoisonValue::get(Op0->getType());
1281 
1282   // If the operation is with the result of a select instruction, check whether
1283   // operating on either branch of the select always yields the same value.
1284   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1285     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1286       return V;
1287 
1288   // If the operation is with the result of a phi instruction, check whether
1289   // operating on all incoming values of the phi always yields the same value.
1290   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1291     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1292       return V;
1293 
1294   // If any bits in the shift amount make that value greater than or equal to
1295   // the number of bits in the type, the shift is undefined.
1296   KnownBits KnownAmt = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1297   if (KnownAmt.getMinValue().uge(KnownAmt.getBitWidth()))
1298     return PoisonValue::get(Op0->getType());
1299 
1300   // If all valid bits in the shift amount are known zero, the first operand is
1301   // unchanged.
1302   unsigned NumValidShiftBits = Log2_32_Ceil(KnownAmt.getBitWidth());
1303   if (KnownAmt.countMinTrailingZeros() >= NumValidShiftBits)
1304     return Op0;
1305 
1306   // Check for nsw shl leading to a poison value.
1307   if (IsNSW) {
1308     assert(Opcode == Instruction::Shl && "Expected shl for nsw instruction");
1309     KnownBits KnownVal = computeKnownBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1310     KnownBits KnownShl = KnownBits::shl(KnownVal, KnownAmt);
1311 
1312     if (KnownVal.Zero.isSignBitSet())
1313       KnownShl.Zero.setSignBit();
1314     if (KnownVal.One.isSignBitSet())
1315       KnownShl.One.setSignBit();
1316 
1317     if (KnownShl.hasConflict())
1318       return PoisonValue::get(Op0->getType());
1319   }
1320 
1321   return nullptr;
1322 }
1323 
1324 /// Given operands for an Shl, LShr or AShr, see if we can
1325 /// fold the result.  If not, this returns null.
1326 static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
1327                                  Value *Op1, bool isExact, const SimplifyQuery &Q,
1328                                  unsigned MaxRecurse) {
1329   if (Value *V =
1330           SimplifyShift(Opcode, Op0, Op1, /*IsNSW*/ false, Q, MaxRecurse))
1331     return V;
1332 
1333   // X >> X -> 0
1334   if (Op0 == Op1)
1335     return Constant::getNullValue(Op0->getType());
1336 
1337   // undef >> X -> 0
1338   // undef >> X -> undef (if it's exact)
1339   if (Q.isUndefValue(Op0))
1340     return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1341 
1342   // The low bit cannot be shifted out of an exact shift if it is set.
1343   if (isExact) {
1344     KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
1345     if (Op0Known.One[0])
1346       return Op0;
1347   }
1348 
1349   return nullptr;
1350 }
1351 
1352 /// Given operands for an Shl, see if we can fold the result.
1353 /// If not, this returns null.
1354 static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1355                               const SimplifyQuery &Q, unsigned MaxRecurse) {
1356   if (Value *V =
1357           SimplifyShift(Instruction::Shl, Op0, Op1, isNSW, Q, MaxRecurse))
1358     return V;
1359 
1360   // undef << X -> 0
1361   // undef << X -> undef if (if it's NSW/NUW)
1362   if (Q.isUndefValue(Op0))
1363     return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
1364 
1365   // (X >> A) << A -> X
1366   Value *X;
1367   if (Q.IIQ.UseInstrInfo &&
1368       match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
1369     return X;
1370 
1371   // shl nuw i8 C, %x  ->  C  iff C has sign bit set.
1372   if (isNUW && match(Op0, m_Negative()))
1373     return Op0;
1374   // NOTE: could use computeKnownBits() / LazyValueInfo,
1375   // but the cost-benefit analysis suggests it isn't worth it.
1376 
1377   return nullptr;
1378 }
1379 
1380 Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1381                              const SimplifyQuery &Q) {
1382   return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1383 }
1384 
1385 /// Given operands for an LShr, see if we can fold the result.
1386 /// If not, this returns null.
1387 static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1388                                const SimplifyQuery &Q, unsigned MaxRecurse) {
1389   if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1390                                     MaxRecurse))
1391       return V;
1392 
1393   // (X << A) >> A -> X
1394   Value *X;
1395   if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
1396     return X;
1397 
1398   // ((X << A) | Y) >> A -> X  if effective width of Y is not larger than A.
1399   // We can return X as we do in the above case since OR alters no bits in X.
1400   // SimplifyDemandedBits in InstCombine can do more general optimization for
1401   // bit manipulation. This pattern aims to provide opportunities for other
1402   // optimizers by supporting a simple but common case in InstSimplify.
1403   Value *Y;
1404   const APInt *ShRAmt, *ShLAmt;
1405   if (match(Op1, m_APInt(ShRAmt)) &&
1406       match(Op0, m_c_Or(m_NUWShl(m_Value(X), m_APInt(ShLAmt)), m_Value(Y))) &&
1407       *ShRAmt == *ShLAmt) {
1408     const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1409     const unsigned EffWidthY = YKnown.countMaxActiveBits();
1410     if (ShRAmt->uge(EffWidthY))
1411       return X;
1412   }
1413 
1414   return nullptr;
1415 }
1416 
1417 Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1418                               const SimplifyQuery &Q) {
1419   return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1420 }
1421 
1422 /// Given operands for an AShr, see if we can fold the result.
1423 /// If not, this returns null.
1424 static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1425                                const SimplifyQuery &Q, unsigned MaxRecurse) {
1426   if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1427                                     MaxRecurse))
1428     return V;
1429 
1430   // -1 >>a X --> -1
1431   // (-1 << X) a>> X --> -1
1432   // Do not return Op0 because it may contain undef elements if it's a vector.
1433   if (match(Op0, m_AllOnes()) ||
1434       match(Op0, m_Shl(m_AllOnes(), m_Specific(Op1))))
1435     return Constant::getAllOnesValue(Op0->getType());
1436 
1437   // (X << A) >> A -> X
1438   Value *X;
1439   if (Q.IIQ.UseInstrInfo && match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
1440     return X;
1441 
1442   // Arithmetic shifting an all-sign-bit value is a no-op.
1443   unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1444   if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1445     return Op0;
1446 
1447   return nullptr;
1448 }
1449 
1450 Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1451                               const SimplifyQuery &Q) {
1452   return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1453 }
1454 
1455 /// Commuted variants are assumed to be handled by calling this function again
1456 /// with the parameters swapped.
1457 static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1458                                          ICmpInst *UnsignedICmp, bool IsAnd,
1459                                          const SimplifyQuery &Q) {
1460   Value *X, *Y;
1461 
1462   ICmpInst::Predicate EqPred;
1463   if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1464       !ICmpInst::isEquality(EqPred))
1465     return nullptr;
1466 
1467   ICmpInst::Predicate UnsignedPred;
1468 
1469   Value *A, *B;
1470   // Y = (A - B);
1471   if (match(Y, m_Sub(m_Value(A), m_Value(B)))) {
1472     if (match(UnsignedICmp,
1473               m_c_ICmp(UnsignedPred, m_Specific(A), m_Specific(B))) &&
1474         ICmpInst::isUnsigned(UnsignedPred)) {
1475       // A >=/<= B || (A - B) != 0  <-->  true
1476       if ((UnsignedPred == ICmpInst::ICMP_UGE ||
1477            UnsignedPred == ICmpInst::ICMP_ULE) &&
1478           EqPred == ICmpInst::ICMP_NE && !IsAnd)
1479         return ConstantInt::getTrue(UnsignedICmp->getType());
1480       // A </> B && (A - B) == 0  <-->  false
1481       if ((UnsignedPred == ICmpInst::ICMP_ULT ||
1482            UnsignedPred == ICmpInst::ICMP_UGT) &&
1483           EqPred == ICmpInst::ICMP_EQ && IsAnd)
1484         return ConstantInt::getFalse(UnsignedICmp->getType());
1485 
1486       // A </> B && (A - B) != 0  <-->  A </> B
1487       // A </> B || (A - B) != 0  <-->  (A - B) != 0
1488       if (EqPred == ICmpInst::ICMP_NE && (UnsignedPred == ICmpInst::ICMP_ULT ||
1489                                           UnsignedPred == ICmpInst::ICMP_UGT))
1490         return IsAnd ? UnsignedICmp : ZeroICmp;
1491 
1492       // A <=/>= B && (A - B) == 0  <-->  (A - B) == 0
1493       // A <=/>= B || (A - B) == 0  <-->  A <=/>= B
1494       if (EqPred == ICmpInst::ICMP_EQ && (UnsignedPred == ICmpInst::ICMP_ULE ||
1495                                           UnsignedPred == ICmpInst::ICMP_UGE))
1496         return IsAnd ? ZeroICmp : UnsignedICmp;
1497     }
1498 
1499     // Given  Y = (A - B)
1500     //   Y >= A && Y != 0  --> Y >= A  iff B != 0
1501     //   Y <  A || Y == 0  --> Y <  A  iff B != 0
1502     if (match(UnsignedICmp,
1503               m_c_ICmp(UnsignedPred, m_Specific(Y), m_Specific(A)))) {
1504       if (UnsignedPred == ICmpInst::ICMP_UGE && IsAnd &&
1505           EqPred == ICmpInst::ICMP_NE &&
1506           isKnownNonZero(B, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
1507         return UnsignedICmp;
1508       if (UnsignedPred == ICmpInst::ICMP_ULT && !IsAnd &&
1509           EqPred == ICmpInst::ICMP_EQ &&
1510           isKnownNonZero(B, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
1511         return UnsignedICmp;
1512     }
1513   }
1514 
1515   if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1516       ICmpInst::isUnsigned(UnsignedPred))
1517     ;
1518   else if (match(UnsignedICmp,
1519                  m_ICmp(UnsignedPred, m_Specific(Y), m_Value(X))) &&
1520            ICmpInst::isUnsigned(UnsignedPred))
1521     UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1522   else
1523     return nullptr;
1524 
1525   // X > Y && Y == 0  -->  Y == 0  iff X != 0
1526   // X > Y || Y == 0  -->  X > Y   iff X != 0
1527   if (UnsignedPred == ICmpInst::ICMP_UGT && EqPred == ICmpInst::ICMP_EQ &&
1528       isKnownNonZero(X, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
1529     return IsAnd ? ZeroICmp : UnsignedICmp;
1530 
1531   // X <= Y && Y != 0  -->  X <= Y  iff X != 0
1532   // X <= Y || Y != 0  -->  Y != 0  iff X != 0
1533   if (UnsignedPred == ICmpInst::ICMP_ULE && EqPred == ICmpInst::ICMP_NE &&
1534       isKnownNonZero(X, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT))
1535     return IsAnd ? UnsignedICmp : ZeroICmp;
1536 
1537   // The transforms below here are expected to be handled more generally with
1538   // simplifyAndOrOfICmpsWithLimitConst() or in InstCombine's
1539   // foldAndOrOfICmpsWithConstEq(). If we are looking to trim optimizer overlap,
1540   // these are candidates for removal.
1541 
1542   // X < Y && Y != 0  -->  X < Y
1543   // X < Y || Y != 0  -->  Y != 0
1544   if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1545     return IsAnd ? UnsignedICmp : ZeroICmp;
1546 
1547   // X >= Y && Y == 0  -->  Y == 0
1548   // X >= Y || Y == 0  -->  X >= Y
1549   if (UnsignedPred == ICmpInst::ICMP_UGE && EqPred == ICmpInst::ICMP_EQ)
1550     return IsAnd ? ZeroICmp : UnsignedICmp;
1551 
1552   // X < Y && Y == 0  -->  false
1553   if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1554       IsAnd)
1555     return getFalse(UnsignedICmp->getType());
1556 
1557   // X >= Y || Y != 0  -->  true
1558   if (UnsignedPred == ICmpInst::ICMP_UGE && EqPred == ICmpInst::ICMP_NE &&
1559       !IsAnd)
1560     return getTrue(UnsignedICmp->getType());
1561 
1562   return nullptr;
1563 }
1564 
1565 /// Commuted variants are assumed to be handled by calling this function again
1566 /// with the parameters swapped.
1567 static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1568   ICmpInst::Predicate Pred0, Pred1;
1569   Value *A ,*B;
1570   if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1571       !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1572     return nullptr;
1573 
1574   // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1575   // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1576   // can eliminate Op1 from this 'and'.
1577   if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1578     return Op0;
1579 
1580   // Check for any combination of predicates that are guaranteed to be disjoint.
1581   if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1582       (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1583       (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1584       (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1585     return getFalse(Op0->getType());
1586 
1587   return nullptr;
1588 }
1589 
1590 /// Commuted variants are assumed to be handled by calling this function again
1591 /// with the parameters swapped.
1592 static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1593   ICmpInst::Predicate Pred0, Pred1;
1594   Value *A ,*B;
1595   if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1596       !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1597     return nullptr;
1598 
1599   // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1600   // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1601   // can eliminate Op0 from this 'or'.
1602   if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1603     return Op1;
1604 
1605   // Check for any combination of predicates that cover the entire range of
1606   // possibilities.
1607   if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1608       (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1609       (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1610       (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1611     return getTrue(Op0->getType());
1612 
1613   return nullptr;
1614 }
1615 
1616 /// Test if a pair of compares with a shared operand and 2 constants has an
1617 /// empty set intersection, full set union, or if one compare is a superset of
1618 /// the other.
1619 static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1620                                                 bool IsAnd) {
1621   // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1622   if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1623     return nullptr;
1624 
1625   const APInt *C0, *C1;
1626   if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1627       !match(Cmp1->getOperand(1), m_APInt(C1)))
1628     return nullptr;
1629 
1630   auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1631   auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1632 
1633   // For and-of-compares, check if the intersection is empty:
1634   // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1635   if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1636     return getFalse(Cmp0->getType());
1637 
1638   // For or-of-compares, check if the union is full:
1639   // (icmp X, C0) || (icmp X, C1) --> full set --> true
1640   if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1641     return getTrue(Cmp0->getType());
1642 
1643   // Is one range a superset of the other?
1644   // If this is and-of-compares, take the smaller set:
1645   // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1646   // If this is or-of-compares, take the larger set:
1647   // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1648   if (Range0.contains(Range1))
1649     return IsAnd ? Cmp1 : Cmp0;
1650   if (Range1.contains(Range0))
1651     return IsAnd ? Cmp0 : Cmp1;
1652 
1653   return nullptr;
1654 }
1655 
1656 static Value *simplifyAndOrOfICmpsWithZero(ICmpInst *Cmp0, ICmpInst *Cmp1,
1657                                            bool IsAnd) {
1658   ICmpInst::Predicate P0 = Cmp0->getPredicate(), P1 = Cmp1->getPredicate();
1659   if (!match(Cmp0->getOperand(1), m_Zero()) ||
1660       !match(Cmp1->getOperand(1), m_Zero()) || P0 != P1)
1661     return nullptr;
1662 
1663   if ((IsAnd && P0 != ICmpInst::ICMP_NE) || (!IsAnd && P1 != ICmpInst::ICMP_EQ))
1664     return nullptr;
1665 
1666   // We have either "(X == 0 || Y == 0)" or "(X != 0 && Y != 0)".
1667   Value *X = Cmp0->getOperand(0);
1668   Value *Y = Cmp1->getOperand(0);
1669 
1670   // If one of the compares is a masked version of a (not) null check, then
1671   // that compare implies the other, so we eliminate the other. Optionally, look
1672   // through a pointer-to-int cast to match a null check of a pointer type.
1673 
1674   // (X == 0) || (([ptrtoint] X & ?) == 0) --> ([ptrtoint] X & ?) == 0
1675   // (X == 0) || ((? & [ptrtoint] X) == 0) --> (? & [ptrtoint] X) == 0
1676   // (X != 0) && (([ptrtoint] X & ?) != 0) --> ([ptrtoint] X & ?) != 0
1677   // (X != 0) && ((? & [ptrtoint] X) != 0) --> (? & [ptrtoint] X) != 0
1678   if (match(Y, m_c_And(m_Specific(X), m_Value())) ||
1679       match(Y, m_c_And(m_PtrToInt(m_Specific(X)), m_Value())))
1680     return Cmp1;
1681 
1682   // (([ptrtoint] Y & ?) == 0) || (Y == 0) --> ([ptrtoint] Y & ?) == 0
1683   // ((? & [ptrtoint] Y) == 0) || (Y == 0) --> (? & [ptrtoint] Y) == 0
1684   // (([ptrtoint] Y & ?) != 0) && (Y != 0) --> ([ptrtoint] Y & ?) != 0
1685   // ((? & [ptrtoint] Y) != 0) && (Y != 0) --> (? & [ptrtoint] Y) != 0
1686   if (match(X, m_c_And(m_Specific(Y), m_Value())) ||
1687       match(X, m_c_And(m_PtrToInt(m_Specific(Y)), m_Value())))
1688     return Cmp0;
1689 
1690   return nullptr;
1691 }
1692 
1693 static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1,
1694                                         const InstrInfoQuery &IIQ) {
1695   // (icmp (add V, C0), C1) & (icmp V, C0)
1696   ICmpInst::Predicate Pred0, Pred1;
1697   const APInt *C0, *C1;
1698   Value *V;
1699   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1700     return nullptr;
1701 
1702   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1703     return nullptr;
1704 
1705   auto *AddInst = cast<OverflowingBinaryOperator>(Op0->getOperand(0));
1706   if (AddInst->getOperand(1) != Op1->getOperand(1))
1707     return nullptr;
1708 
1709   Type *ITy = Op0->getType();
1710   bool isNSW = IIQ.hasNoSignedWrap(AddInst);
1711   bool isNUW = IIQ.hasNoUnsignedWrap(AddInst);
1712 
1713   const APInt Delta = *C1 - *C0;
1714   if (C0->isStrictlyPositive()) {
1715     if (Delta == 2) {
1716       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1717         return getFalse(ITy);
1718       if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1719         return getFalse(ITy);
1720     }
1721     if (Delta == 1) {
1722       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1723         return getFalse(ITy);
1724       if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1725         return getFalse(ITy);
1726     }
1727   }
1728   if (C0->getBoolValue() && isNUW) {
1729     if (Delta == 2)
1730       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1731         return getFalse(ITy);
1732     if (Delta == 1)
1733       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1734         return getFalse(ITy);
1735   }
1736 
1737   return nullptr;
1738 }
1739 
1740 /// Try to eliminate compares with signed or unsigned min/max constants.
1741 static Value *simplifyAndOrOfICmpsWithLimitConst(ICmpInst *Cmp0, ICmpInst *Cmp1,
1742                                                  bool IsAnd) {
1743   // Canonicalize an equality compare as Cmp0.
1744   if (Cmp1->isEquality())
1745     std::swap(Cmp0, Cmp1);
1746   if (!Cmp0->isEquality())
1747     return nullptr;
1748 
1749   // The non-equality compare must include a common operand (X). Canonicalize
1750   // the common operand as operand 0 (the predicate is swapped if the common
1751   // operand was operand 1).
1752   ICmpInst::Predicate Pred0 = Cmp0->getPredicate();
1753   Value *X = Cmp0->getOperand(0);
1754   ICmpInst::Predicate Pred1;
1755   bool HasNotOp = match(Cmp1, m_c_ICmp(Pred1, m_Not(m_Specific(X)), m_Value()));
1756   if (!HasNotOp && !match(Cmp1, m_c_ICmp(Pred1, m_Specific(X), m_Value())))
1757     return nullptr;
1758   if (ICmpInst::isEquality(Pred1))
1759     return nullptr;
1760 
1761   // The equality compare must be against a constant. Flip bits if we matched
1762   // a bitwise not. Convert a null pointer constant to an integer zero value.
1763   APInt MinMaxC;
1764   const APInt *C;
1765   if (match(Cmp0->getOperand(1), m_APInt(C)))
1766     MinMaxC = HasNotOp ? ~*C : *C;
1767   else if (isa<ConstantPointerNull>(Cmp0->getOperand(1)))
1768     MinMaxC = APInt::getZero(8);
1769   else
1770     return nullptr;
1771 
1772   // DeMorganize if this is 'or': P0 || P1 --> !P0 && !P1.
1773   if (!IsAnd) {
1774     Pred0 = ICmpInst::getInversePredicate(Pred0);
1775     Pred1 = ICmpInst::getInversePredicate(Pred1);
1776   }
1777 
1778   // Normalize to unsigned compare and unsigned min/max value.
1779   // Example for 8-bit: -128 + 128 -> 0; 127 + 128 -> 255
1780   if (ICmpInst::isSigned(Pred1)) {
1781     Pred1 = ICmpInst::getUnsignedPredicate(Pred1);
1782     MinMaxC += APInt::getSignedMinValue(MinMaxC.getBitWidth());
1783   }
1784 
1785   // (X != MAX) && (X < Y) --> X < Y
1786   // (X == MAX) || (X >= Y) --> X >= Y
1787   if (MinMaxC.isMaxValue())
1788     if (Pred0 == ICmpInst::ICMP_NE && Pred1 == ICmpInst::ICMP_ULT)
1789       return Cmp1;
1790 
1791   // (X != MIN) && (X > Y) -->  X > Y
1792   // (X == MIN) || (X <= Y) --> X <= Y
1793   if (MinMaxC.isMinValue())
1794     if (Pred0 == ICmpInst::ICMP_NE && Pred1 == ICmpInst::ICMP_UGT)
1795       return Cmp1;
1796 
1797   return nullptr;
1798 }
1799 
1800 static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1,
1801                                  const SimplifyQuery &Q) {
1802   if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true, Q))
1803     return X;
1804   if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true, Q))
1805     return X;
1806 
1807   if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1808     return X;
1809   if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
1810     return X;
1811 
1812   if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
1813     return X;
1814 
1815   if (Value *X = simplifyAndOrOfICmpsWithLimitConst(Op0, Op1, true))
1816     return X;
1817 
1818   if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, true))
1819     return X;
1820 
1821   if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1, Q.IIQ))
1822     return X;
1823   if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0, Q.IIQ))
1824     return X;
1825 
1826   return nullptr;
1827 }
1828 
1829 static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1,
1830                                        const InstrInfoQuery &IIQ) {
1831   // (icmp (add V, C0), C1) | (icmp V, C0)
1832   ICmpInst::Predicate Pred0, Pred1;
1833   const APInt *C0, *C1;
1834   Value *V;
1835   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1836     return nullptr;
1837 
1838   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1839     return nullptr;
1840 
1841   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1842   if (AddInst->getOperand(1) != Op1->getOperand(1))
1843     return nullptr;
1844 
1845   Type *ITy = Op0->getType();
1846   bool isNSW = IIQ.hasNoSignedWrap(AddInst);
1847   bool isNUW = IIQ.hasNoUnsignedWrap(AddInst);
1848 
1849   const APInt Delta = *C1 - *C0;
1850   if (C0->isStrictlyPositive()) {
1851     if (Delta == 2) {
1852       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1853         return getTrue(ITy);
1854       if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1855         return getTrue(ITy);
1856     }
1857     if (Delta == 1) {
1858       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1859         return getTrue(ITy);
1860       if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1861         return getTrue(ITy);
1862     }
1863   }
1864   if (C0->getBoolValue() && isNUW) {
1865     if (Delta == 2)
1866       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1867         return getTrue(ITy);
1868     if (Delta == 1)
1869       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1870         return getTrue(ITy);
1871   }
1872 
1873   return nullptr;
1874 }
1875 
1876 static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1,
1877                                 const SimplifyQuery &Q) {
1878   if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false, Q))
1879     return X;
1880   if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false, Q))
1881     return X;
1882 
1883   if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1884     return X;
1885   if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1886     return X;
1887 
1888   if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1889     return X;
1890 
1891   if (Value *X = simplifyAndOrOfICmpsWithLimitConst(Op0, Op1, false))
1892     return X;
1893 
1894   if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, false))
1895     return X;
1896 
1897   if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1, Q.IIQ))
1898     return X;
1899   if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0, Q.IIQ))
1900     return X;
1901 
1902   return nullptr;
1903 }
1904 
1905 static Value *simplifyAndOrOfFCmps(const TargetLibraryInfo *TLI,
1906                                    FCmpInst *LHS, FCmpInst *RHS, bool IsAnd) {
1907   Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
1908   Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
1909   if (LHS0->getType() != RHS0->getType())
1910     return nullptr;
1911 
1912   FCmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1913   if ((PredL == FCmpInst::FCMP_ORD && PredR == FCmpInst::FCMP_ORD && IsAnd) ||
1914       (PredL == FCmpInst::FCMP_UNO && PredR == FCmpInst::FCMP_UNO && !IsAnd)) {
1915     // (fcmp ord NNAN, X) & (fcmp ord X, Y) --> fcmp ord X, Y
1916     // (fcmp ord NNAN, X) & (fcmp ord Y, X) --> fcmp ord Y, X
1917     // (fcmp ord X, NNAN) & (fcmp ord X, Y) --> fcmp ord X, Y
1918     // (fcmp ord X, NNAN) & (fcmp ord Y, X) --> fcmp ord Y, X
1919     // (fcmp uno NNAN, X) | (fcmp uno X, Y) --> fcmp uno X, Y
1920     // (fcmp uno NNAN, X) | (fcmp uno Y, X) --> fcmp uno Y, X
1921     // (fcmp uno X, NNAN) | (fcmp uno X, Y) --> fcmp uno X, Y
1922     // (fcmp uno X, NNAN) | (fcmp uno Y, X) --> fcmp uno Y, X
1923     if ((isKnownNeverNaN(LHS0, TLI) && (LHS1 == RHS0 || LHS1 == RHS1)) ||
1924         (isKnownNeverNaN(LHS1, TLI) && (LHS0 == RHS0 || LHS0 == RHS1)))
1925       return RHS;
1926 
1927     // (fcmp ord X, Y) & (fcmp ord NNAN, X) --> fcmp ord X, Y
1928     // (fcmp ord Y, X) & (fcmp ord NNAN, X) --> fcmp ord Y, X
1929     // (fcmp ord X, Y) & (fcmp ord X, NNAN) --> fcmp ord X, Y
1930     // (fcmp ord Y, X) & (fcmp ord X, NNAN) --> fcmp ord Y, X
1931     // (fcmp uno X, Y) | (fcmp uno NNAN, X) --> fcmp uno X, Y
1932     // (fcmp uno Y, X) | (fcmp uno NNAN, X) --> fcmp uno Y, X
1933     // (fcmp uno X, Y) | (fcmp uno X, NNAN) --> fcmp uno X, Y
1934     // (fcmp uno Y, X) | (fcmp uno X, NNAN) --> fcmp uno Y, X
1935     if ((isKnownNeverNaN(RHS0, TLI) && (RHS1 == LHS0 || RHS1 == LHS1)) ||
1936         (isKnownNeverNaN(RHS1, TLI) && (RHS0 == LHS0 || RHS0 == LHS1)))
1937       return LHS;
1938   }
1939 
1940   return nullptr;
1941 }
1942 
1943 static Value *simplifyAndOrOfCmps(const SimplifyQuery &Q,
1944                                   Value *Op0, Value *Op1, bool IsAnd) {
1945   // Look through casts of the 'and' operands to find compares.
1946   auto *Cast0 = dyn_cast<CastInst>(Op0);
1947   auto *Cast1 = dyn_cast<CastInst>(Op1);
1948   if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1949       Cast0->getSrcTy() == Cast1->getSrcTy()) {
1950     Op0 = Cast0->getOperand(0);
1951     Op1 = Cast1->getOperand(0);
1952   }
1953 
1954   Value *V = nullptr;
1955   auto *ICmp0 = dyn_cast<ICmpInst>(Op0);
1956   auto *ICmp1 = dyn_cast<ICmpInst>(Op1);
1957   if (ICmp0 && ICmp1)
1958     V = IsAnd ? simplifyAndOfICmps(ICmp0, ICmp1, Q)
1959               : simplifyOrOfICmps(ICmp0, ICmp1, Q);
1960 
1961   auto *FCmp0 = dyn_cast<FCmpInst>(Op0);
1962   auto *FCmp1 = dyn_cast<FCmpInst>(Op1);
1963   if (FCmp0 && FCmp1)
1964     V = simplifyAndOrOfFCmps(Q.TLI, FCmp0, FCmp1, IsAnd);
1965 
1966   if (!V)
1967     return nullptr;
1968   if (!Cast0)
1969     return V;
1970 
1971   // If we looked through casts, we can only handle a constant simplification
1972   // because we are not allowed to create a cast instruction here.
1973   if (auto *C = dyn_cast<Constant>(V))
1974     return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
1975 
1976   return nullptr;
1977 }
1978 
1979 /// Given a bitwise logic op, check if the operands are add/sub with a common
1980 /// source value and inverted constant (identity: C - X -> ~(X + ~C)).
1981 static Value *simplifyLogicOfAddSub(Value *Op0, Value *Op1,
1982                                     Instruction::BinaryOps Opcode) {
1983   assert(Op0->getType() == Op1->getType() && "Mismatched binop types");
1984   assert(BinaryOperator::isBitwiseLogicOp(Opcode) && "Expected logic op");
1985   Value *X;
1986   Constant *C1, *C2;
1987   if ((match(Op0, m_Add(m_Value(X), m_Constant(C1))) &&
1988        match(Op1, m_Sub(m_Constant(C2), m_Specific(X)))) ||
1989       (match(Op1, m_Add(m_Value(X), m_Constant(C1))) &&
1990        match(Op0, m_Sub(m_Constant(C2), m_Specific(X))))) {
1991     if (ConstantExpr::getNot(C1) == C2) {
1992       // (X + C) & (~C - X) --> (X + C) & ~(X + C) --> 0
1993       // (X + C) | (~C - X) --> (X + C) | ~(X + C) --> -1
1994       // (X + C) ^ (~C - X) --> (X + C) ^ ~(X + C) --> -1
1995       Type *Ty = Op0->getType();
1996       return Opcode == Instruction::And ? ConstantInt::getNullValue(Ty)
1997                                         : ConstantInt::getAllOnesValue(Ty);
1998     }
1999   }
2000   return nullptr;
2001 }
2002 
2003 /// Given operands for an And, see if we can fold the result.
2004 /// If not, this returns null.
2005 static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
2006                               unsigned MaxRecurse) {
2007   if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
2008     return C;
2009 
2010   // X & poison -> poison
2011   if (isa<PoisonValue>(Op1))
2012     return Op1;
2013 
2014   // X & undef -> 0
2015   if (Q.isUndefValue(Op1))
2016     return Constant::getNullValue(Op0->getType());
2017 
2018   // X & X = X
2019   if (Op0 == Op1)
2020     return Op0;
2021 
2022   // X & 0 = 0
2023   if (match(Op1, m_Zero()))
2024     return Constant::getNullValue(Op0->getType());
2025 
2026   // X & -1 = X
2027   if (match(Op1, m_AllOnes()))
2028     return Op0;
2029 
2030   // A & ~A  =  ~A & A  =  0
2031   if (match(Op0, m_Not(m_Specific(Op1))) ||
2032       match(Op1, m_Not(m_Specific(Op0))))
2033     return Constant::getNullValue(Op0->getType());
2034 
2035   // (A | ?) & A = A
2036   if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
2037     return Op1;
2038 
2039   // A & (A | ?) = A
2040   if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
2041     return Op0;
2042 
2043   // (X | Y) & (X | ~Y) --> X (commuted 8 ways)
2044   Value *X, *Y;
2045   if (match(Op0, m_c_Or(m_Value(X), m_Not(m_Value(Y)))) &&
2046       match(Op1, m_c_Or(m_Deferred(X), m_Deferred(Y))))
2047     return X;
2048   if (match(Op1, m_c_Or(m_Value(X), m_Not(m_Value(Y)))) &&
2049       match(Op0, m_c_Or(m_Deferred(X), m_Deferred(Y))))
2050     return X;
2051 
2052   if (Value *V = simplifyLogicOfAddSub(Op0, Op1, Instruction::And))
2053     return V;
2054 
2055   // A mask that only clears known zeros of a shifted value is a no-op.
2056   const APInt *Mask;
2057   const APInt *ShAmt;
2058   if (match(Op1, m_APInt(Mask))) {
2059     // If all bits in the inverted and shifted mask are clear:
2060     // and (shl X, ShAmt), Mask --> shl X, ShAmt
2061     if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
2062         (~(*Mask)).lshr(*ShAmt).isZero())
2063       return Op0;
2064 
2065     // If all bits in the inverted and shifted mask are clear:
2066     // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
2067     if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
2068         (~(*Mask)).shl(*ShAmt).isZero())
2069       return Op0;
2070   }
2071 
2072   // If we have a multiplication overflow check that is being 'and'ed with a
2073   // check that one of the multipliers is not zero, we can omit the 'and', and
2074   // only keep the overflow check.
2075   if (isCheckForZeroAndMulWithOverflow(Op0, Op1, true))
2076     return Op1;
2077   if (isCheckForZeroAndMulWithOverflow(Op1, Op0, true))
2078     return Op0;
2079 
2080   // A & (-A) = A if A is a power of two or zero.
2081   if (match(Op0, m_Neg(m_Specific(Op1))) ||
2082       match(Op1, m_Neg(m_Specific(Op0)))) {
2083     if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
2084                                Q.DT))
2085       return Op0;
2086     if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
2087                                Q.DT))
2088       return Op1;
2089   }
2090 
2091   // This is a similar pattern used for checking if a value is a power-of-2:
2092   // (A - 1) & A --> 0 (if A is a power-of-2 or 0)
2093   // A & (A - 1) --> 0 (if A is a power-of-2 or 0)
2094   if (match(Op0, m_Add(m_Specific(Op1), m_AllOnes())) &&
2095       isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI, Q.DT))
2096     return Constant::getNullValue(Op1->getType());
2097   if (match(Op1, m_Add(m_Specific(Op0), m_AllOnes())) &&
2098       isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI, Q.DT))
2099     return Constant::getNullValue(Op0->getType());
2100 
2101   if (Value *V = simplifyAndOrOfCmps(Q, Op0, Op1, true))
2102     return V;
2103 
2104   // Try some generic simplifications for associative operations.
2105   if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
2106                                           MaxRecurse))
2107     return V;
2108 
2109   // And distributes over Or.  Try some generic simplifications based on this.
2110   if (Value *V = expandCommutativeBinOp(Instruction::And, Op0, Op1,
2111                                         Instruction::Or, Q, MaxRecurse))
2112     return V;
2113 
2114   // And distributes over Xor.  Try some generic simplifications based on this.
2115   if (Value *V = expandCommutativeBinOp(Instruction::And, Op0, Op1,
2116                                         Instruction::Xor, Q, MaxRecurse))
2117     return V;
2118 
2119   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1)) {
2120     if (Op0->getType()->isIntOrIntVectorTy(1)) {
2121       // A & (A && B) -> A && B
2122       if (match(Op1, m_Select(m_Specific(Op0), m_Value(), m_Zero())))
2123         return Op1;
2124       else if (match(Op0, m_Select(m_Specific(Op1), m_Value(), m_Zero())))
2125         return Op0;
2126     }
2127     // If the operation is with the result of a select instruction, check
2128     // whether operating on either branch of the select always yields the same
2129     // value.
2130     if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
2131                                          MaxRecurse))
2132       return V;
2133   }
2134 
2135   // If the operation is with the result of a phi instruction, check whether
2136   // operating on all incoming values of the phi always yields the same value.
2137   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
2138     if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
2139                                       MaxRecurse))
2140       return V;
2141 
2142   // Assuming the effective width of Y is not larger than A, i.e. all bits
2143   // from X and Y are disjoint in (X << A) | Y,
2144   // if the mask of this AND op covers all bits of X or Y, while it covers
2145   // no bits from the other, we can bypass this AND op. E.g.,
2146   // ((X << A) | Y) & Mask -> Y,
2147   //     if Mask = ((1 << effective_width_of(Y)) - 1)
2148   // ((X << A) | Y) & Mask -> X << A,
2149   //     if Mask = ((1 << effective_width_of(X)) - 1) << A
2150   // SimplifyDemandedBits in InstCombine can optimize the general case.
2151   // This pattern aims to help other passes for a common case.
2152   Value *XShifted;
2153   if (match(Op1, m_APInt(Mask)) &&
2154       match(Op0, m_c_Or(m_CombineAnd(m_NUWShl(m_Value(X), m_APInt(ShAmt)),
2155                                      m_Value(XShifted)),
2156                         m_Value(Y)))) {
2157     const unsigned Width = Op0->getType()->getScalarSizeInBits();
2158     const unsigned ShftCnt = ShAmt->getLimitedValue(Width);
2159     const KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2160     const unsigned EffWidthY = YKnown.countMaxActiveBits();
2161     if (EffWidthY <= ShftCnt) {
2162       const KnownBits XKnown = computeKnownBits(X, Q.DL, 0, Q.AC, Q.CxtI,
2163                                                 Q.DT);
2164       const unsigned EffWidthX = XKnown.countMaxActiveBits();
2165       const APInt EffBitsY = APInt::getLowBitsSet(Width, EffWidthY);
2166       const APInt EffBitsX = APInt::getLowBitsSet(Width, EffWidthX) << ShftCnt;
2167       // If the mask is extracting all bits from X or Y as is, we can skip
2168       // this AND op.
2169       if (EffBitsY.isSubsetOf(*Mask) && !EffBitsX.intersects(*Mask))
2170         return Y;
2171       if (EffBitsX.isSubsetOf(*Mask) && !EffBitsY.intersects(*Mask))
2172         return XShifted;
2173     }
2174   }
2175 
2176   return nullptr;
2177 }
2178 
2179 Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2180   return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
2181 }
2182 
2183 /// Given operands for an Or, see if we can fold the result.
2184 /// If not, this returns null.
2185 static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
2186                              unsigned MaxRecurse) {
2187   if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
2188     return C;
2189 
2190   // X | poison -> poison
2191   if (isa<PoisonValue>(Op1))
2192     return Op1;
2193 
2194   // X | undef -> -1
2195   // X | -1 = -1
2196   // Do not return Op1 because it may contain undef elements if it's a vector.
2197   if (Q.isUndefValue(Op1) || match(Op1, m_AllOnes()))
2198     return Constant::getAllOnesValue(Op0->getType());
2199 
2200   // X | X = X
2201   // X | 0 = X
2202   if (Op0 == Op1 || match(Op1, m_Zero()))
2203     return Op0;
2204 
2205   // A | ~A  =  ~A | A  =  -1
2206   if (match(Op0, m_Not(m_Specific(Op1))) ||
2207       match(Op1, m_Not(m_Specific(Op0))))
2208     return Constant::getAllOnesValue(Op0->getType());
2209 
2210   // (A & ?) | A = A
2211   if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
2212     return Op1;
2213 
2214   // A | (A & ?) = A
2215   if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
2216     return Op0;
2217 
2218   // ~(A & ?) | A = -1
2219   if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
2220     return Constant::getAllOnesValue(Op1->getType());
2221 
2222   // A | ~(A & ?) = -1
2223   if (match(Op1, m_Not(m_c_And(m_Specific(Op0), m_Value()))))
2224     return Constant::getAllOnesValue(Op0->getType());
2225 
2226   if (Value *V = simplifyLogicOfAddSub(Op0, Op1, Instruction::Or))
2227     return V;
2228 
2229   Value *A, *B, *NotA;
2230   // (A & ~B) | (A ^ B) -> (A ^ B)
2231   // (~B & A) | (A ^ B) -> (A ^ B)
2232   // (A & ~B) | (B ^ A) -> (B ^ A)
2233   // (~B & A) | (B ^ A) -> (B ^ A)
2234   if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
2235       (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
2236        match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
2237     return Op1;
2238 
2239   // Commute the 'or' operands.
2240   // (A ^ B) | (A & ~B) -> (A ^ B)
2241   // (A ^ B) | (~B & A) -> (A ^ B)
2242   // (B ^ A) | (A & ~B) -> (B ^ A)
2243   // (B ^ A) | (~B & A) -> (B ^ A)
2244   if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
2245       (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
2246        match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
2247     return Op0;
2248 
2249   // (A & B) | (~A ^ B) -> (~A ^ B)
2250   // (B & A) | (~A ^ B) -> (~A ^ B)
2251   // (A & B) | (B ^ ~A) -> (B ^ ~A)
2252   // (B & A) | (B ^ ~A) -> (B ^ ~A)
2253   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
2254       (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
2255        match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
2256     return Op1;
2257 
2258   // Commute the 'or' operands.
2259   // (~A ^ B) | (A & B) -> (~A ^ B)
2260   // (~A ^ B) | (B & A) -> (~A ^ B)
2261   // (B ^ ~A) | (A & B) -> (B ^ ~A)
2262   // (B ^ ~A) | (B & A) -> (B ^ ~A)
2263   if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
2264       (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
2265        match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
2266     return Op0;
2267 
2268   // (A | B) | (A ^ B) --> A | B
2269   // (B | A) | (A ^ B) --> B | A
2270   if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
2271       match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
2272     return Op0;
2273 
2274   // Commute the outer 'or' operands.
2275   // (A ^ B) | (A | B) --> A | B
2276   // (A ^ B) | (B | A) --> B | A
2277   if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
2278       match(Op1, m_c_Or(m_Specific(A), m_Specific(B))))
2279     return Op1;
2280 
2281   // (~A & B) | ~(A | B) --> ~A
2282   // (~A & B) | ~(B | A) --> ~A
2283   // (B & ~A) | ~(A | B) --> ~A
2284   // (B & ~A) | ~(B | A) --> ~A
2285   if (match(Op0, m_c_And(m_CombineAnd(m_Value(NotA), m_Not(m_Value(A))),
2286                          m_Value(B))) &&
2287       match(Op1, m_Not(m_c_Or(m_Specific(A), m_Specific(B)))))
2288     return NotA;
2289 
2290   // Commute the 'or' operands.
2291   // ~(A | B) | (~A & B) --> ~A
2292   // ~(B | A) | (~A & B) --> ~A
2293   // ~(A | B) | (B & ~A) --> ~A
2294   // ~(B | A) | (B & ~A) --> ~A
2295   if (match(Op1, m_c_And(m_CombineAnd(m_Value(NotA), m_Not(m_Value(A))),
2296                          m_Value(B))) &&
2297       match(Op0, m_Not(m_c_Or(m_Specific(A), m_Specific(B)))))
2298     return NotA;
2299 
2300   // Rotated -1 is still -1:
2301   // (-1 << X) | (-1 >> (C - X)) --> -1
2302   // (-1 >> X) | (-1 << (C - X)) --> -1
2303   // ...with C <= bitwidth (and commuted variants).
2304   Value *X, *Y;
2305   if ((match(Op0, m_Shl(m_AllOnes(), m_Value(X))) &&
2306        match(Op1, m_LShr(m_AllOnes(), m_Value(Y)))) ||
2307       (match(Op1, m_Shl(m_AllOnes(), m_Value(X))) &&
2308        match(Op0, m_LShr(m_AllOnes(), m_Value(Y))))) {
2309     const APInt *C;
2310     if ((match(X, m_Sub(m_APInt(C), m_Specific(Y))) ||
2311          match(Y, m_Sub(m_APInt(C), m_Specific(X)))) &&
2312         C->ule(X->getType()->getScalarSizeInBits())) {
2313       return ConstantInt::getAllOnesValue(X->getType());
2314     }
2315   }
2316 
2317   if (Value *V = simplifyAndOrOfCmps(Q, Op0, Op1, false))
2318     return V;
2319 
2320   // If we have a multiplication overflow check that is being 'and'ed with a
2321   // check that one of the multipliers is not zero, we can omit the 'and', and
2322   // only keep the overflow check.
2323   if (isCheckForZeroAndMulWithOverflow(Op0, Op1, false))
2324     return Op1;
2325   if (isCheckForZeroAndMulWithOverflow(Op1, Op0, false))
2326     return Op0;
2327 
2328   // Try some generic simplifications for associative operations.
2329   if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
2330                                           MaxRecurse))
2331     return V;
2332 
2333   // Or distributes over And.  Try some generic simplifications based on this.
2334   if (Value *V = expandCommutativeBinOp(Instruction::Or, Op0, Op1,
2335                                         Instruction::And, Q, MaxRecurse))
2336     return V;
2337 
2338   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1)) {
2339     if (Op0->getType()->isIntOrIntVectorTy(1)) {
2340       // A | (A || B) -> A || B
2341       if (match(Op1, m_Select(m_Specific(Op0), m_One(), m_Value())))
2342         return Op1;
2343       else if (match(Op0, m_Select(m_Specific(Op1), m_One(), m_Value())))
2344         return Op0;
2345     }
2346     // If the operation is with the result of a select instruction, check
2347     // whether operating on either branch of the select always yields the same
2348     // value.
2349     if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
2350                                          MaxRecurse))
2351       return V;
2352   }
2353 
2354   // (A & C1)|(B & C2)
2355   const APInt *C1, *C2;
2356   if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
2357       match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
2358     if (*C1 == ~*C2) {
2359       // (A & C1)|(B & C2)
2360       // If we have: ((V + N) & C1) | (V & C2)
2361       // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
2362       // replace with V+N.
2363       Value *N;
2364       if (C2->isMask() && // C2 == 0+1+
2365           match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
2366         // Add commutes, try both ways.
2367         if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2368           return A;
2369       }
2370       // Or commutes, try both ways.
2371       if (C1->isMask() &&
2372           match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
2373         // Add commutes, try both ways.
2374         if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2375           return B;
2376       }
2377     }
2378   }
2379 
2380   // If the operation is with the result of a phi instruction, check whether
2381   // operating on all incoming values of the phi always yields the same value.
2382   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
2383     if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
2384       return V;
2385 
2386   return nullptr;
2387 }
2388 
2389 Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2390   return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
2391 }
2392 
2393 /// Given operands for a Xor, see if we can fold the result.
2394 /// If not, this returns null.
2395 static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
2396                               unsigned MaxRecurse) {
2397   if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
2398     return C;
2399 
2400   // A ^ undef -> undef
2401   if (Q.isUndefValue(Op1))
2402     return Op1;
2403 
2404   // A ^ 0 = A
2405   if (match(Op1, m_Zero()))
2406     return Op0;
2407 
2408   // A ^ A = 0
2409   if (Op0 == Op1)
2410     return Constant::getNullValue(Op0->getType());
2411 
2412   // A ^ ~A  =  ~A ^ A  =  -1
2413   if (match(Op0, m_Not(m_Specific(Op1))) ||
2414       match(Op1, m_Not(m_Specific(Op0))))
2415     return Constant::getAllOnesValue(Op0->getType());
2416 
2417   // (~A | B) ^ (A & B) --> ~A -- There are 8 commuted variants.
2418   // The 'not' op must contain a complete -1 operand (no undef elements for
2419   // vector) for the transform to be safe.
2420   auto matchNotA = [](Value *X, Value *Y) -> Value * {
2421     Value *A, *B, *NotA;
2422     const APInt *C;
2423     if (match(X, m_c_Or(m_CombineAnd(m_Xor(m_Value(A), m_APIntForbidUndef(C)),
2424                                      m_Value(NotA)),
2425                         m_Value(B))) &&
2426         match(Y, m_c_And(m_Specific(A), m_Specific(B))) && C->isAllOnes())
2427       return NotA;
2428     return nullptr;
2429   };
2430   if (Value *NotA = matchNotA(Op0, Op1))
2431     return NotA;
2432   if (Value *NotA = matchNotA(Op1, Op0))
2433     return NotA;
2434 
2435   if (Value *V = simplifyLogicOfAddSub(Op0, Op1, Instruction::Xor))
2436     return V;
2437 
2438   // Try some generic simplifications for associative operations.
2439   if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
2440                                           MaxRecurse))
2441     return V;
2442 
2443   // Threading Xor over selects and phi nodes is pointless, so don't bother.
2444   // Threading over the select in "A ^ select(cond, B, C)" means evaluating
2445   // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
2446   // only if B and C are equal.  If B and C are equal then (since we assume
2447   // that operands have already been simplified) "select(cond, B, C)" should
2448   // have been simplified to the common value of B and C already.  Analysing
2449   // "A^B" and "A^C" thus gains nothing, but costs compile time.  Similarly
2450   // for threading over phi nodes.
2451 
2452   return nullptr;
2453 }
2454 
2455 Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2456   return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2457 }
2458 
2459 
2460 static Type *GetCompareTy(Value *Op) {
2461   return CmpInst::makeCmpResultType(Op->getType());
2462 }
2463 
2464 /// Rummage around inside V looking for something equivalent to the comparison
2465 /// "LHS Pred RHS". Return such a value if found, otherwise return null.
2466 /// Helper function for analyzing max/min idioms.
2467 static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2468                                          Value *LHS, Value *RHS) {
2469   SelectInst *SI = dyn_cast<SelectInst>(V);
2470   if (!SI)
2471     return nullptr;
2472   CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2473   if (!Cmp)
2474     return nullptr;
2475   Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2476   if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2477     return Cmp;
2478   if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2479       LHS == CmpRHS && RHS == CmpLHS)
2480     return Cmp;
2481   return nullptr;
2482 }
2483 
2484 // A significant optimization not implemented here is assuming that alloca
2485 // addresses are not equal to incoming argument values. They don't *alias*,
2486 // as we say, but that doesn't mean they aren't equal, so we take a
2487 // conservative approach.
2488 //
2489 // This is inspired in part by C++11 5.10p1:
2490 //   "Two pointers of the same type compare equal if and only if they are both
2491 //    null, both point to the same function, or both represent the same
2492 //    address."
2493 //
2494 // This is pretty permissive.
2495 //
2496 // It's also partly due to C11 6.5.9p6:
2497 //   "Two pointers compare equal if and only if both are null pointers, both are
2498 //    pointers to the same object (including a pointer to an object and a
2499 //    subobject at its beginning) or function, both are pointers to one past the
2500 //    last element of the same array object, or one is a pointer to one past the
2501 //    end of one array object and the other is a pointer to the start of a
2502 //    different array object that happens to immediately follow the first array
2503 //    object in the address space.)
2504 //
2505 // C11's version is more restrictive, however there's no reason why an argument
2506 // couldn't be a one-past-the-end value for a stack object in the caller and be
2507 // equal to the beginning of a stack object in the callee.
2508 //
2509 // If the C and C++ standards are ever made sufficiently restrictive in this
2510 // area, it may be possible to update LLVM's semantics accordingly and reinstate
2511 // this optimization.
2512 static Constant *
2513 computePointerICmp(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
2514                    const SimplifyQuery &Q) {
2515   const DataLayout &DL = Q.DL;
2516   const TargetLibraryInfo *TLI = Q.TLI;
2517   const DominatorTree *DT = Q.DT;
2518   const Instruction *CxtI = Q.CxtI;
2519   const InstrInfoQuery &IIQ = Q.IIQ;
2520 
2521   // First, skip past any trivial no-ops.
2522   LHS = LHS->stripPointerCasts();
2523   RHS = RHS->stripPointerCasts();
2524 
2525   // A non-null pointer is not equal to a null pointer.
2526   if (isa<ConstantPointerNull>(RHS) && ICmpInst::isEquality(Pred) &&
2527       llvm::isKnownNonZero(LHS, DL, 0, nullptr, nullptr, nullptr,
2528                            IIQ.UseInstrInfo))
2529     return ConstantInt::get(GetCompareTy(LHS),
2530                             !CmpInst::isTrueWhenEqual(Pred));
2531 
2532   // We can only fold certain predicates on pointer comparisons.
2533   switch (Pred) {
2534   default:
2535     return nullptr;
2536 
2537     // Equality comaprisons are easy to fold.
2538   case CmpInst::ICMP_EQ:
2539   case CmpInst::ICMP_NE:
2540     break;
2541 
2542     // We can only handle unsigned relational comparisons because 'inbounds' on
2543     // a GEP only protects against unsigned wrapping.
2544   case CmpInst::ICMP_UGT:
2545   case CmpInst::ICMP_UGE:
2546   case CmpInst::ICMP_ULT:
2547   case CmpInst::ICMP_ULE:
2548     // However, we have to switch them to their signed variants to handle
2549     // negative indices from the base pointer.
2550     Pred = ICmpInst::getSignedPredicate(Pred);
2551     break;
2552   }
2553 
2554   // Strip off any constant offsets so that we can reason about them.
2555   // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2556   // here and compare base addresses like AliasAnalysis does, however there are
2557   // numerous hazards. AliasAnalysis and its utilities rely on special rules
2558   // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2559   // doesn't need to guarantee pointer inequality when it says NoAlias.
2560   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2561   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
2562 
2563   // If LHS and RHS are related via constant offsets to the same base
2564   // value, we can replace it with an icmp which just compares the offsets.
2565   if (LHS == RHS)
2566     return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
2567 
2568   // Various optimizations for (in)equality comparisons.
2569   if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2570     // Different non-empty allocations that exist at the same time have
2571     // different addresses (if the program can tell). Global variables always
2572     // exist, so they always exist during the lifetime of each other and all
2573     // allocas. Two different allocas usually have different addresses...
2574     //
2575     // However, if there's an @llvm.stackrestore dynamically in between two
2576     // allocas, they may have the same address. It's tempting to reduce the
2577     // scope of the problem by only looking at *static* allocas here. That would
2578     // cover the majority of allocas while significantly reducing the likelihood
2579     // of having an @llvm.stackrestore pop up in the middle. However, it's not
2580     // actually impossible for an @llvm.stackrestore to pop up in the middle of
2581     // an entry block. Also, if we have a block that's not attached to a
2582     // function, we can't tell if it's "static" under the current definition.
2583     // Theoretically, this problem could be fixed by creating a new kind of
2584     // instruction kind specifically for static allocas. Such a new instruction
2585     // could be required to be at the top of the entry block, thus preventing it
2586     // from being subject to a @llvm.stackrestore. Instcombine could even
2587     // convert regular allocas into these special allocas. It'd be nifty.
2588     // However, until then, this problem remains open.
2589     //
2590     // So, we'll assume that two non-empty allocas have different addresses
2591     // for now.
2592     //
2593     // With all that, if the offsets are within the bounds of their allocations
2594     // (and not one-past-the-end! so we can't use inbounds!), and their
2595     // allocations aren't the same, the pointers are not equal.
2596     //
2597     // Note that it's not necessary to check for LHS being a global variable
2598     // address, due to canonicalization and constant folding.
2599     if (isa<AllocaInst>(LHS) &&
2600         (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
2601       ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2602       ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
2603       uint64_t LHSSize, RHSSize;
2604       ObjectSizeOpts Opts;
2605       Opts.NullIsUnknownSize =
2606           NullPointerIsDefined(cast<AllocaInst>(LHS)->getFunction());
2607       if (LHSOffsetCI && RHSOffsetCI &&
2608           getObjectSize(LHS, LHSSize, DL, TLI, Opts) &&
2609           getObjectSize(RHS, RHSSize, DL, TLI, Opts)) {
2610         const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2611         const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
2612         if (!LHSOffsetValue.isNegative() &&
2613             !RHSOffsetValue.isNegative() &&
2614             LHSOffsetValue.ult(LHSSize) &&
2615             RHSOffsetValue.ult(RHSSize)) {
2616           return ConstantInt::get(GetCompareTy(LHS),
2617                                   !CmpInst::isTrueWhenEqual(Pred));
2618         }
2619       }
2620 
2621       // Repeat the above check but this time without depending on DataLayout
2622       // or being able to compute a precise size.
2623       if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2624           !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2625           LHSOffset->isNullValue() &&
2626           RHSOffset->isNullValue())
2627         return ConstantInt::get(GetCompareTy(LHS),
2628                                 !CmpInst::isTrueWhenEqual(Pred));
2629     }
2630 
2631     // Even if an non-inbounds GEP occurs along the path we can still optimize
2632     // equality comparisons concerning the result. We avoid walking the whole
2633     // chain again by starting where the last calls to
2634     // stripAndComputeConstantOffsets left off and accumulate the offsets.
2635     Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2636     Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
2637     if (LHS == RHS)
2638       return ConstantExpr::getICmp(Pred,
2639                                    ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2640                                    ConstantExpr::getAdd(RHSOffset, RHSNoBound));
2641 
2642     // If one side of the equality comparison must come from a noalias call
2643     // (meaning a system memory allocation function), and the other side must
2644     // come from a pointer that cannot overlap with dynamically-allocated
2645     // memory within the lifetime of the current function (allocas, byval
2646     // arguments, globals), then determine the comparison result here.
2647     SmallVector<const Value *, 8> LHSUObjs, RHSUObjs;
2648     getUnderlyingObjects(LHS, LHSUObjs);
2649     getUnderlyingObjects(RHS, RHSUObjs);
2650 
2651     // Is the set of underlying objects all noalias calls?
2652     auto IsNAC = [](ArrayRef<const Value *> Objects) {
2653       return all_of(Objects, isNoAliasCall);
2654     };
2655 
2656     // Is the set of underlying objects all things which must be disjoint from
2657     // noalias calls. For allocas, we consider only static ones (dynamic
2658     // allocas might be transformed into calls to malloc not simultaneously
2659     // live with the compared-to allocation). For globals, we exclude symbols
2660     // that might be resolve lazily to symbols in another dynamically-loaded
2661     // library (and, thus, could be malloc'ed by the implementation).
2662     auto IsAllocDisjoint = [](ArrayRef<const Value *> Objects) {
2663       return all_of(Objects, [](const Value *V) {
2664         if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2665           return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2666         if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2667           return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
2668                   GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
2669                  !GV->isThreadLocal();
2670         if (const Argument *A = dyn_cast<Argument>(V))
2671           return A->hasByValAttr();
2672         return false;
2673       });
2674     };
2675 
2676     if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2677         (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2678         return ConstantInt::get(GetCompareTy(LHS),
2679                                 !CmpInst::isTrueWhenEqual(Pred));
2680 
2681     // Fold comparisons for non-escaping pointer even if the allocation call
2682     // cannot be elided. We cannot fold malloc comparison to null. Also, the
2683     // dynamic allocation call could be either of the operands.
2684     Value *MI = nullptr;
2685     if (isAllocLikeFn(LHS, TLI) &&
2686         llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
2687       MI = LHS;
2688     else if (isAllocLikeFn(RHS, TLI) &&
2689              llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
2690       MI = RHS;
2691     // FIXME: We should also fold the compare when the pointer escapes, but the
2692     // compare dominates the pointer escape
2693     if (MI && !PointerMayBeCaptured(MI, true, true))
2694       return ConstantInt::get(GetCompareTy(LHS),
2695                               CmpInst::isFalseWhenEqual(Pred));
2696   }
2697 
2698   // Otherwise, fail.
2699   return nullptr;
2700 }
2701 
2702 /// Fold an icmp when its operands have i1 scalar type.
2703 static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
2704                                   Value *RHS, const SimplifyQuery &Q) {
2705   Type *ITy = GetCompareTy(LHS); // The return type.
2706   Type *OpTy = LHS->getType();   // The operand type.
2707   if (!OpTy->isIntOrIntVectorTy(1))
2708     return nullptr;
2709 
2710   // A boolean compared to true/false can be simplified in 14 out of the 20
2711   // (10 predicates * 2 constants) possible combinations. Cases not handled here
2712   // require a 'not' of the LHS, so those must be transformed in InstCombine.
2713   if (match(RHS, m_Zero())) {
2714     switch (Pred) {
2715     case CmpInst::ICMP_NE:  // X !=  0 -> X
2716     case CmpInst::ICMP_UGT: // X >u  0 -> X
2717     case CmpInst::ICMP_SLT: // X <s  0 -> X
2718       return LHS;
2719 
2720     case CmpInst::ICMP_ULT: // X <u  0 -> false
2721     case CmpInst::ICMP_SGT: // X >s  0 -> false
2722       return getFalse(ITy);
2723 
2724     case CmpInst::ICMP_UGE: // X >=u 0 -> true
2725     case CmpInst::ICMP_SLE: // X <=s 0 -> true
2726       return getTrue(ITy);
2727 
2728     default: break;
2729     }
2730   } else if (match(RHS, m_One())) {
2731     switch (Pred) {
2732     case CmpInst::ICMP_EQ:  // X ==   1 -> X
2733     case CmpInst::ICMP_UGE: // X >=u  1 -> X
2734     case CmpInst::ICMP_SLE: // X <=s -1 -> X
2735       return LHS;
2736 
2737     case CmpInst::ICMP_UGT: // X >u   1 -> false
2738     case CmpInst::ICMP_SLT: // X <s  -1 -> false
2739       return getFalse(ITy);
2740 
2741     case CmpInst::ICMP_ULE: // X <=u  1 -> true
2742     case CmpInst::ICMP_SGE: // X >=s -1 -> true
2743       return getTrue(ITy);
2744 
2745     default: break;
2746     }
2747   }
2748 
2749   switch (Pred) {
2750   default:
2751     break;
2752   case ICmpInst::ICMP_UGE:
2753     if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2754       return getTrue(ITy);
2755     break;
2756   case ICmpInst::ICMP_SGE:
2757     /// For signed comparison, the values for an i1 are 0 and -1
2758     /// respectively. This maps into a truth table of:
2759     /// LHS | RHS | LHS >=s RHS   | LHS implies RHS
2760     ///  0  |  0  |  1 (0 >= 0)   |  1
2761     ///  0  |  1  |  1 (0 >= -1)  |  1
2762     ///  1  |  0  |  0 (-1 >= 0)  |  0
2763     ///  1  |  1  |  1 (-1 >= -1) |  1
2764     if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2765       return getTrue(ITy);
2766     break;
2767   case ICmpInst::ICMP_ULE:
2768     if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2769       return getTrue(ITy);
2770     break;
2771   }
2772 
2773   return nullptr;
2774 }
2775 
2776 /// Try hard to fold icmp with zero RHS because this is a common case.
2777 static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
2778                                    Value *RHS, const SimplifyQuery &Q) {
2779   if (!match(RHS, m_Zero()))
2780     return nullptr;
2781 
2782   Type *ITy = GetCompareTy(LHS); // The return type.
2783   switch (Pred) {
2784   default:
2785     llvm_unreachable("Unknown ICmp predicate!");
2786   case ICmpInst::ICMP_ULT:
2787     return getFalse(ITy);
2788   case ICmpInst::ICMP_UGE:
2789     return getTrue(ITy);
2790   case ICmpInst::ICMP_EQ:
2791   case ICmpInst::ICMP_ULE:
2792     if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo))
2793       return getFalse(ITy);
2794     break;
2795   case ICmpInst::ICMP_NE:
2796   case ICmpInst::ICMP_UGT:
2797     if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo))
2798       return getTrue(ITy);
2799     break;
2800   case ICmpInst::ICMP_SLT: {
2801     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2802     if (LHSKnown.isNegative())
2803       return getTrue(ITy);
2804     if (LHSKnown.isNonNegative())
2805       return getFalse(ITy);
2806     break;
2807   }
2808   case ICmpInst::ICMP_SLE: {
2809     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2810     if (LHSKnown.isNegative())
2811       return getTrue(ITy);
2812     if (LHSKnown.isNonNegative() &&
2813         isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2814       return getFalse(ITy);
2815     break;
2816   }
2817   case ICmpInst::ICMP_SGE: {
2818     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2819     if (LHSKnown.isNegative())
2820       return getFalse(ITy);
2821     if (LHSKnown.isNonNegative())
2822       return getTrue(ITy);
2823     break;
2824   }
2825   case ICmpInst::ICMP_SGT: {
2826     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2827     if (LHSKnown.isNegative())
2828       return getFalse(ITy);
2829     if (LHSKnown.isNonNegative() &&
2830         isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2831       return getTrue(ITy);
2832     break;
2833   }
2834   }
2835 
2836   return nullptr;
2837 }
2838 
2839 static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2840                                        Value *RHS, const InstrInfoQuery &IIQ) {
2841   Type *ITy = GetCompareTy(RHS); // The return type.
2842 
2843   Value *X;
2844   // Sign-bit checks can be optimized to true/false after unsigned
2845   // floating-point casts:
2846   // icmp slt (bitcast (uitofp X)),  0 --> false
2847   // icmp sgt (bitcast (uitofp X)), -1 --> true
2848   if (match(LHS, m_BitCast(m_UIToFP(m_Value(X))))) {
2849     if (Pred == ICmpInst::ICMP_SLT && match(RHS, m_Zero()))
2850       return ConstantInt::getFalse(ITy);
2851     if (Pred == ICmpInst::ICMP_SGT && match(RHS, m_AllOnes()))
2852       return ConstantInt::getTrue(ITy);
2853   }
2854 
2855   const APInt *C;
2856   if (!match(RHS, m_APIntAllowUndef(C)))
2857     return nullptr;
2858 
2859   // Rule out tautological comparisons (eg., ult 0 or uge 0).
2860   ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
2861   if (RHS_CR.isEmptySet())
2862     return ConstantInt::getFalse(ITy);
2863   if (RHS_CR.isFullSet())
2864     return ConstantInt::getTrue(ITy);
2865 
2866   ConstantRange LHS_CR = computeConstantRange(LHS, IIQ.UseInstrInfo);
2867   if (!LHS_CR.isFullSet()) {
2868     if (RHS_CR.contains(LHS_CR))
2869       return ConstantInt::getTrue(ITy);
2870     if (RHS_CR.inverse().contains(LHS_CR))
2871       return ConstantInt::getFalse(ITy);
2872   }
2873 
2874   // (mul nuw/nsw X, MulC) != C --> true  (if C is not a multiple of MulC)
2875   // (mul nuw/nsw X, MulC) == C --> false (if C is not a multiple of MulC)
2876   const APInt *MulC;
2877   if (ICmpInst::isEquality(Pred) &&
2878       ((match(LHS, m_NUWMul(m_Value(), m_APIntAllowUndef(MulC))) &&
2879         *MulC != 0 && C->urem(*MulC) != 0) ||
2880        (match(LHS, m_NSWMul(m_Value(), m_APIntAllowUndef(MulC))) &&
2881         *MulC != 0 && C->srem(*MulC) != 0)))
2882     return ConstantInt::get(ITy, Pred == ICmpInst::ICMP_NE);
2883 
2884   return nullptr;
2885 }
2886 
2887 static Value *simplifyICmpWithBinOpOnLHS(
2888     CmpInst::Predicate Pred, BinaryOperator *LBO, Value *RHS,
2889     const SimplifyQuery &Q, unsigned MaxRecurse) {
2890   Type *ITy = GetCompareTy(RHS); // The return type.
2891 
2892   Value *Y = nullptr;
2893   // icmp pred (or X, Y), X
2894   if (match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2895     if (Pred == ICmpInst::ICMP_ULT)
2896       return getFalse(ITy);
2897     if (Pred == ICmpInst::ICMP_UGE)
2898       return getTrue(ITy);
2899 
2900     if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
2901       KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2902       KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2903       if (RHSKnown.isNonNegative() && YKnown.isNegative())
2904         return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
2905       if (RHSKnown.isNegative() || YKnown.isNonNegative())
2906         return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2907     }
2908   }
2909 
2910   // icmp pred (and X, Y), X
2911   if (match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
2912     if (Pred == ICmpInst::ICMP_UGT)
2913       return getFalse(ITy);
2914     if (Pred == ICmpInst::ICMP_ULE)
2915       return getTrue(ITy);
2916   }
2917 
2918   // icmp pred (urem X, Y), Y
2919   if (match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2920     switch (Pred) {
2921     default:
2922       break;
2923     case ICmpInst::ICMP_SGT:
2924     case ICmpInst::ICMP_SGE: {
2925       KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2926       if (!Known.isNonNegative())
2927         break;
2928       LLVM_FALLTHROUGH;
2929     }
2930     case ICmpInst::ICMP_EQ:
2931     case ICmpInst::ICMP_UGT:
2932     case ICmpInst::ICMP_UGE:
2933       return getFalse(ITy);
2934     case ICmpInst::ICMP_SLT:
2935     case ICmpInst::ICMP_SLE: {
2936       KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2937       if (!Known.isNonNegative())
2938         break;
2939       LLVM_FALLTHROUGH;
2940     }
2941     case ICmpInst::ICMP_NE:
2942     case ICmpInst::ICMP_ULT:
2943     case ICmpInst::ICMP_ULE:
2944       return getTrue(ITy);
2945     }
2946   }
2947 
2948   // icmp pred (urem X, Y), X
2949   if (match(LBO, m_URem(m_Specific(RHS), m_Value()))) {
2950     if (Pred == ICmpInst::ICMP_ULE)
2951       return getTrue(ITy);
2952     if (Pred == ICmpInst::ICMP_UGT)
2953       return getFalse(ITy);
2954   }
2955 
2956   // x >> y <=u x
2957   // x udiv y <=u x.
2958   if (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2959       match(LBO, m_UDiv(m_Specific(RHS), m_Value()))) {
2960     // icmp pred (X op Y), X
2961     if (Pred == ICmpInst::ICMP_UGT)
2962       return getFalse(ITy);
2963     if (Pred == ICmpInst::ICMP_ULE)
2964       return getTrue(ITy);
2965   }
2966 
2967   // (x*C1)/C2 <= x for C1 <= C2.
2968   // This holds even if the multiplication overflows: Assume that x != 0 and
2969   // arithmetic is modulo M. For overflow to occur we must have C1 >= M/x and
2970   // thus C2 >= M/x. It follows that (x*C1)/C2 <= (M-1)/C2 <= ((M-1)*x)/M < x.
2971   //
2972   // Additionally, either the multiplication and division might be represented
2973   // as shifts:
2974   // (x*C1)>>C2 <= x for C1 < 2**C2.
2975   // (x<<C1)/C2 <= x for 2**C1 < C2.
2976   const APInt *C1, *C2;
2977   if ((match(LBO, m_UDiv(m_Mul(m_Specific(RHS), m_APInt(C1)), m_APInt(C2))) &&
2978        C1->ule(*C2)) ||
2979       (match(LBO, m_LShr(m_Mul(m_Specific(RHS), m_APInt(C1)), m_APInt(C2))) &&
2980        C1->ule(APInt(C2->getBitWidth(), 1) << *C2)) ||
2981       (match(LBO, m_UDiv(m_Shl(m_Specific(RHS), m_APInt(C1)), m_APInt(C2))) &&
2982        (APInt(C1->getBitWidth(), 1) << *C1).ule(*C2))) {
2983     if (Pred == ICmpInst::ICMP_UGT)
2984       return getFalse(ITy);
2985     if (Pred == ICmpInst::ICMP_ULE)
2986       return getTrue(ITy);
2987   }
2988 
2989   return nullptr;
2990 }
2991 
2992 
2993 // If only one of the icmp's operands has NSW flags, try to prove that:
2994 //
2995 //   icmp slt (x + C1), (x +nsw C2)
2996 //
2997 // is equivalent to:
2998 //
2999 //   icmp slt C1, C2
3000 //
3001 // which is true if x + C2 has the NSW flags set and:
3002 // *) C1 < C2 && C1 >= 0, or
3003 // *) C2 < C1 && C1 <= 0.
3004 //
3005 static bool trySimplifyICmpWithAdds(CmpInst::Predicate Pred, Value *LHS,
3006                                     Value *RHS) {
3007   // TODO: only support icmp slt for now.
3008   if (Pred != CmpInst::ICMP_SLT)
3009     return false;
3010 
3011   // Canonicalize nsw add as RHS.
3012   if (!match(RHS, m_NSWAdd(m_Value(), m_Value())))
3013     std::swap(LHS, RHS);
3014   if (!match(RHS, m_NSWAdd(m_Value(), m_Value())))
3015     return false;
3016 
3017   Value *X;
3018   const APInt *C1, *C2;
3019   if (!match(LHS, m_c_Add(m_Value(X), m_APInt(C1))) ||
3020       !match(RHS, m_c_Add(m_Specific(X), m_APInt(C2))))
3021     return false;
3022 
3023   return (C1->slt(*C2) && C1->isNonNegative()) ||
3024          (C2->slt(*C1) && C1->isNonPositive());
3025 }
3026 
3027 
3028 /// TODO: A large part of this logic is duplicated in InstCombine's
3029 /// foldICmpBinOp(). We should be able to share that and avoid the code
3030 /// duplication.
3031 static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
3032                                     Value *RHS, const SimplifyQuery &Q,
3033                                     unsigned MaxRecurse) {
3034   BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
3035   BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
3036   if (MaxRecurse && (LBO || RBO)) {
3037     // Analyze the case when either LHS or RHS is an add instruction.
3038     Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
3039     // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
3040     bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
3041     if (LBO && LBO->getOpcode() == Instruction::Add) {
3042       A = LBO->getOperand(0);
3043       B = LBO->getOperand(1);
3044       NoLHSWrapProblem =
3045           ICmpInst::isEquality(Pred) ||
3046           (CmpInst::isUnsigned(Pred) &&
3047            Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(LBO))) ||
3048           (CmpInst::isSigned(Pred) &&
3049            Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(LBO)));
3050     }
3051     if (RBO && RBO->getOpcode() == Instruction::Add) {
3052       C = RBO->getOperand(0);
3053       D = RBO->getOperand(1);
3054       NoRHSWrapProblem =
3055           ICmpInst::isEquality(Pred) ||
3056           (CmpInst::isUnsigned(Pred) &&
3057            Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(RBO))) ||
3058           (CmpInst::isSigned(Pred) &&
3059            Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(RBO)));
3060     }
3061 
3062     // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3063     if ((A == RHS || B == RHS) && NoLHSWrapProblem)
3064       if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
3065                                       Constant::getNullValue(RHS->getType()), Q,
3066                                       MaxRecurse - 1))
3067         return V;
3068 
3069     // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3070     if ((C == LHS || D == LHS) && NoRHSWrapProblem)
3071       if (Value *V =
3072               SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
3073                                C == LHS ? D : C, Q, MaxRecurse - 1))
3074         return V;
3075 
3076     // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
3077     bool CanSimplify = (NoLHSWrapProblem && NoRHSWrapProblem) ||
3078                        trySimplifyICmpWithAdds(Pred, LHS, RHS);
3079     if (A && C && (A == C || A == D || B == C || B == D) && CanSimplify) {
3080       // Determine Y and Z in the form icmp (X+Y), (X+Z).
3081       Value *Y, *Z;
3082       if (A == C) {
3083         // C + B == C + D  ->  B == D
3084         Y = B;
3085         Z = D;
3086       } else if (A == D) {
3087         // D + B == C + D  ->  B == C
3088         Y = B;
3089         Z = C;
3090       } else if (B == C) {
3091         // A + C == C + D  ->  A == D
3092         Y = A;
3093         Z = D;
3094       } else {
3095         assert(B == D);
3096         // A + D == C + D  ->  A == C
3097         Y = A;
3098         Z = C;
3099       }
3100       if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
3101         return V;
3102     }
3103   }
3104 
3105   if (LBO)
3106     if (Value *V = simplifyICmpWithBinOpOnLHS(Pred, LBO, RHS, Q, MaxRecurse))
3107       return V;
3108 
3109   if (RBO)
3110     if (Value *V = simplifyICmpWithBinOpOnLHS(
3111             ICmpInst::getSwappedPredicate(Pred), RBO, LHS, Q, MaxRecurse))
3112       return V;
3113 
3114   // 0 - (zext X) pred C
3115   if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
3116     const APInt *C;
3117     if (match(RHS, m_APInt(C))) {
3118       if (C->isStrictlyPositive()) {
3119         if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_NE)
3120           return ConstantInt::getTrue(GetCompareTy(RHS));
3121         if (Pred == ICmpInst::ICMP_SGE || Pred == ICmpInst::ICMP_EQ)
3122           return ConstantInt::getFalse(GetCompareTy(RHS));
3123       }
3124       if (C->isNonNegative()) {
3125         if (Pred == ICmpInst::ICMP_SLE)
3126           return ConstantInt::getTrue(GetCompareTy(RHS));
3127         if (Pred == ICmpInst::ICMP_SGT)
3128           return ConstantInt::getFalse(GetCompareTy(RHS));
3129       }
3130     }
3131   }
3132 
3133   //   If C2 is a power-of-2 and C is not:
3134   //   (C2 << X) == C --> false
3135   //   (C2 << X) != C --> true
3136   const APInt *C;
3137   if (match(LHS, m_Shl(m_Power2(), m_Value())) &&
3138       match(RHS, m_APIntAllowUndef(C)) && !C->isPowerOf2()) {
3139     // C2 << X can equal zero in some circumstances.
3140     // This simplification might be unsafe if C is zero.
3141     //
3142     // We know it is safe if:
3143     // - The shift is nsw. We can't shift out the one bit.
3144     // - The shift is nuw. We can't shift out the one bit.
3145     // - C2 is one.
3146     // - C isn't zero.
3147     if (Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(LBO)) ||
3148         Q.IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(LBO)) ||
3149         match(LHS, m_Shl(m_One(), m_Value())) || !C->isZero()) {
3150       if (Pred == ICmpInst::ICMP_EQ)
3151         return ConstantInt::getFalse(GetCompareTy(RHS));
3152       if (Pred == ICmpInst::ICMP_NE)
3153         return ConstantInt::getTrue(GetCompareTy(RHS));
3154     }
3155   }
3156 
3157   // TODO: This is overly constrained. LHS can be any power-of-2.
3158   // (1 << X)  >u 0x8000 --> false
3159   // (1 << X) <=u 0x8000 --> true
3160   if (match(LHS, m_Shl(m_One(), m_Value())) && match(RHS, m_SignMask())) {
3161     if (Pred == ICmpInst::ICMP_UGT)
3162       return ConstantInt::getFalse(GetCompareTy(RHS));
3163     if (Pred == ICmpInst::ICMP_ULE)
3164       return ConstantInt::getTrue(GetCompareTy(RHS));
3165   }
3166 
3167   if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
3168       LBO->getOperand(1) == RBO->getOperand(1)) {
3169     switch (LBO->getOpcode()) {
3170     default:
3171       break;
3172     case Instruction::UDiv:
3173     case Instruction::LShr:
3174       if (ICmpInst::isSigned(Pred) || !Q.IIQ.isExact(LBO) ||
3175           !Q.IIQ.isExact(RBO))
3176         break;
3177       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3178                                       RBO->getOperand(0), Q, MaxRecurse - 1))
3179           return V;
3180       break;
3181     case Instruction::SDiv:
3182       if (!ICmpInst::isEquality(Pred) || !Q.IIQ.isExact(LBO) ||
3183           !Q.IIQ.isExact(RBO))
3184         break;
3185       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3186                                       RBO->getOperand(0), Q, MaxRecurse - 1))
3187         return V;
3188       break;
3189     case Instruction::AShr:
3190       if (!Q.IIQ.isExact(LBO) || !Q.IIQ.isExact(RBO))
3191         break;
3192       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3193                                       RBO->getOperand(0), Q, MaxRecurse - 1))
3194         return V;
3195       break;
3196     case Instruction::Shl: {
3197       bool NUW = Q.IIQ.hasNoUnsignedWrap(LBO) && Q.IIQ.hasNoUnsignedWrap(RBO);
3198       bool NSW = Q.IIQ.hasNoSignedWrap(LBO) && Q.IIQ.hasNoSignedWrap(RBO);
3199       if (!NUW && !NSW)
3200         break;
3201       if (!NSW && ICmpInst::isSigned(Pred))
3202         break;
3203       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
3204                                       RBO->getOperand(0), Q, MaxRecurse - 1))
3205         return V;
3206       break;
3207     }
3208     }
3209   }
3210   return nullptr;
3211 }
3212 
3213 /// Simplify integer comparisons where at least one operand of the compare
3214 /// matches an integer min/max idiom.
3215 static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
3216                                      Value *RHS, const SimplifyQuery &Q,
3217                                      unsigned MaxRecurse) {
3218   Type *ITy = GetCompareTy(LHS); // The return type.
3219   Value *A, *B;
3220   CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
3221   CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
3222 
3223   // Signed variants on "max(a,b)>=a -> true".
3224   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3225     if (A != RHS)
3226       std::swap(A, B);       // smax(A, B) pred A.
3227     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
3228     // We analyze this as smax(A, B) pred A.
3229     P = Pred;
3230   } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
3231              (A == LHS || B == LHS)) {
3232     if (A != LHS)
3233       std::swap(A, B);       // A pred smax(A, B).
3234     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
3235     // We analyze this as smax(A, B) swapped-pred A.
3236     P = CmpInst::getSwappedPredicate(Pred);
3237   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3238              (A == RHS || B == RHS)) {
3239     if (A != RHS)
3240       std::swap(A, B);       // smin(A, B) pred A.
3241     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3242     // We analyze this as smax(-A, -B) swapped-pred -A.
3243     // Note that we do not need to actually form -A or -B thanks to EqP.
3244     P = CmpInst::getSwappedPredicate(Pred);
3245   } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
3246              (A == LHS || B == LHS)) {
3247     if (A != LHS)
3248       std::swap(A, B);       // A pred smin(A, B).
3249     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
3250     // We analyze this as smax(-A, -B) pred -A.
3251     // Note that we do not need to actually form -A or -B thanks to EqP.
3252     P = Pred;
3253   }
3254   if (P != CmpInst::BAD_ICMP_PREDICATE) {
3255     // Cases correspond to "max(A, B) p A".
3256     switch (P) {
3257     default:
3258       break;
3259     case CmpInst::ICMP_EQ:
3260     case CmpInst::ICMP_SLE:
3261       // Equivalent to "A EqP B".  This may be the same as the condition tested
3262       // in the max/min; if so, we can just return that.
3263       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3264         return V;
3265       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3266         return V;
3267       // Otherwise, see if "A EqP B" simplifies.
3268       if (MaxRecurse)
3269         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3270           return V;
3271       break;
3272     case CmpInst::ICMP_NE:
3273     case CmpInst::ICMP_SGT: {
3274       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3275       // Equivalent to "A InvEqP B".  This may be the same as the condition
3276       // tested in the max/min; if so, we can just return that.
3277       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3278         return V;
3279       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3280         return V;
3281       // Otherwise, see if "A InvEqP B" simplifies.
3282       if (MaxRecurse)
3283         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3284           return V;
3285       break;
3286     }
3287     case CmpInst::ICMP_SGE:
3288       // Always true.
3289       return getTrue(ITy);
3290     case CmpInst::ICMP_SLT:
3291       // Always false.
3292       return getFalse(ITy);
3293     }
3294   }
3295 
3296   // Unsigned variants on "max(a,b)>=a -> true".
3297   P = CmpInst::BAD_ICMP_PREDICATE;
3298   if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3299     if (A != RHS)
3300       std::swap(A, B);       // umax(A, B) pred A.
3301     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3302     // We analyze this as umax(A, B) pred A.
3303     P = Pred;
3304   } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
3305              (A == LHS || B == LHS)) {
3306     if (A != LHS)
3307       std::swap(A, B);       // A pred umax(A, B).
3308     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3309     // We analyze this as umax(A, B) swapped-pred A.
3310     P = CmpInst::getSwappedPredicate(Pred);
3311   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3312              (A == RHS || B == RHS)) {
3313     if (A != RHS)
3314       std::swap(A, B);       // umin(A, B) pred A.
3315     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3316     // We analyze this as umax(-A, -B) swapped-pred -A.
3317     // Note that we do not need to actually form -A or -B thanks to EqP.
3318     P = CmpInst::getSwappedPredicate(Pred);
3319   } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
3320              (A == LHS || B == LHS)) {
3321     if (A != LHS)
3322       std::swap(A, B);       // A pred umin(A, B).
3323     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3324     // We analyze this as umax(-A, -B) pred -A.
3325     // Note that we do not need to actually form -A or -B thanks to EqP.
3326     P = Pred;
3327   }
3328   if (P != CmpInst::BAD_ICMP_PREDICATE) {
3329     // Cases correspond to "max(A, B) p A".
3330     switch (P) {
3331     default:
3332       break;
3333     case CmpInst::ICMP_EQ:
3334     case CmpInst::ICMP_ULE:
3335       // Equivalent to "A EqP B".  This may be the same as the condition tested
3336       // in the max/min; if so, we can just return that.
3337       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3338         return V;
3339       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3340         return V;
3341       // Otherwise, see if "A EqP B" simplifies.
3342       if (MaxRecurse)
3343         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3344           return V;
3345       break;
3346     case CmpInst::ICMP_NE:
3347     case CmpInst::ICMP_UGT: {
3348       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3349       // Equivalent to "A InvEqP B".  This may be the same as the condition
3350       // tested in the max/min; if so, we can just return that.
3351       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3352         return V;
3353       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3354         return V;
3355       // Otherwise, see if "A InvEqP B" simplifies.
3356       if (MaxRecurse)
3357         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3358           return V;
3359       break;
3360     }
3361     case CmpInst::ICMP_UGE:
3362       return getTrue(ITy);
3363     case CmpInst::ICMP_ULT:
3364       return getFalse(ITy);
3365     }
3366   }
3367 
3368   // Comparing 1 each of min/max with a common operand?
3369   // Canonicalize min operand to RHS.
3370   if (match(LHS, m_UMin(m_Value(), m_Value())) ||
3371       match(LHS, m_SMin(m_Value(), m_Value()))) {
3372     std::swap(LHS, RHS);
3373     Pred = ICmpInst::getSwappedPredicate(Pred);
3374   }
3375 
3376   Value *C, *D;
3377   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3378       match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3379       (A == C || A == D || B == C || B == D)) {
3380     // smax(A, B) >=s smin(A, D) --> true
3381     if (Pred == CmpInst::ICMP_SGE)
3382       return getTrue(ITy);
3383     // smax(A, B) <s smin(A, D) --> false
3384     if (Pred == CmpInst::ICMP_SLT)
3385       return getFalse(ITy);
3386   } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3387              match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3388              (A == C || A == D || B == C || B == D)) {
3389     // umax(A, B) >=u umin(A, D) --> true
3390     if (Pred == CmpInst::ICMP_UGE)
3391       return getTrue(ITy);
3392     // umax(A, B) <u umin(A, D) --> false
3393     if (Pred == CmpInst::ICMP_ULT)
3394       return getFalse(ITy);
3395   }
3396 
3397   return nullptr;
3398 }
3399 
3400 static Value *simplifyICmpWithDominatingAssume(CmpInst::Predicate Predicate,
3401                                                Value *LHS, Value *RHS,
3402                                                const SimplifyQuery &Q) {
3403   // Gracefully handle instructions that have not been inserted yet.
3404   if (!Q.AC || !Q.CxtI || !Q.CxtI->getParent())
3405     return nullptr;
3406 
3407   for (Value *AssumeBaseOp : {LHS, RHS}) {
3408     for (auto &AssumeVH : Q.AC->assumptionsFor(AssumeBaseOp)) {
3409       if (!AssumeVH)
3410         continue;
3411 
3412       CallInst *Assume = cast<CallInst>(AssumeVH);
3413       if (Optional<bool> Imp =
3414               isImpliedCondition(Assume->getArgOperand(0), Predicate, LHS, RHS,
3415                                  Q.DL))
3416         if (isValidAssumeForContext(Assume, Q.CxtI, Q.DT))
3417           return ConstantInt::get(GetCompareTy(LHS), *Imp);
3418     }
3419   }
3420 
3421   return nullptr;
3422 }
3423 
3424 /// Given operands for an ICmpInst, see if we can fold the result.
3425 /// If not, this returns null.
3426 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3427                                const SimplifyQuery &Q, unsigned MaxRecurse) {
3428   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3429   assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
3430 
3431   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
3432     if (Constant *CRHS = dyn_cast<Constant>(RHS))
3433       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
3434 
3435     // If we have a constant, make sure it is on the RHS.
3436     std::swap(LHS, RHS);
3437     Pred = CmpInst::getSwappedPredicate(Pred);
3438   }
3439   assert(!isa<UndefValue>(LHS) && "Unexpected icmp undef,%X");
3440 
3441   Type *ITy = GetCompareTy(LHS); // The return type.
3442 
3443   // icmp poison, X -> poison
3444   if (isa<PoisonValue>(RHS))
3445     return PoisonValue::get(ITy);
3446 
3447   // For EQ and NE, we can always pick a value for the undef to make the
3448   // predicate pass or fail, so we can return undef.
3449   // Matches behavior in llvm::ConstantFoldCompareInstruction.
3450   if (Q.isUndefValue(RHS) && ICmpInst::isEquality(Pred))
3451     return UndefValue::get(ITy);
3452 
3453   // icmp X, X -> true/false
3454   // icmp X, undef -> true/false because undef could be X.
3455   if (LHS == RHS || Q.isUndefValue(RHS))
3456     return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
3457 
3458   if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3459     return V;
3460 
3461   // TODO: Sink/common this with other potentially expensive calls that use
3462   //       ValueTracking? See comment below for isKnownNonEqual().
3463   if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3464     return V;
3465 
3466   if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS, Q.IIQ))
3467     return V;
3468 
3469   // If both operands have range metadata, use the metadata
3470   // to simplify the comparison.
3471   if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
3472     auto RHS_Instr = cast<Instruction>(RHS);
3473     auto LHS_Instr = cast<Instruction>(LHS);
3474 
3475     if (Q.IIQ.getMetadata(RHS_Instr, LLVMContext::MD_range) &&
3476         Q.IIQ.getMetadata(LHS_Instr, LLVMContext::MD_range)) {
3477       auto RHS_CR = getConstantRangeFromMetadata(
3478           *RHS_Instr->getMetadata(LLVMContext::MD_range));
3479       auto LHS_CR = getConstantRangeFromMetadata(
3480           *LHS_Instr->getMetadata(LLVMContext::MD_range));
3481 
3482       if (LHS_CR.icmp(Pred, RHS_CR))
3483         return ConstantInt::getTrue(RHS->getContext());
3484 
3485       if (LHS_CR.icmp(CmpInst::getInversePredicate(Pred), RHS_CR))
3486         return ConstantInt::getFalse(RHS->getContext());
3487     }
3488   }
3489 
3490   // Compare of cast, for example (zext X) != 0 -> X != 0
3491   if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3492     Instruction *LI = cast<CastInst>(LHS);
3493     Value *SrcOp = LI->getOperand(0);
3494     Type *SrcTy = SrcOp->getType();
3495     Type *DstTy = LI->getType();
3496 
3497     // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3498     // if the integer type is the same size as the pointer type.
3499     if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3500         Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
3501       if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3502         // Transfer the cast to the constant.
3503         if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3504                                         ConstantExpr::getIntToPtr(RHSC, SrcTy),
3505                                         Q, MaxRecurse-1))
3506           return V;
3507       } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3508         if (RI->getOperand(0)->getType() == SrcTy)
3509           // Compare without the cast.
3510           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
3511                                           Q, MaxRecurse-1))
3512             return V;
3513       }
3514     }
3515 
3516     if (isa<ZExtInst>(LHS)) {
3517       // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3518       // same type.
3519       if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3520         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3521           // Compare X and Y.  Note that signed predicates become unsigned.
3522           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
3523                                           SrcOp, RI->getOperand(0), Q,
3524                                           MaxRecurse-1))
3525             return V;
3526       }
3527       // Fold (zext X) ule (sext X), (zext X) sge (sext X) to true.
3528       else if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3529         if (SrcOp == RI->getOperand(0)) {
3530           if (Pred == ICmpInst::ICMP_ULE || Pred == ICmpInst::ICMP_SGE)
3531             return ConstantInt::getTrue(ITy);
3532           if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_SLT)
3533             return ConstantInt::getFalse(ITy);
3534         }
3535       }
3536       // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3537       // too.  If not, then try to deduce the result of the comparison.
3538       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3539         // Compute the constant that would happen if we truncated to SrcTy then
3540         // reextended to DstTy.
3541         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3542         Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3543 
3544         // If the re-extended constant didn't change then this is effectively
3545         // also a case of comparing two zero-extended values.
3546         if (RExt == CI && MaxRecurse)
3547           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
3548                                         SrcOp, Trunc, Q, MaxRecurse-1))
3549             return V;
3550 
3551         // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3552         // there.  Use this to work out the result of the comparison.
3553         if (RExt != CI) {
3554           switch (Pred) {
3555           default: llvm_unreachable("Unknown ICmp predicate!");
3556           // LHS <u RHS.
3557           case ICmpInst::ICMP_EQ:
3558           case ICmpInst::ICMP_UGT:
3559           case ICmpInst::ICMP_UGE:
3560             return ConstantInt::getFalse(CI->getContext());
3561 
3562           case ICmpInst::ICMP_NE:
3563           case ICmpInst::ICMP_ULT:
3564           case ICmpInst::ICMP_ULE:
3565             return ConstantInt::getTrue(CI->getContext());
3566 
3567           // LHS is non-negative.  If RHS is negative then LHS >s LHS.  If RHS
3568           // is non-negative then LHS <s RHS.
3569           case ICmpInst::ICMP_SGT:
3570           case ICmpInst::ICMP_SGE:
3571             return CI->getValue().isNegative() ?
3572               ConstantInt::getTrue(CI->getContext()) :
3573               ConstantInt::getFalse(CI->getContext());
3574 
3575           case ICmpInst::ICMP_SLT:
3576           case ICmpInst::ICMP_SLE:
3577             return CI->getValue().isNegative() ?
3578               ConstantInt::getFalse(CI->getContext()) :
3579               ConstantInt::getTrue(CI->getContext());
3580           }
3581         }
3582       }
3583     }
3584 
3585     if (isa<SExtInst>(LHS)) {
3586       // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3587       // same type.
3588       if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3589         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3590           // Compare X and Y.  Note that the predicate does not change.
3591           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
3592                                           Q, MaxRecurse-1))
3593             return V;
3594       }
3595       // Fold (sext X) uge (zext X), (sext X) sle (zext X) to true.
3596       else if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3597         if (SrcOp == RI->getOperand(0)) {
3598           if (Pred == ICmpInst::ICMP_UGE || Pred == ICmpInst::ICMP_SLE)
3599             return ConstantInt::getTrue(ITy);
3600           if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_SGT)
3601             return ConstantInt::getFalse(ITy);
3602         }
3603       }
3604       // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3605       // too.  If not, then try to deduce the result of the comparison.
3606       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3607         // Compute the constant that would happen if we truncated to SrcTy then
3608         // reextended to DstTy.
3609         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3610         Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3611 
3612         // If the re-extended constant didn't change then this is effectively
3613         // also a case of comparing two sign-extended values.
3614         if (RExt == CI && MaxRecurse)
3615           if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
3616             return V;
3617 
3618         // Otherwise the upper bits of LHS are all equal, while RHS has varying
3619         // bits there.  Use this to work out the result of the comparison.
3620         if (RExt != CI) {
3621           switch (Pred) {
3622           default: llvm_unreachable("Unknown ICmp predicate!");
3623           case ICmpInst::ICMP_EQ:
3624             return ConstantInt::getFalse(CI->getContext());
3625           case ICmpInst::ICMP_NE:
3626             return ConstantInt::getTrue(CI->getContext());
3627 
3628           // If RHS is non-negative then LHS <s RHS.  If RHS is negative then
3629           // LHS >s RHS.
3630           case ICmpInst::ICMP_SGT:
3631           case ICmpInst::ICMP_SGE:
3632             return CI->getValue().isNegative() ?
3633               ConstantInt::getTrue(CI->getContext()) :
3634               ConstantInt::getFalse(CI->getContext());
3635           case ICmpInst::ICMP_SLT:
3636           case ICmpInst::ICMP_SLE:
3637             return CI->getValue().isNegative() ?
3638               ConstantInt::getFalse(CI->getContext()) :
3639               ConstantInt::getTrue(CI->getContext());
3640 
3641           // If LHS is non-negative then LHS <u RHS.  If LHS is negative then
3642           // LHS >u RHS.
3643           case ICmpInst::ICMP_UGT:
3644           case ICmpInst::ICMP_UGE:
3645             // Comparison is true iff the LHS <s 0.
3646             if (MaxRecurse)
3647               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3648                                               Constant::getNullValue(SrcTy),
3649                                               Q, MaxRecurse-1))
3650                 return V;
3651             break;
3652           case ICmpInst::ICMP_ULT:
3653           case ICmpInst::ICMP_ULE:
3654             // Comparison is true iff the LHS >=s 0.
3655             if (MaxRecurse)
3656               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3657                                               Constant::getNullValue(SrcTy),
3658                                               Q, MaxRecurse-1))
3659                 return V;
3660             break;
3661           }
3662         }
3663       }
3664     }
3665   }
3666 
3667   // icmp eq|ne X, Y -> false|true if X != Y
3668   // This is potentially expensive, and we have already computedKnownBits for
3669   // compares with 0 above here, so only try this for a non-zero compare.
3670   if (ICmpInst::isEquality(Pred) && !match(RHS, m_Zero()) &&
3671       isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT, Q.IIQ.UseInstrInfo)) {
3672     return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
3673   }
3674 
3675   if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3676     return V;
3677 
3678   if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
3679     return V;
3680 
3681   if (Value *V = simplifyICmpWithDominatingAssume(Pred, LHS, RHS, Q))
3682     return V;
3683 
3684   // Simplify comparisons of related pointers using a powerful, recursive
3685   // GEP-walk when we have target data available..
3686   if (LHS->getType()->isPointerTy())
3687     if (auto *C = computePointerICmp(Pred, LHS, RHS, Q))
3688       return C;
3689   if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3690     if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3691       if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3692               Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3693           Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3694               Q.DL.getTypeSizeInBits(CRHS->getType()))
3695         if (auto *C = computePointerICmp(Pred, CLHS->getPointerOperand(),
3696                                          CRHS->getPointerOperand(), Q))
3697           return C;
3698 
3699   // If the comparison is with the result of a select instruction, check whether
3700   // comparing with either branch of the select always yields the same value.
3701   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3702     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3703       return V;
3704 
3705   // If the comparison is with the result of a phi instruction, check whether
3706   // doing the compare with each incoming phi value yields a common result.
3707   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3708     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3709       return V;
3710 
3711   return nullptr;
3712 }
3713 
3714 Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3715                               const SimplifyQuery &Q) {
3716   return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3717 }
3718 
3719 /// Given operands for an FCmpInst, see if we can fold the result.
3720 /// If not, this returns null.
3721 static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3722                                FastMathFlags FMF, const SimplifyQuery &Q,
3723                                unsigned MaxRecurse) {
3724   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3725   assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3726 
3727   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
3728     if (Constant *CRHS = dyn_cast<Constant>(RHS))
3729       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
3730 
3731     // If we have a constant, make sure it is on the RHS.
3732     std::swap(LHS, RHS);
3733     Pred = CmpInst::getSwappedPredicate(Pred);
3734   }
3735 
3736   // Fold trivial predicates.
3737   Type *RetTy = GetCompareTy(LHS);
3738   if (Pred == FCmpInst::FCMP_FALSE)
3739     return getFalse(RetTy);
3740   if (Pred == FCmpInst::FCMP_TRUE)
3741     return getTrue(RetTy);
3742 
3743   // Fold (un)ordered comparison if we can determine there are no NaNs.
3744   if (Pred == FCmpInst::FCMP_UNO || Pred == FCmpInst::FCMP_ORD)
3745     if (FMF.noNaNs() ||
3746         (isKnownNeverNaN(LHS, Q.TLI) && isKnownNeverNaN(RHS, Q.TLI)))
3747       return ConstantInt::get(RetTy, Pred == FCmpInst::FCMP_ORD);
3748 
3749   // NaN is unordered; NaN is not ordered.
3750   assert((FCmpInst::isOrdered(Pred) || FCmpInst::isUnordered(Pred)) &&
3751          "Comparison must be either ordered or unordered");
3752   if (match(RHS, m_NaN()))
3753     return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3754 
3755   // fcmp pred x, poison and  fcmp pred poison, x
3756   // fold to poison
3757   if (isa<PoisonValue>(LHS) || isa<PoisonValue>(RHS))
3758     return PoisonValue::get(RetTy);
3759 
3760   // fcmp pred x, undef  and  fcmp pred undef, x
3761   // fold to true if unordered, false if ordered
3762   if (Q.isUndefValue(LHS) || Q.isUndefValue(RHS)) {
3763     // Choosing NaN for the undef will always make unordered comparison succeed
3764     // and ordered comparison fail.
3765     return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3766   }
3767 
3768   // fcmp x,x -> true/false.  Not all compares are foldable.
3769   if (LHS == RHS) {
3770     if (CmpInst::isTrueWhenEqual(Pred))
3771       return getTrue(RetTy);
3772     if (CmpInst::isFalseWhenEqual(Pred))
3773       return getFalse(RetTy);
3774   }
3775 
3776   // Handle fcmp with constant RHS.
3777   // TODO: Use match with a specific FP value, so these work with vectors with
3778   // undef lanes.
3779   const APFloat *C;
3780   if (match(RHS, m_APFloat(C))) {
3781     // Check whether the constant is an infinity.
3782     if (C->isInfinity()) {
3783       if (C->isNegative()) {
3784         switch (Pred) {
3785         case FCmpInst::FCMP_OLT:
3786           // No value is ordered and less than negative infinity.
3787           return getFalse(RetTy);
3788         case FCmpInst::FCMP_UGE:
3789           // All values are unordered with or at least negative infinity.
3790           return getTrue(RetTy);
3791         default:
3792           break;
3793         }
3794       } else {
3795         switch (Pred) {
3796         case FCmpInst::FCMP_OGT:
3797           // No value is ordered and greater than infinity.
3798           return getFalse(RetTy);
3799         case FCmpInst::FCMP_ULE:
3800           // All values are unordered with and at most infinity.
3801           return getTrue(RetTy);
3802         default:
3803           break;
3804         }
3805       }
3806 
3807       // LHS == Inf
3808       if (Pred == FCmpInst::FCMP_OEQ && isKnownNeverInfinity(LHS, Q.TLI))
3809         return getFalse(RetTy);
3810       // LHS != Inf
3811       if (Pred == FCmpInst::FCMP_UNE && isKnownNeverInfinity(LHS, Q.TLI))
3812         return getTrue(RetTy);
3813       // LHS == Inf || LHS == NaN
3814       if (Pred == FCmpInst::FCMP_UEQ && isKnownNeverInfinity(LHS, Q.TLI) &&
3815           isKnownNeverNaN(LHS, Q.TLI))
3816         return getFalse(RetTy);
3817       // LHS != Inf && LHS != NaN
3818       if (Pred == FCmpInst::FCMP_ONE && isKnownNeverInfinity(LHS, Q.TLI) &&
3819           isKnownNeverNaN(LHS, Q.TLI))
3820         return getTrue(RetTy);
3821     }
3822     if (C->isNegative() && !C->isNegZero()) {
3823       assert(!C->isNaN() && "Unexpected NaN constant!");
3824       // TODO: We can catch more cases by using a range check rather than
3825       //       relying on CannotBeOrderedLessThanZero.
3826       switch (Pred) {
3827       case FCmpInst::FCMP_UGE:
3828       case FCmpInst::FCMP_UGT:
3829       case FCmpInst::FCMP_UNE:
3830         // (X >= 0) implies (X > C) when (C < 0)
3831         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3832           return getTrue(RetTy);
3833         break;
3834       case FCmpInst::FCMP_OEQ:
3835       case FCmpInst::FCMP_OLE:
3836       case FCmpInst::FCMP_OLT:
3837         // (X >= 0) implies !(X < C) when (C < 0)
3838         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3839           return getFalse(RetTy);
3840         break;
3841       default:
3842         break;
3843       }
3844     }
3845 
3846     // Check comparison of [minnum/maxnum with constant] with other constant.
3847     const APFloat *C2;
3848     if ((match(LHS, m_Intrinsic<Intrinsic::minnum>(m_Value(), m_APFloat(C2))) &&
3849          *C2 < *C) ||
3850         (match(LHS, m_Intrinsic<Intrinsic::maxnum>(m_Value(), m_APFloat(C2))) &&
3851          *C2 > *C)) {
3852       bool IsMaxNum =
3853           cast<IntrinsicInst>(LHS)->getIntrinsicID() == Intrinsic::maxnum;
3854       // The ordered relationship and minnum/maxnum guarantee that we do not
3855       // have NaN constants, so ordered/unordered preds are handled the same.
3856       switch (Pred) {
3857       case FCmpInst::FCMP_OEQ: case FCmpInst::FCMP_UEQ:
3858         // minnum(X, LesserC)  == C --> false
3859         // maxnum(X, GreaterC) == C --> false
3860         return getFalse(RetTy);
3861       case FCmpInst::FCMP_ONE: case FCmpInst::FCMP_UNE:
3862         // minnum(X, LesserC)  != C --> true
3863         // maxnum(X, GreaterC) != C --> true
3864         return getTrue(RetTy);
3865       case FCmpInst::FCMP_OGE: case FCmpInst::FCMP_UGE:
3866       case FCmpInst::FCMP_OGT: case FCmpInst::FCMP_UGT:
3867         // minnum(X, LesserC)  >= C --> false
3868         // minnum(X, LesserC)  >  C --> false
3869         // maxnum(X, GreaterC) >= C --> true
3870         // maxnum(X, GreaterC) >  C --> true
3871         return ConstantInt::get(RetTy, IsMaxNum);
3872       case FCmpInst::FCMP_OLE: case FCmpInst::FCMP_ULE:
3873       case FCmpInst::FCMP_OLT: case FCmpInst::FCMP_ULT:
3874         // minnum(X, LesserC)  <= C --> true
3875         // minnum(X, LesserC)  <  C --> true
3876         // maxnum(X, GreaterC) <= C --> false
3877         // maxnum(X, GreaterC) <  C --> false
3878         return ConstantInt::get(RetTy, !IsMaxNum);
3879       default:
3880         // TRUE/FALSE/ORD/UNO should be handled before this.
3881         llvm_unreachable("Unexpected fcmp predicate");
3882       }
3883     }
3884   }
3885 
3886   if (match(RHS, m_AnyZeroFP())) {
3887     switch (Pred) {
3888     case FCmpInst::FCMP_OGE:
3889     case FCmpInst::FCMP_ULT:
3890       // Positive or zero X >= 0.0 --> true
3891       // Positive or zero X <  0.0 --> false
3892       if ((FMF.noNaNs() || isKnownNeverNaN(LHS, Q.TLI)) &&
3893           CannotBeOrderedLessThanZero(LHS, Q.TLI))
3894         return Pred == FCmpInst::FCMP_OGE ? getTrue(RetTy) : getFalse(RetTy);
3895       break;
3896     case FCmpInst::FCMP_UGE:
3897     case FCmpInst::FCMP_OLT:
3898       // Positive or zero or nan X >= 0.0 --> true
3899       // Positive or zero or nan X <  0.0 --> false
3900       if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3901         return Pred == FCmpInst::FCMP_UGE ? getTrue(RetTy) : getFalse(RetTy);
3902       break;
3903     default:
3904       break;
3905     }
3906   }
3907 
3908   // If the comparison is with the result of a select instruction, check whether
3909   // comparing with either branch of the select always yields the same value.
3910   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3911     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3912       return V;
3913 
3914   // If the comparison is with the result of a phi instruction, check whether
3915   // doing the compare with each incoming phi value yields a common result.
3916   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3917     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3918       return V;
3919 
3920   return nullptr;
3921 }
3922 
3923 Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3924                               FastMathFlags FMF, const SimplifyQuery &Q) {
3925   return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
3926 }
3927 
3928 static Value *simplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
3929                                      const SimplifyQuery &Q,
3930                                      bool AllowRefinement,
3931                                      unsigned MaxRecurse) {
3932   assert(!Op->getType()->isVectorTy() && "This is not safe for vectors");
3933 
3934   // Trivial replacement.
3935   if (V == Op)
3936     return RepOp;
3937 
3938   // We cannot replace a constant, and shouldn't even try.
3939   if (isa<Constant>(Op))
3940     return nullptr;
3941 
3942   auto *I = dyn_cast<Instruction>(V);
3943   if (!I || !is_contained(I->operands(), Op))
3944     return nullptr;
3945 
3946   // Replace Op with RepOp in instruction operands.
3947   SmallVector<Value *, 8> NewOps(I->getNumOperands());
3948   transform(I->operands(), NewOps.begin(),
3949             [&](Value *V) { return V == Op ? RepOp : V; });
3950 
3951   if (!AllowRefinement) {
3952     // General InstSimplify functions may refine the result, e.g. by returning
3953     // a constant for a potentially poison value. To avoid this, implement only
3954     // a few non-refining but profitable transforms here.
3955 
3956     if (auto *BO = dyn_cast<BinaryOperator>(I)) {
3957       unsigned Opcode = BO->getOpcode();
3958       // id op x -> x, x op id -> x
3959       if (NewOps[0] == ConstantExpr::getBinOpIdentity(Opcode, I->getType()))
3960         return NewOps[1];
3961       if (NewOps[1] == ConstantExpr::getBinOpIdentity(Opcode, I->getType(),
3962                                                       /* RHS */ true))
3963         return NewOps[0];
3964 
3965       // x & x -> x, x | x -> x
3966       if ((Opcode == Instruction::And || Opcode == Instruction::Or) &&
3967           NewOps[0] == NewOps[1])
3968         return NewOps[0];
3969     }
3970 
3971     if (auto *GEP = dyn_cast<GetElementPtrInst>(I)) {
3972       // getelementptr x, 0 -> x
3973       if (NewOps.size() == 2 && match(NewOps[1], m_Zero()) &&
3974           !GEP->isInBounds())
3975         return NewOps[0];
3976     }
3977   } else if (MaxRecurse) {
3978     // The simplification queries below may return the original value. Consider:
3979     //   %div = udiv i32 %arg, %arg2
3980     //   %mul = mul nsw i32 %div, %arg2
3981     //   %cmp = icmp eq i32 %mul, %arg
3982     //   %sel = select i1 %cmp, i32 %div, i32 undef
3983     // Replacing %arg by %mul, %div becomes "udiv i32 %mul, %arg2", which
3984     // simplifies back to %arg. This can only happen because %mul does not
3985     // dominate %div. To ensure a consistent return value contract, we make sure
3986     // that this case returns nullptr as well.
3987     auto PreventSelfSimplify = [V](Value *Simplified) {
3988       return Simplified != V ? Simplified : nullptr;
3989     };
3990 
3991     if (auto *B = dyn_cast<BinaryOperator>(I))
3992       return PreventSelfSimplify(SimplifyBinOp(B->getOpcode(), NewOps[0],
3993                                                NewOps[1], Q, MaxRecurse - 1));
3994 
3995     if (CmpInst *C = dyn_cast<CmpInst>(I))
3996       return PreventSelfSimplify(SimplifyCmpInst(C->getPredicate(), NewOps[0],
3997                                                  NewOps[1], Q, MaxRecurse - 1));
3998 
3999     if (auto *GEP = dyn_cast<GetElementPtrInst>(I))
4000       return PreventSelfSimplify(SimplifyGEPInst(GEP->getSourceElementType(),
4001                                                  NewOps, GEP->isInBounds(), Q,
4002                                                  MaxRecurse - 1));
4003 
4004     if (isa<SelectInst>(I))
4005       return PreventSelfSimplify(
4006           SimplifySelectInst(NewOps[0], NewOps[1], NewOps[2], Q,
4007                              MaxRecurse - 1));
4008     // TODO: We could hand off more cases to instsimplify here.
4009   }
4010 
4011   // If all operands are constant after substituting Op for RepOp then we can
4012   // constant fold the instruction.
4013   SmallVector<Constant *, 8> ConstOps;
4014   for (Value *NewOp : NewOps) {
4015     if (Constant *ConstOp = dyn_cast<Constant>(NewOp))
4016       ConstOps.push_back(ConstOp);
4017     else
4018       return nullptr;
4019   }
4020 
4021   // Consider:
4022   //   %cmp = icmp eq i32 %x, 2147483647
4023   //   %add = add nsw i32 %x, 1
4024   //   %sel = select i1 %cmp, i32 -2147483648, i32 %add
4025   //
4026   // We can't replace %sel with %add unless we strip away the flags (which
4027   // will be done in InstCombine).
4028   // TODO: This may be unsound, because it only catches some forms of
4029   // refinement.
4030   if (!AllowRefinement && canCreatePoison(cast<Operator>(I)))
4031     return nullptr;
4032 
4033   if (CmpInst *C = dyn_cast<CmpInst>(I))
4034     return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
4035                                            ConstOps[1], Q.DL, Q.TLI);
4036 
4037   if (LoadInst *LI = dyn_cast<LoadInst>(I))
4038     if (!LI->isVolatile())
4039       return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
4040 
4041   return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
4042 }
4043 
4044 Value *llvm::simplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
4045                                     const SimplifyQuery &Q,
4046                                     bool AllowRefinement) {
4047   return ::simplifyWithOpReplaced(V, Op, RepOp, Q, AllowRefinement,
4048                                   RecursionLimit);
4049 }
4050 
4051 /// Try to simplify a select instruction when its condition operand is an
4052 /// integer comparison where one operand of the compare is a constant.
4053 static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
4054                                     const APInt *Y, bool TrueWhenUnset) {
4055   const APInt *C;
4056 
4057   // (X & Y) == 0 ? X & ~Y : X  --> X
4058   // (X & Y) != 0 ? X & ~Y : X  --> X & ~Y
4059   if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
4060       *Y == ~*C)
4061     return TrueWhenUnset ? FalseVal : TrueVal;
4062 
4063   // (X & Y) == 0 ? X : X & ~Y  --> X & ~Y
4064   // (X & Y) != 0 ? X : X & ~Y  --> X
4065   if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
4066       *Y == ~*C)
4067     return TrueWhenUnset ? FalseVal : TrueVal;
4068 
4069   if (Y->isPowerOf2()) {
4070     // (X & Y) == 0 ? X | Y : X  --> X | Y
4071     // (X & Y) != 0 ? X | Y : X  --> X
4072     if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
4073         *Y == *C)
4074       return TrueWhenUnset ? TrueVal : FalseVal;
4075 
4076     // (X & Y) == 0 ? X : X | Y  --> X
4077     // (X & Y) != 0 ? X : X | Y  --> X | Y
4078     if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
4079         *Y == *C)
4080       return TrueWhenUnset ? TrueVal : FalseVal;
4081   }
4082 
4083   return nullptr;
4084 }
4085 
4086 /// An alternative way to test if a bit is set or not uses sgt/slt instead of
4087 /// eq/ne.
4088 static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
4089                                            ICmpInst::Predicate Pred,
4090                                            Value *TrueVal, Value *FalseVal) {
4091   Value *X;
4092   APInt Mask;
4093   if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
4094     return nullptr;
4095 
4096   return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
4097                                Pred == ICmpInst::ICMP_EQ);
4098 }
4099 
4100 /// Try to simplify a select instruction when its condition operand is an
4101 /// integer comparison.
4102 static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
4103                                          Value *FalseVal, const SimplifyQuery &Q,
4104                                          unsigned MaxRecurse) {
4105   ICmpInst::Predicate Pred;
4106   Value *CmpLHS, *CmpRHS;
4107   if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
4108     return nullptr;
4109 
4110   // Canonicalize ne to eq predicate.
4111   if (Pred == ICmpInst::ICMP_NE) {
4112     Pred = ICmpInst::ICMP_EQ;
4113     std::swap(TrueVal, FalseVal);
4114   }
4115 
4116   // Check for integer min/max with a limit constant:
4117   // X > MIN_INT ? X : MIN_INT --> X
4118   // X < MAX_INT ? X : MAX_INT --> X
4119   if (TrueVal->getType()->isIntOrIntVectorTy()) {
4120     Value *X, *Y;
4121     SelectPatternFlavor SPF =
4122         matchDecomposedSelectPattern(cast<ICmpInst>(CondVal), TrueVal, FalseVal,
4123                                      X, Y).Flavor;
4124     if (SelectPatternResult::isMinOrMax(SPF) && Pred == getMinMaxPred(SPF)) {
4125       APInt LimitC = getMinMaxLimit(getInverseMinMaxFlavor(SPF),
4126                                     X->getType()->getScalarSizeInBits());
4127       if (match(Y, m_SpecificInt(LimitC)))
4128         return X;
4129     }
4130   }
4131 
4132   if (Pred == ICmpInst::ICMP_EQ && match(CmpRHS, m_Zero())) {
4133     Value *X;
4134     const APInt *Y;
4135     if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
4136       if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
4137                                            /*TrueWhenUnset=*/true))
4138         return V;
4139 
4140     // Test for a bogus zero-shift-guard-op around funnel-shift or rotate.
4141     Value *ShAmt;
4142     auto isFsh = m_CombineOr(m_FShl(m_Value(X), m_Value(), m_Value(ShAmt)),
4143                              m_FShr(m_Value(), m_Value(X), m_Value(ShAmt)));
4144     // (ShAmt == 0) ? fshl(X, *, ShAmt) : X --> X
4145     // (ShAmt == 0) ? fshr(*, X, ShAmt) : X --> X
4146     if (match(TrueVal, isFsh) && FalseVal == X && CmpLHS == ShAmt)
4147       return X;
4148 
4149     // Test for a zero-shift-guard-op around rotates. These are used to
4150     // avoid UB from oversized shifts in raw IR rotate patterns, but the
4151     // intrinsics do not have that problem.
4152     // We do not allow this transform for the general funnel shift case because
4153     // that would not preserve the poison safety of the original code.
4154     auto isRotate =
4155         m_CombineOr(m_FShl(m_Value(X), m_Deferred(X), m_Value(ShAmt)),
4156                     m_FShr(m_Value(X), m_Deferred(X), m_Value(ShAmt)));
4157     // (ShAmt == 0) ? X : fshl(X, X, ShAmt) --> fshl(X, X, ShAmt)
4158     // (ShAmt == 0) ? X : fshr(X, X, ShAmt) --> fshr(X, X, ShAmt)
4159     if (match(FalseVal, isRotate) && TrueVal == X && CmpLHS == ShAmt &&
4160         Pred == ICmpInst::ICMP_EQ)
4161       return FalseVal;
4162 
4163     // X == 0 ? abs(X) : -abs(X) --> -abs(X)
4164     // X == 0 ? -abs(X) : abs(X) --> abs(X)
4165     if (match(TrueVal, m_Intrinsic<Intrinsic::abs>(m_Specific(CmpLHS))) &&
4166         match(FalseVal, m_Neg(m_Intrinsic<Intrinsic::abs>(m_Specific(CmpLHS)))))
4167       return FalseVal;
4168     if (match(TrueVal,
4169               m_Neg(m_Intrinsic<Intrinsic::abs>(m_Specific(CmpLHS)))) &&
4170         match(FalseVal, m_Intrinsic<Intrinsic::abs>(m_Specific(CmpLHS))))
4171       return FalseVal;
4172   }
4173 
4174   // Check for other compares that behave like bit test.
4175   if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
4176                                               TrueVal, FalseVal))
4177     return V;
4178 
4179   // If we have a scalar equality comparison, then we know the value in one of
4180   // the arms of the select. See if substituting this value into the arm and
4181   // simplifying the result yields the same value as the other arm.
4182   // Note that the equivalence/replacement opportunity does not hold for vectors
4183   // because each element of a vector select is chosen independently.
4184   if (Pred == ICmpInst::ICMP_EQ && !CondVal->getType()->isVectorTy()) {
4185     if (simplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q,
4186                                /* AllowRefinement */ false, MaxRecurse) ==
4187             TrueVal ||
4188         simplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q,
4189                                /* AllowRefinement */ false, MaxRecurse) ==
4190             TrueVal)
4191       return FalseVal;
4192     if (simplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q,
4193                                /* AllowRefinement */ true, MaxRecurse) ==
4194             FalseVal ||
4195         simplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q,
4196                                /* AllowRefinement */ true, MaxRecurse) ==
4197             FalseVal)
4198       return FalseVal;
4199   }
4200 
4201   return nullptr;
4202 }
4203 
4204 /// Try to simplify a select instruction when its condition operand is a
4205 /// floating-point comparison.
4206 static Value *simplifySelectWithFCmp(Value *Cond, Value *T, Value *F,
4207                                      const SimplifyQuery &Q) {
4208   FCmpInst::Predicate Pred;
4209   if (!match(Cond, m_FCmp(Pred, m_Specific(T), m_Specific(F))) &&
4210       !match(Cond, m_FCmp(Pred, m_Specific(F), m_Specific(T))))
4211     return nullptr;
4212 
4213   // This transform is safe if we do not have (do not care about) -0.0 or if
4214   // at least one operand is known to not be -0.0. Otherwise, the select can
4215   // change the sign of a zero operand.
4216   bool HasNoSignedZeros = Q.CxtI && isa<FPMathOperator>(Q.CxtI) &&
4217                           Q.CxtI->hasNoSignedZeros();
4218   const APFloat *C;
4219   if (HasNoSignedZeros || (match(T, m_APFloat(C)) && C->isNonZero()) ||
4220                           (match(F, m_APFloat(C)) && C->isNonZero())) {
4221     // (T == F) ? T : F --> F
4222     // (F == T) ? T : F --> F
4223     if (Pred == FCmpInst::FCMP_OEQ)
4224       return F;
4225 
4226     // (T != F) ? T : F --> T
4227     // (F != T) ? T : F --> T
4228     if (Pred == FCmpInst::FCMP_UNE)
4229       return T;
4230   }
4231 
4232   return nullptr;
4233 }
4234 
4235 /// Given operands for a SelectInst, see if we can fold the result.
4236 /// If not, this returns null.
4237 static Value *SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
4238                                  const SimplifyQuery &Q, unsigned MaxRecurse) {
4239   if (auto *CondC = dyn_cast<Constant>(Cond)) {
4240     if (auto *TrueC = dyn_cast<Constant>(TrueVal))
4241       if (auto *FalseC = dyn_cast<Constant>(FalseVal))
4242         return ConstantFoldSelectInstruction(CondC, TrueC, FalseC);
4243 
4244     // select poison, X, Y -> poison
4245     if (isa<PoisonValue>(CondC))
4246       return PoisonValue::get(TrueVal->getType());
4247 
4248     // select undef, X, Y -> X or Y
4249     if (Q.isUndefValue(CondC))
4250       return isa<Constant>(FalseVal) ? FalseVal : TrueVal;
4251 
4252     // select true,  X, Y --> X
4253     // select false, X, Y --> Y
4254     // For vectors, allow undef/poison elements in the condition to match the
4255     // defined elements, so we can eliminate the select.
4256     if (match(CondC, m_One()))
4257       return TrueVal;
4258     if (match(CondC, m_Zero()))
4259       return FalseVal;
4260   }
4261 
4262   assert(Cond->getType()->isIntOrIntVectorTy(1) &&
4263          "Select must have bool or bool vector condition");
4264   assert(TrueVal->getType() == FalseVal->getType() &&
4265          "Select must have same types for true/false ops");
4266 
4267   if (Cond->getType() == TrueVal->getType()) {
4268     // select i1 Cond, i1 true, i1 false --> i1 Cond
4269     if (match(TrueVal, m_One()) && match(FalseVal, m_ZeroInt()))
4270       return Cond;
4271 
4272     // (X || Y) && (X || !Y) --> X (commuted 8 ways)
4273     Value *X, *Y;
4274     if (match(FalseVal, m_ZeroInt())) {
4275       if (match(Cond, m_c_LogicalOr(m_Value(X), m_Not(m_Value(Y)))) &&
4276           match(TrueVal, m_c_LogicalOr(m_Specific(X), m_Specific(Y))))
4277         return X;
4278       if (match(TrueVal, m_c_LogicalOr(m_Value(X), m_Not(m_Value(Y)))) &&
4279           match(Cond, m_c_LogicalOr(m_Specific(X), m_Specific(Y))))
4280         return X;
4281     }
4282   }
4283 
4284   // select ?, X, X -> X
4285   if (TrueVal == FalseVal)
4286     return TrueVal;
4287 
4288   // If the true or false value is poison, we can fold to the other value.
4289   // If the true or false value is undef, we can fold to the other value as
4290   // long as the other value isn't poison.
4291   // select ?, poison, X -> X
4292   // select ?, undef,  X -> X
4293   if (isa<PoisonValue>(TrueVal) ||
4294       (Q.isUndefValue(TrueVal) &&
4295        isGuaranteedNotToBePoison(FalseVal, Q.AC, Q.CxtI, Q.DT)))
4296     return FalseVal;
4297   // select ?, X, poison -> X
4298   // select ?, X, undef  -> X
4299   if (isa<PoisonValue>(FalseVal) ||
4300       (Q.isUndefValue(FalseVal) &&
4301        isGuaranteedNotToBePoison(TrueVal, Q.AC, Q.CxtI, Q.DT)))
4302     return TrueVal;
4303 
4304   // Deal with partial undef vector constants: select ?, VecC, VecC' --> VecC''
4305   Constant *TrueC, *FalseC;
4306   if (isa<FixedVectorType>(TrueVal->getType()) &&
4307       match(TrueVal, m_Constant(TrueC)) &&
4308       match(FalseVal, m_Constant(FalseC))) {
4309     unsigned NumElts =
4310         cast<FixedVectorType>(TrueC->getType())->getNumElements();
4311     SmallVector<Constant *, 16> NewC;
4312     for (unsigned i = 0; i != NumElts; ++i) {
4313       // Bail out on incomplete vector constants.
4314       Constant *TEltC = TrueC->getAggregateElement(i);
4315       Constant *FEltC = FalseC->getAggregateElement(i);
4316       if (!TEltC || !FEltC)
4317         break;
4318 
4319       // If the elements match (undef or not), that value is the result. If only
4320       // one element is undef, choose the defined element as the safe result.
4321       if (TEltC == FEltC)
4322         NewC.push_back(TEltC);
4323       else if (isa<PoisonValue>(TEltC) ||
4324                (Q.isUndefValue(TEltC) && isGuaranteedNotToBePoison(FEltC)))
4325         NewC.push_back(FEltC);
4326       else if (isa<PoisonValue>(FEltC) ||
4327                (Q.isUndefValue(FEltC) && isGuaranteedNotToBePoison(TEltC)))
4328         NewC.push_back(TEltC);
4329       else
4330         break;
4331     }
4332     if (NewC.size() == NumElts)
4333       return ConstantVector::get(NewC);
4334   }
4335 
4336   if (Value *V =
4337           simplifySelectWithICmpCond(Cond, TrueVal, FalseVal, Q, MaxRecurse))
4338     return V;
4339 
4340   if (Value *V = simplifySelectWithFCmp(Cond, TrueVal, FalseVal, Q))
4341     return V;
4342 
4343   if (Value *V = foldSelectWithBinaryOp(Cond, TrueVal, FalseVal))
4344     return V;
4345 
4346   Optional<bool> Imp = isImpliedByDomCondition(Cond, Q.CxtI, Q.DL);
4347   if (Imp)
4348     return *Imp ? TrueVal : FalseVal;
4349 
4350   return nullptr;
4351 }
4352 
4353 Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
4354                                 const SimplifyQuery &Q) {
4355   return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
4356 }
4357 
4358 /// Given operands for an GetElementPtrInst, see if we can fold the result.
4359 /// If not, this returns null.
4360 static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops, bool InBounds,
4361                               const SimplifyQuery &Q, unsigned) {
4362   // The type of the GEP pointer operand.
4363   unsigned AS =
4364       cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
4365 
4366   // getelementptr P -> P.
4367   if (Ops.size() == 1)
4368     return Ops[0];
4369 
4370   // Compute the (pointer) type returned by the GEP instruction.
4371   Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
4372   Type *GEPTy = PointerType::get(LastType, AS);
4373   for (Value *Op : Ops) {
4374     // If one of the operands is a vector, the result type is a vector of
4375     // pointers. All vector operands must have the same number of elements.
4376     if (VectorType *VT = dyn_cast<VectorType>(Op->getType())) {
4377       GEPTy = VectorType::get(GEPTy, VT->getElementCount());
4378       break;
4379     }
4380   }
4381 
4382   // getelementptr poison, idx -> poison
4383   // getelementptr baseptr, poison -> poison
4384   if (any_of(Ops, [](const auto *V) { return isa<PoisonValue>(V); }))
4385     return PoisonValue::get(GEPTy);
4386 
4387   if (Q.isUndefValue(Ops[0]))
4388     return UndefValue::get(GEPTy);
4389 
4390   bool IsScalableVec =
4391       isa<ScalableVectorType>(SrcTy) || any_of(Ops, [](const Value *V) {
4392         return isa<ScalableVectorType>(V->getType());
4393       });
4394 
4395   if (Ops.size() == 2) {
4396     // getelementptr P, 0 -> P.
4397     if (match(Ops[1], m_Zero()) && Ops[0]->getType() == GEPTy)
4398       return Ops[0];
4399 
4400     Type *Ty = SrcTy;
4401     if (!IsScalableVec && Ty->isSized()) {
4402       Value *P;
4403       uint64_t C;
4404       uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
4405       // getelementptr P, N -> P if P points to a type of zero size.
4406       if (TyAllocSize == 0 && Ops[0]->getType() == GEPTy)
4407         return Ops[0];
4408 
4409       // The following transforms are only safe if the ptrtoint cast
4410       // doesn't truncate the pointers.
4411       if (Ops[1]->getType()->getScalarSizeInBits() ==
4412           Q.DL.getPointerSizeInBits(AS)) {
4413         auto CanSimplify = [GEPTy, &P, V = Ops[0]]() -> bool {
4414           return P->getType() == GEPTy &&
4415                  getUnderlyingObject(P) == getUnderlyingObject(V);
4416         };
4417         // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
4418         if (TyAllocSize == 1 &&
4419             match(Ops[1], m_Sub(m_PtrToInt(m_Value(P)),
4420                                 m_PtrToInt(m_Specific(Ops[0])))) &&
4421             CanSimplify())
4422           return P;
4423 
4424         // getelementptr V, (ashr (sub P, V), C) -> P if P points to a type of
4425         // size 1 << C.
4426         if (match(Ops[1], m_AShr(m_Sub(m_PtrToInt(m_Value(P)),
4427                                        m_PtrToInt(m_Specific(Ops[0]))),
4428                                  m_ConstantInt(C))) &&
4429             TyAllocSize == 1ULL << C && CanSimplify())
4430           return P;
4431 
4432         // getelementptr V, (sdiv (sub P, V), C) -> P if P points to a type of
4433         // size C.
4434         if (match(Ops[1], m_SDiv(m_Sub(m_PtrToInt(m_Value(P)),
4435                                        m_PtrToInt(m_Specific(Ops[0]))),
4436                                  m_SpecificInt(TyAllocSize))) &&
4437             CanSimplify())
4438           return P;
4439       }
4440     }
4441   }
4442 
4443   if (!IsScalableVec && Q.DL.getTypeAllocSize(LastType) == 1 &&
4444       all_of(Ops.slice(1).drop_back(1),
4445              [](Value *Idx) { return match(Idx, m_Zero()); })) {
4446     unsigned IdxWidth =
4447         Q.DL.getIndexSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
4448     if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == IdxWidth) {
4449       APInt BasePtrOffset(IdxWidth, 0);
4450       Value *StrippedBasePtr =
4451           Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
4452                                                             BasePtrOffset);
4453 
4454       // Avoid creating inttoptr of zero here: While LLVMs treatment of
4455       // inttoptr is generally conservative, this particular case is folded to
4456       // a null pointer, which will have incorrect provenance.
4457 
4458       // gep (gep V, C), (sub 0, V) -> C
4459       if (match(Ops.back(),
4460                 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr)))) &&
4461           !BasePtrOffset.isZero()) {
4462         auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
4463         return ConstantExpr::getIntToPtr(CI, GEPTy);
4464       }
4465       // gep (gep V, C), (xor V, -1) -> C-1
4466       if (match(Ops.back(),
4467                 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes())) &&
4468           !BasePtrOffset.isOne()) {
4469         auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
4470         return ConstantExpr::getIntToPtr(CI, GEPTy);
4471       }
4472     }
4473   }
4474 
4475   // Check to see if this is constant foldable.
4476   if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
4477     return nullptr;
4478 
4479   auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
4480                                             Ops.slice(1), InBounds);
4481   return ConstantFoldConstant(CE, Q.DL);
4482 }
4483 
4484 Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops, bool InBounds,
4485                              const SimplifyQuery &Q) {
4486   return ::SimplifyGEPInst(SrcTy, Ops, InBounds, Q, RecursionLimit);
4487 }
4488 
4489 /// Given operands for an InsertValueInst, see if we can fold the result.
4490 /// If not, this returns null.
4491 static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
4492                                       ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
4493                                       unsigned) {
4494   if (Constant *CAgg = dyn_cast<Constant>(Agg))
4495     if (Constant *CVal = dyn_cast<Constant>(Val))
4496       return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
4497 
4498   // insertvalue x, undef, n -> x
4499   if (Q.isUndefValue(Val))
4500     return Agg;
4501 
4502   // insertvalue x, (extractvalue y, n), n
4503   if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
4504     if (EV->getAggregateOperand()->getType() == Agg->getType() &&
4505         EV->getIndices() == Idxs) {
4506       // insertvalue undef, (extractvalue y, n), n -> y
4507       if (Q.isUndefValue(Agg))
4508         return EV->getAggregateOperand();
4509 
4510       // insertvalue y, (extractvalue y, n), n -> y
4511       if (Agg == EV->getAggregateOperand())
4512         return Agg;
4513     }
4514 
4515   return nullptr;
4516 }
4517 
4518 Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
4519                                      ArrayRef<unsigned> Idxs,
4520                                      const SimplifyQuery &Q) {
4521   return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
4522 }
4523 
4524 Value *llvm::SimplifyInsertElementInst(Value *Vec, Value *Val, Value *Idx,
4525                                        const SimplifyQuery &Q) {
4526   // Try to constant fold.
4527   auto *VecC = dyn_cast<Constant>(Vec);
4528   auto *ValC = dyn_cast<Constant>(Val);
4529   auto *IdxC = dyn_cast<Constant>(Idx);
4530   if (VecC && ValC && IdxC)
4531     return ConstantExpr::getInsertElement(VecC, ValC, IdxC);
4532 
4533   // For fixed-length vector, fold into poison if index is out of bounds.
4534   if (auto *CI = dyn_cast<ConstantInt>(Idx)) {
4535     if (isa<FixedVectorType>(Vec->getType()) &&
4536         CI->uge(cast<FixedVectorType>(Vec->getType())->getNumElements()))
4537       return PoisonValue::get(Vec->getType());
4538   }
4539 
4540   // If index is undef, it might be out of bounds (see above case)
4541   if (Q.isUndefValue(Idx))
4542     return PoisonValue::get(Vec->getType());
4543 
4544   // If the scalar is poison, or it is undef and there is no risk of
4545   // propagating poison from the vector value, simplify to the vector value.
4546   if (isa<PoisonValue>(Val) ||
4547       (Q.isUndefValue(Val) && isGuaranteedNotToBePoison(Vec)))
4548     return Vec;
4549 
4550   // If we are extracting a value from a vector, then inserting it into the same
4551   // place, that's the input vector:
4552   // insertelt Vec, (extractelt Vec, Idx), Idx --> Vec
4553   if (match(Val, m_ExtractElt(m_Specific(Vec), m_Specific(Idx))))
4554     return Vec;
4555 
4556   return nullptr;
4557 }
4558 
4559 /// Given operands for an ExtractValueInst, see if we can fold the result.
4560 /// If not, this returns null.
4561 static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
4562                                        const SimplifyQuery &, unsigned) {
4563   if (auto *CAgg = dyn_cast<Constant>(Agg))
4564     return ConstantFoldExtractValueInstruction(CAgg, Idxs);
4565 
4566   // extractvalue x, (insertvalue y, elt, n), n -> elt
4567   unsigned NumIdxs = Idxs.size();
4568   for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
4569        IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
4570     ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
4571     unsigned NumInsertValueIdxs = InsertValueIdxs.size();
4572     unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
4573     if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
4574         Idxs.slice(0, NumCommonIdxs)) {
4575       if (NumIdxs == NumInsertValueIdxs)
4576         return IVI->getInsertedValueOperand();
4577       break;
4578     }
4579   }
4580 
4581   return nullptr;
4582 }
4583 
4584 Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
4585                                       const SimplifyQuery &Q) {
4586   return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
4587 }
4588 
4589 /// Given operands for an ExtractElementInst, see if we can fold the result.
4590 /// If not, this returns null.
4591 static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx,
4592                                          const SimplifyQuery &Q, unsigned) {
4593   auto *VecVTy = cast<VectorType>(Vec->getType());
4594   if (auto *CVec = dyn_cast<Constant>(Vec)) {
4595     if (auto *CIdx = dyn_cast<Constant>(Idx))
4596       return ConstantExpr::getExtractElement(CVec, CIdx);
4597 
4598     if (Q.isUndefValue(Vec))
4599       return UndefValue::get(VecVTy->getElementType());
4600   }
4601 
4602   // An undef extract index can be arbitrarily chosen to be an out-of-range
4603   // index value, which would result in the instruction being poison.
4604   if (Q.isUndefValue(Idx))
4605     return PoisonValue::get(VecVTy->getElementType());
4606 
4607   // If extracting a specified index from the vector, see if we can recursively
4608   // find a previously computed scalar that was inserted into the vector.
4609   if (auto *IdxC = dyn_cast<ConstantInt>(Idx)) {
4610     // For fixed-length vector, fold into undef if index is out of bounds.
4611     unsigned MinNumElts = VecVTy->getElementCount().getKnownMinValue();
4612     if (isa<FixedVectorType>(VecVTy) && IdxC->getValue().uge(MinNumElts))
4613       return PoisonValue::get(VecVTy->getElementType());
4614     // Handle case where an element is extracted from a splat.
4615     if (IdxC->getValue().ult(MinNumElts))
4616       if (auto *Splat = getSplatValue(Vec))
4617         return Splat;
4618     if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
4619       return Elt;
4620   } else {
4621     // The index is not relevant if our vector is a splat.
4622     if (Value *Splat = getSplatValue(Vec))
4623       return Splat;
4624   }
4625   return nullptr;
4626 }
4627 
4628 Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
4629                                         const SimplifyQuery &Q) {
4630   return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
4631 }
4632 
4633 /// See if we can fold the given phi. If not, returns null.
4634 static Value *SimplifyPHINode(PHINode *PN, ArrayRef<Value *> IncomingValues,
4635                               const SimplifyQuery &Q) {
4636   // WARNING: no matter how worthwhile it may seem, we can not perform PHI CSE
4637   //          here, because the PHI we may succeed simplifying to was not
4638   //          def-reachable from the original PHI!
4639 
4640   // If all of the PHI's incoming values are the same then replace the PHI node
4641   // with the common value.
4642   Value *CommonValue = nullptr;
4643   bool HasUndefInput = false;
4644   for (Value *Incoming : IncomingValues) {
4645     // If the incoming value is the phi node itself, it can safely be skipped.
4646     if (Incoming == PN) continue;
4647     if (Q.isUndefValue(Incoming)) {
4648       // Remember that we saw an undef value, but otherwise ignore them.
4649       HasUndefInput = true;
4650       continue;
4651     }
4652     if (CommonValue && Incoming != CommonValue)
4653       return nullptr;  // Not the same, bail out.
4654     CommonValue = Incoming;
4655   }
4656 
4657   // If CommonValue is null then all of the incoming values were either undef or
4658   // equal to the phi node itself.
4659   if (!CommonValue)
4660     return UndefValue::get(PN->getType());
4661 
4662   // If we have a PHI node like phi(X, undef, X), where X is defined by some
4663   // instruction, we cannot return X as the result of the PHI node unless it
4664   // dominates the PHI block.
4665   if (HasUndefInput)
4666     return valueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
4667 
4668   return CommonValue;
4669 }
4670 
4671 static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
4672                                Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
4673   if (auto *C = dyn_cast<Constant>(Op))
4674     return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
4675 
4676   if (auto *CI = dyn_cast<CastInst>(Op)) {
4677     auto *Src = CI->getOperand(0);
4678     Type *SrcTy = Src->getType();
4679     Type *MidTy = CI->getType();
4680     Type *DstTy = Ty;
4681     if (Src->getType() == Ty) {
4682       auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4683       auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4684       Type *SrcIntPtrTy =
4685           SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4686       Type *MidIntPtrTy =
4687           MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4688       Type *DstIntPtrTy =
4689           DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4690       if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4691                                          SrcIntPtrTy, MidIntPtrTy,
4692                                          DstIntPtrTy) == Instruction::BitCast)
4693         return Src;
4694     }
4695   }
4696 
4697   // bitcast x -> x
4698   if (CastOpc == Instruction::BitCast)
4699     if (Op->getType() == Ty)
4700       return Op;
4701 
4702   return nullptr;
4703 }
4704 
4705 Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
4706                               const SimplifyQuery &Q) {
4707   return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4708 }
4709 
4710 /// For the given destination element of a shuffle, peek through shuffles to
4711 /// match a root vector source operand that contains that element in the same
4712 /// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4713 static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
4714                                    int MaskVal, Value *RootVec,
4715                                    unsigned MaxRecurse) {
4716   if (!MaxRecurse--)
4717     return nullptr;
4718 
4719   // Bail out if any mask value is undefined. That kind of shuffle may be
4720   // simplified further based on demanded bits or other folds.
4721   if (MaskVal == -1)
4722     return nullptr;
4723 
4724   // The mask value chooses which source operand we need to look at next.
4725   int InVecNumElts = cast<FixedVectorType>(Op0->getType())->getNumElements();
4726   int RootElt = MaskVal;
4727   Value *SourceOp = Op0;
4728   if (MaskVal >= InVecNumElts) {
4729     RootElt = MaskVal - InVecNumElts;
4730     SourceOp = Op1;
4731   }
4732 
4733   // If the source operand is a shuffle itself, look through it to find the
4734   // matching root vector.
4735   if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4736     return foldIdentityShuffles(
4737         DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
4738         SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
4739   }
4740 
4741   // TODO: Look through bitcasts? What if the bitcast changes the vector element
4742   // size?
4743 
4744   // The source operand is not a shuffle. Initialize the root vector value for
4745   // this shuffle if that has not been done yet.
4746   if (!RootVec)
4747     RootVec = SourceOp;
4748 
4749   // Give up as soon as a source operand does not match the existing root value.
4750   if (RootVec != SourceOp)
4751     return nullptr;
4752 
4753   // The element must be coming from the same lane in the source vector
4754   // (although it may have crossed lanes in intermediate shuffles).
4755   if (RootElt != DestElt)
4756     return nullptr;
4757 
4758   return RootVec;
4759 }
4760 
4761 static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1,
4762                                         ArrayRef<int> Mask, Type *RetTy,
4763                                         const SimplifyQuery &Q,
4764                                         unsigned MaxRecurse) {
4765   if (all_of(Mask, [](int Elem) { return Elem == UndefMaskElem; }))
4766     return UndefValue::get(RetTy);
4767 
4768   auto *InVecTy = cast<VectorType>(Op0->getType());
4769   unsigned MaskNumElts = Mask.size();
4770   ElementCount InVecEltCount = InVecTy->getElementCount();
4771 
4772   bool Scalable = InVecEltCount.isScalable();
4773 
4774   SmallVector<int, 32> Indices;
4775   Indices.assign(Mask.begin(), Mask.end());
4776 
4777   // Canonicalization: If mask does not select elements from an input vector,
4778   // replace that input vector with poison.
4779   if (!Scalable) {
4780     bool MaskSelects0 = false, MaskSelects1 = false;
4781     unsigned InVecNumElts = InVecEltCount.getKnownMinValue();
4782     for (unsigned i = 0; i != MaskNumElts; ++i) {
4783       if (Indices[i] == -1)
4784         continue;
4785       if ((unsigned)Indices[i] < InVecNumElts)
4786         MaskSelects0 = true;
4787       else
4788         MaskSelects1 = true;
4789     }
4790     if (!MaskSelects0)
4791       Op0 = PoisonValue::get(InVecTy);
4792     if (!MaskSelects1)
4793       Op1 = PoisonValue::get(InVecTy);
4794   }
4795 
4796   auto *Op0Const = dyn_cast<Constant>(Op0);
4797   auto *Op1Const = dyn_cast<Constant>(Op1);
4798 
4799   // If all operands are constant, constant fold the shuffle. This
4800   // transformation depends on the value of the mask which is not known at
4801   // compile time for scalable vectors
4802   if (Op0Const && Op1Const)
4803     return ConstantExpr::getShuffleVector(Op0Const, Op1Const, Mask);
4804 
4805   // Canonicalization: if only one input vector is constant, it shall be the
4806   // second one. This transformation depends on the value of the mask which
4807   // is not known at compile time for scalable vectors
4808   if (!Scalable && Op0Const && !Op1Const) {
4809     std::swap(Op0, Op1);
4810     ShuffleVectorInst::commuteShuffleMask(Indices,
4811                                           InVecEltCount.getKnownMinValue());
4812   }
4813 
4814   // A splat of an inserted scalar constant becomes a vector constant:
4815   // shuf (inselt ?, C, IndexC), undef, <IndexC, IndexC...> --> <C, C...>
4816   // NOTE: We may have commuted above, so analyze the updated Indices, not the
4817   //       original mask constant.
4818   // NOTE: This transformation depends on the value of the mask which is not
4819   // known at compile time for scalable vectors
4820   Constant *C;
4821   ConstantInt *IndexC;
4822   if (!Scalable && match(Op0, m_InsertElt(m_Value(), m_Constant(C),
4823                                           m_ConstantInt(IndexC)))) {
4824     // Match a splat shuffle mask of the insert index allowing undef elements.
4825     int InsertIndex = IndexC->getZExtValue();
4826     if (all_of(Indices, [InsertIndex](int MaskElt) {
4827           return MaskElt == InsertIndex || MaskElt == -1;
4828         })) {
4829       assert(isa<UndefValue>(Op1) && "Expected undef operand 1 for splat");
4830 
4831       // Shuffle mask undefs become undefined constant result elements.
4832       SmallVector<Constant *, 16> VecC(MaskNumElts, C);
4833       for (unsigned i = 0; i != MaskNumElts; ++i)
4834         if (Indices[i] == -1)
4835           VecC[i] = UndefValue::get(C->getType());
4836       return ConstantVector::get(VecC);
4837     }
4838   }
4839 
4840   // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4841   // value type is same as the input vectors' type.
4842   if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
4843     if (Q.isUndefValue(Op1) && RetTy == InVecTy &&
4844         is_splat(OpShuf->getShuffleMask()))
4845       return Op0;
4846 
4847   // All remaining transformation depend on the value of the mask, which is
4848   // not known at compile time for scalable vectors.
4849   if (Scalable)
4850     return nullptr;
4851 
4852   // Don't fold a shuffle with undef mask elements. This may get folded in a
4853   // better way using demanded bits or other analysis.
4854   // TODO: Should we allow this?
4855   if (is_contained(Indices, -1))
4856     return nullptr;
4857 
4858   // Check if every element of this shuffle can be mapped back to the
4859   // corresponding element of a single root vector. If so, we don't need this
4860   // shuffle. This handles simple identity shuffles as well as chains of
4861   // shuffles that may widen/narrow and/or move elements across lanes and back.
4862   Value *RootVec = nullptr;
4863   for (unsigned i = 0; i != MaskNumElts; ++i) {
4864     // Note that recursion is limited for each vector element, so if any element
4865     // exceeds the limit, this will fail to simplify.
4866     RootVec =
4867         foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
4868 
4869     // We can't replace a widening/narrowing shuffle with one of its operands.
4870     if (!RootVec || RootVec->getType() != RetTy)
4871       return nullptr;
4872   }
4873   return RootVec;
4874 }
4875 
4876 /// Given operands for a ShuffleVectorInst, fold the result or return null.
4877 Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1,
4878                                        ArrayRef<int> Mask, Type *RetTy,
4879                                        const SimplifyQuery &Q) {
4880   return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
4881 }
4882 
4883 static Constant *foldConstant(Instruction::UnaryOps Opcode,
4884                               Value *&Op, const SimplifyQuery &Q) {
4885   if (auto *C = dyn_cast<Constant>(Op))
4886     return ConstantFoldUnaryOpOperand(Opcode, C, Q.DL);
4887   return nullptr;
4888 }
4889 
4890 /// Given the operand for an FNeg, see if we can fold the result.  If not, this
4891 /// returns null.
4892 static Value *simplifyFNegInst(Value *Op, FastMathFlags FMF,
4893                                const SimplifyQuery &Q, unsigned MaxRecurse) {
4894   if (Constant *C = foldConstant(Instruction::FNeg, Op, Q))
4895     return C;
4896 
4897   Value *X;
4898   // fneg (fneg X) ==> X
4899   if (match(Op, m_FNeg(m_Value(X))))
4900     return X;
4901 
4902   return nullptr;
4903 }
4904 
4905 Value *llvm::SimplifyFNegInst(Value *Op, FastMathFlags FMF,
4906                               const SimplifyQuery &Q) {
4907   return ::simplifyFNegInst(Op, FMF, Q, RecursionLimit);
4908 }
4909 
4910 static Constant *propagateNaN(Constant *In) {
4911   // If the input is a vector with undef elements, just return a default NaN.
4912   if (!In->isNaN())
4913     return ConstantFP::getNaN(In->getType());
4914 
4915   // Propagate the existing NaN constant when possible.
4916   // TODO: Should we quiet a signaling NaN?
4917   return In;
4918 }
4919 
4920 /// Perform folds that are common to any floating-point operation. This implies
4921 /// transforms based on poison/undef/NaN because the operation itself makes no
4922 /// difference to the result.
4923 static Constant *simplifyFPOp(ArrayRef<Value *> Ops, FastMathFlags FMF,
4924                               const SimplifyQuery &Q,
4925                               fp::ExceptionBehavior ExBehavior,
4926                               RoundingMode Rounding) {
4927   // Poison is independent of anything else. It always propagates from an
4928   // operand to a math result.
4929   if (any_of(Ops, [](Value *V) { return match(V, m_Poison()); }))
4930     return PoisonValue::get(Ops[0]->getType());
4931 
4932   for (Value *V : Ops) {
4933     bool IsNan = match(V, m_NaN());
4934     bool IsInf = match(V, m_Inf());
4935     bool IsUndef = Q.isUndefValue(V);
4936 
4937     // If this operation has 'nnan' or 'ninf' and at least 1 disallowed operand
4938     // (an undef operand can be chosen to be Nan/Inf), then the result of
4939     // this operation is poison.
4940     if (FMF.noNaNs() && (IsNan || IsUndef))
4941       return PoisonValue::get(V->getType());
4942     if (FMF.noInfs() && (IsInf || IsUndef))
4943       return PoisonValue::get(V->getType());
4944 
4945     if (isDefaultFPEnvironment(ExBehavior, Rounding)) {
4946       if (IsUndef || IsNan)
4947         return propagateNaN(cast<Constant>(V));
4948     } else if (ExBehavior != fp::ebStrict) {
4949       if (IsNan)
4950         return propagateNaN(cast<Constant>(V));
4951     }
4952   }
4953   return nullptr;
4954 }
4955 
4956 // TODO: Move this out to a header file:
4957 static inline bool canIgnoreSNaN(fp::ExceptionBehavior EB, FastMathFlags FMF) {
4958   return (EB == fp::ebIgnore || FMF.noNaNs());
4959 }
4960 
4961 /// Given operands for an FAdd, see if we can fold the result.  If not, this
4962 /// returns null.
4963 static Value *
4964 SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4965                  const SimplifyQuery &Q, unsigned MaxRecurse,
4966                  fp::ExceptionBehavior ExBehavior = fp::ebIgnore,
4967                  RoundingMode Rounding = RoundingMode::NearestTiesToEven) {
4968   if (isDefaultFPEnvironment(ExBehavior, Rounding))
4969     if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
4970       return C;
4971 
4972   if (Constant *C = simplifyFPOp({Op0, Op1}, FMF, Q, ExBehavior, Rounding))
4973     return C;
4974 
4975   // fadd X, -0 ==> X
4976   // With strict/constrained FP, we have these possible edge cases that do
4977   // not simplify to Op0:
4978   // fadd SNaN, -0.0 --> QNaN
4979   // fadd +0.0, -0.0 --> -0.0 (but only with round toward negative)
4980   if (canIgnoreSNaN(ExBehavior, FMF) &&
4981       (!canRoundingModeBe(Rounding, RoundingMode::TowardNegative) ||
4982        FMF.noSignedZeros()))
4983     if (match(Op1, m_NegZeroFP()))
4984       return Op0;
4985 
4986   // fadd X, 0 ==> X, when we know X is not -0
4987   if (canIgnoreSNaN(ExBehavior, FMF))
4988     if (match(Op1, m_PosZeroFP()) &&
4989         (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4990       return Op0;
4991 
4992   if (!isDefaultFPEnvironment(ExBehavior, Rounding))
4993     return nullptr;
4994 
4995   // With nnan: -X + X --> 0.0 (and commuted variant)
4996   // We don't have to explicitly exclude infinities (ninf): INF + -INF == NaN.
4997   // Negative zeros are allowed because we always end up with positive zero:
4998   // X = -0.0: (-0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4999   // X = -0.0: ( 0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
5000   // X =  0.0: (-0.0 - ( 0.0)) + ( 0.0) == (-0.0) + ( 0.0) == 0.0
5001   // X =  0.0: ( 0.0 - ( 0.0)) + ( 0.0) == ( 0.0) + ( 0.0) == 0.0
5002   if (FMF.noNaNs()) {
5003     if (match(Op0, m_FSub(m_AnyZeroFP(), m_Specific(Op1))) ||
5004         match(Op1, m_FSub(m_AnyZeroFP(), m_Specific(Op0))))
5005       return ConstantFP::getNullValue(Op0->getType());
5006 
5007     if (match(Op0, m_FNeg(m_Specific(Op1))) ||
5008         match(Op1, m_FNeg(m_Specific(Op0))))
5009       return ConstantFP::getNullValue(Op0->getType());
5010   }
5011 
5012   // (X - Y) + Y --> X
5013   // Y + (X - Y) --> X
5014   Value *X;
5015   if (FMF.noSignedZeros() && FMF.allowReassoc() &&
5016       (match(Op0, m_FSub(m_Value(X), m_Specific(Op1))) ||
5017        match(Op1, m_FSub(m_Value(X), m_Specific(Op0)))))
5018     return X;
5019 
5020   return nullptr;
5021 }
5022 
5023 /// Given operands for an FSub, see if we can fold the result.  If not, this
5024 /// returns null.
5025 static Value *
5026 SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5027                  const SimplifyQuery &Q, unsigned MaxRecurse,
5028                  fp::ExceptionBehavior ExBehavior = fp::ebIgnore,
5029                  RoundingMode Rounding = RoundingMode::NearestTiesToEven) {
5030   if (isDefaultFPEnvironment(ExBehavior, Rounding))
5031     if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
5032       return C;
5033 
5034   if (Constant *C = simplifyFPOp({Op0, Op1}, FMF, Q, ExBehavior, Rounding))
5035     return C;
5036 
5037   if (!isDefaultFPEnvironment(ExBehavior, Rounding))
5038     return nullptr;
5039 
5040   // fsub X, +0 ==> X
5041   if (match(Op1, m_PosZeroFP()))
5042     return Op0;
5043 
5044   // fsub X, -0 ==> X, when we know X is not -0
5045   if (match(Op1, m_NegZeroFP()) &&
5046       (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
5047     return Op0;
5048 
5049   // fsub -0.0, (fsub -0.0, X) ==> X
5050   // fsub -0.0, (fneg X) ==> X
5051   Value *X;
5052   if (match(Op0, m_NegZeroFP()) &&
5053       match(Op1, m_FNeg(m_Value(X))))
5054     return X;
5055 
5056   // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
5057   // fsub 0.0, (fneg X) ==> X if signed zeros are ignored.
5058   if (FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()) &&
5059       (match(Op1, m_FSub(m_AnyZeroFP(), m_Value(X))) ||
5060        match(Op1, m_FNeg(m_Value(X)))))
5061     return X;
5062 
5063   // fsub nnan x, x ==> 0.0
5064   if (FMF.noNaNs() && Op0 == Op1)
5065     return Constant::getNullValue(Op0->getType());
5066 
5067   // Y - (Y - X) --> X
5068   // (X + Y) - Y --> X
5069   if (FMF.noSignedZeros() && FMF.allowReassoc() &&
5070       (match(Op1, m_FSub(m_Specific(Op0), m_Value(X))) ||
5071        match(Op0, m_c_FAdd(m_Specific(Op1), m_Value(X)))))
5072     return X;
5073 
5074   return nullptr;
5075 }
5076 
5077 static Value *SimplifyFMAFMul(Value *Op0, Value *Op1, FastMathFlags FMF,
5078                               const SimplifyQuery &Q, unsigned MaxRecurse,
5079                               fp::ExceptionBehavior ExBehavior,
5080                               RoundingMode Rounding) {
5081   if (Constant *C = simplifyFPOp({Op0, Op1}, FMF, Q, ExBehavior, Rounding))
5082     return C;
5083 
5084   if (!isDefaultFPEnvironment(ExBehavior, Rounding))
5085     return nullptr;
5086 
5087   // fmul X, 1.0 ==> X
5088   if (match(Op1, m_FPOne()))
5089     return Op0;
5090 
5091   // fmul 1.0, X ==> X
5092   if (match(Op0, m_FPOne()))
5093     return Op1;
5094 
5095   // fmul nnan nsz X, 0 ==> 0
5096   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZeroFP()))
5097     return ConstantFP::getNullValue(Op0->getType());
5098 
5099   // fmul nnan nsz 0, X ==> 0
5100   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()))
5101     return ConstantFP::getNullValue(Op1->getType());
5102 
5103   // sqrt(X) * sqrt(X) --> X, if we can:
5104   // 1. Remove the intermediate rounding (reassociate).
5105   // 2. Ignore non-zero negative numbers because sqrt would produce NAN.
5106   // 3. Ignore -0.0 because sqrt(-0.0) == -0.0, but -0.0 * -0.0 == 0.0.
5107   Value *X;
5108   if (Op0 == Op1 && match(Op0, m_Intrinsic<Intrinsic::sqrt>(m_Value(X))) &&
5109       FMF.allowReassoc() && FMF.noNaNs() && FMF.noSignedZeros())
5110     return X;
5111 
5112   return nullptr;
5113 }
5114 
5115 /// Given the operands for an FMul, see if we can fold the result
5116 static Value *
5117 SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5118                  const SimplifyQuery &Q, unsigned MaxRecurse,
5119                  fp::ExceptionBehavior ExBehavior = fp::ebIgnore,
5120                  RoundingMode Rounding = RoundingMode::NearestTiesToEven) {
5121   if (isDefaultFPEnvironment(ExBehavior, Rounding))
5122     if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
5123       return C;
5124 
5125   // Now apply simplifications that do not require rounding.
5126   return SimplifyFMAFMul(Op0, Op1, FMF, Q, MaxRecurse, ExBehavior, Rounding);
5127 }
5128 
5129 Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5130                               const SimplifyQuery &Q,
5131                               fp::ExceptionBehavior ExBehavior,
5132                               RoundingMode Rounding) {
5133   return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit, ExBehavior,
5134                             Rounding);
5135 }
5136 
5137 Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5138                               const SimplifyQuery &Q,
5139                               fp::ExceptionBehavior ExBehavior,
5140                               RoundingMode Rounding) {
5141   return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit, ExBehavior,
5142                             Rounding);
5143 }
5144 
5145 Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5146                               const SimplifyQuery &Q,
5147                               fp::ExceptionBehavior ExBehavior,
5148                               RoundingMode Rounding) {
5149   return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit, ExBehavior,
5150                             Rounding);
5151 }
5152 
5153 Value *llvm::SimplifyFMAFMul(Value *Op0, Value *Op1, FastMathFlags FMF,
5154                              const SimplifyQuery &Q,
5155                              fp::ExceptionBehavior ExBehavior,
5156                              RoundingMode Rounding) {
5157   return ::SimplifyFMAFMul(Op0, Op1, FMF, Q, RecursionLimit, ExBehavior,
5158                            Rounding);
5159 }
5160 
5161 static Value *
5162 SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5163                  const SimplifyQuery &Q, unsigned,
5164                  fp::ExceptionBehavior ExBehavior = fp::ebIgnore,
5165                  RoundingMode Rounding = RoundingMode::NearestTiesToEven) {
5166   if (isDefaultFPEnvironment(ExBehavior, Rounding))
5167     if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
5168       return C;
5169 
5170   if (Constant *C = simplifyFPOp({Op0, Op1}, FMF, Q, ExBehavior, Rounding))
5171     return C;
5172 
5173   if (!isDefaultFPEnvironment(ExBehavior, Rounding))
5174     return nullptr;
5175 
5176   // X / 1.0 -> X
5177   if (match(Op1, m_FPOne()))
5178     return Op0;
5179 
5180   // 0 / X -> 0
5181   // Requires that NaNs are off (X could be zero) and signed zeroes are
5182   // ignored (X could be positive or negative, so the output sign is unknown).
5183   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()))
5184     return ConstantFP::getNullValue(Op0->getType());
5185 
5186   if (FMF.noNaNs()) {
5187     // X / X -> 1.0 is legal when NaNs are ignored.
5188     // We can ignore infinities because INF/INF is NaN.
5189     if (Op0 == Op1)
5190       return ConstantFP::get(Op0->getType(), 1.0);
5191 
5192     // (X * Y) / Y --> X if we can reassociate to the above form.
5193     Value *X;
5194     if (FMF.allowReassoc() && match(Op0, m_c_FMul(m_Value(X), m_Specific(Op1))))
5195       return X;
5196 
5197     // -X /  X -> -1.0 and
5198     //  X / -X -> -1.0 are legal when NaNs are ignored.
5199     // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
5200     if (match(Op0, m_FNegNSZ(m_Specific(Op1))) ||
5201         match(Op1, m_FNegNSZ(m_Specific(Op0))))
5202       return ConstantFP::get(Op0->getType(), -1.0);
5203   }
5204 
5205   return nullptr;
5206 }
5207 
5208 Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5209                               const SimplifyQuery &Q,
5210                               fp::ExceptionBehavior ExBehavior,
5211                               RoundingMode Rounding) {
5212   return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit, ExBehavior,
5213                             Rounding);
5214 }
5215 
5216 static Value *
5217 SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5218                  const SimplifyQuery &Q, unsigned,
5219                  fp::ExceptionBehavior ExBehavior = fp::ebIgnore,
5220                  RoundingMode Rounding = RoundingMode::NearestTiesToEven) {
5221   if (isDefaultFPEnvironment(ExBehavior, Rounding))
5222     if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
5223       return C;
5224 
5225   if (Constant *C = simplifyFPOp({Op0, Op1}, FMF, Q, ExBehavior, Rounding))
5226     return C;
5227 
5228   if (!isDefaultFPEnvironment(ExBehavior, Rounding))
5229     return nullptr;
5230 
5231   // Unlike fdiv, the result of frem always matches the sign of the dividend.
5232   // The constant match may include undef elements in a vector, so return a full
5233   // zero constant as the result.
5234   if (FMF.noNaNs()) {
5235     // +0 % X -> 0
5236     if (match(Op0, m_PosZeroFP()))
5237       return ConstantFP::getNullValue(Op0->getType());
5238     // -0 % X -> -0
5239     if (match(Op0, m_NegZeroFP()))
5240       return ConstantFP::getNegativeZero(Op0->getType());
5241   }
5242 
5243   return nullptr;
5244 }
5245 
5246 Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
5247                               const SimplifyQuery &Q,
5248                               fp::ExceptionBehavior ExBehavior,
5249                               RoundingMode Rounding) {
5250   return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit, ExBehavior,
5251                             Rounding);
5252 }
5253 
5254 //=== Helper functions for higher up the class hierarchy.
5255 
5256 /// Given the operand for a UnaryOperator, see if we can fold the result.
5257 /// If not, this returns null.
5258 static Value *simplifyUnOp(unsigned Opcode, Value *Op, const SimplifyQuery &Q,
5259                            unsigned MaxRecurse) {
5260   switch (Opcode) {
5261   case Instruction::FNeg:
5262     return simplifyFNegInst(Op, FastMathFlags(), Q, MaxRecurse);
5263   default:
5264     llvm_unreachable("Unexpected opcode");
5265   }
5266 }
5267 
5268 /// Given the operand for a UnaryOperator, see if we can fold the result.
5269 /// If not, this returns null.
5270 /// Try to use FastMathFlags when folding the result.
5271 static Value *simplifyFPUnOp(unsigned Opcode, Value *Op,
5272                              const FastMathFlags &FMF,
5273                              const SimplifyQuery &Q, unsigned MaxRecurse) {
5274   switch (Opcode) {
5275   case Instruction::FNeg:
5276     return simplifyFNegInst(Op, FMF, Q, MaxRecurse);
5277   default:
5278     return simplifyUnOp(Opcode, Op, Q, MaxRecurse);
5279   }
5280 }
5281 
5282 Value *llvm::SimplifyUnOp(unsigned Opcode, Value *Op, const SimplifyQuery &Q) {
5283   return ::simplifyUnOp(Opcode, Op, Q, RecursionLimit);
5284 }
5285 
5286 Value *llvm::SimplifyUnOp(unsigned Opcode, Value *Op, FastMathFlags FMF,
5287                           const SimplifyQuery &Q) {
5288   return ::simplifyFPUnOp(Opcode, Op, FMF, Q, RecursionLimit);
5289 }
5290 
5291 /// Given operands for a BinaryOperator, see if we can fold the result.
5292 /// If not, this returns null.
5293 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
5294                             const SimplifyQuery &Q, unsigned MaxRecurse) {
5295   switch (Opcode) {
5296   case Instruction::Add:
5297     return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
5298   case Instruction::Sub:
5299     return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
5300   case Instruction::Mul:
5301     return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
5302   case Instruction::SDiv:
5303     return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
5304   case Instruction::UDiv:
5305     return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
5306   case Instruction::SRem:
5307     return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
5308   case Instruction::URem:
5309     return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
5310   case Instruction::Shl:
5311     return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
5312   case Instruction::LShr:
5313     return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
5314   case Instruction::AShr:
5315     return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
5316   case Instruction::And:
5317     return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
5318   case Instruction::Or:
5319     return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
5320   case Instruction::Xor:
5321     return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
5322   case Instruction::FAdd:
5323     return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
5324   case Instruction::FSub:
5325     return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
5326   case Instruction::FMul:
5327     return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
5328   case Instruction::FDiv:
5329     return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
5330   case Instruction::FRem:
5331     return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
5332   default:
5333     llvm_unreachable("Unexpected opcode");
5334   }
5335 }
5336 
5337 /// Given operands for a BinaryOperator, see if we can fold the result.
5338 /// If not, this returns null.
5339 /// Try to use FastMathFlags when folding the result.
5340 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
5341                             const FastMathFlags &FMF, const SimplifyQuery &Q,
5342                             unsigned MaxRecurse) {
5343   switch (Opcode) {
5344   case Instruction::FAdd:
5345     return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
5346   case Instruction::FSub:
5347     return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
5348   case Instruction::FMul:
5349     return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
5350   case Instruction::FDiv:
5351     return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
5352   default:
5353     return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
5354   }
5355 }
5356 
5357 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
5358                            const SimplifyQuery &Q) {
5359   return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
5360 }
5361 
5362 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
5363                            FastMathFlags FMF, const SimplifyQuery &Q) {
5364   return ::SimplifyBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
5365 }
5366 
5367 /// Given operands for a CmpInst, see if we can fold the result.
5368 static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
5369                               const SimplifyQuery &Q, unsigned MaxRecurse) {
5370   if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
5371     return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
5372   return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
5373 }
5374 
5375 Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
5376                              const SimplifyQuery &Q) {
5377   return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
5378 }
5379 
5380 static bool IsIdempotent(Intrinsic::ID ID) {
5381   switch (ID) {
5382   default: return false;
5383 
5384   // Unary idempotent: f(f(x)) = f(x)
5385   case Intrinsic::fabs:
5386   case Intrinsic::floor:
5387   case Intrinsic::ceil:
5388   case Intrinsic::trunc:
5389   case Intrinsic::rint:
5390   case Intrinsic::nearbyint:
5391   case Intrinsic::round:
5392   case Intrinsic::roundeven:
5393   case Intrinsic::canonicalize:
5394     return true;
5395   }
5396 }
5397 
5398 static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
5399                                    const DataLayout &DL) {
5400   GlobalValue *PtrSym;
5401   APInt PtrOffset;
5402   if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
5403     return nullptr;
5404 
5405   Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
5406   Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
5407   Type *Int32PtrTy = Int32Ty->getPointerTo();
5408   Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
5409 
5410   auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
5411   if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
5412     return nullptr;
5413 
5414   uint64_t OffsetInt = OffsetConstInt->getSExtValue();
5415   if (OffsetInt % 4 != 0)
5416     return nullptr;
5417 
5418   Constant *C = ConstantExpr::getGetElementPtr(
5419       Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
5420       ConstantInt::get(Int64Ty, OffsetInt / 4));
5421   Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
5422   if (!Loaded)
5423     return nullptr;
5424 
5425   auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
5426   if (!LoadedCE)
5427     return nullptr;
5428 
5429   if (LoadedCE->getOpcode() == Instruction::Trunc) {
5430     LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
5431     if (!LoadedCE)
5432       return nullptr;
5433   }
5434 
5435   if (LoadedCE->getOpcode() != Instruction::Sub)
5436     return nullptr;
5437 
5438   auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
5439   if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
5440     return nullptr;
5441   auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
5442 
5443   Constant *LoadedRHS = LoadedCE->getOperand(1);
5444   GlobalValue *LoadedRHSSym;
5445   APInt LoadedRHSOffset;
5446   if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
5447                                   DL) ||
5448       PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
5449     return nullptr;
5450 
5451   return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
5452 }
5453 
5454 static Value *simplifyUnaryIntrinsic(Function *F, Value *Op0,
5455                                      const SimplifyQuery &Q) {
5456   // Idempotent functions return the same result when called repeatedly.
5457   Intrinsic::ID IID = F->getIntrinsicID();
5458   if (IsIdempotent(IID))
5459     if (auto *II = dyn_cast<IntrinsicInst>(Op0))
5460       if (II->getIntrinsicID() == IID)
5461         return II;
5462 
5463   Value *X;
5464   switch (IID) {
5465   case Intrinsic::fabs:
5466     if (SignBitMustBeZero(Op0, Q.TLI)) return Op0;
5467     break;
5468   case Intrinsic::bswap:
5469     // bswap(bswap(x)) -> x
5470     if (match(Op0, m_BSwap(m_Value(X)))) return X;
5471     break;
5472   case Intrinsic::bitreverse:
5473     // bitreverse(bitreverse(x)) -> x
5474     if (match(Op0, m_BitReverse(m_Value(X)))) return X;
5475     break;
5476   case Intrinsic::ctpop: {
5477     // If everything but the lowest bit is zero, that bit is the pop-count. Ex:
5478     // ctpop(and X, 1) --> and X, 1
5479     unsigned BitWidth = Op0->getType()->getScalarSizeInBits();
5480     if (MaskedValueIsZero(Op0, APInt::getHighBitsSet(BitWidth, BitWidth - 1),
5481                           Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
5482       return Op0;
5483     break;
5484   }
5485   case Intrinsic::exp:
5486     // exp(log(x)) -> x
5487     if (Q.CxtI->hasAllowReassoc() &&
5488         match(Op0, m_Intrinsic<Intrinsic::log>(m_Value(X)))) return X;
5489     break;
5490   case Intrinsic::exp2:
5491     // exp2(log2(x)) -> x
5492     if (Q.CxtI->hasAllowReassoc() &&
5493         match(Op0, m_Intrinsic<Intrinsic::log2>(m_Value(X)))) return X;
5494     break;
5495   case Intrinsic::log:
5496     // log(exp(x)) -> x
5497     if (Q.CxtI->hasAllowReassoc() &&
5498         match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X)))) return X;
5499     break;
5500   case Intrinsic::log2:
5501     // log2(exp2(x)) -> x
5502     if (Q.CxtI->hasAllowReassoc() &&
5503         (match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X))) ||
5504          match(Op0, m_Intrinsic<Intrinsic::pow>(m_SpecificFP(2.0),
5505                                                 m_Value(X))))) return X;
5506     break;
5507   case Intrinsic::log10:
5508     // log10(pow(10.0, x)) -> x
5509     if (Q.CxtI->hasAllowReassoc() &&
5510         match(Op0, m_Intrinsic<Intrinsic::pow>(m_SpecificFP(10.0),
5511                                                m_Value(X)))) return X;
5512     break;
5513   case Intrinsic::floor:
5514   case Intrinsic::trunc:
5515   case Intrinsic::ceil:
5516   case Intrinsic::round:
5517   case Intrinsic::roundeven:
5518   case Intrinsic::nearbyint:
5519   case Intrinsic::rint: {
5520     // floor (sitofp x) -> sitofp x
5521     // floor (uitofp x) -> uitofp x
5522     //
5523     // Converting from int always results in a finite integral number or
5524     // infinity. For either of those inputs, these rounding functions always
5525     // return the same value, so the rounding can be eliminated.
5526     if (match(Op0, m_SIToFP(m_Value())) || match(Op0, m_UIToFP(m_Value())))
5527       return Op0;
5528     break;
5529   }
5530   case Intrinsic::experimental_vector_reverse:
5531     // experimental.vector.reverse(experimental.vector.reverse(x)) -> x
5532     if (match(Op0,
5533               m_Intrinsic<Intrinsic::experimental_vector_reverse>(m_Value(X))))
5534       return X;
5535     // experimental.vector.reverse(splat(X)) -> splat(X)
5536     if (isSplatValue(Op0))
5537       return Op0;
5538     break;
5539   default:
5540     break;
5541   }
5542 
5543   return nullptr;
5544 }
5545 
5546 static APInt getMaxMinLimit(Intrinsic::ID IID, unsigned BitWidth) {
5547   switch (IID) {
5548   case Intrinsic::smax: return APInt::getSignedMaxValue(BitWidth);
5549   case Intrinsic::smin: return APInt::getSignedMinValue(BitWidth);
5550   case Intrinsic::umax: return APInt::getMaxValue(BitWidth);
5551   case Intrinsic::umin: return APInt::getMinValue(BitWidth);
5552   default: llvm_unreachable("Unexpected intrinsic");
5553   }
5554 }
5555 
5556 static ICmpInst::Predicate getMaxMinPredicate(Intrinsic::ID IID) {
5557   switch (IID) {
5558   case Intrinsic::smax: return ICmpInst::ICMP_SGE;
5559   case Intrinsic::smin: return ICmpInst::ICMP_SLE;
5560   case Intrinsic::umax: return ICmpInst::ICMP_UGE;
5561   case Intrinsic::umin: return ICmpInst::ICMP_ULE;
5562   default: llvm_unreachable("Unexpected intrinsic");
5563   }
5564 }
5565 
5566 /// Given a min/max intrinsic, see if it can be removed based on having an
5567 /// operand that is another min/max intrinsic with shared operand(s). The caller
5568 /// is expected to swap the operand arguments to handle commutation.
5569 static Value *foldMinMaxSharedOp(Intrinsic::ID IID, Value *Op0, Value *Op1) {
5570   Value *X, *Y;
5571   if (!match(Op0, m_MaxOrMin(m_Value(X), m_Value(Y))))
5572     return nullptr;
5573 
5574   auto *MM0 = dyn_cast<IntrinsicInst>(Op0);
5575   if (!MM0)
5576     return nullptr;
5577   Intrinsic::ID IID0 = MM0->getIntrinsicID();
5578 
5579   if (Op1 == X || Op1 == Y ||
5580       match(Op1, m_c_MaxOrMin(m_Specific(X), m_Specific(Y)))) {
5581     // max (max X, Y), X --> max X, Y
5582     if (IID0 == IID)
5583       return MM0;
5584     // max (min X, Y), X --> X
5585     if (IID0 == getInverseMinMaxIntrinsic(IID))
5586       return Op1;
5587   }
5588   return nullptr;
5589 }
5590 
5591 static Value *simplifyBinaryIntrinsic(Function *F, Value *Op0, Value *Op1,
5592                                       const SimplifyQuery &Q) {
5593   Intrinsic::ID IID = F->getIntrinsicID();
5594   Type *ReturnType = F->getReturnType();
5595   unsigned BitWidth = ReturnType->getScalarSizeInBits();
5596   switch (IID) {
5597   case Intrinsic::abs:
5598     // abs(abs(x)) -> abs(x). We don't need to worry about the nsw arg here.
5599     // It is always ok to pick the earlier abs. We'll just lose nsw if its only
5600     // on the outer abs.
5601     if (match(Op0, m_Intrinsic<Intrinsic::abs>(m_Value(), m_Value())))
5602       return Op0;
5603     break;
5604 
5605   case Intrinsic::cttz: {
5606     Value *X;
5607     if (match(Op0, m_Shl(m_One(), m_Value(X))))
5608       return X;
5609     break;
5610   }
5611   case Intrinsic::ctlz: {
5612     Value *X;
5613     if (match(Op0, m_LShr(m_Negative(), m_Value(X))))
5614       return X;
5615     if (match(Op0, m_AShr(m_Negative(), m_Value())))
5616       return Constant::getNullValue(ReturnType);
5617     break;
5618   }
5619   case Intrinsic::smax:
5620   case Intrinsic::smin:
5621   case Intrinsic::umax:
5622   case Intrinsic::umin: {
5623     // If the arguments are the same, this is a no-op.
5624     if (Op0 == Op1)
5625       return Op0;
5626 
5627     // Canonicalize constant operand as Op1.
5628     if (isa<Constant>(Op0))
5629       std::swap(Op0, Op1);
5630 
5631     // Assume undef is the limit value.
5632     if (Q.isUndefValue(Op1))
5633       return ConstantInt::get(ReturnType, getMaxMinLimit(IID, BitWidth));
5634 
5635     const APInt *C;
5636     if (match(Op1, m_APIntAllowUndef(C))) {
5637       // Clamp to limit value. For example:
5638       // umax(i8 %x, i8 255) --> 255
5639       if (*C == getMaxMinLimit(IID, BitWidth))
5640         return ConstantInt::get(ReturnType, *C);
5641 
5642       // If the constant op is the opposite of the limit value, the other must
5643       // be larger/smaller or equal. For example:
5644       // umin(i8 %x, i8 255) --> %x
5645       if (*C == getMaxMinLimit(getInverseMinMaxIntrinsic(IID), BitWidth))
5646         return Op0;
5647 
5648       // Remove nested call if constant operands allow it. Example:
5649       // max (max X, 7), 5 -> max X, 7
5650       auto *MinMax0 = dyn_cast<IntrinsicInst>(Op0);
5651       if (MinMax0 && MinMax0->getIntrinsicID() == IID) {
5652         // TODO: loosen undef/splat restrictions for vector constants.
5653         Value *M00 = MinMax0->getOperand(0), *M01 = MinMax0->getOperand(1);
5654         const APInt *InnerC;
5655         if ((match(M00, m_APInt(InnerC)) || match(M01, m_APInt(InnerC))) &&
5656             ((IID == Intrinsic::smax && InnerC->sge(*C)) ||
5657              (IID == Intrinsic::smin && InnerC->sle(*C)) ||
5658              (IID == Intrinsic::umax && InnerC->uge(*C)) ||
5659              (IID == Intrinsic::umin && InnerC->ule(*C))))
5660           return Op0;
5661       }
5662     }
5663 
5664     if (Value *V = foldMinMaxSharedOp(IID, Op0, Op1))
5665       return V;
5666     if (Value *V = foldMinMaxSharedOp(IID, Op1, Op0))
5667       return V;
5668 
5669     ICmpInst::Predicate Pred = getMaxMinPredicate(IID);
5670     if (isICmpTrue(Pred, Op0, Op1, Q.getWithoutUndef(), RecursionLimit))
5671       return Op0;
5672     if (isICmpTrue(Pred, Op1, Op0, Q.getWithoutUndef(), RecursionLimit))
5673       return Op1;
5674 
5675     if (Optional<bool> Imp =
5676             isImpliedByDomCondition(Pred, Op0, Op1, Q.CxtI, Q.DL))
5677       return *Imp ? Op0 : Op1;
5678     if (Optional<bool> Imp =
5679             isImpliedByDomCondition(Pred, Op1, Op0, Q.CxtI, Q.DL))
5680       return *Imp ? Op1 : Op0;
5681 
5682     break;
5683   }
5684   case Intrinsic::usub_with_overflow:
5685   case Intrinsic::ssub_with_overflow:
5686     // X - X -> { 0, false }
5687     // X - undef -> { 0, false }
5688     // undef - X -> { 0, false }
5689     if (Op0 == Op1 || Q.isUndefValue(Op0) || Q.isUndefValue(Op1))
5690       return Constant::getNullValue(ReturnType);
5691     break;
5692   case Intrinsic::uadd_with_overflow:
5693   case Intrinsic::sadd_with_overflow:
5694     // X + undef -> { -1, false }
5695     // undef + x -> { -1, false }
5696     if (Q.isUndefValue(Op0) || Q.isUndefValue(Op1)) {
5697       return ConstantStruct::get(
5698           cast<StructType>(ReturnType),
5699           {Constant::getAllOnesValue(ReturnType->getStructElementType(0)),
5700            Constant::getNullValue(ReturnType->getStructElementType(1))});
5701     }
5702     break;
5703   case Intrinsic::umul_with_overflow:
5704   case Intrinsic::smul_with_overflow:
5705     // 0 * X -> { 0, false }
5706     // X * 0 -> { 0, false }
5707     if (match(Op0, m_Zero()) || match(Op1, m_Zero()))
5708       return Constant::getNullValue(ReturnType);
5709     // undef * X -> { 0, false }
5710     // X * undef -> { 0, false }
5711     if (Q.isUndefValue(Op0) || Q.isUndefValue(Op1))
5712       return Constant::getNullValue(ReturnType);
5713     break;
5714   case Intrinsic::uadd_sat:
5715     // sat(MAX + X) -> MAX
5716     // sat(X + MAX) -> MAX
5717     if (match(Op0, m_AllOnes()) || match(Op1, m_AllOnes()))
5718       return Constant::getAllOnesValue(ReturnType);
5719     LLVM_FALLTHROUGH;
5720   case Intrinsic::sadd_sat:
5721     // sat(X + undef) -> -1
5722     // sat(undef + X) -> -1
5723     // For unsigned: Assume undef is MAX, thus we saturate to MAX (-1).
5724     // For signed: Assume undef is ~X, in which case X + ~X = -1.
5725     if (Q.isUndefValue(Op0) || Q.isUndefValue(Op1))
5726       return Constant::getAllOnesValue(ReturnType);
5727 
5728     // X + 0 -> X
5729     if (match(Op1, m_Zero()))
5730       return Op0;
5731     // 0 + X -> X
5732     if (match(Op0, m_Zero()))
5733       return Op1;
5734     break;
5735   case Intrinsic::usub_sat:
5736     // sat(0 - X) -> 0, sat(X - MAX) -> 0
5737     if (match(Op0, m_Zero()) || match(Op1, m_AllOnes()))
5738       return Constant::getNullValue(ReturnType);
5739     LLVM_FALLTHROUGH;
5740   case Intrinsic::ssub_sat:
5741     // X - X -> 0, X - undef -> 0, undef - X -> 0
5742     if (Op0 == Op1 || Q.isUndefValue(Op0) || Q.isUndefValue(Op1))
5743       return Constant::getNullValue(ReturnType);
5744     // X - 0 -> X
5745     if (match(Op1, m_Zero()))
5746       return Op0;
5747     break;
5748   case Intrinsic::load_relative:
5749     if (auto *C0 = dyn_cast<Constant>(Op0))
5750       if (auto *C1 = dyn_cast<Constant>(Op1))
5751         return SimplifyRelativeLoad(C0, C1, Q.DL);
5752     break;
5753   case Intrinsic::powi:
5754     if (auto *Power = dyn_cast<ConstantInt>(Op1)) {
5755       // powi(x, 0) -> 1.0
5756       if (Power->isZero())
5757         return ConstantFP::get(Op0->getType(), 1.0);
5758       // powi(x, 1) -> x
5759       if (Power->isOne())
5760         return Op0;
5761     }
5762     break;
5763   case Intrinsic::copysign:
5764     // copysign X, X --> X
5765     if (Op0 == Op1)
5766       return Op0;
5767     // copysign -X, X --> X
5768     // copysign X, -X --> -X
5769     if (match(Op0, m_FNeg(m_Specific(Op1))) ||
5770         match(Op1, m_FNeg(m_Specific(Op0))))
5771       return Op1;
5772     break;
5773   case Intrinsic::maxnum:
5774   case Intrinsic::minnum:
5775   case Intrinsic::maximum:
5776   case Intrinsic::minimum: {
5777     // If the arguments are the same, this is a no-op.
5778     if (Op0 == Op1) return Op0;
5779 
5780     // Canonicalize constant operand as Op1.
5781     if (isa<Constant>(Op0))
5782       std::swap(Op0, Op1);
5783 
5784     // If an argument is undef, return the other argument.
5785     if (Q.isUndefValue(Op1))
5786       return Op0;
5787 
5788     bool PropagateNaN = IID == Intrinsic::minimum || IID == Intrinsic::maximum;
5789     bool IsMin = IID == Intrinsic::minimum || IID == Intrinsic::minnum;
5790 
5791     // minnum(X, nan) -> X
5792     // maxnum(X, nan) -> X
5793     // minimum(X, nan) -> nan
5794     // maximum(X, nan) -> nan
5795     if (match(Op1, m_NaN()))
5796       return PropagateNaN ? propagateNaN(cast<Constant>(Op1)) : Op0;
5797 
5798     // In the following folds, inf can be replaced with the largest finite
5799     // float, if the ninf flag is set.
5800     const APFloat *C;
5801     if (match(Op1, m_APFloat(C)) &&
5802         (C->isInfinity() || (Q.CxtI->hasNoInfs() && C->isLargest()))) {
5803       // minnum(X, -inf) -> -inf
5804       // maxnum(X, +inf) -> +inf
5805       // minimum(X, -inf) -> -inf if nnan
5806       // maximum(X, +inf) -> +inf if nnan
5807       if (C->isNegative() == IsMin && (!PropagateNaN || Q.CxtI->hasNoNaNs()))
5808         return ConstantFP::get(ReturnType, *C);
5809 
5810       // minnum(X, +inf) -> X if nnan
5811       // maxnum(X, -inf) -> X if nnan
5812       // minimum(X, +inf) -> X
5813       // maximum(X, -inf) -> X
5814       if (C->isNegative() != IsMin && (PropagateNaN || Q.CxtI->hasNoNaNs()))
5815         return Op0;
5816     }
5817 
5818     // Min/max of the same operation with common operand:
5819     // m(m(X, Y)), X --> m(X, Y) (4 commuted variants)
5820     if (auto *M0 = dyn_cast<IntrinsicInst>(Op0))
5821       if (M0->getIntrinsicID() == IID &&
5822           (M0->getOperand(0) == Op1 || M0->getOperand(1) == Op1))
5823         return Op0;
5824     if (auto *M1 = dyn_cast<IntrinsicInst>(Op1))
5825       if (M1->getIntrinsicID() == IID &&
5826           (M1->getOperand(0) == Op0 || M1->getOperand(1) == Op0))
5827         return Op1;
5828 
5829     break;
5830   }
5831   case Intrinsic::experimental_vector_extract: {
5832     Type *ReturnType = F->getReturnType();
5833 
5834     // (extract_vector (insert_vector _, X, 0), 0) -> X
5835     unsigned IdxN = cast<ConstantInt>(Op1)->getZExtValue();
5836     Value *X = nullptr;
5837     if (match(Op0, m_Intrinsic<Intrinsic::experimental_vector_insert>(
5838                        m_Value(), m_Value(X), m_Zero())) &&
5839         IdxN == 0 && X->getType() == ReturnType)
5840       return X;
5841 
5842     break;
5843   }
5844   default:
5845     break;
5846   }
5847 
5848   return nullptr;
5849 }
5850 
5851 static Value *simplifyIntrinsic(CallBase *Call, const SimplifyQuery &Q) {
5852 
5853   unsigned NumOperands = Call->arg_size();
5854   Function *F = cast<Function>(Call->getCalledFunction());
5855   Intrinsic::ID IID = F->getIntrinsicID();
5856 
5857   // Most of the intrinsics with no operands have some kind of side effect.
5858   // Don't simplify.
5859   if (!NumOperands) {
5860     switch (IID) {
5861     case Intrinsic::vscale: {
5862       // Call may not be inserted into the IR yet at point of calling simplify.
5863       if (!Call->getParent() || !Call->getParent()->getParent())
5864         return nullptr;
5865       auto Attr = Call->getFunction()->getFnAttribute(Attribute::VScaleRange);
5866       if (!Attr.isValid())
5867         return nullptr;
5868       unsigned VScaleMin, VScaleMax;
5869       std::tie(VScaleMin, VScaleMax) = Attr.getVScaleRangeArgs();
5870       if (VScaleMin == VScaleMax && VScaleMax != 0)
5871         return ConstantInt::get(F->getReturnType(), VScaleMin);
5872       return nullptr;
5873     }
5874     default:
5875       return nullptr;
5876     }
5877   }
5878 
5879   if (NumOperands == 1)
5880     return simplifyUnaryIntrinsic(F, Call->getArgOperand(0), Q);
5881 
5882   if (NumOperands == 2)
5883     return simplifyBinaryIntrinsic(F, Call->getArgOperand(0),
5884                                    Call->getArgOperand(1), Q);
5885 
5886   // Handle intrinsics with 3 or more arguments.
5887   switch (IID) {
5888   case Intrinsic::masked_load:
5889   case Intrinsic::masked_gather: {
5890     Value *MaskArg = Call->getArgOperand(2);
5891     Value *PassthruArg = Call->getArgOperand(3);
5892     // If the mask is all zeros or undef, the "passthru" argument is the result.
5893     if (maskIsAllZeroOrUndef(MaskArg))
5894       return PassthruArg;
5895     return nullptr;
5896   }
5897   case Intrinsic::fshl:
5898   case Intrinsic::fshr: {
5899     Value *Op0 = Call->getArgOperand(0), *Op1 = Call->getArgOperand(1),
5900           *ShAmtArg = Call->getArgOperand(2);
5901 
5902     // If both operands are undef, the result is undef.
5903     if (Q.isUndefValue(Op0) && Q.isUndefValue(Op1))
5904       return UndefValue::get(F->getReturnType());
5905 
5906     // If shift amount is undef, assume it is zero.
5907     if (Q.isUndefValue(ShAmtArg))
5908       return Call->getArgOperand(IID == Intrinsic::fshl ? 0 : 1);
5909 
5910     const APInt *ShAmtC;
5911     if (match(ShAmtArg, m_APInt(ShAmtC))) {
5912       // If there's effectively no shift, return the 1st arg or 2nd arg.
5913       APInt BitWidth = APInt(ShAmtC->getBitWidth(), ShAmtC->getBitWidth());
5914       if (ShAmtC->urem(BitWidth).isZero())
5915         return Call->getArgOperand(IID == Intrinsic::fshl ? 0 : 1);
5916     }
5917 
5918     // Rotating zero by anything is zero.
5919     if (match(Op0, m_Zero()) && match(Op1, m_Zero()))
5920       return ConstantInt::getNullValue(F->getReturnType());
5921 
5922     // Rotating -1 by anything is -1.
5923     if (match(Op0, m_AllOnes()) && match(Op1, m_AllOnes()))
5924       return ConstantInt::getAllOnesValue(F->getReturnType());
5925 
5926     return nullptr;
5927   }
5928   case Intrinsic::experimental_constrained_fma: {
5929     Value *Op0 = Call->getArgOperand(0);
5930     Value *Op1 = Call->getArgOperand(1);
5931     Value *Op2 = Call->getArgOperand(2);
5932     auto *FPI = cast<ConstrainedFPIntrinsic>(Call);
5933     if (Value *V = simplifyFPOp({Op0, Op1, Op2}, {}, Q,
5934                                 FPI->getExceptionBehavior().getValue(),
5935                                 FPI->getRoundingMode().getValue()))
5936       return V;
5937     return nullptr;
5938   }
5939   case Intrinsic::fma:
5940   case Intrinsic::fmuladd: {
5941     Value *Op0 = Call->getArgOperand(0);
5942     Value *Op1 = Call->getArgOperand(1);
5943     Value *Op2 = Call->getArgOperand(2);
5944     if (Value *V = simplifyFPOp({Op0, Op1, Op2}, {}, Q, fp::ebIgnore,
5945                                 RoundingMode::NearestTiesToEven))
5946       return V;
5947     return nullptr;
5948   }
5949   case Intrinsic::smul_fix:
5950   case Intrinsic::smul_fix_sat: {
5951     Value *Op0 = Call->getArgOperand(0);
5952     Value *Op1 = Call->getArgOperand(1);
5953     Value *Op2 = Call->getArgOperand(2);
5954     Type *ReturnType = F->getReturnType();
5955 
5956     // Canonicalize constant operand as Op1 (ConstantFolding handles the case
5957     // when both Op0 and Op1 are constant so we do not care about that special
5958     // case here).
5959     if (isa<Constant>(Op0))
5960       std::swap(Op0, Op1);
5961 
5962     // X * 0 -> 0
5963     if (match(Op1, m_Zero()))
5964       return Constant::getNullValue(ReturnType);
5965 
5966     // X * undef -> 0
5967     if (Q.isUndefValue(Op1))
5968       return Constant::getNullValue(ReturnType);
5969 
5970     // X * (1 << Scale) -> X
5971     APInt ScaledOne =
5972         APInt::getOneBitSet(ReturnType->getScalarSizeInBits(),
5973                             cast<ConstantInt>(Op2)->getZExtValue());
5974     if (ScaledOne.isNonNegative() && match(Op1, m_SpecificInt(ScaledOne)))
5975       return Op0;
5976 
5977     return nullptr;
5978   }
5979   case Intrinsic::experimental_vector_insert: {
5980     Value *Vec = Call->getArgOperand(0);
5981     Value *SubVec = Call->getArgOperand(1);
5982     Value *Idx = Call->getArgOperand(2);
5983     Type *ReturnType = F->getReturnType();
5984 
5985     // (insert_vector Y, (extract_vector X, 0), 0) -> X
5986     // where: Y is X, or Y is undef
5987     unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue();
5988     Value *X = nullptr;
5989     if (match(SubVec, m_Intrinsic<Intrinsic::experimental_vector_extract>(
5990                           m_Value(X), m_Zero())) &&
5991         (Q.isUndefValue(Vec) || Vec == X) && IdxN == 0 &&
5992         X->getType() == ReturnType)
5993       return X;
5994 
5995     return nullptr;
5996   }
5997   case Intrinsic::experimental_constrained_fadd: {
5998     auto *FPI = cast<ConstrainedFPIntrinsic>(Call);
5999     return SimplifyFAddInst(FPI->getArgOperand(0), FPI->getArgOperand(1),
6000                             FPI->getFastMathFlags(), Q,
6001                             FPI->getExceptionBehavior().getValue(),
6002                             FPI->getRoundingMode().getValue());
6003     break;
6004   }
6005   case Intrinsic::experimental_constrained_fsub: {
6006     auto *FPI = cast<ConstrainedFPIntrinsic>(Call);
6007     return SimplifyFSubInst(FPI->getArgOperand(0), FPI->getArgOperand(1),
6008                             FPI->getFastMathFlags(), Q,
6009                             FPI->getExceptionBehavior().getValue(),
6010                             FPI->getRoundingMode().getValue());
6011     break;
6012   }
6013   case Intrinsic::experimental_constrained_fmul: {
6014     auto *FPI = cast<ConstrainedFPIntrinsic>(Call);
6015     return SimplifyFMulInst(FPI->getArgOperand(0), FPI->getArgOperand(1),
6016                             FPI->getFastMathFlags(), Q,
6017                             FPI->getExceptionBehavior().getValue(),
6018                             FPI->getRoundingMode().getValue());
6019     break;
6020   }
6021   case Intrinsic::experimental_constrained_fdiv: {
6022     auto *FPI = cast<ConstrainedFPIntrinsic>(Call);
6023     return SimplifyFDivInst(FPI->getArgOperand(0), FPI->getArgOperand(1),
6024                             FPI->getFastMathFlags(), Q,
6025                             FPI->getExceptionBehavior().getValue(),
6026                             FPI->getRoundingMode().getValue());
6027     break;
6028   }
6029   case Intrinsic::experimental_constrained_frem: {
6030     auto *FPI = cast<ConstrainedFPIntrinsic>(Call);
6031     return SimplifyFRemInst(FPI->getArgOperand(0), FPI->getArgOperand(1),
6032                             FPI->getFastMathFlags(), Q,
6033                             FPI->getExceptionBehavior().getValue(),
6034                             FPI->getRoundingMode().getValue());
6035     break;
6036   }
6037   default:
6038     return nullptr;
6039   }
6040 }
6041 
6042 static Value *tryConstantFoldCall(CallBase *Call, const SimplifyQuery &Q) {
6043   auto *F = dyn_cast<Function>(Call->getCalledOperand());
6044   if (!F || !canConstantFoldCallTo(Call, F))
6045     return nullptr;
6046 
6047   SmallVector<Constant *, 4> ConstantArgs;
6048   unsigned NumArgs = Call->arg_size();
6049   ConstantArgs.reserve(NumArgs);
6050   for (auto &Arg : Call->args()) {
6051     Constant *C = dyn_cast<Constant>(&Arg);
6052     if (!C) {
6053       if (isa<MetadataAsValue>(Arg.get()))
6054         continue;
6055       return nullptr;
6056     }
6057     ConstantArgs.push_back(C);
6058   }
6059 
6060   return ConstantFoldCall(Call, F, ConstantArgs, Q.TLI);
6061 }
6062 
6063 Value *llvm::SimplifyCall(CallBase *Call, const SimplifyQuery &Q) {
6064   // musttail calls can only be simplified if they are also DCEd.
6065   // As we can't guarantee this here, don't simplify them.
6066   if (Call->isMustTailCall())
6067     return nullptr;
6068 
6069   // call undef -> poison
6070   // call null -> poison
6071   Value *Callee = Call->getCalledOperand();
6072   if (isa<UndefValue>(Callee) || isa<ConstantPointerNull>(Callee))
6073     return PoisonValue::get(Call->getType());
6074 
6075   if (Value *V = tryConstantFoldCall(Call, Q))
6076     return V;
6077 
6078   auto *F = dyn_cast<Function>(Callee);
6079   if (F && F->isIntrinsic())
6080     if (Value *Ret = simplifyIntrinsic(Call, Q))
6081       return Ret;
6082 
6083   return nullptr;
6084 }
6085 
6086 /// Given operands for a Freeze, see if we can fold the result.
6087 static Value *SimplifyFreezeInst(Value *Op0, const SimplifyQuery &Q) {
6088   // Use a utility function defined in ValueTracking.
6089   if (llvm::isGuaranteedNotToBeUndefOrPoison(Op0, Q.AC, Q.CxtI, Q.DT))
6090     return Op0;
6091   // We have room for improvement.
6092   return nullptr;
6093 }
6094 
6095 Value *llvm::SimplifyFreezeInst(Value *Op0, const SimplifyQuery &Q) {
6096   return ::SimplifyFreezeInst(Op0, Q);
6097 }
6098 
6099 static Value *SimplifyLoadInst(LoadInst *LI, Value *PtrOp,
6100                                const SimplifyQuery &Q) {
6101   if (LI->isVolatile())
6102     return nullptr;
6103 
6104   APInt Offset(Q.DL.getIndexTypeSizeInBits(PtrOp->getType()), 0);
6105   auto *PtrOpC = dyn_cast<Constant>(PtrOp);
6106   // Try to convert operand into a constant by stripping offsets while looking
6107   // through invariant.group intrinsics. Don't bother if the underlying object
6108   // is not constant, as calculating GEP offsets is expensive.
6109   if (!PtrOpC && isa<Constant>(getUnderlyingObject(PtrOp))) {
6110     PtrOp = PtrOp->stripAndAccumulateConstantOffsets(
6111         Q.DL, Offset, /* AllowNonInbounts */ true,
6112         /* AllowInvariantGroup */ true);
6113     // Index size may have changed due to address space casts.
6114     Offset = Offset.sextOrTrunc(Q.DL.getIndexTypeSizeInBits(PtrOp->getType()));
6115     PtrOpC = dyn_cast<Constant>(PtrOp);
6116   }
6117 
6118   if (PtrOpC)
6119     return ConstantFoldLoadFromConstPtr(PtrOpC, LI->getType(), Offset, Q.DL);
6120   return nullptr;
6121 }
6122 
6123 /// See if we can compute a simplified version of this instruction.
6124 /// If not, this returns null.
6125 
6126 static Value *simplifyInstructionWithOperands(Instruction *I,
6127                                               ArrayRef<Value *> NewOps,
6128                                               const SimplifyQuery &SQ,
6129                                               OptimizationRemarkEmitter *ORE) {
6130   const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
6131   Value *Result = nullptr;
6132 
6133   switch (I->getOpcode()) {
6134   default:
6135     if (llvm::all_of(NewOps, [](Value *V) { return isa<Constant>(V); })) {
6136       SmallVector<Constant *, 8> NewConstOps(NewOps.size());
6137       transform(NewOps, NewConstOps.begin(),
6138                 [](Value *V) { return cast<Constant>(V); });
6139       Result = ConstantFoldInstOperands(I, NewConstOps, Q.DL, Q.TLI);
6140     }
6141     break;
6142   case Instruction::FNeg:
6143     Result = SimplifyFNegInst(NewOps[0], I->getFastMathFlags(), Q);
6144     break;
6145   case Instruction::FAdd:
6146     Result = SimplifyFAddInst(NewOps[0], NewOps[1], I->getFastMathFlags(), Q);
6147     break;
6148   case Instruction::Add:
6149     Result = SimplifyAddInst(
6150         NewOps[0], NewOps[1], Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
6151         Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
6152     break;
6153   case Instruction::FSub:
6154     Result = SimplifyFSubInst(NewOps[0], NewOps[1], I->getFastMathFlags(), Q);
6155     break;
6156   case Instruction::Sub:
6157     Result = SimplifySubInst(
6158         NewOps[0], NewOps[1], Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
6159         Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
6160     break;
6161   case Instruction::FMul:
6162     Result = SimplifyFMulInst(NewOps[0], NewOps[1], I->getFastMathFlags(), Q);
6163     break;
6164   case Instruction::Mul:
6165     Result = SimplifyMulInst(NewOps[0], NewOps[1], Q);
6166     break;
6167   case Instruction::SDiv:
6168     Result = SimplifySDivInst(NewOps[0], NewOps[1], Q);
6169     break;
6170   case Instruction::UDiv:
6171     Result = SimplifyUDivInst(NewOps[0], NewOps[1], Q);
6172     break;
6173   case Instruction::FDiv:
6174     Result = SimplifyFDivInst(NewOps[0], NewOps[1], I->getFastMathFlags(), Q);
6175     break;
6176   case Instruction::SRem:
6177     Result = SimplifySRemInst(NewOps[0], NewOps[1], Q);
6178     break;
6179   case Instruction::URem:
6180     Result = SimplifyURemInst(NewOps[0], NewOps[1], Q);
6181     break;
6182   case Instruction::FRem:
6183     Result = SimplifyFRemInst(NewOps[0], NewOps[1], I->getFastMathFlags(), Q);
6184     break;
6185   case Instruction::Shl:
6186     Result = SimplifyShlInst(
6187         NewOps[0], NewOps[1], Q.IIQ.hasNoSignedWrap(cast<BinaryOperator>(I)),
6188         Q.IIQ.hasNoUnsignedWrap(cast<BinaryOperator>(I)), Q);
6189     break;
6190   case Instruction::LShr:
6191     Result = SimplifyLShrInst(NewOps[0], NewOps[1],
6192                               Q.IIQ.isExact(cast<BinaryOperator>(I)), Q);
6193     break;
6194   case Instruction::AShr:
6195     Result = SimplifyAShrInst(NewOps[0], NewOps[1],
6196                               Q.IIQ.isExact(cast<BinaryOperator>(I)), Q);
6197     break;
6198   case Instruction::And:
6199     Result = SimplifyAndInst(NewOps[0], NewOps[1], Q);
6200     break;
6201   case Instruction::Or:
6202     Result = SimplifyOrInst(NewOps[0], NewOps[1], Q);
6203     break;
6204   case Instruction::Xor:
6205     Result = SimplifyXorInst(NewOps[0], NewOps[1], Q);
6206     break;
6207   case Instruction::ICmp:
6208     Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(), NewOps[0],
6209                               NewOps[1], Q);
6210     break;
6211   case Instruction::FCmp:
6212     Result = SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), NewOps[0],
6213                               NewOps[1], I->getFastMathFlags(), Q);
6214     break;
6215   case Instruction::Select:
6216     Result = SimplifySelectInst(NewOps[0], NewOps[1], NewOps[2], Q);
6217     break;
6218   case Instruction::GetElementPtr: {
6219     auto *GEPI = cast<GetElementPtrInst>(I);
6220     Result = SimplifyGEPInst(GEPI->getSourceElementType(), NewOps,
6221                              GEPI->isInBounds(), Q);
6222     break;
6223   }
6224   case Instruction::InsertValue: {
6225     InsertValueInst *IV = cast<InsertValueInst>(I);
6226     Result = SimplifyInsertValueInst(NewOps[0], NewOps[1], IV->getIndices(), Q);
6227     break;
6228   }
6229   case Instruction::InsertElement: {
6230     Result = SimplifyInsertElementInst(NewOps[0], NewOps[1], NewOps[2], Q);
6231     break;
6232   }
6233   case Instruction::ExtractValue: {
6234     auto *EVI = cast<ExtractValueInst>(I);
6235     Result = SimplifyExtractValueInst(NewOps[0], EVI->getIndices(), Q);
6236     break;
6237   }
6238   case Instruction::ExtractElement: {
6239     Result = SimplifyExtractElementInst(NewOps[0], NewOps[1], Q);
6240     break;
6241   }
6242   case Instruction::ShuffleVector: {
6243     auto *SVI = cast<ShuffleVectorInst>(I);
6244     Result = SimplifyShuffleVectorInst(
6245         NewOps[0], NewOps[1], SVI->getShuffleMask(), SVI->getType(), Q);
6246     break;
6247   }
6248   case Instruction::PHI:
6249     Result = SimplifyPHINode(cast<PHINode>(I), NewOps, Q);
6250     break;
6251   case Instruction::Call: {
6252     // TODO: Use NewOps
6253     Result = SimplifyCall(cast<CallInst>(I), Q);
6254     break;
6255   }
6256   case Instruction::Freeze:
6257     Result = llvm::SimplifyFreezeInst(NewOps[0], Q);
6258     break;
6259 #define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
6260 #include "llvm/IR/Instruction.def"
6261 #undef HANDLE_CAST_INST
6262     Result = SimplifyCastInst(I->getOpcode(), NewOps[0], I->getType(), Q);
6263     break;
6264   case Instruction::Alloca:
6265     // No simplifications for Alloca and it can't be constant folded.
6266     Result = nullptr;
6267     break;
6268   case Instruction::Load:
6269     Result = SimplifyLoadInst(cast<LoadInst>(I), NewOps[0], Q);
6270     break;
6271   }
6272 
6273   /// If called on unreachable code, the above logic may report that the
6274   /// instruction simplified to itself.  Make life easier for users by
6275   /// detecting that case here, returning a safe value instead.
6276   return Result == I ? UndefValue::get(I->getType()) : Result;
6277 }
6278 
6279 Value *llvm::SimplifyInstructionWithOperands(Instruction *I,
6280                                              ArrayRef<Value *> NewOps,
6281                                              const SimplifyQuery &SQ,
6282                                              OptimizationRemarkEmitter *ORE) {
6283   assert(NewOps.size() == I->getNumOperands() &&
6284          "Number of operands should match the instruction!");
6285   return ::simplifyInstructionWithOperands(I, NewOps, SQ, ORE);
6286 }
6287 
6288 Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
6289                                  OptimizationRemarkEmitter *ORE) {
6290   SmallVector<Value *, 8> Ops(I->operands());
6291   return ::simplifyInstructionWithOperands(I, Ops, SQ, ORE);
6292 }
6293 
6294 /// Implementation of recursive simplification through an instruction's
6295 /// uses.
6296 ///
6297 /// This is the common implementation of the recursive simplification routines.
6298 /// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
6299 /// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
6300 /// instructions to process and attempt to simplify it using
6301 /// InstructionSimplify. Recursively visited users which could not be
6302 /// simplified themselves are to the optional UnsimplifiedUsers set for
6303 /// further processing by the caller.
6304 ///
6305 /// This routine returns 'true' only when *it* simplifies something. The passed
6306 /// in simplified value does not count toward this.
6307 static bool replaceAndRecursivelySimplifyImpl(
6308     Instruction *I, Value *SimpleV, const TargetLibraryInfo *TLI,
6309     const DominatorTree *DT, AssumptionCache *AC,
6310     SmallSetVector<Instruction *, 8> *UnsimplifiedUsers = nullptr) {
6311   bool Simplified = false;
6312   SmallSetVector<Instruction *, 8> Worklist;
6313   const DataLayout &DL = I->getModule()->getDataLayout();
6314 
6315   // If we have an explicit value to collapse to, do that round of the
6316   // simplification loop by hand initially.
6317   if (SimpleV) {
6318     for (User *U : I->users())
6319       if (U != I)
6320         Worklist.insert(cast<Instruction>(U));
6321 
6322     // Replace the instruction with its simplified value.
6323     I->replaceAllUsesWith(SimpleV);
6324 
6325     // Gracefully handle edge cases where the instruction is not wired into any
6326     // parent block.
6327     if (I->getParent() && !I->isEHPad() && !I->isTerminator() &&
6328         !I->mayHaveSideEffects())
6329       I->eraseFromParent();
6330   } else {
6331     Worklist.insert(I);
6332   }
6333 
6334   // Note that we must test the size on each iteration, the worklist can grow.
6335   for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
6336     I = Worklist[Idx];
6337 
6338     // See if this instruction simplifies.
6339     SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
6340     if (!SimpleV) {
6341       if (UnsimplifiedUsers)
6342         UnsimplifiedUsers->insert(I);
6343       continue;
6344     }
6345 
6346     Simplified = true;
6347 
6348     // Stash away all the uses of the old instruction so we can check them for
6349     // recursive simplifications after a RAUW. This is cheaper than checking all
6350     // uses of To on the recursive step in most cases.
6351     for (User *U : I->users())
6352       Worklist.insert(cast<Instruction>(U));
6353 
6354     // Replace the instruction with its simplified value.
6355     I->replaceAllUsesWith(SimpleV);
6356 
6357     // Gracefully handle edge cases where the instruction is not wired into any
6358     // parent block.
6359     if (I->getParent() && !I->isEHPad() && !I->isTerminator() &&
6360         !I->mayHaveSideEffects())
6361       I->eraseFromParent();
6362   }
6363   return Simplified;
6364 }
6365 
6366 bool llvm::replaceAndRecursivelySimplify(
6367     Instruction *I, Value *SimpleV, const TargetLibraryInfo *TLI,
6368     const DominatorTree *DT, AssumptionCache *AC,
6369     SmallSetVector<Instruction *, 8> *UnsimplifiedUsers) {
6370   assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
6371   assert(SimpleV && "Must provide a simplified value.");
6372   return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC,
6373                                            UnsimplifiedUsers);
6374 }
6375 
6376 namespace llvm {
6377 const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
6378   auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
6379   auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
6380   auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
6381   auto *TLI = TLIWP ? &TLIWP->getTLI(F) : nullptr;
6382   auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
6383   auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
6384   return {F.getParent()->getDataLayout(), TLI, DT, AC};
6385 }
6386 
6387 const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
6388                                          const DataLayout &DL) {
6389   return {DL, &AR.TLI, &AR.DT, &AR.AC};
6390 }
6391 
6392 template <class T, class... TArgs>
6393 const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
6394                                          Function &F) {
6395   auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
6396   auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
6397   auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
6398   return {F.getParent()->getDataLayout(), TLI, DT, AC};
6399 }
6400 template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
6401                                                   Function &);
6402 }
6403