blob: 244aa798a9cceacd1976a2c4346e3d5f12ea28d3 [file] [log] [blame]
Chris Lattner965c7692008-06-02 01:18:21 +00001//===- 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"
James Molloy493e57d2015-10-26 14:10:46 +000016#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000017#include "llvm/ADT/SmallPtrSet.h"
Daniel Jasperaec2fa32016-12-19 08:22:17 +000018#include "llvm/Analysis/AssumptionCache.h"
Dan Gohman949ab782010-12-15 20:10:26 +000019#include "llvm/Analysis/InstructionSimplify.h"
Benjamin Kramerfd4777c2013-09-24 16:37:51 +000020#include "llvm/Analysis/MemoryBuiltins.h"
Artur Pilipenko31bcca42016-02-24 12:49:04 +000021#include "llvm/Analysis/Loads.h"
Adam Nemete2b885c2015-04-23 20:09:20 +000022#include "llvm/Analysis/LoopInfo.h"
David Majnemer3ee5f342016-04-13 06:55:52 +000023#include "llvm/Analysis/VectorUtils.h"
Nick Lewyckyec373542014-05-20 05:13:21 +000024#include "llvm/IR/CallSite.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000025#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/Constants.h"
27#include "llvm/IR/DataLayout.h"
Hal Finkel60db0582014-09-07 18:57:58 +000028#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000029#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000030#include "llvm/IR/GlobalAlias.h"
31#include "llvm/IR/GlobalVariable.h"
32#include "llvm/IR/Instructions.h"
33#include "llvm/IR/IntrinsicInst.h"
34#include "llvm/IR/LLVMContext.h"
35#include "llvm/IR/Metadata.h"
36#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000037#include "llvm/IR/PatternMatch.h"
Philip Reames5461d452015-04-23 17:36:48 +000038#include "llvm/IR/Statepoint.h"
Matt Arsenaultf1a7e622014-07-15 01:55:03 +000039#include "llvm/Support/Debug.h"
Chris Lattner965c7692008-06-02 01:18:21 +000040#include "llvm/Support/MathExtras.h"
Matthias Braun37e5d792016-01-28 06:29:33 +000041#include <algorithm>
42#include <array>
Chris Lattner64496902008-06-04 04:46:14 +000043#include <cstring>
Chris Lattner965c7692008-06-02 01:18:21 +000044using namespace llvm;
Duncan Sandsd3951082011-01-25 09:38:29 +000045using namespace llvm::PatternMatch;
46
47const unsigned MaxDepth = 6;
48
Philip Reames1c292272015-03-10 22:43:20 +000049// Controls the number of uses of the value searched for possible
50// dominating comparisons.
51static cl::opt<unsigned> DomConditionsMaxUses("dom-conditions-max-uses",
Igor Laevskycea9ede2015-09-29 14:57:52 +000052 cl::Hidden, cl::init(20));
Philip Reames1c292272015-03-10 22:43:20 +000053
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +000054// This optimization is known to cause performance regressions is some cases,
55// keep it under a temporary flag for now.
56static cl::opt<bool>
57DontImproveNonNegativePhiBits("dont-improve-non-negative-phi-bits",
58 cl::Hidden, cl::init(true));
59
Sanjay Patelaee84212014-11-04 16:27:42 +000060/// Returns the bitwidth of the given scalar or pointer type (if unknown returns
61/// 0). For vector types, returns the element type's bitwidth.
Mehdi Aminia28d91d2015-03-10 02:37:25 +000062static unsigned getBitWidth(Type *Ty, const DataLayout &DL) {
Duncan Sandsd3951082011-01-25 09:38:29 +000063 if (unsigned BitWidth = Ty->getScalarSizeInBits())
64 return BitWidth;
Matt Arsenaultf55e5e72013-08-10 17:34:08 +000065
Mehdi Aminia28d91d2015-03-10 02:37:25 +000066 return DL.getPointerTypeSizeInBits(Ty);
Duncan Sandsd3951082011-01-25 09:38:29 +000067}
Chris Lattner965c7692008-06-02 01:18:21 +000068
Benjamin Kramercfd8d902014-09-12 08:56:53 +000069namespace {
Hal Finkel60db0582014-09-07 18:57:58 +000070// Simplifying using an assume can only be done in a particular control-flow
71// context (the context instruction provides that context). If an assume and
72// the context instruction are not in the same block then the DT helps in
73// figuring out if we can use it.
74struct Query {
Matthias Braunfeb81bc2016-01-15 22:22:04 +000075 const DataLayout &DL;
Daniel Jasperaec2fa32016-12-19 08:22:17 +000076 AssumptionCache *AC;
Hal Finkel60db0582014-09-07 18:57:58 +000077 const Instruction *CxtI;
78 const DominatorTree *DT;
79
Matthias Braun37e5d792016-01-28 06:29:33 +000080 /// Set of assumptions that should be excluded from further queries.
81 /// This is because of the potential for mutual recursion to cause
82 /// computeKnownBits to repeatedly visit the same assume intrinsic. The
83 /// classic case of this is assume(x = y), which will attempt to determine
84 /// bits in x from bits in y, which will attempt to determine bits in y from
85 /// bits in x, etc. Regarding the mutual recursion, computeKnownBits can call
86 /// isKnownNonZero, which calls computeKnownBits and ComputeSignBit and
87 /// isKnownToBeAPowerOfTwo (all of which can call computeKnownBits), and so
88 /// on.
Li Huang755f75f2016-10-15 19:00:04 +000089 std::array<const Value *, MaxDepth> Excluded;
Matthias Braun37e5d792016-01-28 06:29:33 +000090 unsigned NumExcluded;
91
Daniel Jasperaec2fa32016-12-19 08:22:17 +000092 Query(const DataLayout &DL, AssumptionCache *AC, const Instruction *CxtI,
93 const DominatorTree *DT)
94 : DL(DL), AC(AC), CxtI(CxtI), DT(DT), NumExcluded(0) {}
Hal Finkel60db0582014-09-07 18:57:58 +000095
96 Query(const Query &Q, const Value *NewExcl)
Daniel Jasperaec2fa32016-12-19 08:22:17 +000097 : DL(Q.DL), AC(Q.AC), CxtI(Q.CxtI), DT(Q.DT), NumExcluded(Q.NumExcluded) {
Matthias Braun37e5d792016-01-28 06:29:33 +000098 Excluded = Q.Excluded;
99 Excluded[NumExcluded++] = NewExcl;
100 assert(NumExcluded <= Excluded.size());
101 }
102
103 bool isExcluded(const Value *Value) const {
104 if (NumExcluded == 0)
105 return false;
106 auto End = Excluded.begin() + NumExcluded;
107 return std::find(Excluded.begin(), End, Value) != End;
Hal Finkel60db0582014-09-07 18:57:58 +0000108 }
109};
Benjamin Kramercfd8d902014-09-12 08:56:53 +0000110} // end anonymous namespace
Hal Finkel60db0582014-09-07 18:57:58 +0000111
Sanjay Patel547e9752014-11-04 16:09:50 +0000112// Given the provided Value and, potentially, a context instruction, return
Hal Finkel60db0582014-09-07 18:57:58 +0000113// the preferred context instruction (if any).
114static const Instruction *safeCxtI(const Value *V, const Instruction *CxtI) {
115 // If we've been provided with a context instruction, then use that (provided
116 // it has been inserted).
117 if (CxtI && CxtI->getParent())
118 return CxtI;
119
120 // If the value is really an already-inserted instruction, then use that.
121 CxtI = dyn_cast<Instruction>(V);
122 if (CxtI && CxtI->getParent())
123 return CxtI;
124
125 return nullptr;
126}
127
Pete Cooper35b00d52016-08-13 01:05:32 +0000128static void computeKnownBits(const Value *V, APInt &KnownZero, APInt &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000129 unsigned Depth, const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000130
Pete Cooper35b00d52016-08-13 01:05:32 +0000131void llvm::computeKnownBits(const Value *V, APInt &KnownZero, APInt &KnownOne,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000132 const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000133 AssumptionCache *AC, const Instruction *CxtI,
Hal Finkel60db0582014-09-07 18:57:58 +0000134 const DominatorTree *DT) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000135 ::computeKnownBits(V, KnownZero, KnownOne, Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000136 Query(DL, AC, safeCxtI(V, CxtI), DT));
Hal Finkel60db0582014-09-07 18:57:58 +0000137}
138
Pete Cooper35b00d52016-08-13 01:05:32 +0000139bool llvm::haveNoCommonBitsSet(const Value *LHS, const Value *RHS,
140 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000141 AssumptionCache *AC, const Instruction *CxtI,
Jingyue Wuca321902015-05-14 23:53:19 +0000142 const DominatorTree *DT) {
143 assert(LHS->getType() == RHS->getType() &&
144 "LHS and RHS should have the same type");
145 assert(LHS->getType()->isIntOrIntVectorTy() &&
146 "LHS and RHS should be integers");
147 IntegerType *IT = cast<IntegerType>(LHS->getType()->getScalarType());
148 APInt LHSKnownZero(IT->getBitWidth(), 0), LHSKnownOne(IT->getBitWidth(), 0);
149 APInt RHSKnownZero(IT->getBitWidth(), 0), RHSKnownOne(IT->getBitWidth(), 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000150 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, DL, 0, AC, CxtI, DT);
151 computeKnownBits(RHS, RHSKnownZero, RHSKnownOne, DL, 0, AC, CxtI, DT);
Jingyue Wuca321902015-05-14 23:53:19 +0000152 return (LHSKnownZero | RHSKnownZero).isAllOnesValue();
153}
154
Pete Cooper35b00d52016-08-13 01:05:32 +0000155static void ComputeSignBit(const Value *V, bool &KnownZero, bool &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000156 unsigned Depth, const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000157
Pete Cooper35b00d52016-08-13 01:05:32 +0000158void llvm::ComputeSignBit(const Value *V, bool &KnownZero, bool &KnownOne,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000159 const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000160 AssumptionCache *AC, const Instruction *CxtI,
Hal Finkel60db0582014-09-07 18:57:58 +0000161 const DominatorTree *DT) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000162 ::ComputeSignBit(V, KnownZero, KnownOne, Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000163 Query(DL, AC, safeCxtI(V, CxtI), DT));
Hal Finkel60db0582014-09-07 18:57:58 +0000164}
165
Pete Cooper35b00d52016-08-13 01:05:32 +0000166static bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000167 const Query &Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000168
Pete Cooper35b00d52016-08-13 01:05:32 +0000169bool llvm::isKnownToBeAPowerOfTwo(const Value *V, const DataLayout &DL,
170 bool OrZero,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000171 unsigned Depth, AssumptionCache *AC,
172 const Instruction *CxtI,
Hal Finkel60db0582014-09-07 18:57:58 +0000173 const DominatorTree *DT) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000174 return ::isKnownToBeAPowerOfTwo(V, OrZero, Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000175 Query(DL, AC, safeCxtI(V, CxtI), DT));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000176}
177
Pete Cooper35b00d52016-08-13 01:05:32 +0000178static bool isKnownNonZero(const Value *V, unsigned Depth, const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000179
Pete Cooper35b00d52016-08-13 01:05:32 +0000180bool llvm::isKnownNonZero(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000181 AssumptionCache *AC, const Instruction *CxtI,
182 const DominatorTree *DT) {
183 return ::isKnownNonZero(V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000184}
185
Pete Cooper35b00d52016-08-13 01:05:32 +0000186bool llvm::isKnownNonNegative(const Value *V, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000187 unsigned Depth,
188 AssumptionCache *AC, const Instruction *CxtI,
Jingyue Wu10fcea52015-08-20 18:27:04 +0000189 const DominatorTree *DT) {
190 bool NonNegative, Negative;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000191 ComputeSignBit(V, NonNegative, Negative, DL, Depth, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +0000192 return NonNegative;
193}
194
Pete Cooper35b00d52016-08-13 01:05:32 +0000195bool llvm::isKnownPositive(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000196 AssumptionCache *AC, const Instruction *CxtI,
197 const DominatorTree *DT) {
Philip Reames8f12eba2016-03-09 21:31:47 +0000198 if (auto *CI = dyn_cast<ConstantInt>(V))
199 return CI->getValue().isStrictlyPositive();
Sanjoy Das6082c1a2016-05-07 02:08:15 +0000200
Philip Reames8f12eba2016-03-09 21:31:47 +0000201 // TODO: We'd doing two recursive queries here. We should factor this such
202 // that only a single query is needed.
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000203 return isKnownNonNegative(V, DL, Depth, AC, CxtI, DT) &&
204 isKnownNonZero(V, DL, Depth, AC, CxtI, DT);
Philip Reames8f12eba2016-03-09 21:31:47 +0000205}
206
Pete Cooper35b00d52016-08-13 01:05:32 +0000207bool llvm::isKnownNegative(const Value *V, const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000208 AssumptionCache *AC, const Instruction *CxtI,
209 const DominatorTree *DT) {
Nick Lewycky762f8a82016-04-21 00:53:14 +0000210 bool NonNegative, Negative;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000211 ComputeSignBit(V, NonNegative, Negative, DL, Depth, AC, CxtI, DT);
Nick Lewycky762f8a82016-04-21 00:53:14 +0000212 return Negative;
213}
214
Pete Cooper35b00d52016-08-13 01:05:32 +0000215static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q);
James Molloy1d88d6f2015-10-22 13:18:42 +0000216
Pete Cooper35b00d52016-08-13 01:05:32 +0000217bool llvm::isKnownNonEqual(const Value *V1, const Value *V2,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000218 const DataLayout &DL,
219 AssumptionCache *AC, const Instruction *CxtI,
Pete Cooper35b00d52016-08-13 01:05:32 +0000220 const DominatorTree *DT) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000221 return ::isKnownNonEqual(V1, V2, Query(DL, AC,
222 safeCxtI(V1, safeCxtI(V2, CxtI)),
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000223 DT));
James Molloy1d88d6f2015-10-22 13:18:42 +0000224}
225
Pete Cooper35b00d52016-08-13 01:05:32 +0000226static bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000227 const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000228
Pete Cooper35b00d52016-08-13 01:05:32 +0000229bool llvm::MaskedValueIsZero(const Value *V, const APInt &Mask,
230 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000231 unsigned Depth, AssumptionCache *AC,
232 const Instruction *CxtI, const DominatorTree *DT) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000233 return ::MaskedValueIsZero(V, Mask, Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000234 Query(DL, AC, safeCxtI(V, CxtI), DT));
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000235}
236
Pete Cooper35b00d52016-08-13 01:05:32 +0000237static unsigned ComputeNumSignBits(const Value *V, unsigned Depth,
238 const Query &Q);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000239
Pete Cooper35b00d52016-08-13 01:05:32 +0000240unsigned llvm::ComputeNumSignBits(const Value *V, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000241 unsigned Depth, AssumptionCache *AC,
242 const Instruction *CxtI,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000243 const DominatorTree *DT) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000244 return ::ComputeNumSignBits(V, Depth, Query(DL, AC, safeCxtI(V, CxtI), DT));
Hal Finkel60db0582014-09-07 18:57:58 +0000245}
246
Pete Cooper35b00d52016-08-13 01:05:32 +0000247static void computeKnownBitsAddSub(bool Add, const Value *Op0, const Value *Op1,
248 bool NSW,
Jay Foada0653a32014-05-14 21:14:37 +0000249 APInt &KnownZero, APInt &KnownOne,
250 APInt &KnownZero2, APInt &KnownOne2,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000251 unsigned Depth, const Query &Q) {
Hal Finkel60db0582014-09-07 18:57:58 +0000252 if (!Add) {
Pete Cooper35b00d52016-08-13 01:05:32 +0000253 if (const ConstantInt *CLHS = dyn_cast<ConstantInt>(Op0)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000254 // We know that the top bits of C-X are clear if X contains less bits
255 // than C (i.e. no wrap-around can happen). For example, 20-X is
256 // positive if we can prove that X is >= 0 and < 16.
257 if (!CLHS->getValue().isNegative()) {
258 unsigned BitWidth = KnownZero.getBitWidth();
259 unsigned NLZ = (CLHS->getValue()+1).countLeadingZeros();
260 // NLZ can't be BitWidth with no sign bit
261 APInt MaskV = APInt::getHighBitsSet(BitWidth, NLZ+1);
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000262 computeKnownBits(Op1, KnownZero2, KnownOne2, Depth + 1, Q);
Hal Finkel60db0582014-09-07 18:57:58 +0000263
264 // If all of the MaskV bits are known to be zero, then we know the
265 // output top bits are zero, because we now know that the output is
266 // from [0-C].
267 if ((KnownZero2 & MaskV) == MaskV) {
268 unsigned NLZ2 = CLHS->getValue().countLeadingZeros();
269 // Top bits known zero.
270 KnownZero = APInt::getHighBitsSet(BitWidth, NLZ2);
271 }
272 }
273 }
274 }
275
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000276 unsigned BitWidth = KnownZero.getBitWidth();
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000277
David Majnemer97ddca32014-08-22 00:40:43 +0000278 // If an initial sequence of bits in the result is not needed, the
279 // corresponding bits in the operands are not needed.
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000280 APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000281 computeKnownBits(Op0, LHSKnownZero, LHSKnownOne, Depth + 1, Q);
282 computeKnownBits(Op1, KnownZero2, KnownOne2, Depth + 1, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000283
David Majnemer97ddca32014-08-22 00:40:43 +0000284 // Carry in a 1 for a subtract, rather than a 0.
285 APInt CarryIn(BitWidth, 0);
286 if (!Add) {
287 // Sum = LHS + ~RHS + 1
288 std::swap(KnownZero2, KnownOne2);
289 CarryIn.setBit(0);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000290 }
291
David Majnemer97ddca32014-08-22 00:40:43 +0000292 APInt PossibleSumZero = ~LHSKnownZero + ~KnownZero2 + CarryIn;
293 APInt PossibleSumOne = LHSKnownOne + KnownOne2 + CarryIn;
294
295 // Compute known bits of the carry.
296 APInt CarryKnownZero = ~(PossibleSumZero ^ LHSKnownZero ^ KnownZero2);
297 APInt CarryKnownOne = PossibleSumOne ^ LHSKnownOne ^ KnownOne2;
298
299 // Compute set of known bits (where all three relevant bits are known).
300 APInt LHSKnown = LHSKnownZero | LHSKnownOne;
301 APInt RHSKnown = KnownZero2 | KnownOne2;
302 APInt CarryKnown = CarryKnownZero | CarryKnownOne;
303 APInt Known = LHSKnown & RHSKnown & CarryKnown;
304
305 assert((PossibleSumZero & Known) == (PossibleSumOne & Known) &&
306 "known bits of sum differ");
307
308 // Compute known bits of the result.
309 KnownZero = ~PossibleSumOne & Known;
310 KnownOne = PossibleSumOne & Known;
311
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000312 // Are we still trying to solve for the sign bit?
David Majnemer97ddca32014-08-22 00:40:43 +0000313 if (!Known.isNegative()) {
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000314 if (NSW) {
David Majnemer97ddca32014-08-22 00:40:43 +0000315 // Adding two non-negative numbers, or subtracting a negative number from
316 // a non-negative one, can't wrap into negative.
317 if (LHSKnownZero.isNegative() && KnownZero2.isNegative())
318 KnownZero |= APInt::getSignBit(BitWidth);
319 // Adding two negative numbers, or subtracting a non-negative number from
320 // a negative one, can't wrap into non-negative.
321 else if (LHSKnownOne.isNegative() && KnownOne2.isNegative())
322 KnownOne |= APInt::getSignBit(BitWidth);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000323 }
324 }
325}
326
Pete Cooper35b00d52016-08-13 01:05:32 +0000327static void computeKnownBitsMul(const Value *Op0, const Value *Op1, bool NSW,
Jay Foada0653a32014-05-14 21:14:37 +0000328 APInt &KnownZero, APInt &KnownOne,
329 APInt &KnownZero2, APInt &KnownOne2,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000330 unsigned Depth, const Query &Q) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000331 unsigned BitWidth = KnownZero.getBitWidth();
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000332 computeKnownBits(Op1, KnownZero, KnownOne, Depth + 1, Q);
333 computeKnownBits(Op0, KnownZero2, KnownOne2, Depth + 1, Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000334
335 bool isKnownNegative = false;
336 bool isKnownNonNegative = false;
337 // If the multiplication is known not to overflow, compute the sign bit.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000338 if (NSW) {
Nick Lewyckyfa306072012-03-18 23:28:48 +0000339 if (Op0 == Op1) {
340 // The product of a number with itself is non-negative.
341 isKnownNonNegative = true;
342 } else {
343 bool isKnownNonNegativeOp1 = KnownZero.isNegative();
344 bool isKnownNonNegativeOp0 = KnownZero2.isNegative();
345 bool isKnownNegativeOp1 = KnownOne.isNegative();
346 bool isKnownNegativeOp0 = KnownOne2.isNegative();
347 // The product of two numbers with the same sign is non-negative.
348 isKnownNonNegative = (isKnownNegativeOp1 && isKnownNegativeOp0) ||
349 (isKnownNonNegativeOp1 && isKnownNonNegativeOp0);
350 // The product of a negative number and a non-negative number is either
351 // negative or zero.
352 if (!isKnownNonNegative)
353 isKnownNegative = (isKnownNegativeOp1 && isKnownNonNegativeOp0 &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000354 isKnownNonZero(Op0, Depth, Q)) ||
Nick Lewyckyfa306072012-03-18 23:28:48 +0000355 (isKnownNegativeOp0 && isKnownNonNegativeOp1 &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000356 isKnownNonZero(Op1, Depth, Q));
Nick Lewyckyfa306072012-03-18 23:28:48 +0000357 }
358 }
359
360 // If low bits are zero in either operand, output low known-0 bits.
Sanjay Patel5dd66c32015-09-17 20:51:50 +0000361 // Also compute a conservative estimate for high known-0 bits.
Nick Lewyckyfa306072012-03-18 23:28:48 +0000362 // More trickiness is possible, but this is sufficient for the
363 // interesting case of alignment computation.
364 KnownOne.clearAllBits();
365 unsigned TrailZ = KnownZero.countTrailingOnes() +
366 KnownZero2.countTrailingOnes();
367 unsigned LeadZ = std::max(KnownZero.countLeadingOnes() +
368 KnownZero2.countLeadingOnes(),
369 BitWidth) - BitWidth;
370
371 TrailZ = std::min(TrailZ, BitWidth);
372 LeadZ = std::min(LeadZ, BitWidth);
373 KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ) |
374 APInt::getHighBitsSet(BitWidth, LeadZ);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000375
376 // Only make use of no-wrap flags if we failed to compute the sign bit
377 // directly. This matters if the multiplication always overflows, in
378 // which case we prefer to follow the result of the direct computation,
379 // though as the program is invoking undefined behaviour we can choose
380 // whatever we like here.
381 if (isKnownNonNegative && !KnownOne.isNegative())
382 KnownZero.setBit(BitWidth - 1);
383 else if (isKnownNegative && !KnownZero.isNegative())
384 KnownOne.setBit(BitWidth - 1);
385}
386
Jingyue Wu37fcb592014-06-19 16:50:16 +0000387void llvm::computeKnownBitsFromRangeMetadata(const MDNode &Ranges,
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000388 APInt &KnownZero,
389 APInt &KnownOne) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000390 unsigned BitWidth = KnownZero.getBitWidth();
Rafael Espindola53190532012-03-30 15:52:11 +0000391 unsigned NumRanges = Ranges.getNumOperands() / 2;
392 assert(NumRanges >= 1);
393
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000394 KnownZero.setAllBits();
395 KnownOne.setAllBits();
396
Rafael Espindola53190532012-03-30 15:52:11 +0000397 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000398 ConstantInt *Lower =
399 mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 0));
400 ConstantInt *Upper =
401 mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 1));
Rafael Espindola53190532012-03-30 15:52:11 +0000402 ConstantRange Range(Lower->getValue(), Upper->getValue());
Rafael Espindola53190532012-03-30 15:52:11 +0000403
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000404 // The first CommonPrefixBits of all values in Range are equal.
405 unsigned CommonPrefixBits =
406 (Range.getUnsignedMax() ^ Range.getUnsignedMin()).countLeadingZeros();
407
408 APInt Mask = APInt::getHighBitsSet(BitWidth, CommonPrefixBits);
409 KnownOne &= Range.getUnsignedMax() & Mask;
410 KnownZero &= ~Range.getUnsignedMax() & Mask;
411 }
Rafael Espindola53190532012-03-30 15:52:11 +0000412}
Jay Foad5a29c362014-05-15 12:12:55 +0000413
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000414static bool isEphemeralValueOf(const Instruction *I, const Value *E) {
Hal Finkel60db0582014-09-07 18:57:58 +0000415 SmallVector<const Value *, 16> WorkSet(1, I);
416 SmallPtrSet<const Value *, 32> Visited;
417 SmallPtrSet<const Value *, 16> EphValues;
418
Hal Finkelf2199b22015-10-23 20:37:08 +0000419 // The instruction defining an assumption's condition itself is always
420 // considered ephemeral to that assumption (even if it has other
421 // non-ephemeral users). See r246696's test case for an example.
David Majnemer0a16c222016-08-11 21:15:00 +0000422 if (is_contained(I->operands(), E))
Hal Finkelf2199b22015-10-23 20:37:08 +0000423 return true;
424
Hal Finkel60db0582014-09-07 18:57:58 +0000425 while (!WorkSet.empty()) {
426 const Value *V = WorkSet.pop_back_val();
David Blaikie70573dc2014-11-19 07:49:26 +0000427 if (!Visited.insert(V).second)
Hal Finkel60db0582014-09-07 18:57:58 +0000428 continue;
429
430 // If all uses of this value are ephemeral, then so is this value.
David Majnemer0a16c222016-08-11 21:15:00 +0000431 if (all_of(V->users(), [&](const User *U) { return EphValues.count(U); })) {
Hal Finkel60db0582014-09-07 18:57:58 +0000432 if (V == E)
433 return true;
434
435 EphValues.insert(V);
436 if (const User *U = dyn_cast<User>(V))
437 for (User::const_op_iterator J = U->op_begin(), JE = U->op_end();
438 J != JE; ++J) {
439 if (isSafeToSpeculativelyExecute(*J))
440 WorkSet.push_back(*J);
441 }
442 }
443 }
444
445 return false;
446}
447
448// Is this an intrinsic that cannot be speculated but also cannot trap?
449static bool isAssumeLikeIntrinsic(const Instruction *I) {
450 if (const CallInst *CI = dyn_cast<CallInst>(I))
451 if (Function *F = CI->getCalledFunction())
452 switch (F->getIntrinsicID()) {
453 default: break;
454 // FIXME: This list is repeated from NoTTI::getIntrinsicCost.
455 case Intrinsic::assume:
456 case Intrinsic::dbg_declare:
457 case Intrinsic::dbg_value:
458 case Intrinsic::invariant_start:
459 case Intrinsic::invariant_end:
460 case Intrinsic::lifetime_start:
461 case Intrinsic::lifetime_end:
462 case Intrinsic::objectsize:
463 case Intrinsic::ptr_annotation:
464 case Intrinsic::var_annotation:
465 return true;
466 }
467
468 return false;
469}
470
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000471bool llvm::isValidAssumeForContext(const Instruction *Inv,
472 const Instruction *CxtI,
473 const DominatorTree *DT) {
Hal Finkel60db0582014-09-07 18:57:58 +0000474
475 // There are two restrictions on the use of an assume:
476 // 1. The assume must dominate the context (or the control flow must
477 // reach the assume whenever it reaches the context).
478 // 2. The context must not be in the assume's set of ephemeral values
479 // (otherwise we will use the assume to prove that the condition
480 // feeding the assume is trivially true, thus causing the removal of
481 // the assume).
482
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000483 if (DT) {
Pete Cooper54a02552016-08-12 01:00:15 +0000484 if (DT->dominates(Inv, CxtI))
Hal Finkel60db0582014-09-07 18:57:58 +0000485 return true;
Pete Cooper54a02552016-08-12 01:00:15 +0000486 } else if (Inv->getParent() == CxtI->getParent()->getSinglePredecessor()) {
487 // We don't have a DT, but this trivially dominates.
488 return true;
Hal Finkel60db0582014-09-07 18:57:58 +0000489 }
490
Pete Cooper54a02552016-08-12 01:00:15 +0000491 // With or without a DT, the only remaining case we will check is if the
492 // instructions are in the same BB. Give up if that is not the case.
493 if (Inv->getParent() != CxtI->getParent())
494 return false;
495
496 // If we have a dom tree, then we now know that the assume doens't dominate
497 // the other instruction. If we don't have a dom tree then we can check if
498 // the assume is first in the BB.
499 if (!DT) {
Hal Finkel60db0582014-09-07 18:57:58 +0000500 // Search forward from the assume until we reach the context (or the end
501 // of the block); the common case is that the assume will come first.
Pete Cooperfa7ae4f2016-08-11 22:23:07 +0000502 for (auto I = std::next(BasicBlock::const_iterator(Inv)),
Hal Finkel60db0582014-09-07 18:57:58 +0000503 IE = Inv->getParent()->end(); I != IE; ++I)
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000504 if (&*I == CxtI)
Hal Finkel60db0582014-09-07 18:57:58 +0000505 return true;
Hal Finkel60db0582014-09-07 18:57:58 +0000506 }
507
Pete Cooper54a02552016-08-12 01:00:15 +0000508 // The context comes first, but they're both in the same block. Make sure
509 // there is nothing in between that might interrupt the control flow.
510 for (BasicBlock::const_iterator I =
511 std::next(BasicBlock::const_iterator(CxtI)), IE(Inv);
512 I != IE; ++I)
513 if (!isSafeToSpeculativelyExecute(&*I) && !isAssumeLikeIntrinsic(&*I))
514 return false;
515
516 return !isEphemeralValueOf(Inv, CxtI);
Hal Finkel60db0582014-09-07 18:57:58 +0000517}
518
Pete Cooper35b00d52016-08-13 01:05:32 +0000519static void computeKnownBitsFromAssume(const Value *V, APInt &KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000520 APInt &KnownOne, unsigned Depth,
521 const Query &Q) {
Hal Finkel60db0582014-09-07 18:57:58 +0000522 // Use of assumptions is context-sensitive. If we don't have a context, we
523 // cannot use them!
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000524 if (!Q.AC || !Q.CxtI)
Hal Finkel60db0582014-09-07 18:57:58 +0000525 return;
526
527 unsigned BitWidth = KnownZero.getBitWidth();
528
Hal Finkel8a9a7832017-01-11 13:24:24 +0000529 // Note that the patterns below need to be kept in sync with the code
530 // in AssumptionCache::updateAffectedValues.
531
532 for (auto &AssumeVH : Q.AC->assumptionsFor(V)) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000533 if (!AssumeVH)
Chandler Carruth66b31302015-01-04 12:03:27 +0000534 continue;
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000535 CallInst *I = cast<CallInst>(AssumeVH);
536 assert(I->getParent()->getParent() == Q.CxtI->getParent()->getParent() &&
537 "Got assumption for the wrong function!");
538 if (Q.isExcluded(I))
Hal Finkel60db0582014-09-07 18:57:58 +0000539 continue;
540
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000541 // Warning: This loop can end up being somewhat performance sensetive.
542 // We're running this loop for once for each value queried resulting in a
543 // runtime of ~O(#assumes * #values).
Philip Reames00d3b272014-11-24 23:44:28 +0000544
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000545 assert(I->getCalledFunction()->getIntrinsicID() == Intrinsic::assume &&
546 "must be an assume intrinsic");
547
548 Value *Arg = I->getArgOperand(0);
549
550 if (Arg == V && isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000551 assert(BitWidth == 1 && "assume operand is not i1?");
552 KnownZero.clearAllBits();
553 KnownOne.setAllBits();
554 return;
555 }
556
David Majnemer9b609752014-12-12 23:59:29 +0000557 // The remaining tests are all recursive, so bail out if we hit the limit.
558 if (Depth == MaxDepth)
559 continue;
560
Hal Finkel60db0582014-09-07 18:57:58 +0000561 Value *A, *B;
562 auto m_V = m_CombineOr(m_Specific(V),
563 m_CombineOr(m_PtrToInt(m_Specific(V)),
564 m_BitCast(m_Specific(V))));
565
566 CmpInst::Predicate Pred;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000567 ConstantInt *C;
Hal Finkel60db0582014-09-07 18:57:58 +0000568 // assume(v = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000569 if (match(Arg, m_c_ICmp(Pred, m_V, m_Value(A))) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000570 Pred == ICmpInst::ICMP_EQ && isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000571 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000572 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel60db0582014-09-07 18:57:58 +0000573 KnownZero |= RHSKnownZero;
574 KnownOne |= RHSKnownOne;
575 // assume(v & b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000576 } else if (match(Arg,
577 m_c_ICmp(Pred, m_c_And(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000578 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000579 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel60db0582014-09-07 18:57:58 +0000580 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000581 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel60db0582014-09-07 18:57:58 +0000582 APInt MaskKnownZero(BitWidth, 0), MaskKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000583 computeKnownBits(B, MaskKnownZero, MaskKnownOne, Depth+1, Query(Q, I));
Hal Finkel60db0582014-09-07 18:57:58 +0000584
585 // For those bits in the mask that are known to be one, we can propagate
586 // known bits from the RHS to V.
587 KnownZero |= RHSKnownZero & MaskKnownOne;
588 KnownOne |= RHSKnownOne & MaskKnownOne;
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000589 // assume(~(v & b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000590 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_And(m_V, m_Value(B))),
591 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000592 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000593 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000594 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000595 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000596 APInt MaskKnownZero(BitWidth, 0), MaskKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000597 computeKnownBits(B, MaskKnownZero, MaskKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000598
599 // For those bits in the mask that are known to be one, we can propagate
600 // inverted known bits from the RHS to V.
601 KnownZero |= RHSKnownOne & MaskKnownOne;
602 KnownOne |= RHSKnownZero & MaskKnownOne;
603 // assume(v | b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000604 } else if (match(Arg,
605 m_c_ICmp(Pred, m_c_Or(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000606 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000607 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000608 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000609 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000610 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000611 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000612
613 // For those bits in B that are known to be zero, we can propagate known
614 // bits from the RHS to V.
615 KnownZero |= RHSKnownZero & BKnownZero;
616 KnownOne |= RHSKnownOne & BKnownZero;
617 // assume(~(v | b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000618 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Or(m_V, m_Value(B))),
619 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000620 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000621 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000622 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000623 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000624 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000625 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000626
627 // For those bits in B that are known to be zero, we can propagate
628 // inverted known bits from the RHS to V.
629 KnownZero |= RHSKnownOne & BKnownZero;
630 KnownOne |= RHSKnownZero & BKnownZero;
631 // assume(v ^ b = a)
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000632 } else if (match(Arg,
633 m_c_ICmp(Pred, m_c_Xor(m_V, m_Value(B)), m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000634 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000635 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000636 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000637 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000638 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000639 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000640
641 // For those bits in B that are known to be zero, we can propagate known
642 // bits from the RHS to V. For those bits in B that are known to be one,
643 // we can propagate inverted known bits from the RHS to V.
644 KnownZero |= RHSKnownZero & BKnownZero;
645 KnownOne |= RHSKnownOne & BKnownZero;
646 KnownZero |= RHSKnownOne & BKnownOne;
647 KnownOne |= RHSKnownZero & BKnownOne;
648 // assume(~(v ^ b) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000649 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_c_Xor(m_V, m_Value(B))),
650 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000651 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000652 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000653 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000654 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000655 APInt BKnownZero(BitWidth, 0), BKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000656 computeKnownBits(B, BKnownZero, BKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000657
658 // For those bits in B that are known to be zero, we can propagate
659 // inverted known bits from the RHS to V. For those bits in B that are
660 // known to be one, we can propagate known bits from the RHS to V.
661 KnownZero |= RHSKnownOne & BKnownZero;
662 KnownOne |= RHSKnownZero & BKnownZero;
663 KnownZero |= RHSKnownZero & BKnownOne;
664 KnownOne |= RHSKnownOne & BKnownOne;
665 // assume(v << c = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000666 } else if (match(Arg, m_c_ICmp(Pred, m_Shl(m_V, m_ConstantInt(C)),
667 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000668 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000669 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000670 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000671 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000672 // For those bits in RHS that are known, we can propagate them to known
673 // bits in V shifted to the right by C.
674 KnownZero |= RHSKnownZero.lshr(C->getZExtValue());
675 KnownOne |= RHSKnownOne.lshr(C->getZExtValue());
676 // assume(~(v << c) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000677 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_Shl(m_V, m_ConstantInt(C))),
678 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000679 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000680 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000681 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000682 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000683 // For those bits in RHS that are known, we can propagate them inverted
684 // to known bits in V shifted to the right by C.
685 KnownZero |= RHSKnownOne.lshr(C->getZExtValue());
686 KnownOne |= RHSKnownZero.lshr(C->getZExtValue());
687 // assume(v >> c = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000688 } else if (match(Arg,
689 m_c_ICmp(Pred, m_CombineOr(m_LShr(m_V, m_ConstantInt(C)),
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000690 m_AShr(m_V, m_ConstantInt(C))),
691 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000692 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000693 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000694 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000695 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000696 // For those bits in RHS that are known, we can propagate them to known
697 // bits in V shifted to the right by C.
698 KnownZero |= RHSKnownZero << C->getZExtValue();
699 KnownOne |= RHSKnownOne << C->getZExtValue();
700 // assume(~(v >> c) = a)
Philip Reames00d3b272014-11-24 23:44:28 +0000701 } else if (match(Arg, m_c_ICmp(Pred, m_Not(m_CombineOr(
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000702 m_LShr(m_V, m_ConstantInt(C)),
703 m_AShr(m_V, m_ConstantInt(C)))),
Philip Reames00d3b272014-11-24 23:44:28 +0000704 m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000705 Pred == ICmpInst::ICMP_EQ &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000706 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000707 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000708 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000709 // For those bits in RHS that are known, we can propagate them inverted
710 // to known bits in V shifted to the right by C.
711 KnownZero |= RHSKnownOne << C->getZExtValue();
712 KnownOne |= RHSKnownZero << C->getZExtValue();
713 // assume(v >=_s c) where c is non-negative
Philip Reames00d3b272014-11-24 23:44:28 +0000714 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000715 Pred == ICmpInst::ICMP_SGE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000716 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000717 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000718 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000719
720 if (RHSKnownZero.isNegative()) {
721 // We know that the sign bit is zero.
722 KnownZero |= APInt::getSignBit(BitWidth);
723 }
724 // assume(v >_s c) where c is at least -1.
Philip Reames00d3b272014-11-24 23:44:28 +0000725 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000726 Pred == ICmpInst::ICMP_SGT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000727 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000728 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000729 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000730
731 if (RHSKnownOne.isAllOnesValue() || RHSKnownZero.isNegative()) {
732 // We know that the sign bit is zero.
733 KnownZero |= APInt::getSignBit(BitWidth);
734 }
735 // assume(v <=_s c) where c is negative
Philip Reames00d3b272014-11-24 23:44:28 +0000736 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000737 Pred == ICmpInst::ICMP_SLE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000738 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000739 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000740 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000741
742 if (RHSKnownOne.isNegative()) {
743 // We know that the sign bit is one.
744 KnownOne |= APInt::getSignBit(BitWidth);
745 }
746 // assume(v <_s c) where c is non-positive
Philip Reames00d3b272014-11-24 23:44:28 +0000747 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000748 Pred == ICmpInst::ICMP_SLT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000749 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000750 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000751 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000752
753 if (RHSKnownZero.isAllOnesValue() || RHSKnownOne.isNegative()) {
754 // We know that the sign bit is one.
755 KnownOne |= APInt::getSignBit(BitWidth);
756 }
757 // assume(v <=_u c)
Philip Reames00d3b272014-11-24 23:44:28 +0000758 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000759 Pred == ICmpInst::ICMP_ULE &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000760 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000761 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000762 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000763
764 // Whatever high bits in c are zero are known to be zero.
765 KnownZero |=
766 APInt::getHighBitsSet(BitWidth, RHSKnownZero.countLeadingOnes());
767 // assume(v <_u c)
Philip Reames00d3b272014-11-24 23:44:28 +0000768 } else if (match(Arg, m_ICmp(Pred, m_V, m_Value(A))) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000769 Pred == ICmpInst::ICMP_ULT &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000770 isValidAssumeForContext(I, Q.CxtI, Q.DT)) {
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000771 APInt RHSKnownZero(BitWidth, 0), RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000772 computeKnownBits(A, RHSKnownZero, RHSKnownOne, Depth+1, Query(Q, I));
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000773
774 // Whatever high bits in c are zero are known to be zero (if c is a power
775 // of 2, then one more).
Daniel Jasperaec2fa32016-12-19 08:22:17 +0000776 if (isKnownToBeAPowerOfTwo(A, false, Depth + 1, Query(Q, I)))
Hal Finkel15aeaaf2014-09-07 19:21:07 +0000777 KnownZero |=
778 APInt::getHighBitsSet(BitWidth, RHSKnownZero.countLeadingOnes()+1);
779 else
780 KnownZero |=
781 APInt::getHighBitsSet(BitWidth, RHSKnownZero.countLeadingOnes());
Hal Finkel60db0582014-09-07 18:57:58 +0000782 }
783 }
784}
785
Hal Finkelf2199b22015-10-23 20:37:08 +0000786// Compute known bits from a shift operator, including those with a
787// non-constant shift amount. KnownZero and KnownOne are the outputs of this
788// function. KnownZero2 and KnownOne2 are pre-allocated temporaries with the
789// same bit width as KnownZero and KnownOne. KZF and KOF are operator-specific
790// functors that, given the known-zero or known-one bits respectively, and a
791// shift amount, compute the implied known-zero or known-one bits of the shift
792// operator's result respectively for that shift amount. The results from calling
793// KZF and KOF are conservatively combined for all permitted shift amounts.
David Majnemer54690dc2016-08-23 20:52:00 +0000794static void computeKnownBitsFromShiftOperator(
795 const Operator *I, APInt &KnownZero, APInt &KnownOne, APInt &KnownZero2,
796 APInt &KnownOne2, unsigned Depth, const Query &Q,
797 function_ref<APInt(const APInt &, unsigned)> KZF,
798 function_ref<APInt(const APInt &, unsigned)> KOF) {
Hal Finkelf2199b22015-10-23 20:37:08 +0000799 unsigned BitWidth = KnownZero.getBitWidth();
800
801 if (auto *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
802 unsigned ShiftAmt = SA->getLimitedValue(BitWidth-1);
803
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000804 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000805 KnownZero = KZF(KnownZero, ShiftAmt);
806 KnownOne = KOF(KnownOne, ShiftAmt);
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +0000807 // If there is conflict between KnownZero and KnownOne, this must be an
808 // overflowing left shift, so the shift result is undefined. Clear KnownZero
809 // and KnownOne bits so that other code could propagate this undef.
810 if ((KnownZero & KnownOne) != 0) {
811 KnownZero.clearAllBits();
812 KnownOne.clearAllBits();
813 }
814
Hal Finkelf2199b22015-10-23 20:37:08 +0000815 return;
816 }
817
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000818 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000819
820 // Note: We cannot use KnownZero.getLimitedValue() here, because if
821 // BitWidth > 64 and any upper bits are known, we'll end up returning the
822 // limit value (which implies all bits are known).
823 uint64_t ShiftAmtKZ = KnownZero.zextOrTrunc(64).getZExtValue();
824 uint64_t ShiftAmtKO = KnownOne.zextOrTrunc(64).getZExtValue();
825
826 // It would be more-clearly correct to use the two temporaries for this
827 // calculation. Reusing the APInts here to prevent unnecessary allocations.
Richard Trieu7a083812016-02-18 22:09:30 +0000828 KnownZero.clearAllBits();
829 KnownOne.clearAllBits();
Hal Finkelf2199b22015-10-23 20:37:08 +0000830
James Molloy493e57d2015-10-26 14:10:46 +0000831 // If we know the shifter operand is nonzero, we can sometimes infer more
832 // known bits. However this is expensive to compute, so be lazy about it and
833 // only compute it when absolutely necessary.
834 Optional<bool> ShifterOperandIsNonZero;
835
Hal Finkelf2199b22015-10-23 20:37:08 +0000836 // Early exit if we can't constrain any well-defined shift amount.
James Molloy493e57d2015-10-26 14:10:46 +0000837 if (!(ShiftAmtKZ & (BitWidth - 1)) && !(ShiftAmtKO & (BitWidth - 1))) {
838 ShifterOperandIsNonZero =
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000839 isKnownNonZero(I->getOperand(1), Depth + 1, Q);
James Molloy493e57d2015-10-26 14:10:46 +0000840 if (!*ShifterOperandIsNonZero)
841 return;
842 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000843
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000844 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Hal Finkelf2199b22015-10-23 20:37:08 +0000845
846 KnownZero = KnownOne = APInt::getAllOnesValue(BitWidth);
847 for (unsigned ShiftAmt = 0; ShiftAmt < BitWidth; ++ShiftAmt) {
848 // Combine the shifted known input bits only for those shift amounts
849 // compatible with its known constraints.
850 if ((ShiftAmt & ~ShiftAmtKZ) != ShiftAmt)
851 continue;
852 if ((ShiftAmt | ShiftAmtKO) != ShiftAmt)
853 continue;
James Molloy493e57d2015-10-26 14:10:46 +0000854 // If we know the shifter is nonzero, we may be able to infer more known
855 // bits. This check is sunk down as far as possible to avoid the expensive
856 // call to isKnownNonZero if the cheaper checks above fail.
857 if (ShiftAmt == 0) {
858 if (!ShifterOperandIsNonZero.hasValue())
859 ShifterOperandIsNonZero =
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000860 isKnownNonZero(I->getOperand(1), Depth + 1, Q);
James Molloy493e57d2015-10-26 14:10:46 +0000861 if (*ShifterOperandIsNonZero)
862 continue;
863 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000864
865 KnownZero &= KZF(KnownZero2, ShiftAmt);
866 KnownOne &= KOF(KnownOne2, ShiftAmt);
867 }
868
869 // If there are no compatible shift amounts, then we've proven that the shift
870 // amount must be >= the BitWidth, and the result is undefined. We could
871 // return anything we'd like, but we need to make sure the sets of known bits
872 // stay disjoint (it should be better for some other code to actually
873 // propagate the undef than to pick a value here using known bits).
Richard Trieu7a083812016-02-18 22:09:30 +0000874 if ((KnownZero & KnownOne) != 0) {
875 KnownZero.clearAllBits();
876 KnownOne.clearAllBits();
877 }
Hal Finkelf2199b22015-10-23 20:37:08 +0000878}
879
Pete Cooper35b00d52016-08-13 01:05:32 +0000880static void computeKnownBitsFromOperator(const Operator *I, APInt &KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000881 APInt &KnownOne, unsigned Depth,
882 const Query &Q) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000883 unsigned BitWidth = KnownZero.getBitWidth();
884
Chris Lattner965c7692008-06-02 01:18:21 +0000885 APInt KnownZero2(KnownZero), KnownOne2(KnownOne);
Dan Gohman80ca01c2009-07-17 20:47:02 +0000886 switch (I->getOpcode()) {
Chris Lattner965c7692008-06-02 01:18:21 +0000887 default: break;
Rafael Espindola53190532012-03-30 15:52:11 +0000888 case Instruction::Load:
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000889 if (MDNode *MD = cast<LoadInst>(I)->getMetadata(LLVMContext::MD_range))
Sanjoy Das1d1929a2015-10-28 03:20:15 +0000890 computeKnownBitsFromRangeMetadata(*MD, KnownZero, KnownOne);
Jay Foad5a29c362014-05-15 12:12:55 +0000891 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000892 case Instruction::And: {
893 // If either the LHS or the RHS are Zero, the result is zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000894 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
895 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +0000896
Chris Lattner965c7692008-06-02 01:18:21 +0000897 // Output known-1 bits are only known if set in both the LHS & RHS.
898 KnownOne &= KnownOne2;
899 // Output known-0 are known to be clear if zero in either the LHS | RHS.
900 KnownZero |= KnownZero2;
Philip Reames2d858742015-11-10 18:46:14 +0000901
902 // and(x, add (x, -1)) is a common idiom that always clears the low bit;
903 // here we handle the more general case of adding any odd number by
904 // matching the form add(x, add(x, y)) where y is odd.
905 // TODO: This could be generalized to clearing any bit set in y where the
906 // following bit is known to be unset in y.
907 Value *Y = nullptr;
908 if (match(I->getOperand(0), m_Add(m_Specific(I->getOperand(1)),
909 m_Value(Y))) ||
910 match(I->getOperand(1), m_Add(m_Specific(I->getOperand(0)),
911 m_Value(Y)))) {
912 APInt KnownZero3(BitWidth, 0), KnownOne3(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000913 computeKnownBits(Y, KnownZero3, KnownOne3, Depth + 1, Q);
Philip Reames2d858742015-11-10 18:46:14 +0000914 if (KnownOne3.countTrailingOnes() > 0)
915 KnownZero |= APInt::getLowBitsSet(BitWidth, 1);
916 }
Jay Foad5a29c362014-05-15 12:12:55 +0000917 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000918 }
919 case Instruction::Or: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000920 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
921 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +0000922
Chris Lattner965c7692008-06-02 01:18:21 +0000923 // Output known-0 bits are only known if clear in both the LHS & RHS.
924 KnownZero &= KnownZero2;
925 // Output known-1 are known to be set if set in either the LHS | RHS.
926 KnownOne |= KnownOne2;
Jay Foad5a29c362014-05-15 12:12:55 +0000927 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000928 }
929 case Instruction::Xor: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000930 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
931 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +0000932
Chris Lattner965c7692008-06-02 01:18:21 +0000933 // Output known-0 bits are known if clear or set in both the LHS & RHS.
934 APInt KnownZeroOut = (KnownZero & KnownZero2) | (KnownOne & KnownOne2);
935 // Output known-1 are known to be set if set in only one of the LHS, RHS.
936 KnownOne = (KnownZero & KnownOne2) | (KnownOne & KnownZero2);
937 KnownZero = KnownZeroOut;
Jay Foad5a29c362014-05-15 12:12:55 +0000938 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000939 }
940 case Instruction::Mul: {
Nick Lewyckyfa306072012-03-18 23:28:48 +0000941 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000942 computeKnownBitsMul(I->getOperand(0), I->getOperand(1), NSW, KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000943 KnownOne, KnownZero2, KnownOne2, Depth, Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000944 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000945 }
946 case Instruction::UDiv: {
947 // For the purposes of computing leading zeros we can conservatively
948 // treat a udiv as a logical right shift by the power of 2 known to
949 // be less than the denominator.
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000950 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +0000951 unsigned LeadZ = KnownZero2.countLeadingOnes();
952
Jay Foad25a5e4c2010-12-01 08:53:58 +0000953 KnownOne2.clearAllBits();
954 KnownZero2.clearAllBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000955 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +0000956 unsigned RHSUnknownLeadingOnes = KnownOne2.countLeadingZeros();
957 if (RHSUnknownLeadingOnes != BitWidth)
958 LeadZ = std::min(BitWidth,
959 LeadZ + BitWidth - RHSUnknownLeadingOnes - 1);
960
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000961 KnownZero = APInt::getHighBitsSet(BitWidth, LeadZ);
Jay Foad5a29c362014-05-15 12:12:55 +0000962 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000963 }
David Majnemera19d0f22016-08-06 08:16:00 +0000964 case Instruction::Select: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +0000965 computeKnownBits(I->getOperand(2), KnownZero, KnownOne, Depth + 1, Q);
966 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +0000967
Pete Cooper35b00d52016-08-13 01:05:32 +0000968 const Value *LHS;
969 const Value *RHS;
David Majnemera19d0f22016-08-06 08:16:00 +0000970 SelectPatternFlavor SPF = matchSelectPattern(I, LHS, RHS).Flavor;
971 if (SelectPatternResult::isMinOrMax(SPF)) {
972 computeKnownBits(RHS, KnownZero, KnownOne, Depth + 1, Q);
973 computeKnownBits(LHS, KnownZero2, KnownOne2, Depth + 1, Q);
974 } else {
975 computeKnownBits(I->getOperand(2), KnownZero, KnownOne, Depth + 1, Q);
976 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
977 }
978
979 unsigned MaxHighOnes = 0;
980 unsigned MaxHighZeros = 0;
981 if (SPF == SPF_SMAX) {
982 // If both sides are negative, the result is negative.
983 if (KnownOne[BitWidth - 1] && KnownOne2[BitWidth - 1])
984 // We can derive a lower bound on the result by taking the max of the
985 // leading one bits.
986 MaxHighOnes =
987 std::max(KnownOne.countLeadingOnes(), KnownOne2.countLeadingOnes());
988 // If either side is non-negative, the result is non-negative.
989 else if (KnownZero[BitWidth - 1] || KnownZero2[BitWidth - 1])
990 MaxHighZeros = 1;
991 } else if (SPF == SPF_SMIN) {
992 // If both sides are non-negative, the result is non-negative.
993 if (KnownZero[BitWidth - 1] && KnownZero2[BitWidth - 1])
994 // We can derive an upper bound on the result by taking the max of the
995 // leading zero bits.
996 MaxHighZeros = std::max(KnownZero.countLeadingOnes(),
997 KnownZero2.countLeadingOnes());
998 // If either side is negative, the result is negative.
999 else if (KnownOne[BitWidth - 1] || KnownOne2[BitWidth - 1])
1000 MaxHighOnes = 1;
1001 } else if (SPF == SPF_UMAX) {
1002 // We can derive a lower bound on the result by taking the max of the
1003 // leading one bits.
1004 MaxHighOnes =
1005 std::max(KnownOne.countLeadingOnes(), KnownOne2.countLeadingOnes());
1006 } else if (SPF == SPF_UMIN) {
1007 // We can derive an upper bound on the result by taking the max of the
1008 // leading zero bits.
1009 MaxHighZeros =
1010 std::max(KnownZero.countLeadingOnes(), KnownZero2.countLeadingOnes());
1011 }
1012
Chris Lattner965c7692008-06-02 01:18:21 +00001013 // Only known if known in both the LHS and RHS.
1014 KnownOne &= KnownOne2;
1015 KnownZero &= KnownZero2;
David Majnemera19d0f22016-08-06 08:16:00 +00001016 if (MaxHighOnes > 0)
1017 KnownOne |= APInt::getHighBitsSet(BitWidth, MaxHighOnes);
1018 if (MaxHighZeros > 0)
1019 KnownZero |= APInt::getHighBitsSet(BitWidth, MaxHighZeros);
Jay Foad5a29c362014-05-15 12:12:55 +00001020 break;
David Majnemera19d0f22016-08-06 08:16:00 +00001021 }
Chris Lattner965c7692008-06-02 01:18:21 +00001022 case Instruction::FPTrunc:
1023 case Instruction::FPExt:
1024 case Instruction::FPToUI:
1025 case Instruction::FPToSI:
1026 case Instruction::SIToFP:
1027 case Instruction::UIToFP:
Jay Foad5a29c362014-05-15 12:12:55 +00001028 break; // Can't work with floating point.
Chris Lattner965c7692008-06-02 01:18:21 +00001029 case Instruction::PtrToInt:
1030 case Instruction::IntToPtr:
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001031 // Fall through and handle them the same as zext/trunc.
1032 LLVM_FALLTHROUGH;
Chris Lattner965c7692008-06-02 01:18:21 +00001033 case Instruction::ZExt:
1034 case Instruction::Trunc: {
Chris Lattner229907c2011-07-18 04:54:35 +00001035 Type *SrcTy = I->getOperand(0)->getType();
Nadav Rotem15198e92012-10-26 17:17:05 +00001036
Chris Lattner0cdbc7a2009-09-08 00:13:52 +00001037 unsigned SrcBitWidth;
Chris Lattner965c7692008-06-02 01:18:21 +00001038 // Note that we handle pointer operands here because of inttoptr/ptrtoint
1039 // which fall through here.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001040 SrcBitWidth = Q.DL.getTypeSizeInBits(SrcTy->getScalarType());
Nadav Rotem15198e92012-10-26 17:17:05 +00001041
1042 assert(SrcBitWidth && "SrcBitWidth can't be zero");
Jay Foad583abbc2010-12-07 08:25:19 +00001043 KnownZero = KnownZero.zextOrTrunc(SrcBitWidth);
1044 KnownOne = KnownOne.zextOrTrunc(SrcBitWidth);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001045 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Jay Foad583abbc2010-12-07 08:25:19 +00001046 KnownZero = KnownZero.zextOrTrunc(BitWidth);
1047 KnownOne = KnownOne.zextOrTrunc(BitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +00001048 // Any top bits are known to be zero.
1049 if (BitWidth > SrcBitWidth)
1050 KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
Jay Foad5a29c362014-05-15 12:12:55 +00001051 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001052 }
1053 case Instruction::BitCast: {
Chris Lattner229907c2011-07-18 04:54:35 +00001054 Type *SrcTy = I->getOperand(0)->getType();
Sanjay Pateldba8b4c2016-06-02 20:01:37 +00001055 if ((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
Chris Lattneredb84072009-07-02 16:04:08 +00001056 // TODO: For now, not handling conversions like:
1057 // (bitcast i64 %x to <2 x i32>)
Duncan Sands19d0b472010-02-16 11:11:14 +00001058 !I->getType()->isVectorTy()) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001059 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Jay Foad5a29c362014-05-15 12:12:55 +00001060 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001061 }
1062 break;
1063 }
1064 case Instruction::SExt: {
1065 // Compute the bits in the result that are not present in the input.
Chris Lattner0cdbc7a2009-09-08 00:13:52 +00001066 unsigned SrcBitWidth = I->getOperand(0)->getType()->getScalarSizeInBits();
Craig Topper1bef2c82012-12-22 19:15:35 +00001067
Jay Foad583abbc2010-12-07 08:25:19 +00001068 KnownZero = KnownZero.trunc(SrcBitWidth);
1069 KnownOne = KnownOne.trunc(SrcBitWidth);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001070 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Jay Foad583abbc2010-12-07 08:25:19 +00001071 KnownZero = KnownZero.zext(BitWidth);
1072 KnownOne = KnownOne.zext(BitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +00001073
1074 // If the sign bit of the input is known set or clear, then we know the
1075 // top bits of the result.
1076 if (KnownZero[SrcBitWidth-1]) // Input sign bit known zero
1077 KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
1078 else if (KnownOne[SrcBitWidth-1]) // Input sign bit known set
1079 KnownOne |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
Jay Foad5a29c362014-05-15 12:12:55 +00001080 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001081 }
Hal Finkelf2199b22015-10-23 20:37:08 +00001082 case Instruction::Shl: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001083 // (shl X, C1) & C2 == 0 iff (X & C2 >>u C1) == 0
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001084 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
1085 auto KZF = [BitWidth, NSW](const APInt &KnownZero, unsigned ShiftAmt) {
1086 APInt KZResult =
1087 (KnownZero << ShiftAmt) |
1088 APInt::getLowBitsSet(BitWidth, ShiftAmt); // Low bits known 0.
1089 // If this shift has "nsw" keyword, then the result is either a poison
1090 // value or has the same sign bit as the first operand.
1091 if (NSW && KnownZero.isNegative())
1092 KZResult.setBit(BitWidth - 1);
1093 return KZResult;
Hal Finkelf2199b22015-10-23 20:37:08 +00001094 };
1095
Evgeny Stupachenkod7f9c352016-08-24 23:01:33 +00001096 auto KOF = [BitWidth, NSW](const APInt &KnownOne, unsigned ShiftAmt) {
1097 APInt KOResult = KnownOne << ShiftAmt;
1098 if (NSW && KnownOne.isNegative())
1099 KOResult.setBit(BitWidth - 1);
1100 return KOResult;
Hal Finkelf2199b22015-10-23 20:37:08 +00001101 };
1102
1103 computeKnownBitsFromShiftOperator(I, KnownZero, KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001104 KnownZero2, KnownOne2, Depth, Q, KZF,
1105 KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001106 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001107 }
1108 case Instruction::LShr: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001109 // (ushr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Hal Finkelf2199b22015-10-23 20:37:08 +00001110 auto KZF = [BitWidth](const APInt &KnownZero, unsigned ShiftAmt) {
1111 return APIntOps::lshr(KnownZero, ShiftAmt) |
1112 // High bits known zero.
1113 APInt::getHighBitsSet(BitWidth, ShiftAmt);
1114 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001115
Malcolm Parsons17d266b2017-01-13 17:12:16 +00001116 auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
Hal Finkelf2199b22015-10-23 20:37:08 +00001117 return APIntOps::lshr(KnownOne, ShiftAmt);
1118 };
1119
1120 computeKnownBitsFromShiftOperator(I, KnownZero, KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001121 KnownZero2, KnownOne2, Depth, Q, KZF,
1122 KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001123 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001124 }
1125 case Instruction::AShr: {
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +00001126 // (ashr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Malcolm Parsons17d266b2017-01-13 17:12:16 +00001127 auto KZF = [](const APInt &KnownZero, unsigned ShiftAmt) {
Hal Finkelf2199b22015-10-23 20:37:08 +00001128 return APIntOps::ashr(KnownZero, ShiftAmt);
1129 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001130
Malcolm Parsons17d266b2017-01-13 17:12:16 +00001131 auto KOF = [](const APInt &KnownOne, unsigned ShiftAmt) {
Hal Finkelf2199b22015-10-23 20:37:08 +00001132 return APIntOps::ashr(KnownOne, ShiftAmt);
1133 };
Craig Topper1bef2c82012-12-22 19:15:35 +00001134
Hal Finkelf2199b22015-10-23 20:37:08 +00001135 computeKnownBitsFromShiftOperator(I, KnownZero, KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001136 KnownZero2, KnownOne2, Depth, Q, KZF,
1137 KOF);
Chris Lattner965c7692008-06-02 01:18:21 +00001138 break;
Hal Finkelf2199b22015-10-23 20:37:08 +00001139 }
Chris Lattner965c7692008-06-02 01:18:21 +00001140 case Instruction::Sub: {
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001141 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Jay Foada0653a32014-05-14 21:14:37 +00001142 computeKnownBitsAddSub(false, I->getOperand(0), I->getOperand(1), NSW,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001143 KnownZero, KnownOne, KnownZero2, KnownOne2, Depth,
1144 Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001145 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001146 }
Chris Lattner965c7692008-06-02 01:18:21 +00001147 case Instruction::Add: {
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001148 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Jay Foada0653a32014-05-14 21:14:37 +00001149 computeKnownBitsAddSub(true, I->getOperand(0), I->getOperand(1), NSW,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001150 KnownZero, KnownOne, KnownZero2, KnownOne2, Depth,
1151 Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001152 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001153 }
1154 case Instruction::SRem:
1155 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001156 APInt RA = Rem->getValue().abs();
1157 if (RA.isPowerOf2()) {
1158 APInt LowBits = RA - 1;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001159 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001160 Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001161
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001162 // The low bits of the first operand are unchanged by the srem.
1163 KnownZero = KnownZero2 & LowBits;
1164 KnownOne = KnownOne2 & LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +00001165
Duncan Sands26cd6bd2010-01-29 06:18:37 +00001166 // If the first operand is non-negative or has all low bits zero, then
1167 // the upper bits are all zero.
1168 if (KnownZero2[BitWidth-1] || ((KnownZero2 & LowBits) == LowBits))
1169 KnownZero |= ~LowBits;
1170
1171 // If the first operand is negative and not all low bits are zero, then
1172 // the upper bits are all one.
1173 if (KnownOne2[BitWidth-1] && ((KnownOne2 & LowBits) != 0))
1174 KnownOne |= ~LowBits;
1175
Craig Topper1bef2c82012-12-22 19:15:35 +00001176 assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
Chris Lattner965c7692008-06-02 01:18:21 +00001177 }
1178 }
Nick Lewyckye4679792011-03-07 01:50:10 +00001179
1180 // The sign bit is the LHS's sign bit, except when the result of the
1181 // remainder is zero.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001182 if (KnownZero.isNonNegative()) {
Nick Lewyckye4679792011-03-07 01:50:10 +00001183 APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001184 computeKnownBits(I->getOperand(0), LHSKnownZero, LHSKnownOne, Depth + 1,
1185 Q);
Nick Lewyckye4679792011-03-07 01:50:10 +00001186 // If it's known zero, our sign bit is also zero.
1187 if (LHSKnownZero.isNegative())
Duncan Sands34c48692012-04-30 11:56:58 +00001188 KnownZero.setBit(BitWidth - 1);
Nick Lewyckye4679792011-03-07 01:50:10 +00001189 }
1190
Chris Lattner965c7692008-06-02 01:18:21 +00001191 break;
1192 case Instruction::URem: {
1193 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00001194 const APInt &RA = Rem->getValue();
Chris Lattner965c7692008-06-02 01:18:21 +00001195 if (RA.isPowerOf2()) {
1196 APInt LowBits = (RA - 1);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001197 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001198 KnownZero |= ~LowBits;
1199 KnownOne &= LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +00001200 break;
1201 }
1202 }
1203
1204 // Since the result is less than or equal to either operand, any leading
1205 // zero bits in either operand must also exist in the result.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001206 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
1207 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001208
Chris Lattner4612ae12009-01-20 18:22:57 +00001209 unsigned Leaders = std::max(KnownZero.countLeadingOnes(),
Chris Lattner965c7692008-06-02 01:18:21 +00001210 KnownZero2.countLeadingOnes());
Jay Foad25a5e4c2010-12-01 08:53:58 +00001211 KnownOne.clearAllBits();
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001212 KnownZero = APInt::getHighBitsSet(BitWidth, Leaders);
Chris Lattner965c7692008-06-02 01:18:21 +00001213 break;
1214 }
1215
Victor Hernandeza3aaf852009-10-17 01:18:07 +00001216 case Instruction::Alloca: {
Pete Cooper35b00d52016-08-13 01:05:32 +00001217 const AllocaInst *AI = cast<AllocaInst>(I);
Chris Lattner965c7692008-06-02 01:18:21 +00001218 unsigned Align = AI->getAlignment();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001219 if (Align == 0)
Eduard Burtescu90c44492016-01-18 00:10:01 +00001220 Align = Q.DL.getABITypeAlignment(AI->getAllocatedType());
Craig Topper1bef2c82012-12-22 19:15:35 +00001221
Chris Lattner965c7692008-06-02 01:18:21 +00001222 if (Align > 0)
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001223 KnownZero = APInt::getLowBitsSet(BitWidth, countTrailingZeros(Align));
Chris Lattner965c7692008-06-02 01:18:21 +00001224 break;
1225 }
1226 case Instruction::GetElementPtr: {
1227 // Analyze all of the subscripts of this getelementptr instruction
1228 // to determine if we can prove known low zero bits.
Chris Lattner965c7692008-06-02 01:18:21 +00001229 APInt LocalKnownZero(BitWidth, 0), LocalKnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001230 computeKnownBits(I->getOperand(0), LocalKnownZero, LocalKnownOne, Depth + 1,
1231 Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001232 unsigned TrailZ = LocalKnownZero.countTrailingOnes();
1233
1234 gep_type_iterator GTI = gep_type_begin(I);
1235 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
1236 Value *Index = I->getOperand(i);
Peter Collingbourneab85225b2016-12-02 02:24:42 +00001237 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chris Lattner965c7692008-06-02 01:18:21 +00001238 // Handle struct member offset arithmetic.
Matt Arsenault74742a12013-08-19 21:43:16 +00001239
1240 // Handle case when index is vector zeroinitializer
1241 Constant *CIndex = cast<Constant>(Index);
1242 if (CIndex->isZeroValue())
1243 continue;
1244
1245 if (CIndex->getType()->isVectorTy())
1246 Index = CIndex->getSplatValue();
1247
Chris Lattner965c7692008-06-02 01:18:21 +00001248 unsigned Idx = cast<ConstantInt>(Index)->getZExtValue();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001249 const StructLayout *SL = Q.DL.getStructLayout(STy);
Chris Lattner965c7692008-06-02 01:18:21 +00001250 uint64_t Offset = SL->getElementOffset(Idx);
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001251 TrailZ = std::min<unsigned>(TrailZ,
1252 countTrailingZeros(Offset));
Chris Lattner965c7692008-06-02 01:18:21 +00001253 } else {
1254 // Handle array index arithmetic.
Chris Lattner229907c2011-07-18 04:54:35 +00001255 Type *IndexedTy = GTI.getIndexedType();
Jay Foad5a29c362014-05-15 12:12:55 +00001256 if (!IndexedTy->isSized()) {
1257 TrailZ = 0;
1258 break;
1259 }
Dan Gohman7ccc52f2009-06-15 22:12:54 +00001260 unsigned GEPOpiBits = Index->getType()->getScalarSizeInBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001261 uint64_t TypeSize = Q.DL.getTypeAllocSize(IndexedTy);
Chris Lattner965c7692008-06-02 01:18:21 +00001262 LocalKnownZero = LocalKnownOne = APInt(GEPOpiBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001263 computeKnownBits(Index, LocalKnownZero, LocalKnownOne, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00001264 TrailZ = std::min(TrailZ,
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +00001265 unsigned(countTrailingZeros(TypeSize) +
Chris Lattner4612ae12009-01-20 18:22:57 +00001266 LocalKnownZero.countTrailingOnes()));
Chris Lattner965c7692008-06-02 01:18:21 +00001267 }
1268 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001269
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001270 KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ);
Chris Lattner965c7692008-06-02 01:18:21 +00001271 break;
1272 }
1273 case Instruction::PHI: {
Pete Cooper35b00d52016-08-13 01:05:32 +00001274 const PHINode *P = cast<PHINode>(I);
Chris Lattner965c7692008-06-02 01:18:21 +00001275 // Handle the case of a simple two-predecessor recurrence PHI.
1276 // There's a lot more that could theoretically be done here, but
1277 // this is sufficient to catch some interesting cases.
1278 if (P->getNumIncomingValues() == 2) {
1279 for (unsigned i = 0; i != 2; ++i) {
1280 Value *L = P->getIncomingValue(i);
1281 Value *R = P->getIncomingValue(!i);
Dan Gohman80ca01c2009-07-17 20:47:02 +00001282 Operator *LU = dyn_cast<Operator>(L);
Chris Lattner965c7692008-06-02 01:18:21 +00001283 if (!LU)
1284 continue;
Dan Gohman80ca01c2009-07-17 20:47:02 +00001285 unsigned Opcode = LU->getOpcode();
Chris Lattner965c7692008-06-02 01:18:21 +00001286 // Check for operations that have the property that if
1287 // both their operands have low zero bits, the result
Artur Pilipenkobc76eca2016-08-22 13:14:07 +00001288 // will have low zero bits.
Chris Lattner965c7692008-06-02 01:18:21 +00001289 if (Opcode == Instruction::Add ||
1290 Opcode == Instruction::Sub ||
1291 Opcode == Instruction::And ||
1292 Opcode == Instruction::Or ||
1293 Opcode == Instruction::Mul) {
1294 Value *LL = LU->getOperand(0);
1295 Value *LR = LU->getOperand(1);
1296 // Find a recurrence.
1297 if (LL == I)
1298 L = LR;
1299 else if (LR == I)
1300 L = LL;
1301 else
1302 break;
1303 // Ok, we have a PHI of the form L op= R. Check for low
1304 // zero bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001305 computeKnownBits(R, KnownZero2, KnownOne2, Depth + 1, Q);
David Greeneaebd9e02008-10-27 23:24:03 +00001306
1307 // We need to take the minimum number of known bits
1308 APInt KnownZero3(KnownZero), KnownOne3(KnownOne);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001309 computeKnownBits(L, KnownZero3, KnownOne3, Depth + 1, Q);
David Greeneaebd9e02008-10-27 23:24:03 +00001310
Artur Pilipenkoc6eb6bd2016-10-12 16:18:43 +00001311 KnownZero = APInt::getLowBitsSet(
1312 BitWidth, std::min(KnownZero2.countTrailingOnes(),
1313 KnownZero3.countTrailingOnes()));
1314
1315 if (DontImproveNonNegativePhiBits)
1316 break;
1317
1318 auto *OverflowOp = dyn_cast<OverflowingBinaryOperator>(LU);
1319 if (OverflowOp && OverflowOp->hasNoSignedWrap()) {
1320 // If initial value of recurrence is nonnegative, and we are adding
1321 // a nonnegative number with nsw, the result can only be nonnegative
1322 // or poison value regardless of the number of times we execute the
1323 // add in phi recurrence. If initial value is negative and we are
1324 // adding a negative number with nsw, the result can only be
1325 // negative or poison value. Similar arguments apply to sub and mul.
1326 //
1327 // (add non-negative, non-negative) --> non-negative
1328 // (add negative, negative) --> negative
1329 if (Opcode == Instruction::Add) {
1330 if (KnownZero2.isNegative() && KnownZero3.isNegative())
1331 KnownZero.setBit(BitWidth - 1);
1332 else if (KnownOne2.isNegative() && KnownOne3.isNegative())
1333 KnownOne.setBit(BitWidth - 1);
1334 }
1335
1336 // (sub nsw non-negative, negative) --> non-negative
1337 // (sub nsw negative, non-negative) --> negative
1338 else if (Opcode == Instruction::Sub && LL == I) {
1339 if (KnownZero2.isNegative() && KnownOne3.isNegative())
1340 KnownZero.setBit(BitWidth - 1);
1341 else if (KnownOne2.isNegative() && KnownZero3.isNegative())
1342 KnownOne.setBit(BitWidth - 1);
1343 }
1344
1345 // (mul nsw non-negative, non-negative) --> non-negative
1346 else if (Opcode == Instruction::Mul && KnownZero2.isNegative() &&
1347 KnownZero3.isNegative())
1348 KnownZero.setBit(BitWidth - 1);
1349 }
1350
Chris Lattner965c7692008-06-02 01:18:21 +00001351 break;
1352 }
1353 }
1354 }
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001355
Nick Lewyckyac0b62c2011-02-10 23:54:10 +00001356 // Unreachable blocks may have zero-operand PHI nodes.
1357 if (P->getNumIncomingValues() == 0)
Jay Foad5a29c362014-05-15 12:12:55 +00001358 break;
Nick Lewyckyac0b62c2011-02-10 23:54:10 +00001359
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001360 // Otherwise take the unions of the known bit sets of the operands,
1361 // taking conservative care to avoid excessive recursion.
1362 if (Depth < MaxDepth - 1 && !KnownZero && !KnownOne) {
Duncan Sands7dc3d472011-03-08 12:39:03 +00001363 // Skip if every incoming value references to ourself.
Nuno Lopes0d44a502012-07-03 21:15:40 +00001364 if (dyn_cast_or_null<UndefValue>(P->hasConstantValue()))
Duncan Sands7dc3d472011-03-08 12:39:03 +00001365 break;
1366
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001367 KnownZero = APInt::getAllOnesValue(BitWidth);
1368 KnownOne = APInt::getAllOnesValue(BitWidth);
Pete Cooper833f34d2015-05-12 20:05:31 +00001369 for (Value *IncValue : P->incoming_values()) {
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001370 // Skip direct self references.
Pete Cooper833f34d2015-05-12 20:05:31 +00001371 if (IncValue == P) continue;
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001372
1373 KnownZero2 = APInt(BitWidth, 0);
1374 KnownOne2 = APInt(BitWidth, 0);
1375 // Recurse, but cap the recursion to one level, because we don't
1376 // want to waste time spinning around in loops.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001377 computeKnownBits(IncValue, KnownZero2, KnownOne2, MaxDepth - 1, Q);
Dan Gohmanbf0002e2009-05-21 02:28:33 +00001378 KnownZero &= KnownZero2;
1379 KnownOne &= KnownOne2;
1380 // If all bits have been ruled out, there's no need to check
1381 // more operands.
1382 if (!KnownZero && !KnownOne)
1383 break;
1384 }
1385 }
Chris Lattner965c7692008-06-02 01:18:21 +00001386 break;
1387 }
1388 case Instruction::Call:
Jingyue Wu37fcb592014-06-19 16:50:16 +00001389 case Instruction::Invoke:
Hal Finkel6fd5e1f2016-07-11 02:25:14 +00001390 // If range metadata is attached to this call, set known bits from that,
1391 // and then intersect with known bits based on other properties of the
1392 // function.
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001393 if (MDNode *MD = cast<Instruction>(I)->getMetadata(LLVMContext::MD_range))
Sanjoy Das1d1929a2015-10-28 03:20:15 +00001394 computeKnownBitsFromRangeMetadata(*MD, KnownZero, KnownOne);
Pete Cooper35b00d52016-08-13 01:05:32 +00001395 if (const Value *RV = ImmutableCallSite(I).getReturnedArgOperand()) {
Hal Finkel6fd5e1f2016-07-11 02:25:14 +00001396 computeKnownBits(RV, KnownZero2, KnownOne2, Depth + 1, Q);
1397 KnownZero |= KnownZero2;
1398 KnownOne |= KnownOne2;
1399 }
Pete Cooper35b00d52016-08-13 01:05:32 +00001400 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
Chris Lattner965c7692008-06-02 01:18:21 +00001401 switch (II->getIntrinsicID()) {
1402 default: break;
Philip Reames675418e2015-10-06 20:20:45 +00001403 case Intrinsic::bswap:
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001404 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Philip Reames675418e2015-10-06 20:20:45 +00001405 KnownZero |= KnownZero2.byteSwap();
1406 KnownOne |= KnownOne2.byteSwap();
1407 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001408 case Intrinsic::ctlz:
1409 case Intrinsic::cttz: {
1410 unsigned LowBits = Log2_32(BitWidth)+1;
Benjamin Kramer4ee57472011-12-24 17:31:46 +00001411 // If this call is undefined for 0, the result will be less than 2^n.
1412 if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
1413 LowBits -= 1;
Jingyue Wu37fcb592014-06-19 16:50:16 +00001414 KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - LowBits);
Benjamin Kramer4ee57472011-12-24 17:31:46 +00001415 break;
1416 }
1417 case Intrinsic::ctpop: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001418 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, Depth + 1, Q);
Philip Reamesddcf6b32015-10-14 22:42:12 +00001419 // We can bound the space the count needs. Also, bits known to be zero
1420 // can't contribute to the population.
1421 unsigned BitsPossiblySet = BitWidth - KnownZero2.countPopulation();
1422 unsigned LeadingZeros =
1423 APInt(BitWidth, BitsPossiblySet).countLeadingZeros();
Aaron Ballman58f413c2015-10-15 13:55:43 +00001424 assert(LeadingZeros <= BitWidth);
Philip Reamesddcf6b32015-10-14 22:42:12 +00001425 KnownZero |= APInt::getHighBitsSet(BitWidth, LeadingZeros);
1426 KnownOne &= ~KnownZero;
1427 // TODO: we could bound KnownOne using the lower bound on the number
1428 // of bits which might be set provided by popcnt KnownOne2.
Chris Lattner965c7692008-06-02 01:18:21 +00001429 break;
1430 }
Chad Rosierb3628842011-05-26 23:13:19 +00001431 case Intrinsic::x86_sse42_crc32_64_64:
Jingyue Wu37fcb592014-06-19 16:50:16 +00001432 KnownZero |= APInt::getHighBitsSet(64, 32);
Evan Cheng2a746bf2011-05-22 18:25:30 +00001433 break;
Chris Lattner965c7692008-06-02 01:18:21 +00001434 }
1435 }
1436 break;
Bjorn Pettersson39616032016-10-06 09:56:21 +00001437 case Instruction::ExtractElement:
1438 // Look through extract element. At the moment we keep this simple and skip
1439 // tracking the specific element. But at least we might find information
1440 // valid for all elements of the vector (for example if vector is sign
1441 // extended, shifted, etc).
1442 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
1443 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001444 case Instruction::ExtractValue:
1445 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I->getOperand(0))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001446 const ExtractValueInst *EVI = cast<ExtractValueInst>(I);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001447 if (EVI->getNumIndices() != 1) break;
1448 if (EVI->getIndices()[0] == 0) {
1449 switch (II->getIntrinsicID()) {
1450 default: break;
1451 case Intrinsic::uadd_with_overflow:
1452 case Intrinsic::sadd_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +00001453 computeKnownBitsAddSub(true, II->getArgOperand(0),
1454 II->getArgOperand(1), false, KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001455 KnownOne, KnownZero2, KnownOne2, Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001456 break;
1457 case Intrinsic::usub_with_overflow:
1458 case Intrinsic::ssub_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +00001459 computeKnownBitsAddSub(false, II->getArgOperand(0),
1460 II->getArgOperand(1), false, KnownZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001461 KnownOne, KnownZero2, KnownOne2, Depth, Q);
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001462 break;
Nick Lewyckyfa306072012-03-18 23:28:48 +00001463 case Intrinsic::umul_with_overflow:
1464 case Intrinsic::smul_with_overflow:
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001465 computeKnownBitsMul(II->getArgOperand(0), II->getArgOperand(1), false,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001466 KnownZero, KnownOne, KnownZero2, KnownOne2, Depth,
1467 Q);
Nick Lewyckyfa306072012-03-18 23:28:48 +00001468 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +00001469 }
1470 }
1471 }
Chris Lattner965c7692008-06-02 01:18:21 +00001472 }
Jingyue Wu12b0c282015-06-15 05:46:29 +00001473}
1474
1475/// Determine which bits of V are known to be either zero or one and return
1476/// them in the KnownZero/KnownOne bit sets.
1477///
1478/// NOTE: we cannot consider 'undef' to be "IsZero" here. The problem is that
1479/// we cannot optimize based on the assumption that it is zero without changing
1480/// it to be an explicit zero. If we don't change it to zero, other code could
1481/// optimized based on the contradictory assumption that it is non-zero.
1482/// Because instcombine aggressively folds operations with undef args anyway,
1483/// this won't lose us code quality.
1484///
1485/// This function is defined on values with integer type, values with pointer
1486/// type, and vectors of integers. In the case
1487/// where V is a vector, known zero, and known one values are the
1488/// same width as the vector element, and the bit is set only if it is true
1489/// for all of the elements in the vector.
Pete Cooper35b00d52016-08-13 01:05:32 +00001490void computeKnownBits(const Value *V, APInt &KnownZero, APInt &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001491 unsigned Depth, const Query &Q) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001492 assert(V && "No Value?");
1493 assert(Depth <= MaxDepth && "Limit Search Depth");
1494 unsigned BitWidth = KnownZero.getBitWidth();
1495
1496 assert((V->getType()->isIntOrIntVectorTy() ||
1497 V->getType()->getScalarType()->isPointerTy()) &&
Sanjay Pateldba8b4c2016-06-02 20:01:37 +00001498 "Not integer or pointer type!");
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001499 assert((Q.DL.getTypeSizeInBits(V->getType()->getScalarType()) == BitWidth) &&
Jingyue Wu12b0c282015-06-15 05:46:29 +00001500 (!V->getType()->isIntOrIntVectorTy() ||
1501 V->getType()->getScalarSizeInBits() == BitWidth) &&
1502 KnownZero.getBitWidth() == BitWidth &&
1503 KnownOne.getBitWidth() == BitWidth &&
1504 "V, KnownOne and KnownZero should have same BitWidth");
1505
Sanjay Patelc96f6db2016-09-16 21:20:36 +00001506 const APInt *C;
1507 if (match(V, m_APInt(C))) {
1508 // We know all of the bits for a scalar constant or a splat vector constant!
1509 KnownOne = *C;
Jingyue Wu12b0c282015-06-15 05:46:29 +00001510 KnownZero = ~KnownOne;
1511 return;
1512 }
1513 // Null and aggregate-zero are all-zeros.
Sanjay Patele8dc0902016-05-23 17:57:54 +00001514 if (isa<ConstantPointerNull>(V) || isa<ConstantAggregateZero>(V)) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001515 KnownOne.clearAllBits();
1516 KnownZero = APInt::getAllOnesValue(BitWidth);
1517 return;
1518 }
1519 // Handle a constant vector by taking the intersection of the known bits of
David Majnemer3918cdd2016-05-04 06:13:33 +00001520 // each element.
Pete Cooper35b00d52016-08-13 01:05:32 +00001521 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V)) {
Jingyue Wu12b0c282015-06-15 05:46:29 +00001522 // We know that CDS must be a vector of integers. Take the intersection of
1523 // each element.
1524 KnownZero.setAllBits(); KnownOne.setAllBits();
1525 APInt Elt(KnownZero.getBitWidth(), 0);
1526 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1527 Elt = CDS->getElementAsInteger(i);
1528 KnownZero &= ~Elt;
1529 KnownOne &= Elt;
1530 }
1531 return;
1532 }
1533
Pete Cooper35b00d52016-08-13 01:05:32 +00001534 if (const auto *CV = dyn_cast<ConstantVector>(V)) {
David Majnemer3918cdd2016-05-04 06:13:33 +00001535 // We know that CV must be a vector of integers. Take the intersection of
1536 // each element.
1537 KnownZero.setAllBits(); KnownOne.setAllBits();
1538 APInt Elt(KnownZero.getBitWidth(), 0);
1539 for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i) {
1540 Constant *Element = CV->getAggregateElement(i);
1541 auto *ElementCI = dyn_cast_or_null<ConstantInt>(Element);
1542 if (!ElementCI) {
1543 KnownZero.clearAllBits();
1544 KnownOne.clearAllBits();
1545 return;
1546 }
1547 Elt = ElementCI->getValue();
1548 KnownZero &= ~Elt;
1549 KnownOne &= Elt;
1550 }
1551 return;
1552 }
1553
Jingyue Wu12b0c282015-06-15 05:46:29 +00001554 // Start out not knowing anything.
1555 KnownZero.clearAllBits(); KnownOne.clearAllBits();
1556
Duncan P. N. Exon Smithb1b208a2016-09-24 20:42:02 +00001557 // We can't imply anything about undefs.
1558 if (isa<UndefValue>(V))
1559 return;
1560
1561 // There's no point in looking through other users of ConstantData for
1562 // assumptions. Confirm that we've handled them all.
1563 assert(!isa<ConstantData>(V) && "Unhandled constant data!");
1564
Jingyue Wu12b0c282015-06-15 05:46:29 +00001565 // Limit search depth.
1566 // All recursive calls that increase depth must come after this.
1567 if (Depth == MaxDepth)
1568 return;
1569
1570 // A weak GlobalAlias is totally unknown. A non-weak GlobalAlias has
1571 // the bits of its aliasee.
Pete Cooper35b00d52016-08-13 01:05:32 +00001572 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00001573 if (!GA->isInterposable())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001574 computeKnownBits(GA->getAliasee(), KnownZero, KnownOne, Depth + 1, Q);
Jingyue Wu12b0c282015-06-15 05:46:29 +00001575 return;
1576 }
1577
Pete Cooper35b00d52016-08-13 01:05:32 +00001578 if (const Operator *I = dyn_cast<Operator>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001579 computeKnownBitsFromOperator(I, KnownZero, KnownOne, Depth, Q);
Sanjay Patela67559c2015-09-25 20:12:43 +00001580
Artur Pilipenko029d8532015-09-30 11:55:45 +00001581 // Aligned pointers have trailing zeros - refine KnownZero set
1582 if (V->getType()->isPointerTy()) {
Artur Pilipenkoae51afc2016-02-24 12:25:10 +00001583 unsigned Align = V->getPointerAlignment(Q.DL);
Artur Pilipenko029d8532015-09-30 11:55:45 +00001584 if (Align)
1585 KnownZero |= APInt::getLowBitsSet(BitWidth, countTrailingZeros(Align));
1586 }
1587
Philip Reames146307e2016-03-03 19:44:06 +00001588 // computeKnownBitsFromAssume strictly refines KnownZero and
1589 // KnownOne. Therefore, we run them after computeKnownBitsFromOperator.
Jingyue Wu12b0c282015-06-15 05:46:29 +00001590
1591 // Check whether a nearby assume intrinsic can determine some known bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001592 computeKnownBitsFromAssume(V, KnownZero, KnownOne, Depth, Q);
Jingyue Wu12b0c282015-06-15 05:46:29 +00001593
Jay Foad5a29c362014-05-15 12:12:55 +00001594 assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
Chris Lattner965c7692008-06-02 01:18:21 +00001595}
1596
Sanjay Patelaee84212014-11-04 16:27:42 +00001597/// Determine whether the sign bit is known to be zero or one.
1598/// Convenience wrapper around computeKnownBits.
Pete Cooper35b00d52016-08-13 01:05:32 +00001599void ComputeSignBit(const Value *V, bool &KnownZero, bool &KnownOne,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001600 unsigned Depth, const Query &Q) {
1601 unsigned BitWidth = getBitWidth(V->getType(), Q.DL);
Duncan Sandsd3951082011-01-25 09:38:29 +00001602 if (!BitWidth) {
1603 KnownZero = false;
1604 KnownOne = false;
1605 return;
1606 }
1607 APInt ZeroBits(BitWidth, 0);
1608 APInt OneBits(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001609 computeKnownBits(V, ZeroBits, OneBits, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001610 KnownOne = OneBits[BitWidth - 1];
1611 KnownZero = ZeroBits[BitWidth - 1];
1612}
1613
Sanjay Patelaee84212014-11-04 16:27:42 +00001614/// Return true if the given value is known to have exactly one
Duncan Sandsd3951082011-01-25 09:38:29 +00001615/// bit set when defined. For vectors return true if every element is known to
Sanjay Patelaee84212014-11-04 16:27:42 +00001616/// be a power of two when defined. Supports values with integer or pointer
Duncan Sandsd3951082011-01-25 09:38:29 +00001617/// types and vectors of integers.
Pete Cooper35b00d52016-08-13 01:05:32 +00001618bool isKnownToBeAPowerOfTwo(const Value *V, bool OrZero, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001619 const Query &Q) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001620 if (const Constant *C = dyn_cast<Constant>(V)) {
Duncan Sandsba286d72011-10-26 20:55:21 +00001621 if (C->isNullValue())
1622 return OrZero;
Sanjay Patele2e89ef2016-05-22 15:41:53 +00001623
1624 const APInt *ConstIntOrConstSplatInt;
1625 if (match(C, m_APInt(ConstIntOrConstSplatInt)))
1626 return ConstIntOrConstSplatInt->isPowerOf2();
Duncan Sandsba286d72011-10-26 20:55:21 +00001627 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001628
1629 // 1 << X is clearly a power of two if the one is not shifted off the end. If
1630 // it is shifted off the end then the result is undefined.
1631 if (match(V, m_Shl(m_One(), m_Value())))
1632 return true;
1633
1634 // (signbit) >>l X is clearly a power of two if the one is not shifted off the
1635 // bottom. If it is shifted off the bottom then the result is undefined.
Duncan Sands4b397fc2011-02-01 08:50:33 +00001636 if (match(V, m_LShr(m_SignBit(), m_Value())))
Duncan Sandsd3951082011-01-25 09:38:29 +00001637 return true;
1638
1639 // The remaining tests are all recursive, so bail out if we hit the limit.
1640 if (Depth++ == MaxDepth)
1641 return false;
1642
Craig Topper9f008862014-04-15 04:59:12 +00001643 Value *X = nullptr, *Y = nullptr;
Sanjay Patel41160c22015-12-30 22:40:52 +00001644 // A shift left or a logical shift right of a power of two is a power of two
1645 // or zero.
Duncan Sands985ba632011-10-28 18:30:05 +00001646 if (OrZero && (match(V, m_Shl(m_Value(X), m_Value())) ||
Sanjay Patel41160c22015-12-30 22:40:52 +00001647 match(V, m_LShr(m_Value(X), m_Value()))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001648 return isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q);
Duncan Sands985ba632011-10-28 18:30:05 +00001649
Pete Cooper35b00d52016-08-13 01:05:32 +00001650 if (const ZExtInst *ZI = dyn_cast<ZExtInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001651 return isKnownToBeAPowerOfTwo(ZI->getOperand(0), OrZero, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001652
Pete Cooper35b00d52016-08-13 01:05:32 +00001653 if (const SelectInst *SI = dyn_cast<SelectInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001654 return isKnownToBeAPowerOfTwo(SI->getTrueValue(), OrZero, Depth, Q) &&
1655 isKnownToBeAPowerOfTwo(SI->getFalseValue(), OrZero, Depth, Q);
Duncan Sandsba286d72011-10-26 20:55:21 +00001656
Duncan Sandsba286d72011-10-26 20:55:21 +00001657 if (OrZero && match(V, m_And(m_Value(X), m_Value(Y)))) {
1658 // A power of two and'd with anything is a power of two or zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001659 if (isKnownToBeAPowerOfTwo(X, /*OrZero*/ true, Depth, Q) ||
1660 isKnownToBeAPowerOfTwo(Y, /*OrZero*/ true, Depth, Q))
Duncan Sandsba286d72011-10-26 20:55:21 +00001661 return true;
1662 // X & (-X) is always a power of two or zero.
1663 if (match(X, m_Neg(m_Specific(Y))) || match(Y, m_Neg(m_Specific(X))))
1664 return true;
1665 return false;
1666 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001667
David Majnemerb7d54092013-07-30 21:01:36 +00001668 // Adding a power-of-two or zero to the same power-of-two or zero yields
1669 // either the original power-of-two, a larger power-of-two or zero.
1670 if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001671 const OverflowingBinaryOperator *VOBO = cast<OverflowingBinaryOperator>(V);
David Majnemerb7d54092013-07-30 21:01:36 +00001672 if (OrZero || VOBO->hasNoUnsignedWrap() || VOBO->hasNoSignedWrap()) {
1673 if (match(X, m_And(m_Specific(Y), m_Value())) ||
1674 match(X, m_And(m_Value(), m_Specific(Y))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001675 if (isKnownToBeAPowerOfTwo(Y, OrZero, Depth, Q))
David Majnemerb7d54092013-07-30 21:01:36 +00001676 return true;
1677 if (match(Y, m_And(m_Specific(X), m_Value())) ||
1678 match(Y, m_And(m_Value(), m_Specific(X))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001679 if (isKnownToBeAPowerOfTwo(X, OrZero, Depth, Q))
David Majnemerb7d54092013-07-30 21:01:36 +00001680 return true;
1681
1682 unsigned BitWidth = V->getType()->getScalarSizeInBits();
1683 APInt LHSZeroBits(BitWidth, 0), LHSOneBits(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001684 computeKnownBits(X, LHSZeroBits, LHSOneBits, Depth, Q);
David Majnemerb7d54092013-07-30 21:01:36 +00001685
1686 APInt RHSZeroBits(BitWidth, 0), RHSOneBits(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001687 computeKnownBits(Y, RHSZeroBits, RHSOneBits, Depth, Q);
David Majnemerb7d54092013-07-30 21:01:36 +00001688 // If i8 V is a power of two or zero:
1689 // ZeroBits: 1 1 1 0 1 1 1 1
1690 // ~ZeroBits: 0 0 0 1 0 0 0 0
1691 if ((~(LHSZeroBits & RHSZeroBits)).isPowerOf2())
1692 // If OrZero isn't set, we cannot give back a zero result.
1693 // Make sure either the LHS or RHS has a bit set.
1694 if (OrZero || RHSOneBits.getBoolValue() || LHSOneBits.getBoolValue())
1695 return true;
1696 }
1697 }
David Majnemerbeab5672013-05-18 19:30:37 +00001698
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001699 // An exact divide or right shift can only shift off zero bits, so the result
Nick Lewyckyf0469af2011-03-21 21:40:32 +00001700 // is a power of two only if the first operand is a power of two and not
1701 // copying a sign bit (sdiv int_min, 2).
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001702 if (match(V, m_Exact(m_LShr(m_Value(), m_Value()))) ||
1703 match(V, m_Exact(m_UDiv(m_Value(), m_Value())))) {
Hal Finkel60db0582014-09-07 18:57:58 +00001704 return isKnownToBeAPowerOfTwo(cast<Operator>(V)->getOperand(0), OrZero,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001705 Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001706 }
1707
Duncan Sandsd3951082011-01-25 09:38:29 +00001708 return false;
1709}
1710
Chandler Carruth80d3e562012-12-07 02:08:58 +00001711/// \brief Test whether a GEP's result is known to be non-null.
1712///
1713/// Uses properties inherent in a GEP to try to determine whether it is known
1714/// to be non-null.
1715///
1716/// Currently this routine does not support vector GEPs.
Pete Cooper35b00d52016-08-13 01:05:32 +00001717static bool isGEPKnownNonNull(const GEPOperator *GEP, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001718 const Query &Q) {
Chandler Carruth80d3e562012-12-07 02:08:58 +00001719 if (!GEP->isInBounds() || GEP->getPointerAddressSpace() != 0)
1720 return false;
1721
1722 // FIXME: Support vector-GEPs.
1723 assert(GEP->getType()->isPointerTy() && "We only support plain pointer GEP");
1724
1725 // If the base pointer is non-null, we cannot walk to a null address with an
1726 // inbounds GEP in address space zero.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001727 if (isKnownNonZero(GEP->getPointerOperand(), Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001728 return true;
1729
Chandler Carruth80d3e562012-12-07 02:08:58 +00001730 // Walk the GEP operands and see if any operand introduces a non-zero offset.
1731 // If so, then the GEP cannot produce a null pointer, as doing so would
1732 // inherently violate the inbounds contract within address space zero.
1733 for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
1734 GTI != GTE; ++GTI) {
1735 // Struct types are easy -- they must always be indexed by a constant.
Peter Collingbourneab85225b2016-12-02 02:24:42 +00001736 if (StructType *STy = GTI.getStructTypeOrNull()) {
Chandler Carruth80d3e562012-12-07 02:08:58 +00001737 ConstantInt *OpC = cast<ConstantInt>(GTI.getOperand());
1738 unsigned ElementIdx = OpC->getZExtValue();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001739 const StructLayout *SL = Q.DL.getStructLayout(STy);
Chandler Carruth80d3e562012-12-07 02:08:58 +00001740 uint64_t ElementOffset = SL->getElementOffset(ElementIdx);
1741 if (ElementOffset > 0)
1742 return true;
1743 continue;
1744 }
1745
1746 // If we have a zero-sized type, the index doesn't matter. Keep looping.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001747 if (Q.DL.getTypeAllocSize(GTI.getIndexedType()) == 0)
Chandler Carruth80d3e562012-12-07 02:08:58 +00001748 continue;
1749
1750 // Fast path the constant operand case both for efficiency and so we don't
1751 // increment Depth when just zipping down an all-constant GEP.
1752 if (ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand())) {
1753 if (!OpC->isZero())
1754 return true;
1755 continue;
1756 }
1757
1758 // We post-increment Depth here because while isKnownNonZero increments it
1759 // as well, when we pop back up that increment won't persist. We don't want
1760 // to recurse 10k times just because we have 10k GEP operands. We don't
1761 // bail completely out because we want to handle constant GEPs regardless
1762 // of depth.
1763 if (Depth++ >= MaxDepth)
1764 continue;
1765
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001766 if (isKnownNonZero(GTI.getOperand(), Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001767 return true;
1768 }
1769
1770 return false;
1771}
1772
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001773/// Does the 'Range' metadata (which must be a valid MD_range operand list)
1774/// ensure that the value it's attached to is never Value? 'RangeType' is
1775/// is the type of the value described by the range.
Pete Cooper35b00d52016-08-13 01:05:32 +00001776static bool rangeMetadataExcludesValue(const MDNode* Ranges, const APInt& Value) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001777 const unsigned NumRanges = Ranges->getNumOperands() / 2;
1778 assert(NumRanges >= 1);
1779 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001780 ConstantInt *Lower =
1781 mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 0));
1782 ConstantInt *Upper =
1783 mdconst::extract<ConstantInt>(Ranges->getOperand(2 * i + 1));
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001784 ConstantRange Range(Lower->getValue(), Upper->getValue());
1785 if (Range.contains(Value))
1786 return false;
1787 }
1788 return true;
1789}
1790
Sanjay Patelaee84212014-11-04 16:27:42 +00001791/// Return true if the given value is known to be non-zero when defined.
1792/// For vectors return true if every element is known to be non-zero when
1793/// defined. Supports values with integer or pointer type and vectors of
1794/// integers.
Pete Cooper35b00d52016-08-13 01:05:32 +00001795bool isKnownNonZero(const Value *V, unsigned Depth, const Query &Q) {
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001796 if (auto *C = dyn_cast<Constant>(V)) {
Duncan Sandsd3951082011-01-25 09:38:29 +00001797 if (C->isNullValue())
1798 return false;
1799 if (isa<ConstantInt>(C))
1800 // Must be non-zero due to null test above.
1801 return true;
Sanjay Patel23019d12016-05-24 14:18:49 +00001802
1803 // For constant vectors, check that all elements are undefined or known
1804 // non-zero to determine that the whole vector is known non-zero.
1805 if (auto *VecTy = dyn_cast<VectorType>(C->getType())) {
1806 for (unsigned i = 0, e = VecTy->getNumElements(); i != e; ++i) {
1807 Constant *Elt = C->getAggregateElement(i);
1808 if (!Elt || Elt->isNullValue())
1809 return false;
1810 if (!isa<UndefValue>(Elt) && !isa<ConstantInt>(Elt))
1811 return false;
1812 }
1813 return true;
1814 }
1815
Duncan Sandsd3951082011-01-25 09:38:29 +00001816 return false;
1817 }
1818
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001819 if (auto *I = dyn_cast<Instruction>(V)) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001820 if (MDNode *Ranges = I->getMetadata(LLVMContext::MD_range)) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001821 // If the possible ranges don't contain zero, then the value is
1822 // definitely non-zero.
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00001823 if (auto *Ty = dyn_cast<IntegerType>(V->getType())) {
Philip Reames4cb4d3e2014-10-30 20:25:19 +00001824 const APInt ZeroValue(Ty->getBitWidth(), 0);
1825 if (rangeMetadataExcludesValue(Ranges, ZeroValue))
1826 return true;
1827 }
1828 }
1829 }
1830
Duncan Sandsd3951082011-01-25 09:38:29 +00001831 // The remaining tests are all recursive, so bail out if we hit the limit.
Duncan Sands7cb61e52011-10-27 19:16:21 +00001832 if (Depth++ >= MaxDepth)
Duncan Sandsd3951082011-01-25 09:38:29 +00001833 return false;
1834
Chandler Carruth80d3e562012-12-07 02:08:58 +00001835 // Check for pointer simplifications.
1836 if (V->getType()->isPointerTy()) {
Manman Ren12171122013-03-18 21:23:25 +00001837 if (isKnownNonNull(V))
Sanjoy Das6082c1a2016-05-07 02:08:15 +00001838 return true;
Pete Cooper35b00d52016-08-13 01:05:32 +00001839 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001840 if (isGEPKnownNonNull(GEP, Depth, Q))
Chandler Carruth80d3e562012-12-07 02:08:58 +00001841 return true;
1842 }
1843
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001844 unsigned BitWidth = getBitWidth(V->getType()->getScalarType(), Q.DL);
Duncan Sandsd3951082011-01-25 09:38:29 +00001845
1846 // X | Y != 0 if X != 0 or Y != 0.
Craig Topper9f008862014-04-15 04:59:12 +00001847 Value *X = nullptr, *Y = nullptr;
Duncan Sandsd3951082011-01-25 09:38:29 +00001848 if (match(V, m_Or(m_Value(X), m_Value(Y))))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001849 return isKnownNonZero(X, Depth, Q) || isKnownNonZero(Y, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001850
1851 // ext X != 0 if X != 0.
1852 if (isa<SExtInst>(V) || isa<ZExtInst>(V))
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001853 return isKnownNonZero(cast<Instruction>(V)->getOperand(0), Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001854
Duncan Sands2e9e4f12011-01-29 13:27:00 +00001855 // shl X, Y != 0 if X is odd. Note that the value of the shift is undefined
Duncan Sandsd3951082011-01-25 09:38:29 +00001856 // if the lowest bit is shifted off the end.
1857 if (BitWidth && match(V, m_Shl(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001858 // shl nuw can't remove any non-zero bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00001859 const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001860 if (BO->hasNoUnsignedWrap())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001861 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001862
Duncan Sandsd3951082011-01-25 09:38:29 +00001863 APInt KnownZero(BitWidth, 0);
1864 APInt KnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001865 computeKnownBits(X, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001866 if (KnownOne[0])
1867 return true;
1868 }
Duncan Sands2e9e4f12011-01-29 13:27:00 +00001869 // shr X, Y != 0 if X is negative. Note that the value of the shift is not
Duncan Sandsd3951082011-01-25 09:38:29 +00001870 // defined if the sign bit is shifted off the end.
1871 else if (match(V, m_Shr(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001872 // shr exact can only shift out zero bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00001873 const PossiblyExactOperator *BO = cast<PossiblyExactOperator>(V);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001874 if (BO->isExact())
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001875 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001876
Duncan Sandsd3951082011-01-25 09:38:29 +00001877 bool XKnownNonNegative, XKnownNegative;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001878 ComputeSignBit(X, XKnownNonNegative, XKnownNegative, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001879 if (XKnownNegative)
1880 return true;
James Molloyb6be1eb2015-09-24 16:06:32 +00001881
1882 // If the shifter operand is a constant, and all of the bits shifted
1883 // out are known to be zero, and X is known non-zero then at least one
1884 // non-zero bit must remain.
1885 if (ConstantInt *Shift = dyn_cast<ConstantInt>(Y)) {
1886 APInt KnownZero(BitWidth, 0);
1887 APInt KnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001888 computeKnownBits(X, KnownZero, KnownOne, Depth, Q);
Sanjoy Das6082c1a2016-05-07 02:08:15 +00001889
James Molloyb6be1eb2015-09-24 16:06:32 +00001890 auto ShiftVal = Shift->getLimitedValue(BitWidth - 1);
1891 // Is there a known one in the portion not shifted out?
1892 if (KnownOne.countLeadingZeros() < BitWidth - ShiftVal)
1893 return true;
1894 // Are all the bits to be shifted out known zero?
1895 if (KnownZero.countTrailingOnes() >= ShiftVal)
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001896 return isKnownNonZero(X, Depth, Q);
James Molloyb6be1eb2015-09-24 16:06:32 +00001897 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001898 }
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001899 // div exact can only produce a zero if the dividend is zero.
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001900 else if (match(V, m_Exact(m_IDiv(m_Value(X), m_Value())))) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001901 return isKnownNonZero(X, Depth, Q);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001902 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001903 // X + Y.
1904 else if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
1905 bool XKnownNonNegative, XKnownNegative;
1906 bool YKnownNonNegative, YKnownNegative;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001907 ComputeSignBit(X, XKnownNonNegative, XKnownNegative, Depth, Q);
1908 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001909
1910 // If X and Y are both non-negative (as signed values) then their sum is not
Duncan Sands9e9d5b22011-01-25 15:14:15 +00001911 // zero unless both X and Y are zero.
Duncan Sandsd3951082011-01-25 09:38:29 +00001912 if (XKnownNonNegative && YKnownNonNegative)
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001913 if (isKnownNonZero(X, Depth, Q) || isKnownNonZero(Y, Depth, Q))
Duncan Sands9e9d5b22011-01-25 15:14:15 +00001914 return true;
Duncan Sandsd3951082011-01-25 09:38:29 +00001915
1916 // If X and Y are both negative (as signed values) then their sum is not
1917 // zero unless both X and Y equal INT_MIN.
1918 if (BitWidth && XKnownNegative && YKnownNegative) {
1919 APInt KnownZero(BitWidth, 0);
1920 APInt KnownOne(BitWidth, 0);
1921 APInt Mask = APInt::getSignedMaxValue(BitWidth);
1922 // The sign bit of X is set. If some other bit is set then X is not equal
1923 // to INT_MIN.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001924 computeKnownBits(X, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001925 if ((KnownOne & Mask) != 0)
1926 return true;
1927 // The sign bit of Y is set. If some other bit is set then Y is not equal
1928 // to INT_MIN.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001929 computeKnownBits(Y, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001930 if ((KnownOne & Mask) != 0)
1931 return true;
1932 }
1933
1934 // The sum of a non-negative number and a power of two is not zero.
Hal Finkel60db0582014-09-07 18:57:58 +00001935 if (XKnownNonNegative &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001936 isKnownToBeAPowerOfTwo(Y, /*OrZero*/ false, Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00001937 return true;
Hal Finkel60db0582014-09-07 18:57:58 +00001938 if (YKnownNonNegative &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001939 isKnownToBeAPowerOfTwo(X, /*OrZero*/ false, Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00001940 return true;
1941 }
Duncan Sands7cb61e52011-10-27 19:16:21 +00001942 // X * Y.
1943 else if (match(V, m_Mul(m_Value(X), m_Value(Y)))) {
Pete Cooper35b00d52016-08-13 01:05:32 +00001944 const OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
Duncan Sands7cb61e52011-10-27 19:16:21 +00001945 // If X and Y are non-zero then so is X * Y as long as the multiplication
1946 // does not overflow.
1947 if ((BO->hasNoSignedWrap() || BO->hasNoUnsignedWrap()) &&
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001948 isKnownNonZero(X, Depth, Q) && isKnownNonZero(Y, Depth, Q))
Duncan Sands7cb61e52011-10-27 19:16:21 +00001949 return true;
1950 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001951 // (C ? X : Y) != 0 if X != 0 and Y != 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00001952 else if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001953 if (isKnownNonZero(SI->getTrueValue(), Depth, Q) &&
1954 isKnownNonZero(SI->getFalseValue(), Depth, Q))
Duncan Sandsd3951082011-01-25 09:38:29 +00001955 return true;
1956 }
James Molloy897048b2015-09-29 14:08:45 +00001957 // PHI
Pete Cooper35b00d52016-08-13 01:05:32 +00001958 else if (const PHINode *PN = dyn_cast<PHINode>(V)) {
James Molloy897048b2015-09-29 14:08:45 +00001959 // Try and detect a recurrence that monotonically increases from a
1960 // starting value, as these are common as induction variables.
1961 if (PN->getNumIncomingValues() == 2) {
1962 Value *Start = PN->getIncomingValue(0);
1963 Value *Induction = PN->getIncomingValue(1);
1964 if (isa<ConstantInt>(Induction) && !isa<ConstantInt>(Start))
1965 std::swap(Start, Induction);
1966 if (ConstantInt *C = dyn_cast<ConstantInt>(Start)) {
1967 if (!C->isZero() && !C->isNegative()) {
1968 ConstantInt *X;
1969 if ((match(Induction, m_NSWAdd(m_Specific(PN), m_ConstantInt(X))) ||
1970 match(Induction, m_NUWAdd(m_Specific(PN), m_ConstantInt(X)))) &&
1971 !X->isNegative())
1972 return true;
1973 }
1974 }
1975 }
Jun Bum Limca832662016-02-01 17:03:07 +00001976 // Check if all incoming values are non-zero constant.
1977 bool AllNonZeroConstants = all_of(PN->operands(), [](Value *V) {
1978 return isa<ConstantInt>(V) && !cast<ConstantInt>(V)->isZeroValue();
1979 });
1980 if (AllNonZeroConstants)
1981 return true;
James Molloy897048b2015-09-29 14:08:45 +00001982 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001983
1984 if (!BitWidth) return false;
1985 APInt KnownZero(BitWidth, 0);
1986 APInt KnownOne(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00001987 computeKnownBits(V, KnownZero, KnownOne, Depth, Q);
Duncan Sandsd3951082011-01-25 09:38:29 +00001988 return KnownOne != 0;
1989}
1990
James Molloy1d88d6f2015-10-22 13:18:42 +00001991/// Return true if V2 == V1 + X, where X is known non-zero.
Pete Cooper35b00d52016-08-13 01:05:32 +00001992static bool isAddOfNonZero(const Value *V1, const Value *V2, const Query &Q) {
1993 const BinaryOperator *BO = dyn_cast<BinaryOperator>(V1);
James Molloy1d88d6f2015-10-22 13:18:42 +00001994 if (!BO || BO->getOpcode() != Instruction::Add)
1995 return false;
1996 Value *Op = nullptr;
1997 if (V2 == BO->getOperand(0))
1998 Op = BO->getOperand(1);
1999 else if (V2 == BO->getOperand(1))
2000 Op = BO->getOperand(0);
2001 else
2002 return false;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002003 return isKnownNonZero(Op, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002004}
2005
2006/// Return true if it is known that V1 != V2.
Pete Cooper35b00d52016-08-13 01:05:32 +00002007static bool isKnownNonEqual(const Value *V1, const Value *V2, const Query &Q) {
James Molloy1d88d6f2015-10-22 13:18:42 +00002008 if (V1->getType()->isVectorTy() || V1 == V2)
2009 return false;
2010 if (V1->getType() != V2->getType())
2011 // We can't look through casts yet.
2012 return false;
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002013 if (isAddOfNonZero(V1, V2, Q) || isAddOfNonZero(V2, V1, Q))
James Molloy1d88d6f2015-10-22 13:18:42 +00002014 return true;
2015
2016 if (IntegerType *Ty = dyn_cast<IntegerType>(V1->getType())) {
2017 // Are any known bits in V1 contradictory to known bits in V2? If V1
2018 // has a known zero where V2 has a known one, they must not be equal.
2019 auto BitWidth = Ty->getBitWidth();
2020 APInt KnownZero1(BitWidth, 0);
2021 APInt KnownOne1(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002022 computeKnownBits(V1, KnownZero1, KnownOne1, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002023 APInt KnownZero2(BitWidth, 0);
2024 APInt KnownOne2(BitWidth, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002025 computeKnownBits(V2, KnownZero2, KnownOne2, 0, Q);
James Molloy1d88d6f2015-10-22 13:18:42 +00002026
2027 auto OppositeBits = (KnownZero1 & KnownOne2) | (KnownZero2 & KnownOne1);
2028 if (OppositeBits.getBoolValue())
2029 return true;
2030 }
2031 return false;
2032}
2033
Sanjay Patelaee84212014-11-04 16:27:42 +00002034/// Return true if 'V & Mask' is known to be zero. We use this predicate to
2035/// simplify operations downstream. Mask is known to be zero for bits that V
2036/// cannot have.
Chris Lattner4bc28252009-09-08 00:06:16 +00002037///
2038/// This function is defined on values with integer type, values with pointer
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002039/// type, and vectors of integers. In the case
Chris Lattner4bc28252009-09-08 00:06:16 +00002040/// where V is a vector, the mask, known zero, and known one values are the
2041/// same width as the vector element, and the bit is set only if it is true
2042/// for all of the elements in the vector.
Pete Cooper35b00d52016-08-13 01:05:32 +00002043bool MaskedValueIsZero(const Value *V, const APInt &Mask, unsigned Depth,
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002044 const Query &Q) {
Chris Lattner965c7692008-06-02 01:18:21 +00002045 APInt KnownZero(Mask.getBitWidth(), 0), KnownOne(Mask.getBitWidth(), 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002046 computeKnownBits(V, KnownZero, KnownOne, Depth, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002047 return (KnownZero & Mask) == Mask;
2048}
2049
Sanjay Patela06d9892016-06-22 19:20:59 +00002050/// For vector constants, loop over the elements and find the constant with the
2051/// minimum number of sign bits. Return 0 if the value is not a vector constant
2052/// or if any element was not analyzed; otherwise, return the count for the
2053/// element with the minimum number of sign bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00002054static unsigned computeNumSignBitsVectorConstant(const Value *V,
2055 unsigned TyBits) {
2056 const auto *CV = dyn_cast<Constant>(V);
Sanjay Patela06d9892016-06-22 19:20:59 +00002057 if (!CV || !CV->getType()->isVectorTy())
2058 return 0;
Chris Lattner965c7692008-06-02 01:18:21 +00002059
Sanjay Patela06d9892016-06-22 19:20:59 +00002060 unsigned MinSignBits = TyBits;
2061 unsigned NumElts = CV->getType()->getVectorNumElements();
2062 for (unsigned i = 0; i != NumElts; ++i) {
2063 // If we find a non-ConstantInt, bail out.
2064 auto *Elt = dyn_cast_or_null<ConstantInt>(CV->getAggregateElement(i));
2065 if (!Elt)
2066 return 0;
2067
2068 // If the sign bit is 1, flip the bits, so we always count leading zeros.
2069 APInt EltVal = Elt->getValue();
2070 if (EltVal.isNegative())
2071 EltVal = ~EltVal;
2072 MinSignBits = std::min(MinSignBits, EltVal.countLeadingZeros());
2073 }
2074
2075 return MinSignBits;
2076}
Chris Lattner965c7692008-06-02 01:18:21 +00002077
Sanjay Patelaee84212014-11-04 16:27:42 +00002078/// Return the number of times the sign bit of the register is replicated into
2079/// the other bits. We know that at least 1 bit is always equal to the sign bit
2080/// (itself), but other cases can give us information. For example, immediately
2081/// after an "ashr X, 2", we know that the top 3 bits are all equal to each
Sanjay Patela06d9892016-06-22 19:20:59 +00002082/// other, so we return 3. For vectors, return the number of sign bits for the
2083/// vector element with the mininum number of known sign bits.
Pete Cooper35b00d52016-08-13 01:05:32 +00002084unsigned ComputeNumSignBits(const Value *V, unsigned Depth, const Query &Q) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002085 unsigned TyBits = Q.DL.getTypeSizeInBits(V->getType()->getScalarType());
Chris Lattner965c7692008-06-02 01:18:21 +00002086 unsigned Tmp, Tmp2;
2087 unsigned FirstAnswer = 1;
2088
Jay Foada0653a32014-05-14 21:14:37 +00002089 // Note that ConstantInt is handled by the general computeKnownBits case
Chris Lattner2e01a692008-06-02 18:39:07 +00002090 // below.
2091
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002092 if (Depth == MaxDepth)
Chris Lattner965c7692008-06-02 01:18:21 +00002093 return 1; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00002094
Pete Cooper35b00d52016-08-13 01:05:32 +00002095 const Operator *U = dyn_cast<Operator>(V);
Dan Gohman80ca01c2009-07-17 20:47:02 +00002096 switch (Operator::getOpcode(V)) {
Chris Lattner965c7692008-06-02 01:18:21 +00002097 default: break;
2098 case Instruction::SExt:
Mon P Wangbb3eac92009-12-02 04:59:58 +00002099 Tmp = TyBits - U->getOperand(0)->getType()->getScalarSizeInBits();
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002100 return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q) + Tmp;
Craig Topper1bef2c82012-12-22 19:15:35 +00002101
Nadav Rotemc99a3872015-03-06 00:23:58 +00002102 case Instruction::SDiv: {
Nadav Rotem029c5c72015-03-03 21:39:02 +00002103 const APInt *Denominator;
2104 // sdiv X, C -> adds log(C) sign bits.
2105 if (match(U->getOperand(1), m_APInt(Denominator))) {
2106
2107 // Ignore non-positive denominator.
2108 if (!Denominator->isStrictlyPositive())
2109 break;
2110
2111 // Calculate the incoming numerator bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002112 unsigned NumBits = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Nadav Rotem029c5c72015-03-03 21:39:02 +00002113
2114 // Add floor(log(C)) bits to the numerator bits.
2115 return std::min(TyBits, NumBits + Denominator->logBase2());
2116 }
2117 break;
Nadav Rotemc99a3872015-03-06 00:23:58 +00002118 }
2119
2120 case Instruction::SRem: {
2121 const APInt *Denominator;
Sanjoy Dase561fee2015-03-25 22:33:53 +00002122 // srem X, C -> we know that the result is within [-C+1,C) when C is a
2123 // positive constant. This let us put a lower bound on the number of sign
2124 // bits.
Nadav Rotemc99a3872015-03-06 00:23:58 +00002125 if (match(U->getOperand(1), m_APInt(Denominator))) {
2126
2127 // Ignore non-positive denominator.
2128 if (!Denominator->isStrictlyPositive())
2129 break;
2130
2131 // Calculate the incoming numerator bits. SRem by a positive constant
2132 // can't lower the number of sign bits.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002133 unsigned NumrBits =
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002134 ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Nadav Rotemc99a3872015-03-06 00:23:58 +00002135
2136 // Calculate the leading sign bit constraints by examining the
Sanjoy Dase561fee2015-03-25 22:33:53 +00002137 // denominator. Given that the denominator is positive, there are two
2138 // cases:
2139 //
2140 // 1. the numerator is positive. The result range is [0,C) and [0,C) u<
2141 // (1 << ceilLogBase2(C)).
2142 //
2143 // 2. the numerator is negative. Then the result range is (-C,0] and
2144 // integers in (-C,0] are either 0 or >u (-1 << ceilLogBase2(C)).
2145 //
2146 // Thus a lower bound on the number of sign bits is `TyBits -
2147 // ceilLogBase2(C)`.
Nadav Rotemc99a3872015-03-06 00:23:58 +00002148
Sanjoy Dase561fee2015-03-25 22:33:53 +00002149 unsigned ResBits = TyBits - Denominator->ceilLogBase2();
Nadav Rotemc99a3872015-03-06 00:23:58 +00002150 return std::max(NumrBits, ResBits);
2151 }
2152 break;
2153 }
Nadav Rotem029c5c72015-03-03 21:39:02 +00002154
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002155 case Instruction::AShr: {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002156 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002157 // ashr X, C -> adds C sign bits. Vectors too.
2158 const APInt *ShAmt;
2159 if (match(U->getOperand(1), m_APInt(ShAmt))) {
2160 Tmp += ShAmt->getZExtValue();
Chris Lattner965c7692008-06-02 01:18:21 +00002161 if (Tmp > TyBits) Tmp = TyBits;
2162 }
2163 return Tmp;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002164 }
2165 case Instruction::Shl: {
2166 const APInt *ShAmt;
2167 if (match(U->getOperand(1), m_APInt(ShAmt))) {
Chris Lattner965c7692008-06-02 01:18:21 +00002168 // shl destroys sign bits.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002169 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002170 Tmp2 = ShAmt->getZExtValue();
2171 if (Tmp2 >= TyBits || // Bad shift.
2172 Tmp2 >= Tmp) break; // Shifted all sign bits out.
2173 return Tmp - Tmp2;
Chris Lattner965c7692008-06-02 01:18:21 +00002174 }
2175 break;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00002176 }
Chris Lattner965c7692008-06-02 01:18:21 +00002177 case Instruction::And:
2178 case Instruction::Or:
2179 case Instruction::Xor: // NOT is handled here.
2180 // Logical binary ops preserve the number of sign bits at the worst.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002181 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002182 if (Tmp != 1) {
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002183 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002184 FirstAnswer = std::min(Tmp, Tmp2);
2185 // We computed what we know about the sign bits as our first
2186 // answer. Now proceed to the generic code that uses
Jay Foada0653a32014-05-14 21:14:37 +00002187 // computeKnownBits, and pick whichever answer is better.
Chris Lattner965c7692008-06-02 01:18:21 +00002188 }
2189 break;
2190
2191 case Instruction::Select:
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002192 Tmp = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002193 if (Tmp == 1) return 1; // Early out.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002194 Tmp2 = ComputeNumSignBits(U->getOperand(2), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002195 return std::min(Tmp, Tmp2);
Craig Topper1bef2c82012-12-22 19:15:35 +00002196
Chris Lattner965c7692008-06-02 01:18:21 +00002197 case Instruction::Add:
2198 // Add can have at most one carry bit. Thus we know that the output
2199 // is, at worst, one more bit than the inputs.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002200 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002201 if (Tmp == 1) return 1; // Early out.
Craig Topper1bef2c82012-12-22 19:15:35 +00002202
Chris Lattner965c7692008-06-02 01:18:21 +00002203 // Special case decrementing a value (ADD X, -1):
David Majnemera55027f2014-12-26 09:20:17 +00002204 if (const auto *CRHS = dyn_cast<Constant>(U->getOperand(1)))
Chris Lattner965c7692008-06-02 01:18:21 +00002205 if (CRHS->isAllOnesValue()) {
2206 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002207 computeKnownBits(U->getOperand(0), KnownZero, KnownOne, Depth + 1, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00002208
Chris Lattner965c7692008-06-02 01:18:21 +00002209 // If the input is known to be 0 or 1, the output is 0/-1, which is all
2210 // sign bits set.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00002211 if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00002212 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00002213
Chris Lattner965c7692008-06-02 01:18:21 +00002214 // If we are subtracting one from a positive number, there is no carry
2215 // out of the result.
2216 if (KnownZero.isNegative())
2217 return Tmp;
2218 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002219
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002220 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002221 if (Tmp2 == 1) return 1;
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002222 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002223
Chris Lattner965c7692008-06-02 01:18:21 +00002224 case Instruction::Sub:
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002225 Tmp2 = ComputeNumSignBits(U->getOperand(1), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002226 if (Tmp2 == 1) return 1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002227
Chris Lattner965c7692008-06-02 01:18:21 +00002228 // Handle NEG.
David Majnemera55027f2014-12-26 09:20:17 +00002229 if (const auto *CLHS = dyn_cast<Constant>(U->getOperand(0)))
Chris Lattner965c7692008-06-02 01:18:21 +00002230 if (CLHS->isNullValue()) {
2231 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002232 computeKnownBits(U->getOperand(1), KnownZero, KnownOne, Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002233 // If the input is known to be 0 or 1, the output is 0/-1, which is all
2234 // sign bits set.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00002235 if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00002236 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00002237
Chris Lattner965c7692008-06-02 01:18:21 +00002238 // If the input is known to be positive (the sign bit is known clear),
2239 // the output of the NEG has the same number of sign bits as the input.
2240 if (KnownZero.isNegative())
2241 return Tmp2;
Craig Topper1bef2c82012-12-22 19:15:35 +00002242
Chris Lattner965c7692008-06-02 01:18:21 +00002243 // Otherwise, we treat this like a SUB.
2244 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002245
Chris Lattner965c7692008-06-02 01:18:21 +00002246 // Sub can have at most one carry bit. Thus we know that the output
2247 // is, at worst, one more bit than the inputs.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002248 Tmp = ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002249 if (Tmp == 1) return 1; // Early out.
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002250 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00002251
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002252 case Instruction::PHI: {
Pete Cooper35b00d52016-08-13 01:05:32 +00002253 const PHINode *PN = cast<PHINode>(U);
David Majnemer6ee8d172015-01-04 07:06:53 +00002254 unsigned NumIncomingValues = PN->getNumIncomingValues();
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002255 // Don't analyze large in-degree PHIs.
David Majnemer6ee8d172015-01-04 07:06:53 +00002256 if (NumIncomingValues > 4) break;
2257 // Unreachable blocks may have zero-operand PHI nodes.
2258 if (NumIncomingValues == 0) break;
Craig Topper1bef2c82012-12-22 19:15:35 +00002259
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002260 // Take the minimum of all incoming values. This can't infinitely loop
2261 // because of our depth threshold.
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002262 Tmp = ComputeNumSignBits(PN->getIncomingValue(0), Depth + 1, Q);
David Majnemer6ee8d172015-01-04 07:06:53 +00002263 for (unsigned i = 1, e = NumIncomingValues; i != e; ++i) {
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002264 if (Tmp == 1) return Tmp;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002265 Tmp = std::min(
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002266 Tmp, ComputeNumSignBits(PN->getIncomingValue(i), Depth + 1, Q));
Chris Lattner35d3b9d2010-01-07 23:44:37 +00002267 }
2268 return Tmp;
2269 }
2270
Chris Lattner965c7692008-06-02 01:18:21 +00002271 case Instruction::Trunc:
2272 // FIXME: it's tricky to do anything useful for this, but it is an important
2273 // case for targets like X86.
2274 break;
Bjorn Pettersson39616032016-10-06 09:56:21 +00002275
2276 case Instruction::ExtractElement:
2277 // Look through extract element. At the moment we keep this simple and skip
2278 // tracking the specific element. But at least we might find information
2279 // valid for all elements of the vector (for example if vector is sign
2280 // extended, shifted, etc).
2281 return ComputeNumSignBits(U->getOperand(0), Depth + 1, Q);
Chris Lattner965c7692008-06-02 01:18:21 +00002282 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002283
Chris Lattner965c7692008-06-02 01:18:21 +00002284 // Finally, if we can prove that the top bits of the result are 0's or 1's,
2285 // use this information.
Sanjay Patela06d9892016-06-22 19:20:59 +00002286
2287 // If we can examine all elements of a vector constant successfully, we're
2288 // done (we can't do any better than that). If not, keep trying.
2289 if (unsigned VecSignBits = computeNumSignBitsVectorConstant(V, TyBits))
2290 return VecSignBits;
2291
Chris Lattner965c7692008-06-02 01:18:21 +00002292 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Matthias Braunfeb81bc2016-01-15 22:22:04 +00002293 computeKnownBits(V, KnownZero, KnownOne, Depth, Q);
Craig Topper1bef2c82012-12-22 19:15:35 +00002294
Sanjay Patele0536212016-06-23 17:41:59 +00002295 // If we know that the sign bit is either zero or one, determine the number of
2296 // identical bits in the top of the input value.
2297 if (KnownZero.isNegative())
2298 return std::max(FirstAnswer, KnownZero.countLeadingOnes());
Craig Topper1bef2c82012-12-22 19:15:35 +00002299
Sanjay Patele0536212016-06-23 17:41:59 +00002300 if (KnownOne.isNegative())
2301 return std::max(FirstAnswer, KnownOne.countLeadingOnes());
2302
2303 // computeKnownBits gave us no extra information about the top bits.
2304 return FirstAnswer;
Chris Lattner965c7692008-06-02 01:18:21 +00002305}
Chris Lattnera12a6de2008-06-02 01:29:46 +00002306
Sanjay Patelaee84212014-11-04 16:27:42 +00002307/// This function computes the integer multiple of Base that equals V.
2308/// If successful, it returns true and returns the multiple in
2309/// Multiple. If unsuccessful, it returns false. It looks
Victor Hernandez47444882009-11-10 08:28:35 +00002310/// through SExt instructions only if LookThroughSExt is true.
2311bool llvm::ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
Dan Gohman6a976bb2009-11-18 00:58:27 +00002312 bool LookThroughSExt, unsigned Depth) {
Victor Hernandez47444882009-11-10 08:28:35 +00002313 const unsigned MaxDepth = 6;
2314
Dan Gohman6a976bb2009-11-18 00:58:27 +00002315 assert(V && "No Value?");
Victor Hernandez47444882009-11-10 08:28:35 +00002316 assert(Depth <= MaxDepth && "Limit Search Depth");
Duncan Sands9dff9be2010-02-15 16:12:20 +00002317 assert(V->getType()->isIntegerTy() && "Not integer or pointer type!");
Victor Hernandez47444882009-11-10 08:28:35 +00002318
Chris Lattner229907c2011-07-18 04:54:35 +00002319 Type *T = V->getType();
Victor Hernandez47444882009-11-10 08:28:35 +00002320
Dan Gohman6a976bb2009-11-18 00:58:27 +00002321 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Victor Hernandez47444882009-11-10 08:28:35 +00002322
2323 if (Base == 0)
2324 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00002325
Victor Hernandez47444882009-11-10 08:28:35 +00002326 if (Base == 1) {
2327 Multiple = V;
2328 return true;
2329 }
2330
2331 ConstantExpr *CO = dyn_cast<ConstantExpr>(V);
2332 Constant *BaseVal = ConstantInt::get(T, Base);
2333 if (CO && CO == BaseVal) {
2334 // Multiple is 1.
2335 Multiple = ConstantInt::get(T, 1);
2336 return true;
2337 }
2338
2339 if (CI && CI->getZExtValue() % Base == 0) {
2340 Multiple = ConstantInt::get(T, CI->getZExtValue() / Base);
Craig Topper1bef2c82012-12-22 19:15:35 +00002341 return true;
Victor Hernandez47444882009-11-10 08:28:35 +00002342 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002343
Victor Hernandez47444882009-11-10 08:28:35 +00002344 if (Depth == MaxDepth) return false; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00002345
Victor Hernandez47444882009-11-10 08:28:35 +00002346 Operator *I = dyn_cast<Operator>(V);
2347 if (!I) return false;
2348
2349 switch (I->getOpcode()) {
2350 default: break;
Chris Lattner4f0b47d2009-11-26 01:50:12 +00002351 case Instruction::SExt:
Victor Hernandez47444882009-11-10 08:28:35 +00002352 if (!LookThroughSExt) return false;
2353 // otherwise fall through to ZExt
Chris Lattner4f0b47d2009-11-26 01:50:12 +00002354 case Instruction::ZExt:
Dan Gohman6a976bb2009-11-18 00:58:27 +00002355 return ComputeMultiple(I->getOperand(0), Base, Multiple,
2356 LookThroughSExt, Depth+1);
Victor Hernandez47444882009-11-10 08:28:35 +00002357 case Instruction::Shl:
2358 case Instruction::Mul: {
2359 Value *Op0 = I->getOperand(0);
2360 Value *Op1 = I->getOperand(1);
2361
2362 if (I->getOpcode() == Instruction::Shl) {
2363 ConstantInt *Op1CI = dyn_cast<ConstantInt>(Op1);
2364 if (!Op1CI) return false;
2365 // Turn Op0 << Op1 into Op0 * 2^Op1
2366 APInt Op1Int = Op1CI->getValue();
2367 uint64_t BitToSet = Op1Int.getLimitedValue(Op1Int.getBitWidth() - 1);
Jay Foad15084f02010-11-30 09:02:01 +00002368 APInt API(Op1Int.getBitWidth(), 0);
Jay Foad25a5e4c2010-12-01 08:53:58 +00002369 API.setBit(BitToSet);
Jay Foad15084f02010-11-30 09:02:01 +00002370 Op1 = ConstantInt::get(V->getContext(), API);
Victor Hernandez47444882009-11-10 08:28:35 +00002371 }
2372
Craig Topper9f008862014-04-15 04:59:12 +00002373 Value *Mul0 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00002374 if (ComputeMultiple(Op0, Base, Mul0, LookThroughSExt, Depth+1)) {
2375 if (Constant *Op1C = dyn_cast<Constant>(Op1))
2376 if (Constant *MulC = dyn_cast<Constant>(Mul0)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00002377 if (Op1C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00002378 MulC->getType()->getPrimitiveSizeInBits())
2379 Op1C = ConstantExpr::getZExt(Op1C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002380 if (Op1C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00002381 MulC->getType()->getPrimitiveSizeInBits())
2382 MulC = ConstantExpr::getZExt(MulC, Op1C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002383
Chris Lattner72d283c2010-09-05 17:20:46 +00002384 // V == Base * (Mul0 * Op1), so return (Mul0 * Op1)
2385 Multiple = ConstantExpr::getMul(MulC, Op1C);
2386 return true;
2387 }
Victor Hernandez47444882009-11-10 08:28:35 +00002388
2389 if (ConstantInt *Mul0CI = dyn_cast<ConstantInt>(Mul0))
2390 if (Mul0CI->getValue() == 1) {
2391 // V == Base * Op1, so return Op1
2392 Multiple = Op1;
2393 return true;
2394 }
2395 }
2396
Craig Topper9f008862014-04-15 04:59:12 +00002397 Value *Mul1 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00002398 if (ComputeMultiple(Op1, Base, Mul1, LookThroughSExt, Depth+1)) {
2399 if (Constant *Op0C = dyn_cast<Constant>(Op0))
2400 if (Constant *MulC = dyn_cast<Constant>(Mul1)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00002401 if (Op0C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00002402 MulC->getType()->getPrimitiveSizeInBits())
2403 Op0C = ConstantExpr::getZExt(Op0C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002404 if (Op0C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00002405 MulC->getType()->getPrimitiveSizeInBits())
2406 MulC = ConstantExpr::getZExt(MulC, Op0C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00002407
Chris Lattner72d283c2010-09-05 17:20:46 +00002408 // V == Base * (Mul1 * Op0), so return (Mul1 * Op0)
2409 Multiple = ConstantExpr::getMul(MulC, Op0C);
2410 return true;
2411 }
Victor Hernandez47444882009-11-10 08:28:35 +00002412
2413 if (ConstantInt *Mul1CI = dyn_cast<ConstantInt>(Mul1))
2414 if (Mul1CI->getValue() == 1) {
2415 // V == Base * Op0, so return Op0
2416 Multiple = Op0;
2417 return true;
2418 }
2419 }
Victor Hernandez47444882009-11-10 08:28:35 +00002420 }
2421 }
2422
2423 // We could not determine if V is a multiple of Base.
2424 return false;
2425}
2426
David Majnemerb4b27232016-04-19 19:10:21 +00002427Intrinsic::ID llvm::getIntrinsicForCallSite(ImmutableCallSite ICS,
2428 const TargetLibraryInfo *TLI) {
2429 const Function *F = ICS.getCalledFunction();
2430 if (!F)
2431 return Intrinsic::not_intrinsic;
2432
2433 if (F->isIntrinsic())
2434 return F->getIntrinsicID();
2435
2436 if (!TLI)
2437 return Intrinsic::not_intrinsic;
2438
2439 LibFunc::Func Func;
2440 // We're going to make assumptions on the semantics of the functions, check
2441 // that the target knows that it's available in this environment and it does
2442 // not have local linkage.
Ahmed Bougachad765a822016-04-27 19:04:35 +00002443 if (!F || F->hasLocalLinkage() || !TLI->getLibFunc(*F, Func))
2444 return Intrinsic::not_intrinsic;
2445
2446 if (!ICS.onlyReadsMemory())
David Majnemerb4b27232016-04-19 19:10:21 +00002447 return Intrinsic::not_intrinsic;
2448
2449 // Otherwise check if we have a call to a function that can be turned into a
2450 // vector intrinsic.
2451 switch (Func) {
2452 default:
2453 break;
2454 case LibFunc::sin:
2455 case LibFunc::sinf:
2456 case LibFunc::sinl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002457 return Intrinsic::sin;
David Majnemerb4b27232016-04-19 19:10:21 +00002458 case LibFunc::cos:
2459 case LibFunc::cosf:
2460 case LibFunc::cosl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002461 return Intrinsic::cos;
David Majnemerb4b27232016-04-19 19:10:21 +00002462 case LibFunc::exp:
2463 case LibFunc::expf:
2464 case LibFunc::expl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002465 return Intrinsic::exp;
David Majnemerb4b27232016-04-19 19:10:21 +00002466 case LibFunc::exp2:
2467 case LibFunc::exp2f:
2468 case LibFunc::exp2l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002469 return Intrinsic::exp2;
David Majnemerb4b27232016-04-19 19:10:21 +00002470 case LibFunc::log:
2471 case LibFunc::logf:
2472 case LibFunc::logl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002473 return Intrinsic::log;
David Majnemerb4b27232016-04-19 19:10:21 +00002474 case LibFunc::log10:
2475 case LibFunc::log10f:
2476 case LibFunc::log10l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002477 return Intrinsic::log10;
David Majnemerb4b27232016-04-19 19:10:21 +00002478 case LibFunc::log2:
2479 case LibFunc::log2f:
2480 case LibFunc::log2l:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002481 return Intrinsic::log2;
David Majnemerb4b27232016-04-19 19:10:21 +00002482 case LibFunc::fabs:
2483 case LibFunc::fabsf:
2484 case LibFunc::fabsl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002485 return Intrinsic::fabs;
David Majnemerb4b27232016-04-19 19:10:21 +00002486 case LibFunc::fmin:
2487 case LibFunc::fminf:
2488 case LibFunc::fminl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002489 return Intrinsic::minnum;
David Majnemerb4b27232016-04-19 19:10:21 +00002490 case LibFunc::fmax:
2491 case LibFunc::fmaxf:
2492 case LibFunc::fmaxl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002493 return Intrinsic::maxnum;
David Majnemerb4b27232016-04-19 19:10:21 +00002494 case LibFunc::copysign:
2495 case LibFunc::copysignf:
2496 case LibFunc::copysignl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002497 return Intrinsic::copysign;
David Majnemerb4b27232016-04-19 19:10:21 +00002498 case LibFunc::floor:
2499 case LibFunc::floorf:
2500 case LibFunc::floorl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002501 return Intrinsic::floor;
David Majnemerb4b27232016-04-19 19:10:21 +00002502 case LibFunc::ceil:
2503 case LibFunc::ceilf:
2504 case LibFunc::ceill:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002505 return Intrinsic::ceil;
David Majnemerb4b27232016-04-19 19:10:21 +00002506 case LibFunc::trunc:
2507 case LibFunc::truncf:
2508 case LibFunc::truncl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002509 return Intrinsic::trunc;
David Majnemerb4b27232016-04-19 19:10:21 +00002510 case LibFunc::rint:
2511 case LibFunc::rintf:
2512 case LibFunc::rintl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002513 return Intrinsic::rint;
David Majnemerb4b27232016-04-19 19:10:21 +00002514 case LibFunc::nearbyint:
2515 case LibFunc::nearbyintf:
2516 case LibFunc::nearbyintl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002517 return Intrinsic::nearbyint;
David Majnemerb4b27232016-04-19 19:10:21 +00002518 case LibFunc::round:
2519 case LibFunc::roundf:
2520 case LibFunc::roundl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002521 return Intrinsic::round;
David Majnemerb4b27232016-04-19 19:10:21 +00002522 case LibFunc::pow:
2523 case LibFunc::powf:
2524 case LibFunc::powl:
Ahmed Bougachad765a822016-04-27 19:04:35 +00002525 return Intrinsic::pow;
David Majnemerb4b27232016-04-19 19:10:21 +00002526 case LibFunc::sqrt:
2527 case LibFunc::sqrtf:
2528 case LibFunc::sqrtl:
2529 if (ICS->hasNoNaNs())
Ahmed Bougachad765a822016-04-27 19:04:35 +00002530 return Intrinsic::sqrt;
David Majnemerb4b27232016-04-19 19:10:21 +00002531 return Intrinsic::not_intrinsic;
2532 }
2533
2534 return Intrinsic::not_intrinsic;
2535}
2536
Sanjay Patelaee84212014-11-04 16:27:42 +00002537/// Return true if we can prove that the specified FP value is never equal to
2538/// -0.0.
Chris Lattnera12a6de2008-06-02 01:29:46 +00002539///
2540/// NOTE: this function will need to be revisited when we support non-default
2541/// rounding modes!
2542///
David Majnemer3ee5f342016-04-13 06:55:52 +00002543bool llvm::CannotBeNegativeZero(const Value *V, const TargetLibraryInfo *TLI,
2544 unsigned Depth) {
Chris Lattnera12a6de2008-06-02 01:29:46 +00002545 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V))
2546 return !CFP->getValueAPF().isNegZero();
Craig Topper1bef2c82012-12-22 19:15:35 +00002547
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002548 if (Depth == MaxDepth)
Sanjay Patel40eaa8d2015-02-25 18:00:15 +00002549 return false; // Limit search depth.
Chris Lattnera12a6de2008-06-02 01:29:46 +00002550
Dan Gohman80ca01c2009-07-17 20:47:02 +00002551 const Operator *I = dyn_cast<Operator>(V);
Craig Topper9f008862014-04-15 04:59:12 +00002552 if (!I) return false;
Michael Ilseman0f128372012-12-06 00:07:09 +00002553
2554 // Check if the nsz fast-math flag is set
2555 if (const FPMathOperator *FPO = dyn_cast<FPMathOperator>(I))
2556 if (FPO->hasNoSignedZeros())
2557 return true;
2558
Chris Lattnera12a6de2008-06-02 01:29:46 +00002559 // (add x, 0.0) is guaranteed to return +0.0, not -0.0.
Jakub Staszakb7129f22013-03-06 00:16:16 +00002560 if (I->getOpcode() == Instruction::FAdd)
2561 if (ConstantFP *CFP = dyn_cast<ConstantFP>(I->getOperand(1)))
2562 if (CFP->isNullValue())
2563 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00002564
Chris Lattnera12a6de2008-06-02 01:29:46 +00002565 // sitofp and uitofp turn into +0.0 for zero.
2566 if (isa<SIToFPInst>(I) || isa<UIToFPInst>(I))
2567 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00002568
David Majnemer3ee5f342016-04-13 06:55:52 +00002569 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
David Majnemerb4b27232016-04-19 19:10:21 +00002570 Intrinsic::ID IID = getIntrinsicForCallSite(CI, TLI);
David Majnemer3ee5f342016-04-13 06:55:52 +00002571 switch (IID) {
2572 default:
2573 break;
Chris Lattnera12a6de2008-06-02 01:29:46 +00002574 // sqrt(-0.0) = -0.0, no other negative results are possible.
David Majnemer3ee5f342016-04-13 06:55:52 +00002575 case Intrinsic::sqrt:
2576 return CannotBeNegativeZero(CI->getArgOperand(0), TLI, Depth + 1);
2577 // fabs(x) != -0.0
2578 case Intrinsic::fabs:
2579 return true;
Chris Lattnera12a6de2008-06-02 01:29:46 +00002580 }
David Majnemer3ee5f342016-04-13 06:55:52 +00002581 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002582
Chris Lattnera12a6de2008-06-02 01:29:46 +00002583 return false;
2584}
2585
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002586/// If \p SignBitOnly is true, test for a known 0 sign bit rather than a
2587/// standard ordered compare. e.g. make -0.0 olt 0.0 be true because of the sign
2588/// bit despite comparing equal.
2589static bool cannotBeOrderedLessThanZeroImpl(const Value *V,
2590 const TargetLibraryInfo *TLI,
2591 bool SignBitOnly,
2592 unsigned Depth) {
2593 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2594 return !CFP->getValueAPF().isNegative() ||
2595 (!SignBitOnly && CFP->getValueAPF().isZero());
2596 }
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002597
Matt Arsenaultcb2a7eb2016-12-20 19:06:15 +00002598 if (Depth == MaxDepth)
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002599 return false; // Limit search depth.
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002600
2601 const Operator *I = dyn_cast<Operator>(V);
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002602 if (!I)
2603 return false;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002604
2605 switch (I->getOpcode()) {
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002606 default:
2607 break;
Fiona Glaserdb7824f2016-01-12 23:37:30 +00002608 // Unsigned integers are always nonnegative.
2609 case Instruction::UIToFP:
2610 return true;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002611 case Instruction::FMul:
2612 // x*x is always non-negative or a NaN.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002613 if (I->getOperand(0) == I->getOperand(1) &&
2614 (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()))
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002615 return true;
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002616
Justin Bognercd1d5aa2016-08-17 20:30:52 +00002617 LLVM_FALLTHROUGH;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002618 case Instruction::FAdd:
2619 case Instruction::FDiv:
2620 case Instruction::FRem:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002621 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2622 Depth + 1) &&
2623 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2624 Depth + 1);
Fiona Glaserdb7824f2016-01-12 23:37:30 +00002625 case Instruction::Select:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002626 return cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2627 Depth + 1) &&
2628 cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
2629 Depth + 1);
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002630 case Instruction::FPExt:
2631 case Instruction::FPTrunc:
2632 // Widening/narrowing never change sign.
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002633 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2634 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002635 case Instruction::Call:
David Majnemerb4b27232016-04-19 19:10:21 +00002636 Intrinsic::ID IID = getIntrinsicForCallSite(cast<CallInst>(I), TLI);
David Majnemer3ee5f342016-04-13 06:55:52 +00002637 switch (IID) {
2638 default:
2639 break;
2640 case Intrinsic::maxnum:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002641 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2642 Depth + 1) ||
2643 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2644 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002645 case Intrinsic::minnum:
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002646 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2647 Depth + 1) &&
2648 cannotBeOrderedLessThanZeroImpl(I->getOperand(1), TLI, SignBitOnly,
2649 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002650 case Intrinsic::exp:
2651 case Intrinsic::exp2:
2652 case Intrinsic::fabs:
2653 case Intrinsic::sqrt:
2654 return true;
2655 case Intrinsic::powi:
2656 if (ConstantInt *CI = dyn_cast<ConstantInt>(I->getOperand(1))) {
2657 // powi(x,n) is non-negative if n is even.
2658 if (CI->getBitWidth() <= 64 && CI->getSExtValue() % 2u == 0)
2659 return true;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002660 }
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002661 return cannotBeOrderedLessThanZeroImpl(I->getOperand(0), TLI, SignBitOnly,
2662 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002663 case Intrinsic::fma:
2664 case Intrinsic::fmuladd:
2665 // x*x+y is non-negative if y is non-negative.
2666 return I->getOperand(0) == I->getOperand(1) &&
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002667 (!SignBitOnly || cast<FPMathOperator>(I)->hasNoNaNs()) &&
2668 cannotBeOrderedLessThanZeroImpl(I->getOperand(2), TLI, SignBitOnly,
2669 Depth + 1);
David Majnemer3ee5f342016-04-13 06:55:52 +00002670 }
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002671 break;
2672 }
Sanjoy Das6082c1a2016-05-07 02:08:15 +00002673 return false;
Elena Demikhovsky45f04482015-01-28 08:03:58 +00002674}
2675
Matt Arsenault1e0edbf2017-01-11 00:33:24 +00002676bool llvm::CannotBeOrderedLessThanZero(const Value *V,
2677 const TargetLibraryInfo *TLI) {
2678 return cannotBeOrderedLessThanZeroImpl(V, TLI, false, 0);
2679}
2680
2681bool llvm::SignBitMustBeZero(const Value *V, const TargetLibraryInfo *TLI) {
2682 return cannotBeOrderedLessThanZeroImpl(V, TLI, true, 0);
2683}
2684
Sanjay Patelaee84212014-11-04 16:27:42 +00002685/// If the specified value can be set by repeating the same byte in memory,
2686/// return the i8 value that it is represented with. This is
Chris Lattner9cb10352010-12-26 20:15:01 +00002687/// true for all i8 values obviously, but is also true for i32 0, i32 -1,
2688/// i16 0xF0F0, double 0.0 etc. If the value can't be handled with a repeated
2689/// byte store (e.g. i16 0x1234), return null.
2690Value *llvm::isBytewiseValue(Value *V) {
2691 // All byte-wide stores are splatable, even of arbitrary variables.
2692 if (V->getType()->isIntegerTy(8)) return V;
Chris Lattneracf6b072011-02-19 19:35:49 +00002693
2694 // Handle 'null' ConstantArrayZero etc.
2695 if (Constant *C = dyn_cast<Constant>(V))
2696 if (C->isNullValue())
2697 return Constant::getNullValue(Type::getInt8Ty(V->getContext()));
Craig Topper1bef2c82012-12-22 19:15:35 +00002698
Chris Lattner9cb10352010-12-26 20:15:01 +00002699 // Constant float and double values can be handled as integer values if the
Craig Topper1bef2c82012-12-22 19:15:35 +00002700 // corresponding integer value is "byteable". An important case is 0.0.
Chris Lattner9cb10352010-12-26 20:15:01 +00002701 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
2702 if (CFP->getType()->isFloatTy())
2703 V = ConstantExpr::getBitCast(CFP, Type::getInt32Ty(V->getContext()));
2704 if (CFP->getType()->isDoubleTy())
2705 V = ConstantExpr::getBitCast(CFP, Type::getInt64Ty(V->getContext()));
2706 // Don't handle long double formats, which have strange constraints.
2707 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002708
Benjamin Kramer17d90152015-02-07 19:29:02 +00002709 // We can handle constant integers that are multiple of 8 bits.
Chris Lattner9cb10352010-12-26 20:15:01 +00002710 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Benjamin Kramer17d90152015-02-07 19:29:02 +00002711 if (CI->getBitWidth() % 8 == 0) {
2712 assert(CI->getBitWidth() > 8 && "8 bits should be handled above!");
Craig Topper1bef2c82012-12-22 19:15:35 +00002713
Benjamin Kramerb4b51502015-03-25 16:49:59 +00002714 if (!CI->getValue().isSplat(8))
Benjamin Kramer17d90152015-02-07 19:29:02 +00002715 return nullptr;
2716 return ConstantInt::get(V->getContext(), CI->getValue().trunc(8));
Chris Lattner9cb10352010-12-26 20:15:01 +00002717 }
2718 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002719
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002720 // A ConstantDataArray/Vector is splatable if all its members are equal and
2721 // also splatable.
2722 if (ConstantDataSequential *CA = dyn_cast<ConstantDataSequential>(V)) {
2723 Value *Elt = CA->getElementAsConstant(0);
2724 Value *Val = isBytewiseValue(Elt);
Chris Lattner9cb10352010-12-26 20:15:01 +00002725 if (!Val)
Craig Topper9f008862014-04-15 04:59:12 +00002726 return nullptr;
Craig Topper1bef2c82012-12-22 19:15:35 +00002727
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002728 for (unsigned I = 1, E = CA->getNumElements(); I != E; ++I)
2729 if (CA->getElementAsConstant(I) != Elt)
Craig Topper9f008862014-04-15 04:59:12 +00002730 return nullptr;
Craig Topper1bef2c82012-12-22 19:15:35 +00002731
Chris Lattner9cb10352010-12-26 20:15:01 +00002732 return Val;
2733 }
Chad Rosier8abf65a2011-12-06 00:19:08 +00002734
Chris Lattner9cb10352010-12-26 20:15:01 +00002735 // Conceptually, we could handle things like:
2736 // %a = zext i8 %X to i16
2737 // %b = shl i16 %a, 8
2738 // %c = or i16 %a, %b
2739 // but until there is an example that actually needs this, it doesn't seem
2740 // worth worrying about.
Craig Topper9f008862014-04-15 04:59:12 +00002741 return nullptr;
Chris Lattner9cb10352010-12-26 20:15:01 +00002742}
2743
2744
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002745// This is the recursive version of BuildSubAggregate. It takes a few different
2746// arguments. Idxs is the index within the nested struct From that we are
2747// looking at now (which is of type IndexedType). IdxSkip is the number of
2748// indices from Idxs that should be left out when inserting into the resulting
2749// struct. To is the result struct built so far, new insertvalue instructions
2750// build on that.
Chris Lattner229907c2011-07-18 04:54:35 +00002751static Value *BuildSubAggregate(Value *From, Value* To, Type *IndexedType,
Craig Topper2cd5ff82013-07-11 16:22:38 +00002752 SmallVectorImpl<unsigned> &Idxs,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00002753 unsigned IdxSkip,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00002754 Instruction *InsertBefore) {
Dmitri Gribenko226fea52013-01-13 16:01:15 +00002755 llvm::StructType *STy = dyn_cast<llvm::StructType>(IndexedType);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002756 if (STy) {
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002757 // Save the original To argument so we can modify it
2758 Value *OrigTo = To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002759 // General case, the type indexed by Idxs is a struct
2760 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2761 // Process each struct element recursively
2762 Idxs.push_back(i);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002763 Value *PrevTo = To;
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002764 To = BuildSubAggregate(From, To, STy->getElementType(i), Idxs, IdxSkip,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002765 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002766 Idxs.pop_back();
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002767 if (!To) {
2768 // Couldn't find any inserted value for this index? Cleanup
2769 while (PrevTo != OrigTo) {
2770 InsertValueInst* Del = cast<InsertValueInst>(PrevTo);
2771 PrevTo = Del->getAggregateOperand();
2772 Del->eraseFromParent();
2773 }
2774 // Stop processing elements
2775 break;
2776 }
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002777 }
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00002778 // If we successfully found a value for each of our subaggregates
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002779 if (To)
2780 return To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002781 }
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002782 // Base case, the type indexed by SourceIdxs is not a struct, or not all of
2783 // the struct's elements had a value that was inserted directly. In the latter
2784 // case, perhaps we can't determine each of the subelements individually, but
2785 // we might be able to find the complete struct somewhere.
Craig Topper1bef2c82012-12-22 19:15:35 +00002786
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002787 // Find the value that is at that particular spot
Jay Foad57aa6362011-07-13 10:26:04 +00002788 Value *V = FindInsertedValue(From, Idxs);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002789
2790 if (!V)
Craig Topper9f008862014-04-15 04:59:12 +00002791 return nullptr;
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002792
2793 // Insert the value in the new (sub) aggregrate
Frits van Bommel717d7ed2011-07-18 12:00:32 +00002794 return llvm::InsertValueInst::Create(To, V, makeArrayRef(Idxs).slice(IdxSkip),
Jay Foad57aa6362011-07-13 10:26:04 +00002795 "tmp", InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002796}
2797
2798// This helper takes a nested struct and extracts a part of it (which is again a
2799// struct) into a new value. For example, given the struct:
2800// { a, { b, { c, d }, e } }
2801// and the indices "1, 1" this returns
2802// { c, d }.
2803//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002804// It does this by inserting an insertvalue for each element in the resulting
2805// struct, as opposed to just inserting a single struct. This will only work if
2806// each of the elements of the substruct are known (ie, inserted into From by an
2807// insertvalue instruction somewhere).
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002808//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002809// All inserted insertvalue instructions are inserted before InsertBefore
Jay Foad57aa6362011-07-13 10:26:04 +00002810static Value *BuildSubAggregate(Value *From, ArrayRef<unsigned> idx_range,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00002811 Instruction *InsertBefore) {
Matthijs Kooijman69801d42008-06-16 13:28:31 +00002812 assert(InsertBefore && "Must have someplace to insert!");
Chris Lattner229907c2011-07-18 04:54:35 +00002813 Type *IndexedType = ExtractValueInst::getIndexedType(From->getType(),
Jay Foad57aa6362011-07-13 10:26:04 +00002814 idx_range);
Owen Andersonb292b8c2009-07-30 23:03:37 +00002815 Value *To = UndefValue::get(IndexedType);
Jay Foad57aa6362011-07-13 10:26:04 +00002816 SmallVector<unsigned, 10> Idxs(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002817 unsigned IdxSkip = Idxs.size();
2818
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002819 return BuildSubAggregate(From, To, IndexedType, Idxs, IdxSkip, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002820}
2821
Sanjay Patelaee84212014-11-04 16:27:42 +00002822/// Given an aggregrate and an sequence of indices, see if
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002823/// the scalar value indexed is already around as a register, for example if it
2824/// were inserted directly into the aggregrate.
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00002825///
2826/// If InsertBefore is not null, this function will duplicate (modified)
2827/// insertvalues when a part of a nested struct is extracted.
Jay Foad57aa6362011-07-13 10:26:04 +00002828Value *llvm::FindInsertedValue(Value *V, ArrayRef<unsigned> idx_range,
2829 Instruction *InsertBefore) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002830 // Nothing to index? Just return V then (this is useful at the end of our
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002831 // recursion).
Jay Foad57aa6362011-07-13 10:26:04 +00002832 if (idx_range.empty())
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002833 return V;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002834 // We have indices, so V should have an indexable type.
2835 assert((V->getType()->isStructTy() || V->getType()->isArrayTy()) &&
2836 "Not looking at a struct or array?");
2837 assert(ExtractValueInst::getIndexedType(V->getType(), idx_range) &&
2838 "Invalid indices for type?");
Owen Andersonf1f17432009-07-06 22:37:39 +00002839
Chris Lattner67058832012-01-25 06:48:06 +00002840 if (Constant *C = dyn_cast<Constant>(V)) {
2841 C = C->getAggregateElement(idx_range[0]);
Craig Topper9f008862014-04-15 04:59:12 +00002842 if (!C) return nullptr;
Chris Lattner67058832012-01-25 06:48:06 +00002843 return FindInsertedValue(C, idx_range.slice(1), InsertBefore);
2844 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002845
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002846 if (InsertValueInst *I = dyn_cast<InsertValueInst>(V)) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002847 // Loop the indices for the insertvalue instruction in parallel with the
2848 // requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00002849 const unsigned *req_idx = idx_range.begin();
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002850 for (const unsigned *i = I->idx_begin(), *e = I->idx_end();
2851 i != e; ++i, ++req_idx) {
Jay Foad57aa6362011-07-13 10:26:04 +00002852 if (req_idx == idx_range.end()) {
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002853 // We can't handle this without inserting insertvalues
2854 if (!InsertBefore)
Craig Topper9f008862014-04-15 04:59:12 +00002855 return nullptr;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002856
2857 // The requested index identifies a part of a nested aggregate. Handle
2858 // this specially. For example,
2859 // %A = insertvalue { i32, {i32, i32 } } undef, i32 10, 1, 0
2860 // %B = insertvalue { i32, {i32, i32 } } %A, i32 11, 1, 1
2861 // %C = extractvalue {i32, { i32, i32 } } %B, 1
2862 // This can be changed into
2863 // %A = insertvalue {i32, i32 } undef, i32 10, 0
2864 // %C = insertvalue {i32, i32 } %A, i32 11, 1
2865 // which allows the unused 0,0 element from the nested struct to be
2866 // removed.
2867 return BuildSubAggregate(V, makeArrayRef(idx_range.begin(), req_idx),
2868 InsertBefore);
Duncan Sandsdb356ee2008-06-19 08:47:31 +00002869 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002870
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002871 // This insert value inserts something else than what we are looking for.
Benjamin Kramerdf005cb2015-08-08 18:27:36 +00002872 // See if the (aggregate) value inserted into has the value we are
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002873 // looking for, then.
2874 if (*req_idx != *i)
Jay Foad57aa6362011-07-13 10:26:04 +00002875 return FindInsertedValue(I->getAggregateOperand(), idx_range,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002876 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002877 }
2878 // If we end up here, the indices of the insertvalue match with those
2879 // requested (though possibly only partially). Now we recursively look at
2880 // the inserted value, passing any remaining indices.
Jay Foad57aa6362011-07-13 10:26:04 +00002881 return FindInsertedValue(I->getInsertedValueOperand(),
Frits van Bommel717d7ed2011-07-18 12:00:32 +00002882 makeArrayRef(req_idx, idx_range.end()),
Nick Lewycky39dbfd32009-11-23 03:29:18 +00002883 InsertBefore);
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002884 }
Craig Topper1bef2c82012-12-22 19:15:35 +00002885
Chris Lattnerf7eb5432012-01-24 07:54:10 +00002886 if (ExtractValueInst *I = dyn_cast<ExtractValueInst>(V)) {
Benjamin Kramerdf005cb2015-08-08 18:27:36 +00002887 // If we're extracting a value from an aggregate that was extracted from
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002888 // something else, we can extract from that something else directly instead.
2889 // However, we will need to chain I's indices with the requested indices.
Craig Topper1bef2c82012-12-22 19:15:35 +00002890
2891 // Calculate the number of indices required
Jay Foad57aa6362011-07-13 10:26:04 +00002892 unsigned size = I->getNumIndices() + idx_range.size();
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002893 // Allocate some space to put the new indices in
Matthijs Kooijman8369c672008-06-17 08:24:37 +00002894 SmallVector<unsigned, 5> Idxs;
2895 Idxs.reserve(size);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002896 // Add indices from the extract value instruction
Jay Foad57aa6362011-07-13 10:26:04 +00002897 Idxs.append(I->idx_begin(), I->idx_end());
Craig Topper1bef2c82012-12-22 19:15:35 +00002898
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002899 // Add requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00002900 Idxs.append(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002901
Craig Topper1bef2c82012-12-22 19:15:35 +00002902 assert(Idxs.size() == size
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00002903 && "Number of indices added not correct?");
Craig Topper1bef2c82012-12-22 19:15:35 +00002904
Jay Foad57aa6362011-07-13 10:26:04 +00002905 return FindInsertedValue(I->getAggregateOperand(), Idxs, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002906 }
2907 // Otherwise, we don't know (such as, extracting from a function return value
2908 // or load instruction)
Craig Topper9f008862014-04-15 04:59:12 +00002909 return nullptr;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00002910}
Evan Chengda3db112008-06-30 07:31:25 +00002911
Sanjay Patelaee84212014-11-04 16:27:42 +00002912/// Analyze the specified pointer to see if it can be expressed as a base
2913/// pointer plus a constant offset. Return the base and offset to the caller.
Chris Lattnere28618d2010-11-30 22:25:26 +00002914Value *llvm::GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002915 const DataLayout &DL) {
2916 unsigned BitWidth = DL.getPointerTypeSizeInBits(Ptr->getType());
Nuno Lopes368c4d02012-12-31 20:48:35 +00002917 APInt ByteOffset(BitWidth, 0);
Chandler Carruth76641272016-01-04 07:23:12 +00002918
2919 // We walk up the defs but use a visited set to handle unreachable code. In
2920 // that case, we stop after accumulating the cycle once (not that it
2921 // matters).
2922 SmallPtrSet<Value *, 16> Visited;
2923 while (Visited.insert(Ptr).second) {
Nuno Lopes368c4d02012-12-31 20:48:35 +00002924 if (Ptr->getType()->isVectorTy())
2925 break;
Craig Topper1bef2c82012-12-22 19:15:35 +00002926
Nuno Lopes368c4d02012-12-31 20:48:35 +00002927 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
Tom Stellard17eb3412016-10-07 14:23:29 +00002928 // If one of the values we have visited is an addrspacecast, then
2929 // the pointer type of this GEP may be different from the type
2930 // of the Ptr parameter which was passed to this function. This
2931 // means when we construct GEPOffset, we need to use the size
2932 // of GEP's pointer type rather than the size of the original
2933 // pointer type.
2934 APInt GEPOffset(DL.getPointerTypeSizeInBits(Ptr->getType()), 0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002935 if (!GEP->accumulateConstantOffset(DL, GEPOffset))
2936 break;
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00002937
Tom Stellard17eb3412016-10-07 14:23:29 +00002938 ByteOffset += GEPOffset.getSExtValue();
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00002939
Nuno Lopes368c4d02012-12-31 20:48:35 +00002940 Ptr = GEP->getPointerOperand();
Tom Stellard17eb3412016-10-07 14:23:29 +00002941 } else if (Operator::getOpcode(Ptr) == Instruction::BitCast ||
2942 Operator::getOpcode(Ptr) == Instruction::AddrSpaceCast) {
Nuno Lopes368c4d02012-12-31 20:48:35 +00002943 Ptr = cast<Operator>(Ptr)->getOperand(0);
2944 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(Ptr)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00002945 if (GA->isInterposable())
Nuno Lopes368c4d02012-12-31 20:48:35 +00002946 break;
2947 Ptr = GA->getAliasee();
Chris Lattnere28618d2010-11-30 22:25:26 +00002948 } else {
Nuno Lopes368c4d02012-12-31 20:48:35 +00002949 break;
Chris Lattnere28618d2010-11-30 22:25:26 +00002950 }
2951 }
Nuno Lopes368c4d02012-12-31 20:48:35 +00002952 Offset = ByteOffset.getSExtValue();
2953 return Ptr;
Chris Lattnere28618d2010-11-30 22:25:26 +00002954}
2955
David L Kreitzer752c1442016-04-13 14:31:06 +00002956bool llvm::isGEPBasedOnPointerToString(const GEPOperator *GEP) {
2957 // Make sure the GEP has exactly three arguments.
2958 if (GEP->getNumOperands() != 3)
2959 return false;
2960
2961 // Make sure the index-ee is a pointer to array of i8.
2962 ArrayType *AT = dyn_cast<ArrayType>(GEP->getSourceElementType());
2963 if (!AT || !AT->getElementType()->isIntegerTy(8))
2964 return false;
2965
2966 // Check to make sure that the first operand of the GEP is an integer and
2967 // has value 0 so that we are sure we're indexing into the initializer.
2968 const ConstantInt *FirstIdx = dyn_cast<ConstantInt>(GEP->getOperand(1));
2969 if (!FirstIdx || !FirstIdx->isZero())
2970 return false;
2971
2972 return true;
Sanjoy Das6082c1a2016-05-07 02:08:15 +00002973}
Chris Lattnere28618d2010-11-30 22:25:26 +00002974
Sanjay Patelaee84212014-11-04 16:27:42 +00002975/// This function computes the length of a null-terminated C string pointed to
2976/// by V. If successful, it returns true and returns the string in Str.
2977/// If unsuccessful, it returns false.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002978bool llvm::getConstantStringInfo(const Value *V, StringRef &Str,
2979 uint64_t Offset, bool TrimAtNul) {
2980 assert(V);
Evan Chengda3db112008-06-30 07:31:25 +00002981
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002982 // Look through bitcast instructions and geps.
2983 V = V->stripPointerCasts();
Craig Topper1bef2c82012-12-22 19:15:35 +00002984
Benjamin Kramer0248a3e2015-03-21 15:36:06 +00002985 // If the value is a GEP instruction or constant expression, treat it as an
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002986 // offset.
2987 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
David L Kreitzer752c1442016-04-13 14:31:06 +00002988 // The GEP operator should be based on a pointer to string constant, and is
2989 // indexing into the string constant.
2990 if (!isGEPBasedOnPointerToString(GEP))
Bill Wendlingfa54bc22009-03-13 04:39:26 +00002991 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00002992
Evan Chengda3db112008-06-30 07:31:25 +00002993 // If the second index isn't a ConstantInt, then this is a variable index
2994 // into the array. If this occurs, we can't say anything meaningful about
2995 // the string.
2996 uint64_t StartIdx = 0;
Dan Gohman0b4df042010-04-14 22:20:45 +00002997 if (const ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(2)))
Evan Chengda3db112008-06-30 07:31:25 +00002998 StartIdx = CI->getZExtValue();
Bill Wendlingfa54bc22009-03-13 04:39:26 +00002999 else
3000 return false;
Benjamin Kramer0248a3e2015-03-21 15:36:06 +00003001 return getConstantStringInfo(GEP->getOperand(0), Str, StartIdx + Offset,
3002 TrimAtNul);
Evan Chengda3db112008-06-30 07:31:25 +00003003 }
Nick Lewycky46209882011-10-20 00:34:35 +00003004
Evan Chengda3db112008-06-30 07:31:25 +00003005 // The GEP instruction, constant or instruction, must reference a global
3006 // variable that is a constant and is initialized. The referenced constant
3007 // initializer is the array that we'll use for optimization.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003008 const GlobalVariable *GV = dyn_cast<GlobalVariable>(V);
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00003009 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003010 return false;
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003011
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00003012 // Handle the all-zeros case.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003013 if (GV->getInitializer()->isNullValue()) {
Evan Chengda3db112008-06-30 07:31:25 +00003014 // This is a degenerate case. The initializer is constant zero so the
3015 // length of the string must be zero.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003016 Str = "";
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003017 return true;
3018 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003019
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00003020 // This must be a ConstantDataArray.
3021 const auto *Array = dyn_cast<ConstantDataArray>(GV->getInitializer());
Craig Topper9f008862014-04-15 04:59:12 +00003022 if (!Array || !Array->isString())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003023 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003024
Sanjay Patel8ec7e7c2016-05-22 16:07:20 +00003025 // Get the number of elements in the array.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003026 uint64_t NumElts = Array->getType()->getArrayNumElements();
3027
3028 // Start out with the entire array in the StringRef.
3029 Str = Array->getAsString();
3030
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003031 if (Offset > NumElts)
3032 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00003033
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003034 // Skip over 'offset' bytes.
3035 Str = Str.substr(Offset);
Craig Topper1bef2c82012-12-22 19:15:35 +00003036
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003037 if (TrimAtNul) {
3038 // Trim off the \0 and anything after it. If the array is not nul
3039 // terminated, we just return the whole end of string. The client may know
3040 // some other way that the string is length-bound.
3041 Str = Str.substr(0, Str.find('\0'));
3042 }
Bill Wendlingfa54bc22009-03-13 04:39:26 +00003043 return true;
Evan Chengda3db112008-06-30 07:31:25 +00003044}
Eric Christopher4899cbc2010-03-05 06:58:57 +00003045
3046// These next two are very similar to the above, but also look through PHI
3047// nodes.
3048// TODO: See if we can integrate these two together.
3049
Sanjay Patelaee84212014-11-04 16:27:42 +00003050/// If we can compute the length of the string pointed to by
Eric Christopher4899cbc2010-03-05 06:58:57 +00003051/// the specified pointer, return 'len+1'. If we can't, return 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00003052static uint64_t GetStringLengthH(const Value *V,
3053 SmallPtrSetImpl<const PHINode*> &PHIs) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00003054 // Look through noop bitcast instructions.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003055 V = V->stripPointerCasts();
Eric Christopher4899cbc2010-03-05 06:58:57 +00003056
3057 // If this is a PHI node, there are two cases: either we have already seen it
3058 // or we haven't.
Pete Cooper35b00d52016-08-13 01:05:32 +00003059 if (const PHINode *PN = dyn_cast<PHINode>(V)) {
David Blaikie70573dc2014-11-19 07:49:26 +00003060 if (!PHIs.insert(PN).second)
Eric Christopher4899cbc2010-03-05 06:58:57 +00003061 return ~0ULL; // already in the set.
3062
3063 // If it was new, see if all the input strings are the same length.
3064 uint64_t LenSoFar = ~0ULL;
Pete Cooper833f34d2015-05-12 20:05:31 +00003065 for (Value *IncValue : PN->incoming_values()) {
3066 uint64_t Len = GetStringLengthH(IncValue, PHIs);
Eric Christopher4899cbc2010-03-05 06:58:57 +00003067 if (Len == 0) return 0; // Unknown length -> unknown.
3068
3069 if (Len == ~0ULL) continue;
3070
3071 if (Len != LenSoFar && LenSoFar != ~0ULL)
3072 return 0; // Disagree -> unknown.
3073 LenSoFar = Len;
3074 }
3075
3076 // Success, all agree.
3077 return LenSoFar;
3078 }
3079
3080 // strlen(select(c,x,y)) -> strlen(x) ^ strlen(y)
Pete Cooper35b00d52016-08-13 01:05:32 +00003081 if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00003082 uint64_t Len1 = GetStringLengthH(SI->getTrueValue(), PHIs);
3083 if (Len1 == 0) return 0;
3084 uint64_t Len2 = GetStringLengthH(SI->getFalseValue(), PHIs);
3085 if (Len2 == 0) return 0;
3086 if (Len1 == ~0ULL) return Len2;
3087 if (Len2 == ~0ULL) return Len1;
3088 if (Len1 != Len2) return 0;
3089 return Len1;
3090 }
Craig Topper1bef2c82012-12-22 19:15:35 +00003091
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003092 // Otherwise, see if we can read the string.
3093 StringRef StrData;
3094 if (!getConstantStringInfo(V, StrData))
Eric Christopher4899cbc2010-03-05 06:58:57 +00003095 return 0;
3096
Chris Lattnercf9e8f62012-02-05 02:29:43 +00003097 return StrData.size()+1;
Eric Christopher4899cbc2010-03-05 06:58:57 +00003098}
3099
Sanjay Patelaee84212014-11-04 16:27:42 +00003100/// If we can compute the length of the string pointed to by
Eric Christopher4899cbc2010-03-05 06:58:57 +00003101/// the specified pointer, return 'len+1'. If we can't, return 0.
Pete Cooper35b00d52016-08-13 01:05:32 +00003102uint64_t llvm::GetStringLength(const Value *V) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00003103 if (!V->getType()->isPointerTy()) return 0;
3104
Pete Cooper35b00d52016-08-13 01:05:32 +00003105 SmallPtrSet<const PHINode*, 32> PHIs;
Eric Christopher4899cbc2010-03-05 06:58:57 +00003106 uint64_t Len = GetStringLengthH(V, PHIs);
3107 // If Len is ~0ULL, we had an infinite phi cycle: this is dead code, so return
3108 // an empty string as a length.
3109 return Len == ~0ULL ? 1 : Len;
3110}
Dan Gohmana4fcd242010-12-15 20:02:24 +00003111
Adam Nemete2b885c2015-04-23 20:09:20 +00003112/// \brief \p PN defines a loop-variant pointer to an object. Check if the
3113/// previous iteration of the loop was referring to the same object as \p PN.
Pete Cooper35b00d52016-08-13 01:05:32 +00003114static bool isSameUnderlyingObjectInLoop(const PHINode *PN,
3115 const LoopInfo *LI) {
Adam Nemete2b885c2015-04-23 20:09:20 +00003116 // Find the loop-defined value.
3117 Loop *L = LI->getLoopFor(PN->getParent());
3118 if (PN->getNumIncomingValues() != 2)
3119 return true;
3120
3121 // Find the value from previous iteration.
3122 auto *PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(0));
3123 if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
3124 PrevValue = dyn_cast<Instruction>(PN->getIncomingValue(1));
3125 if (!PrevValue || LI->getLoopFor(PrevValue->getParent()) != L)
3126 return true;
3127
3128 // If a new pointer is loaded in the loop, the pointer references a different
3129 // object in every iteration. E.g.:
3130 // for (i)
3131 // int *p = a[i];
3132 // ...
3133 if (auto *Load = dyn_cast<LoadInst>(PrevValue))
3134 if (!L->isLoopInvariant(Load->getPointerOperand()))
3135 return false;
3136 return true;
3137}
3138
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003139Value *llvm::GetUnderlyingObject(Value *V, const DataLayout &DL,
3140 unsigned MaxLookup) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00003141 if (!V->getType()->isPointerTy())
3142 return V;
3143 for (unsigned Count = 0; MaxLookup == 0 || Count < MaxLookup; ++Count) {
3144 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
3145 V = GEP->getPointerOperand();
Matt Arsenault70f4db882014-07-15 00:56:40 +00003146 } else if (Operator::getOpcode(V) == Instruction::BitCast ||
3147 Operator::getOpcode(V) == Instruction::AddrSpaceCast) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00003148 V = cast<Operator>(V)->getOperand(0);
3149 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
Sanjoy Das5ce32722016-04-08 00:48:30 +00003150 if (GA->isInterposable())
Dan Gohmana4fcd242010-12-15 20:02:24 +00003151 return V;
3152 V = GA->getAliasee();
3153 } else {
Hal Finkel5c12d8f2016-07-11 01:32:20 +00003154 if (auto CS = CallSite(V))
3155 if (Value *RV = CS.getReturnedArgOperand()) {
3156 V = RV;
3157 continue;
3158 }
3159
Dan Gohman05b18f12010-12-15 20:49:55 +00003160 // See if InstructionSimplify knows any relevant tricks.
3161 if (Instruction *I = dyn_cast<Instruction>(V))
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003162 // TODO: Acquire a DominatorTree and AssumptionCache and use them.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003163 if (Value *Simplified = SimplifyInstruction(I, DL, nullptr)) {
Dan Gohman05b18f12010-12-15 20:49:55 +00003164 V = Simplified;
3165 continue;
3166 }
3167
Dan Gohmana4fcd242010-12-15 20:02:24 +00003168 return V;
3169 }
3170 assert(V->getType()->isPointerTy() && "Unexpected operand type!");
3171 }
3172 return V;
3173}
Nick Lewycky3e334a42011-06-27 04:20:45 +00003174
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003175void llvm::GetUnderlyingObjects(Value *V, SmallVectorImpl<Value *> &Objects,
Adam Nemete2b885c2015-04-23 20:09:20 +00003176 const DataLayout &DL, LoopInfo *LI,
3177 unsigned MaxLookup) {
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003178 SmallPtrSet<Value *, 4> Visited;
3179 SmallVector<Value *, 4> Worklist;
3180 Worklist.push_back(V);
3181 do {
3182 Value *P = Worklist.pop_back_val();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003183 P = GetUnderlyingObject(P, DL, MaxLookup);
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003184
David Blaikie70573dc2014-11-19 07:49:26 +00003185 if (!Visited.insert(P).second)
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003186 continue;
3187
3188 if (SelectInst *SI = dyn_cast<SelectInst>(P)) {
3189 Worklist.push_back(SI->getTrueValue());
3190 Worklist.push_back(SI->getFalseValue());
3191 continue;
3192 }
3193
3194 if (PHINode *PN = dyn_cast<PHINode>(P)) {
Adam Nemete2b885c2015-04-23 20:09:20 +00003195 // If this PHI changes the underlying object in every iteration of the
3196 // loop, don't look through it. Consider:
3197 // int **A;
3198 // for (i) {
3199 // Prev = Curr; // Prev = PHI (Prev_0, Curr)
3200 // Curr = A[i];
3201 // *Prev, *Curr;
3202 //
3203 // Prev is tracking Curr one iteration behind so they refer to different
3204 // underlying objects.
3205 if (!LI || !LI->isLoopHeader(PN->getParent()) ||
3206 isSameUnderlyingObjectInLoop(PN, LI))
Pete Cooper833f34d2015-05-12 20:05:31 +00003207 for (Value *IncValue : PN->incoming_values())
3208 Worklist.push_back(IncValue);
Dan Gohmaned7c24e22012-05-10 18:57:38 +00003209 continue;
3210 }
3211
3212 Objects.push_back(P);
3213 } while (!Worklist.empty());
3214}
3215
Sanjay Patelaee84212014-11-04 16:27:42 +00003216/// Return true if the only users of this pointer are lifetime markers.
Nick Lewycky3e334a42011-06-27 04:20:45 +00003217bool llvm::onlyUsedByLifetimeMarkers(const Value *V) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003218 for (const User *U : V->users()) {
3219 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(U);
Nick Lewycky3e334a42011-06-27 04:20:45 +00003220 if (!II) return false;
3221
3222 if (II->getIntrinsicID() != Intrinsic::lifetime_start &&
3223 II->getIntrinsicID() != Intrinsic::lifetime_end)
3224 return false;
3225 }
3226 return true;
3227}
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003228
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003229bool llvm::isSafeToSpeculativelyExecute(const Value *V,
3230 const Instruction *CtxI,
Sean Silva45835e72016-07-02 23:47:27 +00003231 const DominatorTree *DT) {
Dan Gohman7ac046a2012-01-04 23:01:09 +00003232 const Operator *Inst = dyn_cast<Operator>(V);
3233 if (!Inst)
3234 return false;
3235
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003236 for (unsigned i = 0, e = Inst->getNumOperands(); i != e; ++i)
3237 if (Constant *C = dyn_cast<Constant>(Inst->getOperand(i)))
3238 if (C->canTrap())
3239 return false;
3240
3241 switch (Inst->getOpcode()) {
3242 default:
3243 return true;
3244 case Instruction::UDiv:
David Majnemerf20d7c42014-11-04 23:49:08 +00003245 case Instruction::URem: {
3246 // x / y is undefined if y == 0.
3247 const APInt *V;
3248 if (match(Inst->getOperand(1), m_APInt(V)))
3249 return *V != 0;
3250 return false;
3251 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003252 case Instruction::SDiv:
3253 case Instruction::SRem: {
David Majnemerf20d7c42014-11-04 23:49:08 +00003254 // x / y is undefined if y == 0 or x == INT_MIN and y == -1
David Majnemer8a6578a2015-02-01 19:10:19 +00003255 const APInt *Numerator, *Denominator;
3256 if (!match(Inst->getOperand(1), m_APInt(Denominator)))
3257 return false;
3258 // We cannot hoist this division if the denominator is 0.
3259 if (*Denominator == 0)
3260 return false;
3261 // It's safe to hoist if the denominator is not 0 or -1.
3262 if (*Denominator != -1)
3263 return true;
3264 // At this point we know that the denominator is -1. It is safe to hoist as
3265 // long we know that the numerator is not INT_MIN.
3266 if (match(Inst->getOperand(0), m_APInt(Numerator)))
3267 return !Numerator->isMinSignedValue();
3268 // The numerator *might* be MinSignedValue.
David Majnemerf20d7c42014-11-04 23:49:08 +00003269 return false;
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003270 }
3271 case Instruction::Load: {
3272 const LoadInst *LI = cast<LoadInst>(Inst);
Kostya Serebryany0b458282013-11-21 07:29:28 +00003273 if (!LI->isUnordered() ||
3274 // Speculative load may create a race that did not exist in the source.
Sanjoy Dasb66374c2016-07-14 20:19:01 +00003275 LI->getFunction()->hasFnAttribute(Attribute::SanitizeThread) ||
Kostya Serebryany5cb86d52015-10-14 00:21:05 +00003276 // Speculative load may load data from dirty regions.
Sanjoy Dasb66374c2016-07-14 20:19:01 +00003277 LI->getFunction()->hasFnAttribute(Attribute::SanitizeAddress))
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003278 return false;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003279 const DataLayout &DL = LI->getModule()->getDataLayout();
Sean Silva45835e72016-07-02 23:47:27 +00003280 return isDereferenceableAndAlignedPointer(LI->getPointerOperand(),
3281 LI->getAlignment(), DL, CtxI, DT);
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003282 }
Nick Lewyckyb4039f62011-12-21 05:52:02 +00003283 case Instruction::Call: {
David Majnemer0a92f862015-08-28 21:13:39 +00003284 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
3285 switch (II->getIntrinsicID()) {
3286 // These synthetic intrinsics have no side-effects and just mark
3287 // information about their operands.
3288 // FIXME: There are other no-op synthetic instructions that potentially
3289 // should be considered at least *safe* to speculate...
3290 case Intrinsic::dbg_declare:
3291 case Intrinsic::dbg_value:
3292 return true;
3293
Xin Tongc13a8e82017-01-09 17:57:08 +00003294 case Intrinsic::bitreverse:
David Majnemer0a92f862015-08-28 21:13:39 +00003295 case Intrinsic::bswap:
3296 case Intrinsic::ctlz:
3297 case Intrinsic::ctpop:
3298 case Intrinsic::cttz:
3299 case Intrinsic::objectsize:
3300 case Intrinsic::sadd_with_overflow:
3301 case Intrinsic::smul_with_overflow:
3302 case Intrinsic::ssub_with_overflow:
3303 case Intrinsic::uadd_with_overflow:
3304 case Intrinsic::umul_with_overflow:
3305 case Intrinsic::usub_with_overflow:
3306 return true;
Peter Zotov0218d0f2016-04-03 12:30:46 +00003307 // These intrinsics are defined to have the same behavior as libm
3308 // functions except for setting errno.
David Majnemer0a92f862015-08-28 21:13:39 +00003309 case Intrinsic::sqrt:
3310 case Intrinsic::fma:
3311 case Intrinsic::fmuladd:
Peter Zotov0218d0f2016-04-03 12:30:46 +00003312 return true;
3313 // These intrinsics are defined to have the same behavior as libm
3314 // functions, and the corresponding libm functions never set errno.
3315 case Intrinsic::trunc:
3316 case Intrinsic::copysign:
David Majnemer0a92f862015-08-28 21:13:39 +00003317 case Intrinsic::fabs:
3318 case Intrinsic::minnum:
3319 case Intrinsic::maxnum:
3320 return true;
Peter Zotov0218d0f2016-04-03 12:30:46 +00003321 // These intrinsics are defined to have the same behavior as libm
3322 // functions, which never overflow when operating on the IEEE754 types
3323 // that we support, and never set errno otherwise.
3324 case Intrinsic::ceil:
3325 case Intrinsic::floor:
3326 case Intrinsic::nearbyint:
3327 case Intrinsic::rint:
3328 case Intrinsic::round:
3329 return true;
David Majnemer0a92f862015-08-28 21:13:39 +00003330 // TODO: are convert_{from,to}_fp16 safe?
3331 // TODO: can we list target-specific intrinsics here?
3332 default: break;
3333 }
3334 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003335 return false; // The called function could have undefined behavior or
David Majnemer0a92f862015-08-28 21:13:39 +00003336 // side-effects, even if marked readnone nounwind.
Nick Lewyckyb4039f62011-12-21 05:52:02 +00003337 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003338 case Instruction::VAArg:
3339 case Instruction::Alloca:
3340 case Instruction::Invoke:
3341 case Instruction::PHI:
3342 case Instruction::Store:
3343 case Instruction::Ret:
3344 case Instruction::Br:
3345 case Instruction::IndirectBr:
3346 case Instruction::Switch:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003347 case Instruction::Unreachable:
3348 case Instruction::Fence:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003349 case Instruction::AtomicRMW:
3350 case Instruction::AtomicCmpXchg:
David Majnemer654e1302015-07-31 17:58:14 +00003351 case Instruction::LandingPad:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003352 case Instruction::Resume:
David Majnemer8a1c45d2015-12-12 05:38:55 +00003353 case Instruction::CatchSwitch:
David Majnemer654e1302015-07-31 17:58:14 +00003354 case Instruction::CatchPad:
David Majnemer654e1302015-07-31 17:58:14 +00003355 case Instruction::CatchRet:
3356 case Instruction::CleanupPad:
3357 case Instruction::CleanupRet:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00003358 return false; // Misc instructions which have effects
3359 }
3360}
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003361
Quentin Colombet6443cce2015-08-06 18:44:34 +00003362bool llvm::mayBeMemoryDependent(const Instruction &I) {
3363 return I.mayReadOrWriteMemory() || !isSafeToSpeculativelyExecute(&I);
3364}
3365
Sanjay Patelaee84212014-11-04 16:27:42 +00003366/// Return true if we know that the specified value is never null.
Sean Silva45835e72016-07-02 23:47:27 +00003367bool llvm::isKnownNonNull(const Value *V) {
Chen Li0d043b52015-09-14 18:10:43 +00003368 assert(V->getType()->isPointerTy() && "V must be pointer type");
3369
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003370 // Alloca never returns null, malloc might.
3371 if (isa<AllocaInst>(V)) return true;
3372
Nick Lewyckyd52b1522014-05-20 01:23:40 +00003373 // A byval, inalloca, or nonnull argument is never null.
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003374 if (const Argument *A = dyn_cast<Argument>(V))
Nick Lewyckyd52b1522014-05-20 01:23:40 +00003375 return A->hasByValOrInAllocaAttr() || A->hasNonNullAttr();
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003376
Peter Collingbourne235c2752016-12-08 19:01:00 +00003377 // A global variable in address space 0 is non null unless extern weak
3378 // or an absolute symbol reference. Other address spaces may have null as a
3379 // valid address for a global, so we can't assume anything.
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003380 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
Peter Collingbourne235c2752016-12-08 19:01:00 +00003381 return !GV->isAbsoluteSymbolRef() && !GV->hasExternalWeakLinkage() &&
Pete Cooper6b716212015-08-27 03:16:29 +00003382 GV->getType()->getAddressSpace() == 0;
Benjamin Kramerfd4777c2013-09-24 16:37:51 +00003383
Sanjoy Das5056e192016-05-07 02:08:22 +00003384 // A Load tagged with nonnull metadata is never null.
Philip Reamescdb72f32014-10-20 22:40:55 +00003385 if (const LoadInst *LI = dyn_cast<LoadInst>(V))
Philip Reames5a3f5f72014-10-21 00:13:20 +00003386 return LI->getMetadata(LLVMContext::MD_nonnull);
Philip Reamescdb72f32014-10-20 22:40:55 +00003387
Benjamin Kramer3a09ef62015-04-10 14:50:08 +00003388 if (auto CS = ImmutableCallSite(V))
Hal Finkelb0407ba2014-07-18 15:51:28 +00003389 if (CS.isReturnNonNull())
Nick Lewyckyec373542014-05-20 05:13:21 +00003390 return true;
3391
Dan Gohman1b0f79d2013-01-31 02:40:59 +00003392 return false;
3393}
David Majnemer491331a2015-01-02 07:29:43 +00003394
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003395static bool isKnownNonNullFromDominatingCondition(const Value *V,
3396 const Instruction *CtxI,
3397 const DominatorTree *DT) {
Chen Li0d043b52015-09-14 18:10:43 +00003398 assert(V->getType()->isPointerTy() && "V must be pointer type");
Duncan P. N. Exon Smithb4798732016-09-24 19:39:47 +00003399 assert(!isa<ConstantData>(V) && "Did not expect ConstantPointerNull");
Sanjay Patel7fd779f2016-12-31 17:37:01 +00003400 assert(CtxI && "Context instruction required for analysis");
3401 assert(DT && "Dominator tree required for analysis");
Chen Li0d043b52015-09-14 18:10:43 +00003402
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003403 unsigned NumUsesExplored = 0;
Sanjoy Das987aaa12016-05-07 02:08:24 +00003404 for (auto *U : V->users()) {
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003405 // Avoid massive lists
3406 if (NumUsesExplored >= DomConditionsMaxUses)
3407 break;
3408 NumUsesExplored++;
3409 // Consider only compare instructions uniquely controlling a branch
Sanjoy Das987aaa12016-05-07 02:08:24 +00003410 CmpInst::Predicate Pred;
3411 if (!match(const_cast<User *>(U),
3412 m_c_ICmp(Pred, m_Specific(V), m_Zero())) ||
3413 (Pred != ICmpInst::ICMP_EQ && Pred != ICmpInst::ICMP_NE))
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003414 continue;
3415
Sanjoy Das987aaa12016-05-07 02:08:24 +00003416 for (auto *CmpU : U->users()) {
Sanjoy Das12c91dc2016-05-10 02:35:44 +00003417 if (const BranchInst *BI = dyn_cast<BranchInst>(CmpU)) {
3418 assert(BI->isConditional() && "uses a comparison!");
Sanjoy Das6082c1a2016-05-07 02:08:15 +00003419
Sanjoy Das12c91dc2016-05-10 02:35:44 +00003420 BasicBlock *NonNullSuccessor =
3421 BI->getSuccessor(Pred == ICmpInst::ICMP_EQ ? 1 : 0);
3422 BasicBlockEdge Edge(BI->getParent(), NonNullSuccessor);
3423 if (Edge.isSingleEdge() && DT->dominates(Edge, CtxI->getParent()))
3424 return true;
3425 } else if (Pred == ICmpInst::ICMP_NE &&
3426 match(CmpU, m_Intrinsic<Intrinsic::experimental_guard>()) &&
3427 DT->dominates(cast<Instruction>(CmpU), CtxI)) {
Sanjoy Das987aaa12016-05-07 02:08:24 +00003428 return true;
Sanjoy Das12c91dc2016-05-10 02:35:44 +00003429 }
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003430 }
3431 }
3432
3433 return false;
3434}
3435
3436bool llvm::isKnownNonNullAt(const Value *V, const Instruction *CtxI,
Sean Silva45835e72016-07-02 23:47:27 +00003437 const DominatorTree *DT) {
Duncan P. N. Exon Smithb4798732016-09-24 19:39:47 +00003438 if (isa<ConstantPointerNull>(V) || isa<UndefValue>(V))
3439 return false;
3440
Sean Silva45835e72016-07-02 23:47:27 +00003441 if (isKnownNonNull(V))
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003442 return true;
3443
Sanjay Patel7fd779f2016-12-31 17:37:01 +00003444 if (!CtxI || !DT)
3445 return false;
3446
3447 return ::isKnownNonNullFromDominatingCondition(V, CtxI, DT);
Sanjoy Dasf8a0db52015-05-18 18:07:00 +00003448}
3449
Pete Cooper35b00d52016-08-13 01:05:32 +00003450OverflowResult llvm::computeOverflowForUnsignedMul(const Value *LHS,
3451 const Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003452 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003453 AssumptionCache *AC,
David Majnemer491331a2015-01-02 07:29:43 +00003454 const Instruction *CxtI,
3455 const DominatorTree *DT) {
3456 // Multiplying n * m significant bits yields a result of n + m significant
3457 // bits. If the total number of significant bits does not exceed the
3458 // result bit width (minus 1), there is no overflow.
3459 // This means if we have enough leading zero bits in the operands
3460 // we can guarantee that the result does not overflow.
3461 // Ref: "Hacker's Delight" by Henry Warren
3462 unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
3463 APInt LHSKnownZero(BitWidth, 0);
David Majnemerc8a576b2015-01-02 07:29:47 +00003464 APInt LHSKnownOne(BitWidth, 0);
David Majnemer491331a2015-01-02 07:29:43 +00003465 APInt RHSKnownZero(BitWidth, 0);
David Majnemerc8a576b2015-01-02 07:29:47 +00003466 APInt RHSKnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003467 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne, DL, /*Depth=*/0, AC, CxtI,
3468 DT);
3469 computeKnownBits(RHS, RHSKnownZero, RHSKnownOne, DL, /*Depth=*/0, AC, CxtI,
3470 DT);
David Majnemer491331a2015-01-02 07:29:43 +00003471 // Note that underestimating the number of zero bits gives a more
3472 // conservative answer.
3473 unsigned ZeroBits = LHSKnownZero.countLeadingOnes() +
3474 RHSKnownZero.countLeadingOnes();
3475 // First handle the easy case: if we have enough zero bits there's
3476 // definitely no overflow.
3477 if (ZeroBits >= BitWidth)
3478 return OverflowResult::NeverOverflows;
3479
3480 // Get the largest possible values for each operand.
3481 APInt LHSMax = ~LHSKnownZero;
3482 APInt RHSMax = ~RHSKnownZero;
3483
3484 // We know the multiply operation doesn't overflow if the maximum values for
3485 // each operand will not overflow after we multiply them together.
David Majnemerc8a576b2015-01-02 07:29:47 +00003486 bool MaxOverflow;
3487 LHSMax.umul_ov(RHSMax, MaxOverflow);
3488 if (!MaxOverflow)
3489 return OverflowResult::NeverOverflows;
David Majnemer491331a2015-01-02 07:29:43 +00003490
David Majnemerc8a576b2015-01-02 07:29:47 +00003491 // We know it always overflows if multiplying the smallest possible values for
3492 // the operands also results in overflow.
3493 bool MinOverflow;
3494 LHSKnownOne.umul_ov(RHSKnownOne, MinOverflow);
3495 if (MinOverflow)
3496 return OverflowResult::AlwaysOverflows;
3497
3498 return OverflowResult::MayOverflow;
David Majnemer491331a2015-01-02 07:29:43 +00003499}
David Majnemer5310c1e2015-01-07 00:39:50 +00003500
Pete Cooper35b00d52016-08-13 01:05:32 +00003501OverflowResult llvm::computeOverflowForUnsignedAdd(const Value *LHS,
3502 const Value *RHS,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003503 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003504 AssumptionCache *AC,
David Majnemer5310c1e2015-01-07 00:39:50 +00003505 const Instruction *CxtI,
3506 const DominatorTree *DT) {
3507 bool LHSKnownNonNegative, LHSKnownNegative;
3508 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003509 AC, CxtI, DT);
David Majnemer5310c1e2015-01-07 00:39:50 +00003510 if (LHSKnownNonNegative || LHSKnownNegative) {
3511 bool RHSKnownNonNegative, RHSKnownNegative;
3512 ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003513 AC, CxtI, DT);
David Majnemer5310c1e2015-01-07 00:39:50 +00003514
3515 if (LHSKnownNegative && RHSKnownNegative) {
3516 // The sign bit is set in both cases: this MUST overflow.
3517 // Create a simple add instruction, and insert it into the struct.
3518 return OverflowResult::AlwaysOverflows;
3519 }
3520
3521 if (LHSKnownNonNegative && RHSKnownNonNegative) {
3522 // The sign bit is clear in both cases: this CANNOT overflow.
3523 // Create a simple add instruction, and insert it into the struct.
3524 return OverflowResult::NeverOverflows;
3525 }
3526 }
3527
3528 return OverflowResult::MayOverflow;
3529}
James Molloy71b91c22015-05-11 14:42:20 +00003530
Pete Cooper35b00d52016-08-13 01:05:32 +00003531static OverflowResult computeOverflowForSignedAdd(const Value *LHS,
3532 const Value *RHS,
3533 const AddOperator *Add,
3534 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003535 AssumptionCache *AC,
Pete Cooper35b00d52016-08-13 01:05:32 +00003536 const Instruction *CxtI,
3537 const DominatorTree *DT) {
Jingyue Wu10fcea52015-08-20 18:27:04 +00003538 if (Add && Add->hasNoSignedWrap()) {
3539 return OverflowResult::NeverOverflows;
3540 }
3541
3542 bool LHSKnownNonNegative, LHSKnownNegative;
3543 bool RHSKnownNonNegative, RHSKnownNegative;
3544 ComputeSignBit(LHS, LHSKnownNonNegative, LHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003545 AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003546 ComputeSignBit(RHS, RHSKnownNonNegative, RHSKnownNegative, DL, /*Depth=*/0,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003547 AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003548
3549 if ((LHSKnownNonNegative && RHSKnownNegative) ||
3550 (LHSKnownNegative && RHSKnownNonNegative)) {
3551 // The sign bits are opposite: this CANNOT overflow.
3552 return OverflowResult::NeverOverflows;
3553 }
3554
3555 // The remaining code needs Add to be available. Early returns if not so.
3556 if (!Add)
3557 return OverflowResult::MayOverflow;
3558
3559 // If the sign of Add is the same as at least one of the operands, this add
3560 // CANNOT overflow. This is particularly useful when the sum is
3561 // @llvm.assume'ed non-negative rather than proved so from analyzing its
3562 // operands.
3563 bool LHSOrRHSKnownNonNegative =
3564 (LHSKnownNonNegative || RHSKnownNonNegative);
3565 bool LHSOrRHSKnownNegative = (LHSKnownNegative || RHSKnownNegative);
3566 if (LHSOrRHSKnownNonNegative || LHSOrRHSKnownNegative) {
3567 bool AddKnownNonNegative, AddKnownNegative;
3568 ComputeSignBit(Add, AddKnownNonNegative, AddKnownNegative, DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003569 /*Depth=*/0, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003570 if ((AddKnownNonNegative && LHSOrRHSKnownNonNegative) ||
3571 (AddKnownNegative && LHSOrRHSKnownNegative)) {
3572 return OverflowResult::NeverOverflows;
3573 }
3574 }
3575
3576 return OverflowResult::MayOverflow;
3577}
3578
Pete Cooper35b00d52016-08-13 01:05:32 +00003579bool llvm::isOverflowIntrinsicNoWrap(const IntrinsicInst *II,
3580 const DominatorTree &DT) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003581#ifndef NDEBUG
3582 auto IID = II->getIntrinsicID();
3583 assert((IID == Intrinsic::sadd_with_overflow ||
3584 IID == Intrinsic::uadd_with_overflow ||
3585 IID == Intrinsic::ssub_with_overflow ||
3586 IID == Intrinsic::usub_with_overflow ||
3587 IID == Intrinsic::smul_with_overflow ||
3588 IID == Intrinsic::umul_with_overflow) &&
3589 "Not an overflow intrinsic!");
3590#endif
3591
Pete Cooper35b00d52016-08-13 01:05:32 +00003592 SmallVector<const BranchInst *, 2> GuardingBranches;
3593 SmallVector<const ExtractValueInst *, 2> Results;
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003594
Pete Cooper35b00d52016-08-13 01:05:32 +00003595 for (const User *U : II->users()) {
3596 if (const auto *EVI = dyn_cast<ExtractValueInst>(U)) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003597 assert(EVI->getNumIndices() == 1 && "Obvious from CI's type");
3598
3599 if (EVI->getIndices()[0] == 0)
3600 Results.push_back(EVI);
3601 else {
3602 assert(EVI->getIndices()[0] == 1 && "Obvious from CI's type");
3603
Pete Cooper35b00d52016-08-13 01:05:32 +00003604 for (const auto *U : EVI->users())
3605 if (const auto *B = dyn_cast<BranchInst>(U)) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003606 assert(B->isConditional() && "How else is it using an i1?");
3607 GuardingBranches.push_back(B);
3608 }
3609 }
3610 } else {
3611 // We are using the aggregate directly in a way we don't want to analyze
3612 // here (storing it to a global, say).
3613 return false;
3614 }
3615 }
3616
Pete Cooper35b00d52016-08-13 01:05:32 +00003617 auto AllUsesGuardedByBranch = [&](const BranchInst *BI) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003618 BasicBlockEdge NoWrapEdge(BI->getParent(), BI->getSuccessor(1));
3619 if (!NoWrapEdge.isSingleEdge())
3620 return false;
3621
3622 // Check if all users of the add are provably no-wrap.
Pete Cooper35b00d52016-08-13 01:05:32 +00003623 for (const auto *Result : Results) {
Sanjoy Dasf49ca522016-05-29 00:34:42 +00003624 // If the extractvalue itself is not executed on overflow, the we don't
3625 // need to check each use separately, since domination is transitive.
3626 if (DT.dominates(NoWrapEdge, Result->getParent()))
3627 continue;
3628
3629 for (auto &RU : Result->uses())
3630 if (!DT.dominates(NoWrapEdge, RU))
3631 return false;
3632 }
3633
3634 return true;
3635 };
3636
3637 return any_of(GuardingBranches, AllUsesGuardedByBranch);
3638}
3639
3640
Pete Cooper35b00d52016-08-13 01:05:32 +00003641OverflowResult llvm::computeOverflowForSignedAdd(const AddOperator *Add,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003642 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003643 AssumptionCache *AC,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003644 const Instruction *CxtI,
3645 const DominatorTree *DT) {
3646 return ::computeOverflowForSignedAdd(Add->getOperand(0), Add->getOperand(1),
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003647 Add, DL, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003648}
3649
Pete Cooper35b00d52016-08-13 01:05:32 +00003650OverflowResult llvm::computeOverflowForSignedAdd(const Value *LHS,
3651 const Value *RHS,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003652 const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003653 AssumptionCache *AC,
Jingyue Wu10fcea52015-08-20 18:27:04 +00003654 const Instruction *CxtI,
3655 const DominatorTree *DT) {
Daniel Jasperaec2fa32016-12-19 08:22:17 +00003656 return ::computeOverflowForSignedAdd(LHS, RHS, nullptr, DL, AC, CxtI, DT);
Jingyue Wu10fcea52015-08-20 18:27:04 +00003657}
3658
Jingyue Wu42f1d672015-07-28 18:22:40 +00003659bool llvm::isGuaranteedToTransferExecutionToSuccessor(const Instruction *I) {
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003660 // A memory operation returns normally if it isn't volatile. A volatile
3661 // operation is allowed to trap.
3662 //
3663 // An atomic operation isn't guaranteed to return in a reasonable amount of
3664 // time because it's possible for another thread to interfere with it for an
3665 // arbitrary length of time, but programs aren't allowed to rely on that.
3666 if (const LoadInst *LI = dyn_cast<LoadInst>(I))
3667 return !LI->isVolatile();
3668 if (const StoreInst *SI = dyn_cast<StoreInst>(I))
3669 return !SI->isVolatile();
3670 if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(I))
3671 return !CXI->isVolatile();
3672 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(I))
3673 return !RMWI->isVolatile();
3674 if (const MemIntrinsic *MII = dyn_cast<MemIntrinsic>(I))
3675 return !MII->isVolatile();
Jingyue Wu42f1d672015-07-28 18:22:40 +00003676
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003677 // If there is no successor, then execution can't transfer to it.
3678 if (const auto *CRI = dyn_cast<CleanupReturnInst>(I))
3679 return !CRI->unwindsToCaller();
3680 if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(I))
3681 return !CatchSwitch->unwindsToCaller();
3682 if (isa<ResumeInst>(I))
3683 return false;
3684 if (isa<ReturnInst>(I))
3685 return false;
Sanjoy Das9a65cd22016-06-08 17:48:36 +00003686
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003687 // Calls can throw, or contain an infinite loop, or kill the process.
Sanjoy Das09455302016-12-31 22:12:31 +00003688 if (auto CS = ImmutableCallSite(I)) {
Sanjoy Das3bb2dbd2016-12-31 22:12:34 +00003689 // Call sites that throw have implicit non-local control flow.
3690 if (!CS.doesNotThrow())
3691 return false;
3692
3693 // Non-throwing call sites can loop infinitely, call exit/pthread_exit
3694 // etc. and thus not return. However, LLVM already assumes that
3695 //
3696 // - Thread exiting actions are modeled as writes to memory invisible to
3697 // the program.
3698 //
3699 // - Loops that don't have side effects (side effects are volatile/atomic
3700 // stores and IO) always terminate (see http://llvm.org/PR965).
3701 // Furthermore IO itself is also modeled as writes to memory invisible to
3702 // the program.
3703 //
3704 // We rely on those assumptions here, and use the memory effects of the call
3705 // target as a proxy for checking that it always returns.
3706
3707 // FIXME: This isn't aggressive enough; a call which only writes to a global
3708 // is guaranteed to return.
Sanjoy Dasd7e82062016-06-14 20:23:16 +00003709 return CS.onlyReadsMemory() || CS.onlyAccessesArgMemory() ||
3710 match(I, m_Intrinsic<Intrinsic::assume>());
Eli Friedmanf1da33e2016-06-11 21:48:25 +00003711 }
3712
3713 // Other instructions return normally.
3714 return true;
Jingyue Wu42f1d672015-07-28 18:22:40 +00003715}
3716
3717bool llvm::isGuaranteedToExecuteForEveryIteration(const Instruction *I,
3718 const Loop *L) {
3719 // The loop header is guaranteed to be executed for every iteration.
3720 //
3721 // FIXME: Relax this constraint to cover all basic blocks that are
3722 // guaranteed to be executed at every iteration.
3723 if (I->getParent() != L->getHeader()) return false;
3724
3725 for (const Instruction &LI : *L->getHeader()) {
3726 if (&LI == I) return true;
3727 if (!isGuaranteedToTransferExecutionToSuccessor(&LI)) return false;
3728 }
3729 llvm_unreachable("Instruction not contained in its own parent basic block.");
3730}
3731
3732bool llvm::propagatesFullPoison(const Instruction *I) {
3733 switch (I->getOpcode()) {
3734 case Instruction::Add:
3735 case Instruction::Sub:
3736 case Instruction::Xor:
3737 case Instruction::Trunc:
3738 case Instruction::BitCast:
3739 case Instruction::AddrSpaceCast:
3740 // These operations all propagate poison unconditionally. Note that poison
3741 // is not any particular value, so xor or subtraction of poison with
3742 // itself still yields poison, not zero.
3743 return true;
3744
3745 case Instruction::AShr:
3746 case Instruction::SExt:
3747 // For these operations, one bit of the input is replicated across
3748 // multiple output bits. A replicated poison bit is still poison.
3749 return true;
3750
3751 case Instruction::Shl: {
3752 // Left shift *by* a poison value is poison. The number of
3753 // positions to shift is unsigned, so no negative values are
3754 // possible there. Left shift by zero places preserves poison. So
3755 // it only remains to consider left shift of poison by a positive
3756 // number of places.
3757 //
3758 // A left shift by a positive number of places leaves the lowest order bit
3759 // non-poisoned. However, if such a shift has a no-wrap flag, then we can
3760 // make the poison operand violate that flag, yielding a fresh full-poison
3761 // value.
3762 auto *OBO = cast<OverflowingBinaryOperator>(I);
3763 return OBO->hasNoUnsignedWrap() || OBO->hasNoSignedWrap();
3764 }
3765
3766 case Instruction::Mul: {
3767 // A multiplication by zero yields a non-poison zero result, so we need to
3768 // rule out zero as an operand. Conservatively, multiplication by a
3769 // non-zero constant is not multiplication by zero.
3770 //
3771 // Multiplication by a non-zero constant can leave some bits
3772 // non-poisoned. For example, a multiplication by 2 leaves the lowest
3773 // order bit unpoisoned. So we need to consider that.
3774 //
3775 // Multiplication by 1 preserves poison. If the multiplication has a
3776 // no-wrap flag, then we can make the poison operand violate that flag
3777 // when multiplied by any integer other than 0 and 1.
3778 auto *OBO = cast<OverflowingBinaryOperator>(I);
3779 if (OBO->hasNoUnsignedWrap() || OBO->hasNoSignedWrap()) {
3780 for (Value *V : OBO->operands()) {
3781 if (auto *CI = dyn_cast<ConstantInt>(V)) {
3782 // A ConstantInt cannot yield poison, so we can assume that it is
3783 // the other operand that is poison.
3784 return !CI->isZero();
3785 }
3786 }
3787 }
3788 return false;
3789 }
3790
Sanjoy Das70c2bbd2016-05-29 00:31:18 +00003791 case Instruction::ICmp:
3792 // Comparing poison with any value yields poison. This is why, for
3793 // instance, x s< (x +nsw 1) can be folded to true.
3794 return true;
3795
Jingyue Wu42f1d672015-07-28 18:22:40 +00003796 case Instruction::GetElementPtr:
3797 // A GEP implicitly represents a sequence of additions, subtractions,
3798 // truncations, sign extensions and multiplications. The multiplications
3799 // are by the non-zero sizes of some set of types, so we do not have to be
3800 // concerned with multiplication by zero. If the GEP is in-bounds, then
3801 // these operations are implicitly no-signed-wrap so poison is propagated
3802 // by the arguments above for Add, Sub, Trunc, SExt and Mul.
3803 return cast<GEPOperator>(I)->isInBounds();
3804
3805 default:
3806 return false;
3807 }
3808}
3809
3810const Value *llvm::getGuaranteedNonFullPoisonOp(const Instruction *I) {
3811 switch (I->getOpcode()) {
3812 case Instruction::Store:
3813 return cast<StoreInst>(I)->getPointerOperand();
3814
3815 case Instruction::Load:
3816 return cast<LoadInst>(I)->getPointerOperand();
3817
3818 case Instruction::AtomicCmpXchg:
3819 return cast<AtomicCmpXchgInst>(I)->getPointerOperand();
3820
3821 case Instruction::AtomicRMW:
3822 return cast<AtomicRMWInst>(I)->getPointerOperand();
3823
3824 case Instruction::UDiv:
3825 case Instruction::SDiv:
3826 case Instruction::URem:
3827 case Instruction::SRem:
3828 return I->getOperand(1);
3829
3830 default:
3831 return nullptr;
3832 }
3833}
3834
3835bool llvm::isKnownNotFullPoison(const Instruction *PoisonI) {
3836 // We currently only look for uses of poison values within the same basic
3837 // block, as that makes it easier to guarantee that the uses will be
3838 // executed given that PoisonI is executed.
3839 //
3840 // FIXME: Expand this to consider uses beyond the same basic block. To do
3841 // this, look out for the distinction between post-dominance and strong
3842 // post-dominance.
3843 const BasicBlock *BB = PoisonI->getParent();
3844
3845 // Set of instructions that we have proved will yield poison if PoisonI
3846 // does.
3847 SmallSet<const Value *, 16> YieldsPoison;
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003848 SmallSet<const BasicBlock *, 4> Visited;
Jingyue Wu42f1d672015-07-28 18:22:40 +00003849 YieldsPoison.insert(PoisonI);
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003850 Visited.insert(PoisonI->getParent());
Jingyue Wu42f1d672015-07-28 18:22:40 +00003851
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003852 BasicBlock::const_iterator Begin = PoisonI->getIterator(), End = BB->end();
Jingyue Wu42f1d672015-07-28 18:22:40 +00003853
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003854 unsigned Iter = 0;
3855 while (Iter++ < MaxDepth) {
3856 for (auto &I : make_range(Begin, End)) {
3857 if (&I != PoisonI) {
3858 const Value *NotPoison = getGuaranteedNonFullPoisonOp(&I);
3859 if (NotPoison != nullptr && YieldsPoison.count(NotPoison))
3860 return true;
3861 if (!isGuaranteedToTransferExecutionToSuccessor(&I))
3862 return false;
3863 }
3864
3865 // Mark poison that propagates from I through uses of I.
3866 if (YieldsPoison.count(&I)) {
3867 for (const User *User : I.users()) {
3868 const Instruction *UserI = cast<Instruction>(User);
3869 if (propagatesFullPoison(UserI))
3870 YieldsPoison.insert(User);
3871 }
Jingyue Wu42f1d672015-07-28 18:22:40 +00003872 }
3873 }
Sanjoy Dasa6155b62016-04-22 17:41:06 +00003874
3875 if (auto *NextBB = BB->getSingleSuccessor()) {
3876 if (Visited.insert(NextBB).second) {
3877 BB = NextBB;
3878 Begin = BB->getFirstNonPHI()->getIterator();
3879 End = BB->end();
3880 continue;
3881 }
3882 }
3883
3884 break;
3885 };
Jingyue Wu42f1d672015-07-28 18:22:40 +00003886 return false;
3887}
3888
Pete Cooper35b00d52016-08-13 01:05:32 +00003889static bool isKnownNonNaN(const Value *V, FastMathFlags FMF) {
James Molloy134bec22015-08-11 09:12:57 +00003890 if (FMF.noNaNs())
3891 return true;
3892
3893 if (auto *C = dyn_cast<ConstantFP>(V))
3894 return !C->isNaN();
3895 return false;
3896}
3897
Pete Cooper35b00d52016-08-13 01:05:32 +00003898static bool isKnownNonZero(const Value *V) {
James Molloy134bec22015-08-11 09:12:57 +00003899 if (auto *C = dyn_cast<ConstantFP>(V))
3900 return !C->isZero();
3901 return false;
3902}
3903
Sanjay Patel819f0962016-11-13 19:30:19 +00003904/// Match non-obvious integer minimum and maximum sequences.
3905static SelectPatternResult matchMinMax(CmpInst::Predicate Pred,
3906 Value *CmpLHS, Value *CmpRHS,
3907 Value *TrueVal, Value *FalseVal,
3908 Value *&LHS, Value *&RHS) {
3909 if (Pred != CmpInst::ICMP_SGT && Pred != CmpInst::ICMP_SLT)
3910 return {SPF_UNKNOWN, SPNB_NA, false};
3911
Sanjay Patelcfcc42b2016-11-13 20:04:52 +00003912 // Z = X -nsw Y
3913 // (X >s Y) ? 0 : Z ==> (Z >s 0) ? 0 : Z ==> SMIN(Z, 0)
3914 // (X <s Y) ? 0 : Z ==> (Z <s 0) ? 0 : Z ==> SMAX(Z, 0)
3915 if (match(TrueVal, m_Zero()) &&
3916 match(FalseVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS)))) {
3917 LHS = TrueVal;
3918 RHS = FalseVal;
3919 return {Pred == CmpInst::ICMP_SGT ? SPF_SMIN : SPF_SMAX, SPNB_NA, false};
3920 }
3921
3922 // Z = X -nsw Y
3923 // (X >s Y) ? Z : 0 ==> (Z >s 0) ? Z : 0 ==> SMAX(Z, 0)
3924 // (X <s Y) ? Z : 0 ==> (Z <s 0) ? Z : 0 ==> SMIN(Z, 0)
3925 if (match(FalseVal, m_Zero()) &&
3926 match(TrueVal, m_NSWSub(m_Specific(CmpLHS), m_Specific(CmpRHS)))) {
3927 LHS = TrueVal;
3928 RHS = FalseVal;
3929 return {Pred == CmpInst::ICMP_SGT ? SPF_SMAX : SPF_SMIN, SPNB_NA, false};
3930 }
3931
Sanjay Patel819f0962016-11-13 19:30:19 +00003932 const APInt *C1;
3933 if (!match(CmpRHS, m_APInt(C1)))
3934 return {SPF_UNKNOWN, SPNB_NA, false};
3935
3936 // An unsigned min/max can be written with a signed compare.
3937 const APInt *C2;
3938 if ((CmpLHS == TrueVal && match(FalseVal, m_APInt(C2))) ||
3939 (CmpLHS == FalseVal && match(TrueVal, m_APInt(C2)))) {
3940 // Is the sign bit set?
3941 // (X <s 0) ? X : MAXVAL ==> (X >u MAXVAL) ? X : MAXVAL ==> UMAX
3942 // (X <s 0) ? MAXVAL : X ==> (X >u MAXVAL) ? MAXVAL : X ==> UMIN
3943 if (Pred == CmpInst::ICMP_SLT && *C1 == 0 && C2->isMaxSignedValue()) {
3944 LHS = TrueVal;
3945 RHS = FalseVal;
3946 return {CmpLHS == TrueVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
3947 }
3948
3949 // Is the sign bit clear?
3950 // (X >s -1) ? MINVAL : X ==> (X <u MINVAL) ? MINVAL : X ==> UMAX
3951 // (X >s -1) ? X : MINVAL ==> (X <u MINVAL) ? X : MINVAL ==> UMIN
3952 if (Pred == CmpInst::ICMP_SGT && C1->isAllOnesValue() &&
3953 C2->isMinSignedValue()) {
3954 LHS = TrueVal;
3955 RHS = FalseVal;
3956 return {CmpLHS == FalseVal ? SPF_UMAX : SPF_UMIN, SPNB_NA, false};
3957 }
3958 }
3959
3960 // Look through 'not' ops to find disguised signed min/max.
3961 // (X >s C) ? ~X : ~C ==> (~X <s ~C) ? ~X : ~C ==> SMIN(~X, ~C)
3962 // (X <s C) ? ~X : ~C ==> (~X >s ~C) ? ~X : ~C ==> SMAX(~X, ~C)
3963 if (match(TrueVal, m_Not(m_Specific(CmpLHS))) &&
3964 match(FalseVal, m_APInt(C2)) && ~(*C1) == *C2) {
3965 LHS = TrueVal;
3966 RHS = FalseVal;
3967 return {Pred == CmpInst::ICMP_SGT ? SPF_SMIN : SPF_SMAX, SPNB_NA, false};
3968 }
3969
3970 // (X >s C) ? ~C : ~X ==> (~X <s ~C) ? ~C : ~X ==> SMAX(~C, ~X)
3971 // (X <s C) ? ~C : ~X ==> (~X >s ~C) ? ~C : ~X ==> SMIN(~C, ~X)
3972 if (match(FalseVal, m_Not(m_Specific(CmpLHS))) &&
3973 match(TrueVal, m_APInt(C2)) && ~(*C1) == *C2) {
3974 LHS = TrueVal;
3975 RHS = FalseVal;
3976 return {Pred == CmpInst::ICMP_SGT ? SPF_SMAX : SPF_SMIN, SPNB_NA, false};
3977 }
3978
3979 return {SPF_UNKNOWN, SPNB_NA, false};
3980}
3981
James Molloy134bec22015-08-11 09:12:57 +00003982static SelectPatternResult matchSelectPattern(CmpInst::Predicate Pred,
3983 FastMathFlags FMF,
James Molloy270ef8c2015-05-15 16:04:50 +00003984 Value *CmpLHS, Value *CmpRHS,
3985 Value *TrueVal, Value *FalseVal,
3986 Value *&LHS, Value *&RHS) {
James Molloy71b91c22015-05-11 14:42:20 +00003987 LHS = CmpLHS;
3988 RHS = CmpRHS;
3989
James Molloy134bec22015-08-11 09:12:57 +00003990 // If the predicate is an "or-equal" (FP) predicate, then signed zeroes may
3991 // return inconsistent results between implementations.
3992 // (0.0 <= -0.0) ? 0.0 : -0.0 // Returns 0.0
3993 // minNum(0.0, -0.0) // May return -0.0 or 0.0 (IEEE 754-2008 5.3.1)
3994 // Therefore we behave conservatively and only proceed if at least one of the
3995 // operands is known to not be zero, or if we don't care about signed zeroes.
3996 switch (Pred) {
3997 default: break;
3998 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLE:
3999 case CmpInst::FCMP_UGE: case CmpInst::FCMP_ULE:
4000 if (!FMF.noSignedZeros() && !isKnownNonZero(CmpLHS) &&
4001 !isKnownNonZero(CmpRHS))
4002 return {SPF_UNKNOWN, SPNB_NA, false};
4003 }
4004
4005 SelectPatternNaNBehavior NaNBehavior = SPNB_NA;
4006 bool Ordered = false;
4007
4008 // When given one NaN and one non-NaN input:
4009 // - maxnum/minnum (C99 fmaxf()/fminf()) return the non-NaN input.
4010 // - A simple C99 (a < b ? a : b) construction will return 'b' (as the
4011 // ordered comparison fails), which could be NaN or non-NaN.
4012 // so here we discover exactly what NaN behavior is required/accepted.
4013 if (CmpInst::isFPPredicate(Pred)) {
4014 bool LHSSafe = isKnownNonNaN(CmpLHS, FMF);
4015 bool RHSSafe = isKnownNonNaN(CmpRHS, FMF);
4016
4017 if (LHSSafe && RHSSafe) {
4018 // Both operands are known non-NaN.
4019 NaNBehavior = SPNB_RETURNS_ANY;
4020 } else if (CmpInst::isOrdered(Pred)) {
4021 // An ordered comparison will return false when given a NaN, so it
4022 // returns the RHS.
4023 Ordered = true;
4024 if (LHSSafe)
James Molloy8990b062015-08-12 15:11:43 +00004025 // LHS is non-NaN, so if RHS is NaN then NaN will be returned.
James Molloy134bec22015-08-11 09:12:57 +00004026 NaNBehavior = SPNB_RETURNS_NAN;
4027 else if (RHSSafe)
4028 NaNBehavior = SPNB_RETURNS_OTHER;
4029 else
4030 // Completely unsafe.
4031 return {SPF_UNKNOWN, SPNB_NA, false};
4032 } else {
4033 Ordered = false;
4034 // An unordered comparison will return true when given a NaN, so it
4035 // returns the LHS.
4036 if (LHSSafe)
James Molloy8990b062015-08-12 15:11:43 +00004037 // LHS is non-NaN, so if RHS is NaN then non-NaN will be returned.
James Molloy134bec22015-08-11 09:12:57 +00004038 NaNBehavior = SPNB_RETURNS_OTHER;
4039 else if (RHSSafe)
4040 NaNBehavior = SPNB_RETURNS_NAN;
4041 else
4042 // Completely unsafe.
4043 return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004044 }
4045 }
4046
James Molloy71b91c22015-05-11 14:42:20 +00004047 if (TrueVal == CmpRHS && FalseVal == CmpLHS) {
James Molloy134bec22015-08-11 09:12:57 +00004048 std::swap(CmpLHS, CmpRHS);
4049 Pred = CmpInst::getSwappedPredicate(Pred);
4050 if (NaNBehavior == SPNB_RETURNS_NAN)
4051 NaNBehavior = SPNB_RETURNS_OTHER;
4052 else if (NaNBehavior == SPNB_RETURNS_OTHER)
4053 NaNBehavior = SPNB_RETURNS_NAN;
4054 Ordered = !Ordered;
4055 }
4056
4057 // ([if]cmp X, Y) ? X : Y
4058 if (TrueVal == CmpLHS && FalseVal == CmpRHS) {
James Molloy71b91c22015-05-11 14:42:20 +00004059 switch (Pred) {
James Molloy134bec22015-08-11 09:12:57 +00004060 default: return {SPF_UNKNOWN, SPNB_NA, false}; // Equality.
James Molloy71b91c22015-05-11 14:42:20 +00004061 case ICmpInst::ICMP_UGT:
James Molloy134bec22015-08-11 09:12:57 +00004062 case ICmpInst::ICMP_UGE: return {SPF_UMAX, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004063 case ICmpInst::ICMP_SGT:
James Molloy134bec22015-08-11 09:12:57 +00004064 case ICmpInst::ICMP_SGE: return {SPF_SMAX, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004065 case ICmpInst::ICMP_ULT:
James Molloy134bec22015-08-11 09:12:57 +00004066 case ICmpInst::ICMP_ULE: return {SPF_UMIN, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004067 case ICmpInst::ICMP_SLT:
James Molloy134bec22015-08-11 09:12:57 +00004068 case ICmpInst::ICMP_SLE: return {SPF_SMIN, SPNB_NA, false};
4069 case FCmpInst::FCMP_UGT:
4070 case FCmpInst::FCMP_UGE:
4071 case FCmpInst::FCMP_OGT:
4072 case FCmpInst::FCMP_OGE: return {SPF_FMAXNUM, NaNBehavior, Ordered};
4073 case FCmpInst::FCMP_ULT:
4074 case FCmpInst::FCMP_ULE:
4075 case FCmpInst::FCMP_OLT:
4076 case FCmpInst::FCMP_OLE: return {SPF_FMINNUM, NaNBehavior, Ordered};
James Molloy71b91c22015-05-11 14:42:20 +00004077 }
4078 }
4079
Sanjay Patele372aec2016-10-27 15:26:10 +00004080 const APInt *C1;
4081 if (match(CmpRHS, m_APInt(C1))) {
James Molloy71b91c22015-05-11 14:42:20 +00004082 if ((CmpLHS == TrueVal && match(FalseVal, m_Neg(m_Specific(CmpLHS)))) ||
4083 (CmpLHS == FalseVal && match(TrueVal, m_Neg(m_Specific(CmpLHS))))) {
4084
4085 // ABS(X) ==> (X >s 0) ? X : -X and (X >s -1) ? X : -X
4086 // NABS(X) ==> (X >s 0) ? -X : X and (X >s -1) ? -X : X
Sanjay Patele372aec2016-10-27 15:26:10 +00004087 if (Pred == ICmpInst::ICMP_SGT && (*C1 == 0 || C1->isAllOnesValue())) {
James Molloy134bec22015-08-11 09:12:57 +00004088 return {(CmpLHS == TrueVal) ? SPF_ABS : SPF_NABS, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004089 }
4090
4091 // ABS(X) ==> (X <s 0) ? -X : X and (X <s 1) ? -X : X
4092 // NABS(X) ==> (X <s 0) ? X : -X and (X <s 1) ? X : -X
Sanjay Patele372aec2016-10-27 15:26:10 +00004093 if (Pred == ICmpInst::ICMP_SLT && (*C1 == 0 || *C1 == 1)) {
James Molloy134bec22015-08-11 09:12:57 +00004094 return {(CmpLHS == FalseVal) ? SPF_ABS : SPF_NABS, SPNB_NA, false};
James Molloy71b91c22015-05-11 14:42:20 +00004095 }
4096 }
James Molloy71b91c22015-05-11 14:42:20 +00004097 }
4098
Sanjay Patel819f0962016-11-13 19:30:19 +00004099 return matchMinMax(Pred, CmpLHS, CmpRHS, TrueVal, FalseVal, LHS, RHS);
James Molloy71b91c22015-05-11 14:42:20 +00004100}
James Molloy270ef8c2015-05-15 16:04:50 +00004101
James Molloy569cea62015-09-02 17:25:25 +00004102static Value *lookThroughCast(CmpInst *CmpI, Value *V1, Value *V2,
4103 Instruction::CastOps *CastOp) {
James Molloy270ef8c2015-05-15 16:04:50 +00004104 CastInst *CI = dyn_cast<CastInst>(V1);
4105 Constant *C = dyn_cast<Constant>(V2);
James Molloy569cea62015-09-02 17:25:25 +00004106 if (!CI)
James Molloy270ef8c2015-05-15 16:04:50 +00004107 return nullptr;
4108 *CastOp = CI->getOpcode();
4109
David Majnemerd2a074b2016-04-29 18:40:34 +00004110 if (auto *CI2 = dyn_cast<CastInst>(V2)) {
James Molloy569cea62015-09-02 17:25:25 +00004111 // If V1 and V2 are both the same cast from the same type, we can look
4112 // through V1.
4113 if (CI2->getOpcode() == CI->getOpcode() &&
4114 CI2->getSrcTy() == CI->getSrcTy())
4115 return CI2->getOperand(0);
4116 return nullptr;
4117 } else if (!C) {
4118 return nullptr;
4119 }
4120
David Majnemerd2a074b2016-04-29 18:40:34 +00004121 Constant *CastedTo = nullptr;
4122
David Majnemer826e9832016-04-29 21:22:04 +00004123 if (isa<ZExtInst>(CI) && CmpI->isUnsigned())
4124 CastedTo = ConstantExpr::getTrunc(C, CI->getSrcTy());
4125
David Majnemerd2a074b2016-04-29 18:40:34 +00004126 if (isa<SExtInst>(CI) && CmpI->isSigned())
4127 CastedTo = ConstantExpr::getTrunc(C, CI->getSrcTy(), true);
4128
David Majnemer826e9832016-04-29 21:22:04 +00004129 if (isa<TruncInst>(CI))
4130 CastedTo = ConstantExpr::getIntegerCast(C, CI->getSrcTy(), CmpI->isSigned());
4131
4132 if (isa<FPTruncInst>(CI))
4133 CastedTo = ConstantExpr::getFPExtend(C, CI->getSrcTy(), true);
4134
4135 if (isa<FPExtInst>(CI))
4136 CastedTo = ConstantExpr::getFPTrunc(C, CI->getSrcTy(), true);
4137
David Majnemerd2a074b2016-04-29 18:40:34 +00004138 if (isa<FPToUIInst>(CI))
4139 CastedTo = ConstantExpr::getUIToFP(C, CI->getSrcTy(), true);
4140
4141 if (isa<FPToSIInst>(CI))
4142 CastedTo = ConstantExpr::getSIToFP(C, CI->getSrcTy(), true);
4143
4144 if (isa<UIToFPInst>(CI))
4145 CastedTo = ConstantExpr::getFPToUI(C, CI->getSrcTy(), true);
4146
4147 if (isa<SIToFPInst>(CI))
4148 CastedTo = ConstantExpr::getFPToSI(C, CI->getSrcTy(), true);
4149
4150 if (!CastedTo)
4151 return nullptr;
4152
4153 Constant *CastedBack =
4154 ConstantExpr::getCast(CI->getOpcode(), CastedTo, C->getType(), true);
4155 // Make sure the cast doesn't lose any information.
4156 if (CastedBack != C)
4157 return nullptr;
4158
4159 return CastedTo;
James Molloy270ef8c2015-05-15 16:04:50 +00004160}
4161
Sanjay Patele8dc0902016-05-23 17:57:54 +00004162SelectPatternResult llvm::matchSelectPattern(Value *V, Value *&LHS, Value *&RHS,
James Molloy270ef8c2015-05-15 16:04:50 +00004163 Instruction::CastOps *CastOp) {
4164 SelectInst *SI = dyn_cast<SelectInst>(V);
James Molloy134bec22015-08-11 09:12:57 +00004165 if (!SI) return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00004166
James Molloy134bec22015-08-11 09:12:57 +00004167 CmpInst *CmpI = dyn_cast<CmpInst>(SI->getCondition());
4168 if (!CmpI) return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00004169
James Molloy134bec22015-08-11 09:12:57 +00004170 CmpInst::Predicate Pred = CmpI->getPredicate();
James Molloy270ef8c2015-05-15 16:04:50 +00004171 Value *CmpLHS = CmpI->getOperand(0);
4172 Value *CmpRHS = CmpI->getOperand(1);
4173 Value *TrueVal = SI->getTrueValue();
4174 Value *FalseVal = SI->getFalseValue();
James Molloy134bec22015-08-11 09:12:57 +00004175 FastMathFlags FMF;
4176 if (isa<FPMathOperator>(CmpI))
4177 FMF = CmpI->getFastMathFlags();
James Molloy270ef8c2015-05-15 16:04:50 +00004178
4179 // Bail out early.
4180 if (CmpI->isEquality())
James Molloy134bec22015-08-11 09:12:57 +00004181 return {SPF_UNKNOWN, SPNB_NA, false};
James Molloy270ef8c2015-05-15 16:04:50 +00004182
4183 // Deal with type mismatches.
4184 if (CastOp && CmpLHS->getType() != TrueVal->getType()) {
James Molloy569cea62015-09-02 17:25:25 +00004185 if (Value *C = lookThroughCast(CmpI, TrueVal, FalseVal, CastOp))
James Molloy134bec22015-08-11 09:12:57 +00004186 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
James Molloy270ef8c2015-05-15 16:04:50 +00004187 cast<CastInst>(TrueVal)->getOperand(0), C,
4188 LHS, RHS);
James Molloy569cea62015-09-02 17:25:25 +00004189 if (Value *C = lookThroughCast(CmpI, FalseVal, TrueVal, CastOp))
James Molloy134bec22015-08-11 09:12:57 +00004190 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS,
James Molloy270ef8c2015-05-15 16:04:50 +00004191 C, cast<CastInst>(FalseVal)->getOperand(0),
4192 LHS, RHS);
4193 }
James Molloy134bec22015-08-11 09:12:57 +00004194 return ::matchSelectPattern(Pred, FMF, CmpLHS, CmpRHS, TrueVal, FalseVal,
James Molloy270ef8c2015-05-15 16:04:50 +00004195 LHS, RHS);
4196}
Sanjoy Dasa7e13782015-10-24 05:37:35 +00004197
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004198/// Return true if "icmp Pred LHS RHS" is always true.
Pete Cooper35b00d52016-08-13 01:05:32 +00004199static bool isTruePredicate(CmpInst::Predicate Pred,
4200 const Value *LHS, const Value *RHS,
Sanjoy Das55ea67c2015-11-06 19:01:08 +00004201 const DataLayout &DL, unsigned Depth,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004202 AssumptionCache *AC, const Instruction *CxtI,
4203 const DominatorTree *DT) {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004204 assert(!LHS->getType()->isVectorTy() && "TODO: extend to handle vectors!");
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004205 if (ICmpInst::isTrueWhenEqual(Pred) && LHS == RHS)
4206 return true;
4207
4208 switch (Pred) {
4209 default:
4210 return false;
4211
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004212 case CmpInst::ICMP_SLE: {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004213 const APInt *C;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004214
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004215 // LHS s<= LHS +_{nsw} C if C >= 0
Sanjoy Dasdc26df42015-11-11 00:16:41 +00004216 if (match(RHS, m_NSWAdd(m_Specific(LHS), m_APInt(C))))
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004217 return !C->isNegative();
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004218 return false;
4219 }
4220
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004221 case CmpInst::ICMP_ULE: {
Sanjoy Dasaf1400f2015-11-10 23:56:15 +00004222 const APInt *C;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004223
Sanjoy Dasdc26df42015-11-11 00:16:41 +00004224 // LHS u<= LHS +_{nuw} C for any C
4225 if (match(RHS, m_NUWAdd(m_Specific(LHS), m_APInt(C))))
Sanjoy Dasc01b4d22015-11-06 19:01:03 +00004226 return true;
Sanjoy Das92568102015-11-10 23:56:20 +00004227
4228 // Match A to (X +_{nuw} CA) and B to (X +_{nuw} CB)
Pete Cooper35b00d52016-08-13 01:05:32 +00004229 auto MatchNUWAddsToSameValue = [&](const Value *A, const Value *B,
4230 const Value *&X,
Sanjoy Das92568102015-11-10 23:56:20 +00004231 const APInt *&CA, const APInt *&CB) {
4232 if (match(A, m_NUWAdd(m_Value(X), m_APInt(CA))) &&
4233 match(B, m_NUWAdd(m_Specific(X), m_APInt(CB))))
4234 return true;
4235
4236 // If X & C == 0 then (X | C) == X +_{nuw} C
4237 if (match(A, m_Or(m_Value(X), m_APInt(CA))) &&
4238 match(B, m_Or(m_Specific(X), m_APInt(CB)))) {
4239 unsigned BitWidth = CA->getBitWidth();
4240 APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004241 computeKnownBits(X, KnownZero, KnownOne, DL, Depth + 1, AC, CxtI, DT);
Sanjoy Das92568102015-11-10 23:56:20 +00004242
4243 if ((KnownZero & *CA) == *CA && (KnownZero & *CB) == *CB)
4244 return true;
4245 }
4246
4247 return false;
4248 };
4249
Pete Cooper35b00d52016-08-13 01:05:32 +00004250 const Value *X;
Sanjoy Das92568102015-11-10 23:56:20 +00004251 const APInt *CLHS, *CRHS;
Sanjoy Dasdc26df42015-11-11 00:16:41 +00004252 if (MatchNUWAddsToSameValue(LHS, RHS, X, CLHS, CRHS))
4253 return CLHS->ule(*CRHS);
Sanjoy Das92568102015-11-10 23:56:20 +00004254
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004255 return false;
4256 }
4257 }
4258}
4259
4260/// Return true if "icmp Pred BLHS BRHS" is true whenever "icmp Pred
Chad Rosier41dd31f2016-04-20 19:15:26 +00004261/// ALHS ARHS" is true. Otherwise, return None.
4262static Optional<bool>
Pete Cooper35b00d52016-08-13 01:05:32 +00004263isImpliedCondOperands(CmpInst::Predicate Pred, const Value *ALHS,
4264 const Value *ARHS, const Value *BLHS,
4265 const Value *BRHS, const DataLayout &DL,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004266 unsigned Depth, AssumptionCache *AC,
4267 const Instruction *CxtI, const DominatorTree *DT) {
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004268 switch (Pred) {
4269 default:
Chad Rosier41dd31f2016-04-20 19:15:26 +00004270 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004271
4272 case CmpInst::ICMP_SLT:
4273 case CmpInst::ICMP_SLE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004274 if (isTruePredicate(CmpInst::ICMP_SLE, BLHS, ALHS, DL, Depth, AC, CxtI,
Chad Rosier41dd31f2016-04-20 19:15:26 +00004275 DT) &&
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004276 isTruePredicate(CmpInst::ICMP_SLE, ARHS, BRHS, DL, Depth, AC, CxtI, DT))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004277 return true;
4278 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004279
4280 case CmpInst::ICMP_ULT:
4281 case CmpInst::ICMP_ULE:
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004282 if (isTruePredicate(CmpInst::ICMP_ULE, BLHS, ALHS, DL, Depth, AC, CxtI,
4283 DT) &&
4284 isTruePredicate(CmpInst::ICMP_ULE, ARHS, BRHS, DL, Depth, AC, CxtI, DT))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004285 return true;
4286 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004287 }
4288}
4289
Chad Rosier226a7342016-05-05 17:41:19 +00004290/// Return true if the operands of the two compares match. IsSwappedOps is true
4291/// when the operands match, but are swapped.
Pete Cooper35b00d52016-08-13 01:05:32 +00004292static bool isMatchingOps(const Value *ALHS, const Value *ARHS,
4293 const Value *BLHS, const Value *BRHS,
Chad Rosier226a7342016-05-05 17:41:19 +00004294 bool &IsSwappedOps) {
4295
4296 bool IsMatchingOps = (ALHS == BLHS && ARHS == BRHS);
4297 IsSwappedOps = (ALHS == BRHS && ARHS == BLHS);
4298 return IsMatchingOps || IsSwappedOps;
4299}
4300
Chad Rosier41dd31f2016-04-20 19:15:26 +00004301/// Return true if "icmp1 APred ALHS ARHS" implies "icmp2 BPred BLHS BRHS" is
4302/// true. Return false if "icmp1 APred ALHS ARHS" implies "icmp2 BPred BLHS
4303/// BRHS" is false. Otherwise, return None if we can't infer anything.
4304static Optional<bool> isImpliedCondMatchingOperands(CmpInst::Predicate APred,
Pete Cooper35b00d52016-08-13 01:05:32 +00004305 const Value *ALHS,
4306 const Value *ARHS,
Chad Rosier41dd31f2016-04-20 19:15:26 +00004307 CmpInst::Predicate BPred,
Pete Cooper35b00d52016-08-13 01:05:32 +00004308 const Value *BLHS,
4309 const Value *BRHS,
Chad Rosier226a7342016-05-05 17:41:19 +00004310 bool IsSwappedOps) {
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004311 // Canonicalize the operands so they're matching.
4312 if (IsSwappedOps) {
4313 std::swap(BLHS, BRHS);
4314 BPred = ICmpInst::getSwappedPredicate(BPred);
4315 }
Chad Rosier99bc4802016-04-21 16:18:02 +00004316 if (CmpInst::isImpliedTrueByMatchingCmp(APred, BPred))
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004317 return true;
Chad Rosier99bc4802016-04-21 16:18:02 +00004318 if (CmpInst::isImpliedFalseByMatchingCmp(APred, BPred))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004319 return false;
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004320
Chad Rosier41dd31f2016-04-20 19:15:26 +00004321 return None;
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004322}
4323
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004324/// Return true if "icmp1 APred ALHS C1" implies "icmp2 BPred BLHS C2" is
4325/// true. Return false if "icmp1 APred ALHS C1" implies "icmp2 BPred BLHS
4326/// C2" is false. Otherwise, return None if we can't infer anything.
4327static Optional<bool>
Pete Cooper35b00d52016-08-13 01:05:32 +00004328isImpliedCondMatchingImmOperands(CmpInst::Predicate APred, const Value *ALHS,
4329 const ConstantInt *C1,
4330 CmpInst::Predicate BPred,
4331 const Value *BLHS, const ConstantInt *C2) {
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004332 assert(ALHS == BLHS && "LHS operands must match.");
4333 ConstantRange DomCR =
4334 ConstantRange::makeExactICmpRegion(APred, C1->getValue());
4335 ConstantRange CR =
4336 ConstantRange::makeAllowedICmpRegion(BPred, C2->getValue());
4337 ConstantRange Intersection = DomCR.intersectWith(CR);
4338 ConstantRange Difference = DomCR.difference(CR);
4339 if (Intersection.isEmptySet())
4340 return false;
4341 if (Difference.isEmptySet())
4342 return true;
4343 return None;
4344}
4345
Pete Cooper35b00d52016-08-13 01:05:32 +00004346Optional<bool> llvm::isImpliedCondition(const Value *LHS, const Value *RHS,
Chad Rosiere2cbd132016-04-25 17:23:36 +00004347 const DataLayout &DL, bool InvertAPred,
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004348 unsigned Depth, AssumptionCache *AC,
4349 const Instruction *CxtI,
Chad Rosier41dd31f2016-04-20 19:15:26 +00004350 const DominatorTree *DT) {
Chad Rosiercd62bf52016-04-29 21:12:31 +00004351 // A mismatch occurs when we compare a scalar cmp to a vector cmp, for example.
4352 if (LHS->getType() != RHS->getType())
4353 return None;
4354
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004355 Type *OpTy = LHS->getType();
4356 assert(OpTy->getScalarType()->isIntegerTy(1));
4357
4358 // LHS ==> RHS by definition
Chad Rosiere2cbd132016-04-25 17:23:36 +00004359 if (!InvertAPred && LHS == RHS)
Chad Rosierb7dfbb42016-04-19 17:19:14 +00004360 return true;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004361
4362 if (OpTy->isVectorTy())
4363 // TODO: extending the code below to handle vectors
Chad Rosier41dd31f2016-04-20 19:15:26 +00004364 return None;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004365 assert(OpTy->isIntegerTy(1) && "implied by above");
4366
4367 ICmpInst::Predicate APred, BPred;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004368 Value *ALHS, *ARHS;
4369 Value *BLHS, *BRHS;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004370
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004371 if (!match(LHS, m_ICmp(APred, m_Value(ALHS), m_Value(ARHS))) ||
4372 !match(RHS, m_ICmp(BPred, m_Value(BLHS), m_Value(BRHS))))
Chad Rosier41dd31f2016-04-20 19:15:26 +00004373 return None;
Sanjoy Das9349dcc2015-11-06 19:00:57 +00004374
Chad Rosiere2cbd132016-04-25 17:23:36 +00004375 if (InvertAPred)
4376 APred = CmpInst::getInversePredicate(APred);
4377
Chad Rosier226a7342016-05-05 17:41:19 +00004378 // Can we infer anything when the two compares have matching operands?
4379 bool IsSwappedOps;
4380 if (isMatchingOps(ALHS, ARHS, BLHS, BRHS, IsSwappedOps)) {
4381 if (Optional<bool> Implication = isImpliedCondMatchingOperands(
4382 APred, ALHS, ARHS, BPred, BLHS, BRHS, IsSwappedOps))
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004383 return Implication;
Chad Rosier226a7342016-05-05 17:41:19 +00004384 // No amount of additional analysis will infer the second condition, so
4385 // early exit.
4386 return None;
4387 }
4388
4389 // Can we infer anything when the LHS operands match and the RHS operands are
4390 // constants (not necessarily matching)?
4391 if (ALHS == BLHS && isa<ConstantInt>(ARHS) && isa<ConstantInt>(BRHS)) {
4392 if (Optional<bool> Implication = isImpliedCondMatchingImmOperands(
4393 APred, ALHS, cast<ConstantInt>(ARHS), BPred, BLHS,
4394 cast<ConstantInt>(BRHS)))
4395 return Implication;
4396 // No amount of additional analysis will infer the second condition, so
4397 // early exit.
4398 return None;
Chad Rosier25cfb7d2016-05-05 15:39:18 +00004399 }
4400
Chad Rosier41dd31f2016-04-20 19:15:26 +00004401 if (APred == BPred)
Daniel Jasperaec2fa32016-12-19 08:22:17 +00004402 return isImpliedCondOperands(APred, ALHS, ARHS, BLHS, BRHS, DL, Depth, AC,
4403 CxtI, DT);
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004404
Chad Rosier41dd31f2016-04-20 19:15:26 +00004405 return None;
Sanjoy Das3ef1e682015-10-28 03:20:19 +00004406}