blob: 6409b85b1a0779acc68bb5b0e44e44163a587b24 [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"
Chandler Carruthed0881b2012-12-03 16:50:05 +000016#include "llvm/ADT/SmallPtrSet.h"
Dan Gohman949ab782010-12-15 20:10:26 +000017#include "llvm/Analysis/InstructionSimplify.h"
Benjamin Kramerfd4777c2013-09-24 16:37:51 +000018#include "llvm/Analysis/MemoryBuiltins.h"
Nick Lewyckyec373542014-05-20 05:13:21 +000019#include "llvm/IR/CallSite.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000020#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000021#include "llvm/IR/Constants.h"
22#include "llvm/IR/DataLayout.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000023#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/GlobalAlias.h"
25#include "llvm/IR/GlobalVariable.h"
26#include "llvm/IR/Instructions.h"
27#include "llvm/IR/IntrinsicInst.h"
28#include "llvm/IR/LLVMContext.h"
29#include "llvm/IR/Metadata.h"
30#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000031#include "llvm/IR/PatternMatch.h"
Matt Arsenaultf1a7e622014-07-15 01:55:03 +000032#include "llvm/Support/Debug.h"
Chris Lattner965c7692008-06-02 01:18:21 +000033#include "llvm/Support/MathExtras.h"
Chris Lattner64496902008-06-04 04:46:14 +000034#include <cstring>
Chris Lattner965c7692008-06-02 01:18:21 +000035using namespace llvm;
Duncan Sandsd3951082011-01-25 09:38:29 +000036using namespace llvm::PatternMatch;
37
38const unsigned MaxDepth = 6;
39
40/// getBitWidth - Returns the bitwidth of the given scalar or pointer type (if
41/// unknown returns 0). For vector types, returns the element type's bitwidth.
Micah Villmowcdfe20b2012-10-08 16:38:25 +000042static unsigned getBitWidth(Type *Ty, const DataLayout *TD) {
Duncan Sandsd3951082011-01-25 09:38:29 +000043 if (unsigned BitWidth = Ty->getScalarSizeInBits())
44 return BitWidth;
Matt Arsenaultf55e5e72013-08-10 17:34:08 +000045
46 return TD ? TD->getPointerTypeSizeInBits(Ty) : 0;
Duncan Sandsd3951082011-01-25 09:38:29 +000047}
Chris Lattner965c7692008-06-02 01:18:21 +000048
Jay Foada0653a32014-05-14 21:14:37 +000049static void computeKnownBitsAddSub(bool Add, Value *Op0, Value *Op1, bool NSW,
50 APInt &KnownZero, APInt &KnownOne,
51 APInt &KnownZero2, APInt &KnownOne2,
52 const DataLayout *TD, unsigned Depth) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +000053 unsigned BitWidth = KnownZero.getBitWidth();
Nick Lewyckyfea3e002012-03-09 09:23:50 +000054
David Majnemer97ddca32014-08-22 00:40:43 +000055 // If an initial sequence of bits in the result is not needed, the
56 // corresponding bits in the operands are not needed.
Nick Lewyckyfea3e002012-03-09 09:23:50 +000057 APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +000058 llvm::computeKnownBits(Op0, LHSKnownZero, LHSKnownOne, TD, Depth+1);
Jay Foada0653a32014-05-14 21:14:37 +000059 llvm::computeKnownBits(Op1, KnownZero2, KnownOne2, TD, Depth+1);
Nick Lewyckyfea3e002012-03-09 09:23:50 +000060
David Majnemer97ddca32014-08-22 00:40:43 +000061 // Carry in a 1 for a subtract, rather than a 0.
62 APInt CarryIn(BitWidth, 0);
63 if (!Add) {
64 // Sum = LHS + ~RHS + 1
65 std::swap(KnownZero2, KnownOne2);
66 CarryIn.setBit(0);
Nick Lewyckyfea3e002012-03-09 09:23:50 +000067 }
68
David Majnemer97ddca32014-08-22 00:40:43 +000069 APInt PossibleSumZero = ~LHSKnownZero + ~KnownZero2 + CarryIn;
70 APInt PossibleSumOne = LHSKnownOne + KnownOne2 + CarryIn;
71
72 // Compute known bits of the carry.
73 APInt CarryKnownZero = ~(PossibleSumZero ^ LHSKnownZero ^ KnownZero2);
74 APInt CarryKnownOne = PossibleSumOne ^ LHSKnownOne ^ KnownOne2;
75
76 // Compute set of known bits (where all three relevant bits are known).
77 APInt LHSKnown = LHSKnownZero | LHSKnownOne;
78 APInt RHSKnown = KnownZero2 | KnownOne2;
79 APInt CarryKnown = CarryKnownZero | CarryKnownOne;
80 APInt Known = LHSKnown & RHSKnown & CarryKnown;
81
82 assert((PossibleSumZero & Known) == (PossibleSumOne & Known) &&
83 "known bits of sum differ");
84
85 // Compute known bits of the result.
86 KnownZero = ~PossibleSumOne & Known;
87 KnownOne = PossibleSumOne & Known;
88
Nick Lewyckyfea3e002012-03-09 09:23:50 +000089 // Are we still trying to solve for the sign bit?
David Majnemer97ddca32014-08-22 00:40:43 +000090 if (!Known.isNegative()) {
Nick Lewyckyfea3e002012-03-09 09:23:50 +000091 if (NSW) {
David Majnemer97ddca32014-08-22 00:40:43 +000092 // Adding two non-negative numbers, or subtracting a negative number from
93 // a non-negative one, can't wrap into negative.
94 if (LHSKnownZero.isNegative() && KnownZero2.isNegative())
95 KnownZero |= APInt::getSignBit(BitWidth);
96 // Adding two negative numbers, or subtracting a non-negative number from
97 // a negative one, can't wrap into non-negative.
98 else if (LHSKnownOne.isNegative() && KnownOne2.isNegative())
99 KnownOne |= APInt::getSignBit(BitWidth);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000100 }
101 }
102}
103
Jay Foada0653a32014-05-14 21:14:37 +0000104static void computeKnownBitsMul(Value *Op0, Value *Op1, bool NSW,
105 APInt &KnownZero, APInt &KnownOne,
106 APInt &KnownZero2, APInt &KnownOne2,
107 const DataLayout *TD, unsigned Depth) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000108 unsigned BitWidth = KnownZero.getBitWidth();
Jay Foada0653a32014-05-14 21:14:37 +0000109 computeKnownBits(Op1, KnownZero, KnownOne, TD, Depth+1);
110 computeKnownBits(Op0, KnownZero2, KnownOne2, TD, Depth+1);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000111
112 bool isKnownNegative = false;
113 bool isKnownNonNegative = false;
114 // If the multiplication is known not to overflow, compute the sign bit.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000115 if (NSW) {
Nick Lewyckyfa306072012-03-18 23:28:48 +0000116 if (Op0 == Op1) {
117 // The product of a number with itself is non-negative.
118 isKnownNonNegative = true;
119 } else {
120 bool isKnownNonNegativeOp1 = KnownZero.isNegative();
121 bool isKnownNonNegativeOp0 = KnownZero2.isNegative();
122 bool isKnownNegativeOp1 = KnownOne.isNegative();
123 bool isKnownNegativeOp0 = KnownOne2.isNegative();
124 // The product of two numbers with the same sign is non-negative.
125 isKnownNonNegative = (isKnownNegativeOp1 && isKnownNegativeOp0) ||
126 (isKnownNonNegativeOp1 && isKnownNonNegativeOp0);
127 // The product of a negative number and a non-negative number is either
128 // negative or zero.
129 if (!isKnownNonNegative)
130 isKnownNegative = (isKnownNegativeOp1 && isKnownNonNegativeOp0 &&
131 isKnownNonZero(Op0, TD, Depth)) ||
132 (isKnownNegativeOp0 && isKnownNonNegativeOp1 &&
133 isKnownNonZero(Op1, TD, Depth));
134 }
135 }
136
137 // If low bits are zero in either operand, output low known-0 bits.
138 // Also compute a conserative estimate for high known-0 bits.
139 // More trickiness is possible, but this is sufficient for the
140 // interesting case of alignment computation.
141 KnownOne.clearAllBits();
142 unsigned TrailZ = KnownZero.countTrailingOnes() +
143 KnownZero2.countTrailingOnes();
144 unsigned LeadZ = std::max(KnownZero.countLeadingOnes() +
145 KnownZero2.countLeadingOnes(),
146 BitWidth) - BitWidth;
147
148 TrailZ = std::min(TrailZ, BitWidth);
149 LeadZ = std::min(LeadZ, BitWidth);
150 KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ) |
151 APInt::getHighBitsSet(BitWidth, LeadZ);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000152
153 // Only make use of no-wrap flags if we failed to compute the sign bit
154 // directly. This matters if the multiplication always overflows, in
155 // which case we prefer to follow the result of the direct computation,
156 // though as the program is invoking undefined behaviour we can choose
157 // whatever we like here.
158 if (isKnownNonNegative && !KnownOne.isNegative())
159 KnownZero.setBit(BitWidth - 1);
160 else if (isKnownNegative && !KnownZero.isNegative())
161 KnownOne.setBit(BitWidth - 1);
162}
163
Jingyue Wu37fcb592014-06-19 16:50:16 +0000164void llvm::computeKnownBitsFromRangeMetadata(const MDNode &Ranges,
165 APInt &KnownZero) {
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000166 unsigned BitWidth = KnownZero.getBitWidth();
Rafael Espindola53190532012-03-30 15:52:11 +0000167 unsigned NumRanges = Ranges.getNumOperands() / 2;
168 assert(NumRanges >= 1);
169
170 // Use the high end of the ranges to find leading zeros.
171 unsigned MinLeadingZeros = BitWidth;
172 for (unsigned i = 0; i < NumRanges; ++i) {
173 ConstantInt *Lower = cast<ConstantInt>(Ranges.getOperand(2*i + 0));
174 ConstantInt *Upper = cast<ConstantInt>(Ranges.getOperand(2*i + 1));
175 ConstantRange Range(Lower->getValue(), Upper->getValue());
176 if (Range.isWrappedSet())
177 MinLeadingZeros = 0; // -1 has no zeros
178 unsigned LeadingZeros = (Upper->getValue() - 1).countLeadingZeros();
179 MinLeadingZeros = std::min(LeadingZeros, MinLeadingZeros);
180 }
181
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000182 KnownZero = APInt::getHighBitsSet(BitWidth, MinLeadingZeros);
Rafael Espindola53190532012-03-30 15:52:11 +0000183}
Jay Foad5a29c362014-05-15 12:12:55 +0000184
Jay Foada0653a32014-05-14 21:14:37 +0000185/// Determine which bits of V are known to be either zero or one and return
186/// them in the KnownZero/KnownOne bit sets.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000187///
Chris Lattner965c7692008-06-02 01:18:21 +0000188/// NOTE: we cannot consider 'undef' to be "IsZero" here. The problem is that
189/// we cannot optimize based on the assumption that it is zero without changing
190/// it to be an explicit zero. If we don't change it to zero, other code could
191/// optimized based on the contradictory assumption that it is non-zero.
192/// Because instcombine aggressively folds operations with undef args anyway,
193/// this won't lose us code quality.
Chris Lattner4bc28252009-09-08 00:06:16 +0000194///
195/// This function is defined on values with integer type, values with pointer
196/// type (but only if TD is non-null), and vectors of integers. In the case
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000197/// where V is a vector, known zero, and known one values are the
Chris Lattner4bc28252009-09-08 00:06:16 +0000198/// same width as the vector element, and the bit is set only if it is true
199/// for all of the elements in the vector.
Jay Foada0653a32014-05-14 21:14:37 +0000200void llvm::computeKnownBits(Value *V, APInt &KnownZero, APInt &KnownOne,
201 const DataLayout *TD, unsigned Depth) {
Chris Lattner965c7692008-06-02 01:18:21 +0000202 assert(V && "No Value?");
Dan Gohmanbf0002e2009-05-21 02:28:33 +0000203 assert(Depth <= MaxDepth && "Limit Search Depth");
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000204 unsigned BitWidth = KnownZero.getBitWidth();
205
Nadav Rotem3924cb02011-12-05 06:29:09 +0000206 assert((V->getType()->isIntOrIntVectorTy() ||
207 V->getType()->getScalarType()->isPointerTy()) &&
208 "Not integer or pointer type!");
Dan Gohman7ccc52f2009-06-15 22:12:54 +0000209 assert((!TD ||
210 TD->getTypeSizeInBits(V->getType()->getScalarType()) == BitWidth) &&
Duncan Sands9dff9be2010-02-15 16:12:20 +0000211 (!V->getType()->isIntOrIntVectorTy() ||
Dan Gohman7ccc52f2009-06-15 22:12:54 +0000212 V->getType()->getScalarSizeInBits() == BitWidth) &&
Nadav Rotem3924cb02011-12-05 06:29:09 +0000213 KnownZero.getBitWidth() == BitWidth &&
Chris Lattner965c7692008-06-02 01:18:21 +0000214 KnownOne.getBitWidth() == BitWidth &&
Jay Foade48d9e82014-05-14 08:00:07 +0000215 "V, KnownOne and KnownZero should have same BitWidth");
Chris Lattner965c7692008-06-02 01:18:21 +0000216
217 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
218 // We know all of the bits for a constant!
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000219 KnownOne = CI->getValue();
220 KnownZero = ~KnownOne;
Chris Lattner965c7692008-06-02 01:18:21 +0000221 return;
222 }
Dan Gohman7ccc52f2009-06-15 22:12:54 +0000223 // Null and aggregate-zero are all-zeros.
224 if (isa<ConstantPointerNull>(V) ||
225 isa<ConstantAggregateZero>(V)) {
Jay Foad25a5e4c2010-12-01 08:53:58 +0000226 KnownOne.clearAllBits();
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000227 KnownZero = APInt::getAllOnesValue(BitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +0000228 return;
229 }
Dan Gohman7ccc52f2009-06-15 22:12:54 +0000230 // Handle a constant vector by taking the intersection of the known bits of
Chris Lattner8213c8a2012-02-06 21:56:39 +0000231 // each element. There is no real need to handle ConstantVector here, because
232 // we don't handle undef in any particularly useful way.
Chris Lattnerf7eb5432012-01-24 07:54:10 +0000233 if (ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V)) {
234 // We know that CDS must be a vector of integers. Take the intersection of
235 // each element.
236 KnownZero.setAllBits(); KnownOne.setAllBits();
237 APInt Elt(KnownZero.getBitWidth(), 0);
Chris Lattner9be59592012-01-25 01:27:20 +0000238 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
Chris Lattnerf7eb5432012-01-24 07:54:10 +0000239 Elt = CDS->getElementAsInteger(i);
240 KnownZero &= ~Elt;
Craig Topper1bef2c82012-12-22 19:15:35 +0000241 KnownOne &= Elt;
Chris Lattnerf7eb5432012-01-24 07:54:10 +0000242 }
243 return;
244 }
Craig Topper1bef2c82012-12-22 19:15:35 +0000245
Chris Lattner965c7692008-06-02 01:18:21 +0000246 // The address of an aligned GlobalValue has trailing zeros.
247 if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
248 unsigned Align = GV->getAlignment();
Nick Lewycky1d57ee32012-03-07 02:27:53 +0000249 if (Align == 0 && TD) {
Eli Friedmane7ab1a22011-11-28 22:48:22 +0000250 if (GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV)) {
251 Type *ObjectType = GVar->getType()->getElementType();
Nick Lewycky1d57ee32012-03-07 02:27:53 +0000252 if (ObjectType->isSized()) {
253 // If the object is defined in the current Module, we'll be giving
254 // it the preferred alignment. Otherwise, we have to assume that it
255 // may only have the minimum ABI alignment.
256 if (!GVar->isDeclaration() && !GVar->isWeakForLinker())
257 Align = TD->getPreferredAlignment(GVar);
258 else
259 Align = TD->getABITypeAlignment(ObjectType);
260 }
Eli Friedmane7ab1a22011-11-28 22:48:22 +0000261 }
Dan Gohmana72f8562009-08-11 15:50:03 +0000262 }
Chris Lattner965c7692008-06-02 01:18:21 +0000263 if (Align > 0)
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000264 KnownZero = APInt::getLowBitsSet(BitWidth,
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +0000265 countTrailingZeros(Align));
Chris Lattner965c7692008-06-02 01:18:21 +0000266 else
Jay Foad25a5e4c2010-12-01 08:53:58 +0000267 KnownZero.clearAllBits();
268 KnownOne.clearAllBits();
Chris Lattner965c7692008-06-02 01:18:21 +0000269 return;
270 }
Dan Gohman94262db2009-09-15 16:14:44 +0000271 // A weak GlobalAlias is totally unknown. A non-weak GlobalAlias has
272 // the bits of its aliasee.
273 if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
274 if (GA->mayBeOverridden()) {
Jay Foad25a5e4c2010-12-01 08:53:58 +0000275 KnownZero.clearAllBits(); KnownOne.clearAllBits();
Dan Gohman94262db2009-09-15 16:14:44 +0000276 } else {
Jay Foada0653a32014-05-14 21:14:37 +0000277 computeKnownBits(GA->getAliasee(), KnownZero, KnownOne, TD, Depth+1);
Dan Gohman94262db2009-09-15 16:14:44 +0000278 }
279 return;
280 }
Craig Topper1bef2c82012-12-22 19:15:35 +0000281
Chris Lattner83791ce2011-05-23 00:03:39 +0000282 if (Argument *A = dyn_cast<Argument>(V)) {
Hal Finkelccc70902014-07-22 16:58:55 +0000283 unsigned Align = A->getType()->isPointerTy() ? A->getParamAlignment() : 0;
Duncan Sands271ea6c2012-10-04 13:36:31 +0000284
Hal Finkelccc70902014-07-22 16:58:55 +0000285 if (!Align && TD && A->hasStructRetAttr()) {
Duncan Sands271ea6c2012-10-04 13:36:31 +0000286 // An sret parameter has at least the ABI alignment of the return type.
287 Type *EltTy = cast<PointerType>(A->getType())->getElementType();
288 if (EltTy->isSized())
289 Align = TD->getABITypeAlignment(EltTy);
290 }
291
292 if (Align)
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +0000293 KnownZero = APInt::getLowBitsSet(BitWidth, countTrailingZeros(Align));
Chris Lattner83791ce2011-05-23 00:03:39 +0000294 return;
295 }
Chris Lattner965c7692008-06-02 01:18:21 +0000296
Chris Lattner83791ce2011-05-23 00:03:39 +0000297 // Start out not knowing anything.
298 KnownZero.clearAllBits(); KnownOne.clearAllBits();
Chris Lattner965c7692008-06-02 01:18:21 +0000299
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000300 if (Depth == MaxDepth)
Chris Lattner965c7692008-06-02 01:18:21 +0000301 return; // Limit search depth.
302
Dan Gohman80ca01c2009-07-17 20:47:02 +0000303 Operator *I = dyn_cast<Operator>(V);
Chris Lattner965c7692008-06-02 01:18:21 +0000304 if (!I) return;
305
306 APInt KnownZero2(KnownZero), KnownOne2(KnownOne);
Dan Gohman80ca01c2009-07-17 20:47:02 +0000307 switch (I->getOpcode()) {
Chris Lattner965c7692008-06-02 01:18:21 +0000308 default: break;
Rafael Espindola53190532012-03-30 15:52:11 +0000309 case Instruction::Load:
310 if (MDNode *MD = cast<LoadInst>(I)->getMetadata(LLVMContext::MD_range))
Jingyue Wu37fcb592014-06-19 16:50:16 +0000311 computeKnownBitsFromRangeMetadata(*MD, KnownZero);
Jay Foad5a29c362014-05-15 12:12:55 +0000312 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000313 case Instruction::And: {
314 // If either the LHS or the RHS are Zero, the result is zero.
Jay Foada0653a32014-05-14 21:14:37 +0000315 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
316 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
Craig Topper1bef2c82012-12-22 19:15:35 +0000317
Chris Lattner965c7692008-06-02 01:18:21 +0000318 // Output known-1 bits are only known if set in both the LHS & RHS.
319 KnownOne &= KnownOne2;
320 // Output known-0 are known to be clear if zero in either the LHS | RHS.
321 KnownZero |= KnownZero2;
Jay Foad5a29c362014-05-15 12:12:55 +0000322 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000323 }
324 case Instruction::Or: {
Jay Foada0653a32014-05-14 21:14:37 +0000325 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
326 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
Craig Topper1bef2c82012-12-22 19:15:35 +0000327
Chris Lattner965c7692008-06-02 01:18:21 +0000328 // Output known-0 bits are only known if clear in both the LHS & RHS.
329 KnownZero &= KnownZero2;
330 // Output known-1 are known to be set if set in either the LHS | RHS.
331 KnownOne |= KnownOne2;
Jay Foad5a29c362014-05-15 12:12:55 +0000332 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000333 }
334 case Instruction::Xor: {
Jay Foada0653a32014-05-14 21:14:37 +0000335 computeKnownBits(I->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
336 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
Craig Topper1bef2c82012-12-22 19:15:35 +0000337
Chris Lattner965c7692008-06-02 01:18:21 +0000338 // Output known-0 bits are known if clear or set in both the LHS & RHS.
339 APInt KnownZeroOut = (KnownZero & KnownZero2) | (KnownOne & KnownOne2);
340 // Output known-1 are known to be set if set in only one of the LHS, RHS.
341 KnownOne = (KnownZero & KnownOne2) | (KnownOne & KnownZero2);
342 KnownZero = KnownZeroOut;
Jay Foad5a29c362014-05-15 12:12:55 +0000343 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000344 }
345 case Instruction::Mul: {
Nick Lewyckyfa306072012-03-18 23:28:48 +0000346 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Jay Foada0653a32014-05-14 21:14:37 +0000347 computeKnownBitsMul(I->getOperand(0), I->getOperand(1), NSW,
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000348 KnownZero, KnownOne, KnownZero2, KnownOne2, TD, Depth);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000349 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000350 }
351 case Instruction::UDiv: {
352 // For the purposes of computing leading zeros we can conservatively
353 // treat a udiv as a logical right shift by the power of 2 known to
354 // be less than the denominator.
Jay Foada0653a32014-05-14 21:14:37 +0000355 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000356 unsigned LeadZ = KnownZero2.countLeadingOnes();
357
Jay Foad25a5e4c2010-12-01 08:53:58 +0000358 KnownOne2.clearAllBits();
359 KnownZero2.clearAllBits();
Jay Foada0653a32014-05-14 21:14:37 +0000360 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000361 unsigned RHSUnknownLeadingOnes = KnownOne2.countLeadingZeros();
362 if (RHSUnknownLeadingOnes != BitWidth)
363 LeadZ = std::min(BitWidth,
364 LeadZ + BitWidth - RHSUnknownLeadingOnes - 1);
365
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000366 KnownZero = APInt::getHighBitsSet(BitWidth, LeadZ);
Jay Foad5a29c362014-05-15 12:12:55 +0000367 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000368 }
369 case Instruction::Select:
Jay Foada0653a32014-05-14 21:14:37 +0000370 computeKnownBits(I->getOperand(2), KnownZero, KnownOne, TD, Depth+1);
371 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, TD,
Chris Lattner965c7692008-06-02 01:18:21 +0000372 Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000373
374 // Only known if known in both the LHS and RHS.
375 KnownOne &= KnownOne2;
376 KnownZero &= KnownZero2;
Jay Foad5a29c362014-05-15 12:12:55 +0000377 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000378 case Instruction::FPTrunc:
379 case Instruction::FPExt:
380 case Instruction::FPToUI:
381 case Instruction::FPToSI:
382 case Instruction::SIToFP:
383 case Instruction::UIToFP:
Jay Foad5a29c362014-05-15 12:12:55 +0000384 break; // Can't work with floating point.
Chris Lattner965c7692008-06-02 01:18:21 +0000385 case Instruction::PtrToInt:
386 case Instruction::IntToPtr:
Matt Arsenaultf1a7e622014-07-15 01:55:03 +0000387 case Instruction::AddrSpaceCast: // Pointers could be different sizes.
Chris Lattner965c7692008-06-02 01:18:21 +0000388 // We can't handle these if we don't know the pointer size.
Jay Foad5a29c362014-05-15 12:12:55 +0000389 if (!TD) break;
Chris Lattner965c7692008-06-02 01:18:21 +0000390 // FALL THROUGH and handle them the same as zext/trunc.
391 case Instruction::ZExt:
392 case Instruction::Trunc: {
Chris Lattner229907c2011-07-18 04:54:35 +0000393 Type *SrcTy = I->getOperand(0)->getType();
Nadav Rotem15198e92012-10-26 17:17:05 +0000394
Chris Lattner0cdbc7a2009-09-08 00:13:52 +0000395 unsigned SrcBitWidth;
Chris Lattner965c7692008-06-02 01:18:21 +0000396 // Note that we handle pointer operands here because of inttoptr/ptrtoint
397 // which fall through here.
Nadav Rotem11350aa2012-12-19 20:47:04 +0000398 if(TD) {
399 SrcBitWidth = TD->getTypeSizeInBits(SrcTy->getScalarType());
400 } else {
401 SrcBitWidth = SrcTy->getScalarSizeInBits();
Jay Foad5a29c362014-05-15 12:12:55 +0000402 if (!SrcBitWidth) break;
Nadav Rotem11350aa2012-12-19 20:47:04 +0000403 }
Nadav Rotem15198e92012-10-26 17:17:05 +0000404
405 assert(SrcBitWidth && "SrcBitWidth can't be zero");
Jay Foad583abbc2010-12-07 08:25:19 +0000406 KnownZero = KnownZero.zextOrTrunc(SrcBitWidth);
407 KnownOne = KnownOne.zextOrTrunc(SrcBitWidth);
Jay Foada0653a32014-05-14 21:14:37 +0000408 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
Jay Foad583abbc2010-12-07 08:25:19 +0000409 KnownZero = KnownZero.zextOrTrunc(BitWidth);
410 KnownOne = KnownOne.zextOrTrunc(BitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +0000411 // Any top bits are known to be zero.
412 if (BitWidth > SrcBitWidth)
413 KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
Jay Foad5a29c362014-05-15 12:12:55 +0000414 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000415 }
416 case Instruction::BitCast: {
Chris Lattner229907c2011-07-18 04:54:35 +0000417 Type *SrcTy = I->getOperand(0)->getType();
Duncan Sands19d0b472010-02-16 11:11:14 +0000418 if ((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
Chris Lattneredb84072009-07-02 16:04:08 +0000419 // TODO: For now, not handling conversions like:
420 // (bitcast i64 %x to <2 x i32>)
Duncan Sands19d0b472010-02-16 11:11:14 +0000421 !I->getType()->isVectorTy()) {
Jay Foada0653a32014-05-14 21:14:37 +0000422 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
Jay Foad5a29c362014-05-15 12:12:55 +0000423 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000424 }
425 break;
426 }
427 case Instruction::SExt: {
428 // Compute the bits in the result that are not present in the input.
Chris Lattner0cdbc7a2009-09-08 00:13:52 +0000429 unsigned SrcBitWidth = I->getOperand(0)->getType()->getScalarSizeInBits();
Craig Topper1bef2c82012-12-22 19:15:35 +0000430
Jay Foad583abbc2010-12-07 08:25:19 +0000431 KnownZero = KnownZero.trunc(SrcBitWidth);
432 KnownOne = KnownOne.trunc(SrcBitWidth);
Jay Foada0653a32014-05-14 21:14:37 +0000433 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
Jay Foad583abbc2010-12-07 08:25:19 +0000434 KnownZero = KnownZero.zext(BitWidth);
435 KnownOne = KnownOne.zext(BitWidth);
Chris Lattner965c7692008-06-02 01:18:21 +0000436
437 // If the sign bit of the input is known set or clear, then we know the
438 // top bits of the result.
439 if (KnownZero[SrcBitWidth-1]) // Input sign bit known zero
440 KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
441 else if (KnownOne[SrcBitWidth-1]) // Input sign bit known set
442 KnownOne |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
Jay Foad5a29c362014-05-15 12:12:55 +0000443 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000444 }
445 case Instruction::Shl:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +0000446 // (shl X, C1) & C2 == 0 iff (X & C2 >>u C1) == 0
Chris Lattner965c7692008-06-02 01:18:21 +0000447 if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
448 uint64_t ShiftAmt = SA->getLimitedValue(BitWidth);
Jay Foada0653a32014-05-14 21:14:37 +0000449 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000450 KnownZero <<= ShiftAmt;
451 KnownOne <<= ShiftAmt;
452 KnownZero |= APInt::getLowBitsSet(BitWidth, ShiftAmt); // low bits known 0
Jay Foad5a29c362014-05-15 12:12:55 +0000453 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000454 }
455 break;
456 case Instruction::LShr:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +0000457 // (ushr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Chris Lattner965c7692008-06-02 01:18:21 +0000458 if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
459 // Compute the new bits that are at the top now.
460 uint64_t ShiftAmt = SA->getLimitedValue(BitWidth);
Craig Topper1bef2c82012-12-22 19:15:35 +0000461
Chris Lattner965c7692008-06-02 01:18:21 +0000462 // Unsigned shift right.
Jay Foada0653a32014-05-14 21:14:37 +0000463 computeKnownBits(I->getOperand(0), KnownZero,KnownOne, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000464 KnownZero = APIntOps::lshr(KnownZero, ShiftAmt);
465 KnownOne = APIntOps::lshr(KnownOne, ShiftAmt);
466 // high bits known zero.
467 KnownZero |= APInt::getHighBitsSet(BitWidth, ShiftAmt);
Jay Foad5a29c362014-05-15 12:12:55 +0000468 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000469 }
470 break;
471 case Instruction::AShr:
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +0000472 // (ashr X, C1) & C2 == 0 iff (-1 >> C1) & C2 == 0
Chris Lattner965c7692008-06-02 01:18:21 +0000473 if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
474 // Compute the new bits that are at the top now.
Chris Lattnerc86e67e2011-01-04 18:19:15 +0000475 uint64_t ShiftAmt = SA->getLimitedValue(BitWidth-1);
Craig Topper1bef2c82012-12-22 19:15:35 +0000476
Chris Lattner965c7692008-06-02 01:18:21 +0000477 // Signed shift right.
Jay Foada0653a32014-05-14 21:14:37 +0000478 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000479 KnownZero = APIntOps::lshr(KnownZero, ShiftAmt);
480 KnownOne = APIntOps::lshr(KnownOne, ShiftAmt);
Craig Topper1bef2c82012-12-22 19:15:35 +0000481
Chris Lattner965c7692008-06-02 01:18:21 +0000482 APInt HighBits(APInt::getHighBitsSet(BitWidth, ShiftAmt));
483 if (KnownZero[BitWidth-ShiftAmt-1]) // New bits are known zero.
484 KnownZero |= HighBits;
485 else if (KnownOne[BitWidth-ShiftAmt-1]) // New bits are known one.
486 KnownOne |= HighBits;
Jay Foad5a29c362014-05-15 12:12:55 +0000487 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000488 }
489 break;
490 case Instruction::Sub: {
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000491 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Jay Foada0653a32014-05-14 21:14:37 +0000492 computeKnownBitsAddSub(false, I->getOperand(0), I->getOperand(1), NSW,
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000493 KnownZero, KnownOne, KnownZero2, KnownOne2, TD,
494 Depth);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000495 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000496 }
Chris Lattner965c7692008-06-02 01:18:21 +0000497 case Instruction::Add: {
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000498 bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
Jay Foada0653a32014-05-14 21:14:37 +0000499 computeKnownBitsAddSub(true, I->getOperand(0), I->getOperand(1), NSW,
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000500 KnownZero, KnownOne, KnownZero2, KnownOne2, TD,
501 Depth);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000502 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000503 }
504 case Instruction::SRem:
505 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
Duncan Sands26cd6bd2010-01-29 06:18:37 +0000506 APInt RA = Rem->getValue().abs();
507 if (RA.isPowerOf2()) {
508 APInt LowBits = RA - 1;
Jay Foada0653a32014-05-14 21:14:37 +0000509 computeKnownBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000510
Duncan Sands26cd6bd2010-01-29 06:18:37 +0000511 // The low bits of the first operand are unchanged by the srem.
512 KnownZero = KnownZero2 & LowBits;
513 KnownOne = KnownOne2 & LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +0000514
Duncan Sands26cd6bd2010-01-29 06:18:37 +0000515 // If the first operand is non-negative or has all low bits zero, then
516 // the upper bits are all zero.
517 if (KnownZero2[BitWidth-1] || ((KnownZero2 & LowBits) == LowBits))
518 KnownZero |= ~LowBits;
519
520 // If the first operand is negative and not all low bits are zero, then
521 // the upper bits are all one.
522 if (KnownOne2[BitWidth-1] && ((KnownOne2 & LowBits) != 0))
523 KnownOne |= ~LowBits;
524
Craig Topper1bef2c82012-12-22 19:15:35 +0000525 assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
Chris Lattner965c7692008-06-02 01:18:21 +0000526 }
527 }
Nick Lewyckye4679792011-03-07 01:50:10 +0000528
529 // The sign bit is the LHS's sign bit, except when the result of the
530 // remainder is zero.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000531 if (KnownZero.isNonNegative()) {
Nick Lewyckye4679792011-03-07 01:50:10 +0000532 APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000533 computeKnownBits(I->getOperand(0), LHSKnownZero, LHSKnownOne, TD,
534 Depth+1);
Nick Lewyckye4679792011-03-07 01:50:10 +0000535 // If it's known zero, our sign bit is also zero.
536 if (LHSKnownZero.isNegative())
Duncan Sands34c48692012-04-30 11:56:58 +0000537 KnownZero.setBit(BitWidth - 1);
Nick Lewyckye4679792011-03-07 01:50:10 +0000538 }
539
Chris Lattner965c7692008-06-02 01:18:21 +0000540 break;
541 case Instruction::URem: {
542 if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
543 APInt RA = Rem->getValue();
544 if (RA.isPowerOf2()) {
545 APInt LowBits = (RA - 1);
Jay Foada0653a32014-05-14 21:14:37 +0000546 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, TD,
547 Depth+1);
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000548 KnownZero |= ~LowBits;
549 KnownOne &= LowBits;
Chris Lattner965c7692008-06-02 01:18:21 +0000550 break;
551 }
552 }
553
554 // Since the result is less than or equal to either operand, any leading
555 // zero bits in either operand must also exist in the result.
Jay Foada0653a32014-05-14 21:14:37 +0000556 computeKnownBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
557 computeKnownBits(I->getOperand(1), KnownZero2, KnownOne2, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000558
Chris Lattner4612ae12009-01-20 18:22:57 +0000559 unsigned Leaders = std::max(KnownZero.countLeadingOnes(),
Chris Lattner965c7692008-06-02 01:18:21 +0000560 KnownZero2.countLeadingOnes());
Jay Foad25a5e4c2010-12-01 08:53:58 +0000561 KnownOne.clearAllBits();
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000562 KnownZero = APInt::getHighBitsSet(BitWidth, Leaders);
Chris Lattner965c7692008-06-02 01:18:21 +0000563 break;
564 }
565
Victor Hernandeza3aaf852009-10-17 01:18:07 +0000566 case Instruction::Alloca: {
Victor Hernandez8acf2952009-10-23 21:09:37 +0000567 AllocaInst *AI = cast<AllocaInst>(V);
Chris Lattner965c7692008-06-02 01:18:21 +0000568 unsigned Align = AI->getAlignment();
Victor Hernandeza3aaf852009-10-17 01:18:07 +0000569 if (Align == 0 && TD)
570 Align = TD->getABITypeAlignment(AI->getType()->getElementType());
Craig Topper1bef2c82012-12-22 19:15:35 +0000571
Chris Lattner965c7692008-06-02 01:18:21 +0000572 if (Align > 0)
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +0000573 KnownZero = APInt::getLowBitsSet(BitWidth, countTrailingZeros(Align));
Chris Lattner965c7692008-06-02 01:18:21 +0000574 break;
575 }
576 case Instruction::GetElementPtr: {
577 // Analyze all of the subscripts of this getelementptr instruction
578 // to determine if we can prove known low zero bits.
Chris Lattner965c7692008-06-02 01:18:21 +0000579 APInt LocalKnownZero(BitWidth, 0), LocalKnownOne(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000580 computeKnownBits(I->getOperand(0), LocalKnownZero, LocalKnownOne, TD,
581 Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000582 unsigned TrailZ = LocalKnownZero.countTrailingOnes();
583
584 gep_type_iterator GTI = gep_type_begin(I);
585 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
586 Value *Index = I->getOperand(i);
Chris Lattner229907c2011-07-18 04:54:35 +0000587 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Chris Lattner965c7692008-06-02 01:18:21 +0000588 // Handle struct member offset arithmetic.
Jay Foad5a29c362014-05-15 12:12:55 +0000589 if (!TD) {
590 TrailZ = 0;
591 break;
592 }
Matt Arsenault74742a12013-08-19 21:43:16 +0000593
594 // Handle case when index is vector zeroinitializer
595 Constant *CIndex = cast<Constant>(Index);
596 if (CIndex->isZeroValue())
597 continue;
598
599 if (CIndex->getType()->isVectorTy())
600 Index = CIndex->getSplatValue();
601
Chris Lattner965c7692008-06-02 01:18:21 +0000602 unsigned Idx = cast<ConstantInt>(Index)->getZExtValue();
Matt Arsenault74742a12013-08-19 21:43:16 +0000603 const StructLayout *SL = TD->getStructLayout(STy);
Chris Lattner965c7692008-06-02 01:18:21 +0000604 uint64_t Offset = SL->getElementOffset(Idx);
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +0000605 TrailZ = std::min<unsigned>(TrailZ,
606 countTrailingZeros(Offset));
Chris Lattner965c7692008-06-02 01:18:21 +0000607 } else {
608 // Handle array index arithmetic.
Chris Lattner229907c2011-07-18 04:54:35 +0000609 Type *IndexedTy = GTI.getIndexedType();
Jay Foad5a29c362014-05-15 12:12:55 +0000610 if (!IndexedTy->isSized()) {
611 TrailZ = 0;
612 break;
613 }
Dan Gohman7ccc52f2009-06-15 22:12:54 +0000614 unsigned GEPOpiBits = Index->getType()->getScalarSizeInBits();
Duncan Sandsaf9eaa82009-05-09 07:06:46 +0000615 uint64_t TypeSize = TD ? TD->getTypeAllocSize(IndexedTy) : 1;
Chris Lattner965c7692008-06-02 01:18:21 +0000616 LocalKnownZero = LocalKnownOne = APInt(GEPOpiBits, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000617 computeKnownBits(Index, LocalKnownZero, LocalKnownOne, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +0000618 TrailZ = std::min(TrailZ,
Michael J. Spencerdf1ecbd72013-05-24 22:23:49 +0000619 unsigned(countTrailingZeros(TypeSize) +
Chris Lattner4612ae12009-01-20 18:22:57 +0000620 LocalKnownZero.countTrailingOnes()));
Chris Lattner965c7692008-06-02 01:18:21 +0000621 }
622 }
Craig Topper1bef2c82012-12-22 19:15:35 +0000623
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000624 KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ);
Chris Lattner965c7692008-06-02 01:18:21 +0000625 break;
626 }
627 case Instruction::PHI: {
628 PHINode *P = cast<PHINode>(I);
629 // Handle the case of a simple two-predecessor recurrence PHI.
630 // There's a lot more that could theoretically be done here, but
631 // this is sufficient to catch some interesting cases.
632 if (P->getNumIncomingValues() == 2) {
633 for (unsigned i = 0; i != 2; ++i) {
634 Value *L = P->getIncomingValue(i);
635 Value *R = P->getIncomingValue(!i);
Dan Gohman80ca01c2009-07-17 20:47:02 +0000636 Operator *LU = dyn_cast<Operator>(L);
Chris Lattner965c7692008-06-02 01:18:21 +0000637 if (!LU)
638 continue;
Dan Gohman80ca01c2009-07-17 20:47:02 +0000639 unsigned Opcode = LU->getOpcode();
Chris Lattner965c7692008-06-02 01:18:21 +0000640 // Check for operations that have the property that if
641 // both their operands have low zero bits, the result
642 // will have low zero bits.
643 if (Opcode == Instruction::Add ||
644 Opcode == Instruction::Sub ||
645 Opcode == Instruction::And ||
646 Opcode == Instruction::Or ||
647 Opcode == Instruction::Mul) {
648 Value *LL = LU->getOperand(0);
649 Value *LR = LU->getOperand(1);
650 // Find a recurrence.
651 if (LL == I)
652 L = LR;
653 else if (LR == I)
654 L = LL;
655 else
656 break;
657 // Ok, we have a PHI of the form L op= R. Check for low
658 // zero bits.
Jay Foada0653a32014-05-14 21:14:37 +0000659 computeKnownBits(R, KnownZero2, KnownOne2, TD, Depth+1);
David Greeneaebd9e02008-10-27 23:24:03 +0000660
661 // We need to take the minimum number of known bits
662 APInt KnownZero3(KnownZero), KnownOne3(KnownOne);
Jay Foada0653a32014-05-14 21:14:37 +0000663 computeKnownBits(L, KnownZero3, KnownOne3, TD, Depth+1);
David Greeneaebd9e02008-10-27 23:24:03 +0000664
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000665 KnownZero = APInt::getLowBitsSet(BitWidth,
David Greeneaebd9e02008-10-27 23:24:03 +0000666 std::min(KnownZero2.countTrailingOnes(),
667 KnownZero3.countTrailingOnes()));
Chris Lattner965c7692008-06-02 01:18:21 +0000668 break;
669 }
670 }
671 }
Dan Gohmanbf0002e2009-05-21 02:28:33 +0000672
Nick Lewyckyac0b62c2011-02-10 23:54:10 +0000673 // Unreachable blocks may have zero-operand PHI nodes.
674 if (P->getNumIncomingValues() == 0)
Jay Foad5a29c362014-05-15 12:12:55 +0000675 break;
Nick Lewyckyac0b62c2011-02-10 23:54:10 +0000676
Dan Gohmanbf0002e2009-05-21 02:28:33 +0000677 // Otherwise take the unions of the known bit sets of the operands,
678 // taking conservative care to avoid excessive recursion.
679 if (Depth < MaxDepth - 1 && !KnownZero && !KnownOne) {
Duncan Sands7dc3d472011-03-08 12:39:03 +0000680 // Skip if every incoming value references to ourself.
Nuno Lopes0d44a502012-07-03 21:15:40 +0000681 if (dyn_cast_or_null<UndefValue>(P->hasConstantValue()))
Duncan Sands7dc3d472011-03-08 12:39:03 +0000682 break;
683
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +0000684 KnownZero = APInt::getAllOnesValue(BitWidth);
685 KnownOne = APInt::getAllOnesValue(BitWidth);
Dan Gohmanbf0002e2009-05-21 02:28:33 +0000686 for (unsigned i = 0, e = P->getNumIncomingValues(); i != e; ++i) {
687 // Skip direct self references.
688 if (P->getIncomingValue(i) == P) continue;
689
690 KnownZero2 = APInt(BitWidth, 0);
691 KnownOne2 = APInt(BitWidth, 0);
692 // Recurse, but cap the recursion to one level, because we don't
693 // want to waste time spinning around in loops.
Jay Foada0653a32014-05-14 21:14:37 +0000694 computeKnownBits(P->getIncomingValue(i), KnownZero2, KnownOne2, TD,
695 MaxDepth-1);
Dan Gohmanbf0002e2009-05-21 02:28:33 +0000696 KnownZero &= KnownZero2;
697 KnownOne &= KnownOne2;
698 // If all bits have been ruled out, there's no need to check
699 // more operands.
700 if (!KnownZero && !KnownOne)
701 break;
702 }
703 }
Chris Lattner965c7692008-06-02 01:18:21 +0000704 break;
705 }
706 case Instruction::Call:
Jingyue Wu37fcb592014-06-19 16:50:16 +0000707 case Instruction::Invoke:
708 if (MDNode *MD = cast<Instruction>(I)->getMetadata(LLVMContext::MD_range))
709 computeKnownBitsFromRangeMetadata(*MD, KnownZero);
710 // If a range metadata is attached to this IntrinsicInst, intersect the
711 // explicit range specified by the metadata and the implicit range of
712 // the intrinsic.
Chris Lattner965c7692008-06-02 01:18:21 +0000713 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
714 switch (II->getIntrinsicID()) {
715 default: break;
Chris Lattner965c7692008-06-02 01:18:21 +0000716 case Intrinsic::ctlz:
717 case Intrinsic::cttz: {
718 unsigned LowBits = Log2_32(BitWidth)+1;
Benjamin Kramer4ee57472011-12-24 17:31:46 +0000719 // If this call is undefined for 0, the result will be less than 2^n.
720 if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
721 LowBits -= 1;
Jingyue Wu37fcb592014-06-19 16:50:16 +0000722 KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - LowBits);
Benjamin Kramer4ee57472011-12-24 17:31:46 +0000723 break;
724 }
725 case Intrinsic::ctpop: {
726 unsigned LowBits = Log2_32(BitWidth)+1;
Jingyue Wu37fcb592014-06-19 16:50:16 +0000727 KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - LowBits);
Chris Lattner965c7692008-06-02 01:18:21 +0000728 break;
729 }
Chad Rosierb3628842011-05-26 23:13:19 +0000730 case Intrinsic::x86_sse42_crc32_64_64:
Jingyue Wu37fcb592014-06-19 16:50:16 +0000731 KnownZero |= APInt::getHighBitsSet(64, 32);
Evan Cheng2a746bf2011-05-22 18:25:30 +0000732 break;
Chris Lattner965c7692008-06-02 01:18:21 +0000733 }
734 }
735 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000736 case Instruction::ExtractValue:
737 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I->getOperand(0))) {
738 ExtractValueInst *EVI = cast<ExtractValueInst>(I);
739 if (EVI->getNumIndices() != 1) break;
740 if (EVI->getIndices()[0] == 0) {
741 switch (II->getIntrinsicID()) {
742 default: break;
743 case Intrinsic::uadd_with_overflow:
744 case Intrinsic::sadd_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +0000745 computeKnownBitsAddSub(true, II->getArgOperand(0),
746 II->getArgOperand(1), false, KnownZero,
747 KnownOne, KnownZero2, KnownOne2, TD, Depth);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000748 break;
749 case Intrinsic::usub_with_overflow:
750 case Intrinsic::ssub_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +0000751 computeKnownBitsAddSub(false, II->getArgOperand(0),
752 II->getArgOperand(1), false, KnownZero,
753 KnownOne, KnownZero2, KnownOne2, TD, Depth);
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000754 break;
Nick Lewyckyfa306072012-03-18 23:28:48 +0000755 case Intrinsic::umul_with_overflow:
756 case Intrinsic::smul_with_overflow:
Jay Foada0653a32014-05-14 21:14:37 +0000757 computeKnownBitsMul(II->getArgOperand(0), II->getArgOperand(1),
758 false, KnownZero, KnownOne,
759 KnownZero2, KnownOne2, TD, Depth);
Nick Lewyckyfa306072012-03-18 23:28:48 +0000760 break;
Nick Lewyckyfea3e002012-03-09 09:23:50 +0000761 }
762 }
763 }
Chris Lattner965c7692008-06-02 01:18:21 +0000764 }
Jay Foad5a29c362014-05-15 12:12:55 +0000765
766 assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
Chris Lattner965c7692008-06-02 01:18:21 +0000767}
768
Duncan Sandsd3951082011-01-25 09:38:29 +0000769/// ComputeSignBit - Determine whether the sign bit is known to be zero or
Jay Foada0653a32014-05-14 21:14:37 +0000770/// one. Convenience wrapper around computeKnownBits.
Duncan Sandsd3951082011-01-25 09:38:29 +0000771void llvm::ComputeSignBit(Value *V, bool &KnownZero, bool &KnownOne,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000772 const DataLayout *TD, unsigned Depth) {
Duncan Sandsd3951082011-01-25 09:38:29 +0000773 unsigned BitWidth = getBitWidth(V->getType(), TD);
774 if (!BitWidth) {
775 KnownZero = false;
776 KnownOne = false;
777 return;
778 }
779 APInt ZeroBits(BitWidth, 0);
780 APInt OneBits(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000781 computeKnownBits(V, ZeroBits, OneBits, TD, Depth);
Duncan Sandsd3951082011-01-25 09:38:29 +0000782 KnownOne = OneBits[BitWidth - 1];
783 KnownZero = ZeroBits[BitWidth - 1];
784}
785
Rafael Espindola319f74c2012-12-13 03:37:24 +0000786/// isKnownToBeAPowerOfTwo - Return true if the given value is known to have exactly one
Duncan Sandsd3951082011-01-25 09:38:29 +0000787/// bit set when defined. For vectors return true if every element is known to
788/// be a power of two when defined. Supports values with integer or pointer
789/// types and vectors of integers.
Rafael Espindola319f74c2012-12-13 03:37:24 +0000790bool llvm::isKnownToBeAPowerOfTwo(Value *V, bool OrZero, unsigned Depth) {
Duncan Sandsba286d72011-10-26 20:55:21 +0000791 if (Constant *C = dyn_cast<Constant>(V)) {
792 if (C->isNullValue())
793 return OrZero;
794 if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
795 return CI->getValue().isPowerOf2();
796 // TODO: Handle vector constants.
797 }
Duncan Sandsd3951082011-01-25 09:38:29 +0000798
799 // 1 << X is clearly a power of two if the one is not shifted off the end. If
800 // it is shifted off the end then the result is undefined.
801 if (match(V, m_Shl(m_One(), m_Value())))
802 return true;
803
804 // (signbit) >>l X is clearly a power of two if the one is not shifted off the
805 // bottom. If it is shifted off the bottom then the result is undefined.
Duncan Sands4b397fc2011-02-01 08:50:33 +0000806 if (match(V, m_LShr(m_SignBit(), m_Value())))
Duncan Sandsd3951082011-01-25 09:38:29 +0000807 return true;
808
809 // The remaining tests are all recursive, so bail out if we hit the limit.
810 if (Depth++ == MaxDepth)
811 return false;
812
Craig Topper9f008862014-04-15 04:59:12 +0000813 Value *X = nullptr, *Y = nullptr;
Duncan Sands985ba632011-10-28 18:30:05 +0000814 // A shift of a power of two is a power of two or zero.
815 if (OrZero && (match(V, m_Shl(m_Value(X), m_Value())) ||
816 match(V, m_Shr(m_Value(X), m_Value()))))
Rafael Espindola319f74c2012-12-13 03:37:24 +0000817 return isKnownToBeAPowerOfTwo(X, /*OrZero*/true, Depth);
Duncan Sands985ba632011-10-28 18:30:05 +0000818
Duncan Sandsd3951082011-01-25 09:38:29 +0000819 if (ZExtInst *ZI = dyn_cast<ZExtInst>(V))
Rafael Espindola319f74c2012-12-13 03:37:24 +0000820 return isKnownToBeAPowerOfTwo(ZI->getOperand(0), OrZero, Depth);
Duncan Sandsd3951082011-01-25 09:38:29 +0000821
822 if (SelectInst *SI = dyn_cast<SelectInst>(V))
Rafael Espindola319f74c2012-12-13 03:37:24 +0000823 return isKnownToBeAPowerOfTwo(SI->getTrueValue(), OrZero, Depth) &&
824 isKnownToBeAPowerOfTwo(SI->getFalseValue(), OrZero, Depth);
Duncan Sandsba286d72011-10-26 20:55:21 +0000825
Duncan Sandsba286d72011-10-26 20:55:21 +0000826 if (OrZero && match(V, m_And(m_Value(X), m_Value(Y)))) {
827 // A power of two and'd with anything is a power of two or zero.
Rafael Espindola319f74c2012-12-13 03:37:24 +0000828 if (isKnownToBeAPowerOfTwo(X, /*OrZero*/true, Depth) ||
829 isKnownToBeAPowerOfTwo(Y, /*OrZero*/true, Depth))
Duncan Sandsba286d72011-10-26 20:55:21 +0000830 return true;
831 // X & (-X) is always a power of two or zero.
832 if (match(X, m_Neg(m_Specific(Y))) || match(Y, m_Neg(m_Specific(X))))
833 return true;
834 return false;
835 }
Duncan Sandsd3951082011-01-25 09:38:29 +0000836
David Majnemerb7d54092013-07-30 21:01:36 +0000837 // Adding a power-of-two or zero to the same power-of-two or zero yields
838 // either the original power-of-two, a larger power-of-two or zero.
839 if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
840 OverflowingBinaryOperator *VOBO = cast<OverflowingBinaryOperator>(V);
841 if (OrZero || VOBO->hasNoUnsignedWrap() || VOBO->hasNoSignedWrap()) {
842 if (match(X, m_And(m_Specific(Y), m_Value())) ||
843 match(X, m_And(m_Value(), m_Specific(Y))))
844 if (isKnownToBeAPowerOfTwo(Y, OrZero, Depth))
845 return true;
846 if (match(Y, m_And(m_Specific(X), m_Value())) ||
847 match(Y, m_And(m_Value(), m_Specific(X))))
848 if (isKnownToBeAPowerOfTwo(X, OrZero, Depth))
849 return true;
850
851 unsigned BitWidth = V->getType()->getScalarSizeInBits();
852 APInt LHSZeroBits(BitWidth, 0), LHSOneBits(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000853 computeKnownBits(X, LHSZeroBits, LHSOneBits, nullptr, Depth);
David Majnemerb7d54092013-07-30 21:01:36 +0000854
855 APInt RHSZeroBits(BitWidth, 0), RHSOneBits(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000856 computeKnownBits(Y, RHSZeroBits, RHSOneBits, nullptr, Depth);
David Majnemerb7d54092013-07-30 21:01:36 +0000857 // If i8 V is a power of two or zero:
858 // ZeroBits: 1 1 1 0 1 1 1 1
859 // ~ZeroBits: 0 0 0 1 0 0 0 0
860 if ((~(LHSZeroBits & RHSZeroBits)).isPowerOf2())
861 // If OrZero isn't set, we cannot give back a zero result.
862 // Make sure either the LHS or RHS has a bit set.
863 if (OrZero || RHSOneBits.getBoolValue() || LHSOneBits.getBoolValue())
864 return true;
865 }
866 }
David Majnemerbeab5672013-05-18 19:30:37 +0000867
Nick Lewyckyc9aab852011-02-28 08:02:21 +0000868 // An exact divide or right shift can only shift off zero bits, so the result
Nick Lewyckyf0469af2011-03-21 21:40:32 +0000869 // is a power of two only if the first operand is a power of two and not
870 // copying a sign bit (sdiv int_min, 2).
Benjamin Kramer9442cd02012-01-01 17:55:30 +0000871 if (match(V, m_Exact(m_LShr(m_Value(), m_Value()))) ||
872 match(V, m_Exact(m_UDiv(m_Value(), m_Value())))) {
Rafael Espindola319f74c2012-12-13 03:37:24 +0000873 return isKnownToBeAPowerOfTwo(cast<Operator>(V)->getOperand(0), OrZero, Depth);
Nick Lewyckyc9aab852011-02-28 08:02:21 +0000874 }
875
Duncan Sandsd3951082011-01-25 09:38:29 +0000876 return false;
877}
878
Chandler Carruth80d3e562012-12-07 02:08:58 +0000879/// \brief Test whether a GEP's result is known to be non-null.
880///
881/// Uses properties inherent in a GEP to try to determine whether it is known
882/// to be non-null.
883///
884/// Currently this routine does not support vector GEPs.
885static bool isGEPKnownNonNull(GEPOperator *GEP, const DataLayout *DL,
886 unsigned Depth) {
887 if (!GEP->isInBounds() || GEP->getPointerAddressSpace() != 0)
888 return false;
889
890 // FIXME: Support vector-GEPs.
891 assert(GEP->getType()->isPointerTy() && "We only support plain pointer GEP");
892
893 // If the base pointer is non-null, we cannot walk to a null address with an
894 // inbounds GEP in address space zero.
895 if (isKnownNonZero(GEP->getPointerOperand(), DL, Depth))
896 return true;
897
898 // Past this, if we don't have DataLayout, we can't do much.
899 if (!DL)
900 return false;
901
902 // Walk the GEP operands and see if any operand introduces a non-zero offset.
903 // If so, then the GEP cannot produce a null pointer, as doing so would
904 // inherently violate the inbounds contract within address space zero.
905 for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
906 GTI != GTE; ++GTI) {
907 // Struct types are easy -- they must always be indexed by a constant.
908 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
909 ConstantInt *OpC = cast<ConstantInt>(GTI.getOperand());
910 unsigned ElementIdx = OpC->getZExtValue();
911 const StructLayout *SL = DL->getStructLayout(STy);
912 uint64_t ElementOffset = SL->getElementOffset(ElementIdx);
913 if (ElementOffset > 0)
914 return true;
915 continue;
916 }
917
918 // If we have a zero-sized type, the index doesn't matter. Keep looping.
919 if (DL->getTypeAllocSize(GTI.getIndexedType()) == 0)
920 continue;
921
922 // Fast path the constant operand case both for efficiency and so we don't
923 // increment Depth when just zipping down an all-constant GEP.
924 if (ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand())) {
925 if (!OpC->isZero())
926 return true;
927 continue;
928 }
929
930 // We post-increment Depth here because while isKnownNonZero increments it
931 // as well, when we pop back up that increment won't persist. We don't want
932 // to recurse 10k times just because we have 10k GEP operands. We don't
933 // bail completely out because we want to handle constant GEPs regardless
934 // of depth.
935 if (Depth++ >= MaxDepth)
936 continue;
937
938 if (isKnownNonZero(GTI.getOperand(), DL, Depth))
939 return true;
940 }
941
942 return false;
943}
944
Duncan Sandsd3951082011-01-25 09:38:29 +0000945/// isKnownNonZero - Return true if the given value is known to be non-zero
946/// when defined. For vectors return true if every element is known to be
947/// non-zero when defined. Supports values with integer or pointer type and
948/// vectors of integers.
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000949bool llvm::isKnownNonZero(Value *V, const DataLayout *TD, unsigned Depth) {
Duncan Sandsd3951082011-01-25 09:38:29 +0000950 if (Constant *C = dyn_cast<Constant>(V)) {
951 if (C->isNullValue())
952 return false;
953 if (isa<ConstantInt>(C))
954 // Must be non-zero due to null test above.
955 return true;
956 // TODO: Handle vectors
957 return false;
958 }
959
960 // The remaining tests are all recursive, so bail out if we hit the limit.
Duncan Sands7cb61e52011-10-27 19:16:21 +0000961 if (Depth++ >= MaxDepth)
Duncan Sandsd3951082011-01-25 09:38:29 +0000962 return false;
963
Chandler Carruth80d3e562012-12-07 02:08:58 +0000964 // Check for pointer simplifications.
965 if (V->getType()->isPointerTy()) {
Manman Ren12171122013-03-18 21:23:25 +0000966 if (isKnownNonNull(V))
967 return true;
Chandler Carruth80d3e562012-12-07 02:08:58 +0000968 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V))
969 if (isGEPKnownNonNull(GEP, TD, Depth))
970 return true;
971 }
972
Nadav Rotemaa3e2a92012-12-14 20:43:49 +0000973 unsigned BitWidth = getBitWidth(V->getType()->getScalarType(), TD);
Duncan Sandsd3951082011-01-25 09:38:29 +0000974
975 // X | Y != 0 if X != 0 or Y != 0.
Craig Topper9f008862014-04-15 04:59:12 +0000976 Value *X = nullptr, *Y = nullptr;
Duncan Sandsd3951082011-01-25 09:38:29 +0000977 if (match(V, m_Or(m_Value(X), m_Value(Y))))
978 return isKnownNonZero(X, TD, Depth) || isKnownNonZero(Y, TD, Depth);
979
980 // ext X != 0 if X != 0.
981 if (isa<SExtInst>(V) || isa<ZExtInst>(V))
982 return isKnownNonZero(cast<Instruction>(V)->getOperand(0), TD, Depth);
983
Duncan Sands2e9e4f12011-01-29 13:27:00 +0000984 // shl X, Y != 0 if X is odd. Note that the value of the shift is undefined
Duncan Sandsd3951082011-01-25 09:38:29 +0000985 // if the lowest bit is shifted off the end.
986 if (BitWidth && match(V, m_Shl(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +0000987 // shl nuw can't remove any non-zero bits.
Duncan Sands7cb61e52011-10-27 19:16:21 +0000988 OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
Nick Lewyckyc9aab852011-02-28 08:02:21 +0000989 if (BO->hasNoUnsignedWrap())
990 return isKnownNonZero(X, TD, Depth);
991
Duncan Sandsd3951082011-01-25 09:38:29 +0000992 APInt KnownZero(BitWidth, 0);
993 APInt KnownOne(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000994 computeKnownBits(X, KnownZero, KnownOne, TD, Depth);
Duncan Sandsd3951082011-01-25 09:38:29 +0000995 if (KnownOne[0])
996 return true;
997 }
Duncan Sands2e9e4f12011-01-29 13:27:00 +0000998 // shr X, Y != 0 if X is negative. Note that the value of the shift is not
Duncan Sandsd3951082011-01-25 09:38:29 +0000999 // defined if the sign bit is shifted off the end.
1000 else if (match(V, m_Shr(m_Value(X), m_Value(Y)))) {
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001001 // shr exact can only shift out zero bits.
Duncan Sands7cb61e52011-10-27 19:16:21 +00001002 PossiblyExactOperator *BO = cast<PossiblyExactOperator>(V);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001003 if (BO->isExact())
1004 return isKnownNonZero(X, TD, Depth);
1005
Duncan Sandsd3951082011-01-25 09:38:29 +00001006 bool XKnownNonNegative, XKnownNegative;
1007 ComputeSignBit(X, XKnownNonNegative, XKnownNegative, TD, Depth);
1008 if (XKnownNegative)
1009 return true;
1010 }
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001011 // div exact can only produce a zero if the dividend is zero.
Benjamin Kramer9442cd02012-01-01 17:55:30 +00001012 else if (match(V, m_Exact(m_IDiv(m_Value(X), m_Value())))) {
1013 return isKnownNonZero(X, TD, Depth);
Nick Lewyckyc9aab852011-02-28 08:02:21 +00001014 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001015 // X + Y.
1016 else if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
1017 bool XKnownNonNegative, XKnownNegative;
1018 bool YKnownNonNegative, YKnownNegative;
1019 ComputeSignBit(X, XKnownNonNegative, XKnownNegative, TD, Depth);
1020 ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, TD, Depth);
1021
1022 // If X and Y are both non-negative (as signed values) then their sum is not
Duncan Sands9e9d5b22011-01-25 15:14:15 +00001023 // zero unless both X and Y are zero.
Duncan Sandsd3951082011-01-25 09:38:29 +00001024 if (XKnownNonNegative && YKnownNonNegative)
Duncan Sands9e9d5b22011-01-25 15:14:15 +00001025 if (isKnownNonZero(X, TD, Depth) || isKnownNonZero(Y, TD, Depth))
1026 return true;
Duncan Sandsd3951082011-01-25 09:38:29 +00001027
1028 // If X and Y are both negative (as signed values) then their sum is not
1029 // zero unless both X and Y equal INT_MIN.
1030 if (BitWidth && XKnownNegative && YKnownNegative) {
1031 APInt KnownZero(BitWidth, 0);
1032 APInt KnownOne(BitWidth, 0);
1033 APInt Mask = APInt::getSignedMaxValue(BitWidth);
1034 // The sign bit of X is set. If some other bit is set then X is not equal
1035 // to INT_MIN.
Jay Foada0653a32014-05-14 21:14:37 +00001036 computeKnownBits(X, KnownZero, KnownOne, TD, Depth);
Duncan Sandsd3951082011-01-25 09:38:29 +00001037 if ((KnownOne & Mask) != 0)
1038 return true;
1039 // The sign bit of Y is set. If some other bit is set then Y is not equal
1040 // to INT_MIN.
Jay Foada0653a32014-05-14 21:14:37 +00001041 computeKnownBits(Y, KnownZero, KnownOne, TD, Depth);
Duncan Sandsd3951082011-01-25 09:38:29 +00001042 if ((KnownOne & Mask) != 0)
1043 return true;
1044 }
1045
1046 // The sum of a non-negative number and a power of two is not zero.
Rafael Espindola319f74c2012-12-13 03:37:24 +00001047 if (XKnownNonNegative && isKnownToBeAPowerOfTwo(Y, /*OrZero*/false, Depth))
Duncan Sandsd3951082011-01-25 09:38:29 +00001048 return true;
Rafael Espindola319f74c2012-12-13 03:37:24 +00001049 if (YKnownNonNegative && isKnownToBeAPowerOfTwo(X, /*OrZero*/false, Depth))
Duncan Sandsd3951082011-01-25 09:38:29 +00001050 return true;
1051 }
Duncan Sands7cb61e52011-10-27 19:16:21 +00001052 // X * Y.
1053 else if (match(V, m_Mul(m_Value(X), m_Value(Y)))) {
1054 OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
1055 // If X and Y are non-zero then so is X * Y as long as the multiplication
1056 // does not overflow.
1057 if ((BO->hasNoSignedWrap() || BO->hasNoUnsignedWrap()) &&
1058 isKnownNonZero(X, TD, Depth) && isKnownNonZero(Y, TD, Depth))
1059 return true;
1060 }
Duncan Sandsd3951082011-01-25 09:38:29 +00001061 // (C ? X : Y) != 0 if X != 0 and Y != 0.
1062 else if (SelectInst *SI = dyn_cast<SelectInst>(V)) {
1063 if (isKnownNonZero(SI->getTrueValue(), TD, Depth) &&
1064 isKnownNonZero(SI->getFalseValue(), TD, Depth))
1065 return true;
1066 }
1067
1068 if (!BitWidth) return false;
1069 APInt KnownZero(BitWidth, 0);
1070 APInt KnownOne(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +00001071 computeKnownBits(V, KnownZero, KnownOne, TD, Depth);
Duncan Sandsd3951082011-01-25 09:38:29 +00001072 return KnownOne != 0;
1073}
1074
Chris Lattner965c7692008-06-02 01:18:21 +00001075/// MaskedValueIsZero - Return true if 'V & Mask' is known to be zero. We use
1076/// this predicate to simplify operations downstream. Mask is known to be zero
1077/// for bits that V cannot have.
Chris Lattner4bc28252009-09-08 00:06:16 +00001078///
1079/// This function is defined on values with integer type, values with pointer
1080/// type (but only if TD is non-null), and vectors of integers. In the case
1081/// where V is a vector, the mask, known zero, and known one values are the
1082/// same width as the vector element, and the bit is set only if it is true
1083/// for all of the elements in the vector.
Chris Lattner965c7692008-06-02 01:18:21 +00001084bool llvm::MaskedValueIsZero(Value *V, const APInt &Mask,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001085 const DataLayout *TD, unsigned Depth) {
Chris Lattner965c7692008-06-02 01:18:21 +00001086 APInt KnownZero(Mask.getBitWidth(), 0), KnownOne(Mask.getBitWidth(), 0);
Jay Foada0653a32014-05-14 21:14:37 +00001087 computeKnownBits(V, KnownZero, KnownOne, TD, Depth);
Chris Lattner965c7692008-06-02 01:18:21 +00001088 return (KnownZero & Mask) == Mask;
1089}
1090
1091
1092
1093/// ComputeNumSignBits - Return the number of times the sign bit of the
1094/// register is replicated into the other bits. We know that at least 1 bit
1095/// is always equal to the sign bit (itself), but other cases can give us
1096/// information. For example, immediately after an "ashr X, 2", we know that
1097/// the top 3 bits are all equal to each other, so we return 3.
1098///
1099/// 'Op' must have a scalar integer type.
1100///
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001101unsigned llvm::ComputeNumSignBits(Value *V, const DataLayout *TD,
Dan Gohman05f11352009-08-27 17:51:25 +00001102 unsigned Depth) {
Duncan Sands9dff9be2010-02-15 16:12:20 +00001103 assert((TD || V->getType()->isIntOrIntVectorTy()) &&
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001104 "ComputeNumSignBits requires a DataLayout object to operate "
Dan Gohman26366932009-06-22 22:02:32 +00001105 "on non-integer values!");
Chris Lattner229907c2011-07-18 04:54:35 +00001106 Type *Ty = V->getType();
Dan Gohman26366932009-06-22 22:02:32 +00001107 unsigned TyBits = TD ? TD->getTypeSizeInBits(V->getType()->getScalarType()) :
1108 Ty->getScalarSizeInBits();
Chris Lattner965c7692008-06-02 01:18:21 +00001109 unsigned Tmp, Tmp2;
1110 unsigned FirstAnswer = 1;
1111
Jay Foada0653a32014-05-14 21:14:37 +00001112 // Note that ConstantInt is handled by the general computeKnownBits case
Chris Lattner2e01a692008-06-02 18:39:07 +00001113 // below.
1114
Chris Lattner965c7692008-06-02 01:18:21 +00001115 if (Depth == 6)
1116 return 1; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00001117
Dan Gohman80ca01c2009-07-17 20:47:02 +00001118 Operator *U = dyn_cast<Operator>(V);
1119 switch (Operator::getOpcode(V)) {
Chris Lattner965c7692008-06-02 01:18:21 +00001120 default: break;
1121 case Instruction::SExt:
Mon P Wangbb3eac92009-12-02 04:59:58 +00001122 Tmp = TyBits - U->getOperand(0)->getType()->getScalarSizeInBits();
Chris Lattner965c7692008-06-02 01:18:21 +00001123 return ComputeNumSignBits(U->getOperand(0), TD, Depth+1) + Tmp;
Craig Topper1bef2c82012-12-22 19:15:35 +00001124
Chris Lattner61a1d6c2012-01-26 21:37:55 +00001125 case Instruction::AShr: {
Chris Lattner965c7692008-06-02 01:18:21 +00001126 Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
Chris Lattner61a1d6c2012-01-26 21:37:55 +00001127 // ashr X, C -> adds C sign bits. Vectors too.
1128 const APInt *ShAmt;
1129 if (match(U->getOperand(1), m_APInt(ShAmt))) {
1130 Tmp += ShAmt->getZExtValue();
Chris Lattner965c7692008-06-02 01:18:21 +00001131 if (Tmp > TyBits) Tmp = TyBits;
1132 }
1133 return Tmp;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00001134 }
1135 case Instruction::Shl: {
1136 const APInt *ShAmt;
1137 if (match(U->getOperand(1), m_APInt(ShAmt))) {
Chris Lattner965c7692008-06-02 01:18:21 +00001138 // shl destroys sign bits.
1139 Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
Chris Lattner61a1d6c2012-01-26 21:37:55 +00001140 Tmp2 = ShAmt->getZExtValue();
1141 if (Tmp2 >= TyBits || // Bad shift.
1142 Tmp2 >= Tmp) break; // Shifted all sign bits out.
1143 return Tmp - Tmp2;
Chris Lattner965c7692008-06-02 01:18:21 +00001144 }
1145 break;
Chris Lattner61a1d6c2012-01-26 21:37:55 +00001146 }
Chris Lattner965c7692008-06-02 01:18:21 +00001147 case Instruction::And:
1148 case Instruction::Or:
1149 case Instruction::Xor: // NOT is handled here.
1150 // Logical binary ops preserve the number of sign bits at the worst.
1151 Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1152 if (Tmp != 1) {
1153 Tmp2 = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1154 FirstAnswer = std::min(Tmp, Tmp2);
1155 // We computed what we know about the sign bits as our first
1156 // answer. Now proceed to the generic code that uses
Jay Foada0653a32014-05-14 21:14:37 +00001157 // computeKnownBits, and pick whichever answer is better.
Chris Lattner965c7692008-06-02 01:18:21 +00001158 }
1159 break;
1160
1161 case Instruction::Select:
1162 Tmp = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1163 if (Tmp == 1) return 1; // Early out.
1164 Tmp2 = ComputeNumSignBits(U->getOperand(2), TD, Depth+1);
1165 return std::min(Tmp, Tmp2);
Craig Topper1bef2c82012-12-22 19:15:35 +00001166
Chris Lattner965c7692008-06-02 01:18:21 +00001167 case Instruction::Add:
1168 // Add can have at most one carry bit. Thus we know that the output
1169 // is, at worst, one more bit than the inputs.
1170 Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1171 if (Tmp == 1) return 1; // Early out.
Craig Topper1bef2c82012-12-22 19:15:35 +00001172
Chris Lattner965c7692008-06-02 01:18:21 +00001173 // Special case decrementing a value (ADD X, -1):
Dan Gohman4f356bb2009-02-24 02:00:40 +00001174 if (ConstantInt *CRHS = dyn_cast<ConstantInt>(U->getOperand(1)))
Chris Lattner965c7692008-06-02 01:18:21 +00001175 if (CRHS->isAllOnesValue()) {
1176 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Jay Foada0653a32014-05-14 21:14:37 +00001177 computeKnownBits(U->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
Craig Topper1bef2c82012-12-22 19:15:35 +00001178
Chris Lattner965c7692008-06-02 01:18:21 +00001179 // If the input is known to be 0 or 1, the output is 0/-1, which is all
1180 // sign bits set.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001181 if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00001182 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00001183
Chris Lattner965c7692008-06-02 01:18:21 +00001184 // If we are subtracting one from a positive number, there is no carry
1185 // out of the result.
1186 if (KnownZero.isNegative())
1187 return Tmp;
1188 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001189
Chris Lattner965c7692008-06-02 01:18:21 +00001190 Tmp2 = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1191 if (Tmp2 == 1) return 1;
Chris Lattner35d3b9d2010-01-07 23:44:37 +00001192 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00001193
Chris Lattner965c7692008-06-02 01:18:21 +00001194 case Instruction::Sub:
1195 Tmp2 = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1196 if (Tmp2 == 1) return 1;
Craig Topper1bef2c82012-12-22 19:15:35 +00001197
Chris Lattner965c7692008-06-02 01:18:21 +00001198 // Handle NEG.
1199 if (ConstantInt *CLHS = dyn_cast<ConstantInt>(U->getOperand(0)))
1200 if (CLHS->isNullValue()) {
1201 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Jay Foada0653a32014-05-14 21:14:37 +00001202 computeKnownBits(U->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
Chris Lattner965c7692008-06-02 01:18:21 +00001203 // If the input is known to be 0 or 1, the output is 0/-1, which is all
1204 // sign bits set.
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001205 if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
Chris Lattner965c7692008-06-02 01:18:21 +00001206 return TyBits;
Craig Topper1bef2c82012-12-22 19:15:35 +00001207
Chris Lattner965c7692008-06-02 01:18:21 +00001208 // If the input is known to be positive (the sign bit is known clear),
1209 // the output of the NEG has the same number of sign bits as the input.
1210 if (KnownZero.isNegative())
1211 return Tmp2;
Craig Topper1bef2c82012-12-22 19:15:35 +00001212
Chris Lattner965c7692008-06-02 01:18:21 +00001213 // Otherwise, we treat this like a SUB.
1214 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001215
Chris Lattner965c7692008-06-02 01:18:21 +00001216 // Sub can have at most one carry bit. Thus we know that the output
1217 // is, at worst, one more bit than the inputs.
1218 Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1219 if (Tmp == 1) return 1; // Early out.
Chris Lattner35d3b9d2010-01-07 23:44:37 +00001220 return std::min(Tmp, Tmp2)-1;
Craig Topper1bef2c82012-12-22 19:15:35 +00001221
Chris Lattner35d3b9d2010-01-07 23:44:37 +00001222 case Instruction::PHI: {
1223 PHINode *PN = cast<PHINode>(U);
1224 // Don't analyze large in-degree PHIs.
1225 if (PN->getNumIncomingValues() > 4) break;
Craig Topper1bef2c82012-12-22 19:15:35 +00001226
Chris Lattner35d3b9d2010-01-07 23:44:37 +00001227 // Take the minimum of all incoming values. This can't infinitely loop
1228 // because of our depth threshold.
1229 Tmp = ComputeNumSignBits(PN->getIncomingValue(0), TD, Depth+1);
1230 for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i) {
1231 if (Tmp == 1) return Tmp;
1232 Tmp = std::min(Tmp,
Evan Cheng2a654292010-03-13 02:20:29 +00001233 ComputeNumSignBits(PN->getIncomingValue(i), TD, Depth+1));
Chris Lattner35d3b9d2010-01-07 23:44:37 +00001234 }
1235 return Tmp;
1236 }
1237
Chris Lattner965c7692008-06-02 01:18:21 +00001238 case Instruction::Trunc:
1239 // FIXME: it's tricky to do anything useful for this, but it is an important
1240 // case for targets like X86.
1241 break;
1242 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001243
Chris Lattner965c7692008-06-02 01:18:21 +00001244 // Finally, if we can prove that the top bits of the result are 0's or 1's,
1245 // use this information.
1246 APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00001247 APInt Mask;
Jay Foada0653a32014-05-14 21:14:37 +00001248 computeKnownBits(V, KnownZero, KnownOne, TD, Depth);
Craig Topper1bef2c82012-12-22 19:15:35 +00001249
Chris Lattner965c7692008-06-02 01:18:21 +00001250 if (KnownZero.isNegative()) { // sign bit is 0
1251 Mask = KnownZero;
1252 } else if (KnownOne.isNegative()) { // sign bit is 1;
1253 Mask = KnownOne;
1254 } else {
1255 // Nothing known.
1256 return FirstAnswer;
1257 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001258
Chris Lattner965c7692008-06-02 01:18:21 +00001259 // Okay, we know that the sign bit in Mask is set. Use CLZ to determine
1260 // the number of identical bits in the top of the input value.
1261 Mask = ~Mask;
1262 Mask <<= Mask.getBitWidth()-TyBits;
1263 // Return # leading zeros. We use 'min' here in case Val was zero before
1264 // shifting. We don't want to return '64' as for an i32 "0".
1265 return std::max(FirstAnswer, std::min(TyBits, Mask.countLeadingZeros()));
1266}
Chris Lattnera12a6de2008-06-02 01:29:46 +00001267
Victor Hernandez47444882009-11-10 08:28:35 +00001268/// ComputeMultiple - This function computes the integer multiple of Base that
1269/// equals V. If successful, it returns true and returns the multiple in
Dan Gohman6a976bb2009-11-18 00:58:27 +00001270/// Multiple. If unsuccessful, it returns false. It looks
Victor Hernandez47444882009-11-10 08:28:35 +00001271/// through SExt instructions only if LookThroughSExt is true.
1272bool llvm::ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
Dan Gohman6a976bb2009-11-18 00:58:27 +00001273 bool LookThroughSExt, unsigned Depth) {
Victor Hernandez47444882009-11-10 08:28:35 +00001274 const unsigned MaxDepth = 6;
1275
Dan Gohman6a976bb2009-11-18 00:58:27 +00001276 assert(V && "No Value?");
Victor Hernandez47444882009-11-10 08:28:35 +00001277 assert(Depth <= MaxDepth && "Limit Search Depth");
Duncan Sands9dff9be2010-02-15 16:12:20 +00001278 assert(V->getType()->isIntegerTy() && "Not integer or pointer type!");
Victor Hernandez47444882009-11-10 08:28:35 +00001279
Chris Lattner229907c2011-07-18 04:54:35 +00001280 Type *T = V->getType();
Victor Hernandez47444882009-11-10 08:28:35 +00001281
Dan Gohman6a976bb2009-11-18 00:58:27 +00001282 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Victor Hernandez47444882009-11-10 08:28:35 +00001283
1284 if (Base == 0)
1285 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00001286
Victor Hernandez47444882009-11-10 08:28:35 +00001287 if (Base == 1) {
1288 Multiple = V;
1289 return true;
1290 }
1291
1292 ConstantExpr *CO = dyn_cast<ConstantExpr>(V);
1293 Constant *BaseVal = ConstantInt::get(T, Base);
1294 if (CO && CO == BaseVal) {
1295 // Multiple is 1.
1296 Multiple = ConstantInt::get(T, 1);
1297 return true;
1298 }
1299
1300 if (CI && CI->getZExtValue() % Base == 0) {
1301 Multiple = ConstantInt::get(T, CI->getZExtValue() / Base);
Craig Topper1bef2c82012-12-22 19:15:35 +00001302 return true;
Victor Hernandez47444882009-11-10 08:28:35 +00001303 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001304
Victor Hernandez47444882009-11-10 08:28:35 +00001305 if (Depth == MaxDepth) return false; // Limit search depth.
Craig Topper1bef2c82012-12-22 19:15:35 +00001306
Victor Hernandez47444882009-11-10 08:28:35 +00001307 Operator *I = dyn_cast<Operator>(V);
1308 if (!I) return false;
1309
1310 switch (I->getOpcode()) {
1311 default: break;
Chris Lattner4f0b47d2009-11-26 01:50:12 +00001312 case Instruction::SExt:
Victor Hernandez47444882009-11-10 08:28:35 +00001313 if (!LookThroughSExt) return false;
1314 // otherwise fall through to ZExt
Chris Lattner4f0b47d2009-11-26 01:50:12 +00001315 case Instruction::ZExt:
Dan Gohman6a976bb2009-11-18 00:58:27 +00001316 return ComputeMultiple(I->getOperand(0), Base, Multiple,
1317 LookThroughSExt, Depth+1);
Victor Hernandez47444882009-11-10 08:28:35 +00001318 case Instruction::Shl:
1319 case Instruction::Mul: {
1320 Value *Op0 = I->getOperand(0);
1321 Value *Op1 = I->getOperand(1);
1322
1323 if (I->getOpcode() == Instruction::Shl) {
1324 ConstantInt *Op1CI = dyn_cast<ConstantInt>(Op1);
1325 if (!Op1CI) return false;
1326 // Turn Op0 << Op1 into Op0 * 2^Op1
1327 APInt Op1Int = Op1CI->getValue();
1328 uint64_t BitToSet = Op1Int.getLimitedValue(Op1Int.getBitWidth() - 1);
Jay Foad15084f02010-11-30 09:02:01 +00001329 APInt API(Op1Int.getBitWidth(), 0);
Jay Foad25a5e4c2010-12-01 08:53:58 +00001330 API.setBit(BitToSet);
Jay Foad15084f02010-11-30 09:02:01 +00001331 Op1 = ConstantInt::get(V->getContext(), API);
Victor Hernandez47444882009-11-10 08:28:35 +00001332 }
1333
Craig Topper9f008862014-04-15 04:59:12 +00001334 Value *Mul0 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00001335 if (ComputeMultiple(Op0, Base, Mul0, LookThroughSExt, Depth+1)) {
1336 if (Constant *Op1C = dyn_cast<Constant>(Op1))
1337 if (Constant *MulC = dyn_cast<Constant>(Mul0)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00001338 if (Op1C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00001339 MulC->getType()->getPrimitiveSizeInBits())
1340 Op1C = ConstantExpr::getZExt(Op1C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00001341 if (Op1C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00001342 MulC->getType()->getPrimitiveSizeInBits())
1343 MulC = ConstantExpr::getZExt(MulC, Op1C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00001344
Chris Lattner72d283c2010-09-05 17:20:46 +00001345 // V == Base * (Mul0 * Op1), so return (Mul0 * Op1)
1346 Multiple = ConstantExpr::getMul(MulC, Op1C);
1347 return true;
1348 }
Victor Hernandez47444882009-11-10 08:28:35 +00001349
1350 if (ConstantInt *Mul0CI = dyn_cast<ConstantInt>(Mul0))
1351 if (Mul0CI->getValue() == 1) {
1352 // V == Base * Op1, so return Op1
1353 Multiple = Op1;
1354 return true;
1355 }
1356 }
1357
Craig Topper9f008862014-04-15 04:59:12 +00001358 Value *Mul1 = nullptr;
Chris Lattner72d283c2010-09-05 17:20:46 +00001359 if (ComputeMultiple(Op1, Base, Mul1, LookThroughSExt, Depth+1)) {
1360 if (Constant *Op0C = dyn_cast<Constant>(Op0))
1361 if (Constant *MulC = dyn_cast<Constant>(Mul1)) {
Craig Topper1bef2c82012-12-22 19:15:35 +00001362 if (Op0C->getType()->getPrimitiveSizeInBits() <
Chris Lattner72d283c2010-09-05 17:20:46 +00001363 MulC->getType()->getPrimitiveSizeInBits())
1364 Op0C = ConstantExpr::getZExt(Op0C, MulC->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00001365 if (Op0C->getType()->getPrimitiveSizeInBits() >
Chris Lattner72d283c2010-09-05 17:20:46 +00001366 MulC->getType()->getPrimitiveSizeInBits())
1367 MulC = ConstantExpr::getZExt(MulC, Op0C->getType());
Craig Topper1bef2c82012-12-22 19:15:35 +00001368
Chris Lattner72d283c2010-09-05 17:20:46 +00001369 // V == Base * (Mul1 * Op0), so return (Mul1 * Op0)
1370 Multiple = ConstantExpr::getMul(MulC, Op0C);
1371 return true;
1372 }
Victor Hernandez47444882009-11-10 08:28:35 +00001373
1374 if (ConstantInt *Mul1CI = dyn_cast<ConstantInt>(Mul1))
1375 if (Mul1CI->getValue() == 1) {
1376 // V == Base * Op0, so return Op0
1377 Multiple = Op0;
1378 return true;
1379 }
1380 }
Victor Hernandez47444882009-11-10 08:28:35 +00001381 }
1382 }
1383
1384 // We could not determine if V is a multiple of Base.
1385 return false;
1386}
1387
Craig Topper1bef2c82012-12-22 19:15:35 +00001388/// CannotBeNegativeZero - Return true if we can prove that the specified FP
Chris Lattnera12a6de2008-06-02 01:29:46 +00001389/// value is never equal to -0.0.
1390///
1391/// NOTE: this function will need to be revisited when we support non-default
1392/// rounding modes!
1393///
1394bool llvm::CannotBeNegativeZero(const Value *V, unsigned Depth) {
1395 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V))
1396 return !CFP->getValueAPF().isNegZero();
Craig Topper1bef2c82012-12-22 19:15:35 +00001397
Chris Lattnera12a6de2008-06-02 01:29:46 +00001398 if (Depth == 6)
1399 return 1; // Limit search depth.
1400
Dan Gohman80ca01c2009-07-17 20:47:02 +00001401 const Operator *I = dyn_cast<Operator>(V);
Craig Topper9f008862014-04-15 04:59:12 +00001402 if (!I) return false;
Michael Ilseman0f128372012-12-06 00:07:09 +00001403
1404 // Check if the nsz fast-math flag is set
1405 if (const FPMathOperator *FPO = dyn_cast<FPMathOperator>(I))
1406 if (FPO->hasNoSignedZeros())
1407 return true;
1408
Chris Lattnera12a6de2008-06-02 01:29:46 +00001409 // (add x, 0.0) is guaranteed to return +0.0, not -0.0.
Jakub Staszakb7129f22013-03-06 00:16:16 +00001410 if (I->getOpcode() == Instruction::FAdd)
1411 if (ConstantFP *CFP = dyn_cast<ConstantFP>(I->getOperand(1)))
1412 if (CFP->isNullValue())
1413 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00001414
Chris Lattnera12a6de2008-06-02 01:29:46 +00001415 // sitofp and uitofp turn into +0.0 for zero.
1416 if (isa<SIToFPInst>(I) || isa<UIToFPInst>(I))
1417 return true;
Craig Topper1bef2c82012-12-22 19:15:35 +00001418
Chris Lattnera12a6de2008-06-02 01:29:46 +00001419 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I))
1420 // sqrt(-0.0) = -0.0, no other negative results are possible.
1421 if (II->getIntrinsicID() == Intrinsic::sqrt)
Gabor Greif1abbde32010-06-23 23:38:07 +00001422 return CannotBeNegativeZero(II->getArgOperand(0), Depth+1);
Craig Topper1bef2c82012-12-22 19:15:35 +00001423
Chris Lattnera12a6de2008-06-02 01:29:46 +00001424 if (const CallInst *CI = dyn_cast<CallInst>(I))
1425 if (const Function *F = CI->getCalledFunction()) {
1426 if (F->isDeclaration()) {
Daniel Dunbarca414c72009-07-26 08:34:35 +00001427 // abs(x) != -0.0
1428 if (F->getName() == "abs") return true;
Dale Johannesenf6a987b2009-09-25 20:54:50 +00001429 // fabs[lf](x) != -0.0
1430 if (F->getName() == "fabs") return true;
1431 if (F->getName() == "fabsf") return true;
1432 if (F->getName() == "fabsl") return true;
1433 if (F->getName() == "sqrt" || F->getName() == "sqrtf" ||
1434 F->getName() == "sqrtl")
Gabor Greif1abbde32010-06-23 23:38:07 +00001435 return CannotBeNegativeZero(CI->getArgOperand(0), Depth+1);
Chris Lattnera12a6de2008-06-02 01:29:46 +00001436 }
1437 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001438
Chris Lattnera12a6de2008-06-02 01:29:46 +00001439 return false;
1440}
1441
Chris Lattner9cb10352010-12-26 20:15:01 +00001442/// isBytewiseValue - If the specified value can be set by repeating the same
1443/// byte in memory, return the i8 value that it is represented with. This is
1444/// true for all i8 values obviously, but is also true for i32 0, i32 -1,
1445/// i16 0xF0F0, double 0.0 etc. If the value can't be handled with a repeated
1446/// byte store (e.g. i16 0x1234), return null.
1447Value *llvm::isBytewiseValue(Value *V) {
1448 // All byte-wide stores are splatable, even of arbitrary variables.
1449 if (V->getType()->isIntegerTy(8)) return V;
Chris Lattneracf6b072011-02-19 19:35:49 +00001450
1451 // Handle 'null' ConstantArrayZero etc.
1452 if (Constant *C = dyn_cast<Constant>(V))
1453 if (C->isNullValue())
1454 return Constant::getNullValue(Type::getInt8Ty(V->getContext()));
Craig Topper1bef2c82012-12-22 19:15:35 +00001455
Chris Lattner9cb10352010-12-26 20:15:01 +00001456 // Constant float and double values can be handled as integer values if the
Craig Topper1bef2c82012-12-22 19:15:35 +00001457 // corresponding integer value is "byteable". An important case is 0.0.
Chris Lattner9cb10352010-12-26 20:15:01 +00001458 if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
1459 if (CFP->getType()->isFloatTy())
1460 V = ConstantExpr::getBitCast(CFP, Type::getInt32Ty(V->getContext()));
1461 if (CFP->getType()->isDoubleTy())
1462 V = ConstantExpr::getBitCast(CFP, Type::getInt64Ty(V->getContext()));
1463 // Don't handle long double formats, which have strange constraints.
1464 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001465
1466 // We can handle constant integers that are power of two in size and a
Chris Lattner9cb10352010-12-26 20:15:01 +00001467 // multiple of 8 bits.
1468 if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1469 unsigned Width = CI->getBitWidth();
1470 if (isPowerOf2_32(Width) && Width > 8) {
1471 // We can handle this value if the recursive binary decomposition is the
1472 // same at all levels.
1473 APInt Val = CI->getValue();
1474 APInt Val2;
1475 while (Val.getBitWidth() != 8) {
1476 unsigned NextWidth = Val.getBitWidth()/2;
1477 Val2 = Val.lshr(NextWidth);
1478 Val2 = Val2.trunc(Val.getBitWidth()/2);
1479 Val = Val.trunc(Val.getBitWidth()/2);
Craig Topper1bef2c82012-12-22 19:15:35 +00001480
Chris Lattner9cb10352010-12-26 20:15:01 +00001481 // If the top/bottom halves aren't the same, reject it.
1482 if (Val != Val2)
Craig Topper9f008862014-04-15 04:59:12 +00001483 return nullptr;
Chris Lattner9cb10352010-12-26 20:15:01 +00001484 }
1485 return ConstantInt::get(V->getContext(), Val);
1486 }
1487 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001488
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001489 // A ConstantDataArray/Vector is splatable if all its members are equal and
1490 // also splatable.
1491 if (ConstantDataSequential *CA = dyn_cast<ConstantDataSequential>(V)) {
1492 Value *Elt = CA->getElementAsConstant(0);
1493 Value *Val = isBytewiseValue(Elt);
Chris Lattner9cb10352010-12-26 20:15:01 +00001494 if (!Val)
Craig Topper9f008862014-04-15 04:59:12 +00001495 return nullptr;
Craig Topper1bef2c82012-12-22 19:15:35 +00001496
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001497 for (unsigned I = 1, E = CA->getNumElements(); I != E; ++I)
1498 if (CA->getElementAsConstant(I) != Elt)
Craig Topper9f008862014-04-15 04:59:12 +00001499 return nullptr;
Craig Topper1bef2c82012-12-22 19:15:35 +00001500
Chris Lattner9cb10352010-12-26 20:15:01 +00001501 return Val;
1502 }
Chad Rosier8abf65a2011-12-06 00:19:08 +00001503
Chris Lattner9cb10352010-12-26 20:15:01 +00001504 // Conceptually, we could handle things like:
1505 // %a = zext i8 %X to i16
1506 // %b = shl i16 %a, 8
1507 // %c = or i16 %a, %b
1508 // but until there is an example that actually needs this, it doesn't seem
1509 // worth worrying about.
Craig Topper9f008862014-04-15 04:59:12 +00001510 return nullptr;
Chris Lattner9cb10352010-12-26 20:15:01 +00001511}
1512
1513
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001514// This is the recursive version of BuildSubAggregate. It takes a few different
1515// arguments. Idxs is the index within the nested struct From that we are
1516// looking at now (which is of type IndexedType). IdxSkip is the number of
1517// indices from Idxs that should be left out when inserting into the resulting
1518// struct. To is the result struct built so far, new insertvalue instructions
1519// build on that.
Chris Lattner229907c2011-07-18 04:54:35 +00001520static Value *BuildSubAggregate(Value *From, Value* To, Type *IndexedType,
Craig Topper2cd5ff82013-07-11 16:22:38 +00001521 SmallVectorImpl<unsigned> &Idxs,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00001522 unsigned IdxSkip,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00001523 Instruction *InsertBefore) {
Dmitri Gribenko226fea52013-01-13 16:01:15 +00001524 llvm::StructType *STy = dyn_cast<llvm::StructType>(IndexedType);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001525 if (STy) {
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001526 // Save the original To argument so we can modify it
1527 Value *OrigTo = To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001528 // General case, the type indexed by Idxs is a struct
1529 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1530 // Process each struct element recursively
1531 Idxs.push_back(i);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001532 Value *PrevTo = To;
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00001533 To = BuildSubAggregate(From, To, STy->getElementType(i), Idxs, IdxSkip,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00001534 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001535 Idxs.pop_back();
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001536 if (!To) {
1537 // Couldn't find any inserted value for this index? Cleanup
1538 while (PrevTo != OrigTo) {
1539 InsertValueInst* Del = cast<InsertValueInst>(PrevTo);
1540 PrevTo = Del->getAggregateOperand();
1541 Del->eraseFromParent();
1542 }
1543 // Stop processing elements
1544 break;
1545 }
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001546 }
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001547 // If we successfully found a value for each of our subaggregates
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001548 if (To)
1549 return To;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001550 }
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001551 // Base case, the type indexed by SourceIdxs is not a struct, or not all of
1552 // the struct's elements had a value that was inserted directly. In the latter
1553 // case, perhaps we can't determine each of the subelements individually, but
1554 // we might be able to find the complete struct somewhere.
Craig Topper1bef2c82012-12-22 19:15:35 +00001555
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001556 // Find the value that is at that particular spot
Jay Foad57aa6362011-07-13 10:26:04 +00001557 Value *V = FindInsertedValue(From, Idxs);
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001558
1559 if (!V)
Craig Topper9f008862014-04-15 04:59:12 +00001560 return nullptr;
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001561
1562 // Insert the value in the new (sub) aggregrate
Frits van Bommel717d7ed2011-07-18 12:00:32 +00001563 return llvm::InsertValueInst::Create(To, V, makeArrayRef(Idxs).slice(IdxSkip),
Jay Foad57aa6362011-07-13 10:26:04 +00001564 "tmp", InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001565}
1566
1567// This helper takes a nested struct and extracts a part of it (which is again a
1568// struct) into a new value. For example, given the struct:
1569// { a, { b, { c, d }, e } }
1570// and the indices "1, 1" this returns
1571// { c, d }.
1572//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001573// It does this by inserting an insertvalue for each element in the resulting
1574// struct, as opposed to just inserting a single struct. This will only work if
1575// each of the elements of the substruct are known (ie, inserted into From by an
1576// insertvalue instruction somewhere).
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001577//
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001578// All inserted insertvalue instructions are inserted before InsertBefore
Jay Foad57aa6362011-07-13 10:26:04 +00001579static Value *BuildSubAggregate(Value *From, ArrayRef<unsigned> idx_range,
Dan Gohmana6d0afc2009-08-07 01:32:21 +00001580 Instruction *InsertBefore) {
Matthijs Kooijman69801d42008-06-16 13:28:31 +00001581 assert(InsertBefore && "Must have someplace to insert!");
Chris Lattner229907c2011-07-18 04:54:35 +00001582 Type *IndexedType = ExtractValueInst::getIndexedType(From->getType(),
Jay Foad57aa6362011-07-13 10:26:04 +00001583 idx_range);
Owen Andersonb292b8c2009-07-30 23:03:37 +00001584 Value *To = UndefValue::get(IndexedType);
Jay Foad57aa6362011-07-13 10:26:04 +00001585 SmallVector<unsigned, 10> Idxs(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001586 unsigned IdxSkip = Idxs.size();
1587
Nick Lewycky39dbfd32009-11-23 03:29:18 +00001588 return BuildSubAggregate(From, To, IndexedType, Idxs, IdxSkip, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001589}
1590
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00001591/// FindInsertedValue - Given an aggregrate and an sequence of indices, see if
1592/// the scalar value indexed is already around as a register, for example if it
1593/// were inserted directly into the aggregrate.
Matthijs Kooijmanfa4d0b82008-06-16 14:13:46 +00001594///
1595/// If InsertBefore is not null, this function will duplicate (modified)
1596/// insertvalues when a part of a nested struct is extracted.
Jay Foad57aa6362011-07-13 10:26:04 +00001597Value *llvm::FindInsertedValue(Value *V, ArrayRef<unsigned> idx_range,
1598 Instruction *InsertBefore) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001599 // Nothing to index? Just return V then (this is useful at the end of our
Chris Lattnerf7eb5432012-01-24 07:54:10 +00001600 // recursion).
Jay Foad57aa6362011-07-13 10:26:04 +00001601 if (idx_range.empty())
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001602 return V;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00001603 // We have indices, so V should have an indexable type.
1604 assert((V->getType()->isStructTy() || V->getType()->isArrayTy()) &&
1605 "Not looking at a struct or array?");
1606 assert(ExtractValueInst::getIndexedType(V->getType(), idx_range) &&
1607 "Invalid indices for type?");
Owen Andersonf1f17432009-07-06 22:37:39 +00001608
Chris Lattner67058832012-01-25 06:48:06 +00001609 if (Constant *C = dyn_cast<Constant>(V)) {
1610 C = C->getAggregateElement(idx_range[0]);
Craig Topper9f008862014-04-15 04:59:12 +00001611 if (!C) return nullptr;
Chris Lattner67058832012-01-25 06:48:06 +00001612 return FindInsertedValue(C, idx_range.slice(1), InsertBefore);
1613 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001614
Chris Lattnerf7eb5432012-01-24 07:54:10 +00001615 if (InsertValueInst *I = dyn_cast<InsertValueInst>(V)) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001616 // Loop the indices for the insertvalue instruction in parallel with the
1617 // requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00001618 const unsigned *req_idx = idx_range.begin();
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00001619 for (const unsigned *i = I->idx_begin(), *e = I->idx_end();
1620 i != e; ++i, ++req_idx) {
Jay Foad57aa6362011-07-13 10:26:04 +00001621 if (req_idx == idx_range.end()) {
Chris Lattnerf7eb5432012-01-24 07:54:10 +00001622 // We can't handle this without inserting insertvalues
1623 if (!InsertBefore)
Craig Topper9f008862014-04-15 04:59:12 +00001624 return nullptr;
Chris Lattnerf7eb5432012-01-24 07:54:10 +00001625
1626 // The requested index identifies a part of a nested aggregate. Handle
1627 // this specially. For example,
1628 // %A = insertvalue { i32, {i32, i32 } } undef, i32 10, 1, 0
1629 // %B = insertvalue { i32, {i32, i32 } } %A, i32 11, 1, 1
1630 // %C = extractvalue {i32, { i32, i32 } } %B, 1
1631 // This can be changed into
1632 // %A = insertvalue {i32, i32 } undef, i32 10, 0
1633 // %C = insertvalue {i32, i32 } %A, i32 11, 1
1634 // which allows the unused 0,0 element from the nested struct to be
1635 // removed.
1636 return BuildSubAggregate(V, makeArrayRef(idx_range.begin(), req_idx),
1637 InsertBefore);
Duncan Sandsdb356ee2008-06-19 08:47:31 +00001638 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001639
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001640 // This insert value inserts something else than what we are looking for.
1641 // See if the (aggregrate) value inserted into has the value we are
1642 // looking for, then.
1643 if (*req_idx != *i)
Jay Foad57aa6362011-07-13 10:26:04 +00001644 return FindInsertedValue(I->getAggregateOperand(), idx_range,
Nick Lewycky39dbfd32009-11-23 03:29:18 +00001645 InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001646 }
1647 // If we end up here, the indices of the insertvalue match with those
1648 // requested (though possibly only partially). Now we recursively look at
1649 // the inserted value, passing any remaining indices.
Jay Foad57aa6362011-07-13 10:26:04 +00001650 return FindInsertedValue(I->getInsertedValueOperand(),
Frits van Bommel717d7ed2011-07-18 12:00:32 +00001651 makeArrayRef(req_idx, idx_range.end()),
Nick Lewycky39dbfd32009-11-23 03:29:18 +00001652 InsertBefore);
Chris Lattnerf7eb5432012-01-24 07:54:10 +00001653 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001654
Chris Lattnerf7eb5432012-01-24 07:54:10 +00001655 if (ExtractValueInst *I = dyn_cast<ExtractValueInst>(V)) {
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001656 // If we're extracting a value from an aggregrate that was extracted from
1657 // something else, we can extract from that something else directly instead.
1658 // However, we will need to chain I's indices with the requested indices.
Craig Topper1bef2c82012-12-22 19:15:35 +00001659
1660 // Calculate the number of indices required
Jay Foad57aa6362011-07-13 10:26:04 +00001661 unsigned size = I->getNumIndices() + idx_range.size();
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001662 // Allocate some space to put the new indices in
Matthijs Kooijman8369c672008-06-17 08:24:37 +00001663 SmallVector<unsigned, 5> Idxs;
1664 Idxs.reserve(size);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001665 // Add indices from the extract value instruction
Jay Foad57aa6362011-07-13 10:26:04 +00001666 Idxs.append(I->idx_begin(), I->idx_end());
Craig Topper1bef2c82012-12-22 19:15:35 +00001667
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001668 // Add requested indices
Jay Foad57aa6362011-07-13 10:26:04 +00001669 Idxs.append(idx_range.begin(), idx_range.end());
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001670
Craig Topper1bef2c82012-12-22 19:15:35 +00001671 assert(Idxs.size() == size
Matthijs Kooijman5cb38772008-06-16 12:57:37 +00001672 && "Number of indices added not correct?");
Craig Topper1bef2c82012-12-22 19:15:35 +00001673
Jay Foad57aa6362011-07-13 10:26:04 +00001674 return FindInsertedValue(I->getAggregateOperand(), Idxs, InsertBefore);
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001675 }
1676 // Otherwise, we don't know (such as, extracting from a function return value
1677 // or load instruction)
Craig Topper9f008862014-04-15 04:59:12 +00001678 return nullptr;
Matthijs Kooijmane92e18b2008-06-16 12:48:21 +00001679}
Evan Chengda3db112008-06-30 07:31:25 +00001680
Chris Lattnere28618d2010-11-30 22:25:26 +00001681/// GetPointerBaseWithConstantOffset - Analyze the specified pointer to see if
1682/// it can be expressed as a base pointer plus a constant offset. Return the
1683/// base and offset to the caller.
1684Value *llvm::GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00001685 const DataLayout *DL) {
Dan Gohman20a2ae92013-01-31 02:00:45 +00001686 // Without DataLayout, conservatively assume 64-bit offsets, which is
1687 // the widest we support.
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00001688 unsigned BitWidth = DL ? DL->getPointerTypeSizeInBits(Ptr->getType()) : 64;
Nuno Lopes368c4d02012-12-31 20:48:35 +00001689 APInt ByteOffset(BitWidth, 0);
1690 while (1) {
1691 if (Ptr->getType()->isVectorTy())
1692 break;
Craig Topper1bef2c82012-12-22 19:15:35 +00001693
Nuno Lopes368c4d02012-12-31 20:48:35 +00001694 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
Matt Arsenaultf55e5e72013-08-10 17:34:08 +00001695 if (DL) {
1696 APInt GEPOffset(BitWidth, 0);
1697 if (!GEP->accumulateConstantOffset(*DL, GEPOffset))
1698 break;
1699
1700 ByteOffset += GEPOffset;
1701 }
1702
Nuno Lopes368c4d02012-12-31 20:48:35 +00001703 Ptr = GEP->getPointerOperand();
Matt Arsenaultfd78d0c2014-07-14 22:39:22 +00001704 } else if (Operator::getOpcode(Ptr) == Instruction::BitCast ||
1705 Operator::getOpcode(Ptr) == Instruction::AddrSpaceCast) {
Nuno Lopes368c4d02012-12-31 20:48:35 +00001706 Ptr = cast<Operator>(Ptr)->getOperand(0);
1707 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(Ptr)) {
1708 if (GA->mayBeOverridden())
1709 break;
1710 Ptr = GA->getAliasee();
Chris Lattnere28618d2010-11-30 22:25:26 +00001711 } else {
Nuno Lopes368c4d02012-12-31 20:48:35 +00001712 break;
Chris Lattnere28618d2010-11-30 22:25:26 +00001713 }
1714 }
Nuno Lopes368c4d02012-12-31 20:48:35 +00001715 Offset = ByteOffset.getSExtValue();
1716 return Ptr;
Chris Lattnere28618d2010-11-30 22:25:26 +00001717}
1718
1719
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001720/// getConstantStringInfo - This function computes the length of a
Evan Chengda3db112008-06-30 07:31:25 +00001721/// null-terminated C string pointed to by V. If successful, it returns true
1722/// and returns the string in Str. If unsuccessful, it returns false.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001723bool llvm::getConstantStringInfo(const Value *V, StringRef &Str,
1724 uint64_t Offset, bool TrimAtNul) {
1725 assert(V);
Evan Chengda3db112008-06-30 07:31:25 +00001726
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001727 // Look through bitcast instructions and geps.
1728 V = V->stripPointerCasts();
Craig Topper1bef2c82012-12-22 19:15:35 +00001729
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001730 // If the value is a GEP instructionor constant expression, treat it as an
1731 // offset.
1732 if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
Evan Chengda3db112008-06-30 07:31:25 +00001733 // Make sure the GEP has exactly three arguments.
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001734 if (GEP->getNumOperands() != 3)
1735 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00001736
Evan Chengda3db112008-06-30 07:31:25 +00001737 // Make sure the index-ee is a pointer to array of i8.
Chris Lattner229907c2011-07-18 04:54:35 +00001738 PointerType *PT = cast<PointerType>(GEP->getOperand(0)->getType());
1739 ArrayType *AT = dyn_cast<ArrayType>(PT->getElementType());
Craig Topper9f008862014-04-15 04:59:12 +00001740 if (!AT || !AT->getElementType()->isIntegerTy(8))
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001741 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00001742
Evan Chengda3db112008-06-30 07:31:25 +00001743 // Check to make sure that the first operand of the GEP is an integer and
1744 // has value 0 so that we are sure we're indexing into the initializer.
Dan Gohman0b4df042010-04-14 22:20:45 +00001745 const ConstantInt *FirstIdx = dyn_cast<ConstantInt>(GEP->getOperand(1));
Craig Topper9f008862014-04-15 04:59:12 +00001746 if (!FirstIdx || !FirstIdx->isZero())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001747 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00001748
Evan Chengda3db112008-06-30 07:31:25 +00001749 // If the second index isn't a ConstantInt, then this is a variable index
1750 // into the array. If this occurs, we can't say anything meaningful about
1751 // the string.
1752 uint64_t StartIdx = 0;
Dan Gohman0b4df042010-04-14 22:20:45 +00001753 if (const ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(2)))
Evan Chengda3db112008-06-30 07:31:25 +00001754 StartIdx = CI->getZExtValue();
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001755 else
1756 return false;
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001757 return getConstantStringInfo(GEP->getOperand(0), Str, StartIdx+Offset);
Evan Chengda3db112008-06-30 07:31:25 +00001758 }
Nick Lewycky46209882011-10-20 00:34:35 +00001759
Evan Chengda3db112008-06-30 07:31:25 +00001760 // The GEP instruction, constant or instruction, must reference a global
1761 // variable that is a constant and is initialized. The referenced constant
1762 // initializer is the array that we'll use for optimization.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001763 const GlobalVariable *GV = dyn_cast<GlobalVariable>(V);
Dan Gohman5d5bc6d2009-08-19 18:20:44 +00001764 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001765 return false;
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001766
Nick Lewycky46209882011-10-20 00:34:35 +00001767 // Handle the all-zeros case
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001768 if (GV->getInitializer()->isNullValue()) {
Evan Chengda3db112008-06-30 07:31:25 +00001769 // This is a degenerate case. The initializer is constant zero so the
1770 // length of the string must be zero.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001771 Str = "";
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001772 return true;
1773 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001774
Evan Chengda3db112008-06-30 07:31:25 +00001775 // Must be a Constant Array
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001776 const ConstantDataArray *Array =
1777 dyn_cast<ConstantDataArray>(GV->getInitializer());
Craig Topper9f008862014-04-15 04:59:12 +00001778 if (!Array || !Array->isString())
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001779 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00001780
Evan Chengda3db112008-06-30 07:31:25 +00001781 // Get the number of elements in the array
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001782 uint64_t NumElts = Array->getType()->getArrayNumElements();
1783
1784 // Start out with the entire array in the StringRef.
1785 Str = Array->getAsString();
1786
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001787 if (Offset > NumElts)
1788 return false;
Craig Topper1bef2c82012-12-22 19:15:35 +00001789
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001790 // Skip over 'offset' bytes.
1791 Str = Str.substr(Offset);
Craig Topper1bef2c82012-12-22 19:15:35 +00001792
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001793 if (TrimAtNul) {
1794 // Trim off the \0 and anything after it. If the array is not nul
1795 // terminated, we just return the whole end of string. The client may know
1796 // some other way that the string is length-bound.
1797 Str = Str.substr(0, Str.find('\0'));
1798 }
Bill Wendlingfa54bc22009-03-13 04:39:26 +00001799 return true;
Evan Chengda3db112008-06-30 07:31:25 +00001800}
Eric Christopher4899cbc2010-03-05 06:58:57 +00001801
1802// These next two are very similar to the above, but also look through PHI
1803// nodes.
1804// TODO: See if we can integrate these two together.
1805
1806/// GetStringLengthH - If we can compute the length of the string pointed to by
1807/// the specified pointer, return 'len+1'. If we can't, return 0.
Craig Topper71b7b682014-08-21 05:55:13 +00001808static uint64_t GetStringLengthH(Value *V, SmallPtrSetImpl<PHINode*> &PHIs) {
Eric Christopher4899cbc2010-03-05 06:58:57 +00001809 // Look through noop bitcast instructions.
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001810 V = V->stripPointerCasts();
Eric Christopher4899cbc2010-03-05 06:58:57 +00001811
1812 // If this is a PHI node, there are two cases: either we have already seen it
1813 // or we haven't.
1814 if (PHINode *PN = dyn_cast<PHINode>(V)) {
1815 if (!PHIs.insert(PN))
1816 return ~0ULL; // already in the set.
1817
1818 // If it was new, see if all the input strings are the same length.
1819 uint64_t LenSoFar = ~0ULL;
1820 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1821 uint64_t Len = GetStringLengthH(PN->getIncomingValue(i), PHIs);
1822 if (Len == 0) return 0; // Unknown length -> unknown.
1823
1824 if (Len == ~0ULL) continue;
1825
1826 if (Len != LenSoFar && LenSoFar != ~0ULL)
1827 return 0; // Disagree -> unknown.
1828 LenSoFar = Len;
1829 }
1830
1831 // Success, all agree.
1832 return LenSoFar;
1833 }
1834
1835 // strlen(select(c,x,y)) -> strlen(x) ^ strlen(y)
1836 if (SelectInst *SI = dyn_cast<SelectInst>(V)) {
1837 uint64_t Len1 = GetStringLengthH(SI->getTrueValue(), PHIs);
1838 if (Len1 == 0) return 0;
1839 uint64_t Len2 = GetStringLengthH(SI->getFalseValue(), PHIs);
1840 if (Len2 == 0) return 0;
1841 if (Len1 == ~0ULL) return Len2;
1842 if (Len2 == ~0ULL) return Len1;
1843 if (Len1 != Len2) return 0;
1844 return Len1;
1845 }
Craig Topper1bef2c82012-12-22 19:15:35 +00001846
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001847 // Otherwise, see if we can read the string.
1848 StringRef StrData;
1849 if (!getConstantStringInfo(V, StrData))
Eric Christopher4899cbc2010-03-05 06:58:57 +00001850 return 0;
1851
Chris Lattnercf9e8f62012-02-05 02:29:43 +00001852 return StrData.size()+1;
Eric Christopher4899cbc2010-03-05 06:58:57 +00001853}
1854
1855/// GetStringLength - If we can compute the length of the string pointed to by
1856/// the specified pointer, return 'len+1'. If we can't, return 0.
1857uint64_t llvm::GetStringLength(Value *V) {
1858 if (!V->getType()->isPointerTy()) return 0;
1859
1860 SmallPtrSet<PHINode*, 32> PHIs;
1861 uint64_t Len = GetStringLengthH(V, PHIs);
1862 // If Len is ~0ULL, we had an infinite phi cycle: this is dead code, so return
1863 // an empty string as a length.
1864 return Len == ~0ULL ? 1 : Len;
1865}
Dan Gohmana4fcd242010-12-15 20:02:24 +00001866
Dan Gohman0f124e12011-01-24 18:53:32 +00001867Value *
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001868llvm::GetUnderlyingObject(Value *V, const DataLayout *TD, unsigned MaxLookup) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00001869 if (!V->getType()->isPointerTy())
1870 return V;
1871 for (unsigned Count = 0; MaxLookup == 0 || Count < MaxLookup; ++Count) {
1872 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
1873 V = GEP->getPointerOperand();
Matt Arsenault70f4db882014-07-15 00:56:40 +00001874 } else if (Operator::getOpcode(V) == Instruction::BitCast ||
1875 Operator::getOpcode(V) == Instruction::AddrSpaceCast) {
Dan Gohmana4fcd242010-12-15 20:02:24 +00001876 V = cast<Operator>(V)->getOperand(0);
1877 } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
1878 if (GA->mayBeOverridden())
1879 return V;
1880 V = GA->getAliasee();
1881 } else {
Dan Gohman05b18f12010-12-15 20:49:55 +00001882 // See if InstructionSimplify knows any relevant tricks.
1883 if (Instruction *I = dyn_cast<Instruction>(V))
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001884 // TODO: Acquire a DominatorTree and use it.
Craig Topper9f008862014-04-15 04:59:12 +00001885 if (Value *Simplified = SimplifyInstruction(I, TD, nullptr)) {
Dan Gohman05b18f12010-12-15 20:49:55 +00001886 V = Simplified;
1887 continue;
1888 }
1889
Dan Gohmana4fcd242010-12-15 20:02:24 +00001890 return V;
1891 }
1892 assert(V->getType()->isPointerTy() && "Unexpected operand type!");
1893 }
1894 return V;
1895}
Nick Lewycky3e334a42011-06-27 04:20:45 +00001896
Dan Gohmaned7c24e22012-05-10 18:57:38 +00001897void
1898llvm::GetUnderlyingObjects(Value *V,
1899 SmallVectorImpl<Value *> &Objects,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001900 const DataLayout *TD,
Dan Gohmaned7c24e22012-05-10 18:57:38 +00001901 unsigned MaxLookup) {
1902 SmallPtrSet<Value *, 4> Visited;
1903 SmallVector<Value *, 4> Worklist;
1904 Worklist.push_back(V);
1905 do {
1906 Value *P = Worklist.pop_back_val();
1907 P = GetUnderlyingObject(P, TD, MaxLookup);
1908
1909 if (!Visited.insert(P))
1910 continue;
1911
1912 if (SelectInst *SI = dyn_cast<SelectInst>(P)) {
1913 Worklist.push_back(SI->getTrueValue());
1914 Worklist.push_back(SI->getFalseValue());
1915 continue;
1916 }
1917
1918 if (PHINode *PN = dyn_cast<PHINode>(P)) {
1919 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1920 Worklist.push_back(PN->getIncomingValue(i));
1921 continue;
1922 }
1923
1924 Objects.push_back(P);
1925 } while (!Worklist.empty());
1926}
1927
Nick Lewycky3e334a42011-06-27 04:20:45 +00001928/// onlyUsedByLifetimeMarkers - Return true if the only users of this pointer
1929/// are lifetime markers.
1930///
1931bool llvm::onlyUsedByLifetimeMarkers(const Value *V) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001932 for (const User *U : V->users()) {
1933 const IntrinsicInst *II = dyn_cast<IntrinsicInst>(U);
Nick Lewycky3e334a42011-06-27 04:20:45 +00001934 if (!II) return false;
1935
1936 if (II->getIntrinsicID() != Intrinsic::lifetime_start &&
1937 II->getIntrinsicID() != Intrinsic::lifetime_end)
1938 return false;
1939 }
1940 return true;
1941}
Dan Gohman75d7d5e2011-12-14 23:49:11 +00001942
Dan Gohman7ac046a2012-01-04 23:01:09 +00001943bool llvm::isSafeToSpeculativelyExecute(const Value *V,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001944 const DataLayout *TD) {
Dan Gohman7ac046a2012-01-04 23:01:09 +00001945 const Operator *Inst = dyn_cast<Operator>(V);
1946 if (!Inst)
1947 return false;
1948
Dan Gohman75d7d5e2011-12-14 23:49:11 +00001949 for (unsigned i = 0, e = Inst->getNumOperands(); i != e; ++i)
1950 if (Constant *C = dyn_cast<Constant>(Inst->getOperand(i)))
1951 if (C->canTrap())
1952 return false;
1953
1954 switch (Inst->getOpcode()) {
1955 default:
1956 return true;
1957 case Instruction::UDiv:
1958 case Instruction::URem:
Sanjay Patel784a5a42014-07-06 23:24:53 +00001959 // x / y is undefined if y == 0, but calculations like x / 3 are safe.
Dan Gohman75d7d5e2011-12-14 23:49:11 +00001960 return isKnownNonZero(Inst->getOperand(1), TD);
1961 case Instruction::SDiv:
1962 case Instruction::SRem: {
1963 Value *Op = Inst->getOperand(1);
1964 // x / y is undefined if y == 0
1965 if (!isKnownNonZero(Op, TD))
1966 return false;
1967 // x / y might be undefined if y == -1
1968 unsigned BitWidth = getBitWidth(Op->getType(), TD);
1969 if (BitWidth == 0)
1970 return false;
1971 APInt KnownZero(BitWidth, 0);
1972 APInt KnownOne(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +00001973 computeKnownBits(Op, KnownZero, KnownOne, TD);
Dan Gohman75d7d5e2011-12-14 23:49:11 +00001974 return !!KnownZero;
1975 }
1976 case Instruction::Load: {
1977 const LoadInst *LI = cast<LoadInst>(Inst);
Kostya Serebryany0b458282013-11-21 07:29:28 +00001978 if (!LI->isUnordered() ||
1979 // Speculative load may create a race that did not exist in the source.
1980 LI->getParent()->getParent()->hasFnAttribute(Attribute::SanitizeThread))
Dan Gohman75d7d5e2011-12-14 23:49:11 +00001981 return false;
Hal Finkel2e42c342014-07-10 05:27:53 +00001982 return LI->getPointerOperand()->isDereferenceablePointer(TD);
Dan Gohman75d7d5e2011-12-14 23:49:11 +00001983 }
Nick Lewyckyb4039f62011-12-21 05:52:02 +00001984 case Instruction::Call: {
1985 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
1986 switch (II->getIntrinsicID()) {
Sanjay Patel784a5a42014-07-06 23:24:53 +00001987 // These synthetic intrinsics have no side-effects and just mark
Chandler Carruth28192c92012-04-07 19:22:18 +00001988 // information about their operands.
1989 // FIXME: There are other no-op synthetic instructions that potentially
1990 // should be considered at least *safe* to speculate...
1991 case Intrinsic::dbg_declare:
1992 case Intrinsic::dbg_value:
1993 return true;
1994
Nick Lewyckyb4039f62011-12-21 05:52:02 +00001995 case Intrinsic::bswap:
1996 case Intrinsic::ctlz:
1997 case Intrinsic::ctpop:
1998 case Intrinsic::cttz:
1999 case Intrinsic::objectsize:
2000 case Intrinsic::sadd_with_overflow:
2001 case Intrinsic::smul_with_overflow:
2002 case Intrinsic::ssub_with_overflow:
2003 case Intrinsic::uadd_with_overflow:
2004 case Intrinsic::umul_with_overflow:
2005 case Intrinsic::usub_with_overflow:
2006 return true;
Matt Arsenaultee364ee2014-01-31 00:09:00 +00002007 // Sqrt should be OK, since the llvm sqrt intrinsic isn't defined to set
2008 // errno like libm sqrt would.
2009 case Intrinsic::sqrt:
2010 case Intrinsic::fma:
2011 case Intrinsic::fmuladd:
Matt Arsenault85cbc7e2014-08-29 16:01:17 +00002012 case Intrinsic::fabs:
Matt Arsenaultee364ee2014-01-31 00:09:00 +00002013 return true;
Nick Lewyckyb4039f62011-12-21 05:52:02 +00002014 // TODO: some fp intrinsics are marked as having the same error handling
2015 // as libm. They're safe to speculate when they won't error.
2016 // TODO: are convert_{from,to}_fp16 safe?
2017 // TODO: can we list target-specific intrinsics here?
2018 default: break;
2019 }
2020 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00002021 return false; // The called function could have undefined behavior or
Nick Lewyckyb4039f62011-12-21 05:52:02 +00002022 // side-effects, even if marked readnone nounwind.
2023 }
Dan Gohman75d7d5e2011-12-14 23:49:11 +00002024 case Instruction::VAArg:
2025 case Instruction::Alloca:
2026 case Instruction::Invoke:
2027 case Instruction::PHI:
2028 case Instruction::Store:
2029 case Instruction::Ret:
2030 case Instruction::Br:
2031 case Instruction::IndirectBr:
2032 case Instruction::Switch:
Dan Gohman75d7d5e2011-12-14 23:49:11 +00002033 case Instruction::Unreachable:
2034 case Instruction::Fence:
2035 case Instruction::LandingPad:
2036 case Instruction::AtomicRMW:
2037 case Instruction::AtomicCmpXchg:
2038 case Instruction::Resume:
2039 return false; // Misc instructions which have effects
2040 }
2041}
Dan Gohman1b0f79d2013-01-31 02:40:59 +00002042
2043/// isKnownNonNull - Return true if we know that the specified value is never
2044/// null.
Benjamin Kramerfd4777c2013-09-24 16:37:51 +00002045bool llvm::isKnownNonNull(const Value *V, const TargetLibraryInfo *TLI) {
Dan Gohman1b0f79d2013-01-31 02:40:59 +00002046 // Alloca never returns null, malloc might.
2047 if (isa<AllocaInst>(V)) return true;
2048
Nick Lewyckyd52b1522014-05-20 01:23:40 +00002049 // A byval, inalloca, or nonnull argument is never null.
Dan Gohman1b0f79d2013-01-31 02:40:59 +00002050 if (const Argument *A = dyn_cast<Argument>(V))
Nick Lewyckyd52b1522014-05-20 01:23:40 +00002051 return A->hasByValOrInAllocaAttr() || A->hasNonNullAttr();
Dan Gohman1b0f79d2013-01-31 02:40:59 +00002052
2053 // Global values are not null unless extern weak.
2054 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2055 return !GV->hasExternalWeakLinkage();
Benjamin Kramerfd4777c2013-09-24 16:37:51 +00002056
Nick Lewyckyec373542014-05-20 05:13:21 +00002057 if (ImmutableCallSite CS = V)
Hal Finkelb0407ba2014-07-18 15:51:28 +00002058 if (CS.isReturnNonNull())
Nick Lewyckyec373542014-05-20 05:13:21 +00002059 return true;
2060
Benjamin Kramerfd4777c2013-09-24 16:37:51 +00002061 // operator new never returns null.
2062 if (isOperatorNewLikeFn(V, TLI, /*LookThroughBitCast=*/true))
2063 return true;
2064
Dan Gohman1b0f79d2013-01-31 02:40:59 +00002065 return false;
2066}