1 //===-- llvm/Type.h - Classes for handling data types -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
14 #include "llvm/AbstractTypeUser.h"
15 #include "llvm/Support/Casting.h"
16 #include "llvm/Support/DataTypes.h"
17 #include "llvm/Support/Streams.h"
18 #include "llvm/ADT/GraphTraits.h"
19 #include "llvm/ADT/iterator"
30 /// This file contains the declaration of the Type class. For more "Type" type
31 /// stuff, look in DerivedTypes.h.
33 /// The instances of the Type class are immutable: once they are created,
34 /// they are never changed. Also note that only one instance of a particular
35 /// type is ever created. Thus seeing if two types are equal is a matter of
36 /// doing a trivial pointer comparison. To enforce that no two equal instances
37 /// are created, Type instances can only be created via static factory methods
38 /// in class Type and in derived classes.
40 /// Once allocated, Types are never free'd, unless they are an abstract type
41 /// that is resolved to a more concrete type.
43 /// Types themself don't have a name, and can be named either by:
44 /// - using SymbolTable instance, typically from some Module,
45 /// - using convenience methods in the Module class (which uses module's
48 /// Opaque types are simple derived types with no state. There may be many
49 /// different Opaque type objects floating around, but two are only considered
50 /// identical if they are pointer equals of each other. This allows us to have
51 /// two opaque types that end up resolving to different concrete types later.
53 /// Opaque types are also kinda weird and scary and different because they have
54 /// to keep a list of uses of the type. When, through linking, parsing, or
55 /// bitcode reading, they become resolved, they need to find and update all
56 /// users of the unknown type, causing them to reference a new, more concrete
57 /// type. Opaque types are deleted when their use list dwindles to zero users.
59 /// @brief Root of type hierarchy
60 class Type : public AbstractTypeUser {
62 //===-------------------------------------------------------------------===//
63 /// Definitions of all of the base types for the Type system. Based on this
64 /// value, you can cast to a "DerivedType" subclass (see DerivedTypes.h)
65 /// Note: If you add an element to this, you need to add an element to the
66 /// Type::getPrimitiveType function, or else things will break!
69 // PrimitiveTypes .. make sure LastPrimitiveTyID stays up to date
70 VoidTyID = 0, ///< 0: type with no size
71 FloatTyID, ///< 1: 32 bit floating point type
72 DoubleTyID, ///< 2: 64 bit floating point type
73 LabelTyID, ///< 3: Labels
75 // Derived types... see DerivedTypes.h file...
76 // Make sure FirstDerivedTyID stays up to date!!!
77 IntegerTyID, ///< 4: Arbitrary bit width integers
78 FunctionTyID, ///< 5: Functions
79 StructTyID, ///< 6: Structures
80 PackedStructTyID,///< 7: Packed Structure. This is for bitcode only
81 ArrayTyID, ///< 8: Arrays
82 PointerTyID, ///< 9: Pointers
83 OpaqueTyID, ///< 10: Opaque: type with unknown structure
84 VectorTyID, ///< 11: SIMD 'packed' format, or other vector type
86 NumTypeIDs, // Must remain as last defined ID
87 LastPrimitiveTyID = LabelTyID,
88 FirstDerivedTyID = IntegerTyID
92 TypeID ID : 8; // The current base type of this type.
93 bool Abstract : 1; // True if type contains an OpaqueType
94 unsigned SubclassData : 23; //Space for subclasses to store data
96 /// RefCount - This counts the number of PATypeHolders that are pointing to
97 /// this type. When this number falls to zero, if the type is abstract and
98 /// has no AbstractTypeUsers, the type is deleted. This is only sensical for
101 mutable unsigned RefCount;
103 const Type *getForwardedTypeInternal() const;
105 // Some Type instances are allocated as arrays, some aren't. So we provide
106 // this method to get the right kind of destruction for the type of Type.
107 void destroy() const; // const is a lie, this does "delete this"!
110 explicit Type(TypeID id) : ID(id), Abstract(false), SubclassData(0),
111 RefCount(0), ForwardType(0), NumContainedTys(0),
114 assert(AbstractTypeUsers.empty() && "Abstract types remain");
117 /// Types can become nonabstract later, if they are refined.
119 inline void setAbstract(bool Val) { Abstract = Val; }
121 unsigned getRefCount() const { return RefCount; }
123 unsigned getSubclassData() const { return SubclassData; }
124 void setSubclassData(unsigned val) { SubclassData = val; }
126 /// ForwardType - This field is used to implement the union find scheme for
127 /// abstract types. When types are refined to other types, this field is set
128 /// to the more refined type. Only abstract types can be forwarded.
129 mutable const Type *ForwardType;
132 /// AbstractTypeUsers - Implement a list of the users that need to be notified
133 /// if I am a type, and I get resolved into a more concrete type.
135 mutable std::vector<AbstractTypeUser *> AbstractTypeUsers;
137 /// NumContainedTys - Keeps track of how many PATypeHandle instances there
138 /// are at the end of this type instance for the list of contained types. It
139 /// is the subclasses responsibility to set this up. Set to 0 if there are no
140 /// contained types in this type.
141 unsigned NumContainedTys;
143 /// ContainedTys - A pointer to the array of Types (PATypeHandle) contained
144 /// by this Type. For example, this includes the arguments of a function
145 /// type, the elements of a structure, the pointee of a pointer, the element
146 /// type of an array, etc. This pointer may be 0 for types that don't
147 /// contain other types (Integer, Double, Float). In general, the subclass
148 /// should arrange for space for the PATypeHandles to be included in the
149 /// allocation of the type object and set this pointer to the address of the
150 /// first element. This allows the Type class to manipulate the ContainedTys
151 /// without understanding the subclass's placement for this array. keeping
152 /// it here also allows the subtype_* members to be implemented MUCH more
153 /// efficiently, and dynamically very few types do not contain any elements.
154 PATypeHandle *ContainedTys;
157 void print(std::ostream &O) const;
158 void print(std::ostream *O) const { if (O) print(*O); }
160 /// @brief Debugging support: print to stderr
163 //===--------------------------------------------------------------------===//
164 // Property accessors for dealing with types... Some of these virtual methods
165 // are defined in private classes defined in Type.cpp for primitive types.
168 /// getTypeID - Return the type id for the type. This will return one
169 /// of the TypeID enum elements defined above.
171 inline TypeID getTypeID() const { return ID; }
173 /// getDescription - Return the string representation of the type...
174 const std::string &getDescription() const;
176 /// isInteger - True if this is an instance of IntegerType.
178 bool isInteger() const { return ID == IntegerTyID; }
180 /// isFloatingPoint - Return true if this is one of the two floating point
182 bool isFloatingPoint() const { return ID == FloatTyID || ID == DoubleTyID; }
184 /// isFPOrFPVector - Return true if this is a FP type or a vector of FP types.
186 bool isFPOrFPVector() const;
188 /// isAbstract - True if the type is either an Opaque type, or is a derived
189 /// type that includes an opaque type somewhere in it.
191 inline bool isAbstract() const { return Abstract; }
193 /// canLosslesslyBitCastTo - Return true if this type could be converted
194 /// with a lossless BitCast to type 'Ty'. For example, uint to int. BitCasts
195 /// are valid for types of the same size only where no re-interpretation of
196 /// the bits is done.
197 /// @brief Determine if this type could be losslessly bitcast to Ty
198 bool canLosslesslyBitCastTo(const Type *Ty) const;
201 /// Here are some useful little methods to query what type derived types are
202 /// Note that all other types can just compare to see if this == Type::xxxTy;
204 inline bool isPrimitiveType() const { return ID <= LastPrimitiveTyID; }
205 inline bool isDerivedType() const { return ID >= FirstDerivedTyID; }
207 /// isFirstClassType - Return true if the value is holdable in a register.
209 inline bool isFirstClassType() const {
210 return (ID != VoidTyID && ID <= LastPrimitiveTyID) ||
211 ID == IntegerTyID || ID == PointerTyID || ID == VectorTyID;
214 /// isSized - Return true if it makes sense to take the size of this type. To
215 /// get the actual size for a particular target, it is reasonable to use the
216 /// TargetData subsystem to do this.
218 bool isSized() const {
219 // If it's a primitive, it is always sized.
220 if (ID == IntegerTyID || isFloatingPoint() || ID == PointerTyID)
222 // If it is not something that can have a size (e.g. a function or label),
223 // it doesn't have a size.
224 if (ID != StructTyID && ID != ArrayTyID && ID != VectorTyID &&
225 ID != PackedStructTyID)
227 // If it is something that can have a size and it's concrete, it definitely
228 // has a size, otherwise we have to try harder to decide.
229 return !isAbstract() || isSizedDerivedType();
232 /// getPrimitiveSizeInBits - Return the basic size of this type if it is a
233 /// primitive type. These are fixed by LLVM and are not target dependent.
234 /// This will return zero if the type does not have a size or is not a
237 unsigned getPrimitiveSizeInBits() const;
239 /// getForwaredType - Return the type that this type has been resolved to if
240 /// it has been resolved to anything. This is used to implement the
241 /// union-find algorithm for type resolution, and shouldn't be used by general
243 const Type *getForwardedType() const {
244 if (!ForwardType) return 0;
245 return getForwardedTypeInternal();
248 /// getVAArgsPromotedType - Return the type an argument of this type
249 /// will be promoted to if passed through a variable argument
251 const Type *getVAArgsPromotedType() const;
253 //===--------------------------------------------------------------------===//
254 // Type Iteration support
256 typedef PATypeHandle *subtype_iterator;
257 subtype_iterator subtype_begin() const { return ContainedTys; }
258 subtype_iterator subtype_end() const { return &ContainedTys[NumContainedTys];}
260 /// getContainedType - This method is used to implement the type iterator
261 /// (defined a the end of the file). For derived types, this returns the
262 /// types 'contained' in the derived type.
264 const Type *getContainedType(unsigned i) const {
265 assert(i < NumContainedTys && "Index out of range!");
266 return ContainedTys[i].get();
269 /// getNumContainedTypes - Return the number of types in the derived type.
271 unsigned getNumContainedTypes() const { return NumContainedTys; }
273 //===--------------------------------------------------------------------===//
274 // Static members exported by the Type class itself. Useful for getting
275 // instances of Type.
278 /// getPrimitiveType - Return a type based on an identifier.
279 static const Type *getPrimitiveType(TypeID IDNumber);
281 //===--------------------------------------------------------------------===//
282 // These are the builtin types that are always available...
284 static const Type *VoidTy, *LabelTy, *FloatTy, *DoubleTy;
285 static const IntegerType *Int1Ty, *Int8Ty, *Int16Ty, *Int32Ty, *Int64Ty;
287 /// Methods for support type inquiry through isa, cast, and dyn_cast:
288 static inline bool classof(const Type *T) { return true; }
290 void addRef() const {
291 assert(isAbstract() && "Cannot add a reference to a non-abstract type!");
295 void dropRef() const {
296 assert(isAbstract() && "Cannot drop a reference to a non-abstract type!");
297 assert(RefCount && "No objects are currently referencing this object!");
299 // If this is the last PATypeHolder using this object, and there are no
300 // PATypeHandles using it, the type is dead, delete it now.
301 if (--RefCount == 0 && AbstractTypeUsers.empty())
305 /// addAbstractTypeUser - Notify an abstract type that there is a new user of
306 /// it. This function is called primarily by the PATypeHandle class.
308 void addAbstractTypeUser(AbstractTypeUser *U) const {
309 assert(isAbstract() && "addAbstractTypeUser: Current type not abstract!");
310 AbstractTypeUsers.push_back(U);
313 /// removeAbstractTypeUser - Notify an abstract type that a user of the class
314 /// no longer has a handle to the type. This function is called primarily by
315 /// the PATypeHandle class. When there are no users of the abstract type, it
316 /// is annihilated, because there is no way to get a reference to it ever
319 void removeAbstractTypeUser(AbstractTypeUser *U) const;
322 /// isSizedDerivedType - Derived types like structures and arrays are sized
323 /// iff all of the members of the type are sized as well. Since asking for
324 /// their size is relatively uncommon, move this operation out of line.
325 bool isSizedDerivedType() const;
327 virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
328 virtual void typeBecameConcrete(const DerivedType *AbsTy);
331 // PromoteAbstractToConcrete - This is an internal method used to calculate
332 // change "Abstract" from true to false when types are refined.
333 void PromoteAbstractToConcrete();
334 friend class TypeMapBase;
337 //===----------------------------------------------------------------------===//
338 // Define some inline methods for the AbstractTypeUser.h:PATypeHandle class.
339 // These are defined here because they MUST be inlined, yet are dependent on
340 // the definition of the Type class.
342 inline void PATypeHandle::addUser() {
343 assert(Ty && "Type Handle has a null type!");
344 if (Ty->isAbstract())
345 Ty->addAbstractTypeUser(User);
347 inline void PATypeHandle::removeUser() {
348 if (Ty->isAbstract())
349 Ty->removeAbstractTypeUser(User);
352 // Define inline methods for PATypeHolder...
354 inline void PATypeHolder::addRef() {
355 if (Ty->isAbstract())
359 inline void PATypeHolder::dropRef() {
360 if (Ty->isAbstract())
365 //===----------------------------------------------------------------------===//
366 // Provide specializations of GraphTraits to be able to treat a type as a
367 // graph of sub types...
369 template <> struct GraphTraits<Type*> {
370 typedef Type NodeType;
371 typedef Type::subtype_iterator ChildIteratorType;
373 static inline NodeType *getEntryNode(Type *T) { return T; }
374 static inline ChildIteratorType child_begin(NodeType *N) {
375 return N->subtype_begin();
377 static inline ChildIteratorType child_end(NodeType *N) {
378 return N->subtype_end();
382 template <> struct GraphTraits<const Type*> {
383 typedef const Type NodeType;
384 typedef Type::subtype_iterator ChildIteratorType;
386 static inline NodeType *getEntryNode(const Type *T) { return T; }
387 static inline ChildIteratorType child_begin(NodeType *N) {
388 return N->subtype_begin();
390 static inline ChildIteratorType child_end(NodeType *N) {
391 return N->subtype_end();
395 template <> inline bool isa_impl<PointerType, Type>(const Type &Ty) {
396 return Ty.getTypeID() == Type::PointerTyID;
399 std::ostream &operator<<(std::ostream &OS, const Type &T);
401 } // End llvm namespace