1 //===-- llvm/Constant.h - Constant class definition -------------*- 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 the declaration of the Constant class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CONSTANT_H
15 #define LLVM_CONSTANT_H
17 #include "llvm/User.h"
22 template<typename T> class SmallVectorImpl;
25 /// This is an important base class in LLVM. It provides the common facilities
26 /// of all constant values in an LLVM program. A constant is a value that is
27 /// immutable at runtime. Functions are constants because their address is
28 /// immutable. Same with global variables.
30 /// All constants share the capabilities provided in this class. All constants
31 /// can have a null value. They can have an operand list. Constants can be
32 /// simple (integer and floating point values), complex (arrays and structures),
33 /// or expression based (computations yielding a constant value composed of
34 /// only certain operators and other constant values).
36 /// Note that Constants are immutable (once created they never change)
37 /// and are fully shared by structural equivalence. This means that two
38 /// structurally equivalent constants will always have the same address.
39 /// Constants are created on demand as needed and never deleted: thus clients
40 /// don't have to worry about the lifetime of the objects.
41 /// @brief LLVM Constant Representation
42 class Constant : public User {
43 void operator=(const Constant &); // Do not implement
44 Constant(const Constant &); // Do not implement
47 Constant(const Type *ty, ValueTy vty, Use *Ops, unsigned NumOps)
48 : User(ty, vty, Ops, NumOps) {}
50 void destroyConstantImpl();
52 void setOperand(unsigned i, Value *V) {
53 User::setOperand(i, V);
56 /// isNullValue - Return true if this is the value that would be returned by
58 virtual bool isNullValue() const = 0;
60 /// isNegativeZeroValue - Return true if the value is what would be returned
61 /// by getZeroValueForNegation.
62 virtual bool isNegativeZeroValue() const { return isNullValue(); }
64 /// canTrap - Return true if evaluation of this constant could trap. This is
65 /// true for things like constant expressions that could divide by zero.
68 /// isConstantUsed - Return true if the constant has users other than constant
69 /// exprs and other dangling things.
70 bool isConstantUsed() const;
72 enum PossibleRelocationsTy {
78 /// getRelocationInfo - This method classifies the entry according to
79 /// whether or not it may generate a relocation entry. This must be
80 /// conservative, so if it might codegen to a relocatable entry, it should say
81 /// so. The return values are:
83 /// NoRelocation: This constant pool entry is guaranteed to never have a
84 /// relocation applied to it (because it holds a simple constant like
86 /// LocalRelocation: This entry has relocations, but the entries are
87 /// guaranteed to be resolvable by the static linker, so the dynamic
88 /// linker will never see them.
89 /// GlobalRelocations: This entry may have arbitrary relocations.
91 /// FIXME: This really should not be in VMCore.
92 PossibleRelocationsTy getRelocationInfo() const;
94 // Specialize get/setOperand for Users as their operands are always
95 // constants or BasicBlocks as well.
96 User *getOperand(unsigned i) {
97 return static_cast<User*>(User::getOperand(i));
99 const User *getOperand(unsigned i) const {
100 return static_cast<const User*>(User::getOperand(i));
103 /// getVectorElements - This method, which is only valid on constant of vector
104 /// type, returns the elements of the vector in the specified smallvector.
105 /// This handles breaking down a vector undef into undef elements, etc. For
106 /// constant exprs and other cases we can't handle, we return an empty vector.
107 void getVectorElements(SmallVectorImpl<Constant*> &Elts) const;
109 /// destroyConstant - Called if some element of this constant is no longer
110 /// valid. At this point only other constants may be on the use_list for this
111 /// constant. Any constants on our Use list must also be destroy'd. The
112 /// implementation must be sure to remove the constant from the list of
113 /// available cached constants. Implementations should call
114 /// destroyConstantImpl as the last thing they do, to destroy all users and
116 virtual void destroyConstant() { assert(0 && "Not reached!"); }
118 //// Methods for support type inquiry through isa, cast, and dyn_cast:
119 static inline bool classof(const Constant *) { return true; }
120 static inline bool classof(const GlobalValue *) { return true; }
121 static inline bool classof(const Value *V) {
122 return V->getValueID() >= ConstantFirstVal &&
123 V->getValueID() <= ConstantLastVal;
126 /// replaceUsesOfWithOnConstant - This method is a special form of
127 /// User::replaceUsesOfWith (which does not work on constants) that does work
128 /// on constants. Basically this method goes through the trouble of building
129 /// a new constant that is equivalent to the current one, with all uses of
130 /// From replaced with uses of To. After this construction is completed, all
131 /// of the users of 'this' are replaced to use the new constant, and then
132 /// 'this' is deleted. In general, you should not call this method, instead,
133 /// use Value::replaceAllUsesWith, which automatically dispatches to this
134 /// method as needed.
136 virtual void replaceUsesOfWithOnConstant(Value *, Value *, Use *) {
137 // Provide a default implementation for constants (like integers) that
138 // cannot use any other values. This cannot be called at runtime, but needs
139 // to be here to avoid link errors.
140 assert(getNumOperands() == 0 && "replaceUsesOfWithOnConstant must be "
141 "implemented for all constants that have operands!");
142 assert(0 && "Constants that do not have operands cannot be using 'From'!");
145 static Constant* getNullValue(const Type* Ty);
147 /// @returns the value for an integer constant of the given type that has all
148 /// its bits set to true.
149 /// @brief Get the all ones value
150 static Constant* getAllOnesValue(const Type* Ty);
152 /// getIntegerValue - Return the value for an integer or pointer constant,
153 /// or a vector thereof, with the given scalar value.
154 static Constant* getIntegerValue(const Type* Ty, const APInt &V);
157 } // End llvm namespace