1 //===- llvm/Analysis/ValueTracking.h - Walk computations --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains routines that help analyze properties that chains of
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_ANALYSIS_VALUETRACKING_H
16 #define LLVM_ANALYSIS_VALUETRACKING_H
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/Support/DataTypes.h"
28 class AssumptionCache;
30 class TargetLibraryInfo;
32 /// Determine which bits of V are known to be either zero or one and return
33 /// them in the KnownZero/KnownOne bit sets.
35 /// This function is defined on values with integer type, values with pointer
36 /// type (but only if TD is non-null), and vectors of integers. In the case
37 /// where V is a vector, the known zero and known one values are the
38 /// same width as the vector element, and the bit is set only if it is true
39 /// for all of the elements in the vector.
40 void computeKnownBits(Value *V, APInt &KnownZero, APInt &KnownOne,
41 const DataLayout *TD = nullptr, unsigned Depth = 0,
42 AssumptionCache *AC = nullptr,
43 const Instruction *CxtI = nullptr,
44 const DominatorTree *DT = nullptr);
45 /// Compute known bits from the range metadata.
46 /// \p KnownZero the set of bits that are known to be zero
47 void computeKnownBitsFromRangeMetadata(const MDNode &Ranges,
50 /// ComputeSignBit - Determine whether the sign bit is known to be zero or
51 /// one. Convenience wrapper around computeKnownBits.
52 void ComputeSignBit(Value *V, bool &KnownZero, bool &KnownOne,
53 const DataLayout *TD = nullptr, unsigned Depth = 0,
54 AssumptionCache *AC = nullptr,
55 const Instruction *CxtI = nullptr,
56 const DominatorTree *DT = nullptr);
58 /// isKnownToBeAPowerOfTwo - Return true if the given value is known to have
59 /// exactly one bit set when defined. For vectors return true if every
60 /// element is known to be a power of two when defined. Supports values with
61 /// integer or pointer type and vectors of integers. If 'OrZero' is set then
62 /// returns true if the given value is either a power of two or zero.
63 bool isKnownToBeAPowerOfTwo(Value *V, bool OrZero = false, unsigned Depth = 0,
64 AssumptionCache *AC = nullptr,
65 const Instruction *CxtI = nullptr,
66 const DominatorTree *DT = nullptr);
68 /// isKnownNonZero - Return true if the given value is known to be non-zero
69 /// when defined. For vectors return true if every element is known to be
70 /// non-zero when defined. Supports values with integer or pointer type and
71 /// vectors of integers.
72 bool isKnownNonZero(Value *V, const DataLayout *TD = nullptr,
73 unsigned Depth = 0, AssumptionCache *AC = nullptr,
74 const Instruction *CxtI = nullptr,
75 const DominatorTree *DT = nullptr);
77 /// MaskedValueIsZero - Return true if 'V & Mask' is known to be zero. We use
78 /// this predicate to simplify operations downstream. Mask is known to be
79 /// zero for bits that V cannot have.
81 /// This function is defined on values with integer type, values with pointer
82 /// type (but only if TD is non-null), and vectors of integers. In the case
83 /// where V is a vector, the mask, known zero, and known one values are the
84 /// same width as the vector element, and the bit is set only if it is true
85 /// for all of the elements in the vector.
86 bool MaskedValueIsZero(Value *V, const APInt &Mask,
87 const DataLayout *TD = nullptr, unsigned Depth = 0,
88 AssumptionCache *AC = nullptr,
89 const Instruction *CxtI = nullptr,
90 const DominatorTree *DT = nullptr);
92 /// ComputeNumSignBits - Return the number of times the sign bit of the
93 /// register is replicated into the other bits. We know that at least 1 bit
94 /// is always equal to the sign bit (itself), but other cases can give us
95 /// information. For example, immediately after an "ashr X, 2", we know that
96 /// the top 3 bits are all equal to each other, so we return 3.
98 /// 'Op' must have a scalar integer type.
100 unsigned ComputeNumSignBits(Value *Op, const DataLayout *TD = nullptr,
101 unsigned Depth = 0, AssumptionCache *AC = nullptr,
102 const Instruction *CxtI = nullptr,
103 const DominatorTree *DT = nullptr);
105 /// ComputeMultiple - This function computes the integer multiple of Base that
106 /// equals V. If successful, it returns true and returns the multiple in
107 /// Multiple. If unsuccessful, it returns false. Also, if V can be
108 /// simplified to an integer, then the simplified V is returned in Val. Look
109 /// through sext only if LookThroughSExt=true.
110 bool ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
111 bool LookThroughSExt = false,
114 /// CannotBeNegativeZero - Return true if we can prove that the specified FP
115 /// value is never equal to -0.0.
117 bool CannotBeNegativeZero(const Value *V, unsigned Depth = 0);
119 /// CannotBeOrderedLessThanZero - Return true if we can prove that the
120 /// specified FP value is either a NaN or never less than 0.0.
122 bool CannotBeOrderedLessThanZero(const Value *V, unsigned Depth = 0);
124 /// isBytewiseValue - If the specified value can be set by repeating the same
125 /// byte in memory, return the i8 value that it is represented with. This is
126 /// true for all i8 values obviously, but is also true for i32 0, i32 -1,
127 /// i16 0xF0F0, double 0.0 etc. If the value can't be handled with a repeated
128 /// byte store (e.g. i16 0x1234), return null.
129 Value *isBytewiseValue(Value *V);
131 /// FindInsertedValue - Given an aggregrate and an sequence of indices, see if
132 /// the scalar value indexed is already around as a register, for example if
133 /// it were inserted directly into the aggregrate.
135 /// If InsertBefore is not null, this function will duplicate (modified)
136 /// insertvalues when a part of a nested struct is extracted.
137 Value *FindInsertedValue(Value *V,
138 ArrayRef<unsigned> idx_range,
139 Instruction *InsertBefore = nullptr);
141 /// GetPointerBaseWithConstantOffset - Analyze the specified pointer to see if
142 /// it can be expressed as a base pointer plus a constant offset. Return the
143 /// base and offset to the caller.
144 Value *GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
145 const DataLayout *TD);
146 static inline const Value *
147 GetPointerBaseWithConstantOffset(const Value *Ptr, int64_t &Offset,
148 const DataLayout *TD) {
149 return GetPointerBaseWithConstantOffset(const_cast<Value*>(Ptr), Offset,TD);
152 /// getConstantStringInfo - This function computes the length of a
153 /// null-terminated C string pointed to by V. If successful, it returns true
154 /// and returns the string in Str. If unsuccessful, it returns false. This
155 /// does not include the trailing nul character by default. If TrimAtNul is
156 /// set to false, then this returns any trailing nul characters as well as any
157 /// other characters that come after it.
158 bool getConstantStringInfo(const Value *V, StringRef &Str,
159 uint64_t Offset = 0, bool TrimAtNul = true);
161 /// GetStringLength - If we can compute the length of the string pointed to by
162 /// the specified pointer, return 'len+1'. If we can't, return 0.
163 uint64_t GetStringLength(Value *V);
165 /// GetUnderlyingObject - This method strips off any GEP address adjustments
166 /// and pointer casts from the specified value, returning the original object
167 /// being addressed. Note that the returned value has pointer type if the
168 /// specified value does. If the MaxLookup value is non-zero, it limits the
169 /// number of instructions to be stripped off.
170 Value *GetUnderlyingObject(Value *V, const DataLayout *TD = nullptr,
171 unsigned MaxLookup = 6);
172 static inline const Value *
173 GetUnderlyingObject(const Value *V, const DataLayout *TD = nullptr,
174 unsigned MaxLookup = 6) {
175 return GetUnderlyingObject(const_cast<Value *>(V), TD, MaxLookup);
178 /// GetUnderlyingObjects - This method is similar to GetUnderlyingObject
179 /// except that it can look through phi and select instructions and return
180 /// multiple objects.
181 void GetUnderlyingObjects(Value *V,
182 SmallVectorImpl<Value *> &Objects,
183 const DataLayout *TD = nullptr,
184 unsigned MaxLookup = 6);
186 /// onlyUsedByLifetimeMarkers - Return true if the only users of this pointer
187 /// are lifetime markers.
188 bool onlyUsedByLifetimeMarkers(const Value *V);
190 /// isSafeToSpeculativelyExecute - Return true if the instruction does not
191 /// have any effects besides calculating the result and does not have
192 /// undefined behavior.
194 /// This method never returns true for an instruction that returns true for
195 /// mayHaveSideEffects; however, this method also does some other checks in
196 /// addition. It checks for undefined behavior, like dividing by zero or
197 /// loading from an invalid pointer (but not for undefined results, like a
198 /// shift with a shift amount larger than the width of the result). It checks
199 /// for malloc and alloca because speculatively executing them might cause a
200 /// memory leak. It also returns false for instructions related to control
201 /// flow, specifically terminators and PHI nodes.
203 /// This method only looks at the instruction itself and its operands, so if
204 /// this method returns true, it is safe to move the instruction as long as
205 /// the correct dominance relationships for the operands and users hold.
206 /// However, this method can return true for instructions that read memory;
207 /// for such instructions, moving them may change the resulting value.
208 bool isSafeToSpeculativelyExecute(const Value *V,
209 const DataLayout *TD = nullptr);
211 /// isKnownNonNull - Return true if this pointer couldn't possibly be null by
212 /// its definition. This returns true for allocas, non-extern-weak globals
213 /// and byval arguments.
214 bool isKnownNonNull(const Value *V, const TargetLibraryInfo *TLI = nullptr);
216 /// Return true if it is valid to use the assumptions provided by an
217 /// assume intrinsic, I, at the point in the control-flow identified by the
218 /// context instruction, CxtI.
219 bool isValidAssumeForContext(const Instruction *I, const Instruction *CxtI,
220 const DataLayout *DL = nullptr,
221 const DominatorTree *DT = nullptr);
223 enum class OverflowResult { AlwaysOverflows, MayOverflow, NeverOverflows };
224 OverflowResult computeOverflowForUnsignedMul(Value *LHS, Value *RHS,
225 const DataLayout *DL,
227 const Instruction *CxtI,
228 const DominatorTree *DT);
229 OverflowResult computeOverflowForUnsignedAdd(Value *LHS, Value *RHS,
230 const DataLayout *DL,
232 const Instruction *CxtI,
233 const DominatorTree *DT);
234 } // end namespace llvm