Teach computeKnownBits to use new align attribute/metadata
[oota-llvm.git] / lib / Analysis / ValueTracking.cpp
1 //===- ValueTracking.cpp - Walk computations to compute properties --------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains routines that help analyze properties that chains of
11 // computations have.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/Analysis/ValueTracking.h"
16 #include "llvm/ADT/SmallPtrSet.h"
17 #include "llvm/Analysis/AssumptionCache.h"
18 #include "llvm/Analysis/InstructionSimplify.h"
19 #include "llvm/Analysis/MemoryBuiltins.h"
20 #include "llvm/Analysis/LoopInfo.h"
21 #include "llvm/IR/CallSite.h"
22 #include "llvm/IR/ConstantRange.h"
23 #include "llvm/IR/Constants.h"
24 #include "llvm/IR/DataLayout.h"
25 #include "llvm/IR/Dominators.h"
26 #include "llvm/IR/GetElementPtrTypeIterator.h"
27 #include "llvm/IR/GlobalAlias.h"
28 #include "llvm/IR/GlobalVariable.h"
29 #include "llvm/IR/Instructions.h"
30 #include "llvm/IR/IntrinsicInst.h"
31 #include "llvm/IR/LLVMContext.h"
32 #include "llvm/IR/Metadata.h"
33 #include "llvm/IR/Operator.h"
34 #include "llvm/IR/PatternMatch.h"
35 #include "llvm/IR/Statepoint.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/MathExtras.h"
38 #include <cstring>
39 using namespace llvm;
40 using namespace llvm::PatternMatch;
41
42 const unsigned MaxDepth = 6;
43
44 /// Enable an experimental feature to leverage information about dominating
45 /// conditions to compute known bits.  The individual options below control how
46 /// hard we search.  The defaults are chosen to be fairly aggressive.  If you
47 /// run into compile time problems when testing, scale them back and report
48 /// your findings.
49 static cl::opt<bool> EnableDomConditions("value-tracking-dom-conditions",
50                                          cl::Hidden, cl::init(false));
51
52 // This is expensive, so we only do it for the top level query value.
53 // (TODO: evaluate cost vs profit, consider higher thresholds)
54 static cl::opt<unsigned> DomConditionsMaxDepth("dom-conditions-max-depth",
55                                                cl::Hidden, cl::init(1));
56
57 /// How many dominating blocks should be scanned looking for dominating
58 /// conditions?
59 static cl::opt<unsigned> DomConditionsMaxDomBlocks("dom-conditions-dom-blocks",
60                                                    cl::Hidden,
61                                                    cl::init(20));
62
63 // Controls the number of uses of the value searched for possible
64 // dominating comparisons.
65 static cl::opt<unsigned> DomConditionsMaxUses("dom-conditions-max-uses",
66                                               cl::Hidden, cl::init(20));
67
68 // If true, don't consider only compares whose only use is a branch.
69 static cl::opt<bool> DomConditionsSingleCmpUse("dom-conditions-single-cmp-use",
70                                                cl::Hidden, cl::init(false));
71
72 /// Returns the bitwidth of the given scalar or pointer type (if unknown returns
73 /// 0). For vector types, returns the element type's bitwidth.
74 static unsigned getBitWidth(Type *Ty, const DataLayout &DL) {
75   if (unsigned BitWidth = Ty->getScalarSizeInBits())
76     return BitWidth;
77
78   return DL.getPointerTypeSizeInBits(Ty);
79 }
80
81 // Many of these functions have internal versions that take an assumption
82 // exclusion set. This is because of the potential for mutual recursion to
83 // cause computeKnownBits to repeatedly visit the same assume intrinsic. The
84 // classic case of this is assume(x = y), which will attempt to determine
85 // bits in x from bits in y, which will attempt to determine bits in y from
86 // bits in x, etc. Regarding the mutual recursion, computeKnownBits can call
87 // isKnownNonZero, which calls computeKnownBits and ComputeSignBit and
88 // isKnownToBeAPowerOfTwo (all of which can call computeKnownBits), and so on.
89 typedef SmallPtrSet<const Value *, 8> ExclInvsSet;
90
91 namespace {
92 // Simplifying using an assume can only be done in a particular control-flow
93 // context (the context instruction provides that context). If an assume and
94 // the context instruction are not in the same block then the DT helps in
95 // figuring out if we can use it.
96 struct Query {
97   ExclInvsSet ExclInvs;
98   AssumptionCache *AC;
99   const Instruction *CxtI;
100   const DominatorTree *DT;
101
102   Query(AssumptionCache *AC = nullptr, const Instruction *CxtI = nullptr,
103         const DominatorTree *DT = nullptr)
104       : AC(AC), CxtI(CxtI), DT(DT) {}
105
106   Query(const Query &Q, const Value *NewExcl)
107       : ExclInvs(Q.ExclInvs), AC(Q.AC), CxtI(Q.CxtI), DT(Q.DT) {
108     ExclInvs.insert(NewExcl);
109   }
110 };
111 } // end anonymous namespace
112
113 // Given the provided Value and, potentially, a context instruction, return
114 // the preferred context instruction (if any).
115 static const Instruction *safeCxtI(const Value *V, const Instruction *CxtI) {
116   // If we've been provided with a context instruction, then use that (provided
117   // it has been inserted).
118   if (CxtI && CxtI->getParent())
119     return CxtI;
120
121   // If the value is really an already-inserted instruction, then use that.
122   CxtI = dyn_cast<Instruction>(V);
123   if (CxtI && CxtI->getParent())
124     return CxtI;
125
126   return nullptr;
127 }
128
129 static void computeKnownBits(Value *V, APInt &KnownZero, APInt &KnownOne,
130                              const DataLayout &DL, unsigned Depth,
131                              const Query &Q);
132
133 void llvm::computeKnownBits(Value *V, APInt &KnownZero, APInt &KnownOne,
134                             const DataLayout &DL, unsigned Depth,
135                             AssumptionCache *AC, const Instruction *CxtI,
136                             const DominatorTree *DT) {
137   ::computeKnownBits(V, KnownZero, KnownOne, DL, Depth,
138                      Query(AC, safeCxtI(V, CxtI), DT));
139 }
140
141 bool llvm::haveNoCommonBitsSet(Value *LHS, Value *RHS, const DataLayout &DL,
142                                AssumptionCache *AC, const Instruction *CxtI,
143                                const DominatorTree *DT) {
144   assert(LHS->getType() == RHS->getType() &&
145          "LHS and RHS should have the same type");
146   assert(LHS->getType()->isIntOrIntVectorTy() &&
147          "LHS and RHS should be integers");
148   IntegerType *IT = cast<IntegerType>(LHS->getType()->getScalarType());
149   APInt LHSKnownZero(IT->getBitWidth(), 0), LHSKnownOne(IT->getBitWidth(), 0);
150   APInt RHSKnownZero(IT->getBitWidth(), 0), RHSKnownOne(IT->getBitWidth(), 0);
151   computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, DL, 0, AC, CxtI, DT);
152   computeKnownBits(RHS, RHSKnownZero, RHSKnownOne, DL, 0, AC, CxtI, DT);
153   return (LHSKnownZero | RHSKnownZero).isAllOnesValue();
154 }
155
156 static void ComputeSignBit(Value *V, bool &KnownZero, bool &KnownOne,
157                            const DataLayout &DL, unsigned Depth,
158                            const Query &Q);
159
160 void llvm::ComputeSignBit(Value *V, bool &KnownZero, bool &KnownOne,
161                           const DataLayout &DL, unsigned Depth,
162                           AssumptionCache *AC, const Instruction *CxtI,
163                           const DominatorTree *DT) {
164   ::ComputeSignBit(V, KnownZero, KnownOne, DL, Depth,
165                    Query(AC, safeCxtI(V, CxtI), DT));
166 }
167
168 static bool isKnownToBeAPowerOfTwo(Value *V, bool OrZero, unsigned Depth,
169                                    const Query &Q, const DataLayout &DL);
170
171 bool llvm::isKnownToBeAPowerOfTwo(Value *V, const DataLayout &DL, bool OrZero,
172                                   unsigned Depth, AssumptionCache *AC,
173                                   const Instruction *CxtI,
174                                   const DominatorTree *DT) {
175   return ::isKnownToBeAPowerOfTwo(V, OrZero, Depth,
176                                   Query(AC, safeCxtI(V, CxtI), DT), DL);
177 }
178
179 static bool isKnownNonZero(Value *V, const DataLayout &DL, unsigned Depth,
180                            const Query &Q);
181
182 bool llvm::isKnownNonZero(Value *V, const DataLayout &DL, unsigned Depth,
183                           AssumptionCache *AC, const Instruction *CxtI,
184                           const DominatorTree *DT) {
185   return ::isKnownNonZero(V, DL, Depth, Query(AC, safeCxtI(V, CxtI), DT));
186 }
187
188 bool llvm::isKnownNonNegative(Value *V, const DataLayout &DL, unsigned Depth,
189                               AssumptionCache *AC, const Instruction *CxtI,
190                               const DominatorTree *DT) {
191   bool NonNegative, Negative;
192   ComputeSignBit(V, NonNegative, Negative, DL, Depth, AC, CxtI, DT);
193   return NonNegative;
194 }
195
196 static bool MaskedValueIsZero(Value *V, const APInt &Mask, const DataLayout &DL,
197                               unsigned Depth, const Query &Q);
198
199 bool llvm::MaskedValueIsZero(Value *V, const APInt &Mask, const DataLayout &DL,
200                              unsigned Depth, AssumptionCache *AC,
201                              const Instruction *CxtI, const DominatorTree *DT) {
202   return ::MaskedValueIsZero(V, Mask, DL, Depth,
203                              Query(AC, safeCxtI(V, CxtI), DT));
204 }
205
206 static unsigned ComputeNumSignBits(Value *V, const DataLayout &DL,
207                                    unsigned Depth, const Query &Q);
208
209 unsigned llvm::ComputeNumSignBits(Value *V, const DataLayout &DL,
210                                   unsigned Depth, AssumptionCache *AC,
211                                   const Instruction *CxtI,
212                                   const DominatorTree *DT) {
213   return ::ComputeNumSignBits(V, DL, Depth, Query(AC, safeCxtI(V, CxtI), DT));
214 }
215
216 static void computeKnownBitsAddSub(bool Add, Value *Op0, Value *Op1, bool NSW,
217                                    APInt &KnownZero, APInt &KnownOne,
218                                    APInt &KnownZero2, APInt &KnownOne2,
219                                    const DataLayout &DL, unsigned Depth,
220                                    const Query &Q) {
221   if (!Add) {
222     if (ConstantInt *CLHS = dyn_cast<ConstantInt>(Op0)) {
223       // We know that the top bits of C-X are clear if X contains less bits
224       // than C (i.e. no wrap-around can happen).  For example, 20-X is
225       // positive if we can prove that X is >= 0 and < 16.
226       if (!CLHS->getValue().isNegative()) {
227         unsigned BitWidth = KnownZero.getBitWidth();
228         unsigned NLZ = (CLHS->getValue()+1).countLeadingZeros();
229         // NLZ can't be BitWidth with no sign bit
230         APInt MaskV = APInt::getHighBitsSet(BitWidth, NLZ+1);
231         computeKnownBits(Op1, KnownZero2, KnownOne2, DL, Depth + 1, Q);
232
233         // If all of the MaskV bits are known to be zero, then we know the
234         // output top bits are zero, because we now know that the output is
235         // from [0-C].
236         if ((KnownZero2 & MaskV) == MaskV) {
237           unsigned NLZ2 = CLHS->getValue().countLeadingZeros();
238           // Top bits known zero.
239           KnownZero = APInt::getHighBitsSet(BitWidth, NLZ2);
240         }
241       }
242     }
243   }
244
245   unsigned BitWidth = KnownZero.getBitWidth();
246
247   // If an initial sequence of bits in the result is not needed, the
248   // corresponding bits in the operands are not needed.
249   APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
250   computeKnownBits(Op0, LHSKnownZero, LHSKnownOne, DL, Depth + 1, Q);
251   computeKnownBits(Op1, KnownZero2, KnownOne2, DL, Depth + 1, Q);
252
253   // Carry in a 1 for a subtract, rather than a 0.
254   APInt CarryIn(BitWidth, 0);
255   if (!Add) {
256     // Sum = LHS + ~RHS + 1
257     std::swap(KnownZero2, KnownOne2);
258     CarryIn.setBit(0);
259   }
260
261   APInt PossibleSumZero = ~LHSKnownZero + ~KnownZero2 + CarryIn;
262   APInt PossibleSumOne = LHSKnownOne + KnownOne2 + CarryIn;
263
264   // Compute known bits of the carry.
265   APInt CarryKnownZero = ~(PossibleSumZero ^ LHSKnownZero ^ KnownZero2);
266   APInt CarryKnownOne = PossibleSumOne ^ LHSKnownOne ^ KnownOne2;
267
268   // Compute set of known bits (where all three relevant bits are known).
269   APInt LHSKnown = LHSKnownZero | LHSKnownOne;
270   APInt RHSKnown = KnownZero2 | KnownOne2;
271   APInt CarryKnown = CarryKnownZero | CarryKnownOne;
272   APInt Known = LHSKnown & RHSKnown & CarryKnown;
273
274   assert((PossibleSumZero & Known) == (PossibleSumOne & Known) &&
275          "known bits of sum differ");
276
277   // Compute known bits of the result.
278   KnownZero = ~PossibleSumOne & Known;
279   KnownOne = PossibleSumOne & Known;
280
281   // Are we still trying to solve for the sign bit?
282   if (!Known.isNegative()) {
283     if (NSW) {
284       // Adding two non-negative numbers, or subtracting a negative number from
285       // a non-negative one, can't wrap into negative.
286       if (LHSKnownZero.isNegative() && KnownZero2.isNegative())
287         KnownZero |= APInt::getSignBit(BitWidth);
288       // Adding two negative numbers, or subtracting a non-negative number from
289       // a negative one, can't wrap into non-negative.
290       else if (LHSKnownOne.isNegative() && KnownOne2.isNegative())
291         KnownOne |= APInt::getSignBit(BitWidth);
292     }
293   }
294 }
295
296 static void computeKnownBitsMul(Value *Op0, Value *Op1, bool NSW,
297                                 APInt &KnownZero, APInt &KnownOne,
298                                 APInt &KnownZero2, APInt &KnownOne2,
299                                 const DataLayout &DL, unsigned Depth,
300                                 const Query &Q) {
301   unsigned BitWidth = KnownZero.getBitWidth();
302   computeKnownBits(Op1, KnownZero, KnownOne, DL, Depth + 1, Q);
303   computeKnownBits(Op0, KnownZero2, KnownOne2, DL, Depth + 1, Q);
304
305   bool isKnownNegative = false;
306   bool isKnownNonNegative = false;
307   // If the multiplication is known not to overflow, compute the sign bit.
308   if (NSW) {
309     if (Op0 == Op1) {
310       // The product of a number with itself is non-negative.
311       isKnownNonNegative = true;
312     } else {
313       bool isKnownNonNegativeOp1 = KnownZero.isNegative();
314       bool isKnownNonNegativeOp0 = KnownZero2.isNegative();
315       bool isKnownNegativeOp1 = KnownOne.isNegative();
316       bool isKnownNegativeOp0 = KnownOne2.isNegative();
317       // The product of two numbers with the same sign is non-negative.
318       isKnownNonNegative = (isKnownNegativeOp1 && isKnownNegativeOp0) ||
319         (isKnownNonNegativeOp1 && isKnownNonNegativeOp0);
320       // The product of a negative number and a non-negative number is either
321       // negative or zero.
322       if (!isKnownNonNegative)
323         isKnownNegative = (isKnownNegativeOp1 && isKnownNonNegativeOp0 &&
324                            isKnownNonZero(Op0, DL, Depth, Q)) ||
325                           (isKnownNegativeOp0 && isKnownNonNegativeOp1 &&
326                            isKnownNonZero(Op1, DL, Depth, Q));
327     }
328   }
329
330   // If low bits are zero in either operand, output low known-0 bits.
331   // Also compute a conservative estimate for high known-0 bits.
332   // More trickiness is possible, but this is sufficient for the
333   // interesting case of alignment computation.
334   KnownOne.clearAllBits();
335   unsigned TrailZ = KnownZero.countTrailingOnes() +
336                     KnownZero2.countTrailingOnes();
337   unsigned LeadZ =  std::max(KnownZero.countLeadingOnes() +
338                              KnownZero2.countLeadingOnes(),
339                              BitWidth) - BitWidth;
340
341   TrailZ = std::min(TrailZ, BitWidth);
342   LeadZ = std::min(LeadZ, BitWidth);
343   KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ) |
344               APInt::getHighBitsSet(BitWidth, LeadZ);
345
346   // Only make use of no-wrap flags if we failed to compute the sign bit
347   // directly.  This matters if the multiplication always overflows, in
348   // which case we prefer to follow the result of the direct computation,
349   // though as the program is invoking undefined behaviour we can choose
350   // whatever we like here.
351   if (isKnownNonNegative && !KnownOne.isNegative())
352     KnownZero.setBit(BitWidth - 1);
353   else if (isKnownNegative && !KnownZero.isNegative())
354     KnownOne.setBit(BitWidth - 1);
355 }
356
357 void llvm::computeKnownBitsFromRangeMetadata(const MDNode &Ranges,
358                                              APInt &KnownZero) {
359   unsigned BitWidth = KnownZero.getBitWidth();
360   unsigned NumRanges = Ranges.getNumOperands() / 2;
361   assert(NumRanges >= 1);
362
363   // Use the high end of the ranges to find leading zeros.
364   unsigned MinLeadingZeros = BitWidth;
365   for (unsigned i = 0; i < NumRanges; ++i) {
366     ConstantInt *Lower =
367         mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 0));
368     ConstantInt *Upper =
369         mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 1));
370     ConstantRange Range(Lower->getValue(), Upper->getValue());
371     if (Range.isWrappedSet())
372       MinLeadingZeros = 0; // -1 has no zeros
373     unsigned LeadingZeros = (Upper->getValue() - 1).countLeadingZeros();
374     MinLeadingZeros = std::min(LeadingZeros, MinLeadingZeros);
375   }
376
377   KnownZero = APInt::getHighBitsSet(BitWidth, MinLeadingZeros);
378 }
379
380 static bool isEphemeralValueOf(Instruction *I, const Value *E) {
381   SmallVector<const Value *, 16> WorkSet(1, I);
382   SmallPtrSet<const Value *, 32> Visited;
383   SmallPtrSet<const Value *, 16> EphValues;
384
385   while (!WorkSet.empty()) {
386     const Value *V = WorkSet.pop_back_val();
387     if (!Visited.insert(V).second)
388       continue;
389
390     // If all uses of this value are ephemeral, then so is this value.
391     bool FoundNEUse = false;
392     for (const User *I : V->users())
393       if (!EphValues.count(I)) {
394         FoundNEUse = true;
395         break;
396       }
397
398     if (!FoundNEUse) {
399       if (V == E)
400         return true;
401
402       EphValues.insert(V);
403       if (const User *U = dyn_cast<User>(V))
404         for (User::const_op_iterator J = U->op_begin(), JE = U->op_end();
405              J != JE; ++J) {
406           if (isSafeToSpeculativelyExecute(*J))
407             WorkSet.push_back(*J);
408         }
409     }
410   }
411
412   return false;
413 }
414
415 // Is this an intrinsic that cannot be speculated but also cannot trap?
416 static bool isAssumeLikeIntrinsic(const Instruction *I) {
417   if (const CallInst *CI = dyn_cast<CallInst>(I))
418     if (Function *F = CI->getCalledFunction())
419       switch (F->getIntrinsicID()) {
420       default: break;
421       // FIXME: This list is repeated from NoTTI::getIntrinsicCost.
422       case Intrinsic::assume:
423       case Intrinsic::dbg_declare:
424       case Intrinsic::dbg_value:
425       case Intrinsic::invariant_start:
426       case Intrinsic::invariant_end:
427       case Intrinsic::lifetime_start:
428       case Intrinsic::lifetime_end:
429       case Intrinsic::objectsize:
430       case Intrinsic::ptr_annotation:
431       case Intrinsic::var_annotation:
432         return true;
433       }
434
435   return false;
436 }
437
438 static bool isValidAssumeForContext(Value *V, const Query &Q) {
439   Instruction *Inv = cast<Instruction>(V);
440
441   // There are two restrictions on the use of an assume:
442   //  1. The assume must dominate the context (or the control flow must
443   //     reach the assume whenever it reaches the context).
444   //  2. The context must not be in the assume's set of ephemeral values
445   //     (otherwise we will use the assume to prove that the condition
446   //     feeding the assume is trivially true, thus causing the removal of
447   //     the assume).
448
449   if (Q.DT) {
450     if (Q.DT->dominates(Inv, Q.CxtI)) {
451       return true;
452     } else if (Inv->getParent() == Q.CxtI->getParent()) {
453       // The context comes first, but they're both in the same block. Make sure
454       // there is nothing in between that might interrupt the control flow.
455       for (BasicBlock::const_iterator I =
456              std::next(BasicBlock::const_iterator(Q.CxtI)),
457                                       IE(Inv); I != IE; ++I)
458         if (!isSafeToSpeculativelyExecute(I) && !isAssumeLikeIntrinsic(I))
459           return false;
460
461       return !isEphemeralValueOf(Inv, Q.CxtI);
462     }
463
464     return false;
465   }
466
467   // When we don't have a DT, we do a limited search...
468   if (Inv->getParent() == Q.CxtI->getParent()->getSinglePredecessor()) {
469     return true;
470   } else if (Inv->getParent() == Q.CxtI->getParent()) {
471     // Search forward from the assume until we reach the context (or the end
472     // of the block); the common case is that the assume will come first.
473     for (BasicBlock::iterator I = std::next(BasicBlock::iterator(Inv)),
474          IE = Inv->getParent()->end(); I != IE; ++I)
475       if (I == Q.CxtI)
476         return true;
477
478     // The context must come first...
479     for (BasicBlock::const_iterator I =
480            std::next(BasicBlock::const_iterator(Q.CxtI)),
481                                     IE(Inv); I != IE; ++I)
482       if (!isSafeToSpeculativelyExecute(I) && !isAssumeLikeIntrinsic(I))
483         return false;
484
485     return !isEphemeralValueOf(Inv, Q.CxtI);
486   }
487
488   return false;
489 }
490
491 bool llvm::isValidAssumeForContext(const Instruction *I,
492                                    const Instruction *CxtI,
493                                    const DominatorTree *DT) {
494   return ::isValidAssumeForContext(const_cast<Instruction *>(I),
495                                    Query(nullptr, CxtI, DT));
496 }
497
498 template<typename LHS, typename RHS>
499 inline match_combine_or<CmpClass_match<LHS, RHS, ICmpInst, ICmpInst::Predicate>,
500                         CmpClass_match<RHS, LHS, ICmpInst, ICmpInst::Predicate>>
501 m_c_ICmp(ICmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
502   return m_CombineOr(m_ICmp(Pred, L, R), m_ICmp(Pred, R, L));
503 }
504
505 template<typename LHS, typename RHS>
506 inline match_combine_or<BinaryOp_match<LHS, RHS, Instruction::And>,
507                         BinaryOp_match<RHS, LHS, Instruction::And>>
508 m_c_And(const LHS &L, const RHS &R) {
509   return m_CombineOr(m_And(L, R), m_And(R, L));
510 }
511
512 template<typename LHS, typename RHS>
513 inline match_combine_or<BinaryOp_match<LHS, RHS, Instruction::Or>,
514                         BinaryOp_match<RHS, LHS, Instruction::Or>>
515 m_c_Or(const LHS &L, const RHS &R) {
516   return m_CombineOr(m_Or(L, R), m_Or(R, L));
517 }
518
519 template<typename LHS, typename RHS>
520 inline match_combine_or<BinaryOp_match<LHS, RHS, Instruction::Xor>,
521                         BinaryOp_match<RHS, LHS, Instruction::Xor>>
522 m_c_Xor(const LHS &L, const RHS &R) {
523   return m_CombineOr(m_Xor(L, R), m_Xor(R, L));
524 }
525
526 /// Compute known bits in 'V' under the assumption that the condition 'Cmp' is
527 /// true (at the context instruction.)  This is mostly a utility function for
528 /// the prototype dominating conditions reasoning below.
529 static void computeKnownBitsFromTrueCondition(Value *V, ICmpInst *Cmp,
530                                               APInt &KnownZero,
531                                               APInt &KnownOne,
532                                               const DataLayout &DL,
533                                               unsigned Depth, const Query &Q) {
534   Value *LHS = Cmp->getOperand(0);
535   Value *RHS = Cmp->getOperand(1);
536   // TODO: We could potentially be more aggressive here.  This would be worth
537   // evaluating.  If we can, explore commoning this code with the assume
538   // handling logic.
539   if (LHS != V && RHS != V)
540     return;
541
542   const unsigned BitWidth = KnownZero.getBitWidth();
543
544   switch (Cmp->getPredicate()) {
545   default:
546     // We know nothing from this condition
547     break;
548   // TODO: implement unsigned bound from below (known one bits)
549   // TODO: common condition check implementations with assumes
550   // TODO: implement other patterns from assume (e.g. V & B == A)
551   case ICmpInst::ICMP_SGT:
552     if (LHS == V) {
553       APInt KnownZeroTemp(BitWidth, 0), KnownOneTemp(BitWidth, 0);
554       computeKnownBits(RHS, KnownZeroTemp, KnownOneTemp, DL, Depth + 1, Q);
555       if (KnownOneTemp.isAllOnesValue() || KnownZeroTemp.isNegative()) {
556         // We know that the sign bit is zero.
557         KnownZero |= APInt::getSignBit(BitWidth);
558       }
559     }
560     break;
561   case ICmpInst::ICMP_EQ:
562     {
563       APInt KnownZeroTemp(BitWidth, 0), KnownOneTemp(BitWidth, 0);
564       if (LHS == V)
565         computeKnownBits(RHS, KnownZeroTemp, KnownOneTemp, DL, Depth + 1, Q);
566       else if (RHS == V)
567         computeKnownBits(LHS, KnownZeroTemp, KnownOneTemp, DL, Depth + 1, Q);
568       else
569         llvm_unreachable("missing use?");
570       KnownZero |= KnownZeroTemp;
571       KnownOne |= KnownOneTemp;
572     }
573     break;
574   case ICmpInst::ICMP_ULE:
575     if (LHS == V) {
576       APInt KnownZeroTemp(BitWidth, 0), KnownOneTemp(BitWidth, 0);
577       computeKnownBits(RHS, KnownZeroTemp, KnownOneTemp, DL, Depth + 1, Q);
578       // The known zero bits carry over
579       unsigned SignBits = KnownZeroTemp.countLeadingOnes();
580       KnownZero |= APInt::getHighBitsSet(BitWidth, SignBits);
581     }
582     break;
583   case ICmpInst::ICMP_ULT:
584     if (LHS == V) {
585       APInt KnownZeroTemp(BitWidth, 0), KnownOneTemp(BitWidth, 0);
586       computeKnownBits(RHS, KnownZeroTemp, KnownOneTemp, DL, Depth + 1, Q);
587       // Whatever high bits in rhs are zero are known to be zero (if rhs is a
588       // power of 2, then one more).
589       unsigned SignBits = KnownZeroTemp.countLeadingOnes();
590       if (isKnownToBeAPowerOfTwo(RHS, false, Depth + 1, Query(Q, Cmp), DL))
591         SignBits++;
592       KnownZero |= APInt::getHighBitsSet(BitWidth, SignBits);
593     }
594     break;
595   };
596 }
597
598 /// Compute known bits in 'V' from conditions which are known to be true along
599 /// all paths leading to the context instruction.  In particular, look for
600 /// cases where one branch of an interesting condition dominates the context
601 /// instruction.  This does not do general dataflow.
602 /// NOTE: This code is EXPERIMENTAL and currently off by default.
603 static void computeKnownBitsFromDominatingCondition(Value *V, APInt &KnownZero,
604                                                     APInt &KnownOne,
605                                                     const DataLayout &DL,
606                                                     unsigned Depth,
607                                                     const Query &Q) {
608   // Need both the dominator tree and the query location to do anything useful
609   if (!Q.DT || !Q.CxtI)
610     return;
611   Instruction *Cxt = const_cast<Instruction *>(Q.CxtI);
612   // The context instruction might be in a statically unreachable block.  If
613   // so, asking dominator queries may yield suprising results.  (e.g. the block
614   // may not have a dom tree node)
615   if (!Q.DT->isReachableFromEntry(Cxt->getParent()))
616     return;
617
618   // Avoid useless work
619   if (auto VI = dyn_cast<Instruction>(V))
620     if (VI->getParent() == Cxt->getParent())
621       return;
622
623   // Note: We currently implement two options.  It's not clear which of these
624   // will survive long term, we need data for that.
625   // Option 1 - Try walking the dominator tree looking for conditions which
626   // might apply.  This works well for local conditions (loop guards, etc..),
627   // but not as well for things far from the context instruction (presuming a
628   // low max blocks explored).  If we can set an high enough limit, this would
629   // be all we need.
630   // Option 2 - We restrict out search to those conditions which are uses of
631   // the value we're interested in.  This is independent of dom structure,
632   // but is slightly less powerful without looking through lots of use chains.
633   // It does handle conditions far from the context instruction (e.g. early
634   // function exits on entry) really well though.
635
636   // Option 1 - Search the dom tree
637   unsigned NumBlocksExplored = 0;
638   BasicBlock *Current = Cxt->getParent();
639   while (true) {
640     // Stop searching if we've gone too far up the chain
641     if (NumBlocksExplored >= DomConditionsMaxDomBlocks)
642       break;
643     NumBlocksExplored++;
644
645     if (!Q.DT->getNode(Current)->getIDom())
646       break;
647     Current = Q.DT->getNode(Current)->getIDom()->getBlock();
648     if (!Current)
649       // found function entry
650       break;
651
652     BranchInst *BI = dyn_cast<BranchInst>(Current->getTerminator());
653     if (!BI || BI->isUnconditional())
654       continue;
655     ICmpInst *Cmp = dyn_cast<ICmpInst>(BI->getCondition());
656     if (!Cmp)
657       continue;
658
659     // We're looking for conditions that are guaranteed to hold at the context
660     // instruction.  Finding a condition where one path dominates the context
661     // isn't enough because both the true and false cases could merge before
662     // the context instruction we're actually interested in.  Instead, we need
663     // to ensure that the taken *edge* dominates the context instruction.  We
664     // know that the edge must be reachable since we started from a reachable
665     // block.
666     BasicBlock *BB0 = BI->getSuccessor(0);
667     BasicBlockEdge Edge(BI->getParent(), BB0);
668     if (!Edge.isSingleEdge() || !Q.DT->dominates(Edge, Q.CxtI->getParent()))
669       continue;
670
671     computeKnownBitsFromTrueCondition(V, Cmp, KnownZero, KnownOne, DL, Depth,
672                                       Q);
673   }
674
675   // Option 2 - Search the other uses of V
676   unsigned NumUsesExplored = 0;
677   for (auto U : V->users()) {
678     // Avoid massive lists
679     if (NumUsesExplored >= DomConditionsMaxUses)
680       break;
681     NumUsesExplored++;
682     // Consider only compare instructions uniquely controlling a branch
683     ICmpInst *Cmp = dyn_cast<ICmpInst>(U);
684     if (!Cmp)
685       continue;
686
687     if (DomConditionsSingleCmpUse && !Cmp->hasOneUse())
688       continue;
689
690     for (auto *CmpU : Cmp->users()) {
691       BranchInst *BI = dyn_cast<BranchInst>(CmpU);
692       if (!BI || BI->isUnconditional())
693         continue;
694       // We're looking for conditions that are guaranteed to hold at the
695       // context instruction.  Finding a condition where one path dominates
696       // the context isn't enough because both the true and false cases could
697       // merge before the context instruction we're actually interested in.
698       // Instead, we need to ensure that the taken *edge* dominates the context
699       // instruction. 
700       BasicBlock *BB0 = BI->getSuccessor(0);
701       BasicBlockEdge Edge(BI->getParent(), BB0);
702       if (!Edge.isSingleEdge() || !Q.DT->dominates(Edge, Q.CxtI->getParent()))
703         continue;
704
705       computeKnownBitsFromTrueCondition(V, Cmp, KnownZero, KnownOne, DL, Depth,
706                                         Q);
707     }
708   }
709 }
710
711 static void computeKnownBitsFromAssume(Value *V, APInt &KnownZero,
712                                        APInt &KnownOne, const DataLayout &DL,
713                                        unsigned Depth, const Query &Q) {
714   // Use of assumptions is context-sensitive. If we don't have a context, we
715   // cannot use them!
716   if (!Q.AC || !Q.CxtI)
717     return;
718
719   unsigned BitWidth = KnownZero.getBitWidth();
720
721   for (auto &AssumeVH : Q.AC->assumptions()) {
722     if (!AssumeVH)
723       continue;
724     CallInst *I = cast<CallInst>(AssumeVH);
725     assert(I->getParent()->getParent() == Q.CxtI->getParent()->getParent() &&
726            "Got assumption for the wrong function!");
727     if (Q.ExclInvs.count(I))
728       continue;
729
730     // Warning: This loop can end up being somewhat performance sensetive.
731     // We're running this loop for once for each value queried resulting in a
732     // runtime of ~O(#assumes * #values).
733
734     assert(I->getCalledFunction()->getIntrinsicID() == Intrinsic::assume &&
735            "must be an assume intrinsic");
736
737     Value *Arg = I->getArgOperand(0);
738
739     if (Arg == V && isValidAssumeForContext(I, Q)) {
740       assert(BitWidth == 1 && "assume operand is not i1?");
741       KnownZero.clearAllBits();
742       KnownOne.setAllBits();
743       return;
744     }
745
746     // The remaining tests are all recursive, so bail out if we hit the limit.
747     if (Depth == MaxDepth)
748       continue;
749
750     Value *A, *B;
751     auto m_V = m_CombineOr(m_Specific(V),
752                            m_CombineOr(m_PtrToInt(m_Specific(V)),
753                            m_BitCast(m_Specific(V))));
754
755     CmpInst::Predicate Pred;
756     ConstantInt *C;
757     // assume(v = a)
758     if (match(Arg, m_c_ICmp(Pred, m_V, m_Value(A))) &&
759         Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
760       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
761       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
762       KnownZero |= RHSKnownZero;
763       KnownOne  |= RHSKnownOne;
764     // assume(v & b = a)
765     } else if (match(Arg,
766                      m_c_ICmp(Pred, m_c_And(m_V, m_Value(B)), m_Value(A))) &&
767                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
768       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
769       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
770       APInt MaskKnownZero(BitWidth, 0), MaskKnownOne(BitWidth, 0);
771       computeKnownBits(B, MaskKnownZero, MaskKnownOne, DL, Depth+1, Query(Q, I));
772
773       // For those bits in the mask that are known to be one, we can propagate
774       // known bits from the RHS to V.
775       KnownZero |= RHSKnownZero & MaskKnownOne;
776       KnownOne  |= RHSKnownOne  & MaskKnownOne;
777     // assume(~(v & b) = a)
778     } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_And(m_V, m_Value(B))),
779                                    m_Value(A))) &&
780                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
781       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
782       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
783       APInt MaskKnownZero(BitWidth, 0), MaskKnownOne(BitWidth, 0);
784       computeKnownBits(B, MaskKnownZero, MaskKnownOne, DL, Depth+1, Query(Q, I));
785
786       // For those bits in the mask that are known to be one, we can propagate
787       // inverted known bits from the RHS to V.
788       KnownZero |= RHSKnownOne  & MaskKnownOne;
789       KnownOne  |= RHSKnownZero & MaskKnownOne;
790     // assume(v | b = a)
791     } else if (match(Arg,
792                      m_c_ICmp(Pred, m_c_Or(m_V, m_Value(B)), m_Value(A))) &&
793                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
794       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
795       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
796       APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
797       computeKnownBits(B, BKnownZero, BKnownOne, DL, Depth+1, Query(Q, I));
798
799       // For those bits in B that are known to be zero, we can propagate known
800       // bits from the RHS to V.
801       KnownZero |= RHSKnownZero & BKnownZero;
802       KnownOne  |= RHSKnownOne  & BKnownZero;
803     // assume(~(v | b) = a)
804     } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Or(m_V, m_Value(B))),
805                                    m_Value(A))) &&
806                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
807       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
808       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
809       APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
810       computeKnownBits(B, BKnownZero, BKnownOne, DL, Depth+1, Query(Q, I));
811
812       // For those bits in B that are known to be zero, we can propagate
813       // inverted known bits from the RHS to V.
814       KnownZero |= RHSKnownOne  & BKnownZero;
815       KnownOne  |= RHSKnownZero & BKnownZero;
816     // assume(v ^ b = a)
817     } else if (match(Arg,
818                      m_c_ICmp(Pred, m_c_Xor(m_V, m_Value(B)), m_Value(A))) &&
819                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
820       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
821       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
822       APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
823       computeKnownBits(B, BKnownZero, BKnownOne, DL, Depth+1, Query(Q, I));
824
825       // For those bits in B that are known to be zero, we can propagate known
826       // bits from the RHS to V. For those bits in B that are known to be one,
827       // we can propagate inverted known bits from the RHS to V.
828       KnownZero |= RHSKnownZero & BKnownZero;
829       KnownOne  |= RHSKnownOne  & BKnownZero;
830       KnownZero |= RHSKnownOne  & BKnownOne;
831       KnownOne  |= RHSKnownZero & BKnownOne;
832     // assume(~(v ^ b) = a)
833     } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Xor(m_V, m_Value(B))),
834                                    m_Value(A))) &&
835                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
836       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
837       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
838       APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
839       computeKnownBits(B, BKnownZero, BKnownOne, DL, Depth+1, Query(Q, I));
840
841       // For those bits in B that are known to be zero, we can propagate
842       // inverted known bits from the RHS to V. For those bits in B that are
843       // known to be one, we can propagate known bits from the RHS to V.
844       KnownZero |= RHSKnownOne  & BKnownZero;
845       KnownOne  |= RHSKnownZero & BKnownZero;
846       KnownZero |= RHSKnownZero & BKnownOne;
847       KnownOne  |= RHSKnownOne  & BKnownOne;
848     // assume(v << c = a)
849     } else if (match(Arg, m_c_ICmp(Pred, m_Shl(m_V, m_ConstantInt(C)),
850                                    m_Value(A))) &&
851                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
852       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
853       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
854       // For those bits in RHS that are known, we can propagate them to known
855       // bits in V shifted to the right by C.
856       KnownZero |= RHSKnownZero.lshr(C->getZExtValue());
857       KnownOne  |= RHSKnownOne.lshr(C->getZExtValue());
858     // assume(~(v << c) = a)
859     } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_Shl(m_V, m_ConstantInt(C))),
860                                    m_Value(A))) &&
861                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
862       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
863       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
864       // For those bits in RHS that are known, we can propagate them inverted
865       // to known bits in V shifted to the right by C.
866       KnownZero |= RHSKnownOne.lshr(C->getZExtValue());
867       KnownOne  |= RHSKnownZero.lshr(C->getZExtValue());
868     // assume(v >> c = a)
869     } else if (match(Arg,
870                      m_c_ICmp(Pred, m_CombineOr(m_LShr(m_V, m_ConstantInt(C)),
871                                                 m_AShr(m_V, m_ConstantInt(C))),
872                               m_Value(A))) &&
873                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
874       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
875       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
876       // For those bits in RHS that are known, we can propagate them to known
877       // bits in V shifted to the right by C.
878       KnownZero |= RHSKnownZero << C->getZExtValue();
879       KnownOne  |= RHSKnownOne  << C->getZExtValue();
880     // assume(~(v >> c) = a)
881     } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_CombineOr(
882                                              m_LShr(m_V, m_ConstantInt(C)),
883                                              m_AShr(m_V, m_ConstantInt(C)))),
884                                    m_Value(A))) &&
885                Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q)) {
886       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
887       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
888       // For those bits in RHS that are known, we can propagate them inverted
889       // to known bits in V shifted to the right by C.
890       KnownZero |= RHSKnownOne  << C->getZExtValue();
891       KnownOne  |= RHSKnownZero << C->getZExtValue();
892     // assume(v >=_s c) where c is non-negative
893     } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
894                Pred == ICmpInst::ICMP_SGE && isValidAssumeForContext(I, Q)) {
895       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
896       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
897
898       if (RHSKnownZero.isNegative()) {
899         // We know that the sign bit is zero.
900         KnownZero |= APInt::getSignBit(BitWidth);
901       }
902     // assume(v >_s c) where c is at least -1.
903     } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
904                Pred == ICmpInst::ICMP_SGT && isValidAssumeForContext(I, Q)) {
905       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
906       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
907
908       if (RHSKnownOne.isAllOnesValue() || RHSKnownZero.isNegative()) {
909         // We know that the sign bit is zero.
910         KnownZero |= APInt::getSignBit(BitWidth);
911       }
912     // assume(v <=_s c) where c is negative
913     } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
914                Pred == ICmpInst::ICMP_SLE && isValidAssumeForContext(I, Q)) {
915       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
916       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
917
918       if (RHSKnownOne.isNegative()) {
919         // We know that the sign bit is one.
920         KnownOne |= APInt::getSignBit(BitWidth);
921       }
922     // assume(v <_s c) where c is non-positive
923     } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
924                Pred == ICmpInst::ICMP_SLT && isValidAssumeForContext(I, Q)) {
925       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
926       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
927
928       if (RHSKnownZero.isAllOnesValue() || RHSKnownOne.isNegative()) {
929         // We know that the sign bit is one.
930         KnownOne |= APInt::getSignBit(BitWidth);
931       }
932     // assume(v <=_u c)
933     } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
934                Pred == ICmpInst::ICMP_ULE && isValidAssumeForContext(I, Q)) {
935       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
936       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
937
938       // Whatever high bits in c are zero are known to be zero.
939       KnownZero |=
940         APInt::getHighBitsSet(BitWidth, RHSKnownZero.countLeadingOnes());
941     // assume(v <_u c)
942     } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
943                Pred == ICmpInst::ICMP_ULT && isValidAssumeForContext(I, Q)) {
944       APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
945       computeKnownBits(A, RHSKnownZero, RHSKnownOne, DL, Depth+1, Query(Q, I));
946
947       // Whatever high bits in c are zero are known to be zero (if c is a power
948       // of 2, then one more).
949       if (isKnownToBeAPowerOfTwo(A, false, Depth + 1, Query(Q, I), DL))
950         KnownZero |=
951           APInt::getHighBitsSet(BitWidth, RHSKnownZero.countLeadingOnes()+1);
952       else
953         KnownZero |=
954           APInt::getHighBitsSet(BitWidth, RHSKnownZero.countLeadingOnes());
955     }
956   }
957 }
958
959 static void computeKnownBitsFromOperator(Operator *I, APInt &KnownZero,
960                                          APInt &KnownOne, const DataLayout &DL,
961                                          unsigned Depth, const Query &Q) {
962   unsigned BitWidth = KnownZero.getBitWidth();
963
964   APInt KnownZero2(KnownZero), KnownOne2(KnownOne);
965   switch (I->getOpcode()) {
966   default: break;
967   case Instruction::Load:
968     if (MDNode *MD = cast<LoadInst>(I)->getMetadata(LLVMContext::MD_range))
969       computeKnownBitsFromRangeMetadata(*MD, KnownZero);
970     break;
971   case Instruction::And: {
972     // If either the LHS or the RHS are Zero, the result is zero.
973     computeKnownBits(I->getOperand(1), KnownZero, KnownOne, DL, Depth + 1, Q);
974     computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, DL, Depth + 1, Q);
975
976     // Output known-1 bits are only known if set in both the LHS & RHS.
977     KnownOne &= KnownOne2;
978     // Output known-0 are known to be clear if zero in either the LHS | RHS.
979     KnownZero |= KnownZero2;
980     break;
981   }
982   case Instruction::Or: {
983     computeKnownBits(I->getOperand(1), KnownZero, KnownOne, DL, Depth + 1, Q);
984     computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, DL, Depth + 1, Q);
985
986     // Output known-0 bits are only known if clear in both the LHS & RHS.
987     KnownZero &= KnownZero2;
988     // Output known-1 are known to be set if set in either the LHS | RHS.
989     KnownOne |= KnownOne2;
990     break;
991   }
992   case Instruction::Xor: {
993     computeKnownBits(I->getOperand(1), KnownZero, KnownOne, DL, Depth + 1, Q);
994     computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, DL, Depth + 1, Q);
995
996     // Output known-0 bits are known if clear or set in both the LHS & RHS.
997     APInt KnownZeroOut = (KnownZero & KnownZero2) | (KnownOne & KnownOne2);
998     // Output known-1 are known to be set if set in only one of the LHS, RHS.
999     KnownOne = (KnownZero & KnownOne2) | (KnownOne & KnownZero2);
1000     KnownZero = KnownZeroOut;
1001     break;
1002   }
1003   case Instruction::Mul: {
1004     bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
1005     computeKnownBitsMul(I->getOperand(0), I->getOperand(1), NSW, KnownZero,
1006                         KnownOne, KnownZero2, KnownOne2, DL, Depth, Q);
1007     break;
1008   }
1009   case Instruction::UDiv: {
1010     // For the purposes of computing leading zeros we can conservatively
1011     // treat a udiv as a logical right shift by the power of 2 known to
1012     // be less than the denominator.
1013     computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, DL, Depth + 1, Q);
1014     unsigned LeadZ = KnownZero2.countLeadingOnes();
1015
1016     KnownOne2.clearAllBits();
1017     KnownZero2.clearAllBits();
1018     computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, DL, Depth + 1, Q);
1019     unsigned RHSUnknownLeadingOnes = KnownOne2.countLeadingZeros();
1020     if (RHSUnknownLeadingOnes != BitWidth)
1021       LeadZ = std::min(BitWidth,
1022                        LeadZ + BitWidth - RHSUnknownLeadingOnes - 1);
1023
1024     KnownZero = APInt::getHighBitsSet(BitWidth, LeadZ);
1025     break;
1026   }
1027   case Instruction::Select:
1028     computeKnownBits(I->getOperand(2), KnownZero, KnownOne, DL, Depth + 1, Q);
1029     computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, DL, Depth + 1, Q);
1030
1031     // Only known if known in both the LHS and RHS.
1032     KnownOne &= KnownOne2;
1033     KnownZero &= KnownZero2;
1034     break;
1035   case Instruction::FPTrunc:
1036   case Instruction::FPExt:
1037   case Instruction::FPToUI:
1038   case Instruction::FPToSI:
1039   case Instruction::SIToFP:
1040   case Instruction::UIToFP:
1041     break; // Can't work with floating point.
1042   case Instruction::PtrToInt:
1043   case Instruction::IntToPtr:
1044   case Instruction::AddrSpaceCast: // Pointers could be different sizes.
1045     // FALL THROUGH and handle them the same as zext/trunc.
1046   case Instruction::ZExt:
1047   case Instruction::Trunc: {
1048     Type *SrcTy = I->getOperand(0)->getType();
1049
1050     unsigned SrcBitWidth;
1051     // Note that we handle pointer operands here because of inttoptr/ptrtoint
1052     // which fall through here.
1053     SrcBitWidth = DL.getTypeSizeInBits(SrcTy->getScalarType());
1054
1055     assert(SrcBitWidth && "SrcBitWidth can't be zero");
1056     KnownZero = KnownZero.zextOrTrunc(SrcBitWidth);
1057     KnownOne = KnownOne.zextOrTrunc(SrcBitWidth);
1058     computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1, Q);
1059     KnownZero = KnownZero.zextOrTrunc(BitWidth);
1060     KnownOne = KnownOne.zextOrTrunc(BitWidth);
1061     // Any top bits are known to be zero.
1062     if (BitWidth > SrcBitWidth)
1063       KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
1064     break;
1065   }
1066   case Instruction::BitCast: {
1067     Type *SrcTy = I->getOperand(0)->getType();
1068     if ((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
1069         // TODO: For now, not handling conversions like:
1070         // (bitcast i64 %x to <2 x i32>)
1071         !I->getType()->isVectorTy()) {
1072       computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1, Q);
1073       break;
1074     }
1075     break;
1076   }
1077   case Instruction::SExt: {
1078     // Compute the bits in the result that are not present in the input.
1079     unsigned SrcBitWidth = I->getOperand(0)->getType()->getScalarSizeInBits();
1080
1081     KnownZero = KnownZero.trunc(SrcBitWidth);
1082     KnownOne = KnownOne.trunc(SrcBitWidth);
1083     computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1, Q);
1084     KnownZero = KnownZero.zext(BitWidth);
1085     KnownOne = KnownOne.zext(BitWidth);
1086
1087     // If the sign bit of the input is known set or clear, then we know the
1088     // top bits of the result.
1089     if (KnownZero[SrcBitWidth-1])             // Input sign bit known zero
1090       KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
1091     else if (KnownOne[SrcBitWidth-1])           // Input sign bit known set
1092       KnownOne |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
1093     break;
1094   }
1095   case Instruction::Shl:
1096     // (shl X, C1) & C2 == 0   iff   (X & C2 >>u C1) == 0
1097     if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
1098       uint64_t ShiftAmt = SA->getLimitedValue(BitWidth);
1099       computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1, Q);
1100       KnownZero <<= ShiftAmt;
1101       KnownOne  <<= ShiftAmt;
1102       KnownZero |= APInt::getLowBitsSet(BitWidth, ShiftAmt); // low bits known 0
1103     }
1104     break;
1105   case Instruction::LShr:
1106     // (ushr X, C1) & C2 == 0   iff  (-1 >> C1) & C2 == 0
1107     if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
1108       // Compute the new bits that are at the top now.
1109       uint64_t ShiftAmt = SA->getLimitedValue(BitWidth);
1110
1111       // Unsigned shift right.
1112       computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1, Q);
1113       KnownZero = APIntOps::lshr(KnownZero, ShiftAmt);
1114       KnownOne  = APIntOps::lshr(KnownOne, ShiftAmt);
1115       // high bits known zero.
1116       KnownZero |= APInt::getHighBitsSet(BitWidth, ShiftAmt);
1117     }
1118     break;
1119   case Instruction::AShr:
1120     // (ashr X, C1) & C2 == 0   iff  (-1 >> C1) & C2 == 0
1121     if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
1122       // Compute the new bits that are at the top now.
1123       uint64_t ShiftAmt = SA->getLimitedValue(BitWidth-1);
1124
1125       // Signed shift right.
1126       computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1, Q);
1127       KnownZero = APIntOps::lshr(KnownZero, ShiftAmt);
1128       KnownOne  = APIntOps::lshr(KnownOne, ShiftAmt);
1129
1130       APInt HighBits(APInt::getHighBitsSet(BitWidth, ShiftAmt));
1131       if (KnownZero[BitWidth-ShiftAmt-1])    // New bits are known zero.
1132         KnownZero |= HighBits;
1133       else if (KnownOne[BitWidth-ShiftAmt-1])  // New bits are known one.
1134         KnownOne |= HighBits;
1135     }
1136     break;
1137   case Instruction::Sub: {
1138     bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
1139     computeKnownBitsAddSub(false, I->getOperand(0), I->getOperand(1), NSW,
1140                            KnownZero, KnownOne, KnownZero2, KnownOne2, DL,
1141                            Depth, Q);
1142     break;
1143   }
1144   case Instruction::Add: {
1145     bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
1146     computeKnownBitsAddSub(true, I->getOperand(0), I->getOperand(1), NSW,
1147                            KnownZero, KnownOne, KnownZero2, KnownOne2, DL,
1148                            Depth, Q);
1149     break;
1150   }
1151   case Instruction::SRem:
1152     if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
1153       APInt RA = Rem->getValue().abs();
1154       if (RA.isPowerOf2()) {
1155         APInt LowBits = RA - 1;
1156         computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, DL, Depth + 1,
1157                          Q);
1158
1159         // The low bits of the first operand are unchanged by the srem.
1160         KnownZero = KnownZero2 & LowBits;
1161         KnownOne = KnownOne2 & LowBits;
1162
1163         // If the first operand is non-negative or has all low bits zero, then
1164         // the upper bits are all zero.
1165         if (KnownZero2[BitWidth-1] || ((KnownZero2 & LowBits) == LowBits))
1166           KnownZero |= ~LowBits;
1167
1168         // If the first operand is negative and not all low bits are zero, then
1169         // the upper bits are all one.
1170         if (KnownOne2[BitWidth-1] && ((KnownOne2 & LowBits) != 0))
1171           KnownOne |= ~LowBits;
1172
1173         assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
1174       }
1175     }
1176
1177     // The sign bit is the LHS's sign bit, except when the result of the
1178     // remainder is zero.
1179     if (KnownZero.isNonNegative()) {
1180       APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
1181       computeKnownBits(I->getOperand(0), LHSKnownZero, LHSKnownOne, DL,
1182                        Depth + 1, Q);
1183       // If it's known zero, our sign bit is also zero.
1184       if (LHSKnownZero.isNegative())
1185         KnownZero.setBit(BitWidth - 1);
1186     }
1187
1188     break;
1189   case Instruction::URem: {
1190     if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
1191       APInt RA = Rem->getValue();
1192       if (RA.isPowerOf2()) {
1193         APInt LowBits = (RA - 1);
1194         computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1,
1195                          Q);
1196         KnownZero |= ~LowBits;
1197         KnownOne &= LowBits;
1198         break;
1199       }
1200     }
1201
1202     // Since the result is less than or equal to either operand, any leading
1203     // zero bits in either operand must also exist in the result.
1204     computeKnownBits(I->getOperand(0), KnownZero, KnownOne, DL, Depth + 1, Q);
1205     computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, DL, Depth + 1, Q);
1206
1207     unsigned Leaders = std::max(KnownZero.countLeadingOnes(),
1208                                 KnownZero2.countLeadingOnes());
1209     KnownOne.clearAllBits();
1210     KnownZero = APInt::getHighBitsSet(BitWidth, Leaders);
1211     break;
1212   }
1213
1214   case Instruction::Alloca: {
1215     AllocaInst *AI = cast<AllocaInst>(I);
1216     unsigned Align = AI->getAlignment();
1217     if (Align == 0)
1218       Align = DL.getABITypeAlignment(AI->getType()->getElementType());
1219
1220     if (Align > 0)
1221       KnownZero = APInt::getLowBitsSet(BitWidth, countTrailingZeros(Align));
1222     break;
1223   }
1224   case Instruction::GetElementPtr: {
1225     // Analyze all of the subscripts of this getelementptr instruction
1226     // to determine if we can prove known low zero bits.
1227     APInt LocalKnownZero(BitWidth, 0), LocalKnownOne(BitWidth, 0);
1228     computeKnownBits(I->getOperand(0), LocalKnownZero, LocalKnownOne, DL,
1229                      Depth + 1, Q);
1230     unsigned TrailZ = LocalKnownZero.countTrailingOnes();
1231
1232     gep_type_iterator GTI = gep_type_begin(I);
1233     for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
1234       Value *Index = I->getOperand(i);
1235       if (StructType *STy = dyn_cast<StructType>(*GTI)) {
1236         // Handle struct member offset arithmetic.
1237
1238         // Handle case when index is vector zeroinitializer
1239         Constant *CIndex = cast<Constant>(Index);
1240         if (CIndex->isZeroValue())
1241           continue;
1242
1243         if (CIndex->getType()->isVectorTy())
1244           Index = CIndex->getSplatValue();
1245
1246         unsigned Idx = cast<ConstantInt>(Index)->getZExtValue();
1247         const StructLayout *SL = DL.getStructLayout(STy);
1248         uint64_t Offset = SL->getElementOffset(Idx);
1249         TrailZ = std::min<unsigned>(TrailZ,
1250                                     countTrailingZeros(Offset));
1251       } else {
1252         // Handle array index arithmetic.
1253         Type *IndexedTy = GTI.getIndexedType();
1254         if (!IndexedTy->isSized()) {
1255           TrailZ = 0;
1256           break;
1257         }
1258         unsigned GEPOpiBits = Index->getType()->getScalarSizeInBits();
1259         uint64_t TypeSize = DL.getTypeAllocSize(IndexedTy);
1260         LocalKnownZero = LocalKnownOne = APInt(GEPOpiBits, 0);
1261         computeKnownBits(Index, LocalKnownZero, LocalKnownOne, DL, Depth + 1,
1262                          Q);
1263         TrailZ = std::min(TrailZ,
1264                           unsigned(countTrailingZeros(TypeSize) +
1265                                    LocalKnownZero.countTrailingOnes()));
1266       }
1267     }
1268
1269     KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ);
1270     break;
1271   }
1272   case Instruction::PHI: {
1273     PHINode *P = cast<PHINode>(I);
1274     // Handle the case of a simple two-predecessor recurrence PHI.
1275     // There's a lot more that could theoretically be done here, but
1276     // this is sufficient to catch some interesting cases.
1277     if (P->getNumIncomingValues() == 2) {
1278       for (unsigned i = 0; i != 2; ++i) {
1279         Value *L = P->getIncomingValue(i);
1280         Value *R = P->getIncomingValue(!i);
1281         Operator *LU = dyn_cast<Operator>(L);
1282         if (!LU)
1283           continue;
1284         unsigned Opcode = LU->getOpcode();
1285         // Check for operations that have the property that if
1286         // both their operands have low zero bits, the result
1287         // will have low zero bits.
1288         if (Opcode == Instruction::Add ||
1289             Opcode == Instruction::Sub ||
1290             Opcode == Instruction::And ||
1291             Opcode == Instruction::Or ||
1292             Opcode == Instruction::Mul) {
1293           Value *LL = LU->getOperand(0);
1294           Value *LR = LU->getOperand(1);
1295           // Find a recurrence.
1296           if (LL == I)
1297             L = LR;
1298           else if (LR == I)
1299             L = LL;
1300           else
1301             break;
1302           // Ok, we have a PHI of the form L op= R. Check for low
1303           // zero bits.
1304           computeKnownBits(R, KnownZero2, KnownOne2, DL, Depth + 1, Q);
1305
1306           // We need to take the minimum number of known bits
1307           APInt KnownZero3(KnownZero), KnownOne3(KnownOne);
1308           computeKnownBits(L, KnownZero3, KnownOne3, DL, Depth + 1, Q);
1309
1310           KnownZero = APInt::getLowBitsSet(BitWidth,
1311                                            std::min(KnownZero2.countTrailingOnes(),
1312                                                     KnownZero3.countTrailingOnes()));
1313           break;
1314         }
1315       }
1316     }
1317
1318     // Unreachable blocks may have zero-operand PHI nodes.
1319     if (P->getNumIncomingValues() == 0)
1320       break;
1321
1322     // Otherwise take the unions of the known bit sets of the operands,
1323     // taking conservative care to avoid excessive recursion.
1324     if (Depth < MaxDepth - 1 && !KnownZero && !KnownOne) {
1325       // Skip if every incoming value references to ourself.
1326       if (dyn_cast_or_null<UndefValue>(P->hasConstantValue()))
1327         break;
1328
1329       KnownZero = APInt::getAllOnesValue(BitWidth);
1330       KnownOne = APInt::getAllOnesValue(BitWidth);
1331       for (Value *IncValue : P->incoming_values()) {
1332         // Skip direct self references.
1333         if (IncValue == P) continue;
1334
1335         KnownZero2 = APInt(BitWidth, 0);
1336         KnownOne2 = APInt(BitWidth, 0);
1337         // Recurse, but cap the recursion to one level, because we don't
1338         // want to waste time spinning around in loops.
1339         computeKnownBits(IncValue, KnownZero2, KnownOne2, DL,
1340                          MaxDepth - 1, Q);
1341         KnownZero &= KnownZero2;
1342         KnownOne &= KnownOne2;
1343         // If all bits have been ruled out, there's no need to check
1344         // more operands.
1345         if (!KnownZero && !KnownOne)
1346           break;
1347       }
1348     }
1349     break;
1350   }
1351   case Instruction::Call:
1352   case Instruction::Invoke:
1353     if (MDNode *MD = cast<Instruction>(I)->getMetadata(LLVMContext::MD_range))
1354       computeKnownBitsFromRangeMetadata(*MD, KnownZero);
1355     // If a range metadata is attached to this IntrinsicInst, intersect the
1356     // explicit range specified by the metadata and the implicit range of
1357     // the intrinsic.
1358     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
1359       switch (II->getIntrinsicID()) {
1360       default: break;
1361       case Intrinsic::bswap:
1362         computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, DL,
1363                          Depth + 1, Q);
1364         KnownZero |= KnownZero2.byteSwap();
1365         KnownOne |= KnownOne2.byteSwap();
1366         break;
1367       case Intrinsic::ctlz:
1368       case Intrinsic::cttz: {
1369         unsigned LowBits = Log2_32(BitWidth)+1;
1370         // If this call is undefined for 0, the result will be less than 2^n.
1371         if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
1372           LowBits -= 1;
1373         KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - LowBits);
1374         break;
1375       }
1376       case Intrinsic::ctpop: {
1377         unsigned LowBits = Log2_32(BitWidth)+1;
1378         KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - LowBits);
1379         break;
1380       }
1381       case Intrinsic::x86_sse42_crc32_64_64:
1382         KnownZero |= APInt::getHighBitsSet(64, 32);
1383         break;
1384       }
1385     }
1386     break;
1387   case Instruction::ExtractValue:
1388     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I->getOperand(0))) {
1389       ExtractValueInst *EVI = cast<ExtractValueInst>(I);
1390       if (EVI->getNumIndices() != 1) break;
1391       if (EVI->getIndices()[0] == 0) {
1392         switch (II->getIntrinsicID()) {
1393         default: break;
1394         case Intrinsic::uadd_with_overflow:
1395         case Intrinsic::sadd_with_overflow:
1396           computeKnownBitsAddSub(true, II->getArgOperand(0),
1397                                  II->getArgOperand(1), false, KnownZero,
1398                                  KnownOne, KnownZero2, KnownOne2, DL, Depth, Q);
1399           break;
1400         case Intrinsic::usub_with_overflow:
1401         case Intrinsic::ssub_with_overflow:
1402           computeKnownBitsAddSub(false, II->getArgOperand(0),
1403                                  II->getArgOperand(1), false, KnownZero,
1404                                  KnownOne, KnownZero2, KnownOne2, DL, Depth, Q);
1405           break;
1406         case Intrinsic::umul_with_overflow:
1407         case Intrinsic::smul_with_overflow:
1408           computeKnownBitsMul(II->getArgOperand(0), II->getArgOperand(1), false,
1409                               KnownZero, KnownOne, KnownZero2, KnownOne2, DL,
1410                               Depth, Q);
1411           break;
1412         }
1413       }
1414     }
1415   }
1416 }
1417
1418 static unsigned getAlignment(const Value *V, const DataLayout &DL) {
1419   unsigned Align = 0;
1420   if (auto *GO = dyn_cast<GlobalObject>(V)) {
1421     Align = GO->getAlignment();
1422     if (Align == 0) {
1423       if (auto *GVar = dyn_cast<GlobalVariable>(GO)) {
1424         Type *ObjectType = GVar->getType()->getElementType();
1425         if (ObjectType->isSized()) {
1426           // If the object is defined in the current Module, we'll be giving
1427           // it the preferred alignment. Otherwise, we have to assume that it
1428           // may only have the minimum ABI alignment.
1429           if (GVar->isStrongDefinitionForLinker())
1430             Align = DL.getPreferredAlignment(GVar);
1431           else
1432             Align = DL.getABITypeAlignment(ObjectType);
1433         }
1434       }
1435     }
1436   } else if (const Argument *A = dyn_cast<Argument>(V)) {
1437     Align = A->getType()->isPointerTy() ? A->getParamAlignment() : 0;
1438
1439     if (!Align && A->hasStructRetAttr()) {
1440       // An sret parameter has at least the ABI alignment of the return type.
1441       Type *EltTy = cast<PointerType>(A->getType())->getElementType();
1442       if (EltTy->isSized())
1443         Align = DL.getABITypeAlignment(EltTy);
1444     }
1445   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
1446     Align = AI->getAlignment();
1447   else if (auto CS = ImmutableCallSite(V))
1448     Align = CS.getAttributes().getParamAlignment(AttributeSet::ReturnIndex);
1449   else if (const LoadInst *LI = dyn_cast<LoadInst>(V))
1450     if (MDNode *MD = LI->getMetadata(LLVMContext::MD_align)) {
1451       ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(0));
1452       Align = CI->getLimitedValue();
1453     }
1454
1455   return Align;
1456 }
1457
1458 /// Determine which bits of V are known to be either zero or one and return
1459 /// them in the KnownZero/KnownOne bit sets.
1460 ///
1461 /// NOTE: we cannot consider 'undef' to be "IsZero" here.  The problem is that
1462 /// we cannot optimize based on the assumption that it is zero without changing
1463 /// it to be an explicit zero.  If we don't change it to zero, other code could
1464 /// optimized based on the contradictory assumption that it is non-zero.
1465 /// Because instcombine aggressively folds operations with undef args anyway,
1466 /// this won't lose us code quality.
1467 ///
1468 /// This function is defined on values with integer type, values with pointer
1469 /// type, and vectors of integers.  In the case
1470 /// where V is a vector, known zero, and known one values are the
1471 /// same width as the vector element, and the bit is set only if it is true
1472 /// for all of the elements in the vector.
1473 void computeKnownBits(Value *V, APInt &KnownZero, APInt &KnownOne,
1474                       const DataLayout &DL, unsigned Depth, const Query &Q) {
1475   assert(V && "No Value?");
1476   assert(Depth <= MaxDepth && "Limit Search Depth");
1477   unsigned BitWidth = KnownZero.getBitWidth();
1478
1479   assert((V->getType()->isIntOrIntVectorTy() ||
1480           V->getType()->getScalarType()->isPointerTy()) &&
1481          "Not integer or pointer type!");
1482   assert((DL.getTypeSizeInBits(V->getType()->getScalarType()) == BitWidth) &&
1483          (!V->getType()->isIntOrIntVectorTy() ||
1484           V->getType()->getScalarSizeInBits() == BitWidth) &&
1485          KnownZero.getBitWidth() == BitWidth &&
1486          KnownOne.getBitWidth() == BitWidth &&
1487          "V, KnownOne and KnownZero should have same BitWidth");
1488
1489   if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1490     // We know all of the bits for a constant!
1491     KnownOne = CI->getValue();
1492     KnownZero = ~KnownOne;
1493     return;
1494   }
1495   // Null and aggregate-zero are all-zeros.
1496   if (isa<ConstantPointerNull>(V) ||
1497       isa<ConstantAggregateZero>(V)) {
1498     KnownOne.clearAllBits();
1499     KnownZero = APInt::getAllOnesValue(BitWidth);
1500     return;
1501   }
1502   // Handle a constant vector by taking the intersection of the known bits of
1503   // each element.  There is no real need to handle ConstantVector here, because
1504   // we don't handle undef in any particularly useful way.
1505   if (ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V)) {
1506     // We know that CDS must be a vector of integers. Take the intersection of
1507     // each element.
1508     KnownZero.setAllBits(); KnownOne.setAllBits();
1509     APInt Elt(KnownZero.getBitWidth(), 0);
1510     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1511       Elt = CDS->getElementAsInteger(i);
1512       KnownZero &= ~Elt;
1513       KnownOne &= Elt;
1514     }
1515     return;
1516   }
1517
1518   // Start out not knowing anything.
1519   KnownZero.clearAllBits(); KnownOne.clearAllBits();
1520
1521   // Limit search depth.
1522   // All recursive calls that increase depth must come after this.
1523   if (Depth == MaxDepth)
1524     return;
1525
1526   // A weak GlobalAlias is totally unknown. A non-weak GlobalAlias has
1527   // the bits of its aliasee.
1528   if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
1529     if (!GA->mayBeOverridden())
1530       computeKnownBits(GA->getAliasee(), KnownZero, KnownOne, DL, Depth + 1, Q);
1531     return;
1532   }
1533
1534   if (Operator *I = dyn_cast<Operator>(V))
1535     computeKnownBitsFromOperator(I, KnownZero, KnownOne, DL, Depth, Q);
1536
1537   // Aligned pointers have trailing zeros - refine KnownZero set
1538   if (V->getType()->isPointerTy()) {
1539     unsigned Align = getAlignment(V, DL);
1540     if (Align)
1541       KnownZero |= APInt::getLowBitsSet(BitWidth, countTrailingZeros(Align));
1542   }
1543
1544   // computeKnownBitsFromAssume and computeKnownBitsFromDominatingCondition
1545   // strictly refines KnownZero and KnownOne. Therefore, we run them after
1546   // computeKnownBitsFromOperator.
1547
1548   // Check whether a nearby assume intrinsic can determine some known bits.
1549   computeKnownBitsFromAssume(V, KnownZero, KnownOne, DL, Depth, Q);
1550
1551   // Check whether there's a dominating condition which implies something about
1552   // this value at the given context.
1553   if (EnableDomConditions && Depth <= DomConditionsMaxDepth)
1554     computeKnownBitsFromDominatingCondition(V, KnownZero, KnownOne, DL, Depth,
1555                                             Q);
1556
1557   assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
1558 }
1559
1560 /// Determine whether the sign bit is known to be zero or one.
1561 /// Convenience wrapper around computeKnownBits.
1562 void ComputeSignBit(Value *V, bool &KnownZero, bool &KnownOne,
1563                     const DataLayout &DL, unsigned Depth, const Query &Q) {
1564   unsigned BitWidth = getBitWidth(V->getType(), DL);
1565   if (!BitWidth) {
1566     KnownZero = false;
1567     KnownOne = false;
1568     return;
1569   }
1570   APInt ZeroBits(BitWidth, 0);
1571   APInt OneBits(BitWidth, 0);
1572   computeKnownBits(V, ZeroBits, OneBits, DL, Depth, Q);
1573   KnownOne = OneBits[BitWidth - 1];
1574   KnownZero = ZeroBits[BitWidth - 1];
1575 }
1576
1577 /// Return true if the given value is known to have exactly one
1578 /// bit set when defined. For vectors return true if every element is known to
1579 /// be a power of two when defined. Supports values with integer or pointer
1580 /// types and vectors of integers.
1581 bool isKnownToBeAPowerOfTwo(Value *V, bool OrZero, unsigned Depth,
1582                             const Query &Q, const DataLayout &DL) {
1583   if (Constant *C = dyn_cast<Constant>(V)) {
1584     if (C->isNullValue())
1585       return OrZero;
1586     if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1587       return CI->getValue().isPowerOf2();
1588     // TODO: Handle vector constants.
1589   }
1590
1591   // 1 << X is clearly a power of two if the one is not shifted off the end.  If
1592   // it is shifted off the end then the result is undefined.
1593   if (match(V, m_Shl(m_One(), m_Value())))
1594     return true;
1595
1596   // (signbit) >>l X is clearly a power of two if the one is not shifted off the
1597   // bottom.  If it is shifted off the bottom then the result is undefined.
1598   if (match(V, m_LShr(m_SignBit(), m_Value())))
1599     return true;
1600
1601   // The remaining tests are all recursive, so bail out if we hit the limit.
1602   if (Depth++ == MaxDepth)
1603     return false;
1604
1605   Value *X = nullptr, *Y = nullptr;
1606   // A shift of a power of two is a power of two or zero.
1607   if (OrZero && (match(V, m_Shl(m_Value(X), m_Value())) ||
1608                  match(V, m_Shr(m_Value(X), m_Value()))))
1609     return isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q, DL);
1610
1611   if (ZExtInst *ZI = dyn_cast<ZExtInst>(V))
1612     return isKnownToBeAPowerOfTwo(ZI->getOperand(0), OrZero, Depth, Q, DL);
1613
1614   if (SelectInst *SI = dyn_cast<SelectInst>(V))
1615     return isKnownToBeAPowerOfTwo(SI->getTrueValue(), OrZero, Depth, Q, DL) &&
1616            isKnownToBeAPowerOfTwo(SI->getFalseValue(), OrZero, Depth, Q, DL);
1617
1618   if (OrZero && match(V, m_And(m_Value(X), m_Value(Y)))) {
1619     // A power of two and'd with anything is a power of two or zero.
1620     if (isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q, DL) ||
1621         isKnownToBeAPowerOfTwo(Y, /*OrZero*/ true, Depth, Q, DL))
1622       return true;
1623     // X & (-X) is always a power of two or zero.
1624     if (match(X, m_Neg(m_Specific(Y))) || match(Y, m_Neg(m_Specific(X))))
1625       return true;
1626     return false;
1627   }
1628
1629   // Adding a power-of-two or zero to the same power-of-two or zero yields
1630   // either the original power-of-two, a larger power-of-two or zero.
1631   if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
1632     OverflowingBinaryOperator *VOBO = cast<OverflowingBinaryOperator>(V);
1633     if (OrZero || VOBO->hasNoUnsignedWrap() || VOBO->hasNoSignedWrap()) {
1634       if (match(X, m_And(m_Specific(Y), m_Value())) ||
1635           match(X, m_And(m_Value(), m_Specific(Y))))
1636         if (isKnownToBeAPowerOfTwo(Y, OrZero, Depth, Q, DL))
1637           return true;
1638       if (match(Y, m_And(m_Specific(X), m_Value())) ||
1639           match(Y, m_And(m_Value(), m_Specific(X))))
1640         if (isKnownToBeAPowerOfTwo(X, OrZero, Depth, Q, DL))
1641           return true;
1642
1643       unsigned BitWidth = V->getType()->getScalarSizeInBits();
1644       APInt LHSZeroBits(BitWidth, 0), LHSOneBits(BitWidth, 0);
1645       computeKnownBits(X, LHSZeroBits, LHSOneBits, DL, Depth, Q);
1646
1647       APInt RHSZeroBits(BitWidth, 0), RHSOneBits(BitWidth, 0);
1648       computeKnownBits(Y, RHSZeroBits, RHSOneBits, DL, Depth, Q);
1649       // If i8 V is a power of two or zero:
1650       //  ZeroBits: 1 1 1 0 1 1 1 1
1651       // ~ZeroBits: 0 0 0 1 0 0 0 0
1652       if ((~(LHSZeroBits & RHSZeroBits)).isPowerOf2())
1653         // If OrZero isn't set, we cannot give back a zero result.
1654         // Make sure either the LHS or RHS has a bit set.
1655         if (OrZero || RHSOneBits.getBoolValue() || LHSOneBits.getBoolValue())
1656           return true;
1657     }
1658   }
1659
1660   // An exact divide or right shift can only shift off zero bits, so the result
1661   // is a power of two only if the first operand is a power of two and not
1662   // copying a sign bit (sdiv int_min, 2).
1663   if (match(V, m_Exact(m_LShr(m_Value(), m_Value()))) ||
1664       match(V, m_Exact(m_UDiv(m_Value(), m_Value())))) {
1665     return isKnownToBeAPowerOfTwo(cast<Operator>(V)->getOperand(0), OrZero,
1666                                   Depth, Q, DL);
1667   }
1668
1669   return false;
1670 }
1671
1672 /// \brief Test whether a GEP's result is known to be non-null.
1673 ///
1674 /// Uses properties inherent in a GEP to try to determine whether it is known
1675 /// to be non-null.
1676 ///
1677 /// Currently this routine does not support vector GEPs.
1678 static bool isGEPKnownNonNull(GEPOperator *GEP, const DataLayout &DL,
1679                               unsigned Depth, const Query &Q) {
1680   if (!GEP->isInBounds() || GEP->getPointerAddressSpace() != 0)
1681     return false;
1682
1683   // FIXME: Support vector-GEPs.
1684   assert(GEP->getType()->isPointerTy() && "We only support plain pointer GEP");
1685
1686   // If the base pointer is non-null, we cannot walk to a null address with an
1687   // inbounds GEP in address space zero.
1688   if (isKnownNonZero(GEP->getPointerOperand(), DL, Depth, Q))
1689     return true;
1690
1691   // Walk the GEP operands and see if any operand introduces a non-zero offset.
1692   // If so, then the GEP cannot produce a null pointer, as doing so would
1693   // inherently violate the inbounds contract within address space zero.
1694   for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
1695        GTI != GTE; ++GTI) {
1696     // Struct types are easy -- they must always be indexed by a constant.
1697     if (StructType *STy = dyn_cast<StructType>(*GTI)) {
1698       ConstantInt *OpC = cast<ConstantInt>(GTI.getOperand());
1699       unsigned ElementIdx = OpC->getZExtValue();
1700       const StructLayout *SL = DL.getStructLayout(STy);
1701       uint64_t ElementOffset = SL->getElementOffset(ElementIdx);
1702       if (ElementOffset > 0)
1703         return true;
1704       continue;
1705     }
1706
1707     // If we have a zero-sized type, the index doesn't matter. Keep looping.
1708     if (DL.getTypeAllocSize(GTI.getIndexedType()) == 0)
1709       continue;
1710
1711     // Fast path the constant operand case both for efficiency and so we don't
1712     // increment Depth when just zipping down an all-constant GEP.
1713     if (ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand())) {
1714       if (!OpC->isZero())
1715         return true;
1716       continue;
1717     }
1718
1719     // We post-increment Depth here because while isKnownNonZero increments it
1720     // as well, when we pop back up that increment won't persist. We don't want
1721     // to recurse 10k times just because we have 10k GEP operands. We don't
1722     // bail completely out because we want to handle constant GEPs regardless
1723     // of depth.
1724     if (Depth++ >= MaxDepth)
1725       continue;
1726
1727     if (isKnownNonZero(GTI.getOperand(), DL, Depth, Q))
1728       return true;
1729   }
1730
1731   return false;
1732 }
1733
1734 /// Does the 'Range' metadata (which must be a valid MD_range operand list)
1735 /// ensure that the value it's attached to is never Value?  'RangeType' is
1736 /// is the type of the value described by the range.
1737 static bool rangeMetadataExcludesValue(MDNode* Ranges,
1738                                        const APInt& Value) {
1739   const unsigned NumRanges = Ranges->getNumOperands() / 2;
1740   assert(NumRanges >= 1);
1741   for (unsigned i = 0; i < NumRanges; ++i) {
1742     ConstantInt *Lower =
1743         mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 0));
1744     ConstantInt *Upper =
1745         mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 1));
1746     ConstantRange Range(Lower->getValue(), Upper->getValue());
1747     if (Range.contains(Value))
1748       return false;
1749   }
1750   return true;
1751 }
1752
1753 /// Return true if the given value is known to be non-zero when defined.
1754 /// For vectors return true if every element is known to be non-zero when
1755 /// defined. Supports values with integer or pointer type and vectors of
1756 /// integers.
1757 bool isKnownNonZero(Value *V, const DataLayout &DL, unsigned Depth,
1758                     const Query &Q) {
1759   if (Constant *C = dyn_cast<Constant>(V)) {
1760     if (C->isNullValue())
1761       return false;
1762     if (isa<ConstantInt>(C))
1763       // Must be non-zero due to null test above.
1764       return true;
1765     // TODO: Handle vectors
1766     return false;
1767   }
1768
1769   if (Instruction* I = dyn_cast<Instruction>(V)) {
1770     if (MDNode *Ranges = I->getMetadata(LLVMContext::MD_range)) {
1771       // If the possible ranges don't contain zero, then the value is
1772       // definitely non-zero.
1773       if (IntegerType* Ty = dyn_cast<IntegerType>(V->getType())) {
1774         const APInt ZeroValue(Ty->getBitWidth(), 0);
1775         if (rangeMetadataExcludesValue(Ranges, ZeroValue))
1776           return true;
1777       }
1778     }
1779   }
1780
1781   // The remaining tests are all recursive, so bail out if we hit the limit.
1782   if (Depth++ >= MaxDepth)
1783     return false;
1784
1785   // Check for pointer simplifications.
1786   if (V->getType()->isPointerTy()) {
1787     if (isKnownNonNull(V))
1788       return true; 
1789     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V))
1790       if (isGEPKnownNonNull(GEP, DL, Depth, Q))
1791         return true;
1792   }
1793
1794   unsigned BitWidth = getBitWidth(V->getType()->getScalarType(), DL);
1795
1796   // X | Y != 0 if X != 0 or Y != 0.
1797   Value *X = nullptr, *Y = nullptr;
1798   if (match(V, m_Or(m_Value(X), m_Value(Y))))
1799     return isKnownNonZero(X, DL, Depth, Q) || isKnownNonZero(Y, DL, Depth, Q);
1800
1801   // ext X != 0 if X != 0.
1802   if (isa<SExtInst>(V) || isa<ZExtInst>(V))
1803     return isKnownNonZero(cast<Instruction>(V)->getOperand(0), DL, Depth, Q);
1804
1805   // shl X, Y != 0 if X is odd.  Note that the value of the shift is undefined
1806   // if the lowest bit is shifted off the end.
1807   if (BitWidth && match(V, m_Shl(m_Value(X), m_Value(Y)))) {
1808     // shl nuw can't remove any non-zero bits.
1809     OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
1810     if (BO->hasNoUnsignedWrap())
1811       return isKnownNonZero(X, DL, Depth, Q);
1812
1813     APInt KnownZero(BitWidth, 0);
1814     APInt KnownOne(BitWidth, 0);
1815     computeKnownBits(X, KnownZero, KnownOne, DL, Depth, Q);
1816     if (KnownOne[0])
1817       return true;
1818   }
1819   // shr X, Y != 0 if X is negative.  Note that the value of the shift is not
1820   // defined if the sign bit is shifted off the end.
1821   else if (match(V, m_Shr(m_Value(X), m_Value(Y)))) {
1822     // shr exact can only shift out zero bits.
1823     PossiblyExactOperator *BO = cast<PossiblyExactOperator>(V);
1824     if (BO->isExact())
1825       return isKnownNonZero(X, DL, Depth, Q);
1826
1827     bool XKnownNonNegative, XKnownNegative;
1828     ComputeSignBit(X, XKnownNonNegative, XKnownNegative, DL, Depth, Q);
1829     if (XKnownNegative)
1830       return true;
1831
1832     // If the shifter operand is a constant, and all of the bits shifted
1833     // out are known to be zero, and X is known non-zero then at least one
1834     // non-zero bit must remain.
1835     if (ConstantInt *Shift = dyn_cast<ConstantInt>(Y)) {
1836       APInt KnownZero(BitWidth, 0);
1837       APInt KnownOne(BitWidth, 0);
1838       computeKnownBits(X, KnownZero, KnownOne, DL, Depth, Q);
1839       
1840       auto ShiftVal = Shift->getLimitedValue(BitWidth - 1);
1841       // Is there a known one in the portion not shifted out?
1842       if (KnownOne.countLeadingZeros() < BitWidth - ShiftVal)
1843         return true;
1844       // Are all the bits to be shifted out known zero?
1845       if (KnownZero.countTrailingOnes() >= ShiftVal)
1846         return isKnownNonZero(X, DL, Depth, Q);
1847     }
1848   }
1849   // div exact can only produce a zero if the dividend is zero.
1850   else if (match(V, m_Exact(m_IDiv(m_Value(X), m_Value())))) {
1851     return isKnownNonZero(X, DL, Depth, Q);
1852   }
1853   // X + Y.
1854   else if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
1855     bool XKnownNonNegative, XKnownNegative;
1856     bool YKnownNonNegative, YKnownNegative;
1857     ComputeSignBit(X, XKnownNonNegative, XKnownNegative, DL, Depth, Q);
1858     ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, DL, Depth, Q);
1859
1860     // If X and Y are both non-negative (as signed values) then their sum is not
1861     // zero unless both X and Y are zero.
1862     if (XKnownNonNegative && YKnownNonNegative)
1863       if (isKnownNonZero(X, DL, Depth, Q) || isKnownNonZero(Y, DL, Depth, Q))
1864         return true;
1865
1866     // If X and Y are both negative (as signed values) then their sum is not
1867     // zero unless both X and Y equal INT_MIN.
1868     if (BitWidth && XKnownNegative && YKnownNegative) {
1869       APInt KnownZero(BitWidth, 0);
1870       APInt KnownOne(BitWidth, 0);
1871       APInt Mask = APInt::getSignedMaxValue(BitWidth);
1872       // The sign bit of X is set.  If some other bit is set then X is not equal
1873       // to INT_MIN.
1874       computeKnownBits(X, KnownZero, KnownOne, DL, Depth, Q);
1875       if ((KnownOne & Mask) != 0)
1876         return true;
1877       // The sign bit of Y is set.  If some other bit is set then Y is not equal
1878       // to INT_MIN.
1879       computeKnownBits(Y, KnownZero, KnownOne, DL, Depth, Q);
1880       if ((KnownOne & Mask) != 0)
1881         return true;
1882     }
1883
1884     // The sum of a non-negative number and a power of two is not zero.
1885     if (XKnownNonNegative &&
1886         isKnownToBeAPowerOfTwo(Y, /*OrZero*/ false, Depth, Q, DL))
1887       return true;
1888     if (YKnownNonNegative &&
1889         isKnownToBeAPowerOfTwo(X, /*OrZero*/ false, Depth, Q, DL))
1890       return true;
1891   }
1892   // X * Y.
1893   else if (match(V, m_Mul(m_Value(X), m_Value(Y)))) {
1894     OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
1895     // If X and Y are non-zero then so is X * Y as long as the multiplication
1896     // does not overflow.
1897     if ((BO->hasNoSignedWrap() || BO->hasNoUnsignedWrap()) &&
1898         isKnownNonZero(X, DL, Depth, Q) && isKnownNonZero(Y, DL, Depth, Q))
1899       return true;
1900   }
1901   // (C ? X : Y) != 0 if X != 0 and Y != 0.
1902   else if (SelectInst *SI = dyn_cast<SelectInst>(V)) {
1903     if (isKnownNonZero(SI->getTrueValue(), DL, Depth, Q) &&
1904         isKnownNonZero(SI->getFalseValue(), DL, Depth, Q))
1905       return true;
1906   }
1907   // PHI
1908   else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1909     // Try and detect a recurrence that monotonically increases from a
1910     // starting value, as these are common as induction variables.
1911     if (PN->getNumIncomingValues() == 2) {
1912       Value *Start = PN->getIncomingValue(0);
1913       Value *Induction = PN->getIncomingValue(1);
1914       if (isa<ConstantInt>(Induction) && !isa<ConstantInt>(Start))
1915         std::swap(Start, Induction);
1916       if (ConstantInt *C = dyn_cast<ConstantInt>(Start)) {
1917         if (!C->isZero() && !C->isNegative()) {
1918           ConstantInt *X;
1919           if ((match(Induction, m_NSWAdd(m_Specific(PN), m_ConstantInt(X))) ||
1920                match(Induction, m_NUWAdd(m_Specific(PN), m_ConstantInt(X)))) &&
1921               !X->isNegative())
1922             return true;
1923         }
1924       }
1925     }
1926   }
1927
1928   if (!BitWidth) return false;
1929   APInt KnownZero(BitWidth, 0);
1930   APInt KnownOne(BitWidth, 0);
1931   computeKnownBits(V, KnownZero, KnownOne, DL, Depth, Q);
1932   return KnownOne != 0;
1933 }
1934
1935 /// Return true if 'V & Mask' is known to be zero.  We use this predicate to
1936 /// simplify operations downstream. Mask is known to be zero for bits that V
1937 /// cannot have.
1938 ///
1939 /// This function is defined on values with integer type, values with pointer
1940 /// type, and vectors of integers.  In the case
1941 /// where V is a vector, the mask, known zero, and known one values are the
1942 /// same width as the vector element, and the bit is set only if it is true
1943 /// for all of the elements in the vector.
1944 bool MaskedValueIsZero(Value *V, const APInt &Mask, const DataLayout &DL,
1945                        unsigned Depth, const Query &Q) {
1946   APInt KnownZero(Mask.getBitWidth(), 0), KnownOne(Mask.getBitWidth(), 0);
1947   computeKnownBits(V, KnownZero, KnownOne, DL, Depth, Q);
1948   return (KnownZero & Mask) == Mask;
1949 }
1950
1951
1952
1953 /// Return the number of times the sign bit of the register is replicated into
1954 /// the other bits. We know that at least 1 bit is always equal to the sign bit
1955 /// (itself), but other cases can give us information. For example, immediately
1956 /// after an "ashr X, 2", we know that the top 3 bits are all equal to each
1957 /// other, so we return 3.
1958 ///
1959 /// 'Op' must have a scalar integer type.
1960 ///
1961 unsigned ComputeNumSignBits(Value *V, const DataLayout &DL, unsigned Depth,
1962                             const Query &Q) {
1963   unsigned TyBits = DL.getTypeSizeInBits(V->getType()->getScalarType());
1964   unsigned Tmp, Tmp2;
1965   unsigned FirstAnswer = 1;
1966
1967   // Note that ConstantInt is handled by the general computeKnownBits case
1968   // below.
1969
1970   if (Depth == 6)
1971     return 1;  // Limit search depth.
1972
1973   Operator *U = dyn_cast<Operator>(V);
1974   switch (Operator::getOpcode(V)) {
1975   default: break;
1976   case Instruction::SExt:
1977     Tmp = TyBits - U->getOperand(0)->getType()->getScalarSizeInBits();
1978     return ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q) + Tmp;
1979
1980   case Instruction::SDiv: {
1981     const APInt *Denominator;
1982     // sdiv X, C -> adds log(C) sign bits.
1983     if (match(U->getOperand(1), m_APInt(Denominator))) {
1984
1985       // Ignore non-positive denominator.
1986       if (!Denominator->isStrictlyPositive())
1987         break;
1988
1989       // Calculate the incoming numerator bits.
1990       unsigned NumBits = ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q);
1991
1992       // Add floor(log(C)) bits to the numerator bits.
1993       return std::min(TyBits, NumBits + Denominator->logBase2());
1994     }
1995     break;
1996   }
1997
1998   case Instruction::SRem: {
1999     const APInt *Denominator;
2000     // srem X, C -> we know that the result is within [-C+1,C) when C is a
2001     // positive constant.  This let us put a lower bound on the number of sign
2002     // bits.
2003     if (match(U->getOperand(1), m_APInt(Denominator))) {
2004
2005       // Ignore non-positive denominator.
2006       if (!Denominator->isStrictlyPositive())
2007         break;
2008
2009       // Calculate the incoming numerator bits. SRem by a positive constant
2010       // can't lower the number of sign bits.
2011       unsigned NumrBits =
2012           ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q);
2013
2014       // Calculate the leading sign bit constraints by examining the
2015       // denominator.  Given that the denominator is positive, there are two
2016       // cases:
2017       //
2018       //  1. the numerator is positive.  The result range is [0,C) and [0,C) u<
2019       //     (1 << ceilLogBase2(C)).
2020       //
2021       //  2. the numerator is negative.  Then the result range is (-C,0] and
2022       //     integers in (-C,0] are either 0 or >u (-1 << ceilLogBase2(C)).
2023       //
2024       // Thus a lower bound on the number of sign bits is `TyBits -
2025       // ceilLogBase2(C)`.
2026
2027       unsigned ResBits = TyBits - Denominator->ceilLogBase2();
2028       return std::max(NumrBits, ResBits);
2029     }
2030     break;
2031   }
2032
2033   case Instruction::AShr: {
2034     Tmp = ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q);
2035     // ashr X, C   -> adds C sign bits.  Vectors too.
2036     const APInt *ShAmt;
2037     if (match(U->getOperand(1), m_APInt(ShAmt))) {
2038       Tmp += ShAmt->getZExtValue();
2039       if (Tmp > TyBits) Tmp = TyBits;
2040     }
2041     return Tmp;
2042   }
2043   case Instruction::Shl: {
2044     const APInt *ShAmt;
2045     if (match(U->getOperand(1), m_APInt(ShAmt))) {
2046       // shl destroys sign bits.
2047       Tmp = ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q);
2048       Tmp2 = ShAmt->getZExtValue();
2049       if (Tmp2 >= TyBits ||      // Bad shift.
2050           Tmp2 >= Tmp) break;    // Shifted all sign bits out.
2051       return Tmp - Tmp2;
2052     }
2053     break;
2054   }
2055   case Instruction::And:
2056   case Instruction::Or:
2057   case Instruction::Xor:    // NOT is handled here.
2058     // Logical binary ops preserve the number of sign bits at the worst.
2059     Tmp = ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q);
2060     if (Tmp != 1) {
2061       Tmp2 = ComputeNumSignBits(U->getOperand(1), DL, Depth + 1, Q);
2062       FirstAnswer = std::min(Tmp, Tmp2);
2063       // We computed what we know about the sign bits as our first
2064       // answer. Now proceed to the generic code that uses
2065       // computeKnownBits, and pick whichever answer is better.
2066     }
2067     break;
2068
2069   case Instruction::Select:
2070     Tmp = ComputeNumSignBits(U->getOperand(1), DL, Depth + 1, Q);
2071     if (Tmp == 1) return 1;  // Early out.
2072     Tmp2 = ComputeNumSignBits(U->getOperand(2), DL, Depth + 1, Q);
2073     return std::min(Tmp, Tmp2);
2074
2075   case Instruction::Add:
2076     // Add can have at most one carry bit.  Thus we know that the output
2077     // is, at worst, one more bit than the inputs.
2078     Tmp = ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q);
2079     if (Tmp == 1) return 1;  // Early out.
2080
2081     // Special case decrementing a value (ADD X, -1):
2082     if (const auto *CRHS = dyn_cast<Constant>(U->getOperand(1)))
2083       if (CRHS->isAllOnesValue()) {
2084         APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
2085         computeKnownBits(U->getOperand(0), KnownZero, KnownOne, DL, Depth + 1,
2086                          Q);
2087
2088         // If the input is known to be 0 or 1, the output is 0/-1, which is all
2089         // sign bits set.
2090         if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
2091           return TyBits;
2092
2093         // If we are subtracting one from a positive number, there is no carry
2094         // out of the result.
2095         if (KnownZero.isNegative())
2096           return Tmp;
2097       }
2098
2099     Tmp2 = ComputeNumSignBits(U->getOperand(1), DL, Depth + 1, Q);
2100     if (Tmp2 == 1) return 1;
2101     return std::min(Tmp, Tmp2)-1;
2102
2103   case Instruction::Sub:
2104     Tmp2 = ComputeNumSignBits(U->getOperand(1), DL, Depth + 1, Q);
2105     if (Tmp2 == 1) return 1;
2106
2107     // Handle NEG.
2108     if (const auto *CLHS = dyn_cast<Constant>(U->getOperand(0)))
2109       if (CLHS->isNullValue()) {
2110         APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
2111         computeKnownBits(U->getOperand(1), KnownZero, KnownOne, DL, Depth + 1,
2112                          Q);
2113         // If the input is known to be 0 or 1, the output is 0/-1, which is all
2114         // sign bits set.
2115         if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
2116           return TyBits;
2117
2118         // If the input is known to be positive (the sign bit is known clear),
2119         // the output of the NEG has the same number of sign bits as the input.
2120         if (KnownZero.isNegative())
2121           return Tmp2;
2122
2123         // Otherwise, we treat this like a SUB.
2124       }
2125
2126     // Sub can have at most one carry bit.  Thus we know that the output
2127     // is, at worst, one more bit than the inputs.
2128     Tmp = ComputeNumSignBits(U->getOperand(0), DL, Depth + 1, Q);
2129     if (Tmp == 1) return 1;  // Early out.
2130     return std::min(Tmp, Tmp2)-1;
2131
2132   case Instruction::PHI: {
2133     PHINode *PN = cast<PHINode>(U);
2134     unsigned NumIncomingValues = PN->getNumIncomingValues();
2135     // Don't analyze large in-degree PHIs.
2136     if (NumIncomingValues > 4) break;
2137     // Unreachable blocks may have zero-operand PHI nodes.
2138     if (NumIncomingValues == 0) break;
2139
2140     // Take the minimum of all incoming values.  This can't infinitely loop
2141     // because of our depth threshold.
2142     Tmp = ComputeNumSignBits(PN->getIncomingValue(0), DL, Depth + 1, Q);
2143     for (unsigned i = 1, e = NumIncomingValues; i != e; ++i) {
2144       if (Tmp == 1) return Tmp;
2145       Tmp = std::min(
2146           Tmp, ComputeNumSignBits(PN->getIncomingValue(i), DL, Depth + 1, Q));
2147     }
2148     return Tmp;
2149   }
2150
2151   case Instruction::Trunc:
2152     // FIXME: it's tricky to do anything useful for this, but it is an important
2153     // case for targets like X86.
2154     break;
2155   }
2156
2157   // Finally, if we can prove that the top bits of the result are 0's or 1's,
2158   // use this information.
2159   APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
2160   APInt Mask;
2161   computeKnownBits(V, KnownZero, KnownOne, DL, Depth, Q);
2162
2163   if (KnownZero.isNegative()) {        // sign bit is 0
2164     Mask = KnownZero;
2165   } else if (KnownOne.isNegative()) {  // sign bit is 1;
2166     Mask = KnownOne;
2167   } else {
2168     // Nothing known.
2169     return FirstAnswer;
2170   }
2171
2172   // Okay, we know that the sign bit in Mask is set.  Use CLZ to determine
2173   // the number of identical bits in the top of the input value.
2174   Mask = ~Mask;
2175   Mask <<= Mask.getBitWidth()-TyBits;
2176   // Return # leading zeros.  We use 'min' here in case Val was zero before
2177   // shifting.  We don't want to return '64' as for an i32 "0".
2178   return std::max(FirstAnswer, std::min(TyBits, Mask.countLeadingZeros()));
2179 }
2180
2181 /// This function computes the integer multiple of Base that equals V.
2182 /// If successful, it returns true and returns the multiple in
2183 /// Multiple. If unsuccessful, it returns false. It looks
2184 /// through SExt instructions only if LookThroughSExt is true.
2185 bool llvm::ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
2186                            bool LookThroughSExt, unsigned Depth) {
2187   const unsigned MaxDepth = 6;
2188
2189   assert(V && "No Value?");
2190   assert(Depth <= MaxDepth && "Limit Search Depth");
2191   assert(V->getType()->isIntegerTy() && "Not integer or pointer type!");
2192
2193   Type *T = V->getType();
2194
2195   ConstantInt *CI = dyn_cast<ConstantInt>(V);
2196
2197   if (Base == 0)
2198     return false;
2199
2200   if (Base == 1) {
2201     Multiple = V;
2202     return true;
2203   }
2204
2205   ConstantExpr *CO = dyn_cast<ConstantExpr>(V);
2206   Constant *BaseVal = ConstantInt::get(T, Base);
2207   if (CO && CO == BaseVal) {
2208     // Multiple is 1.
2209     Multiple = ConstantInt::get(T, 1);
2210     return true;
2211   }
2212
2213   if (CI && CI->getZExtValue() % Base == 0) {
2214     Multiple = ConstantInt::get(T, CI->getZExtValue() / Base);
2215     return true;
2216   }
2217
2218   if (Depth == MaxDepth) return false;  // Limit search depth.
2219
2220   Operator *I = dyn_cast<Operator>(V);
2221   if (!I) return false;
2222
2223   switch (I->getOpcode()) {
2224   default: break;
2225   case Instruction::SExt:
2226     if (!LookThroughSExt) return false;
2227     // otherwise fall through to ZExt
2228   case Instruction::ZExt:
2229     return ComputeMultiple(I->getOperand(0), Base, Multiple,
2230                            LookThroughSExt, Depth+1);
2231   case Instruction::Shl:
2232   case Instruction::Mul: {
2233     Value *Op0 = I->getOperand(0);
2234     Value *Op1 = I->getOperand(1);
2235
2236     if (I->getOpcode() == Instruction::Shl) {
2237       ConstantInt *Op1CI = dyn_cast<ConstantInt>(Op1);
2238       if (!Op1CI) return false;
2239       // Turn Op0 << Op1 into Op0 * 2^Op1
2240       APInt Op1Int = Op1CI->getValue();
2241       uint64_t BitToSet = Op1Int.getLimitedValue(Op1Int.getBitWidth() - 1);
2242       APInt API(Op1Int.getBitWidth(), 0);
2243       API.setBit(BitToSet);
2244       Op1 = ConstantInt::get(V->getContext(), API);
2245     }
2246
2247     Value *Mul0 = nullptr;
2248     if (ComputeMultiple(Op0, Base, Mul0, LookThroughSExt, Depth+1)) {
2249       if (Constant *Op1C = dyn_cast<Constant>(Op1))
2250         if (Constant *MulC = dyn_cast<Constant>(Mul0)) {
2251           if (Op1C->getType()->getPrimitiveSizeInBits() <
2252               MulC->getType()->getPrimitiveSizeInBits())
2253             Op1C = ConstantExpr::getZExt(Op1C, MulC->getType());
2254           if (Op1C->getType()->getPrimitiveSizeInBits() >
2255               MulC->getType()->getPrimitiveSizeInBits())
2256             MulC = ConstantExpr::getZExt(MulC, Op1C->getType());
2257
2258           // V == Base * (Mul0 * Op1), so return (Mul0 * Op1)
2259           Multiple = ConstantExpr::getMul(MulC, Op1C);
2260           return true;
2261         }
2262
2263       if (ConstantInt *Mul0CI = dyn_cast<ConstantInt>(Mul0))
2264         if (Mul0CI->getValue() == 1) {
2265           // V == Base * Op1, so return Op1
2266           Multiple = Op1;
2267           return true;
2268         }
2269     }
2270
2271     Value *Mul1 = nullptr;
2272     if (ComputeMultiple(Op1, Base, Mul1, LookThroughSExt, Depth+1)) {
2273       if (Constant *Op0C = dyn_cast<Constant>(Op0))
2274         if (Constant *MulC = dyn_cast<Constant>(Mul1)) {
2275           if (Op0C->getType()->getPrimitiveSizeInBits() <
2276               MulC->getType()->getPrimitiveSizeInBits())
2277             Op0C = ConstantExpr::getZExt(Op0C, MulC->getType());
2278           if (Op0C->getType()->getPrimitiveSizeInBits() >
2279               MulC->getType()->getPrimitiveSizeInBits())
2280             MulC = ConstantExpr::getZExt(MulC, Op0C->getType());
2281
2282           // V == Base * (Mul1 * Op0), so return (Mul1 * Op0)
2283           Multiple = ConstantExpr::getMul(MulC, Op0C);
2284           return true;
2285         }
2286
2287       if (ConstantInt *Mul1CI = dyn_cast<ConstantInt>(Mul1))
2288         if (Mul1CI->getValue() == 1) {
2289           // V == Base * Op0, so return Op0
2290           Multiple = Op0;
2291           return true;
2292         }
2293     }
2294   }
2295   }
2296
2297   // We could not determine if V is a multiple of Base.
2298   return false;
2299 }
2300
2301 /// Return true if we can prove that the specified FP value is never equal to
2302 /// -0.0.
2303 ///
2304 /// NOTE: this function will need to be revisited when we support non-default
2305 /// rounding modes!
2306 ///
2307 bool llvm::CannotBeNegativeZero(const Value *V, unsigned Depth) {
2308   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V))
2309     return !CFP->getValueAPF().isNegZero();
2310
2311   // FIXME: Magic number! At the least, this should be given a name because it's
2312   // used similarly in CannotBeOrderedLessThanZero(). A better fix may be to
2313   // expose it as a parameter, so it can be used for testing / experimenting.
2314   if (Depth == 6)
2315     return false;  // Limit search depth.
2316
2317   const Operator *I = dyn_cast<Operator>(V);
2318   if (!I) return false;
2319
2320   // Check if the nsz fast-math flag is set
2321   if (const FPMathOperator *FPO = dyn_cast<FPMathOperator>(I))
2322     if (FPO->hasNoSignedZeros())
2323       return true;
2324
2325   // (add x, 0.0) is guaranteed to return +0.0, not -0.0.
2326   if (I->getOpcode() == Instruction::FAdd)
2327     if (ConstantFP *CFP = dyn_cast<ConstantFP>(I->getOperand(1)))
2328       if (CFP->isNullValue())
2329         return true;
2330
2331   // sitofp and uitofp turn into +0.0 for zero.
2332   if (isa<SIToFPInst>(I) || isa<UIToFPInst>(I))
2333     return true;
2334
2335   if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I))
2336     // sqrt(-0.0) = -0.0, no other negative results are possible.
2337     if (II->getIntrinsicID() == Intrinsic::sqrt)
2338       return CannotBeNegativeZero(II->getArgOperand(0), Depth+1);
2339
2340   if (const CallInst *CI = dyn_cast<CallInst>(I))
2341     if (const Function *F = CI->getCalledFunction()) {
2342       if (F->isDeclaration()) {
2343         // abs(x) != -0.0
2344         if (F->getName() == "abs") return true;
2345         // fabs[lf](x) != -0.0
2346         if (F->getName() == "fabs") return true;
2347         if (F->getName() == "fabsf") return true;
2348         if (F->getName() == "fabsl") return true;
2349         if (F->getName() == "sqrt" || F->getName() == "sqrtf" ||
2350             F->getName() == "sqrtl")
2351           return CannotBeNegativeZero(CI->getArgOperand(0), Depth+1);
2352       }
2353     }
2354
2355   return false;
2356 }
2357
2358 bool llvm::CannotBeOrderedLessThanZero(const Value *V, unsigned Depth) {
2359   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V))
2360     return !CFP->getValueAPF().isNegative() || CFP->getValueAPF().isZero();
2361
2362   // FIXME: Magic number! At the least, this should be given a name because it's
2363   // used similarly in CannotBeNegativeZero(). A better fix may be to
2364   // expose it as a parameter, so it can be used for testing / experimenting.
2365   if (Depth == 6)
2366     return false;  // Limit search depth.
2367
2368   const Operator *I = dyn_cast<Operator>(V);
2369   if (!I) return false;
2370
2371   switch (I->getOpcode()) {
2372   default: break;
2373   case Instruction::FMul:
2374     // x*x is always non-negative or a NaN.
2375     if (I->getOperand(0) == I->getOperand(1)) 
2376       return true;
2377     // Fall through
2378   case Instruction::FAdd:
2379   case Instruction::FDiv:
2380   case Instruction::FRem:
2381     return CannotBeOrderedLessThanZero(I->getOperand(0), Depth+1) &&
2382            CannotBeOrderedLessThanZero(I->getOperand(1), Depth+1);
2383   case Instruction::FPExt:
2384   case Instruction::FPTrunc:
2385     // Widening/narrowing never change sign.
2386     return CannotBeOrderedLessThanZero(I->getOperand(0), Depth+1);
2387   case Instruction::Call: 
2388     if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) 
2389       switch (II->getIntrinsicID()) {
2390       default: break;
2391       case Intrinsic::exp:
2392       case Intrinsic::exp2:
2393       case Intrinsic::fabs:
2394       case Intrinsic::sqrt:
2395         return true;
2396       case Intrinsic::powi: 
2397         if (ConstantInt *CI = dyn_cast<ConstantInt>(I->getOperand(1))) {
2398           // powi(x,n) is non-negative if n is even.
2399           if (CI->getBitWidth() <= 64 && CI->getSExtValue() % 2u == 0)
2400             return true;
2401         }
2402         return CannotBeOrderedLessThanZero(I->getOperand(0), Depth+1);
2403       case Intrinsic::fma:
2404       case Intrinsic::fmuladd:
2405         // x*x+y is non-negative if y is non-negative.
2406         return I->getOperand(0) == I->getOperand(1) && 
2407                CannotBeOrderedLessThanZero(I->getOperand(2), Depth+1);
2408       }
2409     break;
2410   }
2411   return false; 
2412 }
2413
2414 /// If the specified value can be set by repeating the same byte in memory,
2415 /// return the i8 value that it is represented with.  This is
2416 /// true for all i8 values obviously, but is also true for i32 0, i32 -1,
2417 /// i16 0xF0F0, double 0.0 etc.  If the value can't be handled with a repeated
2418 /// byte store (e.g. i16 0x1234), return null.
2419 Value *llvm::isBytewiseValue(Value *V) {
2420   // All byte-wide stores are splatable, even of arbitrary variables.
2421   if (V->getType()->isIntegerTy(8)) return V;
2422
2423   // Handle 'null' ConstantArrayZero etc.
2424   if (Constant *C = dyn_cast<Constant>(V))
2425     if (C->isNullValue())
2426       return Constant::getNullValue(Type::getInt8Ty(V->getContext()));
2427
2428   // Constant float and double values can be handled as integer values if the
2429   // corresponding integer value is "byteable".  An important case is 0.0.
2430   if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2431     if (CFP->getType()->isFloatTy())
2432       V = ConstantExpr::getBitCast(CFP, Type::getInt32Ty(V->getContext()));
2433     if (CFP->getType()->isDoubleTy())
2434       V = ConstantExpr::getBitCast(CFP, Type::getInt64Ty(V->getContext()));
2435     // Don't handle long double formats, which have strange constraints.
2436   }
2437
2438   // We can handle constant integers that are multiple of 8 bits.
2439   if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
2440     if (CI->getBitWidth() % 8 == 0) {
2441       assert(CI->getBitWidth() > 8 && "8 bits should be handled above!");
2442
2443       if (!CI->getValue().isSplat(8))
2444         return nullptr;
2445       return ConstantInt::get(V->getContext(), CI->getValue().trunc(8));
2446     }
2447   }
2448
2449   // A ConstantDataArray/Vector is splatable if all its members are equal and
2450   // also splatable.
2451   if (ConstantDataSequential *CA = dyn_cast<ConstantDataSequential>(V)) {
2452     Value *Elt = CA->getElementAsConstant(0);
2453     Value *Val = isBytewiseValue(Elt);
2454     if (!Val)
2455       return nullptr;
2456
2457     for (unsigned I = 1, E = CA->getNumElements(); I != E; ++I)
2458       if (CA->getElementAsConstant(I) != Elt)
2459         return nullptr;
2460
2461     return Val;
2462   }
2463
2464   // Conceptually, we could handle things like:
2465   //   %a = zext i8 %X to i16
2466   //   %b = shl i16 %a, 8
2467   //   %c = or i16 %a, %b
2468   // but until there is an example that actually needs this, it doesn't seem
2469   // worth worrying about.
2470   return nullptr;
2471 }
2472
2473
2474 // This is the recursive version of BuildSubAggregate. It takes a few different
2475 // arguments. Idxs is the index within the nested struct From that we are
2476 // looking at now (which is of type IndexedType). IdxSkip is the number of
2477 // indices from Idxs that should be left out when inserting into the resulting
2478 // struct. To is the result struct built so far, new insertvalue instructions
2479 // build on that.
2480 static Value *BuildSubAggregate(Value *From, Value* To, Type *IndexedType,
2481                                 SmallVectorImpl<unsigned> &Idxs,
2482                                 unsigned IdxSkip,
2483                                 Instruction *InsertBefore) {
2484   llvm::StructType *STy = dyn_cast<llvm::StructType>(IndexedType);
2485   if (STy) {
2486     // Save the original To argument so we can modify it
2487     Value *OrigTo = To;
2488     // General case, the type indexed by Idxs is a struct
2489     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2490       // Process each struct element recursively
2491       Idxs.push_back(i);
2492       Value *PrevTo = To;
2493       To = BuildSubAggregate(From, To, STy->getElementType(i), Idxs, IdxSkip,
2494                              InsertBefore);
2495       Idxs.pop_back();
2496       if (!To) {
2497         // Couldn't find any inserted value for this index? Cleanup
2498         while (PrevTo != OrigTo) {
2499           InsertValueInst* Del = cast<InsertValueInst>(PrevTo);
2500           PrevTo = Del->getAggregateOperand();
2501           Del->eraseFromParent();
2502         }
2503         // Stop processing elements
2504         break;
2505       }
2506     }
2507     // If we successfully found a value for each of our subaggregates
2508     if (To)
2509       return To;
2510   }
2511   // Base case, the type indexed by SourceIdxs is not a struct, or not all of
2512   // the struct's elements had a value that was inserted directly. In the latter
2513   // case, perhaps we can't determine each of the subelements individually, but
2514   // we might be able to find the complete struct somewhere.
2515
2516   // Find the value that is at that particular spot
2517   Value *V = FindInsertedValue(From, Idxs);
2518
2519   if (!V)
2520     return nullptr;
2521
2522   // Insert the value in the new (sub) aggregrate
2523   return llvm::InsertValueInst::Create(To, V, makeArrayRef(Idxs).slice(IdxSkip),
2524                                        "tmp", InsertBefore);
2525 }
2526
2527 // This helper takes a nested struct and extracts a part of it (which is again a
2528 // struct) into a new value. For example, given the struct:
2529 // { a, { b, { c, d }, e } }
2530 // and the indices "1, 1" this returns
2531 // { c, d }.
2532 //
2533 // It does this by inserting an insertvalue for each element in the resulting
2534 // struct, as opposed to just inserting a single struct. This will only work if
2535 // each of the elements of the substruct are known (ie, inserted into From by an
2536 // insertvalue instruction somewhere).
2537 //
2538 // All inserted insertvalue instructions are inserted before InsertBefore
2539 static Value *BuildSubAggregate(Value *From, ArrayRef<unsigned> idx_range,
2540                                 Instruction *InsertBefore) {
2541   assert(InsertBefore && "Must have someplace to insert!");
2542   Type *IndexedType = ExtractValueInst::getIndexedType(From->getType(),
2543                                                              idx_range);
2544   Value *To = UndefValue::get(IndexedType);
2545   SmallVector<unsigned, 10> Idxs(idx_range.begin(), idx_range.end());
2546   unsigned IdxSkip = Idxs.size();
2547
2548   return BuildSubAggregate(From, To, IndexedType, Idxs, IdxSkip, InsertBefore);
2549 }
2550
2551 /// Given an aggregrate and an sequence of indices, see if
2552 /// the scalar value indexed is already around as a register, for example if it
2553 /// were inserted directly into the aggregrate.
2554 ///
2555 /// If InsertBefore is not null, this function will duplicate (modified)
2556 /// insertvalues when a part of a nested struct is extracted.
2557 Value *llvm::FindInsertedValue(Value *V, ArrayRef<unsigned> idx_range,
2558                                Instruction *InsertBefore) {
2559   // Nothing to index? Just return V then (this is useful at the end of our
2560   // recursion).
2561   if (idx_range.empty())
2562     return V;
2563   // We have indices, so V should have an indexable type.
2564   assert((V->getType()->isStructTy() || V->getType()->isArrayTy()) &&
2565          "Not looking at a struct or array?");
2566   assert(ExtractValueInst::getIndexedType(V->getType(), idx_range) &&
2567          "Invalid indices for type?");
2568
2569   if (Constant *C = dyn_cast<Constant>(V)) {
2570     C = C->getAggregateElement(idx_range[0]);
2571     if (!C) return nullptr;
2572     return FindInsertedValue(C, idx_range.slice(1), InsertBefore);
2573   }
2574
2575   if (InsertValueInst *I = dyn_cast<InsertValueInst>(V)) {
2576     // Loop the indices for the insertvalue instruction in parallel with the
2577     // requested indices
2578     const unsigned *req_idx = idx_range.begin();
2579     for (const unsigned *i = I->idx_begin(), *e = I->idx_end();
2580          i != e; ++i, ++req_idx) {
2581       if (req_idx == idx_range.end()) {
2582         // We can't handle this without inserting insertvalues
2583         if (!InsertBefore)
2584           return nullptr;
2585
2586         // The requested index identifies a part of a nested aggregate. Handle
2587         // this specially. For example,
2588         // %A = insertvalue { i32, {i32, i32 } } undef, i32 10, 1, 0
2589         // %B = insertvalue { i32, {i32, i32 } } %A, i32 11, 1, 1
2590         // %C = extractvalue {i32, { i32, i32 } } %B, 1
2591         // This can be changed into
2592         // %A = insertvalue {i32, i32 } undef, i32 10, 0
2593         // %C = insertvalue {i32, i32 } %A, i32 11, 1
2594         // which allows the unused 0,0 element from the nested struct to be
2595         // removed.
2596         return BuildSubAggregate(V, makeArrayRef(idx_range.begin(), req_idx),
2597                                  InsertBefore);
2598       }
2599
2600       // This insert value inserts something else than what we are looking for.
2601       // See if the (aggregate) value inserted into has the value we are
2602       // looking for, then.
2603       if (*req_idx != *i)
2604         return FindInsertedValue(I->getAggregateOperand(), idx_range,
2605                                  InsertBefore);
2606     }
2607     // If we end up here, the indices of the insertvalue match with those
2608     // requested (though possibly only partially). Now we recursively look at
2609     // the inserted value, passing any remaining indices.
2610     return FindInsertedValue(I->getInsertedValueOperand(),
2611                              makeArrayRef(req_idx, idx_range.end()),
2612                              InsertBefore);
2613   }
2614
2615   if (ExtractValueInst *I = dyn_cast<ExtractValueInst>(V)) {
2616     // If we're extracting a value from an aggregate that was extracted from
2617     // something else, we can extract from that something else directly instead.
2618     // However, we will need to chain I's indices with the requested indices.
2619
2620     // Calculate the number of indices required
2621     unsigned size = I->getNumIndices() + idx_range.size();
2622     // Allocate some space to put the new indices in
2623     SmallVector<unsigned, 5> Idxs;
2624     Idxs.reserve(size);
2625     // Add indices from the extract value instruction
2626     Idxs.append(I->idx_begin(), I->idx_end());
2627
2628     // Add requested indices
2629     Idxs.append(idx_range.begin(), idx_range.end());
2630
2631     assert(Idxs.size() == size
2632            && "Number of indices added not correct?");
2633
2634     return FindInsertedValue(I->getAggregateOperand(), Idxs, InsertBefore);
2635   }
2636   // Otherwise, we don't know (such as, extracting from a function return value
2637   // or load instruction)
2638   return nullptr;
2639 }
2640
2641 /// Analyze the specified pointer to see if it can be expressed as a base
2642 /// pointer plus a constant offset. Return the base and offset to the caller.
2643 Value *llvm::GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
2644                                               const DataLayout &DL) {
2645   unsigned BitWidth = DL.getPointerTypeSizeInBits(Ptr->getType());
2646   APInt ByteOffset(BitWidth, 0);
2647   while (1) {
2648     if (Ptr->getType()->isVectorTy())
2649       break;
2650
2651     if (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
2652       APInt GEPOffset(BitWidth, 0);
2653       if (!GEP->accumulateConstantOffset(DL, GEPOffset))
2654         break;
2655
2656       ByteOffset += GEPOffset;
2657
2658       Ptr = GEP->getPointerOperand();
2659     } else if (Operator::getOpcode(Ptr) == Instruction::BitCast ||
2660                Operator::getOpcode(Ptr) == Instruction::AddrSpaceCast) {
2661       Ptr = cast<Operator>(Ptr)->getOperand(0);
2662     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(Ptr)) {
2663       if (GA->mayBeOverridden())
2664         break;
2665       Ptr = GA->getAliasee();
2666     } else {
2667       break;
2668     }
2669   }
2670   Offset = ByteOffset.getSExtValue();
2671   return Ptr;
2672 }
2673
2674
2675 /// This function computes the length of a null-terminated C string pointed to
2676 /// by V. If successful, it returns true and returns the string in Str.
2677 /// If unsuccessful, it returns false.
2678 bool llvm::getConstantStringInfo(const Value *V, StringRef &Str,
2679                                  uint64_t Offset, bool TrimAtNul) {
2680   assert(V);
2681
2682   // Look through bitcast instructions and geps.
2683   V = V->stripPointerCasts();
2684
2685   // If the value is a GEP instruction or constant expression, treat it as an
2686   // offset.
2687   if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
2688     // Make sure the GEP has exactly three arguments.
2689     if (GEP->getNumOperands() != 3)
2690       return false;
2691
2692     // Make sure the index-ee is a pointer to array of i8.
2693     PointerType *PT = cast<PointerType>(GEP->getOperand(0)->getType());
2694     ArrayType *AT = dyn_cast<ArrayType>(PT->getElementType());
2695     if (!AT || !AT->getElementType()->isIntegerTy(8))
2696       return false;
2697
2698     // Check to make sure that the first operand of the GEP is an integer and
2699     // has value 0 so that we are sure we're indexing into the initializer.
2700     const ConstantInt *FirstIdx = dyn_cast<ConstantInt>(GEP->getOperand(1));
2701     if (!FirstIdx || !FirstIdx->isZero())
2702       return false;
2703
2704     // If the second index isn't a ConstantInt, then this is a variable index
2705     // into the array.  If this occurs, we can't say anything meaningful about
2706     // the string.
2707     uint64_t StartIdx = 0;
2708     if (const ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(2)))
2709       StartIdx = CI->getZExtValue();
2710     else
2711       return false;
2712     return getConstantStringInfo(GEP->getOperand(0), Str, StartIdx + Offset,
2713                                  TrimAtNul);
2714   }
2715
2716   // The GEP instruction, constant or instruction, must reference a global
2717   // variable that is a constant and is initialized. The referenced constant
2718   // initializer is the array that we'll use for optimization.
2719   const GlobalVariable *GV = dyn_cast<GlobalVariable>(V);
2720   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer())
2721     return false;
2722
2723   // Handle the all-zeros case
2724   if (GV->getInitializer()->isNullValue()) {
2725     // This is a degenerate case. The initializer is constant zero so the
2726     // length of the string must be zero.
2727     Str = "";
2728     return true;
2729   }
2730
2731   // Must be a Constant Array
2732   const ConstantDataArray *Array =
2733     dyn_cast<ConstantDataArray>(GV->getInitializer());
2734   if (!Array || !Array->isString())
2735     return false;
2736
2737   // Get the number of elements in the array
2738   uint64_t NumElts = Array->getType()->getArrayNumElements();
2739
2740   // Start out with the entire array in the StringRef.
2741   Str = Array->getAsString();
2742
2743   if (Offset > NumElts)
2744     return false;
2745
2746   // Skip over 'offset' bytes.
2747   Str = Str.substr(Offset);
2748
2749   if (TrimAtNul) {
2750     // Trim off the \0 and anything after it.  If the array is not nul
2751     // terminated, we just return the whole end of string.  The client may know
2752     // some other way that the string is length-bound.
2753     Str = Str.substr(0, Str.find('\0'));
2754   }
2755   return true;
2756 }
2757
2758 // These next two are very similar to the above, but also look through PHI
2759 // nodes.
2760 // TODO: See if we can integrate these two together.
2761
2762 /// If we can compute the length of the string pointed to by
2763 /// the specified pointer, return 'len+1'.  If we can't, return 0.
2764 static uint64_t GetStringLengthH(Value *V, SmallPtrSetImpl<PHINode*> &PHIs) {
2765   // Look through noop bitcast instructions.
2766   V = V->stripPointerCasts();
2767
2768   // If this is a PHI node, there are two cases: either we have already seen it
2769   // or we haven't.
2770   if (PHINode *PN = dyn_cast<PHINode>(V)) {
2771     if (!PHIs.insert(PN).second)
2772       return ~0ULL;  // already in the set.
2773
2774     // If it was new, see if all the input strings are the same length.
2775     uint64_t LenSoFar = ~0ULL;
2776     for (Value *IncValue : PN->incoming_values()) {
2777       uint64_t Len = GetStringLengthH(IncValue, PHIs);
2778       if (Len == 0) return 0; // Unknown length -> unknown.
2779
2780       if (Len == ~0ULL) continue;
2781
2782       if (Len != LenSoFar && LenSoFar != ~0ULL)
2783         return 0;    // Disagree -> unknown.
2784       LenSoFar = Len;
2785     }
2786
2787     // Success, all agree.
2788     return LenSoFar;
2789   }
2790
2791   // strlen(select(c,x,y)) -> strlen(x) ^ strlen(y)
2792   if (SelectInst *SI = dyn_cast<SelectInst>(V)) {
2793     uint64_t Len1 = GetStringLengthH(SI->getTrueValue(), PHIs);
2794     if (Len1 == 0) return 0;
2795     uint64_t Len2 = GetStringLengthH(SI->getFalseValue(), PHIs);
2796     if (Len2 == 0) return 0;
2797     if (Len1 == ~0ULL) return Len2;
2798     if (Len2 == ~0ULL) return Len1;
2799     if (Len1 != Len2) return 0;
2800     return Len1;
2801   }
2802
2803   // Otherwise, see if we can read the string.
2804   StringRef StrData;
2805   if (!getConstantStringInfo(V, StrData))
2806     return 0;
2807
2808   return StrData.size()+1;
2809 }
2810
2811 /// If we can compute the length of the string pointed to by
2812 /// the specified pointer, return 'len+1'.  If we can't, return 0.
2813 uint64_t llvm::GetStringLength(Value *V) {
2814   if (!V->getType()->isPointerTy()) return 0;
2815
2816   SmallPtrSet<PHINode*, 32> PHIs;
2817   uint64_t Len = GetStringLengthH(V, PHIs);
2818   // If Len is ~0ULL, we had an infinite phi cycle: this is dead code, so return
2819   // an empty string as a length.
2820   return Len == ~0ULL ? 1 : Len;
2821 }
2822
2823 /// \brief \p PN defines a loop-variant pointer to an object.  Check if the
2824 /// previous iteration of the loop was referring to the same object as \p PN.
2825 static bool isSameUnderlyingObjectInLoop(PHINode *PN, LoopInfo *LI) {
2826   // Find the loop-defined value.
2827   Loop *L = LI->getLoopFor(PN->getParent());
2828   if (PN->getNumIncomingValues() != 2)
2829     return true;
2830
2831   // Find the value from previous iteration.
2832   auto *PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(0));
2833   if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
2834     PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(1));
2835   if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
2836     return true;
2837
2838   // If a new pointer is loaded in the loop, the pointer references a different
2839   // object in every iteration.  E.g.:
2840   //    for (i)
2841   //       int *p = a[i];
2842   //       ...
2843   if (auto *Load = dyn_cast<LoadInst>(PrevValue))
2844     if (!L->isLoopInvariant(Load->getPointerOperand()))
2845       return false;
2846   return true;
2847 }
2848
2849 Value *llvm::GetUnderlyingObject(Value *V, const DataLayout &DL,
2850                                  unsigned MaxLookup) {
2851   if (!V->getType()->isPointerTy())
2852     return V;
2853   for (unsigned Count = 0; MaxLookup == 0 || Count < MaxLookup; ++Count) {
2854     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
2855       V = GEP->getPointerOperand();
2856     } else if (Operator::getOpcode(V) == Instruction::BitCast ||
2857                Operator::getOpcode(V) == Instruction::AddrSpaceCast) {
2858       V = cast<Operator>(V)->getOperand(0);
2859     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
2860       if (GA->mayBeOverridden())
2861         return V;
2862       V = GA->getAliasee();
2863     } else {
2864       // See if InstructionSimplify knows any relevant tricks.
2865       if (Instruction *I = dyn_cast<Instruction>(V))
2866         // TODO: Acquire a DominatorTree and AssumptionCache and use them.
2867         if (Value *Simplified = SimplifyInstruction(I, DL, nullptr)) {
2868           V = Simplified;
2869           continue;
2870         }
2871
2872       return V;
2873     }
2874     assert(V->getType()->isPointerTy() && "Unexpected operand type!");
2875   }
2876   return V;
2877 }
2878
2879 void llvm::GetUnderlyingObjects(Value *V, SmallVectorImpl<Value *> &Objects,
2880                                 const DataLayout &DL, LoopInfo *LI,
2881                                 unsigned MaxLookup) {
2882   SmallPtrSet<Value *, 4> Visited;
2883   SmallVector<Value *, 4> Worklist;
2884   Worklist.push_back(V);
2885   do {
2886     Value *P = Worklist.pop_back_val();
2887     P = GetUnderlyingObject(P, DL, MaxLookup);
2888
2889     if (!Visited.insert(P).second)
2890       continue;
2891
2892     if (SelectInst *SI = dyn_cast<SelectInst>(P)) {
2893       Worklist.push_back(SI->getTrueValue());
2894       Worklist.push_back(SI->getFalseValue());
2895       continue;
2896     }
2897
2898     if (PHINode *PN = dyn_cast<PHINode>(P)) {
2899       // If this PHI changes the underlying object in every iteration of the
2900       // loop, don't look through it.  Consider:
2901       //   int **A;
2902       //   for (i) {
2903       //     Prev = Curr;     // Prev = PHI (Prev_0, Curr)
2904       //     Curr = A[i];
2905       //     *Prev, *Curr;
2906       //
2907       // Prev is tracking Curr one iteration behind so they refer to different
2908       // underlying objects.
2909       if (!LI || !LI->isLoopHeader(PN->getParent()) ||
2910           isSameUnderlyingObjectInLoop(PN, LI))
2911         for (Value *IncValue : PN->incoming_values())
2912           Worklist.push_back(IncValue);
2913       continue;
2914     }
2915
2916     Objects.push_back(P);
2917   } while (!Worklist.empty());
2918 }
2919
2920 /// Return true if the only users of this pointer are lifetime markers.
2921 bool llvm::onlyUsedByLifetimeMarkers(const Value *V) {
2922   for (const User *U : V->users()) {
2923     const IntrinsicInst *II = dyn_cast<IntrinsicInst>(U);
2924     if (!II) return false;
2925
2926     if (II->getIntrinsicID() != Intrinsic::lifetime_start &&
2927         II->getIntrinsicID() != Intrinsic::lifetime_end)
2928       return false;
2929   }
2930   return true;
2931 }
2932
2933 static bool isDereferenceableFromAttribute(const Value *BV, APInt Offset,
2934                                            Type *Ty, const DataLayout &DL,
2935                                            const Instruction *CtxI,
2936                                            const DominatorTree *DT,
2937                                            const TargetLibraryInfo *TLI) {
2938   assert(Offset.isNonNegative() && "offset can't be negative");
2939   assert(Ty->isSized() && "must be sized");
2940   
2941   APInt DerefBytes(Offset.getBitWidth(), 0);
2942   bool CheckForNonNull = false;
2943   if (const Argument *A = dyn_cast<Argument>(BV)) {
2944     DerefBytes = A->getDereferenceableBytes();
2945     if (!DerefBytes.getBoolValue()) {
2946       DerefBytes = A->getDereferenceableOrNullBytes();
2947       CheckForNonNull = true;
2948     }
2949   } else if (auto CS = ImmutableCallSite(BV)) {
2950     DerefBytes = CS.getDereferenceableBytes(0);
2951     if (!DerefBytes.getBoolValue()) {
2952       DerefBytes = CS.getDereferenceableOrNullBytes(0);
2953       CheckForNonNull = true;
2954     }
2955   } else if (const LoadInst *LI = dyn_cast<LoadInst>(BV)) {
2956     if (MDNode *MD = LI->getMetadata(LLVMContext::MD_dereferenceable)) {
2957       ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(0));
2958       DerefBytes = CI->getLimitedValue();
2959     }
2960     if (!DerefBytes.getBoolValue()) {
2961       if (MDNode *MD = 
2962               LI->getMetadata(LLVMContext::MD_dereferenceable_or_null)) {
2963         ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(0));
2964         DerefBytes = CI->getLimitedValue();
2965       }
2966       CheckForNonNull = true;
2967     }
2968   }
2969   
2970   if (DerefBytes.getBoolValue())
2971     if (DerefBytes.uge(Offset + DL.getTypeStoreSize(Ty)))
2972       if (!CheckForNonNull || isKnownNonNullAt(BV, CtxI, DT, TLI))
2973         return true;
2974
2975   return false;
2976 }
2977
2978 static bool isDereferenceableFromAttribute(const Value *V, const DataLayout &DL,
2979                                            const Instruction *CtxI,
2980                                            const DominatorTree *DT,
2981                                            const TargetLibraryInfo *TLI) {
2982   Type *VTy = V->getType();
2983   Type *Ty = VTy->getPointerElementType();
2984   if (!Ty->isSized())
2985     return false;
2986   
2987   APInt Offset(DL.getTypeStoreSizeInBits(VTy), 0);
2988   return isDereferenceableFromAttribute(V, Offset, Ty, DL, CtxI, DT, TLI);
2989 }
2990
2991 static bool isAligned(const Value *Base, APInt Offset, unsigned Align,
2992                       const DataLayout &DL) {
2993   APInt BaseAlign(Offset.getBitWidth(), 0);
2994   if (const AllocaInst *AI = dyn_cast<AllocaInst>(Base))
2995     BaseAlign = AI->getAlignment();
2996   else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Base))
2997     BaseAlign = GV->getAlignment();
2998   else if (const Argument *A = dyn_cast<Argument>(Base))
2999     BaseAlign = A->getParamAlignment();
3000   else if (auto CS = ImmutableCallSite(Base))
3001     BaseAlign = CS.getAttributes().getParamAlignment(AttributeSet::ReturnIndex);
3002   else if (const LoadInst *LI = dyn_cast<LoadInst>(Base))
3003     if (MDNode *MD = LI->getMetadata(LLVMContext::MD_align)) {
3004       ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(0));
3005       BaseAlign = CI->getLimitedValue();
3006     }
3007
3008   if (!BaseAlign) {
3009     Type *Ty = Base->getType()->getPointerElementType();
3010     BaseAlign = DL.getABITypeAlignment(Ty);
3011   }
3012
3013   APInt Alignment(Offset.getBitWidth(), Align);
3014
3015   assert(Alignment.isPowerOf2() && "must be a power of 2!");
3016   return BaseAlign.uge(Alignment) && !(Offset & (Alignment-1));
3017 }
3018
3019 static bool isAligned(const Value *Base, unsigned Align, const DataLayout &DL) {
3020   APInt Offset(DL.getTypeStoreSizeInBits(Base->getType()), 0);
3021   return isAligned(Base, Offset, Align, DL);
3022 }
3023
3024 /// Test if V is always a pointer to allocated and suitably aligned memory for
3025 /// a simple load or store.
3026 static bool isDereferenceableAndAlignedPointer(
3027     const Value *V, unsigned Align, const DataLayout &DL,
3028     const Instruction *CtxI, const DominatorTree *DT,
3029     const TargetLibraryInfo *TLI, SmallPtrSetImpl<const Value *> &Visited) {
3030   // Note that it is not safe to speculate into a malloc'd region because
3031   // malloc may return null.
3032
3033   // These are obviously ok if aligned.
3034   if (isa<AllocaInst>(V))
3035     return isAligned(V, Align, DL);
3036
3037   // It's not always safe to follow a bitcast, for example:
3038   //   bitcast i8* (alloca i8) to i32*
3039   // would result in a 4-byte load from a 1-byte alloca. However,
3040   // if we're casting from a pointer from a type of larger size
3041   // to a type of smaller size (or the same size), and the alignment
3042   // is at least as large as for the resulting pointer type, then
3043   // we can look through the bitcast.
3044   if (const BitCastOperator *BC = dyn_cast<BitCastOperator>(V)) {
3045     Type *STy = BC->getSrcTy()->getPointerElementType(),
3046          *DTy = BC->getDestTy()->getPointerElementType();
3047     if (STy->isSized() && DTy->isSized() &&
3048         (DL.getTypeStoreSize(STy) >= DL.getTypeStoreSize(DTy)) &&
3049         (DL.getABITypeAlignment(STy) >= DL.getABITypeAlignment(DTy)))
3050       return isDereferenceableAndAlignedPointer(BC->getOperand(0), Align, DL,
3051                                                 CtxI, DT, TLI, Visited);
3052   }
3053
3054   // Global variables which can't collapse to null are ok.
3055   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
3056     if (!GV->hasExternalWeakLinkage())
3057       return isAligned(V, Align, DL);
3058
3059   // byval arguments are okay.
3060   if (const Argument *A = dyn_cast<Argument>(V))
3061     if (A->hasByValAttr())
3062       return isAligned(V, Align, DL);
3063
3064   if (isDereferenceableFromAttribute(V, DL, CtxI, DT, TLI))
3065     return isAligned(V, Align, DL);
3066
3067   // For GEPs, determine if the indexing lands within the allocated object.
3068   if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
3069     Type *VTy = GEP->getType();
3070     Type *Ty = VTy->getPointerElementType();
3071     const Value *Base = GEP->getPointerOperand();
3072
3073     // Conservatively require that the base pointer be fully dereferenceable
3074     // and aligned.
3075     if (!Visited.insert(Base).second)
3076       return false;
3077     if (!isDereferenceableAndAlignedPointer(Base, Align, DL, CtxI, DT, TLI,
3078                                             Visited))
3079       return false;
3080
3081     APInt Offset(DL.getPointerTypeSizeInBits(VTy), 0);
3082     if (!GEP->accumulateConstantOffset(DL, Offset))
3083       return false;
3084
3085     // Check if the load is within the bounds of the underlying object
3086     // and offset is aligned.
3087     uint64_t LoadSize = DL.getTypeStoreSize(Ty);
3088     Type *BaseType = Base->getType()->getPointerElementType();
3089     assert(isPowerOf2_32(Align) && "must be a power of 2!");
3090     return (Offset + LoadSize).ule(DL.getTypeAllocSize(BaseType)) && 
3091            !(Offset & APInt(Offset.getBitWidth(), Align-1));
3092   }
3093
3094   // For gc.relocate, look through relocations
3095   if (const IntrinsicInst *I = dyn_cast<IntrinsicInst>(V))
3096     if (I->getIntrinsicID() == Intrinsic::experimental_gc_relocate) {
3097       GCRelocateOperands RelocateInst(I);
3098       return isDereferenceableAndAlignedPointer(
3099           RelocateInst.getDerivedPtr(), Align, DL, CtxI, DT, TLI, Visited);
3100     }
3101
3102   if (const AddrSpaceCastInst *ASC = dyn_cast<AddrSpaceCastInst>(V))
3103     return isDereferenceableAndAlignedPointer(ASC->getOperand(0), Align, DL,
3104                                               CtxI, DT, TLI, Visited);
3105
3106   // If we don't know, assume the worst.
3107   return false;
3108 }
3109
3110 bool llvm::isDereferenceableAndAlignedPointer(const Value *V, unsigned Align,
3111                                               const DataLayout &DL,
3112                                               const Instruction *CtxI,
3113                                               const DominatorTree *DT,
3114                                               const TargetLibraryInfo *TLI) {
3115   // When dereferenceability information is provided by a dereferenceable
3116   // attribute, we know exactly how many bytes are dereferenceable. If we can
3117   // determine the exact offset to the attributed variable, we can use that
3118   // information here.
3119   Type *VTy = V->getType();
3120   Type *Ty = VTy->getPointerElementType();
3121
3122   // Require ABI alignment for loads without alignment specification
3123   if (Align == 0)
3124     Align = DL.getABITypeAlignment(Ty);
3125
3126   if (Ty->isSized()) {
3127     APInt Offset(DL.getTypeStoreSizeInBits(VTy), 0);
3128     const Value *BV = V->stripAndAccumulateInBoundsConstantOffsets(DL, Offset);
3129
3130     if (Offset.isNonNegative())
3131       if (isDereferenceableFromAttribute(BV, Offset, Ty, DL, CtxI, DT, TLI) &&
3132           isAligned(BV, Offset, Align, DL))
3133         return true;
3134   }
3135
3136   SmallPtrSet<const Value *, 32> Visited;
3137   return ::isDereferenceableAndAlignedPointer(V, Align, DL, CtxI, DT, TLI,
3138                                               Visited);
3139 }
3140
3141 bool llvm::isDereferenceablePointer(const Value *V, const DataLayout &DL,
3142                                     const Instruction *CtxI,
3143                                     const DominatorTree *DT,
3144                                     const TargetLibraryInfo *TLI) {
3145   return isDereferenceableAndAlignedPointer(V, 1, DL, CtxI, DT, TLI);
3146 }
3147
3148 bool llvm::isSafeToSpeculativelyExecute(const Value *V,
3149                                         const Instruction *CtxI,
3150                                         const DominatorTree *DT,
3151                                         const TargetLibraryInfo *TLI) {
3152   const Operator *Inst = dyn_cast<Operator>(V);
3153   if (!Inst)
3154     return false;
3155
3156   for (unsigned i = 0, e = Inst->getNumOperands(); i != e; ++i)
3157     if (Constant *C = dyn_cast<Constant>(Inst->getOperand(i)))
3158       if (C->canTrap())
3159         return false;
3160
3161   switch (Inst->getOpcode()) {
3162   default:
3163     return true;
3164   case Instruction::UDiv:
3165   case Instruction::URem: {
3166     // x / y is undefined if y == 0.
3167     const APInt *V;
3168     if (match(Inst->getOperand(1), m_APInt(V)))
3169       return *V != 0;
3170     return false;
3171   }
3172   case Instruction::SDiv:
3173   case Instruction::SRem: {
3174     // x / y is undefined if y == 0 or x == INT_MIN and y == -1
3175     const APInt *Numerator, *Denominator;
3176     if (!match(Inst->getOperand(1), m_APInt(Denominator)))
3177       return false;
3178     // We cannot hoist this division if the denominator is 0.
3179     if (*Denominator == 0)
3180       return false;
3181     // It's safe to hoist if the denominator is not 0 or -1.
3182     if (*Denominator != -1)
3183       return true;
3184     // At this point we know that the denominator is -1.  It is safe to hoist as
3185     // long we know that the numerator is not INT_MIN.
3186     if (match(Inst->getOperand(0), m_APInt(Numerator)))
3187       return !Numerator->isMinSignedValue();
3188     // The numerator *might* be MinSignedValue.
3189     return false;
3190   }
3191   case Instruction::Load: {
3192     const LoadInst *LI = cast<LoadInst>(Inst);
3193     if (!LI->isUnordered() ||
3194         // Speculative load may create a race that did not exist in the source.
3195         LI->getParent()->getParent()->hasFnAttribute(Attribute::SanitizeThread))
3196       return false;
3197     const DataLayout &DL = LI->getModule()->getDataLayout();
3198     return isDereferenceableAndAlignedPointer(
3199         LI->getPointerOperand(), LI->getAlignment(), DL, CtxI, DT, TLI);
3200   }
3201   case Instruction::Call: {
3202     if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
3203       switch (II->getIntrinsicID()) {
3204       // These synthetic intrinsics have no side-effects and just mark
3205       // information about their operands.
3206       // FIXME: There are other no-op synthetic instructions that potentially
3207       // should be considered at least *safe* to speculate...
3208       case Intrinsic::dbg_declare:
3209       case Intrinsic::dbg_value:
3210         return true;
3211
3212       case Intrinsic::bswap:
3213       case Intrinsic::ctlz:
3214       case Intrinsic::ctpop:
3215       case Intrinsic::cttz:
3216       case Intrinsic::objectsize:
3217       case Intrinsic::sadd_with_overflow:
3218       case Intrinsic::smul_with_overflow:
3219       case Intrinsic::ssub_with_overflow:
3220       case Intrinsic::uadd_with_overflow:
3221       case Intrinsic::umul_with_overflow:
3222       case Intrinsic::usub_with_overflow:
3223         return true;
3224       // Sqrt should be OK, since the llvm sqrt intrinsic isn't defined to set
3225       // errno like libm sqrt would.
3226       case Intrinsic::sqrt:
3227       case Intrinsic::fma:
3228       case Intrinsic::fmuladd:
3229       case Intrinsic::fabs:
3230       case Intrinsic::minnum:
3231       case Intrinsic::maxnum:
3232         return true;
3233       // TODO: some fp intrinsics are marked as having the same error handling
3234       // as libm. They're safe to speculate when they won't error.
3235       // TODO: are convert_{from,to}_fp16 safe?
3236       // TODO: can we list target-specific intrinsics here?
3237       default: break;
3238       }
3239     }
3240     return false; // The called function could have undefined behavior or
3241                   // side-effects, even if marked readnone nounwind.
3242   }
3243   case Instruction::VAArg:
3244   case Instruction::Alloca:
3245   case Instruction::Invoke:
3246   case Instruction::PHI:
3247   case Instruction::Store:
3248   case Instruction::Ret:
3249   case Instruction::Br:
3250   case Instruction::IndirectBr:
3251   case Instruction::Switch:
3252   case Instruction::Unreachable:
3253   case Instruction::Fence:
3254   case Instruction::AtomicRMW:
3255   case Instruction::AtomicCmpXchg:
3256   case Instruction::LandingPad:
3257   case Instruction::Resume:
3258   case Instruction::CatchPad:
3259   case Instruction::CatchEndPad:
3260   case Instruction::CatchRet:
3261   case Instruction::CleanupPad:
3262   case Instruction::CleanupEndPad:
3263   case Instruction::CleanupRet:
3264   case Instruction::TerminatePad:
3265     return false; // Misc instructions which have effects
3266   }
3267 }
3268
3269 bool llvm::mayBeMemoryDependent(const Instruction &I) {
3270   return I.mayReadOrWriteMemory() || !isSafeToSpeculativelyExecute(&I);
3271 }
3272
3273 /// Return true if we know that the specified value is never null.
3274 bool llvm::isKnownNonNull(const Value *V, const TargetLibraryInfo *TLI) {
3275   assert(V->getType()->isPointerTy() && "V must be pointer type");
3276
3277   // Alloca never returns null, malloc might.
3278   if (isa<AllocaInst>(V)) return true;
3279
3280   // A byval, inalloca, or nonnull argument is never null.
3281   if (const Argument *A = dyn_cast<Argument>(V))
3282     return A->hasByValOrInAllocaAttr() || A->hasNonNullAttr();
3283
3284   // A global variable in address space 0 is non null unless extern weak.
3285   // Other address spaces may have null as a valid address for a global,
3286   // so we can't assume anything.
3287   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
3288     return !GV->hasExternalWeakLinkage() &&
3289            GV->getType()->getAddressSpace() == 0;
3290
3291   // A Load tagged w/nonnull metadata is never null. 
3292   if (const LoadInst *LI = dyn_cast<LoadInst>(V))
3293     return LI->getMetadata(LLVMContext::MD_nonnull);
3294
3295   if (auto CS = ImmutableCallSite(V))
3296     if (CS.isReturnNonNull())
3297       return true;
3298
3299   // operator new never returns null.
3300   if (isOperatorNewLikeFn(V, TLI, /*LookThroughBitCast=*/true))
3301     return true;
3302
3303   return false;
3304 }
3305
3306 static bool isKnownNonNullFromDominatingCondition(const Value *V,
3307                                                   const Instruction *CtxI,
3308                                                   const DominatorTree *DT) {
3309   assert(V->getType()->isPointerTy() && "V must be pointer type");
3310
3311   unsigned NumUsesExplored = 0;
3312   for (auto U : V->users()) {
3313     // Avoid massive lists
3314     if (NumUsesExplored >= DomConditionsMaxUses)
3315       break;
3316     NumUsesExplored++;
3317     // Consider only compare instructions uniquely controlling a branch
3318     const ICmpInst *Cmp = dyn_cast<ICmpInst>(U);
3319     if (!Cmp)
3320       continue;
3321
3322     if (DomConditionsSingleCmpUse && !Cmp->hasOneUse())
3323       continue;
3324
3325     for (auto *CmpU : Cmp->users()) {
3326       const BranchInst *BI = dyn_cast<BranchInst>(CmpU);
3327       if (!BI)
3328         continue;
3329       
3330       assert(BI->isConditional() && "uses a comparison!");
3331
3332       BasicBlock *NonNullSuccessor = nullptr;
3333       CmpInst::Predicate Pred;
3334
3335       if (match(const_cast<ICmpInst*>(Cmp),
3336                 m_c_ICmp(Pred, m_Specific(V), m_Zero()))) {
3337         if (Pred == ICmpInst::ICMP_EQ)
3338           NonNullSuccessor = BI->getSuccessor(1);
3339         else if (Pred == ICmpInst::ICMP_NE)
3340           NonNullSuccessor = BI->getSuccessor(0);
3341       }
3342
3343       if (NonNullSuccessor) {
3344         BasicBlockEdge Edge(BI->getParent(), NonNullSuccessor);
3345         if (Edge.isSingleEdge() && DT->dominates(Edge, CtxI->getParent()))
3346           return true;
3347       }
3348     }
3349   }
3350
3351   return false;
3352 }
3353
3354 bool llvm::isKnownNonNullAt(const Value *V, const Instruction *CtxI,
3355                    const DominatorTree *DT, const TargetLibraryInfo *TLI) {
3356   if (isKnownNonNull(V, TLI))
3357     return true;
3358
3359   return CtxI ? ::isKnownNonNullFromDominatingCondition(V, CtxI, DT) : false;
3360 }
3361
3362 OverflowResult llvm::computeOverflowForUnsignedMul(Value *LHS, Value *RHS,
3363                                                    const DataLayout &DL,
3364                                                    AssumptionCache *AC,
3365                                                    const Instruction *CxtI,
3366                                                    const DominatorTree *DT) {
3367   // Multiplying n * m significant bits yields a result of n + m significant
3368   // bits. If the total number of significant bits does not exceed the
3369   // result bit width (minus 1), there is no overflow.
3370   // This means if we have enough leading zero bits in the operands
3371   // we can guarantee that the result does not overflow.
3372   // Ref: "Hacker's Delight" by Henry Warren
3373   unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
3374   APInt LHSKnownZero(BitWidth, 0);
3375   APInt LHSKnownOne(BitWidth, 0);
3376   APInt RHSKnownZero(BitWidth, 0);
3377   APInt RHSKnownOne(BitWidth, 0);
3378   computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, DL, /*Depth=*/0, AC, CxtI,
3379                    DT);
3380   computeKnownBits(RHS, RHSKnownZero, RHSKnownOne, DL, /*Depth=*/0, AC, CxtI,
3381                    DT);
3382   // Note that underestimating the number of zero bits gives a more
3383   // conservative answer.
3384   unsigned ZeroBits = LHSKnownZero.countLeadingOnes() +
3385                       RHSKnownZero.countLeadingOnes();
3386   // First handle the easy case: if we have enough zero bits there's
3387   // definitely no overflow.
3388   if (ZeroBits >= BitWidth)
3389     return OverflowResult::NeverOverflows;
3390
3391   // Get the largest possible values for each operand.
3392   APInt LHSMax = ~LHSKnownZero;
3393   APInt RHSMax = ~RHSKnownZero;
3394
3395   // We know the multiply operation doesn't overflow if the maximum values for
3396   // each operand will not overflow after we multiply them together.
3397   bool MaxOverflow;
3398   LHSMax.umul_ov(RHSMax, MaxOverflow);
3399   if (!MaxOverflow)
3400     return OverflowResult::NeverOverflows;
3401
3402   // We know it always overflows if multiplying the smallest possible values for
3403   // the operands also results in overflow.
3404   bool MinOverflow;
3405   LHSKnownOne.umul_ov(RHSKnownOne, MinOverflow);
3406   if (MinOverflow)
3407     return OverflowResult::AlwaysOverflows;
3408
3409   return OverflowResult::MayOverflow;
3410 }
3411
3412 OverflowResult llvm::computeOverflowForUnsignedAdd(Value *LHS, Value *RHS,
3413                                                    const DataLayout &DL,
3414                                                    AssumptionCache *AC,
3415                                                    const Instruction *CxtI,
3416                                                    const DominatorTree *DT) {
3417   bool LHSKnownNonNegative, LHSKnownNegative;
3418   ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, DL, /*Depth=*/0,
3419                  AC, CxtI, DT);
3420   if (LHSKnownNonNegative || LHSKnownNegative) {
3421     bool RHSKnownNonNegative, RHSKnownNegative;
3422     ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, DL, /*Depth=*/0,
3423                    AC, CxtI, DT);
3424
3425     if (LHSKnownNegative && RHSKnownNegative) {
3426       // The sign bit is set in both cases: this MUST overflow.
3427       // Create a simple add instruction, and insert it into the struct.
3428       return OverflowResult::AlwaysOverflows;
3429     }
3430
3431     if (LHSKnownNonNegative && RHSKnownNonNegative) {
3432       // The sign bit is clear in both cases: this CANNOT overflow.
3433       // Create a simple add instruction, and insert it into the struct.
3434       return OverflowResult::NeverOverflows;
3435     }
3436   }
3437
3438   return OverflowResult::MayOverflow;
3439 }
3440
3441 static OverflowResult computeOverflowForSignedAdd(
3442     Value *LHS, Value *RHS, AddOperator *Add, const DataLayout &DL,
3443     AssumptionCache *AC, const Instruction *CxtI, const DominatorTree *DT) {
3444   if (Add && Add->hasNoSignedWrap()) {
3445     return OverflowResult::NeverOverflows;
3446   }
3447
3448   bool LHSKnownNonNegative, LHSKnownNegative;
3449   bool RHSKnownNonNegative, RHSKnownNegative;
3450   ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, DL, /*Depth=*/0,
3451                  AC, CxtI, DT);
3452   ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, DL, /*Depth=*/0,
3453                  AC, CxtI, DT);
3454
3455   if ((LHSKnownNonNegative && RHSKnownNegative) ||
3456       (LHSKnownNegative && RHSKnownNonNegative)) {
3457     // The sign bits are opposite: this CANNOT overflow.
3458     return OverflowResult::NeverOverflows;
3459   }
3460
3461   // The remaining code needs Add to be available. Early returns if not so.
3462   if (!Add)
3463     return OverflowResult::MayOverflow;
3464
3465   // If the sign of Add is the same as at least one of the operands, this add
3466   // CANNOT overflow. This is particularly useful when the sum is
3467   // @llvm.assume'ed non-negative rather than proved so from analyzing its
3468   // operands.
3469   bool LHSOrRHSKnownNonNegative =
3470       (LHSKnownNonNegative || RHSKnownNonNegative);
3471   bool LHSOrRHSKnownNegative = (LHSKnownNegative || RHSKnownNegative);
3472   if (LHSOrRHSKnownNonNegative || LHSOrRHSKnownNegative) {
3473     bool AddKnownNonNegative, AddKnownNegative;
3474     ComputeSignBit(Add, AddKnownNonNegative, AddKnownNegative, DL,
3475                    /*Depth=*/0, AC, CxtI, DT);
3476     if ((AddKnownNonNegative && LHSOrRHSKnownNonNegative) ||
3477         (AddKnownNegative && LHSOrRHSKnownNegative)) {
3478       return OverflowResult::NeverOverflows;
3479     }
3480   }
3481
3482   return OverflowResult::MayOverflow;
3483 }
3484
3485 OverflowResult llvm::computeOverflowForSignedAdd(AddOperator *Add,
3486                                                  const DataLayout &DL,
3487                                                  AssumptionCache *AC,
3488                                                  const Instruction *CxtI,
3489                                                  const DominatorTree *DT) {
3490   return ::computeOverflowForSignedAdd(Add->getOperand(0), Add->getOperand(1),
3491                                        Add, DL, AC, CxtI, DT);
3492 }
3493
3494 OverflowResult llvm::computeOverflowForSignedAdd(Value *LHS, Value *RHS,
3495                                                  const DataLayout &DL,
3496                                                  AssumptionCache *AC,
3497                                                  const Instruction *CxtI,
3498                                                  const DominatorTree *DT) {
3499   return ::computeOverflowForSignedAdd(LHS, RHS, nullptr, DL, AC, CxtI, DT);
3500 }
3501
3502 bool llvm::isGuaranteedToTransferExecutionToSuccessor(const Instruction *I) {
3503   // FIXME: This conservative implementation can be relaxed. E.g. most
3504   // atomic operations are guaranteed to terminate on most platforms
3505   // and most functions terminate.
3506
3507   return !I->isAtomic() &&       // atomics may never succeed on some platforms
3508          !isa<CallInst>(I) &&    // could throw and might not terminate
3509          !isa<InvokeInst>(I) &&  // might not terminate and could throw to
3510                                  //   non-successor (see bug 24185 for details).
3511          !isa<ResumeInst>(I) &&  // has no successors
3512          !isa<ReturnInst>(I);    // has no successors
3513 }
3514
3515 bool llvm::isGuaranteedToExecuteForEveryIteration(const Instruction *I,
3516                                                   const Loop *L) {
3517   // The loop header is guaranteed to be executed for every iteration.
3518   //
3519   // FIXME: Relax this constraint to cover all basic blocks that are
3520   // guaranteed to be executed at every iteration.
3521   if (I->getParent() != L->getHeader()) return false;
3522
3523   for (const Instruction &LI : *L->getHeader()) {
3524     if (&LI == I) return true;
3525     if (!isGuaranteedToTransferExecutionToSuccessor(&LI)) return false;
3526   }
3527   llvm_unreachable("Instruction not contained in its own parent basic block.");
3528 }
3529
3530 bool llvm::propagatesFullPoison(const Instruction *I) {
3531   switch (I->getOpcode()) {
3532     case Instruction::Add:
3533     case Instruction::Sub:
3534     case Instruction::Xor:
3535     case Instruction::Trunc:
3536     case Instruction::BitCast:
3537     case Instruction::AddrSpaceCast:
3538       // These operations all propagate poison unconditionally. Note that poison
3539       // is not any particular value, so xor or subtraction of poison with
3540       // itself still yields poison, not zero.
3541       return true;
3542
3543     case Instruction::AShr:
3544     case Instruction::SExt:
3545       // For these operations, one bit of the input is replicated across
3546       // multiple output bits. A replicated poison bit is still poison.
3547       return true;
3548
3549     case Instruction::Shl: {
3550       // Left shift *by* a poison value is poison. The number of
3551       // positions to shift is unsigned, so no negative values are
3552       // possible there. Left shift by zero places preserves poison. So
3553       // it only remains to consider left shift of poison by a positive
3554       // number of places.
3555       //
3556       // A left shift by a positive number of places leaves the lowest order bit
3557       // non-poisoned. However, if such a shift has a no-wrap flag, then we can
3558       // make the poison operand violate that flag, yielding a fresh full-poison
3559       // value.
3560       auto *OBO = cast<OverflowingBinaryOperator>(I);
3561       return OBO->hasNoUnsignedWrap() || OBO->hasNoSignedWrap();
3562     }
3563
3564     case Instruction::Mul: {
3565       // A multiplication by zero yields a non-poison zero result, so we need to
3566       // rule out zero as an operand. Conservatively, multiplication by a
3567       // non-zero constant is not multiplication by zero.
3568       //
3569       // Multiplication by a non-zero constant can leave some bits
3570       // non-poisoned. For example, a multiplication by 2 leaves the lowest
3571       // order bit unpoisoned. So we need to consider that.
3572       //
3573       // Multiplication by 1 preserves poison. If the multiplication has a
3574       // no-wrap flag, then we can make the poison operand violate that flag
3575       // when multiplied by any integer other than 0 and 1.
3576       auto *OBO = cast<OverflowingBinaryOperator>(I);
3577       if (OBO->hasNoUnsignedWrap() || OBO->hasNoSignedWrap()) {
3578         for (Value *V : OBO->operands()) {
3579           if (auto *CI = dyn_cast<ConstantInt>(V)) {
3580             // A ConstantInt cannot yield poison, so we can assume that it is
3581             // the other operand that is poison.
3582             return !CI->isZero();
3583           }
3584         }
3585       }
3586       return false;
3587     }
3588
3589     case Instruction::GetElementPtr:
3590       // A GEP implicitly represents a sequence of additions, subtractions,
3591       // truncations, sign extensions and multiplications. The multiplications
3592       // are by the non-zero sizes of some set of types, so we do not have to be
3593       // concerned with multiplication by zero. If the GEP is in-bounds, then
3594       // these operations are implicitly no-signed-wrap so poison is propagated
3595       // by the arguments above for Add, Sub, Trunc, SExt and Mul.
3596       return cast<GEPOperator>(I)->isInBounds();
3597
3598     default:
3599       return false;
3600   }
3601 }
3602
3603 const Value *llvm::getGuaranteedNonFullPoisonOp(const Instruction *I) {
3604   switch (I->getOpcode()) {
3605     case Instruction::Store:
3606       return cast<StoreInst>(I)->getPointerOperand();
3607
3608     case Instruction::Load:
3609       return cast<LoadInst>(I)->getPointerOperand();
3610
3611     case Instruction::AtomicCmpXchg:
3612       return cast<AtomicCmpXchgInst>(I)->getPointerOperand();
3613
3614     case Instruction::AtomicRMW:
3615       return cast<AtomicRMWInst>(I)->getPointerOperand();
3616
3617     case Instruction::UDiv:
3618     case Instruction::SDiv:
3619     case Instruction::URem:
3620     case Instruction::SRem:
3621       return I->getOperand(1);
3622
3623     default:
3624       return nullptr;
3625   }
3626 }
3627
3628 bool llvm::isKnownNotFullPoison(const Instruction *PoisonI) {
3629   // We currently only look for uses of poison values within the same basic
3630   // block, as that makes it easier to guarantee that the uses will be
3631   // executed given that PoisonI is executed.
3632   //
3633   // FIXME: Expand this to consider uses beyond the same basic block. To do
3634   // this, look out for the distinction between post-dominance and strong
3635   // post-dominance.
3636   const BasicBlock *BB = PoisonI->getParent();
3637
3638   // Set of instructions that we have proved will yield poison if PoisonI
3639   // does.
3640   SmallSet<const Value *, 16> YieldsPoison;
3641   YieldsPoison.insert(PoisonI);
3642
3643   for (const Instruction *I = PoisonI, *E = BB->end(); I != E;
3644        I = I->getNextNode()) {
3645     if (I != PoisonI) {
3646       const Value *NotPoison = getGuaranteedNonFullPoisonOp(I);
3647       if (NotPoison != nullptr && YieldsPoison.count(NotPoison)) return true;
3648       if (!isGuaranteedToTransferExecutionToSuccessor(I)) return false;
3649     }
3650
3651     // Mark poison that propagates from I through uses of I.
3652     if (YieldsPoison.count(I)) {
3653       for (const User *User : I->users()) {
3654         const Instruction *UserI = cast<Instruction>(User);
3655         if (UserI->getParent() == BB && propagatesFullPoison(UserI))
3656           YieldsPoison.insert(User);
3657       }
3658     }
3659   }
3660   return false;
3661 }
3662
3663 static bool isKnownNonNaN(Value *V, FastMathFlags FMF) {
3664   if (FMF.noNaNs())
3665     return true;
3666
3667   if (auto *C = dyn_cast<ConstantFP>(V))
3668     return !C->isNaN();
3669   return false;
3670 }
3671
3672 static bool isKnownNonZero(Value *V) {
3673   if (auto *C = dyn_cast<ConstantFP>(V))
3674     return !C->isZero();
3675   return false;
3676 }
3677
3678 static SelectPatternResult matchSelectPattern(CmpInst::Predicate Pred,
3679                                               FastMathFlags FMF,
3680                                               Value *CmpLHS, Value *CmpRHS,
3681                                               Value *TrueVal, Value *FalseVal,
3682                                               Value *&LHS, Value *&RHS) {
3683   LHS = CmpLHS;
3684   RHS = CmpRHS;
3685
3686   // If the predicate is an "or-equal"  (FP) predicate, then signed zeroes may
3687   // return inconsistent results between implementations.
3688   //   (0.0 <= -0.0) ? 0.0 : -0.0 // Returns 0.0
3689   //   minNum(0.0, -0.0)          // May return -0.0 or 0.0 (IEEE 754-2008 5.3.1)
3690   // Therefore we behave conservatively and only proceed if at least one of the
3691   // operands is known to not be zero, or if we don't care about signed zeroes.
3692   switch (Pred) {
3693   default: break;
3694   case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLE:
3695   case CmpInst::FCMP_UGE: case CmpInst::FCMP_ULE:
3696     if (!FMF.noSignedZeros() && !isKnownNonZero(CmpLHS) &&
3697         !isKnownNonZero(CmpRHS))
3698       return {SPF_UNKNOWN, SPNB_NA, false};
3699   }
3700
3701   SelectPatternNaNBehavior NaNBehavior = SPNB_NA;
3702   bool Ordered = false;
3703
3704   // When given one NaN and one non-NaN input:
3705   //   - maxnum/minnum (C99 fmaxf()/fminf()) return the non-NaN input.
3706   //   - A simple C99 (a < b ? a : b) construction will return 'b' (as the
3707   //     ordered comparison fails), which could be NaN or non-NaN.
3708   // so here we discover exactly what NaN behavior is required/accepted.
3709   if (CmpInst::isFPPredicate(Pred)) {
3710     bool LHSSafe = isKnownNonNaN(CmpLHS, FMF);
3711     bool RHSSafe = isKnownNonNaN(CmpRHS, FMF);
3712
3713     if (LHSSafe && RHSSafe) {
3714       // Both operands are known non-NaN.
3715       NaNBehavior = SPNB_RETURNS_ANY;
3716     } else if (CmpInst::isOrdered(Pred)) {
3717       // An ordered comparison will return false when given a NaN, so it
3718       // returns the RHS.
3719       Ordered = true;
3720       if (LHSSafe)
3721         // LHS is non-NaN, so if RHS is NaN then NaN will be returned.
3722         NaNBehavior = SPNB_RETURNS_NAN;
3723       else if (RHSSafe)
3724         NaNBehavior = SPNB_RETURNS_OTHER;
3725       else
3726         // Completely unsafe.
3727         return {SPF_UNKNOWN, SPNB_NA, false};
3728     } else {
3729       Ordered = false;
3730       // An unordered comparison will return true when given a NaN, so it
3731       // returns the LHS.
3732       if (LHSSafe)
3733         // LHS is non-NaN, so if RHS is NaN then non-NaN will be returned.
3734         NaNBehavior = SPNB_RETURNS_OTHER;
3735       else if (RHSSafe)
3736         NaNBehavior = SPNB_RETURNS_NAN;
3737       else
3738         // Completely unsafe.
3739         return {SPF_UNKNOWN, SPNB_NA, false};
3740     }
3741   }
3742
3743   if (TrueVal == CmpRHS && FalseVal == CmpLHS) {
3744     std::swap(CmpLHS, CmpRHS);
3745     Pred = CmpInst::getSwappedPredicate(Pred);
3746     if (NaNBehavior == SPNB_RETURNS_NAN)
3747       NaNBehavior = SPNB_RETURNS_OTHER;
3748     else if (NaNBehavior == SPNB_RETURNS_OTHER)
3749       NaNBehavior = SPNB_RETURNS_NAN;
3750     Ordered = !Ordered;
3751   }
3752
3753   // ([if]cmp X, Y) ? X : Y
3754   if (TrueVal == CmpLHS && FalseVal == CmpRHS) {
3755     switch (Pred) {
3756     default: return {SPF_UNKNOWN, SPNB_NA, false}; // Equality.
3757     case ICmpInst::ICMP_UGT:
3758     case ICmpInst::ICMP_UGE: return {SPF_UMAX, SPNB_NA, false};
3759     case ICmpInst::ICMP_SGT:
3760     case ICmpInst::ICMP_SGE: return {SPF_SMAX, SPNB_NA, false};
3761     case ICmpInst::ICMP_ULT:
3762     case ICmpInst::ICMP_ULE: return {SPF_UMIN, SPNB_NA, false};
3763     case ICmpInst::ICMP_SLT:
3764     case ICmpInst::ICMP_SLE: return {SPF_SMIN, SPNB_NA, false};
3765     case FCmpInst::FCMP_UGT:
3766     case FCmpInst::FCMP_UGE:
3767     case FCmpInst::FCMP_OGT:
3768     case FCmpInst::FCMP_OGE: return {SPF_FMAXNUM, NaNBehavior, Ordered};
3769     case FCmpInst::FCMP_ULT:
3770     case FCmpInst::FCMP_ULE:
3771     case FCmpInst::FCMP_OLT:
3772     case FCmpInst::FCMP_OLE: return {SPF_FMINNUM, NaNBehavior, Ordered};
3773     }
3774   }
3775
3776   if (ConstantInt *C1 = dyn_cast<ConstantInt>(CmpRHS)) {
3777     if ((CmpLHS == TrueVal && match(FalseVal, m_Neg(m_Specific(CmpLHS)))) ||
3778         (CmpLHS == FalseVal && match(TrueVal, m_Neg(m_Specific(CmpLHS))))) {
3779
3780       // ABS(X) ==> (X >s 0) ? X : -X and (X >s -1) ? X : -X
3781       // NABS(X) ==> (X >s 0) ? -X : X and (X >s -1) ? -X : X
3782       if (Pred == ICmpInst::ICMP_SGT && (C1->isZero() || C1->isMinusOne())) {
3783         return {(CmpLHS == TrueVal) ? SPF_ABS : SPF_NABS, SPNB_NA, false};
3784       }
3785
3786       // ABS(X) ==> (X <s 0) ? -X : X and (X <s 1) ? -X : X
3787       // NABS(X) ==> (X <s 0) ? X : -X and (X <s 1) ? X : -X
3788       if (Pred == ICmpInst::ICMP_SLT && (C1->isZero() || C1->isOne())) {
3789         return {(CmpLHS == FalseVal) ? SPF_ABS : SPF_NABS, SPNB_NA, false};
3790       }
3791     }
3792     
3793     // Y >s C ? ~Y : ~C == ~Y <s ~C ? ~Y : ~C = SMIN(~Y, ~C)
3794     if (const auto *C2 = dyn_cast<ConstantInt>(FalseVal)) {
3795       if (C1->getType() == C2->getType() && ~C1->getValue() == C2->getValue() &&
3796           (match(TrueVal, m_Not(m_Specific(CmpLHS))) ||
3797            match(CmpLHS, m_Not(m_Specific(TrueVal))))) {
3798         LHS = TrueVal;
3799         RHS = FalseVal;
3800         return {SPF_SMIN, SPNB_NA, false};
3801       }
3802     }
3803   }
3804
3805   // TODO: (X > 4) ? X : 5   -->  (X >= 5) ? X : 5  -->  MAX(X, 5)
3806
3807   return {SPF_UNKNOWN, SPNB_NA, false};
3808 }
3809
3810 static Value *lookThroughCast(CmpInst *CmpI, Value *V1, Value *V2,
3811                               Instruction::CastOps *CastOp) {
3812   CastInst *CI = dyn_cast<CastInst>(V1);
3813   Constant *C = dyn_cast<Constant>(V2);
3814   CastInst *CI2 = dyn_cast<CastInst>(V2);
3815   if (!CI)
3816     return nullptr;
3817   *CastOp = CI->getOpcode();
3818
3819   if (CI2) {
3820     // If V1 and V2 are both the same cast from the same type, we can look
3821     // through V1.
3822     if (CI2->getOpcode() == CI->getOpcode() &&
3823         CI2->getSrcTy() == CI->getSrcTy())
3824       return CI2->getOperand(0);
3825     return nullptr;
3826   } else if (!C) {
3827     return nullptr;
3828   }
3829
3830   if (isa<SExtInst>(CI) && CmpI->isSigned()) {
3831     Constant *T = ConstantExpr::getTrunc(C, CI->getSrcTy());
3832     // This is only valid if the truncated value can be sign-extended
3833     // back to the original value.
3834     if (ConstantExpr::getSExt(T, C->getType()) == C)
3835       return T;
3836     return nullptr;
3837   }
3838   if (isa<ZExtInst>(CI) && CmpI->isUnsigned())
3839     return ConstantExpr::getTrunc(C, CI->getSrcTy());
3840
3841   if (isa<TruncInst>(CI))
3842     return ConstantExpr::getIntegerCast(C, CI->getSrcTy(), CmpI->isSigned());
3843
3844   if (isa<FPToUIInst>(CI))
3845     return ConstantExpr::getUIToFP(C, CI->getSrcTy(), true);
3846
3847   if (isa<FPToSIInst>(CI))
3848     return ConstantExpr::getSIToFP(C, CI->getSrcTy(), true);
3849
3850   if (isa<UIToFPInst>(CI))
3851     return ConstantExpr::getFPToUI(C, CI->getSrcTy(), true);
3852
3853   if (isa<SIToFPInst>(CI))
3854     return ConstantExpr::getFPToSI(C, CI->getSrcTy(), true);
3855
3856   if (isa<FPTruncInst>(CI))
3857     return ConstantExpr::getFPExtend(C, CI->getSrcTy(), true);
3858
3859   if (isa<FPExtInst>(CI))
3860     return ConstantExpr::getFPTrunc(C, CI->getSrcTy(), true);
3861
3862   return nullptr;
3863 }
3864
3865 SelectPatternResult llvm::matchSelectPattern(Value *V,
3866                                              Value *&LHS, Value *&RHS,
3867                                              Instruction::CastOps *CastOp) {
3868   SelectInst *SI = dyn_cast<SelectInst>(V);
3869   if (!SI) return {SPF_UNKNOWN, SPNB_NA, false};
3870
3871   CmpInst *CmpI = dyn_cast<CmpInst>(SI->getCondition());
3872   if (!CmpI) return {SPF_UNKNOWN, SPNB_NA, false};
3873
3874   CmpInst::Predicate Pred = CmpI->getPredicate();
3875   Value *CmpLHS = CmpI->getOperand(0);
3876   Value *CmpRHS = CmpI->getOperand(1);
3877   Value *TrueVal = SI->getTrueValue();
3878   Value *FalseVal = SI->getFalseValue();
3879   FastMathFlags FMF;
3880   if (isa<FPMathOperator>(CmpI))
3881     FMF = CmpI->getFastMathFlags();
3882
3883   // Bail out early.
3884   if (CmpI->isEquality())
3885     return {SPF_UNKNOWN, SPNB_NA, false};
3886
3887   // Deal with type mismatches.
3888   if (CastOp && CmpLHS->getType() != TrueVal->getType()) {
3889     if (Value *C = lookThroughCast(CmpI, TrueVal, FalseVal, CastOp))
3890       return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
3891                                   cast<CastInst>(TrueVal)->getOperand(0), C,
3892                                   LHS, RHS);
3893     if (Value *C = lookThroughCast(CmpI, FalseVal, TrueVal, CastOp))
3894       return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
3895                                   C, cast<CastInst>(FalseVal)->getOperand(0),
3896                                   LHS, RHS);
3897   }
3898   return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS, TrueVal, FalseVal,
3899                               LHS, RHS);
3900 }