1 //===-- llvm/Value.h - Definition of the Value class ------------*- 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 declares the Value class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_IR_VALUE_H
15 #define LLVM_IR_VALUE_H
17 #include "llvm-c/Core.h"
18 #include "llvm/ADT/iterator_range.h"
19 #include "llvm/IR/Use.h"
20 #include "llvm/Support/CBindingWrapping.h"
21 #include "llvm/Support/Casting.h"
22 #include "llvm/Support/Compiler.h"
28 class AssemblyAnnotationWriter;
44 class ValueHandleBase;
45 class ValueSymbolTable;
48 template<typename ValueTy> class StringMapEntry;
49 typedef StringMapEntry<Value*> ValueName;
51 //===----------------------------------------------------------------------===//
53 //===----------------------------------------------------------------------===//
55 /// This is a very important LLVM class. It is the base class of all values
56 /// computed by a program that may be used as operands to other values. Value is
57 /// the super class of other important classes such as Instruction and Function.
58 /// All Values have a Type. Type is not a subclass of Value. Some values can
59 /// have a name and they belong to some Module. Setting the name on the Value
60 /// automatically updates the module's symbol table.
62 /// Every value has a "use list" that keeps track of which other Values are
63 /// using this Value. A Value can also have an arbitrary number of ValueHandle
64 /// objects that watch it and listen to RAUW and Destroy events. See
65 /// llvm/IR/ValueHandle.h for details.
67 /// @brief LLVM Value Representation
69 const unsigned char SubclassID; // Subclass identifier (for isa/dyn_cast)
70 unsigned char HasValueHandle : 1; // Has a ValueHandle pointing to this?
72 /// SubclassOptionalData - This member is similar to SubclassData, however it
73 /// is for holding information which may be used to aid optimization, but
74 /// which may be cleared to zero without affecting conservative
76 unsigned char SubclassOptionalData : 7;
79 template <typename UseT> // UseT == 'Use' or 'const Use'
80 class use_iterator_impl
81 : public std::iterator<std::forward_iterator_tag, UseT *, ptrdiff_t> {
82 typedef std::iterator<std::forward_iterator_tag, UseT *, ptrdiff_t> super;
85 explicit use_iterator_impl(UseT *u) : U(u) {}
89 typedef typename super::reference reference;
90 typedef typename super::pointer pointer;
92 use_iterator_impl() : U() {}
94 bool operator==(const use_iterator_impl &x) const { return U == x.U; }
95 bool operator!=(const use_iterator_impl &x) const { return !operator==(x); }
97 use_iterator_impl &operator++() { // Preincrement
98 assert(U && "Cannot increment end iterator!");
102 use_iterator_impl operator++(int) { // Postincrement
108 UseT &operator*() const {
109 assert(U && "Cannot dereference end iterator!");
113 UseT *operator->() const { return &operator*(); }
115 operator use_iterator_impl<const UseT>() const {
116 return use_iterator_impl<const UseT>(U);
120 template <typename UserTy> // UserTy == 'User' or 'const User'
121 class user_iterator_impl
122 : public std::iterator<std::forward_iterator_tag, UserTy *, ptrdiff_t> {
123 typedef std::iterator<std::forward_iterator_tag, UserTy *, ptrdiff_t> super;
125 use_iterator_impl<Use> UI;
126 explicit user_iterator_impl(Use *U) : UI(U) {}
130 typedef typename super::reference reference;
131 typedef typename super::pointer pointer;
133 user_iterator_impl() {}
135 bool operator==(const user_iterator_impl &x) const { return UI == x.UI; }
136 bool operator!=(const user_iterator_impl &x) const { return !operator==(x); }
138 /// \brief Returns true if this iterator is equal to user_end() on the value.
139 bool atEnd() const { return *this == user_iterator_impl(); }
141 user_iterator_impl &operator++() { // Preincrement
145 user_iterator_impl operator++(int) { // Postincrement
151 // Retrieve a pointer to the current User.
152 UserTy *operator*() const {
153 return UI->getUser();
156 UserTy *operator->() const { return operator*(); }
158 operator user_iterator_impl<const UserTy>() const {
159 return user_iterator_impl<const UserTy>(*UI);
162 Use &getUse() const { return *UI; }
164 /// \brief Return the operand # of this use in its User.
165 /// FIXME: Replace all callers with a direct call to Use::getOperandNo.
166 unsigned getOperandNo() const { return UI->getOperandNo(); }
169 /// SubclassData - This member is defined by this class, but is not used for
170 /// anything. Subclasses can use it to hold whatever state they find useful.
171 /// This field is initialized to zero by the ctor.
172 unsigned short SubclassData;
177 friend class ValueSymbolTable; // Allow ValueSymbolTable to directly mod Name.
178 friend class ValueHandleBase;
181 void operator=(const Value &) LLVM_DELETED_FUNCTION;
182 Value(const Value &) LLVM_DELETED_FUNCTION;
185 /// printCustom - Value subclasses can override this to implement custom
186 /// printing behavior.
187 virtual void printCustom(raw_ostream &O) const;
189 Value(Type *Ty, unsigned scid);
193 /// dump - Support for debugging, callable in GDB: V->dump()
197 /// print - Implement operator<< on Value.
199 void print(raw_ostream &O) const;
201 /// \brief Print the name of this Value out to the specified raw_ostream.
202 /// This is useful when you just want to print 'int %reg126', not the
203 /// instruction that generated it. If you specify a Module for context, then
204 /// even constanst get pretty-printed; for example, the type of a null
205 /// pointer is printed symbolically.
206 void printAsOperand(raw_ostream &O, bool PrintType = true, const Module *M = 0) const;
208 /// All values are typed, get the type of this value.
210 Type *getType() const { return VTy; }
212 /// All values hold a context through their type.
213 LLVMContext &getContext() const;
215 // All values can potentially be named.
216 bool hasName() const { return Name != 0 && SubclassID != MDStringVal; }
217 ValueName *getValueName() const { return Name; }
218 void setValueName(ValueName *VN) { Name = VN; }
220 /// getName() - Return a constant reference to the value's name. This is cheap
221 /// and guaranteed to return the same reference as long as the value is not
223 StringRef getName() const;
225 /// setName() - Change the name of the value, choosing a new unique name if
226 /// the provided name is taken.
228 /// \param Name The new name; or "" if the value's name should be removed.
229 void setName(const Twine &Name);
232 /// takeName - transfer the name from V to this value, setting V's name to
233 /// empty. It is an error to call V->takeName(V).
234 void takeName(Value *V);
236 /// replaceAllUsesWith - Go through the uses list for this definition and make
237 /// each use point to "V" instead of "this". After this completes, 'this's
238 /// use list is guaranteed to be empty.
240 void replaceAllUsesWith(Value *V);
242 //----------------------------------------------------------------------
243 // Methods for handling the chain of uses of this Value.
245 bool use_empty() const { return UseList == 0; }
247 typedef use_iterator_impl<Use> use_iterator;
248 typedef use_iterator_impl<const Use> const_use_iterator;
249 use_iterator use_begin() { return use_iterator(UseList); }
250 const_use_iterator use_begin() const { return const_use_iterator(UseList); }
251 use_iterator use_end() { return use_iterator(); }
252 const_use_iterator use_end() const { return const_use_iterator(); }
253 iterator_range<use_iterator> uses() {
254 return iterator_range<use_iterator>(use_begin(), use_end());
256 iterator_range<const_use_iterator> uses() const {
257 return iterator_range<const_use_iterator>(use_begin(), use_end());
260 typedef user_iterator_impl<User> user_iterator;
261 typedef user_iterator_impl<const User> const_user_iterator;
262 user_iterator user_begin() { return user_iterator(UseList); }
263 const_user_iterator user_begin() const { return const_user_iterator(UseList); }
264 user_iterator user_end() { return user_iterator(); }
265 const_user_iterator user_end() const { return const_user_iterator(); }
266 User *user_back() { return *user_begin(); }
267 const User *user_back() const { return *user_begin(); }
268 iterator_range<user_iterator> users() {
269 return iterator_range<user_iterator>(user_begin(), user_end());
271 iterator_range<const_user_iterator> users() const {
272 return iterator_range<const_user_iterator>(user_begin(), user_end());
275 /// hasOneUse - Return true if there is exactly one user of this value. This
276 /// is specialized because it is a common request and does not require
277 /// traversing the whole use list.
279 bool hasOneUse() const {
280 const_use_iterator I = use_begin(), E = use_end();
281 if (I == E) return false;
285 /// hasNUses - Return true if this Value has exactly N users.
287 bool hasNUses(unsigned N) const;
289 /// hasNUsesOrMore - Return true if this value has N users or more. This is
290 /// logically equivalent to getNumUses() >= N.
292 bool hasNUsesOrMore(unsigned N) const;
294 bool isUsedInBasicBlock(const BasicBlock *BB) const;
296 /// getNumUses - This method computes the number of uses of this Value. This
297 /// is a linear time operation. Use hasOneUse, hasNUses, or hasNUsesOrMore
298 /// to check for specific values.
299 unsigned getNumUses() const;
301 /// addUse - This method should only be used by the Use class.
303 void addUse(Use &U) { U.addToList(&UseList); }
305 /// An enumeration for keeping track of the concrete subclass of Value that
306 /// is actually instantiated. Values of this enumeration are kept in the
307 /// Value classes SubclassID field. They are used for concrete type
310 ArgumentVal, // This is an instance of Argument
311 BasicBlockVal, // This is an instance of BasicBlock
312 FunctionVal, // This is an instance of Function
313 GlobalAliasVal, // This is an instance of GlobalAlias
314 GlobalVariableVal, // This is an instance of GlobalVariable
315 UndefValueVal, // This is an instance of UndefValue
316 BlockAddressVal, // This is an instance of BlockAddress
317 ConstantExprVal, // This is an instance of ConstantExpr
318 ConstantAggregateZeroVal, // This is an instance of ConstantAggregateZero
319 ConstantDataArrayVal, // This is an instance of ConstantDataArray
320 ConstantDataVectorVal, // This is an instance of ConstantDataVector
321 ConstantIntVal, // This is an instance of ConstantInt
322 ConstantFPVal, // This is an instance of ConstantFP
323 ConstantArrayVal, // This is an instance of ConstantArray
324 ConstantStructVal, // This is an instance of ConstantStruct
325 ConstantVectorVal, // This is an instance of ConstantVector
326 ConstantPointerNullVal, // This is an instance of ConstantPointerNull
327 MDNodeVal, // This is an instance of MDNode
328 MDStringVal, // This is an instance of MDString
329 InlineAsmVal, // This is an instance of InlineAsm
330 PseudoSourceValueVal, // This is an instance of PseudoSourceValue
331 FixedStackPseudoSourceValueVal, // This is an instance of
332 // FixedStackPseudoSourceValue
333 InstructionVal, // This is an instance of Instruction
334 // Enum values starting at InstructionVal are used for Instructions;
335 // don't add new values here!
338 ConstantFirstVal = FunctionVal,
339 ConstantLastVal = ConstantPointerNullVal
342 /// getValueID - Return an ID for the concrete type of this object. This is
343 /// used to implement the classof checks. This should not be used for any
344 /// other purpose, as the values may change as LLVM evolves. Also, note that
345 /// for instructions, the Instruction's opcode is added to InstructionVal. So
346 /// this means three things:
347 /// # there is no value with code InstructionVal (no opcode==0).
348 /// # there are more possible values for the value type than in ValueTy enum.
349 /// # the InstructionVal enumerator must be the highest valued enumerator in
350 /// the ValueTy enum.
351 unsigned getValueID() const {
355 /// getRawSubclassOptionalData - Return the raw optional flags value
356 /// contained in this value. This should only be used when testing two
357 /// Values for equivalence.
358 unsigned getRawSubclassOptionalData() const {
359 return SubclassOptionalData;
362 /// clearSubclassOptionalData - Clear the optional flags contained in
364 void clearSubclassOptionalData() {
365 SubclassOptionalData = 0;
368 /// hasSameSubclassOptionalData - Test whether the optional flags contained
369 /// in this value are equal to the optional flags in the given value.
370 bool hasSameSubclassOptionalData(const Value *V) const {
371 return SubclassOptionalData == V->SubclassOptionalData;
374 /// intersectOptionalDataWith - Clear any optional flags in this value
375 /// that are not also set in the given value.
376 void intersectOptionalDataWith(const Value *V) {
377 SubclassOptionalData &= V->SubclassOptionalData;
380 /// hasValueHandle - Return true if there is a value handle associated with
382 bool hasValueHandle() const { return HasValueHandle; }
384 /// \brief Strips off any unneeded pointer casts, all-zero GEPs and aliases
385 /// from the specified value, returning the original uncasted value.
387 /// If this is called on a non-pointer value, it returns 'this'.
388 Value *stripPointerCasts();
389 const Value *stripPointerCasts() const {
390 return const_cast<Value*>(this)->stripPointerCasts();
393 /// \brief Strips off any unneeded pointer casts and all-zero GEPs from the
394 /// specified value, returning the original uncasted value.
396 /// If this is called on a non-pointer value, it returns 'this'.
397 Value *stripPointerCastsNoFollowAliases();
398 const Value *stripPointerCastsNoFollowAliases() const {
399 return const_cast<Value*>(this)->stripPointerCastsNoFollowAliases();
402 /// \brief Strips off unneeded pointer casts and all-constant GEPs from the
403 /// specified value, returning the original pointer value.
405 /// If this is called on a non-pointer value, it returns 'this'.
406 Value *stripInBoundsConstantOffsets();
407 const Value *stripInBoundsConstantOffsets() const {
408 return const_cast<Value*>(this)->stripInBoundsConstantOffsets();
411 /// \brief Strips like \c stripInBoundsConstantOffsets but also accumulates
412 /// the constant offset stripped.
414 /// Stores the resulting constant offset stripped into the APInt provided.
415 /// The provided APInt will be extended or truncated as needed to be the
416 /// correct bitwidth for an offset of this pointer type.
418 /// If this is called on a non-pointer value, it returns 'this'.
419 Value *stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL,
421 const Value *stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL,
422 APInt &Offset) const {
423 return const_cast<Value *>(this)
424 ->stripAndAccumulateInBoundsConstantOffsets(DL, Offset);
427 /// \brief Strips off unneeded pointer casts and any in-bounds offsets from
428 /// the specified value, returning the original pointer value.
430 /// If this is called on a non-pointer value, it returns 'this'.
431 Value *stripInBoundsOffsets();
432 const Value *stripInBoundsOffsets() const {
433 return const_cast<Value*>(this)->stripInBoundsOffsets();
436 /// isDereferenceablePointer - Test if this value is always a pointer to
437 /// allocated and suitably aligned memory for a simple load or store.
438 bool isDereferenceablePointer() const;
440 /// DoPHITranslation - If this value is a PHI node with CurBB as its parent,
441 /// return the value in the PHI node corresponding to PredBB. If not, return
442 /// ourself. This is useful if you want to know the value something has in a
443 /// predecessor block.
444 Value *DoPHITranslation(const BasicBlock *CurBB, const BasicBlock *PredBB);
446 const Value *DoPHITranslation(const BasicBlock *CurBB,
447 const BasicBlock *PredBB) const{
448 return const_cast<Value*>(this)->DoPHITranslation(CurBB, PredBB);
451 /// MaximumAlignment - This is the greatest alignment value supported by
452 /// load, store, and alloca instructions, and global values.
453 static const unsigned MaximumAlignment = 1u << 29;
455 /// mutateType - Mutate the type of this Value to be of the specified type.
456 /// Note that this is an extremely dangerous operation which can create
457 /// completely invalid IR very easily. It is strongly recommended that you
458 /// recreate IR objects with the right types instead of mutating them in
460 void mutateType(Type *Ty) {
465 unsigned short getSubclassDataFromValue() const { return SubclassData; }
466 void setValueSubclassData(unsigned short D) { SubclassData = D; }
469 inline raw_ostream &operator<<(raw_ostream &OS, const Value &V) {
474 void Use::set(Value *V) {
475 if (Val) removeFromList();
477 if (V) V->addUse(*this);
481 // isa - Provide some specializations of isa so that we don't have to include
482 // the subtype header files to test to see if the value is a subclass...
484 template <> struct isa_impl<Constant, Value> {
485 static inline bool doit(const Value &Val) {
486 return Val.getValueID() >= Value::ConstantFirstVal &&
487 Val.getValueID() <= Value::ConstantLastVal;
491 template <> struct isa_impl<Argument, Value> {
492 static inline bool doit (const Value &Val) {
493 return Val.getValueID() == Value::ArgumentVal;
497 template <> struct isa_impl<InlineAsm, Value> {
498 static inline bool doit(const Value &Val) {
499 return Val.getValueID() == Value::InlineAsmVal;
503 template <> struct isa_impl<Instruction, Value> {
504 static inline bool doit(const Value &Val) {
505 return Val.getValueID() >= Value::InstructionVal;
509 template <> struct isa_impl<BasicBlock, Value> {
510 static inline bool doit(const Value &Val) {
511 return Val.getValueID() == Value::BasicBlockVal;
515 template <> struct isa_impl<Function, Value> {
516 static inline bool doit(const Value &Val) {
517 return Val.getValueID() == Value::FunctionVal;
521 template <> struct isa_impl<GlobalVariable, Value> {
522 static inline bool doit(const Value &Val) {
523 return Val.getValueID() == Value::GlobalVariableVal;
527 template <> struct isa_impl<GlobalAlias, Value> {
528 static inline bool doit(const Value &Val) {
529 return Val.getValueID() == Value::GlobalAliasVal;
533 template <> struct isa_impl<GlobalValue, Value> {
534 static inline bool doit(const Value &Val) {
535 return isa<GlobalVariable>(Val) || isa<Function>(Val) ||
536 isa<GlobalAlias>(Val);
540 template <> struct isa_impl<MDNode, Value> {
541 static inline bool doit(const Value &Val) {
542 return Val.getValueID() == Value::MDNodeVal;
546 // Value* is only 4-byte aligned.
548 class PointerLikeTypeTraits<Value*> {
551 static inline void *getAsVoidPointer(PT P) { return P; }
552 static inline PT getFromVoidPointer(void *P) {
553 return static_cast<PT>(P);
555 enum { NumLowBitsAvailable = 2 };
558 // Create wrappers for C Binding types (see CBindingWrapping.h).
559 DEFINE_ISA_CONVERSION_FUNCTIONS(Value, LLVMValueRef)
561 /* Specialized opaque value conversions.
563 inline Value **unwrap(LLVMValueRef *Vals) {
564 return reinterpret_cast<Value**>(Vals);
568 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
570 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
574 return reinterpret_cast<T**>(Vals);
577 inline LLVMValueRef *wrap(const Value **Vals) {
578 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
581 } // End llvm namespace