1 //===- ValueTracking.cpp - Walk computations to compute properties --------===//
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 contains routines that help analyze properties that chains of
10 // computations have.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/Analysis/ValueTracking.h"
15 #include "llvm/ADT/APFloat.h"
16 #include "llvm/ADT/APInt.h"
17 #include "llvm/ADT/ArrayRef.h"
18 #include "llvm/ADT/None.h"
19 #include "llvm/ADT/Optional.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/SmallPtrSet.h"
22 #include "llvm/ADT/SmallSet.h"
23 #include "llvm/ADT/SmallVector.h"
24 #include "llvm/ADT/StringRef.h"
25 #include "llvm/ADT/iterator_range.h"
26 #include "llvm/Analysis/AliasAnalysis.h"
27 #include "llvm/Analysis/AssumeBundleQueries.h"
28 #include "llvm/Analysis/AssumptionCache.h"
29 #include "llvm/Analysis/GuardUtils.h"
30 #include "llvm/Analysis/InstructionSimplify.h"
31 #include "llvm/Analysis/Loads.h"
32 #include "llvm/Analysis/LoopInfo.h"
33 #include "llvm/Analysis/OptimizationRemarkEmitter.h"
34 #include "llvm/Analysis/TargetLibraryInfo.h"
35 #include "llvm/IR/Argument.h"
36 #include "llvm/IR/Attributes.h"
37 #include "llvm/IR/BasicBlock.h"
38 #include "llvm/IR/Constant.h"
39 #include "llvm/IR/ConstantRange.h"
40 #include "llvm/IR/Constants.h"
41 #include "llvm/IR/DerivedTypes.h"
42 #include "llvm/IR/DiagnosticInfo.h"
43 #include "llvm/IR/Dominators.h"
44 #include "llvm/IR/Function.h"
45 #include "llvm/IR/GetElementPtrTypeIterator.h"
46 #include "llvm/IR/GlobalAlias.h"
47 #include "llvm/IR/GlobalValue.h"
48 #include "llvm/IR/GlobalVariable.h"
49 #include "llvm/IR/InstrTypes.h"
50 #include "llvm/IR/Instruction.h"
51 #include "llvm/IR/Instructions.h"
52 #include "llvm/IR/IntrinsicInst.h"
53 #include "llvm/IR/Intrinsics.h"
54 #include "llvm/IR/IntrinsicsAArch64.h"
55 #include "llvm/IR/IntrinsicsX86.h"
56 #include "llvm/IR/LLVMContext.h"
57 #include "llvm/IR/Metadata.h"
58 #include "llvm/IR/Module.h"
59 #include "llvm/IR/Operator.h"
60 #include "llvm/IR/PatternMatch.h"
61 #include "llvm/IR/Type.h"
62 #include "llvm/IR/User.h"
63 #include "llvm/IR/Value.h"
64 #include "llvm/Support/Casting.h"
65 #include "llvm/Support/CommandLine.h"
66 #include "llvm/Support/Compiler.h"
67 #include "llvm/Support/ErrorHandling.h"
68 #include "llvm/Support/KnownBits.h"
69 #include "llvm/Support/MathExtras.h"
70 #include <algorithm>
71 #include <array>
72 #include <cassert>
73 #include <cstdint>
74 #include <iterator>
75 #include <utility>
76 
77 using namespace llvm;
78 using namespace llvm::PatternMatch;
79 
80 const unsigned MaxDepth = 6;
81 
82 // Controls the number of uses of the value searched for possible
83 // dominating comparisons.
84 static cl::opt<unsigned> DomConditionsMaxUses("dom-conditions-max-uses",
85                                               cl::Hidden, cl::init(20));
86 
87 /// Returns the bitwidth of the given scalar or pointer type. For vector types,
88 /// returns the element type's bitwidth.
89 static unsigned getBitWidth(Type *Ty, const DataLayout &DL) {
90   if (unsigned BitWidth = Ty->getScalarSizeInBits())
91     return BitWidth;
92 
93   return DL.getPointerTypeSizeInBits(Ty);
94 }
95 
96 namespace {
97 
98 // Simplifying using an assume can only be done in a particular control-flow
99 // context (the context instruction provides that context). If an assume and
100 // the context instruction are not in the same block then the DT helps in
101 // figuring out if we can use it.
102 struct Query {
103   const DataLayout &DL;
104   AssumptionCache *AC;
105   const Instruction *CxtI;
106   const DominatorTree *DT;
107 
108   // Unlike the other analyses, this may be a nullptr because not all clients
109   // provide it currently.
110   OptimizationRemarkEmitter *ORE;
111 
112   /// Set of assumptions that should be excluded from further queries.
113   /// This is because of the potential for mutual recursion to cause
114   /// computeKnownBits to repeatedly visit the same assume intrinsic. The
115   /// classic case of this is assume(x = y), which will attempt to determine
116   /// bits in x from bits in y, which will attempt to determine bits in y from
117   /// bits in x, etc. Regarding the mutual recursion, computeKnownBits can call
118   /// isKnownNonZero, which calls computeKnownBits and isKnownToBeAPowerOfTwo
119   /// (all of which can call computeKnownBits), and so on.
120   std::array<const Value *, MaxDepth> Excluded;
121 
122   /// If true, it is safe to use metadata during simplification.
123   InstrInfoQuery IIQ;
124 
125   unsigned NumExcluded = 0;
126 
127   Query(const DataLayout &DL, AssumptionCache *AC, const Instruction *CxtI,
128         const DominatorTree *DT, bool UseInstrInfo,
129         OptimizationRemarkEmitter *ORE = nullptr)
130       : DL(DL), AC(AC), CxtI(CxtI), DT(DT), ORE(ORE), IIQ(UseInstrInfo) {}
131 
132   Query(const Query &Q, const Value *NewExcl)
133       : DL(Q.DL), AC(Q.AC), CxtI(Q.CxtI), DT(Q.DT), ORE(Q.ORE), IIQ(Q.IIQ),
134         NumExcluded(Q.NumExcluded) {
135     Excluded = Q.Excluded;
136     Excluded[NumExcluded++] = NewExcl;
137     assert(NumExcluded <= Excluded.size());
138   }
139 
140   bool isExcluded(const Value *Value) const {
141     if (NumExcluded == 0)
142       return false;
143     auto End = Excluded.begin() + NumExcluded;
144     return std::find(Excluded.begin(), End, Value) != End;
145   }
146 };
147 
148 } // end anonymous namespace
149 
150 // Given the provided Value and, potentially, a context instruction, return
151 // the preferred context instruction (if any).
152 static const Instruction *safeCxtI(const Value *V, const Instruction *CxtI) {
153   // If we've been provided with a context instruction, then use that (provided
154   // it has been inserted).
155   if (CxtI && CxtI->getParent())
156     return CxtI;
157 
158   // If the value is really an already-inserted instruction, then use that.
159   CxtI = dyn_cast<Instruction>(V);
160   if (CxtI && CxtI->getParent())
161     return CxtI;
162 
163   return nullptr;
164 }
165 
166 static bool getShuffleDemandedElts(const ShuffleVectorInst *Shuf,
167                                    const APInt &DemandedElts,
168                                    APInt &DemandedLHS, APInt &DemandedRHS) {
169   // The length of scalable vectors is unknown at compile time, thus we
170   // cannot check their values
171   if (isa<ScalableVectorType>(Shuf->getType()))
172     return false;
173 
174   int NumElts =
175       cast<VectorType>(Shuf->getOperand(0)->getType())->getNumElements();
176   int NumMaskElts = Shuf->getType()->getNumElements();
177   DemandedLHS = DemandedRHS = APInt::getNullValue(NumElts);
178   if (DemandedElts.isNullValue())
179     return true;
180   // Simple case of a shuffle with zeroinitializer.
181   if (all_of(Shuf->getShuffleMask(), [](int Elt) { return Elt == 0; })) {
182     DemandedLHS.setBit(0);
183     return true;
184   }
185   for (int i = 0; i != NumMaskElts; ++i) {
186     if (!DemandedElts[i])
187       continue;
188     int M = Shuf->getMaskValue(i);
189     assert(M < (NumElts * 2) && "Invalid shuffle mask constant");
190 
191     // For undef elements, we don't know anything about the common state of
192     // the shuffle result.
193     if (M == -1)
194       return false;
195     if (M < NumElts)
196       DemandedLHS.setBit(M % NumElts);
197     else
198       DemandedRHS.setBit(M % NumElts);
199   }
200 
201   return true;
202 }
203 
204 static void computeKnownBits(const Value *V, const APInt &DemandedElts,
205                              KnownBits &Known, unsigned Depth, const Query &Q);
206 
207 static void computeKnownBits(const Value *V, KnownBits &Known, unsigned Depth,
208                              const Query &Q) {
209   // FIXME: We currently have no way to represent the DemandedElts of a scalable
210   // vector
211   if (isa<ScalableVectorType>(V->getType())) {
212     Known.resetAll();
213     return;
214   }
215 
216   auto *FVTy = dyn_cast<FixedVectorType>(V->getType());
217   APInt DemandedElts =
218       FVTy ? APInt::getAllOnesValue(FVTy->getNumElements()) : APInt(1, 1);
219   computeKnownBits(V, DemandedElts, Known, Depth, Q);
220 }
221 
222 void llvm::computeKnownBits(const Value *V, KnownBits &Known,
223                             const DataLayout &DL, unsigned Depth,
224                             AssumptionCache *AC, const Instruction *CxtI,
225                             const DominatorTree *DT,
226                             OptimizationRemarkEmitter *ORE, bool UseInstrInfo) {
227   ::computeKnownBits(V, Known, Depth,
228                      Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo, ORE));
229 }
230 
231 void llvm::computeKnownBits(const Value *V, const APInt &DemandedElts,
232                             KnownBits &Known, const DataLayout &DL,
233                             unsigned Depth, AssumptionCache *AC,
234                             const Instruction *CxtI, const DominatorTree *DT,
235                             OptimizationRemarkEmitter *ORE, bool UseInstrInfo) {
236   ::computeKnownBits(V, DemandedElts, Known, Depth,
237                      Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo, ORE));
238 }
239 
240 static KnownBits computeKnownBits(const Value *V, const APInt &DemandedElts,
241                                   unsigned Depth, const Query &Q);
242 
243 static KnownBits computeKnownBits(const Value *V, unsigned Depth,
244                                   const Query &Q);
245 
246 KnownBits llvm::computeKnownBits(const Value *V, const DataLayout &DL,
247                                  unsigned Depth, AssumptionCache *AC,
248                                  const Instruction *CxtI,
249                                  const DominatorTree *DT,
250                                  OptimizationRemarkEmitter *ORE,
251                                  bool UseInstrInfo) {
252   return ::computeKnownBits(
253       V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo, ORE));
254 }
255 
256 KnownBits llvm::computeKnownBits(const Value *V, const APInt &DemandedElts,
257                                  const DataLayout &DL, unsigned Depth,
258                                  AssumptionCache *AC, const Instruction *CxtI,
259                                  const DominatorTree *DT,
260                                  OptimizationRemarkEmitter *ORE,
261                                  bool UseInstrInfo) {
262   return ::computeKnownBits(
263       V, DemandedElts, Depth,
264       Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo, ORE));
265 }
266 
267 bool llvm::haveNoCommonBitsSet(const Value *LHS, const Value *RHS,
268                                const DataLayout &DL, AssumptionCache *AC,
269                                const Instruction *CxtI, const DominatorTree *DT,
270                                bool UseInstrInfo) {
271   assert(LHS->getType() == RHS->getType() &&
272          "LHS and RHS should have the same type");
273   assert(LHS->getType()->isIntOrIntVectorTy() &&
274          "LHS and RHS should be integers");
275   // Look for an inverted mask: (X & ~M) op (Y & M).
276   Value *M;
277   if (match(LHS, m_c_And(m_Not(m_Value(M)), m_Value())) &&
278       match(RHS, m_c_And(m_Specific(M), m_Value())))
279     return true;
280   if (match(RHS, m_c_And(m_Not(m_Value(M)), m_Value())) &&
281       match(LHS, m_c_And(m_Specific(M), m_Value())))
282     return true;
283   IntegerType *IT = cast<IntegerType>(LHS->getType()->getScalarType());
284   KnownBits LHSKnown(IT->getBitWidth());
285   KnownBits RHSKnown(IT->getBitWidth());
286   computeKnownBits(LHS, LHSKnown, DL, 0, AC, CxtI, DT, nullptr, UseInstrInfo);
287   computeKnownBits(RHS, RHSKnown, DL, 0, AC, CxtI, DT, nullptr, UseInstrInfo);
288   return (LHSKnown.Zero | RHSKnown.Zero).isAllOnesValue();
289 }
290 
291 bool llvm::isOnlyUsedInZeroEqualityComparison(const Instruction *CxtI) {
292   for (const User *U : CxtI->users()) {
293     if (const ICmpInst *IC = dyn_cast<ICmpInst>(U))
294       if (IC->isEquality())
295         if (Constant *C = dyn_cast<Constant>(IC->getOperand(1)))
296           if (C->isNullValue())
297             continue;
298     return false;
299   }
300   return true;
301 }
302 
303 static bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
304                                    const Query &Q);
305 
306 bool llvm::isKnownToBeAPowerOfTwo(const Value *V, const DataLayout &DL,
307                                   bool OrZero, unsigned Depth,
308                                   AssumptionCache *AC, const Instruction *CxtI,
309                                   const DominatorTree *DT, bool UseInstrInfo) {
310   return ::isKnownToBeAPowerOfTwo(
311       V, OrZero, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
312 }
313 
314 static bool isKnownNonZero(const Value *V, const APInt &DemandedElts,
315                            unsigned Depth, const Query &Q);
316 
317 static bool isKnownNonZero(const Value *V, unsigned Depth, const Query &Q);
318 
319 bool llvm::isKnownNonZero(const Value *V, const DataLayout &DL, unsigned Depth,
320                           AssumptionCache *AC, const Instruction *CxtI,
321                           const DominatorTree *DT, bool UseInstrInfo) {
322   return ::isKnownNonZero(V, Depth,
323                           Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
324 }
325 
326 bool llvm::isKnownNonNegative(const Value *V, const DataLayout &DL,
327                               unsigned Depth, AssumptionCache *AC,
328                               const Instruction *CxtI, const DominatorTree *DT,
329                               bool UseInstrInfo) {
330   KnownBits Known =
331       computeKnownBits(V, DL, Depth, AC, CxtI, DT, nullptr, UseInstrInfo);
332   return Known.isNonNegative();
333 }
334 
335 bool llvm::isKnownPositive(const Value *V, const DataLayout &DL, unsigned Depth,
336                            AssumptionCache *AC, const Instruction *CxtI,
337                            const DominatorTree *DT, bool UseInstrInfo) {
338   if (auto *CI = dyn_cast<ConstantInt>(V))
339     return CI->getValue().isStrictlyPositive();
340 
341   // TODO: We'd doing two recursive queries here.  We should factor this such
342   // that only a single query is needed.
343   return isKnownNonNegative(V, DL, Depth, AC, CxtI, DT, UseInstrInfo) &&
344          isKnownNonZero(V, DL, Depth, AC, CxtI, DT, UseInstrInfo);
345 }
346 
347 bool llvm::isKnownNegative(const Value *V, const DataLayout &DL, unsigned Depth,
348                            AssumptionCache *AC, const Instruction *CxtI,
349                            const DominatorTree *DT, bool UseInstrInfo) {
350   KnownBits Known =
351       computeKnownBits(V, DL, Depth, AC, CxtI, DT, nullptr, UseInstrInfo);
352   return Known.isNegative();
353 }
354 
355 static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q);
356 
357 bool llvm::isKnownNonEqual(const Value *V1, const Value *V2,
358                            const DataLayout &DL, AssumptionCache *AC,
359                            const Instruction *CxtI, const DominatorTree *DT,
360                            bool UseInstrInfo) {
361   return ::isKnownNonEqual(V1, V2,
362                            Query(DL, AC, safeCxtI(V1, safeCxtI(V2, CxtI)), DT,
363                                  UseInstrInfo, /*ORE=*/nullptr));
364 }
365 
366 static bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
367                               const Query &Q);
368 
369 bool llvm::MaskedValueIsZero(const Value *V, const APInt &Mask,
370                              const DataLayout &DL, unsigned Depth,
371                              AssumptionCache *AC, const Instruction *CxtI,
372                              const DominatorTree *DT, bool UseInstrInfo) {
373   return ::MaskedValueIsZero(
374       V, Mask, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
375 }
376 
377 static unsigned ComputeNumSignBits(const Value *V, const APInt &DemandedElts,
378                                    unsigned Depth, const Query &Q);
379 
380 static unsigned ComputeNumSignBits(const Value *V, unsigned Depth,
381                                    const Query &Q) {
382   // FIXME: We currently have no way to represent the DemandedElts of a scalable
383   // vector
384   if (isa<ScalableVectorType>(V->getType()))
385     return 1;
386 
387   auto *FVTy = dyn_cast<FixedVectorType>(V->getType());
388   APInt DemandedElts =
389       FVTy ? APInt::getAllOnesValue(FVTy->getNumElements()) : APInt(1, 1);
390   return ComputeNumSignBits(V, DemandedElts, Depth, Q);
391 }
392 
393 unsigned llvm::ComputeNumSignBits(const Value *V, const DataLayout &DL,
394                                   unsigned Depth, AssumptionCache *AC,
395                                   const Instruction *CxtI,
396                                   const DominatorTree *DT, bool UseInstrInfo) {
397   return ::ComputeNumSignBits(
398       V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT, UseInstrInfo));
399 }
400 
401 static void computeKnownBitsAddSub(bool Add, const Value *Op0, const Value *Op1,
402                                    bool NSW, const APInt &DemandedElts,
403                                    KnownBits &KnownOut, KnownBits &Known2,
404                                    unsigned Depth, const Query &Q) {
405   computeKnownBits(Op1, DemandedElts, KnownOut, Depth + 1, Q);
406 
407   // If one operand is unknown and we have no nowrap information,
408   // the result will be unknown independently of the second operand.
409   if (KnownOut.isUnknown() && !NSW)
410     return;
411 
412   computeKnownBits(Op0, DemandedElts, Known2, Depth + 1, Q);
413   KnownOut = KnownBits::computeForAddSub(Add, NSW, Known2, KnownOut);
414 }
415 
416 static void computeKnownBitsMul(const Value *Op0, const Value *Op1, bool NSW,
417                                 const APInt &DemandedElts, KnownBits &Known,
418                                 KnownBits &Known2, unsigned Depth,
419                                 const Query &Q) {
420   unsigned BitWidth = Known.getBitWidth();
421   computeKnownBits(Op1, DemandedElts, Known, Depth + 1, Q);
422   computeKnownBits(Op0, DemandedElts, Known2, Depth + 1, Q);
423 
424   bool isKnownNegative = false;
425   bool isKnownNonNegative = false;
426   // If the multiplication is known not to overflow, compute the sign bit.
427   if (NSW) {
428     if (Op0 == Op1) {
429       // The product of a number with itself is non-negative.
430       isKnownNonNegative = true;
431     } else {
432       bool isKnownNonNegativeOp1 = Known.isNonNegative();
433       bool isKnownNonNegativeOp0 = Known2.isNonNegative();
434       bool isKnownNegativeOp1 = Known.isNegative();
435       bool isKnownNegativeOp0 = Known2.isNegative();
436       // The product of two numbers with the same sign is non-negative.
437       isKnownNonNegative = (isKnownNegativeOp1 && isKnownNegativeOp0) ||
438         (isKnownNonNegativeOp1 && isKnownNonNegativeOp0);
439       // The product of a negative number and a non-negative number is either
440       // negative or zero.
441       if (!isKnownNonNegative)
442         isKnownNegative = (isKnownNegativeOp1 && isKnownNonNegativeOp0 &&
443                            isKnownNonZero(Op0, Depth, Q)) ||
444                           (isKnownNegativeOp0 && isKnownNonNegativeOp1 &&
445                            isKnownNonZero(Op1, Depth, Q));
446     }
447   }
448 
449   assert(!Known.hasConflict() && !Known2.hasConflict());
450   // Compute a conservative estimate for high known-0 bits.
451   unsigned LeadZ =  std::max(Known.countMinLeadingZeros() +
452                              Known2.countMinLeadingZeros(),
453                              BitWidth) - BitWidth;
454   LeadZ = std::min(LeadZ, BitWidth);
455 
456   // The result of the bottom bits of an integer multiply can be
457   // inferred by looking at the bottom bits of both operands and
458   // multiplying them together.
459   // We can infer at least the minimum number of known trailing bits
460   // of both operands. Depending on number of trailing zeros, we can
461   // infer more bits, because (a*b) <=> ((a/m) * (b/n)) * (m*n) assuming
462   // a and b are divisible by m and n respectively.
463   // We then calculate how many of those bits are inferrable and set
464   // the output. For example, the i8 mul:
465   //  a = XXXX1100 (12)
466   //  b = XXXX1110 (14)
467   // We know the bottom 3 bits are zero since the first can be divided by
468   // 4 and the second by 2, thus having ((12/4) * (14/2)) * (2*4).
469   // Applying the multiplication to the trimmed arguments gets:
470   //    XX11 (3)
471   //    X111 (7)
472   // -------
473   //    XX11
474   //   XX11
475   //  XX11
476   // XX11
477   // -------
478   // XXXXX01
479   // Which allows us to infer the 2 LSBs. Since we're multiplying the result
480   // by 8, the bottom 3 bits will be 0, so we can infer a total of 5 bits.
481   // The proof for this can be described as:
482   // Pre: (C1 >= 0) && (C1 < (1 << C5)) && (C2 >= 0) && (C2 < (1 << C6)) &&
483   //      (C7 == (1 << (umin(countTrailingZeros(C1), C5) +
484   //                    umin(countTrailingZeros(C2), C6) +
485   //                    umin(C5 - umin(countTrailingZeros(C1), C5),
486   //                         C6 - umin(countTrailingZeros(C2), C6)))) - 1)
487   // %aa = shl i8 %a, C5
488   // %bb = shl i8 %b, C6
489   // %aaa = or i8 %aa, C1
490   // %bbb = or i8 %bb, C2
491   // %mul = mul i8 %aaa, %bbb
492   // %mask = and i8 %mul, C7
493   //   =>
494   // %mask = i8 ((C1*C2)&C7)
495   // Where C5, C6 describe the known bits of %a, %b
496   // C1, C2 describe the known bottom bits of %a, %b.
497   // C7 describes the mask of the known bits of the result.
498   APInt Bottom0 = Known.One;
499   APInt Bottom1 = Known2.One;
500 
501   // How many times we'd be able to divide each argument by 2 (shr by 1).
502   // This gives us the number of trailing zeros on the multiplication result.
503   unsigned TrailBitsKnown0 = (Known.Zero | Known.One).countTrailingOnes();
504   unsigned TrailBitsKnown1 = (Known2.Zero | Known2.One).countTrailingOnes();
505   unsigned TrailZero0 = Known.countMinTrailingZeros();
506   unsigned TrailZero1 = Known2.countMinTrailingZeros();
507   unsigned TrailZ = TrailZero0 + TrailZero1;
508 
509   // Figure out the fewest known-bits operand.
510   unsigned SmallestOperand = std::min(TrailBitsKnown0 - TrailZero0,
511                                       TrailBitsKnown1 - TrailZero1);
512   unsigned ResultBitsKnown = std::min(SmallestOperand + TrailZ, BitWidth);
513 
514   APInt BottomKnown = Bottom0.getLoBits(TrailBitsKnown0) *
515                       Bottom1.getLoBits(TrailBitsKnown1);
516 
517   Known.resetAll();
518   Known.Zero.setHighBits(LeadZ);
519   Known.Zero |= (~BottomKnown).getLoBits(ResultBitsKnown);
520   Known.One |= BottomKnown.getLoBits(ResultBitsKnown);
521 
522   // Only make use of no-wrap flags if we failed to compute the sign bit
523   // directly.  This matters if the multiplication always overflows, in
524   // which case we prefer to follow the result of the direct computation,
525   // though as the program is invoking undefined behaviour we can choose
526   // whatever we like here.
527   if (isKnownNonNegative && !Known.isNegative())
528     Known.makeNonNegative();
529   else if (isKnownNegative && !Known.isNonNegative())
530     Known.makeNegative();
531 }
532 
533 void llvm::computeKnownBitsFromRangeMetadata(const MDNode &Ranges,
534                                              KnownBits &Known) {
535   unsigned BitWidth = Known.getBitWidth();
536   unsigned NumRanges = Ranges.getNumOperands() / 2;
537   assert(NumRanges >= 1);
538 
539   Known.Zero.setAllBits();
540   Known.One.setAllBits();
541 
542   for (unsigned i = 0; i < NumRanges; ++i) {
543     ConstantInt *Lower =
544         mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 0));
545     ConstantInt *Upper =
546         mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 1));
547     ConstantRange Range(Lower->getValue(), Upper->getValue());
548 
549     // The first CommonPrefixBits of all values in Range are equal.
550     unsigned CommonPrefixBits =
551         (Range.getUnsignedMax() ^ Range.getUnsignedMin()).countLeadingZeros();
552 
553     APInt Mask = APInt::getHighBitsSet(BitWidth, CommonPrefixBits);
554     Known.One &= Range.getUnsignedMax() & Mask;
555     Known.Zero &= ~Range.getUnsignedMax() & Mask;
556   }
557 }
558 
559 static bool isEphemeralValueOf(const Instruction *I, const Value *E) {
560   SmallVector<const Value *, 16> WorkSet(1, I);
561   SmallPtrSet<const Value *, 32> Visited;
562   SmallPtrSet<const Value *, 16> EphValues;
563 
564   // The instruction defining an assumption's condition itself is always
565   // considered ephemeral to that assumption (even if it has other
566   // non-ephemeral users). See r246696's test case for an example.
567   if (is_contained(I->operands(), E))
568     return true;
569 
570   while (!WorkSet.empty()) {
571     const Value *V = WorkSet.pop_back_val();
572     if (!Visited.insert(V).second)
573       continue;
574 
575     // If all uses of this value are ephemeral, then so is this value.
576     if (llvm::all_of(V->users(), [&](const User *U) {
577                                    return EphValues.count(U);
578                                  })) {
579       if (V == E)
580         return true;
581 
582       if (V == I || isSafeToSpeculativelyExecute(V)) {
583        EphValues.insert(V);
584        if (const User *U = dyn_cast<User>(V))
585          for (User::const_op_iterator J = U->op_begin(), JE = U->op_end();
586               J != JE; ++J)
587            WorkSet.push_back(*J);
588       }
589     }
590   }
591 
592   return false;
593 }
594 
595 // Is this an intrinsic that cannot be speculated but also cannot trap?
596 bool llvm::isAssumeLikeIntrinsic(const Instruction *I) {
597   if (const CallInst *CI = dyn_cast<CallInst>(I))
598     if (Function *F = CI->getCalledFunction())
599       switch (F->getIntrinsicID()) {
600       default: break;
601       // FIXME: This list is repeated from NoTTI::getIntrinsicCost.
602       case Intrinsic::assume:
603       case Intrinsic::sideeffect:
604       case Intrinsic::dbg_declare:
605       case Intrinsic::dbg_value:
606       case Intrinsic::dbg_label:
607       case Intrinsic::invariant_start:
608       case Intrinsic::invariant_end:
609       case Intrinsic::lifetime_start:
610       case Intrinsic::lifetime_end:
611       case Intrinsic::objectsize:
612       case Intrinsic::ptr_annotation:
613       case Intrinsic::var_annotation:
614         return true;
615       }
616 
617   return false;
618 }
619 
620 bool llvm::isValidAssumeForContext(const Instruction *Inv,
621                                    const Instruction *CxtI,
622                                    const DominatorTree *DT) {
623   // There are two restrictions on the use of an assume:
624   //  1. The assume must dominate the context (or the control flow must
625   //     reach the assume whenever it reaches the context).
626   //  2. The context must not be in the assume's set of ephemeral values
627   //     (otherwise we will use the assume to prove that the condition
628   //     feeding the assume is trivially true, thus causing the removal of
629   //     the assume).
630 
631   if (Inv->getParent() == CxtI->getParent()) {
632     // If Inv and CtxI are in the same block, check if the assume (Inv) is first
633     // in the BB.
634     if (Inv->comesBefore(CxtI))
635       return true;
636 
637     // Don't let an assume affect itself - this would cause the problems
638     // `isEphemeralValueOf` is trying to prevent, and it would also make
639     // the loop below go out of bounds.
640     if (Inv == CxtI)
641       return false;
642 
643     // The context comes first, but they're both in the same block.
644     // Make sure there is nothing in between that might interrupt
645     // the control flow, not even CxtI itself.
646     for (BasicBlock::const_iterator I(CxtI), IE(Inv); I != IE; ++I)
647       if (!isGuaranteedToTransferExecutionToSuccessor(&*I))
648         return false;
649 
650     return !isEphemeralValueOf(Inv, CxtI);
651   }
652 
653   // Inv and CxtI are in different blocks.
654   if (DT) {
655     if (DT->dominates(Inv, CxtI))
656       return true;
657   } else if (Inv->getParent() == CxtI->getParent()->getSinglePredecessor()) {
658     // We don't have a DT, but this trivially dominates.
659     return true;
660   }
661 
662   return false;
663 }
664 
665 static bool isKnownNonZeroFromAssume(const Value *V, const Query &Q) {
666   // Use of assumptions is context-sensitive. If we don't have a context, we
667   // cannot use them!
668   if (!Q.AC || !Q.CxtI)
669     return false;
670 
671   // Note that the patterns below need to be kept in sync with the code
672   // in AssumptionCache::updateAffectedValues.
673 
674   auto CmpExcludesZero = [V](ICmpInst *Cmp) {
675     auto m_V = m_CombineOr(m_Specific(V), m_PtrToInt(m_Specific(V)));
676 
677     Value *RHS;
678     CmpInst::Predicate Pred;
679     if (!match(Cmp, m_c_ICmp(Pred, m_V, m_Value(RHS))))
680       return false;
681     // assume(v u> y) -> assume(v != 0)
682     if (Pred == ICmpInst::ICMP_UGT)
683       return true;
684 
685     // assume(v != 0)
686     // We special-case this one to ensure that we handle `assume(v != null)`.
687     if (Pred == ICmpInst::ICMP_NE)
688       return match(RHS, m_Zero());
689 
690     // All other predicates - rely on generic ConstantRange handling.
691     ConstantInt *CI;
692     if (!match(RHS, m_ConstantInt(CI)))
693       return false;
694     ConstantRange RHSRange(CI->getValue());
695     ConstantRange TrueValues =
696         ConstantRange::makeAllowedICmpRegion(Pred, RHSRange);
697     return !TrueValues.contains(APInt::getNullValue(CI->getBitWidth()));
698   };
699 
700   if (Q.CxtI && V->getType()->isPointerTy()) {
701     SmallVector<Attribute::AttrKind, 2> AttrKinds{Attribute::NonNull};
702     if (!NullPointerIsDefined(Q.CxtI->getFunction(),
703                               V->getType()->getPointerAddressSpace()))
704       AttrKinds.push_back(Attribute::Dereferenceable);
705 
706     if (getKnowledgeValidInContext(V, AttrKinds, Q.CxtI, Q.DT, Q.AC))
707       return true;
708   }
709 
710   for (auto &AssumeVH : Q.AC->assumptionsFor(V)) {
711     if (!AssumeVH)
712       continue;
713     CallInst *I = cast<CallInst>(AssumeVH);
714     assert(I->getFunction() == Q.CxtI->getFunction() &&
715            "Got assumption for the wrong function!");
716     if (Q.isExcluded(I))
717       continue;
718 
719     // Warning: This loop can end up being somewhat performance sensitive.
720     // We're running this loop for once for each value queried resulting in a
721     // runtime of ~O(#assumes * #values).
722 
723     assert(I->getCalledFunction()->getIntrinsicID() == Intrinsic::assume &&
724            "must be an assume intrinsic");
725 
726     Value *Arg = I->getArgOperand(0);
727     ICmpInst *Cmp = dyn_cast<ICmpInst>(Arg);
728     if (!Cmp)
729       continue;
730 
731     if (CmpExcludesZero(Cmp) && isValidAssumeForContext(I, Q.CxtI, Q.DT))
732       return true;
733   }
734 
735   return false;
736 }
737 
738 static void computeKnownBitsFromAssume(const Value *V, KnownBits &Known,
739                                        unsigned Depth, const Query &Q) {
740   // Use of assumptions is context-sensitive. If we don't have a context, we
741   // cannot use them!
742   if (!Q.AC || !Q.CxtI)
743     return;
744 
745   unsigned BitWidth = Known.getBitWidth();
746 
747   // Note that the patterns below need to be kept in sync with the code
748   // in AssumptionCache::updateAffectedValues.
749 
750   for (auto &AssumeVH : Q.AC->assumptionsFor(V)) {
751     if (!AssumeVH)
752       continue;
753     CallInst *I = cast<CallInst>(AssumeVH);
754     assert(I->getParent()->getParent() == Q.CxtI->getParent()->getParent() &&
755            "Got assumption for the wrong function!");
756     if (Q.isExcluded(I))
757       continue;
758 
759     // Warning: This loop can end up being somewhat performance sensitive.
760     // We're running this loop for once for each value queried resulting in a
761     // runtime of ~O(#assumes * #values).
762 
763     assert(I->getCalledFunction()->getIntrinsicID() == Intrinsic::assume &&
764            "must be an assume intrinsic");
765 
766     Value *Arg = I->getArgOperand(0);
767 
768     if (Arg == V && isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
769       assert(BitWidth == 1 && "assume operand is not i1?");
770       Known.setAllOnes();
771       return;
772     }
773     if (match(Arg, m_Not(m_Specific(V))) &&
774         isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
775       assert(BitWidth == 1 && "assume operand is not i1?");
776       Known.setAllZero();
777       return;
778     }
779 
780     // The remaining tests are all recursive, so bail out if we hit the limit.
781     if (Depth == MaxDepth)
782       continue;
783 
784     ICmpInst *Cmp = dyn_cast<ICmpInst>(Arg);
785     if (!Cmp)
786       continue;
787 
788     // Note that ptrtoint may change the bitwidth.
789     Value *A, *B;
790     auto m_V = m_CombineOr(m_Specific(V), m_PtrToInt(m_Specific(V)));
791 
792     CmpInst::Predicate Pred;
793     uint64_t C;
794     switch (Cmp->getPredicate()) {
795     default:
796       break;
797     case ICmpInst::ICMP_EQ:
798       // assume(v = a)
799       if (match(Cmp, m_c_ICmp(Pred, m_V, m_Value(A))) &&
800           isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
801         KnownBits RHSKnown =
802             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
803         Known.Zero |= RHSKnown.Zero;
804         Known.One  |= RHSKnown.One;
805       // assume(v & b = a)
806       } else if (match(Cmp,
807                        m_c_ICmp(Pred, m_c_And(m_V, m_Value(B)), m_Value(A))) &&
808                  isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
809         KnownBits RHSKnown =
810             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
811         KnownBits MaskKnown =
812             computeKnownBits(B, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
813 
814         // For those bits in the mask that are known to be one, we can propagate
815         // known bits from the RHS to V.
816         Known.Zero |= RHSKnown.Zero & MaskKnown.One;
817         Known.One  |= RHSKnown.One  & MaskKnown.One;
818       // assume(~(v & b) = a)
819       } else if (match(Cmp, m_c_ICmp(Pred, m_Not(m_c_And(m_V, m_Value(B))),
820                                      m_Value(A))) &&
821                  isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
822         KnownBits RHSKnown =
823             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
824         KnownBits MaskKnown =
825             computeKnownBits(B, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
826 
827         // For those bits in the mask that are known to be one, we can propagate
828         // inverted known bits from the RHS to V.
829         Known.Zero |= RHSKnown.One  & MaskKnown.One;
830         Known.One  |= RHSKnown.Zero & MaskKnown.One;
831       // assume(v | b = a)
832       } else if (match(Cmp,
833                        m_c_ICmp(Pred, m_c_Or(m_V, m_Value(B)), m_Value(A))) &&
834                  isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
835         KnownBits RHSKnown =
836             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
837         KnownBits BKnown =
838             computeKnownBits(B, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
839 
840         // For those bits in B that are known to be zero, we can propagate known
841         // bits from the RHS to V.
842         Known.Zero |= RHSKnown.Zero & BKnown.Zero;
843         Known.One  |= RHSKnown.One  & BKnown.Zero;
844       // assume(~(v | b) = a)
845       } else if (match(Cmp, m_c_ICmp(Pred, m_Not(m_c_Or(m_V, m_Value(B))),
846                                      m_Value(A))) &&
847                  isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
848         KnownBits RHSKnown =
849             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
850         KnownBits BKnown =
851             computeKnownBits(B, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
852 
853         // For those bits in B that are known to be zero, we can propagate
854         // inverted known bits from the RHS to V.
855         Known.Zero |= RHSKnown.One  & BKnown.Zero;
856         Known.One  |= RHSKnown.Zero & BKnown.Zero;
857       // assume(v ^ b = a)
858       } else if (match(Cmp,
859                        m_c_ICmp(Pred, m_c_Xor(m_V, m_Value(B)), m_Value(A))) &&
860                  isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
861         KnownBits RHSKnown =
862             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
863         KnownBits BKnown =
864             computeKnownBits(B, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
865 
866         // For those bits in B that are known to be zero, we can propagate known
867         // bits from the RHS to V. For those bits in B that are known to be one,
868         // we can propagate inverted known bits from the RHS to V.
869         Known.Zero |= RHSKnown.Zero & BKnown.Zero;
870         Known.One  |= RHSKnown.One  & BKnown.Zero;
871         Known.Zero |= RHSKnown.One  & BKnown.One;
872         Known.One  |= RHSKnown.Zero & BKnown.One;
873       // assume(~(v ^ b) = a)
874       } else if (match(Cmp, m_c_ICmp(Pred, m_Not(m_c_Xor(m_V, m_Value(B))),
875                                      m_Value(A))) &&
876                  isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
877         KnownBits RHSKnown =
878             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
879         KnownBits BKnown =
880             computeKnownBits(B, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
881 
882         // For those bits in B that are known to be zero, we can propagate
883         // inverted known bits from the RHS to V. For those bits in B that are
884         // known to be one, we can propagate known bits from the RHS to V.
885         Known.Zero |= RHSKnown.One  & BKnown.Zero;
886         Known.One  |= RHSKnown.Zero & BKnown.Zero;
887         Known.Zero |= RHSKnown.Zero & BKnown.One;
888         Known.One  |= RHSKnown.One  & BKnown.One;
889       // assume(v << c = a)
890       } else if (match(Cmp, m_c_ICmp(Pred, m_Shl(m_V, m_ConstantInt(C)),
891                                      m_Value(A))) &&
892                  isValidAssumeForContext(I, Q.CxtI, Q.DT) && C < BitWidth) {
893         KnownBits RHSKnown =
894             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
895 
896         // For those bits in RHS that are known, we can propagate them to known
897         // bits in V shifted to the right by C.
898         RHSKnown.Zero.lshrInPlace(C);
899         Known.Zero |= RHSKnown.Zero;
900         RHSKnown.One.lshrInPlace(C);
901         Known.One  |= RHSKnown.One;
902       // assume(~(v << c) = a)
903       } else if (match(Cmp, m_c_ICmp(Pred, m_Not(m_Shl(m_V, m_ConstantInt(C))),
904                                      m_Value(A))) &&
905                  isValidAssumeForContext(I, Q.CxtI, Q.DT) && C < BitWidth) {
906         KnownBits RHSKnown =
907             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
908         // For those bits in RHS that are known, we can propagate them inverted
909         // to known bits in V shifted to the right by C.
910         RHSKnown.One.lshrInPlace(C);
911         Known.Zero |= RHSKnown.One;
912         RHSKnown.Zero.lshrInPlace(C);
913         Known.One  |= RHSKnown.Zero;
914       // assume(v >> c = a)
915       } else if (match(Cmp, m_c_ICmp(Pred, m_Shr(m_V, m_ConstantInt(C)),
916                                      m_Value(A))) &&
917                  isValidAssumeForContext(I, Q.CxtI, Q.DT) && C < BitWidth) {
918         KnownBits RHSKnown =
919             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
920         // For those bits in RHS that are known, we can propagate them to known
921         // bits in V shifted to the right by C.
922         Known.Zero |= RHSKnown.Zero << C;
923         Known.One  |= RHSKnown.One  << C;
924       // assume(~(v >> c) = a)
925       } else if (match(Cmp, m_c_ICmp(Pred, m_Not(m_Shr(m_V, m_ConstantInt(C))),
926                                      m_Value(A))) &&
927                  isValidAssumeForContext(I, Q.CxtI, Q.DT) && C < BitWidth) {
928         KnownBits RHSKnown =
929             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
930         // For those bits in RHS that are known, we can propagate them inverted
931         // to known bits in V shifted to the right by C.
932         Known.Zero |= RHSKnown.One  << C;
933         Known.One  |= RHSKnown.Zero << C;
934       }
935       break;
936     case ICmpInst::ICMP_SGE:
937       // assume(v >=_s c) where c is non-negative
938       if (match(Cmp, m_ICmp(Pred, m_V, m_Value(A))) &&
939           isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
940         KnownBits RHSKnown =
941             computeKnownBits(A, Depth + 1, Query(Q, I)).anyextOrTrunc(BitWidth);
942 
943         if (RHSKnown.isNonNegative()) {
944           // We know that the sign bit is zero.
945           Known.makeNonNegative();
946         }
947       }
948       break;
949     case ICmpInst::ICMP_SGT:
950       // assume(v >_s c) where c is at least -1.
951       if (match(Cmp, m_ICmp(Pred, m_V, m_Value(A))) &&
952           isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
953         KnownBits RHSKnown =
954             computeKnownBits(A, Depth + 1, Query(Q, I)).anyextOrTrunc(BitWidth);
955 
956         if (RHSKnown.isAllOnes() || RHSKnown.isNonNegative()) {
957           // We know that the sign bit is zero.
958           Known.makeNonNegative();
959         }
960       }
961       break;
962     case ICmpInst::ICMP_SLE:
963       // assume(v <=_s c) where c is negative
964       if (match(Cmp, m_ICmp(Pred, m_V, m_Value(A))) &&
965           isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
966         KnownBits RHSKnown =
967             computeKnownBits(A, Depth + 1, Query(Q, I)).anyextOrTrunc(BitWidth);
968 
969         if (RHSKnown.isNegative()) {
970           // We know that the sign bit is one.
971           Known.makeNegative();
972         }
973       }
974       break;
975     case ICmpInst::ICMP_SLT:
976       // assume(v <_s c) where c is non-positive
977       if (match(Cmp, m_ICmp(Pred, m_V, m_Value(A))) &&
978           isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
979         KnownBits RHSKnown =
980             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
981 
982         if (RHSKnown.isZero() || RHSKnown.isNegative()) {
983           // We know that the sign bit is one.
984           Known.makeNegative();
985         }
986       }
987       break;
988     case ICmpInst::ICMP_ULE:
989       // assume(v <=_u c)
990       if (match(Cmp, m_ICmp(Pred, m_V, m_Value(A))) &&
991           isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
992         KnownBits RHSKnown =
993             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
994 
995         // Whatever high bits in c are zero are known to be zero.
996         Known.Zero.setHighBits(RHSKnown.countMinLeadingZeros());
997       }
998       break;
999     case ICmpInst::ICMP_ULT:
1000       // assume(v <_u c)
1001       if (match(Cmp, m_ICmp(Pred, m_V, m_Value(A))) &&
1002           isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
1003         KnownBits RHSKnown =
1004             computeKnownBits(A, Depth+1, Query(Q, I)).anyextOrTrunc(BitWidth);
1005 
1006         // If the RHS is known zero, then this assumption must be wrong (nothing
1007         // is unsigned less than zero). Signal a conflict and get out of here.
1008         if (RHSKnown.isZero()) {
1009           Known.Zero.setAllBits();
1010           Known.One.setAllBits();
1011           break;
1012         }
1013 
1014         // Whatever high bits in c are zero are known to be zero (if c is a power
1015         // of 2, then one more).
1016         if (isKnownToBeAPowerOfTwo(A, false, Depth + 1, Query(Q, I)))
1017           Known.Zero.setHighBits(RHSKnown.countMinLeadingZeros() + 1);
1018         else
1019           Known.Zero.setHighBits(RHSKnown.countMinLeadingZeros());
1020       }
1021       break;
1022     }
1023   }
1024 
1025   // If assumptions conflict with each other or previous known bits, then we
1026   // have a logical fallacy. It's possible that the assumption is not reachable,
1027   // so this isn't a real bug. On the other hand, the program may have undefined
1028   // behavior, or we might have a bug in the compiler. We can't assert/crash, so
1029   // clear out the known bits, try to warn the user, and hope for the best.
1030   if (Known.Zero.intersects(Known.One)) {
1031     Known.resetAll();
1032 
1033     if (Q.ORE)
1034       Q.ORE->emit([&]() {
1035         auto *CxtI = const_cast<Instruction *>(Q.CxtI);
1036         return OptimizationRemarkAnalysis("value-tracking", "BadAssumption",
1037                                           CxtI)
1038                << "Detected conflicting code assumptions. Program may "
1039                   "have undefined behavior, or compiler may have "
1040                   "internal error.";
1041       });
1042   }
1043 }
1044 
1045 /// Compute known bits from a shift operator, including those with a
1046 /// non-constant shift amount. Known is the output of this function. Known2 is a
1047 /// pre-allocated temporary with the same bit width as Known. KZF and KOF are
1048 /// operator-specific functions that, given the known-zero or known-one bits
1049 /// respectively, and a shift amount, compute the implied known-zero or
1050 /// known-one bits of the shift operator's result respectively for that shift
1051 /// amount. The results from calling KZF and KOF are conservatively combined for
1052 /// all permitted shift amounts.
1053 static void computeKnownBitsFromShiftOperator(
1054     const Operator *I, const APInt &DemandedElts, KnownBits &Known,
1055     KnownBits &Known2, unsigned Depth, const Query &Q,
1056     function_ref<APInt(const APInt &, unsigned)> KZF,
1057     function_ref<APInt(const APInt &, unsigned)> KOF) {
1058   unsigned BitWidth = Known.getBitWidth();
1059 
1060   computeKnownBits(I->getOperand(1), DemandedElts, Known, Depth + 1, Q);
1061   if (Known.isConstant()) {
1062     unsigned ShiftAmt = Known.getConstant().getLimitedValue(BitWidth - 1);
1063 
1064     computeKnownBits(I->getOperand(0), DemandedElts, Known, Depth + 1, Q);
1065     Known.Zero = KZF(Known.Zero, ShiftAmt);
1066     Known.One  = KOF(Known.One, ShiftAmt);
1067     // If the known bits conflict, this must be an overflowing left shift, so
1068     // the shift result is poison. We can return anything we want. Choose 0 for
1069     // the best folding opportunity.
1070     if (Known.hasConflict())
1071       Known.setAllZero();
1072 
1073     return;
1074   }
1075 
1076   // If the shift amount could be greater than or equal to the bit-width of the
1077   // LHS, the value could be poison, but bail out because the check below is
1078   // expensive.
1079   // TODO: Should we just carry on?
1080   if (Known.getMaxValue().uge(BitWidth)) {
1081     Known.resetAll();
1082     return;
1083   }
1084 
1085   // Note: We cannot use Known.Zero.getLimitedValue() here, because if
1086   // BitWidth > 64 and any upper bits are known, we'll end up returning the
1087   // limit value (which implies all bits are known).
1088   uint64_t ShiftAmtKZ = Known.Zero.zextOrTrunc(64).getZExtValue();
1089   uint64_t ShiftAmtKO = Known.One.zextOrTrunc(64).getZExtValue();
1090 
1091   // It would be more-clearly correct to use the two temporaries for this
1092   // calculation. Reusing the APInts here to prevent unnecessary allocations.
1093   Known.resetAll();
1094 
1095   // If we know the shifter operand is nonzero, we can sometimes infer more
1096   // known bits. However this is expensive to compute, so be lazy about it and
1097   // only compute it when absolutely necessary.
1098   Optional<bool> ShifterOperandIsNonZero;
1099 
1100   // Early exit if we can't constrain any well-defined shift amount.
1101   if (!(ShiftAmtKZ & (PowerOf2Ceil(BitWidth) - 1)) &&
1102       !(ShiftAmtKO & (PowerOf2Ceil(BitWidth) - 1))) {
1103     ShifterOperandIsNonZero =
1104         isKnownNonZero(I->getOperand(1), DemandedElts, Depth + 1, Q);
1105     if (!*ShifterOperandIsNonZero)
1106       return;
1107   }
1108 
1109   computeKnownBits(I->getOperand(0), DemandedElts, Known2, Depth + 1, Q);
1110 
1111   Known.Zero.setAllBits();
1112   Known.One.setAllBits();
1113   for (unsigned ShiftAmt = 0; ShiftAmt < BitWidth; ++ShiftAmt) {
1114     // Combine the shifted known input bits only for those shift amounts
1115     // compatible with its known constraints.
1116     if ((ShiftAmt & ~ShiftAmtKZ) != ShiftAmt)
1117       continue;
1118     if ((ShiftAmt | ShiftAmtKO) != ShiftAmt)
1119       continue;
1120     // If we know the shifter is nonzero, we may be able to infer more known
1121     // bits. This check is sunk down as far as possible to avoid the expensive
1122     // call to isKnownNonZero if the cheaper checks above fail.
1123     if (ShiftAmt == 0) {
1124       if (!ShifterOperandIsNonZero.hasValue())
1125         ShifterOperandIsNonZero =
1126             isKnownNonZero(I->getOperand(1), DemandedElts, Depth + 1, Q);
1127       if (*ShifterOperandIsNonZero)
1128         continue;
1129     }
1130 
1131     Known.Zero &= KZF(Known2.Zero, ShiftAmt);
1132     Known.One  &= KOF(Known2.One, ShiftAmt);
1133   }
1134 
1135   // If the known bits conflict, the result is poison. Return a 0 and hope the
1136   // caller can further optimize that.
1137   if (Known.hasConflict())
1138     Known.setAllZero();
1139 }
1140 
1141 static void computeKnownBitsFromOperator(const Operator *I,
1142                                          const APInt &DemandedElts,
1143                                          KnownBits &Known, unsigned Depth,
1144                                          const Query &Q) {
1145   unsigned BitWidth = Known.getBitWidth();
1146 
1147   KnownBits Known2(BitWidth);
1148   switch (I->getOpcode()) {
1149   default: break;
1150   case Instruction::Load:
1151     if (MDNode *MD =
1152             Q.IIQ.getMetadata(cast<LoadInst>(I), LLVMContext::MD_range))
1153       computeKnownBitsFromRangeMetadata(*MD, Known);
1154     break;
1155   case Instruction::And: {
1156     // If either the LHS or the RHS are Zero, the result is zero.
1157     computeKnownBits(I->getOperand(1), DemandedElts, Known, Depth + 1, Q);
1158     computeKnownBits(I->getOperand(0), DemandedElts, Known2, Depth + 1, Q);
1159 
1160     Known &= Known2;
1161 
1162     // and(x, add (x, -1)) is a common idiom that always clears the low bit;
1163     // here we handle the more general case of adding any odd number by
1164     // matching the form add(x, add(x, y)) where y is odd.
1165     // TODO: This could be generalized to clearing any bit set in y where the
1166     // following bit is known to be unset in y.
1167     Value *X = nullptr, *Y = nullptr;
1168     if (!Known.Zero[0] && !Known.One[0] &&
1169         match(I, m_c_BinOp(m_Value(X), m_Add(m_Deferred(X), m_Value(Y))))) {
1170       Known2.resetAll();
1171       computeKnownBits(Y, DemandedElts, Known2, Depth + 1, Q);
1172       if (Known2.countMinTrailingOnes() > 0)
1173         Known.Zero.setBit(0);
1174     }
1175     break;
1176   }
1177   case Instruction::Or:
1178     computeKnownBits(I->getOperand(1), DemandedElts, Known, Depth + 1, Q);
1179     computeKnownBits(I->getOperand(0), DemandedElts, Known2, Depth + 1, Q);
1180 
1181     Known |= Known2;
1182     break;
1183   case Instruction::Xor:
1184     computeKnownBits(I->getOperand(1), DemandedElts, Known, Depth + 1, Q);
1185     computeKnownBits(I->getOperand(0), DemandedElts, Known2, Depth + 1, Q);
1186 
1187     Known ^= Known2;
1188     break;
1189   case Instruction::Mul: {
1190     bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
1191     computeKnownBitsMul(I->getOperand(0), I->getOperand(1), NSW, DemandedElts,
1192                         Known, Known2, Depth, Q);
1193     break;
1194   }
1195   case Instruction::UDiv: {
1196     // For the purposes of computing leading zeros we can conservatively
1197     // treat a udiv as a logical right shift by the power of 2 known to
1198     // be less than the denominator.
1199     computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1200     unsigned LeadZ = Known2.countMinLeadingZeros();
1201 
1202     Known2.resetAll();
1203     computeKnownBits(I->getOperand(1), Known2, Depth + 1, Q);
1204     unsigned RHSMaxLeadingZeros = Known2.countMaxLeadingZeros();
1205     if (RHSMaxLeadingZeros != BitWidth)
1206       LeadZ = std::min(BitWidth, LeadZ + BitWidth - RHSMaxLeadingZeros - 1);
1207 
1208     Known.Zero.setHighBits(LeadZ);
1209     break;
1210   }
1211   case Instruction::Select: {
1212     const Value *LHS = nullptr, *RHS = nullptr;
1213     SelectPatternFlavor SPF = matchSelectPattern(I, LHS, RHS).Flavor;
1214     if (SelectPatternResult::isMinOrMax(SPF)) {
1215       computeKnownBits(RHS, Known, Depth + 1, Q);
1216       computeKnownBits(LHS, Known2, Depth + 1, Q);
1217     } else {
1218       computeKnownBits(I->getOperand(2), Known, Depth + 1, Q);
1219       computeKnownBits(I->getOperand(1), Known2, Depth + 1, Q);
1220     }
1221 
1222     unsigned MaxHighOnes = 0;
1223     unsigned MaxHighZeros = 0;
1224     if (SPF == SPF_SMAX) {
1225       // If both sides are negative, the result is negative.
1226       if (Known.isNegative() && Known2.isNegative())
1227         // We can derive a lower bound on the result by taking the max of the
1228         // leading one bits.
1229         MaxHighOnes =
1230             std::max(Known.countMinLeadingOnes(), Known2.countMinLeadingOnes());
1231       // If either side is non-negative, the result is non-negative.
1232       else if (Known.isNonNegative() || Known2.isNonNegative())
1233         MaxHighZeros = 1;
1234     } else if (SPF == SPF_SMIN) {
1235       // If both sides are non-negative, the result is non-negative.
1236       if (Known.isNonNegative() && Known2.isNonNegative())
1237         // We can derive an upper bound on the result by taking the max of the
1238         // leading zero bits.
1239         MaxHighZeros = std::max(Known.countMinLeadingZeros(),
1240                                 Known2.countMinLeadingZeros());
1241       // If either side is negative, the result is negative.
1242       else if (Known.isNegative() || Known2.isNegative())
1243         MaxHighOnes = 1;
1244     } else if (SPF == SPF_UMAX) {
1245       // We can derive a lower bound on the result by taking the max of the
1246       // leading one bits.
1247       MaxHighOnes =
1248           std::max(Known.countMinLeadingOnes(), Known2.countMinLeadingOnes());
1249     } else if (SPF == SPF_UMIN) {
1250       // We can derive an upper bound on the result by taking the max of the
1251       // leading zero bits.
1252       MaxHighZeros =
1253           std::max(Known.countMinLeadingZeros(), Known2.countMinLeadingZeros());
1254     } else if (SPF == SPF_ABS) {
1255       // RHS from matchSelectPattern returns the negation part of abs pattern.
1256       // If the negate has an NSW flag we can assume the sign bit of the result
1257       // will be 0 because that makes abs(INT_MIN) undefined.
1258       if (match(RHS, m_Neg(m_Specific(LHS))) &&
1259           Q.IIQ.hasNoSignedWrap(cast<Instruction>(RHS)))
1260         MaxHighZeros = 1;
1261     }
1262 
1263     // Only known if known in both the LHS and RHS.
1264     Known.One &= Known2.One;
1265     Known.Zero &= Known2.Zero;
1266     if (MaxHighOnes > 0)
1267       Known.One.setHighBits(MaxHighOnes);
1268     if (MaxHighZeros > 0)
1269       Known.Zero.setHighBits(MaxHighZeros);
1270     break;
1271   }
1272   case Instruction::FPTrunc:
1273   case Instruction::FPExt:
1274   case Instruction::FPToUI:
1275   case Instruction::FPToSI:
1276   case Instruction::SIToFP:
1277   case Instruction::UIToFP:
1278     break; // Can't work with floating point.
1279   case Instruction::PtrToInt:
1280   case Instruction::IntToPtr:
1281     // Fall through and handle them the same as zext/trunc.
1282     LLVM_FALLTHROUGH;
1283   case Instruction::ZExt:
1284   case Instruction::Trunc: {
1285     Type *SrcTy = I->getOperand(0)->getType();
1286 
1287     unsigned SrcBitWidth;
1288     // Note that we handle pointer operands here because of inttoptr/ptrtoint
1289     // which fall through here.
1290     Type *ScalarTy = SrcTy->getScalarType();
1291     SrcBitWidth = ScalarTy->isPointerTy() ?
1292       Q.DL.getPointerTypeSizeInBits(ScalarTy) :
1293       Q.DL.getTypeSizeInBits(ScalarTy);
1294 
1295     assert(SrcBitWidth && "SrcBitWidth can't be zero");
1296     Known = Known.anyextOrTrunc(SrcBitWidth);
1297     computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1298     Known = Known.zextOrTrunc(BitWidth);
1299     break;
1300   }
1301   case Instruction::BitCast: {
1302     Type *SrcTy = I->getOperand(0)->getType();
1303     if (SrcTy->isIntOrPtrTy() &&
1304         // TODO: For now, not handling conversions like:
1305         // (bitcast i64 %x to <2 x i32>)
1306         !I->getType()->isVectorTy()) {
1307       computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1308       break;
1309     }
1310     break;
1311   }
1312   case Instruction::SExt: {
1313     // Compute the bits in the result that are not present in the input.
1314     unsigned SrcBitWidth = I->getOperand(0)->getType()->getScalarSizeInBits();
1315 
1316     Known = Known.trunc(SrcBitWidth);
1317     computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1318     // If the sign bit of the input is known set or clear, then we know the
1319     // top bits of the result.
1320     Known = Known.sext(BitWidth);
1321     break;
1322   }
1323   case Instruction::Shl: {
1324     // (shl X, C1) & C2 == 0   iff   (X & C2 >>u C1) == 0
1325     bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
1326     auto KZF = [NSW](const APInt &KnownZero, unsigned ShiftAmt) {
1327       APInt KZResult = KnownZero << ShiftAmt;
1328       KZResult.setLowBits(ShiftAmt); // Low bits known 0.
1329       // If this shift has "nsw" keyword, then the result is either a poison
1330       // value or has the same sign bit as the first operand.
1331       if (NSW && KnownZero.isSignBitSet())
1332         KZResult.setSignBit();
1333       return KZResult;
1334     };
1335 
1336     auto KOF = [NSW](const APInt &KnownOne, unsigned ShiftAmt) {
1337       APInt KOResult = KnownOne << ShiftAmt;
1338       if (NSW && KnownOne.isSignBitSet())
1339         KOResult.setSignBit();
1340       return KOResult;
1341     };
1342 
1343     computeKnownBitsFromShiftOperator(I, DemandedElts, Known, Known2, Depth, Q,
1344                                       KZF, KOF);
1345     break;
1346   }
1347   case Instruction::LShr: {
1348     // (lshr X, C1) & C2 == 0   iff  (-1 >> C1) & C2 == 0
1349     auto KZF = [](const APInt &KnownZero, unsigned ShiftAmt) {
1350       APInt KZResult = KnownZero.lshr(ShiftAmt);
1351       // High bits known zero.
1352       KZResult.setHighBits(ShiftAmt);
1353       return KZResult;
1354     };
1355 
1356     auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
1357       return KnownOne.lshr(ShiftAmt);
1358     };
1359 
1360     computeKnownBitsFromShiftOperator(I, DemandedElts, Known, Known2, Depth, Q,
1361                                       KZF, KOF);
1362     break;
1363   }
1364   case Instruction::AShr: {
1365     // (ashr X, C1) & C2 == 0   iff  (-1 >> C1) & C2 == 0
1366     auto KZF = [](const APInt &KnownZero, unsigned ShiftAmt) {
1367       return KnownZero.ashr(ShiftAmt);
1368     };
1369 
1370     auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
1371       return KnownOne.ashr(ShiftAmt);
1372     };
1373 
1374     computeKnownBitsFromShiftOperator(I, DemandedElts, Known, Known2, Depth, Q,
1375                                       KZF, KOF);
1376     break;
1377   }
1378   case Instruction::Sub: {
1379     bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
1380     computeKnownBitsAddSub(false, I->getOperand(0), I->getOperand(1), NSW,
1381                            DemandedElts, Known, Known2, Depth, Q);
1382     break;
1383   }
1384   case Instruction::Add: {
1385     bool NSW = Q.IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(I));
1386     computeKnownBitsAddSub(true, I->getOperand(0), I->getOperand(1), NSW,
1387                            DemandedElts, Known, Known2, Depth, Q);
1388     break;
1389   }
1390   case Instruction::SRem:
1391     if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
1392       APInt RA = Rem->getValue().abs();
1393       if (RA.isPowerOf2()) {
1394         APInt LowBits = RA - 1;
1395         computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1396 
1397         // The low bits of the first operand are unchanged by the srem.
1398         Known.Zero = Known2.Zero & LowBits;
1399         Known.One = Known2.One & LowBits;
1400 
1401         // If the first operand is non-negative or has all low bits zero, then
1402         // the upper bits are all zero.
1403         if (Known2.isNonNegative() || LowBits.isSubsetOf(Known2.Zero))
1404           Known.Zero |= ~LowBits;
1405 
1406         // If the first operand is negative and not all low bits are zero, then
1407         // the upper bits are all one.
1408         if (Known2.isNegative() && LowBits.intersects(Known2.One))
1409           Known.One |= ~LowBits;
1410 
1411         assert((Known.Zero & Known.One) == 0 && "Bits known to be one AND zero?");
1412         break;
1413       }
1414     }
1415 
1416     // The sign bit is the LHS's sign bit, except when the result of the
1417     // remainder is zero.
1418     computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1419     // If it's known zero, our sign bit is also zero.
1420     if (Known2.isNonNegative())
1421       Known.makeNonNegative();
1422 
1423     break;
1424   case Instruction::URem: {
1425     if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
1426       const APInt &RA = Rem->getValue();
1427       if (RA.isPowerOf2()) {
1428         APInt LowBits = (RA - 1);
1429         computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1430         Known.Zero |= ~LowBits;
1431         Known.One &= LowBits;
1432         break;
1433       }
1434     }
1435 
1436     // Since the result is less than or equal to either operand, any leading
1437     // zero bits in either operand must also exist in the result.
1438     computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1439     computeKnownBits(I->getOperand(1), Known2, Depth + 1, Q);
1440 
1441     unsigned Leaders =
1442         std::max(Known.countMinLeadingZeros(), Known2.countMinLeadingZeros());
1443     Known.resetAll();
1444     Known.Zero.setHighBits(Leaders);
1445     break;
1446   }
1447   case Instruction::Alloca:
1448     Known.Zero.setLowBits(Log2(cast<AllocaInst>(I)->getAlign()));
1449     break;
1450   case Instruction::GetElementPtr: {
1451     // Analyze all of the subscripts of this getelementptr instruction
1452     // to determine if we can prove known low zero bits.
1453     KnownBits LocalKnown(BitWidth);
1454     computeKnownBits(I->getOperand(0), LocalKnown, Depth + 1, Q);
1455     unsigned TrailZ = LocalKnown.countMinTrailingZeros();
1456 
1457     gep_type_iterator GTI = gep_type_begin(I);
1458     for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
1459       // TrailZ can only become smaller, short-circuit if we hit zero.
1460       if (TrailZ == 0)
1461         break;
1462 
1463       Value *Index = I->getOperand(i);
1464       if (StructType *STy = GTI.getStructTypeOrNull()) {
1465         // Handle struct member offset arithmetic.
1466 
1467         // Handle case when index is vector zeroinitializer
1468         Constant *CIndex = cast<Constant>(Index);
1469         if (CIndex->isZeroValue())
1470           continue;
1471 
1472         if (CIndex->getType()->isVectorTy())
1473           Index = CIndex->getSplatValue();
1474 
1475         unsigned Idx = cast<ConstantInt>(Index)->getZExtValue();
1476         const StructLayout *SL = Q.DL.getStructLayout(STy);
1477         uint64_t Offset = SL->getElementOffset(Idx);
1478         TrailZ = std::min<unsigned>(TrailZ,
1479                                     countTrailingZeros(Offset));
1480       } else {
1481         // Handle array index arithmetic.
1482         Type *IndexedTy = GTI.getIndexedType();
1483         if (!IndexedTy->isSized()) {
1484           TrailZ = 0;
1485           break;
1486         }
1487         unsigned GEPOpiBits = Index->getType()->getScalarSizeInBits();
1488         uint64_t TypeSize = Q.DL.getTypeAllocSize(IndexedTy).getKnownMinSize();
1489         LocalKnown.Zero = LocalKnown.One = APInt(GEPOpiBits, 0);
1490         computeKnownBits(Index, LocalKnown, Depth + 1, Q);
1491         TrailZ = std::min(TrailZ,
1492                           unsigned(countTrailingZeros(TypeSize) +
1493                                    LocalKnown.countMinTrailingZeros()));
1494       }
1495     }
1496 
1497     Known.Zero.setLowBits(TrailZ);
1498     break;
1499   }
1500   case Instruction::PHI: {
1501     const PHINode *P = cast<PHINode>(I);
1502     // Handle the case of a simple two-predecessor recurrence PHI.
1503     // There's a lot more that could theoretically be done here, but
1504     // this is sufficient to catch some interesting cases.
1505     if (P->getNumIncomingValues() == 2) {
1506       for (unsigned i = 0; i != 2; ++i) {
1507         Value *L = P->getIncomingValue(i);
1508         Value *R = P->getIncomingValue(!i);
1509         Instruction *RInst = P->getIncomingBlock(!i)->getTerminator();
1510         Instruction *LInst = P->getIncomingBlock(i)->getTerminator();
1511         Operator *LU = dyn_cast<Operator>(L);
1512         if (!LU)
1513           continue;
1514         unsigned Opcode = LU->getOpcode();
1515         // Check for operations that have the property that if
1516         // both their operands have low zero bits, the result
1517         // will have low zero bits.
1518         if (Opcode == Instruction::Add ||
1519             Opcode == Instruction::Sub ||
1520             Opcode == Instruction::And ||
1521             Opcode == Instruction::Or ||
1522             Opcode == Instruction::Mul) {
1523           Value *LL = LU->getOperand(0);
1524           Value *LR = LU->getOperand(1);
1525           // Find a recurrence.
1526           if (LL == I)
1527             L = LR;
1528           else if (LR == I)
1529             L = LL;
1530           else
1531             continue; // Check for recurrence with L and R flipped.
1532 
1533           // Change the context instruction to the "edge" that flows into the
1534           // phi. This is important because that is where the value is actually
1535           // "evaluated" even though it is used later somewhere else. (see also
1536           // D69571).
1537           Query RecQ = Q;
1538 
1539           // Ok, we have a PHI of the form L op= R. Check for low
1540           // zero bits.
1541           RecQ.CxtI = RInst;
1542           computeKnownBits(R, Known2, Depth + 1, RecQ);
1543 
1544           // We need to take the minimum number of known bits
1545           KnownBits Known3(BitWidth);
1546           RecQ.CxtI = LInst;
1547           computeKnownBits(L, Known3, Depth + 1, RecQ);
1548 
1549           Known.Zero.setLowBits(std::min(Known2.countMinTrailingZeros(),
1550                                          Known3.countMinTrailingZeros()));
1551 
1552           auto *OverflowOp = dyn_cast<OverflowingBinaryOperator>(LU);
1553           if (OverflowOp && Q.IIQ.hasNoSignedWrap(OverflowOp)) {
1554             // If initial value of recurrence is nonnegative, and we are adding
1555             // a nonnegative number with nsw, the result can only be nonnegative
1556             // or poison value regardless of the number of times we execute the
1557             // add in phi recurrence. If initial value is negative and we are
1558             // adding a negative number with nsw, the result can only be
1559             // negative or poison value. Similar arguments apply to sub and mul.
1560             //
1561             // (add non-negative, non-negative) --> non-negative
1562             // (add negative, negative) --> negative
1563             if (Opcode == Instruction::Add) {
1564               if (Known2.isNonNegative() && Known3.isNonNegative())
1565                 Known.makeNonNegative();
1566               else if (Known2.isNegative() && Known3.isNegative())
1567                 Known.makeNegative();
1568             }
1569 
1570             // (sub nsw non-negative, negative) --> non-negative
1571             // (sub nsw negative, non-negative) --> negative
1572             else if (Opcode == Instruction::Sub && LL == I) {
1573               if (Known2.isNonNegative() && Known3.isNegative())
1574                 Known.makeNonNegative();
1575               else if (Known2.isNegative() && Known3.isNonNegative())
1576                 Known.makeNegative();
1577             }
1578 
1579             // (mul nsw non-negative, non-negative) --> non-negative
1580             else if (Opcode == Instruction::Mul && Known2.isNonNegative() &&
1581                      Known3.isNonNegative())
1582               Known.makeNonNegative();
1583           }
1584 
1585           break;
1586         }
1587       }
1588     }
1589 
1590     // Unreachable blocks may have zero-operand PHI nodes.
1591     if (P->getNumIncomingValues() == 0)
1592       break;
1593 
1594     // Otherwise take the unions of the known bit sets of the operands,
1595     // taking conservative care to avoid excessive recursion.
1596     if (Depth < MaxDepth - 1 && !Known.Zero && !Known.One) {
1597       // Skip if every incoming value references to ourself.
1598       if (dyn_cast_or_null<UndefValue>(P->hasConstantValue()))
1599         break;
1600 
1601       Known.Zero.setAllBits();
1602       Known.One.setAllBits();
1603       for (unsigned u = 0, e = P->getNumIncomingValues(); u < e; ++u) {
1604         Value *IncValue = P->getIncomingValue(u);
1605         // Skip direct self references.
1606         if (IncValue == P) continue;
1607 
1608         // Change the context instruction to the "edge" that flows into the
1609         // phi. This is important because that is where the value is actually
1610         // "evaluated" even though it is used later somewhere else. (see also
1611         // D69571).
1612         Query RecQ = Q;
1613         RecQ.CxtI = P->getIncomingBlock(u)->getTerminator();
1614 
1615         Known2 = KnownBits(BitWidth);
1616         // Recurse, but cap the recursion to one level, because we don't
1617         // want to waste time spinning around in loops.
1618         computeKnownBits(IncValue, Known2, MaxDepth - 1, RecQ);
1619         Known.Zero &= Known2.Zero;
1620         Known.One &= Known2.One;
1621         // If all bits have been ruled out, there's no need to check
1622         // more operands.
1623         if (!Known.Zero && !Known.One)
1624           break;
1625       }
1626     }
1627     break;
1628   }
1629   case Instruction::Call:
1630   case Instruction::Invoke:
1631     // If range metadata is attached to this call, set known bits from that,
1632     // and then intersect with known bits based on other properties of the
1633     // function.
1634     if (MDNode *MD =
1635             Q.IIQ.getMetadata(cast<Instruction>(I), LLVMContext::MD_range))
1636       computeKnownBitsFromRangeMetadata(*MD, Known);
1637     if (const Value *RV = cast<CallBase>(I)->getReturnedArgOperand()) {
1638       computeKnownBits(RV, Known2, Depth + 1, Q);
1639       Known.Zero |= Known2.Zero;
1640       Known.One |= Known2.One;
1641     }
1642     if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
1643       switch (II->getIntrinsicID()) {
1644       default: break;
1645       case Intrinsic::bitreverse:
1646         computeKnownBits(I->getOperand(0), DemandedElts, Known2, Depth + 1, Q);
1647         Known.Zero |= Known2.Zero.reverseBits();
1648         Known.One |= Known2.One.reverseBits();
1649         break;
1650       case Intrinsic::bswap:
1651         computeKnownBits(I->getOperand(0), DemandedElts, Known2, Depth + 1, Q);
1652         Known.Zero |= Known2.Zero.byteSwap();
1653         Known.One |= Known2.One.byteSwap();
1654         break;
1655       case Intrinsic::ctlz: {
1656         computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1657         // If we have a known 1, its position is our upper bound.
1658         unsigned PossibleLZ = Known2.One.countLeadingZeros();
1659         // If this call is undefined for 0, the result will be less than 2^n.
1660         if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
1661           PossibleLZ = std::min(PossibleLZ, BitWidth - 1);
1662         unsigned LowBits = Log2_32(PossibleLZ)+1;
1663         Known.Zero.setBitsFrom(LowBits);
1664         break;
1665       }
1666       case Intrinsic::cttz: {
1667         computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1668         // If we have a known 1, its position is our upper bound.
1669         unsigned PossibleTZ = Known2.One.countTrailingZeros();
1670         // If this call is undefined for 0, the result will be less than 2^n.
1671         if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
1672           PossibleTZ = std::min(PossibleTZ, BitWidth - 1);
1673         unsigned LowBits = Log2_32(PossibleTZ)+1;
1674         Known.Zero.setBitsFrom(LowBits);
1675         break;
1676       }
1677       case Intrinsic::ctpop: {
1678         computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1679         // We can bound the space the count needs.  Also, bits known to be zero
1680         // can't contribute to the population.
1681         unsigned BitsPossiblySet = Known2.countMaxPopulation();
1682         unsigned LowBits = Log2_32(BitsPossiblySet)+1;
1683         Known.Zero.setBitsFrom(LowBits);
1684         // TODO: we could bound KnownOne using the lower bound on the number
1685         // of bits which might be set provided by popcnt KnownOne2.
1686         break;
1687       }
1688       case Intrinsic::fshr:
1689       case Intrinsic::fshl: {
1690         const APInt *SA;
1691         if (!match(I->getOperand(2), m_APInt(SA)))
1692           break;
1693 
1694         // Normalize to funnel shift left.
1695         uint64_t ShiftAmt = SA->urem(BitWidth);
1696         if (II->getIntrinsicID() == Intrinsic::fshr)
1697           ShiftAmt = BitWidth - ShiftAmt;
1698 
1699         KnownBits Known3(BitWidth);
1700         computeKnownBits(I->getOperand(0), Known2, Depth + 1, Q);
1701         computeKnownBits(I->getOperand(1), Known3, Depth + 1, Q);
1702 
1703         Known.Zero =
1704             Known2.Zero.shl(ShiftAmt) | Known3.Zero.lshr(BitWidth - ShiftAmt);
1705         Known.One =
1706             Known2.One.shl(ShiftAmt) | Known3.One.lshr(BitWidth - ShiftAmt);
1707         break;
1708       }
1709       case Intrinsic::uadd_sat:
1710       case Intrinsic::usub_sat: {
1711         bool IsAdd = II->getIntrinsicID() == Intrinsic::uadd_sat;
1712         computeKnownBits(I->getOperand(0), Known, Depth + 1, Q);
1713         computeKnownBits(I->getOperand(1), Known2, Depth + 1, Q);
1714 
1715         // Add: Leading ones of either operand are preserved.
1716         // Sub: Leading zeros of LHS and leading ones of RHS are preserved
1717         // as leading zeros in the result.
1718         unsigned LeadingKnown;
1719         if (IsAdd)
1720           LeadingKnown = std::max(Known.countMinLeadingOnes(),
1721                                   Known2.countMinLeadingOnes());
1722         else
1723           LeadingKnown = std::max(Known.countMinLeadingZeros(),
1724                                   Known2.countMinLeadingOnes());
1725 
1726         Known = KnownBits::computeForAddSub(
1727             IsAdd, /* NSW */ false, Known, Known2);
1728 
1729         // We select between the operation result and all-ones/zero
1730         // respectively, so we can preserve known ones/zeros.
1731         if (IsAdd) {
1732           Known.One.setHighBits(LeadingKnown);
1733           Known.Zero.clearAllBits();
1734         } else {
1735           Known.Zero.setHighBits(LeadingKnown);
1736           Known.One.clearAllBits();
1737         }
1738         break;
1739       }
1740       case Intrinsic::x86_sse42_crc32_64_64:
1741         Known.Zero.setBitsFrom(32);
1742         break;
1743       }
1744     }
1745     break;
1746   case Instruction::ShuffleVector: {
1747     auto *Shuf = dyn_cast<ShuffleVectorInst>(I);
1748     // FIXME: Do we need to handle ConstantExpr involving shufflevectors?
1749     if (!Shuf) {
1750       Known.resetAll();
1751       return;
1752     }
1753     // For undef elements, we don't know anything about the common state of
1754     // the shuffle result.
1755     APInt DemandedLHS, DemandedRHS;
1756     if (!getShuffleDemandedElts(Shuf, DemandedElts, DemandedLHS, DemandedRHS)) {
1757       Known.resetAll();
1758       return;
1759     }
1760     Known.One.setAllBits();
1761     Known.Zero.setAllBits();
1762     if (!!DemandedLHS) {
1763       const Value *LHS = Shuf->getOperand(0);
1764       computeKnownBits(LHS, DemandedLHS, Known, Depth + 1, Q);
1765       // If we don't know any bits, early out.
1766       if (Known.isUnknown())
1767         break;
1768     }
1769     if (!!DemandedRHS) {
1770       const Value *RHS = Shuf->getOperand(1);
1771       computeKnownBits(RHS, DemandedRHS, Known2, Depth + 1, Q);
1772       Known.One &= Known2.One;
1773       Known.Zero &= Known2.Zero;
1774     }
1775     break;
1776   }
1777   case Instruction::InsertElement: {
1778     const Value *Vec = I->getOperand(0);
1779     const Value *Elt = I->getOperand(1);
1780     auto *CIdx = dyn_cast<ConstantInt>(I->getOperand(2));
1781     // Early out if the index is non-constant or out-of-range.
1782     unsigned NumElts = DemandedElts.getBitWidth();
1783     if (!CIdx || CIdx->getValue().uge(NumElts)) {
1784       Known.resetAll();
1785       return;
1786     }
1787     Known.One.setAllBits();
1788     Known.Zero.setAllBits();
1789     unsigned EltIdx = CIdx->getZExtValue();
1790     // Do we demand the inserted element?
1791     if (DemandedElts[EltIdx]) {
1792       computeKnownBits(Elt, Known, Depth + 1, Q);
1793       // If we don't know any bits, early out.
1794       if (Known.isUnknown())
1795         break;
1796     }
1797     // We don't need the base vector element that has been inserted.
1798     APInt DemandedVecElts = DemandedElts;
1799     DemandedVecElts.clearBit(EltIdx);
1800     if (!!DemandedVecElts) {
1801       computeKnownBits(Vec, DemandedVecElts, Known2, Depth + 1, Q);
1802       Known.One &= Known2.One;
1803       Known.Zero &= Known2.Zero;
1804     }
1805     break;
1806   }
1807   case Instruction::ExtractElement: {
1808     // Look through extract element. If the index is non-constant or
1809     // out-of-range demand all elements, otherwise just the extracted element.
1810     const Value *Vec = I->getOperand(0);
1811     const Value *Idx = I->getOperand(1);
1812     auto *CIdx = dyn_cast<ConstantInt>(Idx);
1813     if (isa<ScalableVectorType>(Vec->getType())) {
1814       // FIXME: there's probably *something* we can do with scalable vectors
1815       Known.resetAll();
1816       break;
1817     }
1818     unsigned NumElts = cast<FixedVectorType>(Vec->getType())->getNumElements();
1819     APInt DemandedVecElts = APInt::getAllOnesValue(NumElts);
1820     if (CIdx && CIdx->getValue().ult(NumElts))
1821       DemandedVecElts = APInt::getOneBitSet(NumElts, CIdx->getZExtValue());
1822     computeKnownBits(Vec, DemandedVecElts, Known, Depth + 1, Q);
1823     break;
1824   }
1825   case Instruction::ExtractValue:
1826     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I->getOperand(0))) {
1827       const ExtractValueInst *EVI = cast<ExtractValueInst>(I);
1828       if (EVI->getNumIndices() != 1) break;
1829       if (EVI->getIndices()[0] == 0) {
1830         switch (II->getIntrinsicID()) {
1831         default: break;
1832         case Intrinsic::uadd_with_overflow:
1833         case Intrinsic::sadd_with_overflow:
1834           computeKnownBitsAddSub(true, II->getArgOperand(0),
1835                                  II->getArgOperand(1), false, DemandedElts,
1836                                  Known, Known2, Depth, Q);
1837           break;
1838         case Intrinsic::usub_with_overflow:
1839         case Intrinsic::ssub_with_overflow:
1840           computeKnownBitsAddSub(false, II->getArgOperand(0),
1841                                  II->getArgOperand(1), false, DemandedElts,
1842                                  Known, Known2, Depth, Q);
1843           break;
1844         case Intrinsic::umul_with_overflow:
1845         case Intrinsic::smul_with_overflow:
1846           computeKnownBitsMul(II->getArgOperand(0), II->getArgOperand(1), false,
1847                               DemandedElts, Known, Known2, Depth, Q);
1848           break;
1849         }
1850       }
1851     }
1852     break;
1853   }
1854 }
1855 
1856 /// Determine which bits of V are known to be either zero or one and return
1857 /// them.
1858 KnownBits computeKnownBits(const Value *V, const APInt &DemandedElts,
1859                            unsigned Depth, const Query &Q) {
1860   KnownBits Known(getBitWidth(V->getType(), Q.DL));
1861   computeKnownBits(V, DemandedElts, Known, Depth, Q);
1862   return Known;
1863 }
1864 
1865 /// Determine which bits of V are known to be either zero or one and return
1866 /// them.
1867 KnownBits computeKnownBits(const Value *V, unsigned Depth, const Query &Q) {
1868   KnownBits Known(getBitWidth(V->getType(), Q.DL));
1869   computeKnownBits(V, Known, Depth, Q);
1870   return Known;
1871 }
1872 
1873 /// Determine which bits of V are known to be either zero or one and return
1874 /// them in the Known bit set.
1875 ///
1876 /// NOTE: we cannot consider 'undef' to be "IsZero" here.  The problem is that
1877 /// we cannot optimize based on the assumption that it is zero without changing
1878 /// it to be an explicit zero.  If we don't change it to zero, other code could
1879 /// optimized based on the contradictory assumption that it is non-zero.
1880 /// Because instcombine aggressively folds operations with undef args anyway,
1881 /// this won't lose us code quality.
1882 ///
1883 /// This function is defined on values with integer type, values with pointer
1884 /// type, and vectors of integers.  In the case
1885 /// where V is a vector, known zero, and known one values are the
1886 /// same width as the vector element, and the bit is set only if it is true
1887 /// for all of the demanded elements in the vector specified by DemandedElts.
1888 void computeKnownBits(const Value *V, const APInt &DemandedElts,
1889                       KnownBits &Known, unsigned Depth, const Query &Q) {
1890   if (!DemandedElts || isa<ScalableVectorType>(V->getType())) {
1891     // No demanded elts or V is a scalable vector, better to assume we don't
1892     // know anything.
1893     Known.resetAll();
1894     return;
1895   }
1896 
1897   assert(V && "No Value?");
1898   assert(Depth <= MaxDepth && "Limit Search Depth");
1899 
1900 #ifndef NDEBUG
1901   Type *Ty = V->getType();
1902   unsigned BitWidth = Known.getBitWidth();
1903 
1904   assert((Ty->isIntOrIntVectorTy(BitWidth) || Ty->isPtrOrPtrVectorTy()) &&
1905          "Not integer or pointer type!");
1906 
1907   if (auto *FVTy = dyn_cast<FixedVectorType>(Ty)) {
1908     assert(
1909         FVTy->getNumElements() == DemandedElts.getBitWidth() &&
1910         "DemandedElt width should equal the fixed vector number of elements");
1911   } else {
1912     assert(DemandedElts == APInt(1, 1) &&
1913            "DemandedElt width should be 1 for scalars");
1914   }
1915 
1916   Type *ScalarTy = Ty->getScalarType();
1917   if (ScalarTy->isPointerTy()) {
1918     assert(BitWidth == Q.DL.getPointerTypeSizeInBits(ScalarTy) &&
1919            "V and Known should have same BitWidth");
1920   } else {
1921     assert(BitWidth == Q.DL.getTypeSizeInBits(ScalarTy) &&
1922            "V and Known should have same BitWidth");
1923   }
1924 #endif
1925 
1926   const APInt *C;
1927   if (match(V, m_APInt(C))) {
1928     // We know all of the bits for a scalar constant or a splat vector constant!
1929     Known.One = *C;
1930     Known.Zero = ~Known.One;
1931     return;
1932   }
1933   // Null and aggregate-zero are all-zeros.
1934   if (isa<ConstantPointerNull>(V) || isa<ConstantAggregateZero>(V)) {
1935     Known.setAllZero();
1936     return;
1937   }
1938   // Handle a constant vector by taking the intersection of the known bits of
1939   // each element.
1940   if (const ConstantDataVector *CDV = dyn_cast<ConstantDataVector>(V)) {
1941     // We know that CDV must be a vector of integers. Take the intersection of
1942     // each element.
1943     Known.Zero.setAllBits(); Known.One.setAllBits();
1944     for (unsigned i = 0, e = CDV->getNumElements(); i != e; ++i) {
1945       if (!DemandedElts[i])
1946         continue;
1947       APInt Elt = CDV->getElementAsAPInt(i);
1948       Known.Zero &= ~Elt;
1949       Known.One &= Elt;
1950     }
1951     return;
1952   }
1953 
1954   if (const auto *CV = dyn_cast<ConstantVector>(V)) {
1955     // We know that CV must be a vector of integers. Take the intersection of
1956     // each element.
1957     Known.Zero.setAllBits(); Known.One.setAllBits();
1958     for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i) {
1959       if (!DemandedElts[i])
1960         continue;
1961       Constant *Element = CV->getAggregateElement(i);
1962       auto *ElementCI = dyn_cast_or_null<ConstantInt>(Element);
1963       if (!ElementCI) {
1964         Known.resetAll();
1965         return;
1966       }
1967       const APInt &Elt = ElementCI->getValue();
1968       Known.Zero &= ~Elt;
1969       Known.One &= Elt;
1970     }
1971     return;
1972   }
1973 
1974   // Start out not knowing anything.
1975   Known.resetAll();
1976 
1977   // We can't imply anything about undefs.
1978   if (isa<UndefValue>(V))
1979     return;
1980 
1981   // There's no point in looking through other users of ConstantData for
1982   // assumptions.  Confirm that we've handled them all.
1983   assert(!isa<ConstantData>(V) && "Unhandled constant data!");
1984 
1985   // Limit search depth.
1986   // All recursive calls that increase depth must come after this.
1987   if (Depth == MaxDepth)
1988     return;
1989 
1990   // A weak GlobalAlias is totally unknown. A non-weak GlobalAlias has
1991   // the bits of its aliasee.
1992   if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
1993     if (!GA->isInterposable())
1994       computeKnownBits(GA->getAliasee(), Known, Depth + 1, Q);
1995     return;
1996   }
1997 
1998   if (const Operator *I = dyn_cast<Operator>(V))
1999     computeKnownBitsFromOperator(I, DemandedElts, Known, Depth, Q);
2000 
2001   // Aligned pointers have trailing zeros - refine Known.Zero set
2002   if (isa<PointerType>(V->getType())) {
2003     Align Alignment = V->getPointerAlignment(Q.DL);
2004     Known.Zero.setLowBits(countTrailingZeros(Alignment.value()));
2005   }
2006 
2007   // computeKnownBitsFromAssume strictly refines Known.
2008   // Therefore, we run them after computeKnownBitsFromOperator.
2009 
2010   // Check whether a nearby assume intrinsic can determine some known bits.
2011   computeKnownBitsFromAssume(V, Known, Depth, Q);
2012 
2013   assert((Known.Zero & Known.One) == 0 && "Bits known to be one AND zero?");
2014 }
2015 
2016 /// Return true if the given value is known to have exactly one
2017 /// bit set when defined. For vectors return true if every element is known to
2018 /// be a power of two when defined. Supports values with integer or pointer
2019 /// types and vectors of integers.
2020 bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
2021                             const Query &Q) {
2022   assert(Depth <= MaxDepth && "Limit Search Depth");
2023 
2024   // Attempt to match against constants.
2025   if (OrZero && match(V, m_Power2OrZero()))
2026       return true;
2027   if (match(V, m_Power2()))
2028       return true;
2029 
2030   // 1 << X is clearly a power of two if the one is not shifted off the end.  If
2031   // it is shifted off the end then the result is undefined.
2032   if (match(V, m_Shl(m_One(), m_Value())))
2033     return true;
2034 
2035   // (signmask) >>l X is clearly a power of two if the one is not shifted off
2036   // the bottom.  If it is shifted off the bottom then the result is undefined.
2037   if (match(V, m_LShr(m_SignMask(), m_Value())))
2038     return true;
2039 
2040   // The remaining tests are all recursive, so bail out if we hit the limit.
2041   if (Depth++ == MaxDepth)
2042     return false;
2043 
2044   Value *X = nullptr, *Y = nullptr;
2045   // A shift left or a logical shift right of a power of two is a power of two
2046   // or zero.
2047   if (OrZero && (match(V, m_Shl(m_Value(X), m_Value())) ||
2048                  match(V, m_LShr(m_Value(X), m_Value()))))
2049     return isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q);
2050 
2051   if (const ZExtInst *ZI = dyn_cast<ZExtInst>(V))
2052     return isKnownToBeAPowerOfTwo(ZI->getOperand(0), OrZero, Depth, Q);
2053 
2054   if (const SelectInst *SI = dyn_cast<SelectInst>(V))
2055     return isKnownToBeAPowerOfTwo(SI->getTrueValue(), OrZero, Depth, Q) &&
2056            isKnownToBeAPowerOfTwo(SI->getFalseValue(), OrZero, Depth, Q);
2057 
2058   if (OrZero && match(V, m_And(m_Value(X), m_Value(Y)))) {
2059     // A power of two and'd with anything is a power of two or zero.
2060     if (isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q) ||
2061         isKnownToBeAPowerOfTwo(Y, /*OrZero*/ true, Depth, Q))
2062       return true;
2063     // X & (-X) is always a power of two or zero.
2064     if (match(X, m_Neg(m_Specific(Y))) || match(Y, m_Neg(m_Specific(X))))
2065       return true;
2066     return false;
2067   }
2068 
2069   // Adding a power-of-two or zero to the same power-of-two or zero yields
2070   // either the original power-of-two, a larger power-of-two or zero.
2071   if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
2072     const OverflowingBinaryOperator *VOBO = cast<OverflowingBinaryOperator>(V);
2073     if (OrZero || Q.IIQ.hasNoUnsignedWrap(VOBO) ||
2074         Q.IIQ.hasNoSignedWrap(VOBO)) {
2075       if (match(X, m_And(m_Specific(Y), m_Value())) ||
2076           match(X, m_And(m_Value(), m_Specific(Y))))
2077         if (isKnownToBeAPowerOfTwo(Y, OrZero, Depth, Q))
2078           return true;
2079       if (match(Y, m_And(m_Specific(X), m_Value())) ||
2080           match(Y, m_And(m_Value(), m_Specific(X))))
2081         if (isKnownToBeAPowerOfTwo(X, OrZero, Depth, Q))
2082           return true;
2083 
2084       unsigned BitWidth = V->getType()->getScalarSizeInBits();
2085       KnownBits LHSBits(BitWidth);
2086       computeKnownBits(X, LHSBits, Depth, Q);
2087 
2088       KnownBits RHSBits(BitWidth);
2089       computeKnownBits(Y, RHSBits, Depth, Q);
2090       // If i8 V is a power of two or zero:
2091       //  ZeroBits: 1 1 1 0 1 1 1 1
2092       // ~ZeroBits: 0 0 0 1 0 0 0 0
2093       if ((~(LHSBits.Zero & RHSBits.Zero)).isPowerOf2())
2094         // If OrZero isn't set, we cannot give back a zero result.
2095         // Make sure either the LHS or RHS has a bit set.
2096         if (OrZero || RHSBits.One.getBoolValue() || LHSBits.One.getBoolValue())
2097           return true;
2098     }
2099   }
2100 
2101   // An exact divide or right shift can only shift off zero bits, so the result
2102   // is a power of two only if the first operand is a power of two and not
2103   // copying a sign bit (sdiv int_min, 2).
2104   if (match(V, m_Exact(m_LShr(m_Value(), m_Value()))) ||
2105       match(V, m_Exact(m_UDiv(m_Value(), m_Value())))) {
2106     return isKnownToBeAPowerOfTwo(cast<Operator>(V)->getOperand(0), OrZero,
2107                                   Depth, Q);
2108   }
2109 
2110   return false;
2111 }
2112 
2113 /// Test whether a GEP's result is known to be non-null.
2114 ///
2115 /// Uses properties inherent in a GEP to try to determine whether it is known
2116 /// to be non-null.
2117 ///
2118 /// Currently this routine does not support vector GEPs.
2119 static bool isGEPKnownNonNull(const GEPOperator *GEP, unsigned Depth,
2120                               const Query &Q) {
2121   const Function *F = nullptr;
2122   if (const Instruction *I = dyn_cast<Instruction>(GEP))
2123     F = I->getFunction();
2124 
2125   if (!GEP->isInBounds() ||
2126       NullPointerIsDefined(F, GEP->getPointerAddressSpace()))
2127     return false;
2128 
2129   // FIXME: Support vector-GEPs.
2130   assert(GEP->getType()->isPointerTy() && "We only support plain pointer GEP");
2131 
2132   // If the base pointer is non-null, we cannot walk to a null address with an
2133   // inbounds GEP in address space zero.
2134   if (isKnownNonZero(GEP->getPointerOperand(), Depth, Q))
2135     return true;
2136 
2137   // Walk the GEP operands and see if any operand introduces a non-zero offset.
2138   // If so, then the GEP cannot produce a null pointer, as doing so would
2139   // inherently violate the inbounds contract within address space zero.
2140   for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
2141        GTI != GTE; ++GTI) {
2142     // Struct types are easy -- they must always be indexed by a constant.
2143     if (StructType *STy = GTI.getStructTypeOrNull()) {
2144       ConstantInt *OpC = cast<ConstantInt>(GTI.getOperand());
2145       unsigned ElementIdx = OpC->getZExtValue();
2146       const StructLayout *SL = Q.DL.getStructLayout(STy);
2147       uint64_t ElementOffset = SL->getElementOffset(ElementIdx);
2148       if (ElementOffset > 0)
2149         return true;
2150       continue;
2151     }
2152 
2153     // If we have a zero-sized type, the index doesn't matter. Keep looping.
2154     if (Q.DL.getTypeAllocSize(GTI.getIndexedType()).getKnownMinSize() == 0)
2155       continue;
2156 
2157     // Fast path the constant operand case both for efficiency and so we don't
2158     // increment Depth when just zipping down an all-constant GEP.
2159     if (ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand())) {
2160       if (!OpC->isZero())
2161         return true;
2162       continue;
2163     }
2164 
2165     // We post-increment Depth here because while isKnownNonZero increments it
2166     // as well, when we pop back up that increment won't persist. We don't want
2167     // to recurse 10k times just because we have 10k GEP operands. We don't
2168     // bail completely out because we want to handle constant GEPs regardless
2169     // of depth.
2170     if (Depth++ >= MaxDepth)
2171       continue;
2172 
2173     if (isKnownNonZero(GTI.getOperand(), Depth, Q))
2174       return true;
2175   }
2176 
2177   return false;
2178 }
2179 
2180 static bool isKnownNonNullFromDominatingCondition(const Value *V,
2181                                                   const Instruction *CtxI,
2182                                                   const DominatorTree *DT) {
2183   if (isa<Constant>(V))
2184     return false;
2185 
2186   if (!CtxI || !DT)
2187     return false;
2188 
2189   unsigned NumUsesExplored = 0;
2190   for (auto *U : V->users()) {
2191     // Avoid massive lists
2192     if (NumUsesExplored >= DomConditionsMaxUses)
2193       break;
2194     NumUsesExplored++;
2195 
2196     // If the value is used as an argument to a call or invoke, then argument
2197     // attributes may provide an answer about null-ness.
2198     if (const auto *CB = dyn_cast<CallBase>(U))
2199       if (auto *CalledFunc = CB->getCalledFunction())
2200         for (const Argument &Arg : CalledFunc->args())
2201           if (CB->getArgOperand(Arg.getArgNo()) == V &&
2202               Arg.hasNonNullAttr() && DT->dominates(CB, CtxI))
2203             return true;
2204 
2205     // If the value is used as a load/store, then the pointer must be non null.
2206     if (V == getLoadStorePointerOperand(U)) {
2207       const Instruction *I = cast<Instruction>(U);
2208       if (!NullPointerIsDefined(I->getFunction(),
2209                                 V->getType()->getPointerAddressSpace()) &&
2210           DT->dominates(I, CtxI))
2211         return true;
2212     }
2213 
2214     // Consider only compare instructions uniquely controlling a branch
2215     CmpInst::Predicate Pred;
2216     if (!match(const_cast<User *>(U),
2217                m_c_ICmp(Pred, m_Specific(V), m_Zero())) ||
2218         (Pred != ICmpInst::ICMP_EQ && Pred != ICmpInst::ICMP_NE))
2219       continue;
2220 
2221     SmallVector<const User *, 4> WorkList;
2222     SmallPtrSet<const User *, 4> Visited;
2223     for (auto *CmpU : U->users()) {
2224       assert(WorkList.empty() && "Should be!");
2225       if (Visited.insert(CmpU).second)
2226         WorkList.push_back(CmpU);
2227 
2228       while (!WorkList.empty()) {
2229         auto *Curr = WorkList.pop_back_val();
2230 
2231         // If a user is an AND, add all its users to the work list. We only
2232         // propagate "pred != null" condition through AND because it is only
2233         // correct to assume that all conditions of AND are met in true branch.
2234         // TODO: Support similar logic of OR and EQ predicate?
2235         if (Pred == ICmpInst::ICMP_NE)
2236           if (auto *BO = dyn_cast<BinaryOperator>(Curr))
2237             if (BO->getOpcode() == Instruction::And) {
2238               for (auto *BOU : BO->users())
2239                 if (Visited.insert(BOU).second)
2240                   WorkList.push_back(BOU);
2241               continue;
2242             }
2243 
2244         if (const BranchInst *BI = dyn_cast<BranchInst>(Curr)) {
2245           assert(BI->isConditional() && "uses a comparison!");
2246 
2247           BasicBlock *NonNullSuccessor =
2248               BI->getSuccessor(Pred == ICmpInst::ICMP_EQ ? 1 : 0);
2249           BasicBlockEdge Edge(BI->getParent(), NonNullSuccessor);
2250           if (Edge.isSingleEdge() && DT->dominates(Edge, CtxI->getParent()))
2251             return true;
2252         } else if (Pred == ICmpInst::ICMP_NE && isGuard(Curr) &&
2253                    DT->dominates(cast<Instruction>(Curr), CtxI)) {
2254           return true;
2255         }
2256       }
2257     }
2258   }
2259 
2260   return false;
2261 }
2262 
2263 /// Does the 'Range' metadata (which must be a valid MD_range operand list)
2264 /// ensure that the value it's attached to is never Value?  'RangeType' is
2265 /// is the type of the value described by the range.
2266 static bool rangeMetadataExcludesValue(const MDNode* Ranges, const APInt& Value) {
2267   const unsigned NumRanges = Ranges->getNumOperands() / 2;
2268   assert(NumRanges >= 1);
2269   for (unsigned i = 0; i < NumRanges; ++i) {
2270     ConstantInt *Lower =
2271         mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 0));
2272     ConstantInt *Upper =
2273         mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 1));
2274     ConstantRange Range(Lower->getValue(), Upper->getValue());
2275     if (Range.contains(Value))
2276       return false;
2277   }
2278   return true;
2279 }
2280 
2281 /// Return true if the given value is known to be non-zero when defined. For
2282 /// vectors, return true if every demanded element is known to be non-zero when
2283 /// defined. For pointers, if the context instruction and dominator tree are
2284 /// specified, perform context-sensitive analysis and return true if the
2285 /// pointer couldn't possibly be null at the specified instruction.
2286 /// Supports values with integer or pointer type and vectors of integers.
2287 bool isKnownNonZero(const Value *V, const APInt &DemandedElts, unsigned Depth,
2288                     const Query &Q) {
2289   // FIXME: We currently have no way to represent the DemandedElts of a scalable
2290   // vector
2291   if (isa<ScalableVectorType>(V->getType()))
2292     return false;
2293 
2294   if (auto *C = dyn_cast<Constant>(V)) {
2295     if (C->isNullValue())
2296       return false;
2297     if (isa<ConstantInt>(C))
2298       // Must be non-zero due to null test above.
2299       return true;
2300 
2301     if (auto *CE = dyn_cast<ConstantExpr>(C)) {
2302       // See the comment for IntToPtr/PtrToInt instructions below.
2303       if (CE->getOpcode() == Instruction::IntToPtr ||
2304           CE->getOpcode() == Instruction::PtrToInt)
2305         if (Q.DL.getTypeSizeInBits(CE->getOperand(0)->getType()) <=
2306             Q.DL.getTypeSizeInBits(CE->getType()))
2307           return isKnownNonZero(CE->getOperand(0), Depth, Q);
2308     }
2309 
2310     // For constant vectors, check that all elements are undefined or known
2311     // non-zero to determine that the whole vector is known non-zero.
2312     if (auto *VecTy = dyn_cast<FixedVectorType>(C->getType())) {
2313       for (unsigned i = 0, e = VecTy->getNumElements(); i != e; ++i) {
2314         if (!DemandedElts[i])
2315           continue;
2316         Constant *Elt = C->getAggregateElement(i);
2317         if (!Elt || Elt->isNullValue())
2318           return false;
2319         if (!isa<UndefValue>(Elt) && !isa<ConstantInt>(Elt))
2320           return false;
2321       }
2322       return true;
2323     }
2324 
2325     // A global variable in address space 0 is non null unless extern weak
2326     // or an absolute symbol reference. Other address spaces may have null as a
2327     // valid address for a global, so we can't assume anything.
2328     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
2329       if (!GV->isAbsoluteSymbolRef() && !GV->hasExternalWeakLinkage() &&
2330           GV->getType()->getAddressSpace() == 0)
2331         return true;
2332     } else
2333       return false;
2334   }
2335 
2336   if (auto *I = dyn_cast<Instruction>(V)) {
2337     if (MDNode *Ranges = Q.IIQ.getMetadata(I, LLVMContext::MD_range)) {
2338       // If the possible ranges don't contain zero, then the value is
2339       // definitely non-zero.
2340       if (auto *Ty = dyn_cast<IntegerType>(V->getType())) {
2341         const APInt ZeroValue(Ty->getBitWidth(), 0);
2342         if (rangeMetadataExcludesValue(Ranges, ZeroValue))
2343           return true;
2344       }
2345     }
2346   }
2347 
2348   if (isKnownNonZeroFromAssume(V, Q))
2349     return true;
2350 
2351   // Some of the tests below are recursive, so bail out if we hit the limit.
2352   if (Depth++ >= MaxDepth)
2353     return false;
2354 
2355   // Check for pointer simplifications.
2356   if (V->getType()->isPointerTy()) {
2357     // Alloca never returns null, malloc might.
2358     if (isa<AllocaInst>(V) && Q.DL.getAllocaAddrSpace() == 0)
2359       return true;
2360 
2361     // A byval, inalloca, or nonnull argument is never null.
2362     if (const Argument *A = dyn_cast<Argument>(V))
2363       if (A->hasPassPointeeByValueAttr() || A->hasNonNullAttr())
2364         return true;
2365 
2366     // A Load tagged with nonnull metadata is never null.
2367     if (const LoadInst *LI = dyn_cast<LoadInst>(V))
2368       if (Q.IIQ.getMetadata(LI, LLVMContext::MD_nonnull))
2369         return true;
2370 
2371     if (const auto *Call = dyn_cast<CallBase>(V)) {
2372       if (Call->isReturnNonNull())
2373         return true;
2374       if (const auto *RP = getArgumentAliasingToReturnedPointer(Call, true))
2375         return isKnownNonZero(RP, Depth, Q);
2376     }
2377   }
2378 
2379   if (isKnownNonNullFromDominatingCondition(V, Q.CxtI, Q.DT))
2380     return true;
2381 
2382   // Check for recursive pointer simplifications.
2383   if (V->getType()->isPointerTy()) {
2384     // Look through bitcast operations, GEPs, and int2ptr instructions as they
2385     // do not alter the value, or at least not the nullness property of the
2386     // value, e.g., int2ptr is allowed to zero/sign extend the value.
2387     //
2388     // Note that we have to take special care to avoid looking through
2389     // truncating casts, e.g., int2ptr/ptr2int with appropriate sizes, as well
2390     // as casts that can alter the value, e.g., AddrSpaceCasts.
2391     if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V))
2392       if (isGEPKnownNonNull(GEP, Depth, Q))
2393         return true;
2394 
2395     if (auto *BCO = dyn_cast<BitCastOperator>(V))
2396       return isKnownNonZero(BCO->getOperand(0), Depth, Q);
2397 
2398     if (auto *I2P = dyn_cast<IntToPtrInst>(V))
2399       if (Q.DL.getTypeSizeInBits(I2P->getSrcTy()) <=
2400           Q.DL.getTypeSizeInBits(I2P->getDestTy()))
2401         return isKnownNonZero(I2P->getOperand(0), Depth, Q);
2402   }
2403 
2404   // Similar to int2ptr above, we can look through ptr2int here if the cast
2405   // is a no-op or an extend and not a truncate.
2406   if (auto *P2I = dyn_cast<PtrToIntInst>(V))
2407     if (Q.DL.getTypeSizeInBits(P2I->getSrcTy()) <=
2408         Q.DL.getTypeSizeInBits(P2I->getDestTy()))
2409       return isKnownNonZero(P2I->getOperand(0), Depth, Q);
2410 
2411   unsigned BitWidth = getBitWidth(V->getType()->getScalarType(), Q.DL);
2412 
2413   // X | Y != 0 if X != 0 or Y != 0.
2414   Value *X = nullptr, *Y = nullptr;
2415   if (match(V, m_Or(m_Value(X), m_Value(Y))))
2416     return isKnownNonZero(X, DemandedElts, Depth, Q) ||
2417            isKnownNonZero(Y, DemandedElts, Depth, Q);
2418 
2419   // ext X != 0 if X != 0.
2420   if (isa<SExtInst>(V) || isa<ZExtInst>(V))
2421     return isKnownNonZero(cast<Instruction>(V)->getOperand(0), Depth, Q);
2422 
2423   // shl X, Y != 0 if X is odd.  Note that the value of the shift is undefined
2424   // if the lowest bit is shifted off the end.
2425   if (match(V, m_Shl(m_Value(X), m_Value(Y)))) {
2426     // shl nuw can't remove any non-zero bits.
2427     const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
2428     if (Q.IIQ.hasNoUnsignedWrap(BO))
2429       return isKnownNonZero(X, Depth, Q);
2430 
2431     KnownBits Known(BitWidth);
2432     computeKnownBits(X, DemandedElts, Known, Depth, Q);
2433     if (Known.One[0])
2434       return true;
2435   }
2436   // shr X, Y != 0 if X is negative.  Note that the value of the shift is not
2437   // defined if the sign bit is shifted off the end.
2438   else if (match(V, m_Shr(m_Value(X), m_Value(Y)))) {
2439     // shr exact can only shift out zero bits.
2440     const PossiblyExactOperator *BO = cast<PossiblyExactOperator>(V);
2441     if (BO->isExact())
2442       return isKnownNonZero(X, Depth, Q);
2443 
2444     KnownBits Known = computeKnownBits(X, DemandedElts, Depth, Q);
2445     if (Known.isNegative())
2446       return true;
2447 
2448     // If the shifter operand is a constant, and all of the bits shifted
2449     // out are known to be zero, and X is known non-zero then at least one
2450     // non-zero bit must remain.
2451     if (ConstantInt *Shift = dyn_cast<ConstantInt>(Y)) {
2452       auto ShiftVal = Shift->getLimitedValue(BitWidth - 1);
2453       // Is there a known one in the portion not shifted out?
2454       if (Known.countMaxLeadingZeros() < BitWidth - ShiftVal)
2455         return true;
2456       // Are all the bits to be shifted out known zero?
2457       if (Known.countMinTrailingZeros() >= ShiftVal)
2458         return isKnownNonZero(X, DemandedElts, Depth, Q);
2459     }
2460   }
2461   // div exact can only produce a zero if the dividend is zero.
2462   else if (match(V, m_Exact(m_IDiv(m_Value(X), m_Value())))) {
2463     return isKnownNonZero(X, DemandedElts, Depth, Q);
2464   }
2465   // X + Y.
2466   else if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
2467     KnownBits XKnown = computeKnownBits(X, DemandedElts, Depth, Q);
2468     KnownBits YKnown = computeKnownBits(Y, DemandedElts, Depth, Q);
2469 
2470     // If X and Y are both non-negative (as signed values) then their sum is not
2471     // zero unless both X and Y are zero.
2472     if (XKnown.isNonNegative() && YKnown.isNonNegative())
2473       if (isKnownNonZero(X, DemandedElts, Depth, Q) ||
2474           isKnownNonZero(Y, DemandedElts, Depth, Q))
2475         return true;
2476 
2477     // If X and Y are both negative (as signed values) then their sum is not
2478     // zero unless both X and Y equal INT_MIN.
2479     if (XKnown.isNegative() && YKnown.isNegative()) {
2480       APInt Mask = APInt::getSignedMaxValue(BitWidth);
2481       // The sign bit of X is set.  If some other bit is set then X is not equal
2482       // to INT_MIN.
2483       if (XKnown.One.intersects(Mask))
2484         return true;
2485       // The sign bit of Y is set.  If some other bit is set then Y is not equal
2486       // to INT_MIN.
2487       if (YKnown.One.intersects(Mask))
2488         return true;
2489     }
2490 
2491     // The sum of a non-negative number and a power of two is not zero.
2492     if (XKnown.isNonNegative() &&
2493         isKnownToBeAPowerOfTwo(Y, /*OrZero*/ false, Depth, Q))
2494       return true;
2495     if (YKnown.isNonNegative() &&
2496         isKnownToBeAPowerOfTwo(X, /*OrZero*/ false, Depth, Q))
2497       return true;
2498   }
2499   // X * Y.
2500   else if (match(V, m_Mul(m_Value(X), m_Value(Y)))) {
2501     const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
2502     // If X and Y are non-zero then so is X * Y as long as the multiplication
2503     // does not overflow.
2504     if ((Q.IIQ.hasNoSignedWrap(BO) || Q.IIQ.hasNoUnsignedWrap(BO)) &&
2505         isKnownNonZero(X, DemandedElts, Depth, Q) &&
2506         isKnownNonZero(Y, DemandedElts, Depth, Q))
2507       return true;
2508   }
2509   // (C ? X : Y) != 0 if X != 0 and Y != 0.
2510   else if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
2511     if (isKnownNonZero(SI->getTrueValue(), DemandedElts, Depth, Q) &&
2512         isKnownNonZero(SI->getFalseValue(), DemandedElts, Depth, Q))
2513       return true;
2514   }
2515   // PHI
2516   else if (const PHINode *PN = dyn_cast<PHINode>(V)) {
2517     // Try and detect a recurrence that monotonically increases from a
2518     // starting value, as these are common as induction variables.
2519     if (PN->getNumIncomingValues() == 2) {
2520       Value *Start = PN->getIncomingValue(0);
2521       Value *Induction = PN->getIncomingValue(1);
2522       if (isa<ConstantInt>(Induction) && !isa<ConstantInt>(Start))
2523         std::swap(Start, Induction);
2524       if (ConstantInt *C = dyn_cast<ConstantInt>(Start)) {
2525         if (!C->isZero() && !C->isNegative()) {
2526           ConstantInt *X;
2527           if (Q.IIQ.UseInstrInfo &&
2528               (match(Induction, m_NSWAdd(m_Specific(PN), m_ConstantInt(X))) ||
2529                match(Induction, m_NUWAdd(m_Specific(PN), m_ConstantInt(X)))) &&
2530               !X->isNegative())
2531             return true;
2532         }
2533       }
2534     }
2535     // Check if all incoming values are non-zero constant.
2536     bool AllNonZeroConstants = llvm::all_of(PN->operands(), [](Value *V) {
2537       return isa<ConstantInt>(V) && !cast<ConstantInt>(V)->isZero();
2538     });
2539     if (AllNonZeroConstants)
2540       return true;
2541   }
2542   // ExtractElement
2543   else if (const auto *EEI = dyn_cast<ExtractElementInst>(V)) {
2544     const Value *Vec = EEI->getVectorOperand();
2545     const Value *Idx = EEI->getIndexOperand();
2546     auto *CIdx = dyn_cast<ConstantInt>(Idx);
2547     unsigned NumElts = cast<FixedVectorType>(Vec->getType())->getNumElements();
2548     APInt DemandedVecElts = APInt::getAllOnesValue(NumElts);
2549     if (CIdx && CIdx->getValue().ult(NumElts))
2550       DemandedVecElts = APInt::getOneBitSet(NumElts, CIdx->getZExtValue());
2551     return isKnownNonZero(Vec, DemandedVecElts, Depth, Q);
2552   }
2553 
2554   KnownBits Known(BitWidth);
2555   computeKnownBits(V, DemandedElts, Known, Depth, Q);
2556   return Known.One != 0;
2557 }
2558 
2559 bool isKnownNonZero(const Value* V, unsigned Depth, const Query& Q) {
2560   // FIXME: We currently have no way to represent the DemandedElts of a scalable
2561   // vector
2562   if (isa<ScalableVectorType>(V->getType()))
2563     return false;
2564 
2565   auto *FVTy = dyn_cast<FixedVectorType>(V->getType());
2566   APInt DemandedElts =
2567       FVTy ? APInt::getAllOnesValue(FVTy->getNumElements()) : APInt(1, 1);
2568   return isKnownNonZero(V, DemandedElts, Depth, Q);
2569 }
2570 
2571 /// Return true if V2 == V1 + X, where X is known non-zero.
2572 static bool isAddOfNonZero(const Value *V1, const Value *V2, const Query &Q) {
2573   const BinaryOperator *BO = dyn_cast<BinaryOperator>(V1);
2574   if (!BO || BO->getOpcode() != Instruction::Add)
2575     return false;
2576   Value *Op = nullptr;
2577   if (V2 == BO->getOperand(0))
2578     Op = BO->getOperand(1);
2579   else if (V2 == BO->getOperand(1))
2580     Op = BO->getOperand(0);
2581   else
2582     return false;
2583   return isKnownNonZero(Op, 0, Q);
2584 }
2585 
2586 /// Return true if it is known that V1 != V2.
2587 static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q) {
2588   if (V1 == V2)
2589     return false;
2590   if (V1->getType() != V2->getType())
2591     // We can't look through casts yet.
2592     return false;
2593   if (isAddOfNonZero(V1, V2, Q) || isAddOfNonZero(V2, V1, Q))
2594     return true;
2595 
2596   if (V1->getType()->isIntOrIntVectorTy()) {
2597     // Are any known bits in V1 contradictory to known bits in V2? If V1
2598     // has a known zero where V2 has a known one, they must not be equal.
2599     KnownBits Known1 = computeKnownBits(V1, 0, Q);
2600     KnownBits Known2 = computeKnownBits(V2, 0, Q);
2601 
2602     if (Known1.Zero.intersects(Known2.One) ||
2603         Known2.Zero.intersects(Known1.One))
2604       return true;
2605   }
2606   return false;
2607 }
2608 
2609 /// Return true if 'V & Mask' is known to be zero.  We use this predicate to
2610 /// simplify operations downstream. Mask is known to be zero for bits that V
2611 /// cannot have.
2612 ///
2613 /// This function is defined on values with integer type, values with pointer
2614 /// type, and vectors of integers.  In the case
2615 /// where V is a vector, the mask, known zero, and known one values are the
2616 /// same width as the vector element, and the bit is set only if it is true
2617 /// for all of the elements in the vector.
2618 bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
2619                        const Query &Q) {
2620   KnownBits Known(Mask.getBitWidth());
2621   computeKnownBits(V, Known, Depth, Q);
2622   return Mask.isSubsetOf(Known.Zero);
2623 }
2624 
2625 // Match a signed min+max clamp pattern like smax(smin(In, CHigh), CLow).
2626 // Returns the input and lower/upper bounds.
2627 static bool isSignedMinMaxClamp(const Value *Select, const Value *&In,
2628                                 const APInt *&CLow, const APInt *&CHigh) {
2629   assert(isa<Operator>(Select) &&
2630          cast<Operator>(Select)->getOpcode() == Instruction::Select &&
2631          "Input should be a Select!");
2632 
2633   const Value *LHS = nullptr, *RHS = nullptr;
2634   SelectPatternFlavor SPF = matchSelectPattern(Select, LHS, RHS).Flavor;
2635   if (SPF != SPF_SMAX && SPF != SPF_SMIN)
2636     return false;
2637 
2638   if (!match(RHS, m_APInt(CLow)))
2639     return false;
2640 
2641   const Value *LHS2 = nullptr, *RHS2 = nullptr;
2642   SelectPatternFlavor SPF2 = matchSelectPattern(LHS, LHS2, RHS2).Flavor;
2643   if (getInverseMinMaxFlavor(SPF) != SPF2)
2644     return false;
2645 
2646   if (!match(RHS2, m_APInt(CHigh)))
2647     return false;
2648 
2649   if (SPF == SPF_SMIN)
2650     std::swap(CLow, CHigh);
2651 
2652   In = LHS2;
2653   return CLow->sle(*CHigh);
2654 }
2655 
2656 /// For vector constants, loop over the elements and find the constant with the
2657 /// minimum number of sign bits. Return 0 if the value is not a vector constant
2658 /// or if any element was not analyzed; otherwise, return the count for the
2659 /// element with the minimum number of sign bits.
2660 static unsigned computeNumSignBitsVectorConstant(const Value *V,
2661                                                  const APInt &DemandedElts,
2662                                                  unsigned TyBits) {
2663   const auto *CV = dyn_cast<Constant>(V);
2664   if (!CV || !isa<FixedVectorType>(CV->getType()))
2665     return 0;
2666 
2667   unsigned MinSignBits = TyBits;
2668   unsigned NumElts = cast<FixedVectorType>(CV->getType())->getNumElements();
2669   for (unsigned i = 0; i != NumElts; ++i) {
2670     if (!DemandedElts[i])
2671       continue;
2672     // If we find a non-ConstantInt, bail out.
2673     auto *Elt = dyn_cast_or_null<ConstantInt>(CV->getAggregateElement(i));
2674     if (!Elt)
2675       return 0;
2676 
2677     MinSignBits = std::min(MinSignBits, Elt->getValue().getNumSignBits());
2678   }
2679 
2680   return MinSignBits;
2681 }
2682 
2683 static unsigned ComputeNumSignBitsImpl(const Value *V,
2684                                        const APInt &DemandedElts,
2685                                        unsigned Depth, const Query &Q);
2686 
2687 static unsigned ComputeNumSignBits(const Value *V, const APInt &DemandedElts,
2688                                    unsigned Depth, const Query &Q) {
2689   unsigned Result = ComputeNumSignBitsImpl(V, DemandedElts, Depth, Q);
2690   assert(Result > 0 && "At least one sign bit needs to be present!");
2691   return Result;
2692 }
2693 
2694 /// Return the number of times the sign bit of the register is replicated into
2695 /// the other bits. We know that at least 1 bit is always equal to the sign bit
2696 /// (itself), but other cases can give us information. For example, immediately
2697 /// after an "ashr X, 2", we know that the top 3 bits are all equal to each
2698 /// other, so we return 3. For vectors, return the number of sign bits for the
2699 /// vector element with the minimum number of known sign bits of the demanded
2700 /// elements in the vector specified by DemandedElts.
2701 static unsigned ComputeNumSignBitsImpl(const Value *V,
2702                                        const APInt &DemandedElts,
2703                                        unsigned Depth, const Query &Q) {
2704   Type *Ty = V->getType();
2705 
2706   // FIXME: We currently have no way to represent the DemandedElts of a scalable
2707   // vector
2708   if (isa<ScalableVectorType>(Ty))
2709     return 1;
2710 
2711 #ifndef NDEBUG
2712   assert(Depth <= MaxDepth && "Limit Search Depth");
2713 
2714   if (auto *FVTy = dyn_cast<FixedVectorType>(Ty)) {
2715     assert(
2716         FVTy->getNumElements() == DemandedElts.getBitWidth() &&
2717         "DemandedElt width should equal the fixed vector number of elements");
2718   } else {
2719     assert(DemandedElts == APInt(1, 1) &&
2720            "DemandedElt width should be 1 for scalars");
2721   }
2722 #endif
2723 
2724   // We return the minimum number of sign bits that are guaranteed to be present
2725   // in V, so for undef we have to conservatively return 1.  We don't have the
2726   // same behavior for poison though -- that's a FIXME today.
2727 
2728   Type *ScalarTy = Ty->getScalarType();
2729   unsigned TyBits = ScalarTy->isPointerTy() ?
2730     Q.DL.getPointerTypeSizeInBits(ScalarTy) :
2731     Q.DL.getTypeSizeInBits(ScalarTy);
2732 
2733   unsigned Tmp, Tmp2;
2734   unsigned FirstAnswer = 1;
2735 
2736   // Note that ConstantInt is handled by the general computeKnownBits case
2737   // below.
2738 
2739   if (Depth == MaxDepth)
2740     return 1;  // Limit search depth.
2741 
2742   if (auto *U = dyn_cast<Operator>(V)) {
2743     switch (Operator::getOpcode(V)) {
2744     default: break;
2745     case Instruction::SExt:
2746       Tmp = TyBits - U->getOperand(0)->getType()->getScalarSizeInBits();
2747       return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q) + Tmp;
2748 
2749     case Instruction::SDiv: {
2750       const APInt *Denominator;
2751       // sdiv X, C -> adds log(C) sign bits.
2752       if (match(U->getOperand(1), m_APInt(Denominator))) {
2753 
2754         // Ignore non-positive denominator.
2755         if (!Denominator->isStrictlyPositive())
2756           break;
2757 
2758         // Calculate the incoming numerator bits.
2759         unsigned NumBits = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2760 
2761         // Add floor(log(C)) bits to the numerator bits.
2762         return std::min(TyBits, NumBits + Denominator->logBase2());
2763       }
2764       break;
2765     }
2766 
2767     case Instruction::SRem: {
2768       const APInt *Denominator;
2769       // srem X, C -> we know that the result is within [-C+1,C) when C is a
2770       // positive constant.  This let us put a lower bound on the number of sign
2771       // bits.
2772       if (match(U->getOperand(1), m_APInt(Denominator))) {
2773 
2774         // Ignore non-positive denominator.
2775         if (!Denominator->isStrictlyPositive())
2776           break;
2777 
2778         // Calculate the incoming numerator bits. SRem by a positive constant
2779         // can't lower the number of sign bits.
2780         unsigned NumrBits = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2781 
2782         // Calculate the leading sign bit constraints by examining the
2783         // denominator.  Given that the denominator is positive, there are two
2784         // cases:
2785         //
2786         //  1. the numerator is positive. The result range is [0,C) and [0,C) u<
2787         //     (1 << ceilLogBase2(C)).
2788         //
2789         //  2. the numerator is negative. Then the result range is (-C,0] and
2790         //     integers in (-C,0] are either 0 or >u (-1 << ceilLogBase2(C)).
2791         //
2792         // Thus a lower bound on the number of sign bits is `TyBits -
2793         // ceilLogBase2(C)`.
2794 
2795         unsigned ResBits = TyBits - Denominator->ceilLogBase2();
2796         return std::max(NumrBits, ResBits);
2797       }
2798       break;
2799     }
2800 
2801     case Instruction::AShr: {
2802       Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2803       // ashr X, C   -> adds C sign bits.  Vectors too.
2804       const APInt *ShAmt;
2805       if (match(U->getOperand(1), m_APInt(ShAmt))) {
2806         if (ShAmt->uge(TyBits))
2807           break; // Bad shift.
2808         unsigned ShAmtLimited = ShAmt->getZExtValue();
2809         Tmp += ShAmtLimited;
2810         if (Tmp > TyBits) Tmp = TyBits;
2811       }
2812       return Tmp;
2813     }
2814     case Instruction::Shl: {
2815       const APInt *ShAmt;
2816       if (match(U->getOperand(1), m_APInt(ShAmt))) {
2817         // shl destroys sign bits.
2818         Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2819         if (ShAmt->uge(TyBits) ||   // Bad shift.
2820             ShAmt->uge(Tmp)) break; // Shifted all sign bits out.
2821         Tmp2 = ShAmt->getZExtValue();
2822         return Tmp - Tmp2;
2823       }
2824       break;
2825     }
2826     case Instruction::And:
2827     case Instruction::Or:
2828     case Instruction::Xor: // NOT is handled here.
2829       // Logical binary ops preserve the number of sign bits at the worst.
2830       Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2831       if (Tmp != 1) {
2832         Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
2833         FirstAnswer = std::min(Tmp, Tmp2);
2834         // We computed what we know about the sign bits as our first
2835         // answer. Now proceed to the generic code that uses
2836         // computeKnownBits, and pick whichever answer is better.
2837       }
2838       break;
2839 
2840     case Instruction::Select: {
2841       // If we have a clamp pattern, we know that the number of sign bits will
2842       // be the minimum of the clamp min/max range.
2843       const Value *X;
2844       const APInt *CLow, *CHigh;
2845       if (isSignedMinMaxClamp(U, X, CLow, CHigh))
2846         return std::min(CLow->getNumSignBits(), CHigh->getNumSignBits());
2847 
2848       Tmp = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
2849       if (Tmp == 1) break;
2850       Tmp2 = ComputeNumSignBits(U->getOperand(2), Depth + 1, Q);
2851       return std::min(Tmp, Tmp2);
2852     }
2853 
2854     case Instruction::Add:
2855       // Add can have at most one carry bit.  Thus we know that the output
2856       // is, at worst, one more bit than the inputs.
2857       Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2858       if (Tmp == 1) break;
2859 
2860       // Special case decrementing a value (ADD X, -1):
2861       if (const auto *CRHS = dyn_cast<Constant>(U->getOperand(1)))
2862         if (CRHS->isAllOnesValue()) {
2863           KnownBits Known(TyBits);
2864           computeKnownBits(U->getOperand(0), Known, Depth + 1, Q);
2865 
2866           // If the input is known to be 0 or 1, the output is 0/-1, which is
2867           // all sign bits set.
2868           if ((Known.Zero | 1).isAllOnesValue())
2869             return TyBits;
2870 
2871           // If we are subtracting one from a positive number, there is no carry
2872           // out of the result.
2873           if (Known.isNonNegative())
2874             return Tmp;
2875         }
2876 
2877       Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
2878       if (Tmp2 == 1) break;
2879       return std::min(Tmp, Tmp2) - 1;
2880 
2881     case Instruction::Sub:
2882       Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
2883       if (Tmp2 == 1) break;
2884 
2885       // Handle NEG.
2886       if (const auto *CLHS = dyn_cast<Constant>(U->getOperand(0)))
2887         if (CLHS->isNullValue()) {
2888           KnownBits Known(TyBits);
2889           computeKnownBits(U->getOperand(1), Known, Depth + 1, Q);
2890           // If the input is known to be 0 or 1, the output is 0/-1, which is
2891           // all sign bits set.
2892           if ((Known.Zero | 1).isAllOnesValue())
2893             return TyBits;
2894 
2895           // If the input is known to be positive (the sign bit is known clear),
2896           // the output of the NEG has the same number of sign bits as the
2897           // input.
2898           if (Known.isNonNegative())
2899             return Tmp2;
2900 
2901           // Otherwise, we treat this like a SUB.
2902         }
2903 
2904       // Sub can have at most one carry bit.  Thus we know that the output
2905       // is, at worst, one more bit than the inputs.
2906       Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2907       if (Tmp == 1) break;
2908       return std::min(Tmp, Tmp2) - 1;
2909 
2910     case Instruction::Mul: {
2911       // The output of the Mul can be at most twice the valid bits in the
2912       // inputs.
2913       unsigned SignBitsOp0 = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2914       if (SignBitsOp0 == 1) break;
2915       unsigned SignBitsOp1 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
2916       if (SignBitsOp1 == 1) break;
2917       unsigned OutValidBits =
2918           (TyBits - SignBitsOp0 + 1) + (TyBits - SignBitsOp1 + 1);
2919       return OutValidBits > TyBits ? 1 : TyBits - OutValidBits + 1;
2920     }
2921 
2922     case Instruction::PHI: {
2923       const PHINode *PN = cast<PHINode>(U);
2924       unsigned NumIncomingValues = PN->getNumIncomingValues();
2925       // Don't analyze large in-degree PHIs.
2926       if (NumIncomingValues > 4) break;
2927       // Unreachable blocks may have zero-operand PHI nodes.
2928       if (NumIncomingValues == 0) break;
2929 
2930       // Take the minimum of all incoming values.  This can't infinitely loop
2931       // because of our depth threshold.
2932       Tmp = ComputeNumSignBits(PN->getIncomingValue(0), Depth + 1, Q);
2933       for (unsigned i = 1, e = NumIncomingValues; i != e; ++i) {
2934         if (Tmp == 1) return Tmp;
2935         Tmp = std::min(
2936             Tmp, ComputeNumSignBits(PN->getIncomingValue(i), Depth + 1, Q));
2937       }
2938       return Tmp;
2939     }
2940 
2941     case Instruction::Trunc:
2942       // FIXME: it's tricky to do anything useful for this, but it is an
2943       // important case for targets like X86.
2944       break;
2945 
2946     case Instruction::ExtractElement:
2947       // Look through extract element. At the moment we keep this simple and
2948       // skip tracking the specific element. But at least we might find
2949       // information valid for all elements of the vector (for example if vector
2950       // is sign extended, shifted, etc).
2951       return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
2952 
2953     case Instruction::ShuffleVector: {
2954       // Collect the minimum number of sign bits that are shared by every vector
2955       // element referenced by the shuffle.
2956       auto *Shuf = dyn_cast<ShuffleVectorInst>(U);
2957       if (!Shuf) {
2958         // FIXME: Add support for shufflevector constant expressions.
2959         return 1;
2960       }
2961       APInt DemandedLHS, DemandedRHS;
2962       // For undef elements, we don't know anything about the common state of
2963       // the shuffle result.
2964       if (!getShuffleDemandedElts(Shuf, DemandedElts, DemandedLHS, DemandedRHS))
2965         return 1;
2966       Tmp = std::numeric_limits<unsigned>::max();
2967       if (!!DemandedLHS) {
2968         const Value *LHS = Shuf->getOperand(0);
2969         Tmp = ComputeNumSignBits(LHS, DemandedLHS, Depth + 1, Q);
2970       }
2971       // If we don't know anything, early out and try computeKnownBits
2972       // fall-back.
2973       if (Tmp == 1)
2974         break;
2975       if (!!DemandedRHS) {
2976         const Value *RHS = Shuf->getOperand(1);
2977         Tmp2 = ComputeNumSignBits(RHS, DemandedRHS, Depth + 1, Q);
2978         Tmp = std::min(Tmp, Tmp2);
2979       }
2980       // If we don't know anything, early out and try computeKnownBits
2981       // fall-back.
2982       if (Tmp == 1)
2983         break;
2984       assert(Tmp <= Ty->getScalarSizeInBits() &&
2985              "Failed to determine minimum sign bits");
2986       return Tmp;
2987     }
2988     }
2989   }
2990 
2991   // Finally, if we can prove that the top bits of the result are 0's or 1's,
2992   // use this information.
2993 
2994   // If we can examine all elements of a vector constant successfully, we're
2995   // done (we can't do any better than that). If not, keep trying.
2996   if (unsigned VecSignBits =
2997           computeNumSignBitsVectorConstant(V, DemandedElts, TyBits))
2998     return VecSignBits;
2999 
3000   KnownBits Known(TyBits);
3001   computeKnownBits(V, DemandedElts, Known, Depth, Q);
3002 
3003   // If we know that the sign bit is either zero or one, determine the number of
3004   // identical bits in the top of the input value.
3005   return std::max(FirstAnswer, Known.countMinSignBits());
3006 }
3007 
3008 /// This function computes the integer multiple of Base that equals V.
3009 /// If successful, it returns true and returns the multiple in
3010 /// Multiple. If unsuccessful, it returns false. It looks
3011 /// through SExt instructions only if LookThroughSExt is true.
3012 bool llvm::ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
3013                            bool LookThroughSExt, unsigned Depth) {
3014   assert(V && "No Value?");
3015   assert(Depth <= MaxDepth && "Limit Search Depth");
3016   assert(V->getType()->isIntegerTy() && "Not integer or pointer type!");
3017 
3018   Type *T = V->getType();
3019 
3020   ConstantInt *CI = dyn_cast<ConstantInt>(V);
3021 
3022   if (Base == 0)
3023     return false;
3024 
3025   if (Base == 1) {
3026     Multiple = V;
3027     return true;
3028   }
3029 
3030   ConstantExpr *CO = dyn_cast<ConstantExpr>(V);
3031   Constant *BaseVal = ConstantInt::get(T, Base);
3032   if (CO && CO == BaseVal) {
3033     // Multiple is 1.
3034     Multiple = ConstantInt::get(T, 1);
3035     return true;
3036   }
3037 
3038   if (CI && CI->getZExtValue() % Base == 0) {
3039     Multiple = ConstantInt::get(T, CI->getZExtValue() / Base);
3040     return true;
3041   }
3042 
3043   if (Depth == MaxDepth) return false;  // Limit search depth.
3044 
3045   Operator *I = dyn_cast<Operator>(V);
3046   if (!I) return false;
3047 
3048   switch (I->getOpcode()) {
3049   default: break;
3050   case Instruction::SExt:
3051     if (!LookThroughSExt) return false;
3052     // otherwise fall through to ZExt
3053     LLVM_FALLTHROUGH;
3054   case Instruction::ZExt:
3055     return ComputeMultiple(I->getOperand(0), Base, Multiple,
3056                            LookThroughSExt, Depth+1);
3057   case Instruction::Shl:
3058   case Instruction::Mul: {
3059     Value *Op0 = I->getOperand(0);
3060     Value *Op1 = I->getOperand(1);
3061 
3062     if (I->getOpcode() == Instruction::Shl) {
3063       ConstantInt *Op1CI = dyn_cast<ConstantInt>(Op1);
3064       if (!Op1CI) return false;
3065       // Turn Op0 << Op1 into Op0 * 2^Op1
3066       APInt Op1Int = Op1CI->getValue();
3067       uint64_t BitToSet = Op1Int.getLimitedValue(Op1Int.getBitWidth() - 1);
3068       APInt API(Op1Int.getBitWidth(), 0);
3069       API.setBit(BitToSet);
3070       Op1 = ConstantInt::get(V->getContext(), API);
3071     }
3072 
3073     Value *Mul0 = nullptr;
3074     if (ComputeMultiple(Op0, Base, Mul0, LookThroughSExt, Depth+1)) {
3075       if (Constant *Op1C = dyn_cast<Constant>(Op1))
3076         if (Constant *MulC = dyn_cast<Constant>(Mul0)) {
3077           if (Op1C->getType()->getPrimitiveSizeInBits() <
3078               MulC->getType()->getPrimitiveSizeInBits())
3079             Op1C = ConstantExpr::getZExt(Op1C, MulC->getType());
3080           if (Op1C->getType()->getPrimitiveSizeInBits() >
3081               MulC->getType()->getPrimitiveSizeInBits())
3082             MulC = ConstantExpr::getZExt(MulC, Op1C->getType());
3083 
3084           // V == Base * (Mul0 * Op1), so return (Mul0 * Op1)
3085           Multiple = ConstantExpr::getMul(MulC, Op1C);
3086           return true;
3087         }
3088 
3089       if (ConstantInt *Mul0CI = dyn_cast<ConstantInt>(Mul0))
3090         if (Mul0CI->getValue() == 1) {
3091           // V == Base * Op1, so return Op1
3092           Multiple = Op1;
3093           return true;
3094         }
3095     }
3096 
3097     Value *Mul1 = nullptr;
3098     if (ComputeMultiple(Op1, Base, Mul1, LookThroughSExt, Depth+1)) {
3099       if (Constant *Op0C = dyn_cast<Constant>(Op0))
3100         if (Constant *MulC = dyn_cast<Constant>(Mul1)) {
3101           if (Op0C->getType()->getPrimitiveSizeInBits() <
3102               MulC->getType()->getPrimitiveSizeInBits())
3103             Op0C = ConstantExpr::getZExt(Op0C, MulC->getType());
3104           if (Op0C->getType()->getPrimitiveSizeInBits() >
3105               MulC->getType()->getPrimitiveSizeInBits())
3106             MulC = ConstantExpr::getZExt(MulC, Op0C->getType());
3107 
3108           // V == Base * (Mul1 * Op0), so return (Mul1 * Op0)
3109           Multiple = ConstantExpr::getMul(MulC, Op0C);
3110           return true;
3111         }
3112 
3113       if (ConstantInt *Mul1CI = dyn_cast<ConstantInt>(Mul1))
3114         if (Mul1CI->getValue() == 1) {
3115           // V == Base * Op0, so return Op0
3116           Multiple = Op0;
3117           return true;
3118         }
3119     }
3120   }
3121   }
3122 
3123   // We could not determine if V is a multiple of Base.
3124   return false;
3125 }
3126 
3127 Intrinsic::ID llvm::getIntrinsicForCallSite(const CallBase &CB,
3128                                             const TargetLibraryInfo *TLI) {
3129   const Function *F = CB.getCalledFunction();
3130   if (!F)
3131     return Intrinsic::not_intrinsic;
3132 
3133   if (F->isIntrinsic())
3134     return F->getIntrinsicID();
3135 
3136   if (!TLI)
3137     return Intrinsic::not_intrinsic;
3138 
3139   LibFunc Func;
3140   // We're going to make assumptions on the semantics of the functions, check
3141   // that the target knows that it's available in this environment and it does
3142   // not have local linkage.
3143   if (!F || F->hasLocalLinkage() || !TLI->getLibFunc(*F, Func))
3144     return Intrinsic::not_intrinsic;
3145 
3146   if (!CB.onlyReadsMemory())
3147     return Intrinsic::not_intrinsic;
3148 
3149   // Otherwise check if we have a call to a function that can be turned into a
3150   // vector intrinsic.
3151   switch (Func) {
3152   default:
3153     break;
3154   case LibFunc_sin:
3155   case LibFunc_sinf:
3156   case LibFunc_sinl:
3157     return Intrinsic::sin;
3158   case LibFunc_cos:
3159   case LibFunc_cosf:
3160   case LibFunc_cosl:
3161     return Intrinsic::cos;
3162   case LibFunc_exp:
3163   case LibFunc_expf:
3164   case LibFunc_expl:
3165     return Intrinsic::exp;
3166   case LibFunc_exp2:
3167   case LibFunc_exp2f:
3168   case LibFunc_exp2l:
3169     return Intrinsic::exp2;
3170   case LibFunc_log:
3171   case LibFunc_logf:
3172   case LibFunc_logl:
3173     return Intrinsic::log;
3174   case LibFunc_log10:
3175   case LibFunc_log10f:
3176   case LibFunc_log10l:
3177     return Intrinsic::log10;
3178   case LibFunc_log2:
3179   case LibFunc_log2f:
3180   case LibFunc_log2l:
3181     return Intrinsic::log2;
3182   case LibFunc_fabs:
3183   case LibFunc_fabsf:
3184   case LibFunc_fabsl:
3185     return Intrinsic::fabs;
3186   case LibFunc_fmin:
3187   case LibFunc_fminf:
3188   case LibFunc_fminl:
3189     return Intrinsic::minnum;
3190   case LibFunc_fmax:
3191   case LibFunc_fmaxf:
3192   case LibFunc_fmaxl:
3193     return Intrinsic::maxnum;
3194   case LibFunc_copysign:
3195   case LibFunc_copysignf:
3196   case LibFunc_copysignl:
3197     return Intrinsic::copysign;
3198   case LibFunc_floor:
3199   case LibFunc_floorf:
3200   case LibFunc_floorl:
3201     return Intrinsic::floor;
3202   case LibFunc_ceil:
3203   case LibFunc_ceilf:
3204   case LibFunc_ceill:
3205     return Intrinsic::ceil;
3206   case LibFunc_trunc:
3207   case LibFunc_truncf:
3208   case LibFunc_truncl:
3209     return Intrinsic::trunc;
3210   case LibFunc_rint:
3211   case LibFunc_rintf:
3212   case LibFunc_rintl:
3213     return Intrinsic::rint;
3214   case LibFunc_nearbyint:
3215   case LibFunc_nearbyintf:
3216   case LibFunc_nearbyintl:
3217     return Intrinsic::nearbyint;
3218   case LibFunc_round:
3219   case LibFunc_roundf:
3220   case LibFunc_roundl:
3221     return Intrinsic::round;
3222   case LibFunc_roundeven:
3223   case LibFunc_roundevenf:
3224   case LibFunc_roundevenl:
3225     return Intrinsic::roundeven;
3226   case LibFunc_pow:
3227   case LibFunc_powf:
3228   case LibFunc_powl:
3229     return Intrinsic::pow;
3230   case LibFunc_sqrt:
3231   case LibFunc_sqrtf:
3232   case LibFunc_sqrtl:
3233     return Intrinsic::sqrt;
3234   }
3235 
3236   return Intrinsic::not_intrinsic;
3237 }
3238 
3239 /// Return true if we can prove that the specified FP value is never equal to
3240 /// -0.0.
3241 /// NOTE: Do not check 'nsz' here because that fast-math-flag does not guarantee
3242 ///       that a value is not -0.0. It only guarantees that -0.0 may be treated
3243 ///       the same as +0.0 in floating-point ops.
3244 ///
3245 /// NOTE: this function will need to be revisited when we support non-default
3246 /// rounding modes!
3247 bool llvm::CannotBeNegativeZero(const Value *V, const TargetLibraryInfo *TLI,
3248                                 unsigned Depth) {
3249   if (auto *CFP = dyn_cast<ConstantFP>(V))
3250     return !CFP->getValueAPF().isNegZero();
3251 
3252   // Limit search depth.
3253   if (Depth == MaxDepth)
3254     return false;
3255 
3256   auto *Op = dyn_cast<Operator>(V);
3257   if (!Op)
3258     return false;
3259 
3260   // (fadd x, 0.0) is guaranteed to return +0.0, not -0.0.
3261   if (match(Op, m_FAdd(m_Value(), m_PosZeroFP())))
3262     return true;
3263 
3264   // sitofp and uitofp turn into +0.0 for zero.
3265   if (isa<SIToFPInst>(Op) || isa<UIToFPInst>(Op))
3266     return true;
3267 
3268   if (auto *Call = dyn_cast<CallInst>(Op)) {
3269     Intrinsic::ID IID = getIntrinsicForCallSite(*Call, TLI);
3270     switch (IID) {
3271     default:
3272       break;
3273     // sqrt(-0.0) = -0.0, no other negative results are possible.
3274     case Intrinsic::sqrt:
3275     case Intrinsic::canonicalize:
3276       return CannotBeNegativeZero(Call->getArgOperand(0), TLI, Depth + 1);
3277     // fabs(x) != -0.0
3278     case Intrinsic::fabs:
3279       return true;
3280     }
3281   }
3282 
3283   return false;
3284 }
3285 
3286 /// If \p SignBitOnly is true, test for a known 0 sign bit rather than a
3287 /// standard ordered compare. e.g. make -0.0 olt 0.0 be true because of the sign
3288 /// bit despite comparing equal.
3289 static bool cannotBeOrderedLessThanZeroImpl(const Value *V,
3290                                             const TargetLibraryInfo *TLI,
3291                                             bool SignBitOnly,
3292                                             unsigned Depth) {
3293   // TODO: This function does not do the right thing when SignBitOnly is true
3294   // and we're lowering to a hypothetical IEEE 754-compliant-but-evil platform
3295   // which flips the sign bits of NaNs.  See
3296   // https://llvm.org/bugs/show_bug.cgi?id=31702.
3297 
3298   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
3299     return !CFP->getValueAPF().isNegative() ||
3300            (!SignBitOnly && CFP->getValueAPF().isZero());
3301   }
3302 
3303   // Handle vector of constants.
3304   if (auto *CV = dyn_cast<Constant>(V)) {
3305     if (auto *CVFVTy = dyn_cast<FixedVectorType>(CV->getType())) {
3306       unsigned NumElts = CVFVTy->getNumElements();
3307       for (unsigned i = 0; i != NumElts; ++i) {
3308         auto *CFP = dyn_cast_or_null<ConstantFP>(CV->getAggregateElement(i));
3309         if (!CFP)
3310           return false;
3311         if (CFP->getValueAPF().isNegative() &&
3312             (SignBitOnly || !CFP->getValueAPF().isZero()))
3313           return false;
3314       }
3315 
3316       // All non-negative ConstantFPs.
3317       return true;
3318     }
3319   }
3320 
3321   if (Depth == MaxDepth)
3322     return false; // Limit search depth.
3323 
3324   const Operator *I = dyn_cast<Operator>(V);
3325   if (!I)
3326     return false;
3327 
3328   switch (I->getOpcode()) {
3329   default:
3330     break;
3331   // Unsigned integers are always nonnegative.
3332   case Instruction::UIToFP:
3333     return true;
3334   case Instruction::FMul:
3335   case Instruction::FDiv:
3336     // X * X is always non-negative or a NaN.
3337     // X / X is always exactly 1.0 or a NaN.
3338     if (I->getOperand(0) == I->getOperand(1) &&
3339         (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()))
3340       return true;
3341 
3342     LLVM_FALLTHROUGH;
3343   case Instruction::FAdd:
3344   case Instruction::FRem:
3345     return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
3346                                            Depth + 1) &&
3347            cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
3348                                            Depth + 1);
3349   case Instruction::Select:
3350     return cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
3351                                            Depth + 1) &&
3352            cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
3353                                            Depth + 1);
3354   case Instruction::FPExt:
3355   case Instruction::FPTrunc:
3356     // Widening/narrowing never change sign.
3357     return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
3358                                            Depth + 1);
3359   case Instruction::ExtractElement:
3360     // Look through extract element. At the moment we keep this simple and skip
3361     // tracking the specific element. But at least we might find information
3362     // valid for all elements of the vector.
3363     return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
3364                                            Depth + 1);
3365   case Instruction::Call:
3366     const auto *CI = cast<CallInst>(I);
3367     Intrinsic::ID IID = getIntrinsicForCallSite(*CI, TLI);
3368     switch (IID) {
3369     default:
3370       break;
3371     case Intrinsic::maxnum:
3372       return (isKnownNeverNaN(I->getOperand(0), TLI) &&
3373               cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI,
3374                                               SignBitOnly, Depth + 1)) ||
3375             (isKnownNeverNaN(I->getOperand(1), TLI) &&
3376               cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI,
3377                                               SignBitOnly, Depth + 1));
3378 
3379     case Intrinsic::maximum:
3380       return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
3381                                              Depth + 1) ||
3382              cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
3383                                              Depth + 1);
3384     case Intrinsic::minnum:
3385     case Intrinsic::minimum:
3386       return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
3387                                              Depth + 1) &&
3388              cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
3389                                              Depth + 1);
3390     case Intrinsic::exp:
3391     case Intrinsic::exp2:
3392     case Intrinsic::fabs:
3393       return true;
3394 
3395     case Intrinsic::sqrt:
3396       // sqrt(x) is always >= -0 or NaN.  Moreover, sqrt(x) == -0 iff x == -0.
3397       if (!SignBitOnly)
3398         return true;
3399       return CI->hasNoNaNs() && (CI->hasNoSignedZeros() ||
3400                                  CannotBeNegativeZero(CI->getOperand(0), TLI));
3401 
3402     case Intrinsic::powi:
3403       if (ConstantInt *Exponent = dyn_cast<ConstantInt>(I->getOperand(1))) {
3404         // powi(x,n) is non-negative if n is even.
3405         if (Exponent->getBitWidth() <= 64 && Exponent->getSExtValue() % 2u == 0)
3406           return true;
3407       }
3408       // TODO: This is not correct.  Given that exp is an integer, here are the
3409       // ways that pow can return a negative value:
3410       //
3411       //   pow(x, exp)    --> negative if exp is odd and x is negative.
3412       //   pow(-0, exp)   --> -inf if exp is negative odd.
3413       //   pow(-0, exp)   --> -0 if exp is positive odd.
3414       //   pow(-inf, exp) --> -0 if exp is negative odd.
3415       //   pow(-inf, exp) --> -inf if exp is positive odd.
3416       //
3417       // Therefore, if !SignBitOnly, we can return true if x >= +0 or x is NaN,
3418       // but we must return false if x == -0.  Unfortunately we do not currently
3419       // have a way of expressing this constraint.  See details in
3420       // https://llvm.org/bugs/show_bug.cgi?id=31702.
3421       return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
3422                                              Depth + 1);
3423 
3424     case Intrinsic::fma:
3425     case Intrinsic::fmuladd:
3426       // x*x+y is non-negative if y is non-negative.
3427       return I->getOperand(0) == I->getOperand(1) &&
3428              (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()) &&
3429              cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
3430                                              Depth + 1);
3431     }
3432     break;
3433   }
3434   return false;
3435 }
3436 
3437 bool llvm::CannotBeOrderedLessThanZero(const Value *V,
3438                                        const TargetLibraryInfo *TLI) {
3439   return cannotBeOrderedLessThanZeroImpl(V, TLI, false, 0);
3440 }
3441 
3442 bool llvm::SignBitMustBeZero(const Value *V, const TargetLibraryInfo *TLI) {
3443   return cannotBeOrderedLessThanZeroImpl(V, TLI, true, 0);
3444 }
3445 
3446 bool llvm::isKnownNeverInfinity(const Value *V, const TargetLibraryInfo *TLI,
3447                                 unsigned Depth) {
3448   assert(V->getType()->isFPOrFPVectorTy() && "Querying for Inf on non-FP type");
3449 
3450   // If we're told that infinities won't happen, assume they won't.
3451   if (auto *FPMathOp = dyn_cast<FPMathOperator>(V))
3452     if (FPMathOp->hasNoInfs())
3453       return true;
3454 
3455   // Handle scalar constants.
3456   if (auto *CFP = dyn_cast<ConstantFP>(V))
3457     return !CFP->isInfinity();
3458 
3459   if (Depth == MaxDepth)
3460     return false;
3461 
3462   if (auto *Inst = dyn_cast<Instruction>(V)) {
3463     switch (Inst->getOpcode()) {
3464     case Instruction::Select: {
3465       return isKnownNeverInfinity(Inst->getOperand(1), TLI, Depth + 1) &&
3466              isKnownNeverInfinity(Inst->getOperand(2), TLI, Depth + 1);
3467     }
3468     case Instruction::UIToFP:
3469       // If the input type fits into the floating type the result is finite.
3470       return ilogb(APFloat::getLargest(
3471                  Inst->getType()->getScalarType()->getFltSemantics())) >=
3472              (int)Inst->getOperand(0)->getType()->getScalarSizeInBits();
3473     default:
3474       break;
3475     }
3476   }
3477 
3478   // try to handle fixed width vector constants
3479   if (isa<FixedVectorType>(V->getType()) && isa<Constant>(V)) {
3480     // For vectors, verify that each element is not infinity.
3481     unsigned NumElts = cast<VectorType>(V->getType())->getNumElements();
3482     for (unsigned i = 0; i != NumElts; ++i) {
3483       Constant *Elt = cast<Constant>(V)->getAggregateElement(i);
3484       if (!Elt)
3485         return false;
3486       if (isa<UndefValue>(Elt))
3487         continue;
3488       auto *CElt = dyn_cast<ConstantFP>(Elt);
3489       if (!CElt || CElt->isInfinity())
3490         return false;
3491     }
3492     // All elements were confirmed non-infinity or undefined.
3493     return true;
3494   }
3495 
3496   // was not able to prove that V never contains infinity
3497   return false;
3498 }
3499 
3500 bool llvm::isKnownNeverNaN(const Value *V, const TargetLibraryInfo *TLI,
3501                            unsigned Depth) {
3502   assert(V->getType()->isFPOrFPVectorTy() && "Querying for NaN on non-FP type");
3503 
3504   // If we're told that NaNs won't happen, assume they won't.
3505   if (auto *FPMathOp = dyn_cast<FPMathOperator>(V))
3506     if (FPMathOp->hasNoNaNs())
3507       return true;
3508 
3509   // Handle scalar constants.
3510   if (auto *CFP = dyn_cast<ConstantFP>(V))
3511     return !CFP->isNaN();
3512 
3513   if (Depth == MaxDepth)
3514     return false;
3515 
3516   if (auto *Inst = dyn_cast<Instruction>(V)) {
3517     switch (Inst->getOpcode()) {
3518     case Instruction::FAdd:
3519     case Instruction::FSub:
3520       // Adding positive and negative infinity produces NaN.
3521       return isKnownNeverNaN(Inst->getOperand(0), TLI, Depth + 1) &&
3522              isKnownNeverNaN(Inst->getOperand(1), TLI, Depth + 1) &&
3523              (isKnownNeverInfinity(Inst->getOperand(0), TLI, Depth + 1) ||
3524               isKnownNeverInfinity(Inst->getOperand(1), TLI, Depth + 1));
3525 
3526     case Instruction::FMul:
3527       // Zero multiplied with infinity produces NaN.
3528       // FIXME: If neither side can be zero fmul never produces NaN.
3529       return isKnownNeverNaN(Inst->getOperand(0), TLI, Depth + 1) &&
3530              isKnownNeverInfinity(Inst->getOperand(0), TLI, Depth + 1) &&
3531              isKnownNeverNaN(Inst->getOperand(1), TLI, Depth + 1) &&
3532              isKnownNeverInfinity(Inst->getOperand(1), TLI, Depth + 1);
3533 
3534     case Instruction::FDiv:
3535     case Instruction::FRem:
3536       // FIXME: Only 0/0, Inf/Inf, Inf REM x and x REM 0 produce NaN.
3537       return false;
3538 
3539     case Instruction::Select: {
3540       return isKnownNeverNaN(Inst->getOperand(1), TLI, Depth + 1) &&
3541              isKnownNeverNaN(Inst->getOperand(2), TLI, Depth + 1);
3542     }
3543     case Instruction::SIToFP:
3544     case Instruction::UIToFP:
3545       return true;
3546     case Instruction::FPTrunc:
3547     case Instruction::FPExt:
3548       return isKnownNeverNaN(Inst->getOperand(0), TLI, Depth + 1);
3549     default:
3550       break;
3551     }
3552   }
3553 
3554   if (const auto *II = dyn_cast<IntrinsicInst>(V)) {
3555     switch (II->getIntrinsicID()) {
3556     case Intrinsic::canonicalize:
3557     case Intrinsic::fabs:
3558     case Intrinsic::copysign:
3559     case Intrinsic::exp:
3560     case Intrinsic::exp2:
3561     case Intrinsic::floor:
3562     case Intrinsic::ceil:
3563     case Intrinsic::trunc:
3564     case Intrinsic::rint:
3565     case Intrinsic::nearbyint:
3566     case Intrinsic::round:
3567     case Intrinsic::roundeven:
3568       return isKnownNeverNaN(II->getArgOperand(0), TLI, Depth + 1);
3569     case Intrinsic::sqrt:
3570       return isKnownNeverNaN(II->getArgOperand(0), TLI, Depth + 1) &&
3571              CannotBeOrderedLessThanZero(II->getArgOperand(0), TLI);
3572     case Intrinsic::minnum:
3573     case Intrinsic::maxnum:
3574       // If either operand is not NaN, the result is not NaN.
3575       return isKnownNeverNaN(II->getArgOperand(0), TLI, Depth + 1) ||
3576              isKnownNeverNaN(II->getArgOperand(1), TLI, Depth + 1);
3577     default:
3578       return false;
3579     }
3580   }
3581 
3582   // Try to handle fixed width vector constants
3583   if (isa<FixedVectorType>(V->getType()) && isa<Constant>(V)) {
3584     // For vectors, verify that each element is not NaN.
3585     unsigned NumElts = cast<VectorType>(V->getType())->getNumElements();
3586     for (unsigned i = 0; i != NumElts; ++i) {
3587       Constant *Elt = cast<Constant>(V)->getAggregateElement(i);
3588       if (!Elt)
3589         return false;
3590       if (isa<UndefValue>(Elt))
3591         continue;
3592       auto *CElt = dyn_cast<ConstantFP>(Elt);
3593       if (!CElt || CElt->isNaN())
3594         return false;
3595     }
3596     // All elements were confirmed not-NaN or undefined.
3597     return true;
3598   }
3599 
3600   // Was not able to prove that V never contains NaN
3601   return false;
3602 }
3603 
3604 Value *llvm::isBytewiseValue(Value *V, const DataLayout &DL) {
3605 
3606   // All byte-wide stores are splatable, even of arbitrary variables.
3607   if (V->getType()->isIntegerTy(8))
3608     return V;
3609 
3610   LLVMContext &Ctx = V->getContext();
3611 
3612   // Undef don't care.
3613   auto *UndefInt8 = UndefValue::get(Type::getInt8Ty(Ctx));
3614   if (isa<UndefValue>(V))
3615     return UndefInt8;
3616 
3617   // Return Undef for zero-sized type.
3618   if (!DL.getTypeStoreSize(V->getType()).isNonZero())
3619     return UndefInt8;
3620 
3621   Constant *C = dyn_cast<Constant>(V);
3622   if (!C) {
3623     // Conceptually, we could handle things like:
3624     //   %a = zext i8 %X to i16
3625     //   %b = shl i16 %a, 8
3626     //   %c = or i16 %a, %b
3627     // but until there is an example that actually needs this, it doesn't seem
3628     // worth worrying about.
3629     return nullptr;
3630   }
3631 
3632   // Handle 'null' ConstantArrayZero etc.
3633   if (C->isNullValue())
3634     return Constant::getNullValue(Type::getInt8Ty(Ctx));
3635 
3636   // Constant floating-point values can be handled as integer values if the
3637   // corresponding integer value is "byteable".  An important case is 0.0.
3638   if (ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
3639     Type *Ty = nullptr;
3640     if (CFP->getType()->isHalfTy())
3641       Ty = Type::getInt16Ty(Ctx);
3642     else if (CFP->getType()->isFloatTy())
3643       Ty = Type::getInt32Ty(Ctx);
3644     else if (CFP->getType()->isDoubleTy())
3645       Ty = Type::getInt64Ty(Ctx);
3646     // Don't handle long double formats, which have strange constraints.
3647     return Ty ? isBytewiseValue(ConstantExpr::getBitCast(CFP, Ty), DL)
3648               : nullptr;
3649   }
3650 
3651   // We can handle constant integers that are multiple of 8 bits.
3652   if (ConstantInt *CI = dyn_cast<ConstantInt>(C)) {
3653     if (CI->getBitWidth() % 8 == 0) {
3654       assert(CI->getBitWidth() > 8 && "8 bits should be handled above!");
3655       if (!CI->getValue().isSplat(8))
3656         return nullptr;
3657       return ConstantInt::get(Ctx, CI->getValue().trunc(8));
3658     }
3659   }
3660 
3661   if (auto *CE = dyn_cast<ConstantExpr>(C)) {
3662     if (CE->getOpcode() == Instruction::IntToPtr) {
3663       auto PS = DL.getPointerSizeInBits(
3664           cast<PointerType>(CE->getType())->getAddressSpace());
3665       return isBytewiseValue(
3666           ConstantExpr::getIntegerCast(CE->getOperand(0),
3667                                        Type::getIntNTy(Ctx, PS), false),
3668           DL);
3669     }
3670   }
3671 
3672   auto Merge = [&](Value *LHS, Value *RHS) -> Value * {
3673     if (LHS == RHS)
3674       return LHS;
3675     if (!LHS || !RHS)
3676       return nullptr;
3677     if (LHS == UndefInt8)
3678       return RHS;
3679     if (RHS == UndefInt8)
3680       return LHS;
3681     return nullptr;
3682   };
3683 
3684   if (ConstantDataSequential *CA = dyn_cast<ConstantDataSequential>(C)) {
3685     Value *Val = UndefInt8;
3686     for (unsigned I = 0, E = CA->getNumElements(); I != E; ++I)
3687       if (!(Val = Merge(Val, isBytewiseValue(CA->getElementAsConstant(I), DL))))
3688         return nullptr;
3689     return Val;
3690   }
3691 
3692   if (isa<ConstantAggregate>(C)) {
3693     Value *Val = UndefInt8;
3694     for (unsigned I = 0, E = C->getNumOperands(); I != E; ++I)
3695       if (!(Val = Merge(Val, isBytewiseValue(C->getOperand(I), DL))))
3696         return nullptr;
3697     return Val;
3698   }
3699 
3700   // Don't try to handle the handful of other constants.
3701   return nullptr;
3702 }
3703 
3704 // This is the recursive version of BuildSubAggregate. It takes a few different
3705 // arguments. Idxs is the index within the nested struct From that we are
3706 // looking at now (which is of type IndexedType). IdxSkip is the number of
3707 // indices from Idxs that should be left out when inserting into the resulting
3708 // struct. To is the result struct built so far, new insertvalue instructions
3709 // build on that.
3710 static Value *BuildSubAggregate(Value *From, Value* To, Type *IndexedType,
3711                                 SmallVectorImpl<unsigned> &Idxs,
3712                                 unsigned IdxSkip,
3713                                 Instruction *InsertBefore) {
3714   StructType *STy = dyn_cast<StructType>(IndexedType);
3715   if (STy) {
3716     // Save the original To argument so we can modify it
3717     Value *OrigTo = To;
3718     // General case, the type indexed by Idxs is a struct
3719     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
3720       // Process each struct element recursively
3721       Idxs.push_back(i);
3722       Value *PrevTo = To;
3723       To = BuildSubAggregate(From, To, STy->getElementType(i), Idxs, IdxSkip,
3724                              InsertBefore);
3725       Idxs.pop_back();
3726       if (!To) {
3727         // Couldn't find any inserted value for this index? Cleanup
3728         while (PrevTo != OrigTo) {
3729           InsertValueInst* Del = cast<InsertValueInst>(PrevTo);
3730           PrevTo = Del->getAggregateOperand();
3731           Del->eraseFromParent();
3732         }
3733         // Stop processing elements
3734         break;
3735       }
3736     }
3737     // If we successfully found a value for each of our subaggregates
3738     if (To)
3739       return To;
3740   }
3741   // Base case, the type indexed by SourceIdxs is not a struct, or not all of
3742   // the struct's elements had a value that was inserted directly. In the latter
3743   // case, perhaps we can't determine each of the subelements individually, but
3744   // we might be able to find the complete struct somewhere.
3745 
3746   // Find the value that is at that particular spot
3747   Value *V = FindInsertedValue(From, Idxs);
3748 
3749   if (!V)
3750     return nullptr;
3751 
3752   // Insert the value in the new (sub) aggregate
3753   return InsertValueInst::Create(To, V, makeArrayRef(Idxs).slice(IdxSkip),
3754                                  "tmp", InsertBefore);
3755 }
3756 
3757 // This helper takes a nested struct and extracts a part of it (which is again a
3758 // struct) into a new value. For example, given the struct:
3759 // { a, { b, { c, d }, e } }
3760 // and the indices "1, 1" this returns
3761 // { c, d }.
3762 //
3763 // It does this by inserting an insertvalue for each element in the resulting
3764 // struct, as opposed to just inserting a single struct. This will only work if
3765 // each of the elements of the substruct are known (ie, inserted into From by an
3766 // insertvalue instruction somewhere).
3767 //
3768 // All inserted insertvalue instructions are inserted before InsertBefore
3769 static Value *BuildSubAggregate(Value *From, ArrayRef<unsigned> idx_range,
3770                                 Instruction *InsertBefore) {
3771   assert(InsertBefore && "Must have someplace to insert!");
3772   Type *IndexedType = ExtractValueInst::getIndexedType(From->getType(),
3773                                                              idx_range);
3774   Value *To = UndefValue::get(IndexedType);
3775   SmallVector<unsigned, 10> Idxs(idx_range.begin(), idx_range.end());
3776   unsigned IdxSkip = Idxs.size();
3777 
3778   return BuildSubAggregate(From, To, IndexedType, Idxs, IdxSkip, InsertBefore);
3779 }
3780 
3781 /// Given an aggregate and a sequence of indices, see if the scalar value
3782 /// indexed is already around as a register, for example if it was inserted
3783 /// directly into the aggregate.
3784 ///
3785 /// If InsertBefore is not null, this function will duplicate (modified)
3786 /// insertvalues when a part of a nested struct is extracted.
3787 Value *llvm::FindInsertedValue(Value *V, ArrayRef<unsigned> idx_range,
3788                                Instruction *InsertBefore) {
3789   // Nothing to index? Just return V then (this is useful at the end of our
3790   // recursion).
3791   if (idx_range.empty())
3792     return V;
3793   // We have indices, so V should have an indexable type.
3794   assert((V->getType()->isStructTy() || V->getType()->isArrayTy()) &&
3795          "Not looking at a struct or array?");
3796   assert(ExtractValueInst::getIndexedType(V->getType(), idx_range) &&
3797          "Invalid indices for type?");
3798 
3799   if (Constant *C = dyn_cast<Constant>(V)) {
3800     C = C->getAggregateElement(idx_range[0]);
3801     if (!C) return nullptr;
3802     return FindInsertedValue(C, idx_range.slice(1), InsertBefore);
3803   }
3804 
3805   if (InsertValueInst *I = dyn_cast<InsertValueInst>(V)) {
3806     // Loop the indices for the insertvalue instruction in parallel with the
3807     // requested indices
3808     const unsigned *req_idx = idx_range.begin();
3809     for (const unsigned *i = I->idx_begin(), *e = I->idx_end();
3810          i != e; ++i, ++req_idx) {
3811       if (req_idx == idx_range.end()) {
3812         // We can't handle this without inserting insertvalues
3813         if (!InsertBefore)
3814           return nullptr;
3815 
3816         // The requested index identifies a part of a nested aggregate. Handle
3817         // this specially. For example,
3818         // %A = insertvalue { i32, {i32, i32 } } undef, i32 10, 1, 0
3819         // %B = insertvalue { i32, {i32, i32 } } %A, i32 11, 1, 1
3820         // %C = extractvalue {i32, { i32, i32 } } %B, 1
3821         // This can be changed into
3822         // %A = insertvalue {i32, i32 } undef, i32 10, 0
3823         // %C = insertvalue {i32, i32 } %A, i32 11, 1
3824         // which allows the unused 0,0 element from the nested struct to be
3825         // removed.
3826         return BuildSubAggregate(V, makeArrayRef(idx_range.begin(), req_idx),
3827                                  InsertBefore);
3828       }
3829 
3830       // This insert value inserts something else than what we are looking for.
3831       // See if the (aggregate) value inserted into has the value we are
3832       // looking for, then.
3833       if (*req_idx != *i)
3834         return FindInsertedValue(I->getAggregateOperand(), idx_range,
3835                                  InsertBefore);
3836     }
3837     // If we end up here, the indices of the insertvalue match with those
3838     // requested (though possibly only partially). Now we recursively look at
3839     // the inserted value, passing any remaining indices.
3840     return FindInsertedValue(I->getInsertedValueOperand(),
3841                              makeArrayRef(req_idx, idx_range.end()),
3842                              InsertBefore);
3843   }
3844 
3845   if (ExtractValueInst *I = dyn_cast<ExtractValueInst>(V)) {
3846     // If we're extracting a value from an aggregate that was extracted from
3847     // something else, we can extract from that something else directly instead.
3848     // However, we will need to chain I's indices with the requested indices.
3849 
3850     // Calculate the number of indices required
3851     unsigned size = I->getNumIndices() + idx_range.size();
3852     // Allocate some space to put the new indices in
3853     SmallVector<unsigned, 5> Idxs;
3854     Idxs.reserve(size);
3855     // Add indices from the extract value instruction
3856     Idxs.append(I->idx_begin(), I->idx_end());
3857 
3858     // Add requested indices
3859     Idxs.append(idx_range.begin(), idx_range.end());
3860 
3861     assert(Idxs.size() == size
3862            && "Number of indices added not correct?");
3863 
3864     return FindInsertedValue(I->getAggregateOperand(), Idxs, InsertBefore);
3865   }
3866   // Otherwise, we don't know (such as, extracting from a function return value
3867   // or load instruction)
3868   return nullptr;
3869 }
3870 
3871 bool llvm::isGEPBasedOnPointerToString(const GEPOperator *GEP,
3872                                        unsigned CharSize) {
3873   // Make sure the GEP has exactly three arguments.
3874   if (GEP->getNumOperands() != 3)
3875     return false;
3876 
3877   // Make sure the index-ee is a pointer to array of \p CharSize integers.
3878   // CharSize.
3879   ArrayType *AT = dyn_cast<ArrayType>(GEP->getSourceElementType());
3880   if (!AT || !AT->getElementType()->isIntegerTy(CharSize))
3881     return false;
3882 
3883   // Check to make sure that the first operand of the GEP is an integer and
3884   // has value 0 so that we are sure we're indexing into the initializer.
3885   const ConstantInt *FirstIdx = dyn_cast<ConstantInt>(GEP->getOperand(1));
3886   if (!FirstIdx || !FirstIdx->isZero())
3887     return false;
3888 
3889   return true;
3890 }
3891 
3892 bool llvm::getConstantDataArrayInfo(const Value *V,
3893                                     ConstantDataArraySlice &Slice,
3894                                     unsigned ElementSize, uint64_t Offset) {
3895   assert(V);
3896 
3897   // Look through bitcast instructions and geps.
3898   V = V->stripPointerCasts();
3899 
3900   // If the value is a GEP instruction or constant expression, treat it as an
3901   // offset.
3902   if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
3903     // The GEP operator should be based on a pointer to string constant, and is
3904     // indexing into the string constant.
3905     if (!isGEPBasedOnPointerToString(GEP, ElementSize))
3906       return false;
3907 
3908     // If the second index isn't a ConstantInt, then this is a variable index
3909     // into the array.  If this occurs, we can't say anything meaningful about
3910     // the string.
3911     uint64_t StartIdx = 0;
3912     if (const ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(2)))
3913       StartIdx = CI->getZExtValue();
3914     else
3915       return false;
3916     return getConstantDataArrayInfo(GEP->getOperand(0), Slice, ElementSize,
3917                                     StartIdx + Offset);
3918   }
3919 
3920   // The GEP instruction, constant or instruction, must reference a global
3921   // variable that is a constant and is initialized. The referenced constant
3922   // initializer is the array that we'll use for optimization.
3923   const GlobalVariable *GV = dyn_cast<GlobalVariable>(V);
3924   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer())
3925     return false;
3926 
3927   const ConstantDataArray *Array;
3928   ArrayType *ArrayTy;
3929   if (GV->getInitializer()->isNullValue()) {
3930     Type *GVTy = GV->getValueType();
3931     if ( (ArrayTy = dyn_cast<ArrayType>(GVTy)) ) {
3932       // A zeroinitializer for the array; there is no ConstantDataArray.
3933       Array = nullptr;
3934     } else {
3935       const DataLayout &DL = GV->getParent()->getDataLayout();
3936       uint64_t SizeInBytes = DL.getTypeStoreSize(GVTy).getFixedSize();
3937       uint64_t Length = SizeInBytes / (ElementSize / 8);
3938       if (Length <= Offset)
3939         return false;
3940 
3941       Slice.Array = nullptr;
3942       Slice.Offset = 0;
3943       Slice.Length = Length - Offset;
3944       return true;
3945     }
3946   } else {
3947     // This must be a ConstantDataArray.
3948     Array = dyn_cast<ConstantDataArray>(GV->getInitializer());
3949     if (!Array)
3950       return false;
3951     ArrayTy = Array->getType();
3952   }
3953   if (!ArrayTy->getElementType()->isIntegerTy(ElementSize))
3954     return false;
3955 
3956   uint64_t NumElts = ArrayTy->getArrayNumElements();
3957   if (Offset > NumElts)
3958     return false;
3959 
3960   Slice.Array = Array;
3961   Slice.Offset = Offset;
3962   Slice.Length = NumElts - Offset;
3963   return true;
3964 }
3965 
3966 /// This function computes the length of a null-terminated C string pointed to
3967 /// by V. If successful, it returns true and returns the string in Str.
3968 /// If unsuccessful, it returns false.
3969 bool llvm::getConstantStringInfo(const Value *V, StringRef &Str,
3970                                  uint64_t Offset, bool TrimAtNul) {
3971   ConstantDataArraySlice Slice;
3972   if (!getConstantDataArrayInfo(V, Slice, 8, Offset))
3973     return false;
3974 
3975   if (Slice.Array == nullptr) {
3976     if (TrimAtNul) {
3977       Str = StringRef();
3978       return true;
3979     }
3980     if (Slice.Length == 1) {
3981       Str = StringRef("", 1);
3982       return true;
3983     }
3984     // We cannot instantiate a StringRef as we do not have an appropriate string
3985     // of 0s at hand.
3986     return false;
3987   }
3988 
3989   // Start out with the entire array in the StringRef.
3990   Str = Slice.Array->getAsString();
3991   // Skip over 'offset' bytes.
3992   Str = Str.substr(Slice.Offset);
3993 
3994   if (TrimAtNul) {
3995     // Trim off the \0 and anything after it.  If the array is not nul
3996     // terminated, we just return the whole end of string.  The client may know
3997     // some other way that the string is length-bound.
3998     Str = Str.substr(0, Str.find('\0'));
3999   }
4000   return true;
4001 }
4002 
4003 // These next two are very similar to the above, but also look through PHI
4004 // nodes.
4005 // TODO: See if we can integrate these two together.
4006 
4007 /// If we can compute the length of the string pointed to by
4008 /// the specified pointer, return 'len+1'.  If we can't, return 0.
4009 static uint64_t GetStringLengthH(const Value *V,
4010                                  SmallPtrSetImpl<const PHINode*> &PHIs,
4011                                  unsigned CharSize) {
4012   // Look through noop bitcast instructions.
4013   V = V->stripPointerCasts();
4014 
4015   // If this is a PHI node, there are two cases: either we have already seen it
4016   // or we haven't.
4017   if (const PHINode *PN = dyn_cast<PHINode>(V)) {
4018     if (!PHIs.insert(PN).second)
4019       return ~0ULL;  // already in the set.
4020 
4021     // If it was new, see if all the input strings are the same length.
4022     uint64_t LenSoFar = ~0ULL;
4023     for (Value *IncValue : PN->incoming_values()) {
4024       uint64_t Len = GetStringLengthH(IncValue, PHIs, CharSize);
4025       if (Len == 0) return 0; // Unknown length -> unknown.
4026 
4027       if (Len == ~0ULL) continue;
4028 
4029       if (Len != LenSoFar && LenSoFar != ~0ULL)
4030         return 0;    // Disagree -> unknown.
4031       LenSoFar = Len;
4032     }
4033 
4034     // Success, all agree.
4035     return LenSoFar;
4036   }
4037 
4038   // strlen(select(c,x,y)) -> strlen(x) ^ strlen(y)
4039   if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
4040     uint64_t Len1 = GetStringLengthH(SI->getTrueValue(), PHIs, CharSize);
4041     if (Len1 == 0) return 0;
4042     uint64_t Len2 = GetStringLengthH(SI->getFalseValue(), PHIs, CharSize);
4043     if (Len2 == 0) return 0;
4044     if (Len1 == ~0ULL) return Len2;
4045     if (Len2 == ~0ULL) return Len1;
4046     if (Len1 != Len2) return 0;
4047     return Len1;
4048   }
4049 
4050   // Otherwise, see if we can read the string.
4051   ConstantDataArraySlice Slice;
4052   if (!getConstantDataArrayInfo(V, Slice, CharSize))
4053     return 0;
4054 
4055   if (Slice.Array == nullptr)
4056     return 1;
4057 
4058   // Search for nul characters
4059   unsigned NullIndex = 0;
4060   for (unsigned E = Slice.Length; NullIndex < E; ++NullIndex) {
4061     if (Slice.Array->getElementAsInteger(Slice.Offset + NullIndex) == 0)
4062       break;
4063   }
4064 
4065   return NullIndex + 1;
4066 }
4067 
4068 /// If we can compute the length of the string pointed to by
4069 /// the specified pointer, return 'len+1'.  If we can't, return 0.
4070 uint64_t llvm::GetStringLength(const Value *V, unsigned CharSize) {
4071   if (!V->getType()->isPointerTy())
4072     return 0;
4073 
4074   SmallPtrSet<const PHINode*, 32> PHIs;
4075   uint64_t Len = GetStringLengthH(V, PHIs, CharSize);
4076   // If Len is ~0ULL, we had an infinite phi cycle: this is dead code, so return
4077   // an empty string as a length.
4078   return Len == ~0ULL ? 1 : Len;
4079 }
4080 
4081 const Value *
4082 llvm::getArgumentAliasingToReturnedPointer(const CallBase *Call,
4083                                            bool MustPreserveNullness) {
4084   assert(Call &&
4085          "getArgumentAliasingToReturnedPointer only works on nonnull calls");
4086   if (const Value *RV = Call->getReturnedArgOperand())
4087     return RV;
4088   // This can be used only as a aliasing property.
4089   if (isIntrinsicReturningPointerAliasingArgumentWithoutCapturing(
4090           Call, MustPreserveNullness))
4091     return Call->getArgOperand(0);
4092   return nullptr;
4093 }
4094 
4095 bool llvm::isIntrinsicReturningPointerAliasingArgumentWithoutCapturing(
4096     const CallBase *Call, bool MustPreserveNullness) {
4097   switch (Call->getIntrinsicID()) {
4098   case Intrinsic::launder_invariant_group:
4099   case Intrinsic::strip_invariant_group:
4100   case Intrinsic::aarch64_irg:
4101   case Intrinsic::aarch64_tagp:
4102     return true;
4103   case Intrinsic::ptrmask:
4104     return !MustPreserveNullness;
4105   default:
4106     return false;
4107   }
4108 }
4109 
4110 /// \p PN defines a loop-variant pointer to an object.  Check if the
4111 /// previous iteration of the loop was referring to the same object as \p PN.
4112 static bool isSameUnderlyingObjectInLoop(const PHINode *PN,
4113                                          const LoopInfo *LI) {
4114   // Find the loop-defined value.
4115   Loop *L = LI->getLoopFor(PN->getParent());
4116   if (PN->getNumIncomingValues() != 2)
4117     return true;
4118 
4119   // Find the value from previous iteration.
4120   auto *PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(0));
4121   if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
4122     PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(1));
4123   if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
4124     return true;
4125 
4126   // If a new pointer is loaded in the loop, the pointer references a different
4127   // object in every iteration.  E.g.:
4128   //    for (i)
4129   //       int *p = a[i];
4130   //       ...
4131   if (auto *Load = dyn_cast<LoadInst>(PrevValue))
4132     if (!L->isLoopInvariant(Load->getPointerOperand()))
4133       return false;
4134   return true;
4135 }
4136 
4137 Value *llvm::GetUnderlyingObject(Value *V, const DataLayout &DL,
4138                                  unsigned MaxLookup) {
4139   if (!V->getType()->isPointerTy())
4140     return V;
4141   for (unsigned Count = 0; MaxLookup == 0 || Count < MaxLookup; ++Count) {
4142     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
4143       V = GEP->getPointerOperand();
4144     } else if (Operator::getOpcode(V) == Instruction::BitCast ||
4145                Operator::getOpcode(V) == Instruction::AddrSpaceCast) {
4146       V = cast<Operator>(V)->getOperand(0);
4147       if (!V->getType()->isPointerTy())
4148         return V;
4149     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
4150       if (GA->isInterposable())
4151         return V;
4152       V = GA->getAliasee();
4153     } else {
4154       if (auto *PHI = dyn_cast<PHINode>(V)) {
4155         // Look through single-arg phi nodes created by LCSSA.
4156         if (PHI->getNumIncomingValues() == 1) {
4157           V = PHI->getIncomingValue(0);
4158           continue;
4159         }
4160       } else if (auto *Call = dyn_cast<CallBase>(V)) {
4161         // CaptureTracking can know about special capturing properties of some
4162         // intrinsics like launder.invariant.group, that can't be expressed with
4163         // the attributes, but have properties like returning aliasing pointer.
4164         // Because some analysis may assume that nocaptured pointer is not
4165         // returned from some special intrinsic (because function would have to
4166         // be marked with returns attribute), it is crucial to use this function
4167         // because it should be in sync with CaptureTracking. Not using it may
4168         // cause weird miscompilations where 2 aliasing pointers are assumed to
4169         // noalias.
4170         if (auto *RP = getArgumentAliasingToReturnedPointer(Call, false)) {
4171           V = RP;
4172           continue;
4173         }
4174       }
4175 
4176       return V;
4177     }
4178     assert(V->getType()->isPointerTy() && "Unexpected operand type!");
4179   }
4180   return V;
4181 }
4182 
4183 void llvm::GetUnderlyingObjects(const Value *V,
4184                                 SmallVectorImpl<const Value *> &Objects,
4185                                 const DataLayout &DL, LoopInfo *LI,
4186                                 unsigned MaxLookup) {
4187   SmallPtrSet<const Value *, 4> Visited;
4188   SmallVector<const Value *, 4> Worklist;
4189   Worklist.push_back(V);
4190   do {
4191     const Value *P = Worklist.pop_back_val();
4192     P = GetUnderlyingObject(P, DL, MaxLookup);
4193 
4194     if (!Visited.insert(P).second)
4195       continue;
4196 
4197     if (auto *SI = dyn_cast<SelectInst>(P)) {
4198       Worklist.push_back(SI->getTrueValue());
4199       Worklist.push_back(SI->getFalseValue());
4200       continue;
4201     }
4202 
4203     if (auto *PN = dyn_cast<PHINode>(P)) {
4204       // If this PHI changes the underlying object in every iteration of the
4205       // loop, don't look through it.  Consider:
4206       //   int **A;
4207       //   for (i) {
4208       //     Prev = Curr;     // Prev = PHI (Prev_0, Curr)
4209       //     Curr = A[i];
4210       //     *Prev, *Curr;
4211       //
4212       // Prev is tracking Curr one iteration behind so they refer to different
4213       // underlying objects.
4214       if (!LI || !LI->isLoopHeader(PN->getParent()) ||
4215           isSameUnderlyingObjectInLoop(PN, LI))
4216         for (Value *IncValue : PN->incoming_values())
4217           Worklist.push_back(IncValue);
4218       continue;
4219     }
4220 
4221     Objects.push_back(P);
4222   } while (!Worklist.empty());
4223 }
4224 
4225 /// This is the function that does the work of looking through basic
4226 /// ptrtoint+arithmetic+inttoptr sequences.
4227 static const Value *getUnderlyingObjectFromInt(const Value *V) {
4228   do {
4229     if (const Operator *U = dyn_cast<Operator>(V)) {
4230       // If we find a ptrtoint, we can transfer control back to the
4231       // regular getUnderlyingObjectFromInt.
4232       if (U->getOpcode() == Instruction::PtrToInt)
4233         return U->getOperand(0);
4234       // If we find an add of a constant, a multiplied value, or a phi, it's
4235       // likely that the other operand will lead us to the base
4236       // object. We don't have to worry about the case where the
4237       // object address is somehow being computed by the multiply,
4238       // because our callers only care when the result is an
4239       // identifiable object.
4240       if (U->getOpcode() != Instruction::Add ||
4241           (!isa<ConstantInt>(U->getOperand(1)) &&
4242            Operator::getOpcode(U->getOperand(1)) != Instruction::Mul &&
4243            !isa<PHINode>(U->getOperand(1))))
4244         return V;
4245       V = U->getOperand(0);
4246     } else {
4247       return V;
4248     }
4249     assert(V->getType()->isIntegerTy() && "Unexpected operand type!");
4250   } while (true);
4251 }
4252 
4253 /// This is a wrapper around GetUnderlyingObjects and adds support for basic
4254 /// ptrtoint+arithmetic+inttoptr sequences.
4255 /// It returns false if unidentified object is found in GetUnderlyingObjects.
4256 bool llvm::getUnderlyingObjectsForCodeGen(const Value *V,
4257                           SmallVectorImpl<Value *> &Objects,
4258                           const DataLayout &DL) {
4259   SmallPtrSet<const Value *, 16> Visited;
4260   SmallVector<const Value *, 4> Working(1, V);
4261   do {
4262     V = Working.pop_back_val();
4263 
4264     SmallVector<const Value *, 4> Objs;
4265     GetUnderlyingObjects(V, Objs, DL);
4266 
4267     for (const Value *V : Objs) {
4268       if (!Visited.insert(V).second)
4269         continue;
4270       if (Operator::getOpcode(V) == Instruction::IntToPtr) {
4271         const Value *O =
4272           getUnderlyingObjectFromInt(cast<User>(V)->getOperand(0));
4273         if (O->getType()->isPointerTy()) {
4274           Working.push_back(O);
4275           continue;
4276         }
4277       }
4278       // If GetUnderlyingObjects fails to find an identifiable object,
4279       // getUnderlyingObjectsForCodeGen also fails for safety.
4280       if (!isIdentifiedObject(V)) {
4281         Objects.clear();
4282         return false;
4283       }
4284       Objects.push_back(const_cast<Value *>(V));
4285     }
4286   } while (!Working.empty());
4287   return true;
4288 }
4289 
4290 /// Return true if the only users of this pointer are lifetime markers.
4291 bool llvm::onlyUsedByLifetimeMarkers(const Value *V) {
4292   for (const User *U : V->users()) {
4293     const IntrinsicInst *II = dyn_cast<IntrinsicInst>(U);
4294     if (!II) return false;
4295 
4296     if (!II->isLifetimeStartOrEnd())
4297       return false;
4298   }
4299   return true;
4300 }
4301 
4302 bool llvm::mustSuppressSpeculation(const LoadInst &LI) {
4303   if (!LI.isUnordered())
4304     return true;
4305   const Function &F = *LI.getFunction();
4306   // Speculative load may create a race that did not exist in the source.
4307   return F.hasFnAttribute(Attribute::SanitizeThread) ||
4308     // Speculative load may load data from dirty regions.
4309     F.hasFnAttribute(Attribute::SanitizeAddress) ||
4310     F.hasFnAttribute(Attribute::SanitizeHWAddress);
4311 }
4312 
4313 
4314 bool llvm::isSafeToSpeculativelyExecute(const Value *V,
4315                                         const Instruction *CtxI,
4316                                         const DominatorTree *DT) {
4317   const Operator *Inst = dyn_cast<Operator>(V);
4318   if (!Inst)
4319     return false;
4320 
4321   for (unsigned i = 0, e = Inst->getNumOperands(); i != e; ++i)
4322     if (Constant *C = dyn_cast<Constant>(Inst->getOperand(i)))
4323       if (C->canTrap())
4324         return false;
4325 
4326   switch (Inst->getOpcode()) {
4327   default:
4328     return true;
4329   case Instruction::UDiv:
4330   case Instruction::URem: {
4331     // x / y is undefined if y == 0.
4332     const APInt *V;
4333     if (match(Inst->getOperand(1), m_APInt(V)))
4334       return *V != 0;
4335     return false;
4336   }
4337   case Instruction::SDiv:
4338   case Instruction::SRem: {
4339     // x / y is undefined if y == 0 or x == INT_MIN and y == -1
4340     const APInt *Numerator, *Denominator;
4341     if (!match(Inst->getOperand(1), m_APInt(Denominator)))
4342       return false;
4343     // We cannot hoist this division if the denominator is 0.
4344     if (*Denominator == 0)
4345       return false;
4346     // It's safe to hoist if the denominator is not 0 or -1.
4347     if (*Denominator != -1)
4348       return true;
4349     // At this point we know that the denominator is -1.  It is safe to hoist as
4350     // long we know that the numerator is not INT_MIN.
4351     if (match(Inst->getOperand(0), m_APInt(Numerator)))
4352       return !Numerator->isMinSignedValue();
4353     // The numerator *might* be MinSignedValue.
4354     return false;
4355   }
4356   case Instruction::Load: {
4357     const LoadInst *LI = cast<LoadInst>(Inst);
4358     if (mustSuppressSpeculation(*LI))
4359       return false;
4360     const DataLayout &DL = LI->getModule()->getDataLayout();
4361     return isDereferenceableAndAlignedPointer(
4362         LI->getPointerOperand(), LI->getType(), MaybeAlign(LI->getAlignment()),
4363         DL, CtxI, DT);
4364   }
4365   case Instruction::Call: {
4366     auto *CI = cast<const CallInst>(Inst);
4367     const Function *Callee = CI->getCalledFunction();
4368 
4369     // The called function could have undefined behavior or side-effects, even
4370     // if marked readnone nounwind.
4371     return Callee && Callee->isSpeculatable();
4372   }
4373   case Instruction::VAArg:
4374   case Instruction::Alloca:
4375   case Instruction::Invoke:
4376   case Instruction::CallBr:
4377   case Instruction::PHI:
4378   case Instruction::Store:
4379   case Instruction::Ret:
4380   case Instruction::Br:
4381   case Instruction::IndirectBr:
4382   case Instruction::Switch:
4383   case Instruction::Unreachable:
4384   case Instruction::Fence:
4385   case Instruction::AtomicRMW:
4386   case Instruction::AtomicCmpXchg:
4387   case Instruction::LandingPad:
4388   case Instruction::Resume:
4389   case Instruction::CatchSwitch:
4390   case Instruction::CatchPad:
4391   case Instruction::CatchRet:
4392   case Instruction::CleanupPad:
4393   case Instruction::CleanupRet:
4394     return false; // Misc instructions which have effects
4395   }
4396 }
4397 
4398 bool llvm::mayBeMemoryDependent(const Instruction &I) {
4399   return I.mayReadOrWriteMemory() || !isSafeToSpeculativelyExecute(&I);
4400 }
4401 
4402 /// Convert ConstantRange OverflowResult into ValueTracking OverflowResult.
4403 static OverflowResult mapOverflowResult(ConstantRange::OverflowResult OR) {
4404   switch (OR) {
4405     case ConstantRange::OverflowResult::MayOverflow:
4406       return OverflowResult::MayOverflow;
4407     case ConstantRange::OverflowResult::AlwaysOverflowsLow:
4408       return OverflowResult::AlwaysOverflowsLow;
4409     case ConstantRange::OverflowResult::AlwaysOverflowsHigh:
4410       return OverflowResult::AlwaysOverflowsHigh;
4411     case ConstantRange::OverflowResult::NeverOverflows:
4412       return OverflowResult::NeverOverflows;
4413   }
4414   llvm_unreachable("Unknown OverflowResult");
4415 }
4416 
4417 /// Combine constant ranges from computeConstantRange() and computeKnownBits().
4418 static ConstantRange computeConstantRangeIncludingKnownBits(
4419     const Value *V, bool ForSigned, const DataLayout &DL, unsigned Depth,
4420     AssumptionCache *AC, const Instruction *CxtI, const DominatorTree *DT,
4421     OptimizationRemarkEmitter *ORE = nullptr, bool UseInstrInfo = true) {
4422   KnownBits Known = computeKnownBits(
4423       V, DL, Depth, AC, CxtI, DT, ORE, UseInstrInfo);
4424   ConstantRange CR1 = ConstantRange::fromKnownBits(Known, ForSigned);
4425   ConstantRange CR2 = computeConstantRange(V, UseInstrInfo);
4426   ConstantRange::PreferredRangeType RangeType =
4427       ForSigned ? ConstantRange::Signed : ConstantRange::Unsigned;
4428   return CR1.intersectWith(CR2, RangeType);
4429 }
4430 
4431 OverflowResult llvm::computeOverflowForUnsignedMul(
4432     const Value *LHS, const Value *RHS, const DataLayout &DL,
4433     AssumptionCache *AC, const Instruction *CxtI, const DominatorTree *DT,
4434     bool UseInstrInfo) {
4435   KnownBits LHSKnown = computeKnownBits(LHS, DL, /*Depth=*/0, AC, CxtI, DT,
4436                                         nullptr, UseInstrInfo);
4437   KnownBits RHSKnown = computeKnownBits(RHS, DL, /*Depth=*/0, AC, CxtI, DT,
4438                                         nullptr, UseInstrInfo);
4439   ConstantRange LHSRange = ConstantRange::fromKnownBits(LHSKnown, false);
4440   ConstantRange RHSRange = ConstantRange::fromKnownBits(RHSKnown, false);
4441   return mapOverflowResult(LHSRange.unsignedMulMayOverflow(RHSRange));
4442 }
4443 
4444 OverflowResult
4445 llvm::computeOverflowForSignedMul(const Value *LHS, const Value *RHS,
4446                                   const DataLayout &DL, AssumptionCache *AC,
4447                                   const Instruction *CxtI,
4448                                   const DominatorTree *DT, bool UseInstrInfo) {
4449   // Multiplying n * m significant bits yields a result of n + m significant
4450   // bits. If the total number of significant bits does not exceed the
4451   // result bit width (minus 1), there is no overflow.
4452   // This means if we have enough leading sign bits in the operands
4453   // we can guarantee that the result does not overflow.
4454   // Ref: "Hacker's Delight" by Henry Warren
4455   unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
4456 
4457   // Note that underestimating the number of sign bits gives a more
4458   // conservative answer.
4459   unsigned SignBits = ComputeNumSignBits(LHS, DL, 0, AC, CxtI, DT) +
4460                       ComputeNumSignBits(RHS, DL, 0, AC, CxtI, DT);
4461 
4462   // First handle the easy case: if we have enough sign bits there's
4463   // definitely no overflow.
4464   if (SignBits > BitWidth + 1)
4465     return OverflowResult::NeverOverflows;
4466 
4467   // There are two ambiguous cases where there can be no overflow:
4468   //   SignBits == BitWidth + 1    and
4469   //   SignBits == BitWidth
4470   // The second case is difficult to check, therefore we only handle the
4471   // first case.
4472   if (SignBits == BitWidth + 1) {
4473     // It overflows only when both arguments are negative and the true
4474     // product is exactly the minimum negative number.
4475     // E.g. mul i16 with 17 sign bits: 0xff00 * 0xff80 = 0x8000
4476     // For simplicity we just check if at least one side is not negative.
4477     KnownBits LHSKnown = computeKnownBits(LHS, DL, /*Depth=*/0, AC, CxtI, DT,
4478                                           nullptr, UseInstrInfo);
4479     KnownBits RHSKnown = computeKnownBits(RHS, DL, /*Depth=*/0, AC, CxtI, DT,
4480                                           nullptr, UseInstrInfo);
4481     if (LHSKnown.isNonNegative() || RHSKnown.isNonNegative())
4482       return OverflowResult::NeverOverflows;
4483   }
4484   return OverflowResult::MayOverflow;
4485 }
4486 
4487 OverflowResult llvm::computeOverflowForUnsignedAdd(
4488     const Value *LHS, const Value *RHS, const DataLayout &DL,
4489     AssumptionCache *AC, const Instruction *CxtI, const DominatorTree *DT,
4490     bool UseInstrInfo) {
4491   ConstantRange LHSRange = computeConstantRangeIncludingKnownBits(
4492       LHS, /*ForSigned=*/false, DL, /*Depth=*/0, AC, CxtI, DT,
4493       nullptr, UseInstrInfo);
4494   ConstantRange RHSRange = computeConstantRangeIncludingKnownBits(
4495       RHS, /*ForSigned=*/false, DL, /*Depth=*/0, AC, CxtI, DT,
4496       nullptr, UseInstrInfo);
4497   return mapOverflowResult(LHSRange.unsignedAddMayOverflow(RHSRange));
4498 }
4499 
4500 static OverflowResult computeOverflowForSignedAdd(const Value *LHS,
4501                                                   const Value *RHS,
4502                                                   const AddOperator *Add,
4503                                                   const DataLayout &DL,
4504                                                   AssumptionCache *AC,
4505                                                   const Instruction *CxtI,
4506                                                   const DominatorTree *DT) {
4507   if (Add && Add->hasNoSignedWrap()) {
4508     return OverflowResult::NeverOverflows;
4509   }
4510 
4511   // If LHS and RHS each have at least two sign bits, the addition will look
4512   // like
4513   //
4514   // XX..... +
4515   // YY.....
4516   //
4517   // If the carry into the most significant position is 0, X and Y can't both
4518   // be 1 and therefore the carry out of the addition is also 0.
4519   //
4520   // If the carry into the most significant position is 1, X and Y can't both
4521   // be 0 and therefore the carry out of the addition is also 1.
4522   //
4523   // Since the carry into the most significant position is always equal to
4524   // the carry out of the addition, there is no signed overflow.
4525   if (ComputeNumSignBits(LHS, DL, 0, AC, CxtI, DT) > 1 &&
4526       ComputeNumSignBits(RHS, DL, 0, AC, CxtI, DT) > 1)
4527     return OverflowResult::NeverOverflows;
4528 
4529   ConstantRange LHSRange = computeConstantRangeIncludingKnownBits(
4530       LHS, /*ForSigned=*/true, DL, /*Depth=*/0, AC, CxtI, DT);
4531   ConstantRange RHSRange = computeConstantRangeIncludingKnownBits(
4532       RHS, /*ForSigned=*/true, DL, /*Depth=*/0, AC, CxtI, DT);
4533   OverflowResult OR =
4534       mapOverflowResult(LHSRange.signedAddMayOverflow(RHSRange));
4535   if (OR != OverflowResult::MayOverflow)
4536     return OR;
4537 
4538   // The remaining code needs Add to be available. Early returns if not so.
4539   if (!Add)
4540     return OverflowResult::MayOverflow;
4541 
4542   // If the sign of Add is the same as at least one of the operands, this add
4543   // CANNOT overflow. If this can be determined from the known bits of the
4544   // operands the above signedAddMayOverflow() check will have already done so.
4545   // The only other way to improve on the known bits is from an assumption, so
4546   // call computeKnownBitsFromAssume() directly.
4547   bool LHSOrRHSKnownNonNegative =
4548       (LHSRange.isAllNonNegative() || RHSRange.isAllNonNegative());
4549   bool LHSOrRHSKnownNegative =
4550       (LHSRange.isAllNegative() || RHSRange.isAllNegative());
4551   if (LHSOrRHSKnownNonNegative || LHSOrRHSKnownNegative) {
4552     KnownBits AddKnown(LHSRange.getBitWidth());
4553     computeKnownBitsFromAssume(
4554         Add, AddKnown, /*Depth=*/0, Query(DL, AC, CxtI, DT, true));
4555     if ((AddKnown.isNonNegative() && LHSOrRHSKnownNonNegative) ||
4556         (AddKnown.isNegative() && LHSOrRHSKnownNegative))
4557       return OverflowResult::NeverOverflows;
4558   }
4559 
4560   return OverflowResult::MayOverflow;
4561 }
4562 
4563 OverflowResult llvm::computeOverflowForUnsignedSub(const Value *LHS,
4564                                                    const Value *RHS,
4565                                                    const DataLayout &DL,
4566                                                    AssumptionCache *AC,
4567                                                    const Instruction *CxtI,
4568                                                    const DominatorTree *DT) {
4569   // Checking for conditions implied by dominating conditions may be expensive.
4570   // Limit it to usub_with_overflow calls for now.
4571   if (match(CxtI,
4572             m_Intrinsic<Intrinsic::usub_with_overflow>(m_Value(), m_Value())))
4573     if (auto C =
4574             isImpliedByDomCondition(CmpInst::ICMP_UGE, LHS, RHS, CxtI, DL)) {
4575       if (*C)
4576         return OverflowResult::NeverOverflows;
4577       return OverflowResult::AlwaysOverflowsLow;
4578     }
4579   ConstantRange LHSRange = computeConstantRangeIncludingKnownBits(
4580       LHS, /*ForSigned=*/false, DL, /*Depth=*/0, AC, CxtI, DT);
4581   ConstantRange RHSRange = computeConstantRangeIncludingKnownBits(
4582       RHS, /*ForSigned=*/false, DL, /*Depth=*/0, AC, CxtI, DT);
4583   return mapOverflowResult(LHSRange.unsignedSubMayOverflow(RHSRange));
4584 }
4585 
4586 OverflowResult llvm::computeOverflowForSignedSub(const Value *LHS,
4587                                                  const Value *RHS,
4588                                                  const DataLayout &DL,
4589                                                  AssumptionCache *AC,
4590                                                  const Instruction *CxtI,
4591                                                  const DominatorTree *DT) {
4592   // If LHS and RHS each have at least two sign bits, the subtraction
4593   // cannot overflow.
4594   if (ComputeNumSignBits(LHS, DL, 0, AC, CxtI, DT) > 1 &&
4595       ComputeNumSignBits(RHS, DL, 0, AC, CxtI, DT) > 1)
4596     return OverflowResult::NeverOverflows;
4597 
4598   ConstantRange LHSRange = computeConstantRangeIncludingKnownBits(
4599       LHS, /*ForSigned=*/true, DL, /*Depth=*/0, AC, CxtI, DT);
4600   ConstantRange RHSRange = computeConstantRangeIncludingKnownBits(
4601       RHS, /*ForSigned=*/true, DL, /*Depth=*/0, AC, CxtI, DT);
4602   return mapOverflowResult(LHSRange.signedSubMayOverflow(RHSRange));
4603 }
4604 
4605 bool llvm::isOverflowIntrinsicNoWrap(const WithOverflowInst *WO,
4606                                      const DominatorTree &DT) {
4607   SmallVector<const BranchInst *, 2> GuardingBranches;
4608   SmallVector<const ExtractValueInst *, 2> Results;
4609 
4610   for (const User *U : WO->users()) {
4611     if (const auto *EVI = dyn_cast<ExtractValueInst>(U)) {
4612       assert(EVI->getNumIndices() == 1 && "Obvious from CI's type");
4613 
4614       if (EVI->getIndices()[0] == 0)
4615         Results.push_back(EVI);
4616       else {
4617         assert(EVI->getIndices()[0] == 1 && "Obvious from CI's type");
4618 
4619         for (const auto *U : EVI->users())
4620           if (const auto *B = dyn_cast<BranchInst>(U)) {
4621             assert(B->isConditional() && "How else is it using an i1?");
4622             GuardingBranches.push_back(B);
4623           }
4624       }
4625     } else {
4626       // We are using the aggregate directly in a way we don't want to analyze
4627       // here (storing it to a global, say).
4628       return false;
4629     }
4630   }
4631 
4632   auto AllUsesGuardedByBranch = [&](const BranchInst *BI) {
4633     BasicBlockEdge NoWrapEdge(BI->getParent(), BI->getSuccessor(1));
4634     if (!NoWrapEdge.isSingleEdge())
4635       return false;
4636 
4637     // Check if all users of the add are provably no-wrap.
4638     for (const auto *Result : Results) {
4639       // If the extractvalue itself is not executed on overflow, the we don't
4640       // need to check each use separately, since domination is transitive.
4641       if (DT.dominates(NoWrapEdge, Result->getParent()))
4642         continue;
4643 
4644       for (auto &RU : Result->uses())
4645         if (!DT.dominates(NoWrapEdge, RU))
4646           return false;
4647     }
4648 
4649     return true;
4650   };
4651 
4652   return llvm::any_of(GuardingBranches, AllUsesGuardedByBranch);
4653 }
4654 
4655 bool llvm::canCreatePoison(const Instruction *I) {
4656   // See whether I has flags that may create poison
4657   if (isa<OverflowingBinaryOperator>(I) &&
4658       (I->hasNoSignedWrap() || I->hasNoUnsignedWrap()))
4659     return true;
4660   if (isa<PossiblyExactOperator>(I) && I->isExact())
4661     return true;
4662   if (auto *FP = dyn_cast<FPMathOperator>(I)) {
4663     auto FMF = FP->getFastMathFlags();
4664     if (FMF.noNaNs() || FMF.noInfs())
4665       return true;
4666   }
4667   if (auto *GEP = dyn_cast<GetElementPtrInst>(I))
4668     if (GEP->isInBounds())
4669       return true;
4670 
4671   unsigned Opcode = I->getOpcode();
4672 
4673   // Check whether opcode is a poison-generating operation
4674   switch (Opcode) {
4675   case Instruction::Shl:
4676   case Instruction::AShr:
4677   case Instruction::LShr: {
4678     // Shifts return poison if shiftwidth is larger than the bitwidth.
4679     if (auto *C = dyn_cast<Constant>(I->getOperand(1))) {
4680       SmallVector<Constant *, 4> ShiftAmounts;
4681       if (auto *FVTy = dyn_cast<FixedVectorType>(C->getType())) {
4682         unsigned NumElts = FVTy->getNumElements();
4683         for (unsigned i = 0; i < NumElts; ++i)
4684           ShiftAmounts.push_back(C->getAggregateElement(i));
4685       } else if (isa<ScalableVectorType>(C->getType()))
4686         return true; // Can't tell, just return true to be safe
4687       else
4688         ShiftAmounts.push_back(C);
4689 
4690       bool Safe = llvm::all_of(ShiftAmounts, [](Constant *C) {
4691         auto *CI = dyn_cast<ConstantInt>(C);
4692         return CI && CI->getZExtValue() < C->getType()->getIntegerBitWidth();
4693       });
4694       return !Safe;
4695     }
4696     return true;
4697   }
4698   case Instruction::FPToSI:
4699   case Instruction::FPToUI:
4700     // fptosi/ui yields poison if the resulting value does not fit in the
4701     // destination type.
4702     return true;
4703   case Instruction::Call:
4704   case Instruction::CallBr:
4705   case Instruction::Invoke:
4706     // Function calls can return a poison value even if args are non-poison
4707     // values.
4708     return true;
4709   case Instruction::InsertElement:
4710   case Instruction::ExtractElement: {
4711     // If index exceeds the length of the vector, it returns poison
4712     auto *VTy = cast<VectorType>(I->getOperand(0)->getType());
4713     unsigned IdxOp = I->getOpcode() == Instruction::InsertElement ? 2 : 1;
4714     auto *Idx = dyn_cast<ConstantInt>(I->getOperand(IdxOp));
4715     if (!Idx || Idx->getZExtValue() >= VTy->getElementCount().Min)
4716       return true;
4717     return false;
4718   }
4719   case Instruction::FNeg:
4720   case Instruction::PHI:
4721   case Instruction::Select:
4722   case Instruction::URem:
4723   case Instruction::SRem:
4724   case Instruction::ShuffleVector:
4725   case Instruction::ExtractValue:
4726   case Instruction::InsertValue:
4727   case Instruction::Freeze:
4728   case Instruction::ICmp:
4729   case Instruction::FCmp:
4730   case Instruction::GetElementPtr:
4731     return false;
4732   default:
4733     if (isa<CastInst>(I))
4734       return false;
4735     else if (isa<BinaryOperator>(I))
4736       return false;
4737     // Be conservative and return true.
4738     return true;
4739   }
4740 }
4741 
4742 bool llvm::isGuaranteedNotToBeUndefOrPoison(const Value *V,
4743                                             const Instruction *CtxI,
4744                                             const DominatorTree *DT,
4745                                             unsigned Depth) {
4746   if (Depth >= MaxDepth)
4747     return false;
4748 
4749   // If the value is a freeze instruction, then it can never
4750   // be undef or poison.
4751   if (isa<FreezeInst>(V))
4752     return true;
4753   // TODO: Some instructions are guaranteed to return neither undef
4754   // nor poison if their arguments are not poison/undef.
4755 
4756   if (auto *C = dyn_cast<Constant>(V)) {
4757     // TODO: We can analyze ConstExpr by opcode to determine if there is any
4758     //       possibility of poison.
4759     if (isa<UndefValue>(C) || isa<ConstantExpr>(C))
4760       return false;
4761 
4762     if (isa<ConstantInt>(C) || isa<GlobalVariable>(C) || isa<ConstantFP>(V) ||
4763         isa<ConstantPointerNull>(C) || isa<Function>(C))
4764       return true;
4765 
4766     if (C->getType()->isVectorTy())
4767       return !C->containsUndefElement() && !C->containsConstantExpression();
4768 
4769     // TODO: Recursively analyze aggregates or other constants.
4770     return false;
4771   }
4772 
4773   // Strip cast operations from a pointer value.
4774   // Note that stripPointerCastsSameRepresentation can strip off getelementptr
4775   // inbounds with zero offset. To guarantee that the result isn't poison, the
4776   // stripped pointer is checked as it has to be pointing into an allocated
4777   // object or be null `null` to ensure `inbounds` getelement pointers with a
4778   // zero offset could not produce poison.
4779   // It can strip off addrspacecast that do not change bit representation as
4780   // well. We believe that such addrspacecast is equivalent to no-op.
4781   auto *StrippedV = V->stripPointerCastsSameRepresentation();
4782   if (isa<AllocaInst>(StrippedV) || isa<GlobalVariable>(StrippedV) ||
4783       isa<Function>(StrippedV) || isa<ConstantPointerNull>(StrippedV))
4784     return true;
4785 
4786   auto OpCheck = [&](const Value *V) {
4787     return isGuaranteedNotToBeUndefOrPoison(V, CtxI, DT, Depth + 1);
4788   };
4789 
4790   if (auto *I = dyn_cast<Instruction>(V)) {
4791     switch (I->getOpcode()) {
4792     case Instruction::GetElementPtr: {
4793       auto *GEPI = dyn_cast<GetElementPtrInst>(I);
4794       if (!GEPI->isInBounds() && llvm::all_of(GEPI->operands(), OpCheck))
4795         return true;
4796       break;
4797     }
4798     case Instruction::FCmp: {
4799       auto *FI = dyn_cast<FCmpInst>(I);
4800       if (FI->getFastMathFlags().none() &&
4801           llvm::all_of(FI->operands(), OpCheck))
4802         return true;
4803       break;
4804     }
4805     case Instruction::BitCast:
4806     case Instruction::PHI:
4807     case Instruction::ICmp:
4808       if (llvm::all_of(I->operands(), OpCheck))
4809         return true;
4810       break;
4811     default:
4812       break;
4813     }
4814 
4815     if (programUndefinedIfPoison(I) && I->getType()->isIntegerTy(1))
4816       // Note: once we have an agreement that poison is a value-wise concept,
4817       // we can remove the isIntegerTy(1) constraint.
4818       return true;
4819   }
4820 
4821   // CxtI may be null or a cloned instruction.
4822   if (!CtxI || !CtxI->getParent() || !DT)
4823     return false;
4824 
4825   auto *DNode = DT->getNode(CtxI->getParent());
4826   if (!DNode)
4827     // Unreachable block
4828     return false;
4829 
4830   // If V is used as a branch condition before reaching CtxI, V cannot be
4831   // undef or poison.
4832   //   br V, BB1, BB2
4833   // BB1:
4834   //   CtxI ; V cannot be undef or poison here
4835   auto *Dominator = DNode->getIDom();
4836   while (Dominator) {
4837     auto *TI = Dominator->getBlock()->getTerminator();
4838 
4839     if (auto BI = dyn_cast<BranchInst>(TI)) {
4840       if (BI->isConditional() && BI->getCondition() == V)
4841         return true;
4842     } else if (auto SI = dyn_cast<SwitchInst>(TI)) {
4843       if (SI->getCondition() == V)
4844         return true;
4845     }
4846 
4847     Dominator = Dominator->getIDom();
4848   }
4849 
4850   return false;
4851 }
4852 
4853 OverflowResult llvm::computeOverflowForSignedAdd(const AddOperator *Add,
4854                                                  const DataLayout &DL,
4855                                                  AssumptionCache *AC,
4856                                                  const Instruction *CxtI,
4857                                                  const DominatorTree *DT) {
4858   return ::computeOverflowForSignedAdd(Add->getOperand(0), Add->getOperand(1),
4859                                        Add, DL, AC, CxtI, DT);
4860 }
4861 
4862 OverflowResult llvm::computeOverflowForSignedAdd(const Value *LHS,
4863                                                  const Value *RHS,
4864                                                  const DataLayout &DL,
4865                                                  AssumptionCache *AC,
4866                                                  const Instruction *CxtI,
4867                                                  const DominatorTree *DT) {
4868   return ::computeOverflowForSignedAdd(LHS, RHS, nullptr, DL, AC, CxtI, DT);
4869 }
4870 
4871 bool llvm::isGuaranteedToTransferExecutionToSuccessor(const Instruction *I) {
4872   // Note: An atomic operation isn't guaranteed to return in a reasonable amount
4873   // of time because it's possible for another thread to interfere with it for an
4874   // arbitrary length of time, but programs aren't allowed to rely on that.
4875 
4876   // If there is no successor, then execution can't transfer to it.
4877   if (const auto *CRI = dyn_cast<CleanupReturnInst>(I))
4878     return !CRI->unwindsToCaller();
4879   if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(I))
4880     return !CatchSwitch->unwindsToCaller();
4881   if (isa<ResumeInst>(I))
4882     return false;
4883   if (isa<ReturnInst>(I))
4884     return false;
4885   if (isa<UnreachableInst>(I))
4886     return false;
4887 
4888   // Calls can throw, or contain an infinite loop, or kill the process.
4889   if (const auto *CB = dyn_cast<CallBase>(I)) {
4890     // Call sites that throw have implicit non-local control flow.
4891     if (!CB->doesNotThrow())
4892       return false;
4893 
4894     // A function which doens't throw and has "willreturn" attribute will
4895     // always return.
4896     if (CB->hasFnAttr(Attribute::WillReturn))
4897       return true;
4898 
4899     // Non-throwing call sites can loop infinitely, call exit/pthread_exit
4900     // etc. and thus not return.  However, LLVM already assumes that
4901     //
4902     //  - Thread exiting actions are modeled as writes to memory invisible to
4903     //    the program.
4904     //
4905     //  - Loops that don't have side effects (side effects are volatile/atomic
4906     //    stores and IO) always terminate (see http://llvm.org/PR965).
4907     //    Furthermore IO itself is also modeled as writes to memory invisible to
4908     //    the program.
4909     //
4910     // We rely on those assumptions here, and use the memory effects of the call
4911     // target as a proxy for checking that it always returns.
4912 
4913     // FIXME: This isn't aggressive enough; a call which only writes to a global
4914     // is guaranteed to return.
4915     return CB->onlyReadsMemory() || CB->onlyAccessesArgMemory();
4916   }
4917 
4918   // Other instructions return normally.
4919   return true;
4920 }
4921 
4922 bool llvm::isGuaranteedToTransferExecutionToSuccessor(const BasicBlock *BB) {
4923   // TODO: This is slightly conservative for invoke instruction since exiting
4924   // via an exception *is* normal control for them.
4925   for (auto I = BB->begin(), E = BB->end(); I != E; ++I)
4926     if (!isGuaranteedToTransferExecutionToSuccessor(&*I))
4927       return false;
4928   return true;
4929 }
4930 
4931 bool llvm::isGuaranteedToExecuteForEveryIteration(const Instruction *I,
4932                                                   const Loop *L) {
4933   // The loop header is guaranteed to be executed for every iteration.
4934   //
4935   // FIXME: Relax this constraint to cover all basic blocks that are
4936   // guaranteed to be executed at every iteration.
4937   if (I->getParent() != L->getHeader()) return false;
4938 
4939   for (const Instruction &LI : *L->getHeader()) {
4940     if (&LI == I) return true;
4941     if (!isGuaranteedToTransferExecutionToSuccessor(&LI)) return false;
4942   }
4943   llvm_unreachable("Instruction not contained in its own parent basic block.");
4944 }
4945 
4946 bool llvm::propagatesPoison(const Instruction *I) {
4947   switch (I->getOpcode()) {
4948   case Instruction::Freeze:
4949   case Instruction::Select:
4950   case Instruction::PHI:
4951   case Instruction::Call:
4952   case Instruction::Invoke:
4953     return false;
4954   case Instruction::ICmp:
4955   case Instruction::FCmp:
4956   case Instruction::GetElementPtr:
4957     return true;
4958   default:
4959     if (isa<BinaryOperator>(I) || isa<UnaryOperator>(I) || isa<CastInst>(I))
4960       return true;
4961 
4962     // Be conservative and return false.
4963     return false;
4964   }
4965 }
4966 
4967 const Value *llvm::getGuaranteedNonPoisonOp(const Instruction *I) {
4968   switch (I->getOpcode()) {
4969     case Instruction::Store:
4970       return cast<StoreInst>(I)->getPointerOperand();
4971 
4972     case Instruction::Load:
4973       return cast<LoadInst>(I)->getPointerOperand();
4974 
4975     case Instruction::AtomicCmpXchg:
4976       return cast<AtomicCmpXchgInst>(I)->getPointerOperand();
4977 
4978     case Instruction::AtomicRMW:
4979       return cast<AtomicRMWInst>(I)->getPointerOperand();
4980 
4981     case Instruction::UDiv:
4982     case Instruction::SDiv:
4983     case Instruction::URem:
4984     case Instruction::SRem:
4985       return I->getOperand(1);
4986 
4987     case Instruction::Call:
4988       if (auto *II = dyn_cast<IntrinsicInst>(I)) {
4989         switch (II->getIntrinsicID()) {
4990         case Intrinsic::assume:
4991           return II->getArgOperand(0);
4992         default:
4993           return nullptr;
4994         }
4995       }
4996       return nullptr;
4997 
4998     default:
4999       return nullptr;
5000   }
5001 }
5002 
5003 bool llvm::mustTriggerUB(const Instruction *I,
5004                          const SmallSet<const Value *, 16>& KnownPoison) {
5005   auto *NotPoison = getGuaranteedNonPoisonOp(I);
5006   return (NotPoison && KnownPoison.count(NotPoison));
5007 }
5008 
5009 
5010 bool llvm::programUndefinedIfPoison(const Instruction *PoisonI) {
5011   // We currently only look for uses of poison values within the same basic
5012   // block, as that makes it easier to guarantee that the uses will be
5013   // executed given that PoisonI is executed.
5014   //
5015   // FIXME: Expand this to consider uses beyond the same basic block. To do
5016   // this, look out for the distinction between post-dominance and strong
5017   // post-dominance.
5018   const BasicBlock *BB = PoisonI->getParent();
5019 
5020   // Set of instructions that we have proved will yield poison if PoisonI
5021   // does.
5022   SmallSet<const Value *, 16> YieldsPoison;
5023   SmallSet<const BasicBlock *, 4> Visited;
5024   YieldsPoison.insert(PoisonI);
5025   Visited.insert(PoisonI->getParent());
5026 
5027   BasicBlock::const_iterator Begin = PoisonI->getIterator(), End = BB->end();
5028 
5029   unsigned Iter = 0;
5030   while (Iter++ < MaxDepth) {
5031     for (auto &I : make_range(Begin, End)) {
5032       if (&I != PoisonI) {
5033         if (mustTriggerUB(&I, YieldsPoison))
5034           return true;
5035         if (!isGuaranteedToTransferExecutionToSuccessor(&I))
5036           return false;
5037       }
5038 
5039       // Mark poison that propagates from I through uses of I.
5040       if (YieldsPoison.count(&I)) {
5041         for (const User *User : I.users()) {
5042           const Instruction *UserI = cast<Instruction>(User);
5043           if (propagatesPoison(UserI))
5044             YieldsPoison.insert(User);
5045         }
5046       }
5047     }
5048 
5049     if (auto *NextBB = BB->getSingleSuccessor()) {
5050       if (Visited.insert(NextBB).second) {
5051         BB = NextBB;
5052         Begin = BB->getFirstNonPHI()->getIterator();
5053         End = BB->end();
5054         continue;
5055       }
5056     }
5057 
5058     break;
5059   }
5060   return false;
5061 }
5062 
5063 static bool isKnownNonNaN(const Value *V, FastMathFlags FMF) {
5064   if (FMF.noNaNs())
5065     return true;
5066 
5067   if (auto *C = dyn_cast<ConstantFP>(V))
5068     return !C->isNaN();
5069 
5070   if (auto *C = dyn_cast<ConstantDataVector>(V)) {
5071     if (!C->getElementType()->isFloatingPointTy())
5072       return false;
5073     for (unsigned I = 0, E = C->getNumElements(); I < E; ++I) {
5074       if (C->getElementAsAPFloat(I).isNaN())
5075         return false;
5076     }
5077     return true;
5078   }
5079 
5080   if (isa<ConstantAggregateZero>(V))
5081     return true;
5082 
5083   return false;
5084 }
5085 
5086 static bool isKnownNonZero(const Value *V) {
5087   if (auto *C = dyn_cast<ConstantFP>(V))
5088     return !C->isZero();
5089 
5090   if (auto *C = dyn_cast<ConstantDataVector>(V)) {
5091     if (!C->getElementType()->isFloatingPointTy())
5092       return false;
5093     for (unsigned I = 0, E = C->getNumElements(); I < E; ++I) {
5094       if (C->getElementAsAPFloat(I).isZero())
5095         return false;
5096     }
5097     return true;
5098   }
5099 
5100   return false;
5101 }
5102 
5103 /// Match clamp pattern for float types without care about NaNs or signed zeros.
5104 /// Given non-min/max outer cmp/select from the clamp pattern this
5105 /// function recognizes if it can be substitued by a "canonical" min/max
5106 /// pattern.
5107 static SelectPatternResult matchFastFloatClamp(CmpInst::Predicate Pred,
5108                                                Value *CmpLHS, Value *CmpRHS,
5109                                                Value *TrueVal, Value *FalseVal,
5110                                                Value *&LHS, Value *&RHS) {
5111   // Try to match
5112   //   X < C1 ? C1 : Min(X, C2) --> Max(C1, Min(X, C2))
5113   //   X > C1 ? C1 : Max(X, C2) --> Min(C1, Max(X, C2))
5114   // and return description of the outer Max/Min.
5115 
5116   // First, check if select has inverse order:
5117   if (CmpRHS == FalseVal) {
5118     std::swap(TrueVal, FalseVal);
5119     Pred = CmpInst::getInversePredicate(Pred);
5120   }
5121 
5122   // Assume success now. If there's no match, callers should not use these anyway.
5123   LHS = TrueVal;
5124   RHS = FalseVal;
5125 
5126   const APFloat *FC1;
5127   if (CmpRHS != TrueVal || !match(CmpRHS, m_APFloat(FC1)) || !FC1->isFinite())
5128     return {SPF_UNKNOWN, SPNB_NA, false};
5129 
5130   const APFloat *FC2;
5131   switch (Pred) {
5132   case CmpInst::FCMP_OLT:
5133   case CmpInst::FCMP_OLE:
5134   case CmpInst::FCMP_ULT:
5135   case CmpInst::FCMP_ULE:
5136     if (match(FalseVal,
5137               m_CombineOr(m_OrdFMin(m_Specific(CmpLHS), m_APFloat(FC2)),
5138                           m_UnordFMin(m_Specific(CmpLHS), m_APFloat(FC2)))) &&
5139         *FC1 < *FC2)
5140       return {SPF_FMAXNUM, SPNB_RETURNS_ANY, false};
5141     break;
5142   case CmpInst::FCMP_OGT:
5143   case CmpInst::FCMP_OGE:
5144   case CmpInst::FCMP_UGT:
5145   case CmpInst::FCMP_UGE:
5146     if (match(FalseVal,
5147               m_CombineOr(m_OrdFMax(m_Specific(CmpLHS), m_APFloat(FC2)),
5148                           m_UnordFMax(m_Specific(CmpLHS), m_APFloat(FC2)))) &&
5149         *FC1 > *FC2)
5150       return {SPF_FMINNUM, SPNB_RETURNS_ANY, false};
5151     break;
5152   default:
5153     break;
5154   }
5155 
5156   return {SPF_UNKNOWN, SPNB_NA, false};
5157 }
5158 
5159 /// Recognize variations of:
5160 ///   CLAMP(v,l,h) ==> ((v) < (l) ? (l) : ((v) > (h) ? (h) : (v)))
5161 static SelectPatternResult matchClamp(CmpInst::Predicate Pred,
5162                                       Value *CmpLHS, Value *CmpRHS,
5163                                       Value *TrueVal, Value *FalseVal) {
5164   // Swap the select operands and predicate to match the patterns below.
5165   if (CmpRHS != TrueVal) {
5166     Pred = ICmpInst::getSwappedPredicate(Pred);
5167     std::swap(TrueVal, FalseVal);
5168   }
5169   const APInt *C1;
5170   if (CmpRHS == TrueVal && match(CmpRHS, m_APInt(C1))) {
5171     const APInt *C2;
5172     // (X <s C1) ? C1 : SMIN(X, C2) ==> SMAX(SMIN(X, C2), C1)
5173     if (match(FalseVal, m_SMin(m_Specific(CmpLHS), m_APInt(C2))) &&
5174         C1->slt(*C2) && Pred == CmpInst::ICMP_SLT)
5175       return {SPF_SMAX, SPNB_NA, false};
5176 
5177     // (X >s C1) ? C1 : SMAX(X, C2) ==> SMIN(SMAX(X, C2), C1)
5178     if (match(FalseVal, m_SMax(m_Specific(CmpLHS), m_APInt(C2))) &&
5179         C1->sgt(*C2) && Pred == CmpInst::ICMP_SGT)
5180       return {SPF_SMIN, SPNB_NA, false};
5181 
5182     // (X <u C1) ? C1 : UMIN(X, C2) ==> UMAX(UMIN(X, C2), C1)
5183     if (match(FalseVal, m_UMin(m_Specific(CmpLHS), m_APInt(C2))) &&
5184         C1->ult(*C2) && Pred == CmpInst::ICMP_ULT)
5185       return {SPF_UMAX, SPNB_NA, false};
5186 
5187     // (X >u C1) ? C1 : UMAX(X, C2) ==> UMIN(UMAX(X, C2), C1)
5188     if (match(FalseVal, m_UMax(m_Specific(CmpLHS), m_APInt(C2))) &&
5189         C1->ugt(*C2) && Pred == CmpInst::ICMP_UGT)
5190       return {SPF_UMIN, SPNB_NA, false};
5191   }
5192   return {SPF_UNKNOWN, SPNB_NA, false};
5193 }
5194 
5195 /// Recognize variations of:
5196 ///   a < c ? min(a,b) : min(b,c) ==> min(min(a,b),min(b,c))
5197 static SelectPatternResult matchMinMaxOfMinMax(CmpInst::Predicate Pred,
5198                                                Value *CmpLHS, Value *CmpRHS,
5199                                                Value *TVal, Value *FVal,
5200                                                unsigned Depth) {
5201   // TODO: Allow FP min/max with nnan/nsz.
5202   assert(CmpInst::isIntPredicate(Pred) && "Expected integer comparison");
5203 
5204   Value *A = nullptr, *B = nullptr;
5205   SelectPatternResult L = matchSelectPattern(TVal, A, B, nullptr, Depth + 1);
5206   if (!SelectPatternResult::isMinOrMax(L.Flavor))
5207     return {SPF_UNKNOWN, SPNB_NA, false};
5208 
5209   Value *C = nullptr, *D = nullptr;
5210   SelectPatternResult R = matchSelectPattern(FVal, C, D, nullptr, Depth + 1);
5211   if (L.Flavor != R.Flavor)
5212     return {SPF_UNKNOWN, SPNB_NA, false};
5213 
5214   // We have something like: x Pred y ? min(a, b) : min(c, d).
5215   // Try to match the compare to the min/max operations of the select operands.
5216   // First, make sure we have the right compare predicate.
5217   switch (L.Flavor) {
5218   case SPF_SMIN:
5219     if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE) {
5220       Pred = ICmpInst::getSwappedPredicate(Pred);
5221       std::swap(CmpLHS, CmpRHS);
5222     }
5223     if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
5224       break;
5225     return {SPF_UNKNOWN, SPNB_NA, false};
5226   case SPF_SMAX:
5227     if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE) {
5228       Pred = ICmpInst::getSwappedPredicate(Pred);
5229       std::swap(CmpLHS, CmpRHS);
5230     }
5231     if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
5232       break;
5233     return {SPF_UNKNOWN, SPNB_NA, false};
5234   case SPF_UMIN:
5235     if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE) {
5236       Pred = ICmpInst::getSwappedPredicate(Pred);
5237       std::swap(CmpLHS, CmpRHS);
5238     }
5239     if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE)
5240       break;
5241     return {SPF_UNKNOWN, SPNB_NA, false};
5242   case SPF_UMAX:
5243     if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
5244       Pred = ICmpInst::getSwappedPredicate(Pred);
5245       std::swap(CmpLHS, CmpRHS);
5246     }
5247     if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
5248       break;
5249     return {SPF_UNKNOWN, SPNB_NA, false};
5250   default:
5251     return {SPF_UNKNOWN, SPNB_NA, false};
5252   }
5253 
5254   // If there is a common operand in the already matched min/max and the other
5255   // min/max operands match the compare operands (either directly or inverted),
5256   // then this is min/max of the same flavor.
5257 
5258   // a pred c ? m(a, b) : m(c, b) --> m(m(a, b), m(c, b))
5259   // ~c pred ~a ? m(a, b) : m(c, b) --> m(m(a, b), m(c, b))
5260   if (D == B) {
5261     if ((CmpLHS == A && CmpRHS == C) || (match(C, m_Not(m_Specific(CmpLHS))) &&
5262                                          match(A, m_Not(m_Specific(CmpRHS)))))
5263       return {L.Flavor, SPNB_NA, false};
5264   }
5265   // a pred d ? m(a, b) : m(b, d) --> m(m(a, b), m(b, d))
5266   // ~d pred ~a ? m(a, b) : m(b, d) --> m(m(a, b), m(b, d))
5267   if (C == B) {
5268     if ((CmpLHS == A && CmpRHS == D) || (match(D, m_Not(m_Specific(CmpLHS))) &&
5269                                          match(A, m_Not(m_Specific(CmpRHS)))))
5270       return {L.Flavor, SPNB_NA, false};
5271   }
5272   // b pred c ? m(a, b) : m(c, a) --> m(m(a, b), m(c, a))
5273   // ~c pred ~b ? m(a, b) : m(c, a) --> m(m(a, b), m(c, a))
5274   if (D == A) {
5275     if ((CmpLHS == B && CmpRHS == C) || (match(C, m_Not(m_Specific(CmpLHS))) &&
5276                                          match(B, m_Not(m_Specific(CmpRHS)))))
5277       return {L.Flavor, SPNB_NA, false};
5278   }
5279   // b pred d ? m(a, b) : m(a, d) --> m(m(a, b), m(a, d))
5280   // ~d pred ~b ? m(a, b) : m(a, d) --> m(m(a, b), m(a, d))
5281   if (C == A) {
5282     if ((CmpLHS == B && CmpRHS == D) || (match(D, m_Not(m_Specific(CmpLHS))) &&
5283                                          match(B, m_Not(m_Specific(CmpRHS)))))
5284       return {L.Flavor, SPNB_NA, false};
5285   }
5286 
5287   return {SPF_UNKNOWN, SPNB_NA, false};
5288 }
5289 
5290 /// If the input value is the result of a 'not' op, constant integer, or vector
5291 /// splat of a constant integer, return the bitwise-not source value.
5292 /// TODO: This could be extended to handle non-splat vector integer constants.
5293 static Value *getNotValue(Value *V) {
5294   Value *NotV;
5295   if (match(V, m_Not(m_Value(NotV))))
5296     return NotV;
5297 
5298   const APInt *C;
5299   if (match(V, m_APInt(C)))
5300     return ConstantInt::get(V->getType(), ~(*C));
5301 
5302   return nullptr;
5303 }
5304 
5305 /// Match non-obvious integer minimum and maximum sequences.
5306 static SelectPatternResult matchMinMax(CmpInst::Predicate Pred,
5307                                        Value *CmpLHS, Value *CmpRHS,
5308                                        Value *TrueVal, Value *FalseVal,
5309                                        Value *&LHS, Value *&RHS,
5310                                        unsigned Depth) {
5311   // Assume success. If there's no match, callers should not use these anyway.
5312   LHS = TrueVal;
5313   RHS = FalseVal;
5314 
5315   SelectPatternResult SPR = matchClamp(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal);
5316   if (SPR.Flavor != SelectPatternFlavor::SPF_UNKNOWN)
5317     return SPR;
5318 
5319   SPR = matchMinMaxOfMinMax(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, Depth);
5320   if (SPR.Flavor != SelectPatternFlavor::SPF_UNKNOWN)
5321     return SPR;
5322 
5323   // Look through 'not' ops to find disguised min/max.
5324   // (X > Y) ? ~X : ~Y ==> (~X < ~Y) ? ~X : ~Y ==> MIN(~X, ~Y)
5325   // (X < Y) ? ~X : ~Y ==> (~X > ~Y) ? ~X : ~Y ==> MAX(~X, ~Y)
5326   if (CmpLHS == getNotValue(TrueVal) && CmpRHS == getNotValue(FalseVal)) {
5327     switch (Pred) {
5328     case CmpInst::ICMP_SGT: return {SPF_SMIN, SPNB_NA, false};
5329     case CmpInst::ICMP_SLT: return {SPF_SMAX, SPNB_NA, false};
5330     case CmpInst::ICMP_UGT: return {SPF_UMIN, SPNB_NA, false};
5331     case CmpInst::ICMP_ULT: return {SPF_UMAX, SPNB_NA, false};
5332     default: break;
5333     }
5334   }
5335 
5336   // (X > Y) ? ~Y : ~X ==> (~X < ~Y) ? ~Y : ~X ==> MAX(~Y, ~X)
5337   // (X < Y) ? ~Y : ~X ==> (~X > ~Y) ? ~Y : ~X ==> MIN(~Y, ~X)
5338   if (CmpLHS == getNotValue(FalseVal) && CmpRHS == getNotValue(TrueVal)) {
5339     switch (Pred) {
5340     case CmpInst::ICMP_SGT: return {SPF_SMAX, SPNB_NA, false};
5341     case CmpInst::ICMP_SLT: return {SPF_SMIN, SPNB_NA, false};
5342     case CmpInst::ICMP_UGT: return {SPF_UMAX, SPNB_NA, false};
5343     case CmpInst::ICMP_ULT: return {SPF_UMIN, SPNB_NA, false};
5344     default: break;
5345     }
5346   }
5347 
5348   if (Pred != CmpInst::ICMP_SGT && Pred != CmpInst::ICMP_SLT)
5349     return {SPF_UNKNOWN, SPNB_NA, false};
5350 
5351   // Z = X -nsw Y
5352   // (X >s Y) ? 0 : Z ==> (Z >s 0) ? 0 : Z ==> SMIN(Z, 0)
5353   // (X <s Y) ? 0 : Z ==> (Z <s 0) ? 0 : Z ==> SMAX(Z, 0)
5354   if (match(TrueVal, m_Zero()) &&
5355       match(FalseVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS))))
5356     return {Pred == CmpInst::ICMP_SGT ? SPF_SMIN : SPF_SMAX, SPNB_NA, false};
5357 
5358   // Z = X -nsw Y
5359   // (X >s Y) ? Z : 0 ==> (Z >s 0) ? Z : 0 ==> SMAX(Z, 0)
5360   // (X <s Y) ? Z : 0 ==> (Z <s 0) ? Z : 0 ==> SMIN(Z, 0)
5361   if (match(FalseVal, m_Zero()) &&
5362       match(TrueVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS))))
5363     return {Pred == CmpInst::ICMP_SGT ? SPF_SMAX : SPF_SMIN, SPNB_NA, false};
5364 
5365   const APInt *C1;
5366   if (!match(CmpRHS, m_APInt(C1)))
5367     return {SPF_UNKNOWN, SPNB_NA, false};
5368 
5369   // An unsigned min/max can be written with a signed compare.
5370   const APInt *C2;
5371   if ((CmpLHS == TrueVal && match(FalseVal, m_APInt(C2))) ||
5372       (CmpLHS == FalseVal && match(TrueVal, m_APInt(C2)))) {
5373     // Is the sign bit set?
5374     // (X <s 0) ? X : MAXVAL ==> (X >u MAXVAL) ? X : MAXVAL ==> UMAX
5375     // (X <s 0) ? MAXVAL : X ==> (X >u MAXVAL) ? MAXVAL : X ==> UMIN
5376     if (Pred == CmpInst::ICMP_SLT && C1->isNullValue() &&
5377         C2->isMaxSignedValue())
5378       return {CmpLHS == TrueVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
5379 
5380     // Is the sign bit clear?
5381     // (X >s -1) ? MINVAL : X ==> (X <u MINVAL) ? MINVAL : X ==> UMAX
5382     // (X >s -1) ? X : MINVAL ==> (X <u MINVAL) ? X : MINVAL ==> UMIN
5383     if (Pred == CmpInst::ICMP_SGT && C1->isAllOnesValue() &&
5384         C2->isMinSignedValue())
5385       return {CmpLHS == FalseVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
5386   }
5387 
5388   return {SPF_UNKNOWN, SPNB_NA, false};
5389 }
5390 
5391 bool llvm::isKnownNegation(const Value *X, const Value *Y, bool NeedNSW) {
5392   assert(X && Y && "Invalid operand");
5393 
5394   // X = sub (0, Y) || X = sub nsw (0, Y)
5395   if ((!NeedNSW && match(X, m_Sub(m_ZeroInt(), m_Specific(Y)))) ||
5396       (NeedNSW && match(X, m_NSWSub(m_ZeroInt(), m_Specific(Y)))))
5397     return true;
5398 
5399   // Y = sub (0, X) || Y = sub nsw (0, X)
5400   if ((!NeedNSW && match(Y, m_Sub(m_ZeroInt(), m_Specific(X)))) ||
5401       (NeedNSW && match(Y, m_NSWSub(m_ZeroInt(), m_Specific(X)))))
5402     return true;
5403 
5404   // X = sub (A, B), Y = sub (B, A) || X = sub nsw (A, B), Y = sub nsw (B, A)
5405   Value *A, *B;
5406   return (!NeedNSW && (match(X, m_Sub(m_Value(A), m_Value(B))) &&
5407                         match(Y, m_Sub(m_Specific(B), m_Specific(A))))) ||
5408          (NeedNSW && (match(X, m_NSWSub(m_Value(A), m_Value(B))) &&
5409                        match(Y, m_NSWSub(m_Specific(B), m_Specific(A)))));
5410 }
5411 
5412 static SelectPatternResult matchSelectPattern(CmpInst::Predicate Pred,
5413                                               FastMathFlags FMF,
5414                                               Value *CmpLHS, Value *CmpRHS,
5415                                               Value *TrueVal, Value *FalseVal,
5416                                               Value *&LHS, Value *&RHS,
5417                                               unsigned Depth) {
5418   if (CmpInst::isFPPredicate(Pred)) {
5419     // IEEE-754 ignores the sign of 0.0 in comparisons. So if the select has one
5420     // 0.0 operand, set the compare's 0.0 operands to that same value for the
5421     // purpose of identifying min/max. Disregard vector constants with undefined
5422     // elements because those can not be back-propagated for analysis.
5423     Value *OutputZeroVal = nullptr;
5424     if (match(TrueVal, m_AnyZeroFP()) && !match(FalseVal, m_AnyZeroFP()) &&
5425         !cast<Constant>(TrueVal)->containsUndefElement())
5426       OutputZeroVal = TrueVal;
5427     else if (match(FalseVal, m_AnyZeroFP()) && !match(TrueVal, m_AnyZeroFP()) &&
5428              !cast<Constant>(FalseVal)->containsUndefElement())
5429       OutputZeroVal = FalseVal;
5430 
5431     if (OutputZeroVal) {
5432       if (match(CmpLHS, m_AnyZeroFP()))
5433         CmpLHS = OutputZeroVal;
5434       if (match(CmpRHS, m_AnyZeroFP()))
5435         CmpRHS = OutputZeroVal;
5436     }
5437   }
5438 
5439   LHS = CmpLHS;
5440   RHS = CmpRHS;
5441 
5442   // Signed zero may return inconsistent results between implementations.
5443   //  (0.0 <= -0.0) ? 0.0 : -0.0 // Returns 0.0
5444   //  minNum(0.0, -0.0)          // May return -0.0 or 0.0 (IEEE 754-2008 5.3.1)
5445   // Therefore, we behave conservatively and only proceed if at least one of the
5446   // operands is known to not be zero or if we don't care about signed zero.
5447   switch (Pred) {
5448   default: break;
5449   // FIXME: Include OGT/OLT/UGT/ULT.
5450   case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLE:
5451   case CmpInst::FCMP_UGE: case CmpInst::FCMP_ULE:
5452     if (!FMF.noSignedZeros() && !isKnownNonZero(CmpLHS) &&
5453         !isKnownNonZero(CmpRHS))
5454       return {SPF_UNKNOWN, SPNB_NA, false};
5455   }
5456 
5457   SelectPatternNaNBehavior NaNBehavior = SPNB_NA;
5458   bool Ordered = false;
5459 
5460   // When given one NaN and one non-NaN input:
5461   //   - maxnum/minnum (C99 fmaxf()/fminf()) return the non-NaN input.
5462   //   - A simple C99 (a < b ? a : b) construction will return 'b' (as the
5463   //     ordered comparison fails), which could be NaN or non-NaN.
5464   // so here we discover exactly what NaN behavior is required/accepted.
5465   if (CmpInst::isFPPredicate(Pred)) {
5466     bool LHSSafe = isKnownNonNaN(CmpLHS, FMF);
5467     bool RHSSafe = isKnownNonNaN(CmpRHS, FMF);
5468 
5469     if (LHSSafe && RHSSafe) {
5470       // Both operands are known non-NaN.
5471       NaNBehavior = SPNB_RETURNS_ANY;
5472     } else if (CmpInst::isOrdered(Pred)) {
5473       // An ordered comparison will return false when given a NaN, so it
5474       // returns the RHS.
5475       Ordered = true;
5476       if (LHSSafe)
5477         // LHS is non-NaN, so if RHS is NaN then NaN will be returned.
5478         NaNBehavior = SPNB_RETURNS_NAN;
5479       else if (RHSSafe)
5480         NaNBehavior = SPNB_RETURNS_OTHER;
5481       else
5482         // Completely unsafe.
5483         return {SPF_UNKNOWN, SPNB_NA, false};
5484     } else {
5485       Ordered = false;
5486       // An unordered comparison will return true when given a NaN, so it
5487       // returns the LHS.
5488       if (LHSSafe)
5489         // LHS is non-NaN, so if RHS is NaN then non-NaN will be returned.
5490         NaNBehavior = SPNB_RETURNS_OTHER;
5491       else if (RHSSafe)
5492         NaNBehavior = SPNB_RETURNS_NAN;
5493       else
5494         // Completely unsafe.
5495         return {SPF_UNKNOWN, SPNB_NA, false};
5496     }
5497   }
5498 
5499   if (TrueVal == CmpRHS && FalseVal == CmpLHS) {
5500     std::swap(CmpLHS, CmpRHS);
5501     Pred = CmpInst::getSwappedPredicate(Pred);
5502     if (NaNBehavior == SPNB_RETURNS_NAN)
5503       NaNBehavior = SPNB_RETURNS_OTHER;
5504     else if (NaNBehavior == SPNB_RETURNS_OTHER)
5505       NaNBehavior = SPNB_RETURNS_NAN;
5506     Ordered = !Ordered;
5507   }
5508 
5509   // ([if]cmp X, Y) ? X : Y
5510   if (TrueVal == CmpLHS && FalseVal == CmpRHS) {
5511     switch (Pred) {
5512     default: return {SPF_UNKNOWN, SPNB_NA, false}; // Equality.
5513     case ICmpInst::ICMP_UGT:
5514     case ICmpInst::ICMP_UGE: return {SPF_UMAX, SPNB_NA, false};
5515     case ICmpInst::ICMP_SGT:
5516     case ICmpInst::ICMP_SGE: return {SPF_SMAX, SPNB_NA, false};
5517     case ICmpInst::ICMP_ULT:
5518     case ICmpInst::ICMP_ULE: return {SPF_UMIN, SPNB_NA, false};
5519     case ICmpInst::ICMP_SLT:
5520     case ICmpInst::ICMP_SLE: return {SPF_SMIN, SPNB_NA, false};
5521     case FCmpInst::FCMP_UGT:
5522     case FCmpInst::FCMP_UGE:
5523     case FCmpInst::FCMP_OGT:
5524     case FCmpInst::FCMP_OGE: return {SPF_FMAXNUM, NaNBehavior, Ordered};
5525     case FCmpInst::FCMP_ULT:
5526     case FCmpInst::FCMP_ULE:
5527     case FCmpInst::FCMP_OLT:
5528     case FCmpInst::FCMP_OLE: return {SPF_FMINNUM, NaNBehavior, Ordered};
5529     }
5530   }
5531 
5532   if (isKnownNegation(TrueVal, FalseVal)) {
5533     // Sign-extending LHS does not change its sign, so TrueVal/FalseVal can
5534     // match against either LHS or sext(LHS).
5535     auto MaybeSExtCmpLHS =
5536         m_CombineOr(m_Specific(CmpLHS), m_SExt(m_Specific(CmpLHS)));
5537     auto ZeroOrAllOnes = m_CombineOr(m_ZeroInt(), m_AllOnes());
5538     auto ZeroOrOne = m_CombineOr(m_ZeroInt(), m_One());
5539     if (match(TrueVal, MaybeSExtCmpLHS)) {
5540       // Set the return values. If the compare uses the negated value (-X >s 0),
5541       // swap the return values because the negated value is always 'RHS'.
5542       LHS = TrueVal;
5543       RHS = FalseVal;
5544       if (match(CmpLHS, m_Neg(m_Specific(FalseVal))))
5545         std::swap(LHS, RHS);
5546 
5547       // (X >s 0) ? X : -X or (X >s -1) ? X : -X --> ABS(X)
5548       // (-X >s 0) ? -X : X or (-X >s -1) ? -X : X --> ABS(X)
5549       if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, ZeroOrAllOnes))
5550         return {SPF_ABS, SPNB_NA, false};
5551 
5552       // (X >=s 0) ? X : -X or (X >=s 1) ? X : -X --> ABS(X)
5553       if (Pred == ICmpInst::ICMP_SGE && match(CmpRHS, ZeroOrOne))
5554         return {SPF_ABS, SPNB_NA, false};
5555 
5556       // (X <s 0) ? X : -X or (X <s 1) ? X : -X --> NABS(X)
5557       // (-X <s 0) ? -X : X or (-X <s 1) ? -X : X --> NABS(X)
5558       if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, ZeroOrOne))
5559         return {SPF_NABS, SPNB_NA, false};
5560     }
5561     else if (match(FalseVal, MaybeSExtCmpLHS)) {
5562       // Set the return values. If the compare uses the negated value (-X >s 0),
5563       // swap the return values because the negated value is always 'RHS'.
5564       LHS = FalseVal;
5565       RHS = TrueVal;
5566       if (match(CmpLHS, m_Neg(m_Specific(TrueVal))))
5567         std::swap(LHS, RHS);
5568 
5569       // (X >s 0) ? -X : X or (X >s -1) ? -X : X --> NABS(X)
5570       // (-X >s 0) ? X : -X or (-X >s -1) ? X : -X --> NABS(X)
5571       if (Pred == ICmpInst::ICMP_SGT && match(CmpRHS, ZeroOrAllOnes))
5572         return {SPF_NABS, SPNB_NA, false};
5573 
5574       // (X <s 0) ? -X : X or (X <s 1) ? -X : X --> ABS(X)
5575       // (-X <s 0) ? X : -X or (-X <s 1) ? X : -X --> ABS(X)
5576       if (Pred == ICmpInst::ICMP_SLT && match(CmpRHS, ZeroOrOne))
5577         return {SPF_ABS, SPNB_NA, false};
5578     }
5579   }
5580 
5581   if (CmpInst::isIntPredicate(Pred))
5582     return matchMinMax(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, LHS, RHS, Depth);
5583 
5584   // According to (IEEE 754-2008 5.3.1), minNum(0.0, -0.0) and similar
5585   // may return either -0.0 or 0.0, so fcmp/select pair has stricter
5586   // semantics than minNum. Be conservative in such case.
5587   if (NaNBehavior != SPNB_RETURNS_ANY ||
5588       (!FMF.noSignedZeros() && !isKnownNonZero(CmpLHS) &&
5589        !isKnownNonZero(CmpRHS)))
5590     return {SPF_UNKNOWN, SPNB_NA, false};
5591 
5592   return matchFastFloatClamp(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, LHS, RHS);
5593 }
5594 
5595 /// Helps to match a select pattern in case of a type mismatch.
5596 ///
5597 /// The function processes the case when type of true and false values of a
5598 /// select instruction differs from type of the cmp instruction operands because
5599 /// of a cast instruction. The function checks if it is legal to move the cast
5600 /// operation after "select". If yes, it returns the new second value of
5601 /// "select" (with the assumption that cast is moved):
5602 /// 1. As operand of cast instruction when both values of "select" are same cast
5603 /// instructions.
5604 /// 2. As restored constant (by applying reverse cast operation) when the first
5605 /// value of the "select" is a cast operation and the second value is a
5606 /// constant.
5607 /// NOTE: We return only the new second value because the first value could be
5608 /// accessed as operand of cast instruction.
5609 static Value *lookThroughCast(CmpInst *CmpI, Value *V1, Value *V2,
5610                               Instruction::CastOps *CastOp) {
5611   auto *Cast1 = dyn_cast<CastInst>(V1);
5612   if (!Cast1)
5613     return nullptr;
5614 
5615   *CastOp = Cast1->getOpcode();
5616   Type *SrcTy = Cast1->getSrcTy();
5617   if (auto *Cast2 = dyn_cast<CastInst>(V2)) {
5618     // If V1 and V2 are both the same cast from the same type, look through V1.
5619     if (*CastOp == Cast2->getOpcode() && SrcTy == Cast2->getSrcTy())
5620       return Cast2->getOperand(0);
5621     return nullptr;
5622   }
5623 
5624   auto *C = dyn_cast<Constant>(V2);
5625   if (!C)
5626     return nullptr;
5627 
5628   Constant *CastedTo = nullptr;
5629   switch (*CastOp) {
5630   case Instruction::ZExt:
5631     if (CmpI->isUnsigned())
5632       CastedTo = ConstantExpr::getTrunc(C, SrcTy);
5633     break;
5634   case Instruction::SExt:
5635     if (CmpI->isSigned())
5636       CastedTo = ConstantExpr::getTrunc(C, SrcTy, true);
5637     break;
5638   case Instruction::Trunc:
5639     Constant *CmpConst;
5640     if (match(CmpI->getOperand(1), m_Constant(CmpConst)) &&
5641         CmpConst->getType() == SrcTy) {
5642       // Here we have the following case:
5643       //
5644       //   %cond = cmp iN %x, CmpConst
5645       //   %tr = trunc iN %x to iK
5646       //   %narrowsel = select i1 %cond, iK %t, iK C
5647       //
5648       // We can always move trunc after select operation:
5649       //
5650       //   %cond = cmp iN %x, CmpConst
5651       //   %widesel = select i1 %cond, iN %x, iN CmpConst
5652       //   %tr = trunc iN %widesel to iK
5653       //
5654       // Note that C could be extended in any way because we don't care about
5655       // upper bits after truncation. It can't be abs pattern, because it would
5656       // look like:
5657       //
5658       //   select i1 %cond, x, -x.
5659       //
5660       // So only min/max pattern could be matched. Such match requires widened C
5661       // == CmpConst. That is why set widened C = CmpConst, condition trunc
5662       // CmpConst == C is checked below.
5663       CastedTo = CmpConst;
5664     } else {
5665       CastedTo = ConstantExpr::getIntegerCast(C, SrcTy, CmpI->isSigned());
5666     }
5667     break;
5668   case Instruction::FPTrunc:
5669     CastedTo = ConstantExpr::getFPExtend(C, SrcTy, true);
5670     break;
5671   case Instruction::FPExt:
5672     CastedTo = ConstantExpr::getFPTrunc(C, SrcTy, true);
5673     break;
5674   case Instruction::FPToUI:
5675     CastedTo = ConstantExpr::getUIToFP(C, SrcTy, true);
5676     break;
5677   case Instruction::FPToSI:
5678     CastedTo = ConstantExpr::getSIToFP(C, SrcTy, true);
5679     break;
5680   case Instruction::UIToFP:
5681     CastedTo = ConstantExpr::getFPToUI(C, SrcTy, true);
5682     break;
5683   case Instruction::SIToFP:
5684     CastedTo = ConstantExpr::getFPToSI(C, SrcTy, true);
5685     break;
5686   default:
5687     break;
5688   }
5689 
5690   if (!CastedTo)
5691     return nullptr;
5692 
5693   // Make sure the cast doesn't lose any information.
5694   Constant *CastedBack =
5695       ConstantExpr::getCast(*CastOp, CastedTo, C->getType(), true);
5696   if (CastedBack != C)
5697     return nullptr;
5698 
5699   return CastedTo;
5700 }
5701 
5702 SelectPatternResult llvm::matchSelectPattern(Value *V, Value *&LHS, Value *&RHS,
5703                                              Instruction::CastOps *CastOp,
5704                                              unsigned Depth) {
5705   if (Depth >= MaxDepth)
5706     return {SPF_UNKNOWN, SPNB_NA, false};
5707 
5708   SelectInst *SI = dyn_cast<SelectInst>(V);
5709   if (!SI) return {SPF_UNKNOWN, SPNB_NA, false};
5710 
5711   CmpInst *CmpI = dyn_cast<CmpInst>(SI->getCondition());
5712   if (!CmpI) return {SPF_UNKNOWN, SPNB_NA, false};
5713 
5714   Value *TrueVal = SI->getTrueValue();
5715   Value *FalseVal = SI->getFalseValue();
5716 
5717   return llvm::matchDecomposedSelectPattern(CmpI, TrueVal, FalseVal, LHS, RHS,
5718                                             CastOp, Depth);
5719 }
5720 
5721 SelectPatternResult llvm::matchDecomposedSelectPattern(
5722     CmpInst *CmpI, Value *TrueVal, Value *FalseVal, Value *&LHS, Value *&RHS,
5723     Instruction::CastOps *CastOp, unsigned Depth) {
5724   CmpInst::Predicate Pred = CmpI->getPredicate();
5725   Value *CmpLHS = CmpI->getOperand(0);
5726   Value *CmpRHS = CmpI->getOperand(1);
5727   FastMathFlags FMF;
5728   if (isa<FPMathOperator>(CmpI))
5729     FMF = CmpI->getFastMathFlags();
5730 
5731   // Bail out early.
5732   if (CmpI->isEquality())
5733     return {SPF_UNKNOWN, SPNB_NA, false};
5734 
5735   // Deal with type mismatches.
5736   if (CastOp && CmpLHS->getType() != TrueVal->getType()) {
5737     if (Value *C = lookThroughCast(CmpI, TrueVal, FalseVal, CastOp)) {
5738       // If this is a potential fmin/fmax with a cast to integer, then ignore
5739       // -0.0 because there is no corresponding integer value.
5740       if (*CastOp == Instruction::FPToSI || *CastOp == Instruction::FPToUI)
5741         FMF.setNoSignedZeros();
5742       return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
5743                                   cast<CastInst>(TrueVal)->getOperand(0), C,
5744                                   LHS, RHS, Depth);
5745     }
5746     if (Value *C = lookThroughCast(CmpI, FalseVal, TrueVal, CastOp)) {
5747       // If this is a potential fmin/fmax with a cast to integer, then ignore
5748       // -0.0 because there is no corresponding integer value.
5749       if (*CastOp == Instruction::FPToSI || *CastOp == Instruction::FPToUI)
5750         FMF.setNoSignedZeros();
5751       return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
5752                                   C, cast<CastInst>(FalseVal)->getOperand(0),
5753                                   LHS, RHS, Depth);
5754     }
5755   }
5756   return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS, TrueVal, FalseVal,
5757                               LHS, RHS, Depth);
5758 }
5759 
5760 CmpInst::Predicate llvm::getMinMaxPred(SelectPatternFlavor SPF, bool Ordered) {
5761   if (SPF == SPF_SMIN) return ICmpInst::ICMP_SLT;
5762   if (SPF == SPF_UMIN) return ICmpInst::ICMP_ULT;
5763   if (SPF == SPF_SMAX) return ICmpInst::ICMP_SGT;
5764   if (SPF == SPF_UMAX) return ICmpInst::ICMP_UGT;
5765   if (SPF == SPF_FMINNUM)
5766     return Ordered ? FCmpInst::FCMP_OLT : FCmpInst::FCMP_ULT;
5767   if (SPF == SPF_FMAXNUM)
5768     return Ordered ? FCmpInst::FCMP_OGT : FCmpInst::FCMP_UGT;
5769   llvm_unreachable("unhandled!");
5770 }
5771 
5772 SelectPatternFlavor llvm::getInverseMinMaxFlavor(SelectPatternFlavor SPF) {
5773   if (SPF == SPF_SMIN) return SPF_SMAX;
5774   if (SPF == SPF_UMIN) return SPF_UMAX;
5775   if (SPF == SPF_SMAX) return SPF_SMIN;
5776   if (SPF == SPF_UMAX) return SPF_UMIN;
5777   llvm_unreachable("unhandled!");
5778 }
5779 
5780 CmpInst::Predicate llvm::getInverseMinMaxPred(SelectPatternFlavor SPF) {
5781   return getMinMaxPred(getInverseMinMaxFlavor(SPF));
5782 }
5783 
5784 /// Return true if "icmp Pred LHS RHS" is always true.
5785 static bool isTruePredicate(CmpInst::Predicate Pred, const Value *LHS,
5786                             const Value *RHS, const DataLayout &DL,
5787                             unsigned Depth) {
5788   assert(!LHS->getType()->isVectorTy() && "TODO: extend to handle vectors!");
5789   if (ICmpInst::isTrueWhenEqual(Pred) && LHS == RHS)
5790     return true;
5791 
5792   switch (Pred) {
5793   default:
5794     return false;
5795 
5796   case CmpInst::ICMP_SLE: {
5797     const APInt *C;
5798 
5799     // LHS s<= LHS +_{nsw} C   if C >= 0
5800     if (match(RHS, m_NSWAdd(m_Specific(LHS), m_APInt(C))))
5801       return !C->isNegative();
5802     return false;
5803   }
5804 
5805   case CmpInst::ICMP_ULE: {
5806     const APInt *C;
5807 
5808     // LHS u<= LHS +_{nuw} C   for any C
5809     if (match(RHS, m_NUWAdd(m_Specific(LHS), m_APInt(C))))
5810       return true;
5811 
5812     // Match A to (X +_{nuw} CA) and B to (X +_{nuw} CB)
5813     auto MatchNUWAddsToSameValue = [&](const Value *A, const Value *B,
5814                                        const Value *&X,
5815                                        const APInt *&CA, const APInt *&CB) {
5816       if (match(A, m_NUWAdd(m_Value(X), m_APInt(CA))) &&
5817           match(B, m_NUWAdd(m_Specific(X), m_APInt(CB))))
5818         return true;
5819 
5820       // If X & C == 0 then (X | C) == X +_{nuw} C
5821       if (match(A, m_Or(m_Value(X), m_APInt(CA))) &&
5822           match(B, m_Or(m_Specific(X), m_APInt(CB)))) {
5823         KnownBits Known(CA->getBitWidth());
5824         computeKnownBits(X, Known, DL, Depth + 1, /*AC*/ nullptr,
5825                          /*CxtI*/ nullptr, /*DT*/ nullptr);
5826         if (CA->isSubsetOf(Known.Zero) && CB->isSubsetOf(Known.Zero))
5827           return true;
5828       }
5829 
5830       return false;
5831     };
5832 
5833     const Value *X;
5834     const APInt *CLHS, *CRHS;
5835     if (MatchNUWAddsToSameValue(LHS, RHS, X, CLHS, CRHS))
5836       return CLHS->ule(*CRHS);
5837 
5838     return false;
5839   }
5840   }
5841 }
5842 
5843 /// Return true if "icmp Pred BLHS BRHS" is true whenever "icmp Pred
5844 /// ALHS ARHS" is true.  Otherwise, return None.
5845 static Optional<bool>
5846 isImpliedCondOperands(CmpInst::Predicate Pred, const Value *ALHS,
5847                       const Value *ARHS, const Value *BLHS, const Value *BRHS,
5848                       const DataLayout &DL, unsigned Depth) {
5849   switch (Pred) {
5850   default:
5851     return None;
5852 
5853   case CmpInst::ICMP_SLT:
5854   case CmpInst::ICMP_SLE:
5855     if (isTruePredicate(CmpInst::ICMP_SLE, BLHS, ALHS, DL, Depth) &&
5856         isTruePredicate(CmpInst::ICMP_SLE, ARHS, BRHS, DL, Depth))
5857       return true;
5858     return None;
5859 
5860   case CmpInst::ICMP_ULT:
5861   case CmpInst::ICMP_ULE:
5862     if (isTruePredicate(CmpInst::ICMP_ULE, BLHS, ALHS, DL, Depth) &&
5863         isTruePredicate(CmpInst::ICMP_ULE, ARHS, BRHS, DL, Depth))
5864       return true;
5865     return None;
5866   }
5867 }
5868 
5869 /// Return true if the operands of the two compares match.  IsSwappedOps is true
5870 /// when the operands match, but are swapped.
5871 static bool isMatchingOps(const Value *ALHS, const Value *ARHS,
5872                           const Value *BLHS, const Value *BRHS,
5873                           bool &IsSwappedOps) {
5874 
5875   bool IsMatchingOps = (ALHS == BLHS && ARHS == BRHS);
5876   IsSwappedOps = (ALHS == BRHS && ARHS == BLHS);
5877   return IsMatchingOps || IsSwappedOps;
5878 }
5879 
5880 /// Return true if "icmp1 APred X, Y" implies "icmp2 BPred X, Y" is true.
5881 /// Return false if "icmp1 APred X, Y" implies "icmp2 BPred X, Y" is false.
5882 /// Otherwise, return None if we can't infer anything.
5883 static Optional<bool> isImpliedCondMatchingOperands(CmpInst::Predicate APred,
5884                                                     CmpInst::Predicate BPred,
5885                                                     bool AreSwappedOps) {
5886   // Canonicalize the predicate as if the operands were not commuted.
5887   if (AreSwappedOps)
5888     BPred = ICmpInst::getSwappedPredicate(BPred);
5889 
5890   if (CmpInst::isImpliedTrueByMatchingCmp(APred, BPred))
5891     return true;
5892   if (CmpInst::isImpliedFalseByMatchingCmp(APred, BPred))
5893     return false;
5894 
5895   return None;
5896 }
5897 
5898 /// Return true if "icmp APred X, C1" implies "icmp BPred X, C2" is true.
5899 /// Return false if "icmp APred X, C1" implies "icmp BPred X, C2" is false.
5900 /// Otherwise, return None if we can't infer anything.
5901 static Optional<bool>
5902 isImpliedCondMatchingImmOperands(CmpInst::Predicate APred,
5903                                  const ConstantInt *C1,
5904                                  CmpInst::Predicate BPred,
5905                                  const ConstantInt *C2) {
5906   ConstantRange DomCR =
5907       ConstantRange::makeExactICmpRegion(APred, C1->getValue());
5908   ConstantRange CR =
5909       ConstantRange::makeAllowedICmpRegion(BPred, C2->getValue());
5910   ConstantRange Intersection = DomCR.intersectWith(CR);
5911   ConstantRange Difference = DomCR.difference(CR);
5912   if (Intersection.isEmptySet())
5913     return false;
5914   if (Difference.isEmptySet())
5915     return true;
5916   return None;
5917 }
5918 
5919 /// Return true if LHS implies RHS is true.  Return false if LHS implies RHS is
5920 /// false.  Otherwise, return None if we can't infer anything.
5921 static Optional<bool> isImpliedCondICmps(const ICmpInst *LHS,
5922                                          CmpInst::Predicate BPred,
5923                                          const Value *BLHS, const Value *BRHS,
5924                                          const DataLayout &DL, bool LHSIsTrue,
5925                                          unsigned Depth) {
5926   Value *ALHS = LHS->getOperand(0);
5927   Value *ARHS = LHS->getOperand(1);
5928 
5929   // The rest of the logic assumes the LHS condition is true.  If that's not the
5930   // case, invert the predicate to make it so.
5931   CmpInst::Predicate APred =
5932       LHSIsTrue ? LHS->getPredicate() : LHS->getInversePredicate();
5933 
5934   // Can we infer anything when the two compares have matching operands?
5935   bool AreSwappedOps;
5936   if (isMatchingOps(ALHS, ARHS, BLHS, BRHS, AreSwappedOps)) {
5937     if (Optional<bool> Implication = isImpliedCondMatchingOperands(
5938             APred, BPred, AreSwappedOps))
5939       return Implication;
5940     // No amount of additional analysis will infer the second condition, so
5941     // early exit.
5942     return None;
5943   }
5944 
5945   // Can we infer anything when the LHS operands match and the RHS operands are
5946   // constants (not necessarily matching)?
5947   if (ALHS == BLHS && isa<ConstantInt>(ARHS) && isa<ConstantInt>(BRHS)) {
5948     if (Optional<bool> Implication = isImpliedCondMatchingImmOperands(
5949             APred, cast<ConstantInt>(ARHS), BPred, cast<ConstantInt>(BRHS)))
5950       return Implication;
5951     // No amount of additional analysis will infer the second condition, so
5952     // early exit.
5953     return None;
5954   }
5955 
5956   if (APred == BPred)
5957     return isImpliedCondOperands(APred, ALHS, ARHS, BLHS, BRHS, DL, Depth);
5958   return None;
5959 }
5960 
5961 /// Return true if LHS implies RHS is true.  Return false if LHS implies RHS is
5962 /// false.  Otherwise, return None if we can't infer anything.  We expect the
5963 /// RHS to be an icmp and the LHS to be an 'and' or an 'or' instruction.
5964 static Optional<bool>
5965 isImpliedCondAndOr(const BinaryOperator *LHS, CmpInst::Predicate RHSPred,
5966                    const Value *RHSOp0, const Value *RHSOp1,
5967 
5968                    const DataLayout &DL, bool LHSIsTrue, unsigned Depth) {
5969   // The LHS must be an 'or' or an 'and' instruction.
5970   assert((LHS->getOpcode() == Instruction::And ||
5971           LHS->getOpcode() == Instruction::Or) &&
5972          "Expected LHS to be 'and' or 'or'.");
5973 
5974   assert(Depth <= MaxDepth && "Hit recursion limit");
5975 
5976   // If the result of an 'or' is false, then we know both legs of the 'or' are
5977   // false.  Similarly, if the result of an 'and' is true, then we know both
5978   // legs of the 'and' are true.
5979   Value *ALHS, *ARHS;
5980   if ((!LHSIsTrue && match(LHS, m_Or(m_Value(ALHS), m_Value(ARHS)))) ||
5981       (LHSIsTrue && match(LHS, m_And(m_Value(ALHS), m_Value(ARHS))))) {
5982     // FIXME: Make this non-recursion.
5983     if (Optional<bool> Implication = isImpliedCondition(
5984             ALHS, RHSPred, RHSOp0, RHSOp1, DL, LHSIsTrue, Depth + 1))
5985       return Implication;
5986     if (Optional<bool> Implication = isImpliedCondition(
5987             ARHS, RHSPred, RHSOp0, RHSOp1, DL, LHSIsTrue, Depth + 1))
5988       return Implication;
5989     return None;
5990   }
5991   return None;
5992 }
5993 
5994 Optional<bool>
5995 llvm::isImpliedCondition(const Value *LHS, CmpInst::Predicate RHSPred,
5996                          const Value *RHSOp0, const Value *RHSOp1,
5997                          const DataLayout &DL, bool LHSIsTrue, unsigned Depth) {
5998   // Bail out when we hit the limit.
5999   if (Depth == MaxDepth)
6000     return None;
6001 
6002   // A mismatch occurs when we compare a scalar cmp to a vector cmp, for
6003   // example.
6004   if (RHSOp0->getType()->isVectorTy() != LHS->getType()->isVectorTy())
6005     return None;
6006 
6007   Type *OpTy = LHS->getType();
6008   assert(OpTy->isIntOrIntVectorTy(1) && "Expected integer type only!");
6009 
6010   // FIXME: Extending the code below to handle vectors.
6011   if (OpTy->isVectorTy())
6012     return None;
6013 
6014   assert(OpTy->isIntegerTy(1) && "implied by above");
6015 
6016   // Both LHS and RHS are icmps.
6017   const ICmpInst *LHSCmp = dyn_cast<ICmpInst>(LHS);
6018   if (LHSCmp)
6019     return isImpliedCondICmps(LHSCmp, RHSPred, RHSOp0, RHSOp1, DL, LHSIsTrue,
6020                               Depth);
6021 
6022   /// The LHS should be an 'or' or an 'and' instruction.  We expect the RHS to
6023   /// be / an icmp. FIXME: Add support for and/or on the RHS.
6024   const BinaryOperator *LHSBO = dyn_cast<BinaryOperator>(LHS);
6025   if (LHSBO) {
6026     if ((LHSBO->getOpcode() == Instruction::And ||
6027          LHSBO->getOpcode() == Instruction::Or))
6028       return isImpliedCondAndOr(LHSBO, RHSPred, RHSOp0, RHSOp1, DL, LHSIsTrue,
6029                                 Depth);
6030   }
6031   return None;
6032 }
6033 
6034 Optional<bool> llvm::isImpliedCondition(const Value *LHS, const Value *RHS,
6035                                         const DataLayout &DL, bool LHSIsTrue,
6036                                         unsigned Depth) {
6037   // LHS ==> RHS by definition
6038   if (LHS == RHS)
6039     return LHSIsTrue;
6040 
6041   const ICmpInst *RHSCmp = dyn_cast<ICmpInst>(RHS);
6042   if (RHSCmp)
6043     return isImpliedCondition(LHS, RHSCmp->getPredicate(),
6044                               RHSCmp->getOperand(0), RHSCmp->getOperand(1), DL,
6045                               LHSIsTrue, Depth);
6046   return None;
6047 }
6048 
6049 // Returns a pair (Condition, ConditionIsTrue), where Condition is a branch
6050 // condition dominating ContextI or nullptr, if no condition is found.
6051 static std::pair<Value *, bool>
6052 getDomPredecessorCondition(const Instruction *ContextI) {
6053   if (!ContextI || !ContextI->getParent())
6054     return {nullptr, false};
6055 
6056   // TODO: This is a poor/cheap way to determine dominance. Should we use a
6057   // dominator tree (eg, from a SimplifyQuery) instead?
6058   const BasicBlock *ContextBB = ContextI->getParent();
6059   const BasicBlock *PredBB = ContextBB->getSinglePredecessor();
6060   if (!PredBB)
6061     return {nullptr, false};
6062 
6063   // We need a conditional branch in the predecessor.
6064   Value *PredCond;
6065   BasicBlock *TrueBB, *FalseBB;
6066   if (!match(PredBB->getTerminator(), m_Br(m_Value(PredCond), TrueBB, FalseBB)))
6067     return {nullptr, false};
6068 
6069   // The branch should get simplified. Don't bother simplifying this condition.
6070   if (TrueBB == FalseBB)
6071     return {nullptr, false};
6072 
6073   assert((TrueBB == ContextBB || FalseBB == ContextBB) &&
6074          "Predecessor block does not point to successor?");
6075 
6076   // Is this condition implied by the predecessor condition?
6077   return {PredCond, TrueBB == ContextBB};
6078 }
6079 
6080 Optional<bool> llvm::isImpliedByDomCondition(const Value *Cond,
6081                                              const Instruction *ContextI,
6082                                              const DataLayout &DL) {
6083   assert(Cond->getType()->isIntOrIntVectorTy(1) && "Condition must be bool");
6084   auto PredCond = getDomPredecessorCondition(ContextI);
6085   if (PredCond.first)
6086     return isImpliedCondition(PredCond.first, Cond, DL, PredCond.second);
6087   return None;
6088 }
6089 
6090 Optional<bool> llvm::isImpliedByDomCondition(CmpInst::Predicate Pred,
6091                                              const Value *LHS, const Value *RHS,
6092                                              const Instruction *ContextI,
6093                                              const DataLayout &DL) {
6094   auto PredCond = getDomPredecessorCondition(ContextI);
6095   if (PredCond.first)
6096     return isImpliedCondition(PredCond.first, Pred, LHS, RHS, DL,
6097                               PredCond.second);
6098   return None;
6099 }
6100 
6101 static void setLimitsForBinOp(const BinaryOperator &BO, APInt &Lower,
6102                               APInt &Upper, const InstrInfoQuery &IIQ) {
6103   unsigned Width = Lower.getBitWidth();
6104   const APInt *C;
6105   switch (BO.getOpcode()) {
6106   case Instruction::Add:
6107     if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
6108       // FIXME: If we have both nuw and nsw, we should reduce the range further.
6109       if (IIQ.hasNoUnsignedWrap(cast<OverflowingBinaryOperator>(&BO))) {
6110         // 'add nuw x, C' produces [C, UINT_MAX].
6111         Lower = *C;
6112       } else if (IIQ.hasNoSignedWrap(cast<OverflowingBinaryOperator>(&BO))) {
6113         if (C->isNegative()) {
6114           // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
6115           Lower = APInt::getSignedMinValue(Width);
6116           Upper = APInt::getSignedMaxValue(Width) + *C + 1;
6117         } else {
6118           // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
6119           Lower = APInt::getSignedMinValue(Width) + *C;
6120           Upper = APInt::getSignedMaxValue(Width) + 1;
6121         }
6122       }
6123     }
6124     break;
6125 
6126   case Instruction::And:
6127     if (match(BO.getOperand(1), m_APInt(C)))
6128       // 'and x, C' produces [0, C].
6129       Upper = *C + 1;
6130     break;
6131 
6132   case Instruction::Or:
6133     if (match(BO.getOperand(1), m_APInt(C)))
6134       // 'or x, C' produces [C, UINT_MAX].
6135       Lower = *C;
6136     break;
6137 
6138   case Instruction::AShr:
6139     if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
6140       // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
6141       Lower = APInt::getSignedMinValue(Width).ashr(*C);
6142       Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
6143     } else if (match(BO.getOperand(0), m_APInt(C))) {
6144       unsigned ShiftAmount = Width - 1;
6145       if (!C->isNullValue() && IIQ.isExact(&BO))
6146         ShiftAmount = C->countTrailingZeros();
6147       if (C->isNegative()) {
6148         // 'ashr C, x' produces [C, C >> (Width-1)]
6149         Lower = *C;
6150         Upper = C->ashr(ShiftAmount) + 1;
6151       } else {
6152         // 'ashr C, x' produces [C >> (Width-1), C]
6153         Lower = C->ashr(ShiftAmount);
6154         Upper = *C + 1;
6155       }
6156     }
6157     break;
6158 
6159   case Instruction::LShr:
6160     if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
6161       // 'lshr x, C' produces [0, UINT_MAX >> C].
6162       Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
6163     } else if (match(BO.getOperand(0), m_APInt(C))) {
6164       // 'lshr C, x' produces [C >> (Width-1), C].
6165       unsigned ShiftAmount = Width - 1;
6166       if (!C->isNullValue() && IIQ.isExact(&BO))
6167         ShiftAmount = C->countTrailingZeros();
6168       Lower = C->lshr(ShiftAmount);
6169       Upper = *C + 1;
6170     }
6171     break;
6172 
6173   case Instruction::Shl:
6174     if (match(BO.getOperand(0), m_APInt(C))) {
6175       if (IIQ.hasNoUnsignedWrap(&BO)) {
6176         // 'shl nuw C, x' produces [C, C << CLZ(C)]
6177         Lower = *C;
6178         Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
6179       } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
6180         if (C->isNegative()) {
6181           // 'shl nsw C, x' produces [C << CLO(C)-1, C]
6182           unsigned ShiftAmount = C->countLeadingOnes() - 1;
6183           Lower = C->shl(ShiftAmount);
6184           Upper = *C + 1;
6185         } else {
6186           // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
6187           unsigned ShiftAmount = C->countLeadingZeros() - 1;
6188           Lower = *C;
6189           Upper = C->shl(ShiftAmount) + 1;
6190         }
6191       }
6192     }
6193     break;
6194 
6195   case Instruction::SDiv:
6196     if (match(BO.getOperand(1), m_APInt(C))) {
6197       APInt IntMin = APInt::getSignedMinValue(Width);
6198       APInt IntMax = APInt::getSignedMaxValue(Width);
6199       if (C->isAllOnesValue()) {
6200         // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
6201         //    where C != -1 and C != 0 and C != 1
6202         Lower = IntMin + 1;
6203         Upper = IntMax + 1;
6204       } else if (C->countLeadingZeros() < Width - 1) {
6205         // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
6206         //    where C != -1 and C != 0 and C != 1
6207         Lower = IntMin.sdiv(*C);
6208         Upper = IntMax.sdiv(*C);
6209         if (Lower.sgt(Upper))
6210           std::swap(Lower, Upper);
6211         Upper = Upper + 1;
6212         assert(Upper != Lower && "Upper part of range has wrapped!");
6213       }
6214     } else if (match(BO.getOperand(0), m_APInt(C))) {
6215       if (C->isMinSignedValue()) {
6216         // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
6217         Lower = *C;
6218         Upper = Lower.lshr(1) + 1;
6219       } else {
6220         // 'sdiv C, x' produces [-|C|, |C|].
6221         Upper = C->abs() + 1;
6222         Lower = (-Upper) + 1;
6223       }
6224     }
6225     break;
6226 
6227   case Instruction::UDiv:
6228     if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
6229       // 'udiv x, C' produces [0, UINT_MAX / C].
6230       Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
6231     } else if (match(BO.getOperand(0), m_APInt(C))) {
6232       // 'udiv C, x' produces [0, C].
6233       Upper = *C + 1;
6234     }
6235     break;
6236 
6237   case Instruction::SRem:
6238     if (match(BO.getOperand(1), m_APInt(C))) {
6239       // 'srem x, C' produces (-|C|, |C|).
6240       Upper = C->abs();
6241       Lower = (-Upper) + 1;
6242     }
6243     break;
6244 
6245   case Instruction::URem:
6246     if (match(BO.getOperand(1), m_APInt(C)))
6247       // 'urem x, C' produces [0, C).
6248       Upper = *C;
6249     break;
6250 
6251   default:
6252     break;
6253   }
6254 }
6255 
6256 static void setLimitsForIntrinsic(const IntrinsicInst &II, APInt &Lower,
6257                                   APInt &Upper) {
6258   unsigned Width = Lower.getBitWidth();
6259   const APInt *C;
6260   switch (II.getIntrinsicID()) {
6261   case Intrinsic::uadd_sat:
6262     // uadd.sat(x, C) produces [C, UINT_MAX].
6263     if (match(II.getOperand(0), m_APInt(C)) ||
6264         match(II.getOperand(1), m_APInt(C)))
6265       Lower = *C;
6266     break;
6267   case Intrinsic::sadd_sat:
6268     if (match(II.getOperand(0), m_APInt(C)) ||
6269         match(II.getOperand(1), m_APInt(C))) {
6270       if (C->isNegative()) {
6271         // sadd.sat(x, -C) produces [SINT_MIN, SINT_MAX + (-C)].
6272         Lower = APInt::getSignedMinValue(Width);
6273         Upper = APInt::getSignedMaxValue(Width) + *C + 1;
6274       } else {
6275         // sadd.sat(x, +C) produces [SINT_MIN + C, SINT_MAX].
6276         Lower = APInt::getSignedMinValue(Width) + *C;
6277         Upper = APInt::getSignedMaxValue(Width) + 1;
6278       }
6279     }
6280     break;
6281   case Intrinsic::usub_sat:
6282     // usub.sat(C, x) produces [0, C].
6283     if (match(II.getOperand(0), m_APInt(C)))
6284       Upper = *C + 1;
6285     // usub.sat(x, C) produces [0, UINT_MAX - C].
6286     else if (match(II.getOperand(1), m_APInt(C)))
6287       Upper = APInt::getMaxValue(Width) - *C + 1;
6288     break;
6289   case Intrinsic::ssub_sat:
6290     if (match(II.getOperand(0), m_APInt(C))) {
6291       if (C->isNegative()) {
6292         // ssub.sat(-C, x) produces [SINT_MIN, -SINT_MIN + (-C)].
6293         Lower = APInt::getSignedMinValue(Width);
6294         Upper = *C - APInt::getSignedMinValue(Width) + 1;
6295       } else {
6296         // ssub.sat(+C, x) produces [-SINT_MAX + C, SINT_MAX].
6297         Lower = *C - APInt::getSignedMaxValue(Width);
6298         Upper = APInt::getSignedMaxValue(Width) + 1;
6299       }
6300     } else if (match(II.getOperand(1), m_APInt(C))) {
6301       if (C->isNegative()) {
6302         // ssub.sat(x, -C) produces [SINT_MIN - (-C), SINT_MAX]:
6303         Lower = APInt::getSignedMinValue(Width) - *C;
6304         Upper = APInt::getSignedMaxValue(Width) + 1;
6305       } else {
6306         // ssub.sat(x, +C) produces [SINT_MIN, SINT_MAX - C].
6307         Lower = APInt::getSignedMinValue(Width);
6308         Upper = APInt::getSignedMaxValue(Width) - *C + 1;
6309       }
6310     }
6311     break;
6312   default:
6313     break;
6314   }
6315 }
6316 
6317 static void setLimitsForSelectPattern(const SelectInst &SI, APInt &Lower,
6318                                       APInt &Upper, const InstrInfoQuery &IIQ) {
6319   const Value *LHS = nullptr, *RHS = nullptr;
6320   SelectPatternResult R = matchSelectPattern(&SI, LHS, RHS);
6321   if (R.Flavor == SPF_UNKNOWN)
6322     return;
6323 
6324   unsigned BitWidth = SI.getType()->getScalarSizeInBits();
6325 
6326   if (R.Flavor == SelectPatternFlavor::SPF_ABS) {
6327     // If the negation part of the abs (in RHS) has the NSW flag,
6328     // then the result of abs(X) is [0..SIGNED_MAX],
6329     // otherwise it is [0..SIGNED_MIN], as -SIGNED_MIN == SIGNED_MIN.
6330     Lower = APInt::getNullValue(BitWidth);
6331     if (match(RHS, m_Neg(m_Specific(LHS))) &&
6332         IIQ.hasNoSignedWrap(cast<Instruction>(RHS)))
6333       Upper = APInt::getSignedMaxValue(BitWidth) + 1;
6334     else
6335       Upper = APInt::getSignedMinValue(BitWidth) + 1;
6336     return;
6337   }
6338 
6339   if (R.Flavor == SelectPatternFlavor::SPF_NABS) {
6340     // The result of -abs(X) is <= 0.
6341     Lower = APInt::getSignedMinValue(BitWidth);
6342     Upper = APInt(BitWidth, 1);
6343     return;
6344   }
6345 
6346   const APInt *C;
6347   if (!match(LHS, m_APInt(C)) && !match(RHS, m_APInt(C)))
6348     return;
6349 
6350   switch (R.Flavor) {
6351     case SPF_UMIN:
6352       Upper = *C + 1;
6353       break;
6354     case SPF_UMAX:
6355       Lower = *C;
6356       break;
6357     case SPF_SMIN:
6358       Lower = APInt::getSignedMinValue(BitWidth);
6359       Upper = *C + 1;
6360       break;
6361     case SPF_SMAX:
6362       Lower = *C;
6363       Upper = APInt::getSignedMaxValue(BitWidth) + 1;
6364       break;
6365     default:
6366       break;
6367   }
6368 }
6369 
6370 ConstantRange llvm::computeConstantRange(const Value *V, bool UseInstrInfo,
6371                                          AssumptionCache *AC,
6372                                          const Instruction *CtxI,
6373                                          unsigned Depth) {
6374   assert(V->getType()->isIntOrIntVectorTy() && "Expected integer instruction");
6375 
6376   if (Depth == MaxDepth)
6377     return ConstantRange::getFull(V->getType()->getScalarSizeInBits());
6378 
6379   const APInt *C;
6380   if (match(V, m_APInt(C)))
6381     return ConstantRange(*C);
6382 
6383   InstrInfoQuery IIQ(UseInstrInfo);
6384   unsigned BitWidth = V->getType()->getScalarSizeInBits();
6385   APInt Lower = APInt(BitWidth, 0);
6386   APInt Upper = APInt(BitWidth, 0);
6387   if (auto *BO = dyn_cast<BinaryOperator>(V))
6388     setLimitsForBinOp(*BO, Lower, Upper, IIQ);
6389   else if (auto *II = dyn_cast<IntrinsicInst>(V))
6390     setLimitsForIntrinsic(*II, Lower, Upper);
6391   else if (auto *SI = dyn_cast<SelectInst>(V))
6392     setLimitsForSelectPattern(*SI, Lower, Upper, IIQ);
6393 
6394   ConstantRange CR = ConstantRange::getNonEmpty(Lower, Upper);
6395 
6396   if (auto *I = dyn_cast<Instruction>(V))
6397     if (auto *Range = IIQ.getMetadata(I, LLVMContext::MD_range))
6398       CR = CR.intersectWith(getConstantRangeFromMetadata(*Range));
6399 
6400   if (CtxI && AC) {
6401     // Try to restrict the range based on information from assumptions.
6402     for (auto &AssumeVH : AC->assumptionsFor(V)) {
6403       if (!AssumeVH)
6404         continue;
6405       CallInst *I = cast<CallInst>(AssumeVH);
6406       assert(I->getParent()->getParent() == CtxI->getParent()->getParent() &&
6407              "Got assumption for the wrong function!");
6408       assert(I->getCalledFunction()->getIntrinsicID() == Intrinsic::assume &&
6409              "must be an assume intrinsic");
6410 
6411       if (!isValidAssumeForContext(I, CtxI, nullptr))
6412         continue;
6413       Value *Arg = I->getArgOperand(0);
6414       ICmpInst *Cmp = dyn_cast<ICmpInst>(Arg);
6415       // Currently we just use information from comparisons.
6416       if (!Cmp || Cmp->getOperand(0) != V)
6417         continue;
6418       ConstantRange RHS = computeConstantRange(Cmp->getOperand(1), UseInstrInfo,
6419                                                AC, I, Depth + 1);
6420       CR = CR.intersectWith(
6421           ConstantRange::makeSatisfyingICmpRegion(Cmp->getPredicate(), RHS));
6422     }
6423   }
6424 
6425   return CR;
6426 }
6427 
6428 static Optional<int64_t>
6429 getOffsetFromIndex(const GEPOperator *GEP, unsigned Idx, const DataLayout &DL) {
6430   // Skip over the first indices.
6431   gep_type_iterator GTI = gep_type_begin(GEP);
6432   for (unsigned i = 1; i != Idx; ++i, ++GTI)
6433     /*skip along*/;
6434 
6435   // Compute the offset implied by the rest of the indices.
6436   int64_t Offset = 0;
6437   for (unsigned i = Idx, e = GEP->getNumOperands(); i != e; ++i, ++GTI) {
6438     ConstantInt *OpC = dyn_cast<ConstantInt>(GEP->getOperand(i));
6439     if (!OpC)
6440       return None;
6441     if (OpC->isZero())
6442       continue; // No offset.
6443 
6444     // Handle struct indices, which add their field offset to the pointer.
6445     if (StructType *STy = GTI.getStructTypeOrNull()) {
6446       Offset += DL.getStructLayout(STy)->getElementOffset(OpC->getZExtValue());
6447       continue;
6448     }
6449 
6450     // Otherwise, we have a sequential type like an array or fixed-length
6451     // vector. Multiply the index by the ElementSize.
6452     TypeSize Size = DL.getTypeAllocSize(GTI.getIndexedType());
6453     if (Size.isScalable())
6454       return None;
6455     Offset += Size.getFixedSize() * OpC->getSExtValue();
6456   }
6457 
6458   return Offset;
6459 }
6460 
6461 Optional<int64_t> llvm::isPointerOffset(const Value *Ptr1, const Value *Ptr2,
6462                                         const DataLayout &DL) {
6463   Ptr1 = Ptr1->stripPointerCasts();
6464   Ptr2 = Ptr2->stripPointerCasts();
6465 
6466   // Handle the trivial case first.
6467   if (Ptr1 == Ptr2) {
6468     return 0;
6469   }
6470 
6471   const GEPOperator *GEP1 = dyn_cast<GEPOperator>(Ptr1);
6472   const GEPOperator *GEP2 = dyn_cast<GEPOperator>(Ptr2);
6473 
6474   // If one pointer is a GEP see if the GEP is a constant offset from the base,
6475   // as in "P" and "gep P, 1".
6476   // Also do this iteratively to handle the the following case:
6477   //   Ptr_t1 = GEP Ptr1, c1
6478   //   Ptr_t2 = GEP Ptr_t1, c2
6479   //   Ptr2 = GEP Ptr_t2, c3
6480   // where we will return c1+c2+c3.
6481   // TODO: Handle the case when both Ptr1 and Ptr2 are GEPs of some common base
6482   // -- replace getOffsetFromBase with getOffsetAndBase, check that the bases
6483   // are the same, and return the difference between offsets.
6484   auto getOffsetFromBase = [&DL](const GEPOperator *GEP,
6485                                  const Value *Ptr) -> Optional<int64_t> {
6486     const GEPOperator *GEP_T = GEP;
6487     int64_t OffsetVal = 0;
6488     bool HasSameBase = false;
6489     while (GEP_T) {
6490       auto Offset = getOffsetFromIndex(GEP_T, 1, DL);
6491       if (!Offset)
6492         return None;
6493       OffsetVal += *Offset;
6494       auto Op0 = GEP_T->getOperand(0)->stripPointerCasts();
6495       if (Op0 == Ptr) {
6496         HasSameBase = true;
6497         break;
6498       }
6499       GEP_T = dyn_cast<GEPOperator>(Op0);
6500     }
6501     if (!HasSameBase)
6502       return None;
6503     return OffsetVal;
6504   };
6505 
6506   if (GEP1) {
6507     auto Offset = getOffsetFromBase(GEP1, Ptr2);
6508     if (Offset)
6509       return -*Offset;
6510   }
6511   if (GEP2) {
6512     auto Offset = getOffsetFromBase(GEP2, Ptr1);
6513     if (Offset)
6514       return Offset;
6515   }
6516 
6517   // Right now we handle the case when Ptr1/Ptr2 are both GEPs with an identical
6518   // base.  After that base, they may have some number of common (and
6519   // potentially variable) indices.  After that they handle some constant
6520   // offset, which determines their offset from each other.  At this point, we
6521   // handle no other case.
6522   if (!GEP1 || !GEP2 || GEP1->getOperand(0) != GEP2->getOperand(0))
6523     return None;
6524 
6525   // Skip any common indices and track the GEP types.
6526   unsigned Idx = 1;
6527   for (; Idx != GEP1->getNumOperands() && Idx != GEP2->getNumOperands(); ++Idx)
6528     if (GEP1->getOperand(Idx) != GEP2->getOperand(Idx))
6529       break;
6530 
6531   auto Offset1 = getOffsetFromIndex(GEP1, Idx, DL);
6532   auto Offset2 = getOffsetFromIndex(GEP2, Idx, DL);
6533   if (!Offset1 || !Offset2)
6534     return None;
6535   return *Offset2 - *Offset1;
6536 }
6537