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