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 /// \brief LLVM Value Representation
57 /// This is a very important LLVM class. It is the base class of all values
58 /// computed by a program that may be used as operands to other values. Value is
59 /// the super class of other important classes such as Instruction and Function.
60 /// All Values have a Type. Type is not a subclass of Value. Some values can
61 /// have a name and they belong to some Module. Setting the name on the Value
62 /// automatically updates the module's symbol table.
64 /// Every value has a "use list" that keeps track of which other Values are
65 /// using this Value. A Value can also have an arbitrary number of ValueHandle
66 /// objects that watch it and listen to RAUW and Destroy events. See
67 /// llvm/IR/ValueHandle.h for details.
72 friend class ValueAsMetadata; // Allow access to NameAndIsUsedByMD.
73 friend class ValueHandleBase;
74 PointerIntPair<ValueName *, 1> NameAndIsUsedByMD;
76 const unsigned char SubclassID; // Subclass identifier (for isa/dyn_cast)
77 unsigned char HasValueHandle : 1; // Has a ValueHandle pointing to this?
79 /// \brief Hold subclass data that can be dropped.
81 /// This member is similar to SubclassData, however it is for holding
82 /// information which may be used to aid optimization, but which may be
83 /// cleared to zero without affecting conservative interpretation.
84 unsigned char SubclassOptionalData : 7;
87 /// \brief Hold arbitrary subclass data.
89 /// This member is defined by this class, but is not used for anything.
90 /// Subclasses can use it to hold whatever state they find useful. This
91 /// field is initialized to zero by the ctor.
92 unsigned short SubclassData;
95 /// \brief The number of operands in the subclass.
97 /// This member is defined by this class, but not used for anything.
98 /// Subclasses can use it to store their number of operands, if they have
101 /// This is stored here to save space in User on 64-bit hosts. Since most
102 /// instances of Value have operands, 32-bit hosts aren't significantly
104 unsigned NumOperands;
107 template <typename UseT> // UseT == 'Use' or 'const Use'
108 class use_iterator_impl
109 : public std::iterator<std::forward_iterator_tag, UseT *> {
111 explicit use_iterator_impl(UseT *u) : U(u) {}
115 use_iterator_impl() : U() {}
117 bool operator==(const use_iterator_impl &x) const { return U == x.U; }
118 bool operator!=(const use_iterator_impl &x) const { return !operator==(x); }
120 use_iterator_impl &operator++() { // Preincrement
121 assert(U && "Cannot increment end iterator!");
125 use_iterator_impl operator++(int) { // Postincrement
131 UseT &operator*() const {
132 assert(U && "Cannot dereference end iterator!");
136 UseT *operator->() const { return &operator*(); }
138 operator use_iterator_impl<const UseT>() const {
139 return use_iterator_impl<const UseT>(U);
143 template <typename UserTy> // UserTy == 'User' or 'const User'
144 class user_iterator_impl
145 : public std::iterator<std::forward_iterator_tag, UserTy *> {
146 use_iterator_impl<Use> UI;
147 explicit user_iterator_impl(Use *U) : UI(U) {}
151 user_iterator_impl() {}
153 bool operator==(const user_iterator_impl &x) const { return UI == x.UI; }
154 bool operator!=(const user_iterator_impl &x) const { return !operator==(x); }
156 /// \brief Returns true if this iterator is equal to user_end() on the value.
157 bool atEnd() const { return *this == user_iterator_impl(); }
159 user_iterator_impl &operator++() { // Preincrement
163 user_iterator_impl operator++(int) { // Postincrement
169 // Retrieve a pointer to the current User.
170 UserTy *operator*() const {
171 return UI->getUser();
174 UserTy *operator->() const { return operator*(); }
176 operator user_iterator_impl<const UserTy>() const {
177 return user_iterator_impl<const UserTy>(*UI);
180 Use &getUse() const { return *UI; }
183 void operator=(const Value &) = delete;
184 Value(const Value &) = delete;
187 Value(Type *Ty, unsigned scid);
191 /// \brief Support for debugging, callable in GDB: V->dump()
194 /// \brief Implement operator<< on Value.
195 void print(raw_ostream &O) const;
197 /// \brief Print the name of this Value out to the specified raw_ostream.
199 /// This is useful when you just want to print 'int %reg126', not the
200 /// instruction that generated it. If you specify a Module for context, then
201 /// even constanst get pretty-printed; for example, the type of a null
202 /// pointer is printed symbolically.
203 void printAsOperand(raw_ostream &O, bool PrintType = true,
204 const Module *M = nullptr) const;
206 /// \brief All values are typed, get the type of this value.
207 Type *getType() const { return VTy; }
209 /// \brief All values hold a context through their type.
210 LLVMContext &getContext() const;
212 // \brief All values can potentially be named.
213 bool hasName() const { return getValueName() != nullptr; }
214 ValueName *getValueName() const { return NameAndIsUsedByMD.getPointer(); }
215 void setValueName(ValueName *VN) { NameAndIsUsedByMD.setPointer(VN); }
218 void destroyValueName();
219 void setNameImpl(const Twine &Name);
222 /// \brief Return a constant reference to the value's name.
224 /// This is cheap and guaranteed to return the same reference as long as the
225 /// value is not modified.
226 StringRef getName() const;
228 /// \brief Change the name of the value.
230 /// Choose a new unique name if the provided name is taken.
232 /// \param Name The new name; or "" if the value's name should be removed.
233 void setName(const Twine &Name);
236 /// \brief Transfer the name from V to this value.
238 /// After taking V's name, sets V's name to empty.
240 /// \note It is an error to call V->takeName(V).
241 void takeName(Value *V);
243 /// \brief Change all uses of this to point to a new Value.
245 /// Go through the uses list for this definition and make each use point to
246 /// "V" instead of "this". After this completes, 'this's use list is
247 /// guaranteed to be empty.
248 void replaceAllUsesWith(Value *V);
250 /// replaceUsesOutsideBlock - Go through the uses list for this definition and
251 /// make each use point to "V" instead of "this" when the use is outside the
252 /// block. 'This's use list is expected to have at least one element.
253 /// Unlike replaceAllUsesWith this function does not support basic block
254 /// values or constant users.
255 void replaceUsesOutsideBlock(Value *V, BasicBlock *BB);
257 //----------------------------------------------------------------------
258 // Methods for handling the chain of uses of this Value.
260 bool use_empty() const { return UseList == nullptr; }
262 typedef use_iterator_impl<Use> use_iterator;
263 typedef use_iterator_impl<const Use> const_use_iterator;
264 use_iterator use_begin() { return use_iterator(UseList); }
265 const_use_iterator use_begin() const { return const_use_iterator(UseList); }
266 use_iterator use_end() { return use_iterator(); }
267 const_use_iterator use_end() const { return const_use_iterator(); }
268 iterator_range<use_iterator> uses() {
269 return iterator_range<use_iterator>(use_begin(), use_end());
271 iterator_range<const_use_iterator> uses() const {
272 return iterator_range<const_use_iterator>(use_begin(), use_end());
275 bool user_empty() const { return UseList == nullptr; }
277 typedef user_iterator_impl<User> user_iterator;
278 typedef user_iterator_impl<const User> const_user_iterator;
279 user_iterator user_begin() { return user_iterator(UseList); }
280 const_user_iterator user_begin() const { return const_user_iterator(UseList); }
281 user_iterator user_end() { return user_iterator(); }
282 const_user_iterator user_end() const { return const_user_iterator(); }
283 User *user_back() { return *user_begin(); }
284 const User *user_back() const { return *user_begin(); }
285 iterator_range<user_iterator> users() {
286 return iterator_range<user_iterator>(user_begin(), user_end());
288 iterator_range<const_user_iterator> users() const {
289 return iterator_range<const_user_iterator>(user_begin(), user_end());
292 /// \brief Return true if there is exactly one user of this value.
294 /// This is specialized because it is a common request and does not require
295 /// traversing the whole use list.
296 bool hasOneUse() const {
297 const_use_iterator I = use_begin(), E = use_end();
298 if (I == E) return false;
302 /// \brief Return true if this Value has exactly N users.
303 bool hasNUses(unsigned N) const;
305 /// \brief Return true if this value has N users or more.
307 /// This is logically equivalent to getNumUses() >= N.
308 bool hasNUsesOrMore(unsigned N) const;
310 /// \brief Check if this value is used in the specified basic block.
311 bool isUsedInBasicBlock(const BasicBlock *BB) const;
313 /// \brief This method computes the number of uses of this Value.
315 /// This is a linear time operation. Use hasOneUse, hasNUses, or
316 /// hasNUsesOrMore to check for specific values.
317 unsigned getNumUses() const;
319 /// \brief This method should only be used by the Use class.
320 void addUse(Use &U) { U.addToList(&UseList); }
322 /// \brief Concrete subclass of this.
324 /// An enumeration for keeping track of the concrete subclass of Value that
325 /// is actually instantiated. Values of this enumeration are kept in the
326 /// Value classes SubclassID field. They are used for concrete type
329 ArgumentVal, // This is an instance of Argument
330 BasicBlockVal, // This is an instance of BasicBlock
331 FunctionVal, // This is an instance of Function
332 GlobalAliasVal, // This is an instance of GlobalAlias
333 GlobalVariableVal, // This is an instance of GlobalVariable
334 UndefValueVal, // This is an instance of UndefValue
335 BlockAddressVal, // This is an instance of BlockAddress
336 ConstantExprVal, // This is an instance of ConstantExpr
337 ConstantAggregateZeroVal, // This is an instance of ConstantAggregateZero
338 ConstantDataArrayVal, // This is an instance of ConstantDataArray
339 ConstantDataVectorVal, // This is an instance of ConstantDataVector
340 ConstantIntVal, // This is an instance of ConstantInt
341 ConstantFPVal, // This is an instance of ConstantFP
342 ConstantArrayVal, // This is an instance of ConstantArray
343 ConstantStructVal, // This is an instance of ConstantStruct
344 ConstantVectorVal, // This is an instance of ConstantVector
345 ConstantPointerNullVal, // This is an instance of ConstantPointerNull
346 MetadataAsValueVal, // This is an instance of MetadataAsValue
347 InlineAsmVal, // This is an instance of InlineAsm
348 InstructionVal, // This is an instance of Instruction
349 // Enum values starting at InstructionVal are used for Instructions;
350 // don't add new values here!
353 ConstantFirstVal = FunctionVal,
354 ConstantLastVal = ConstantPointerNullVal
357 /// \brief Return an ID for the concrete type of this object.
359 /// This is used to implement the classof checks. This should not be used
360 /// for any other purpose, as the values may change as LLVM evolves. Also,
361 /// note that for instructions, the Instruction's opcode is added to
362 /// InstructionVal. So this means three things:
363 /// # there is no value with code InstructionVal (no opcode==0).
364 /// # there are more possible values for the value type than in ValueTy enum.
365 /// # the InstructionVal enumerator must be the highest valued enumerator in
366 /// the ValueTy enum.
367 unsigned getValueID() const {
371 /// \brief Return the raw optional flags value contained in this value.
373 /// This should only be used when testing two Values for equivalence.
374 unsigned getRawSubclassOptionalData() const {
375 return SubclassOptionalData;
378 /// \brief Clear the optional flags contained in this value.
379 void clearSubclassOptionalData() {
380 SubclassOptionalData = 0;
383 /// \brief Check the optional flags for equality.
384 bool hasSameSubclassOptionalData(const Value *V) const {
385 return SubclassOptionalData == V->SubclassOptionalData;
388 /// \brief Clear any optional flags not set in the given Value.
389 void intersectOptionalDataWith(const Value *V) {
390 SubclassOptionalData &= V->SubclassOptionalData;
393 /// \brief Return true if there is a value handle associated with this value.
394 bool hasValueHandle() const { return HasValueHandle; }
396 /// \brief Return true if there is metadata referencing this value.
397 bool isUsedByMetadata() const { return NameAndIsUsedByMD.getInt(); }
399 /// \brief Strip off pointer casts, all-zero GEPs, and aliases.
401 /// Returns the original uncasted value. If this is called on a non-pointer
402 /// value, it returns 'this'.
403 Value *stripPointerCasts();
404 const Value *stripPointerCasts() const {
405 return const_cast<Value*>(this)->stripPointerCasts();
408 /// \brief Strip off pointer casts and all-zero GEPs.
410 /// Returns the original uncasted value. If this is called on a non-pointer
411 /// value, it returns 'this'.
412 Value *stripPointerCastsNoFollowAliases();
413 const Value *stripPointerCastsNoFollowAliases() const {
414 return const_cast<Value*>(this)->stripPointerCastsNoFollowAliases();
417 /// \brief Strip off pointer casts and all-constant inbounds GEPs.
419 /// Returns the original pointer value. If this is called on a non-pointer
420 /// value, it returns 'this'.
421 Value *stripInBoundsConstantOffsets();
422 const Value *stripInBoundsConstantOffsets() const {
423 return const_cast<Value*>(this)->stripInBoundsConstantOffsets();
426 /// \brief Accumulate offsets from \a stripInBoundsConstantOffsets().
428 /// Stores the resulting constant offset stripped into the APInt provided.
429 /// The provided APInt will be extended or truncated as needed to be the
430 /// correct bitwidth for an offset of this pointer type.
432 /// If this is called on a non-pointer value, it returns 'this'.
433 Value *stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL,
435 const Value *stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL,
436 APInt &Offset) const {
437 return const_cast<Value *>(this)
438 ->stripAndAccumulateInBoundsConstantOffsets(DL, Offset);
441 /// \brief Strip off pointer casts and inbounds GEPs.
443 /// Returns the original pointer value. If this is called on a non-pointer
444 /// value, it returns 'this'.
445 Value *stripInBoundsOffsets();
446 const Value *stripInBoundsOffsets() const {
447 return const_cast<Value*>(this)->stripInBoundsOffsets();
450 /// \brief Translate PHI node to its predecessor from the given basic block.
452 /// If this value is a PHI node with CurBB as its parent, return the value in
453 /// the PHI node corresponding to PredBB. If not, return ourself. This is
454 /// useful if you want to know the value something has in a predecessor
456 Value *DoPHITranslation(const BasicBlock *CurBB, const BasicBlock *PredBB);
458 const Value *DoPHITranslation(const BasicBlock *CurBB,
459 const BasicBlock *PredBB) const{
460 return const_cast<Value*>(this)->DoPHITranslation(CurBB, PredBB);
463 /// \brief The maximum alignment for instructions.
465 /// This is the greatest alignment value supported by load, store, and alloca
466 /// instructions, and global values.
467 static const unsigned MaxAlignmentExponent = 29;
468 static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent;
470 /// \brief Mutate the type of this Value to be of the specified type.
472 /// Note that this is an extremely dangerous operation which can create
473 /// completely invalid IR very easily. It is strongly recommended that you
474 /// recreate IR objects with the right types instead of mutating them in
476 void mutateType(Type *Ty) {
480 /// \brief Sort the use-list.
482 /// Sorts the Value's use-list by Cmp using a stable mergesort. Cmp is
483 /// expected to compare two \a Use references.
484 template <class Compare> void sortUseList(Compare Cmp);
486 /// \brief Reverse the use-list.
487 void reverseUseList();
490 /// \brief Merge two lists together.
492 /// Merges \c L and \c R using \c Cmp. To enable stable sorts, always pushes
493 /// "equal" items from L before items from R.
495 /// \return the first element in the list.
497 /// \note Completely ignores \a Use::Prev (doesn't read, doesn't update).
498 template <class Compare>
499 static Use *mergeUseLists(Use *L, Use *R, Compare Cmp) {
501 mergeUseListsImpl(L, R, &Merged, Cmp);
505 /// \brief Tail-recursive helper for \a mergeUseLists().
507 /// \param[out] Next the first element in the list.
508 template <class Compare>
509 static void mergeUseListsImpl(Use *L, Use *R, Use **Next, Compare Cmp);
512 unsigned short getSubclassDataFromValue() const { return SubclassData; }
513 void setValueSubclassData(unsigned short D) { SubclassData = D; }
516 inline raw_ostream &operator<<(raw_ostream &OS, const Value &V) {
521 void Use::set(Value *V) {
522 if (Val) removeFromList();
524 if (V) V->addUse(*this);
527 template <class Compare> void Value::sortUseList(Compare Cmp) {
528 if (!UseList || !UseList->Next)
529 // No need to sort 0 or 1 uses.
532 // Note: this function completely ignores Prev pointers until the end when
533 // they're fixed en masse.
535 // Create a binomial vector of sorted lists, visiting uses one at a time and
536 // merging lists as necessary.
537 const unsigned MaxSlots = 32;
538 Use *Slots[MaxSlots];
540 // Collect the first use, turning it into a single-item list.
541 Use *Next = UseList->Next;
542 UseList->Next = nullptr;
543 unsigned NumSlots = 1;
546 // Collect all but the last use.
549 Next = Current->Next;
551 // Turn Current into a single-item list.
552 Current->Next = nullptr;
554 // Save Current in the first available slot, merging on collisions.
556 for (I = 0; I < NumSlots; ++I) {
560 // Merge two lists, doubling the size of Current and emptying slot I.
562 // Since the uses in Slots[I] originally preceded those in Current, send
563 // Slots[I] in as the left parameter to maintain a stable sort.
564 Current = mergeUseLists(Slots[I], Current, Cmp);
567 // Check if this is a new slot.
570 assert(NumSlots <= MaxSlots && "Use list bigger than 2^32");
573 // Found an open slot.
577 // Merge all the lists together.
578 assert(Next && "Expected one more Use");
579 assert(!Next->Next && "Expected only one Use");
581 for (unsigned I = 0; I < NumSlots; ++I)
583 // Since the uses in Slots[I] originally preceded those in UseList, send
584 // Slots[I] in as the left parameter to maintain a stable sort.
585 UseList = mergeUseLists(Slots[I], UseList, Cmp);
587 // Fix the Prev pointers.
588 for (Use *I = UseList, **Prev = &UseList; I; I = I->Next) {
594 template <class Compare>
595 void Value::mergeUseListsImpl(Use *L, Use *R, Use **Next, Compare Cmp) {
606 mergeUseListsImpl(L, R->Next, &R->Next, Cmp);
610 mergeUseListsImpl(L->Next, R, &L->Next, Cmp);
613 // isa - Provide some specializations of isa so that we don't have to include
614 // the subtype header files to test to see if the value is a subclass...
616 template <> struct isa_impl<Constant, Value> {
617 static inline bool doit(const Value &Val) {
618 return Val.getValueID() >= Value::ConstantFirstVal &&
619 Val.getValueID() <= Value::ConstantLastVal;
623 template <> struct isa_impl<Argument, Value> {
624 static inline bool doit (const Value &Val) {
625 return Val.getValueID() == Value::ArgumentVal;
629 template <> struct isa_impl<InlineAsm, Value> {
630 static inline bool doit(const Value &Val) {
631 return Val.getValueID() == Value::InlineAsmVal;
635 template <> struct isa_impl<Instruction, Value> {
636 static inline bool doit(const Value &Val) {
637 return Val.getValueID() >= Value::InstructionVal;
641 template <> struct isa_impl<BasicBlock, Value> {
642 static inline bool doit(const Value &Val) {
643 return Val.getValueID() == Value::BasicBlockVal;
647 template <> struct isa_impl<Function, Value> {
648 static inline bool doit(const Value &Val) {
649 return Val.getValueID() == Value::FunctionVal;
653 template <> struct isa_impl<GlobalVariable, Value> {
654 static inline bool doit(const Value &Val) {
655 return Val.getValueID() == Value::GlobalVariableVal;
659 template <> struct isa_impl<GlobalAlias, Value> {
660 static inline bool doit(const Value &Val) {
661 return Val.getValueID() == Value::GlobalAliasVal;
665 template <> struct isa_impl<GlobalValue, Value> {
666 static inline bool doit(const Value &Val) {
667 return isa<GlobalObject>(Val) || isa<GlobalAlias>(Val);
671 template <> struct isa_impl<GlobalObject, Value> {
672 static inline bool doit(const Value &Val) {
673 return isa<GlobalVariable>(Val) || isa<Function>(Val);
677 // Value* is only 4-byte aligned.
679 class PointerLikeTypeTraits<Value*> {
682 static inline void *getAsVoidPointer(PT P) { return P; }
683 static inline PT getFromVoidPointer(void *P) {
684 return static_cast<PT>(P);
686 enum { NumLowBitsAvailable = 2 };
689 // Create wrappers for C Binding types (see CBindingWrapping.h).
690 DEFINE_ISA_CONVERSION_FUNCTIONS(Value, LLVMValueRef)
692 /* Specialized opaque value conversions.
694 inline Value **unwrap(LLVMValueRef *Vals) {
695 return reinterpret_cast<Value**>(Vals);
699 inline T **unwrap(LLVMValueRef *Vals, unsigned Length) {
701 for (LLVMValueRef *I = Vals, *E = Vals + Length; I != E; ++I)
705 return reinterpret_cast<T**>(Vals);
708 inline LLVMValueRef *wrap(const Value **Vals) {
709 return reinterpret_cast<LLVMValueRef*>(const_cast<Value**>(Vals));
712 } // End llvm namespace