eliminate the Type::getDescription() method, using "<<" instead. This
[oota-llvm.git] / include / llvm / Type.h
1 //===-- llvm/Type.h - Classes for handling data types -----------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains the declaration of the Type class.  For more "Type"
11 // stuff, look in DerivedTypes.h.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_TYPE_H
16 #define LLVM_TYPE_H
17
18 #include "llvm/AbstractTypeUser.h"
19 #include "llvm/Support/Casting.h"
20 #include <string>
21 #include <vector>
22
23 namespace llvm {
24
25 class DerivedType;
26 class PointerType;
27 class IntegerType;
28 class TypeMapBase;
29 class raw_ostream;
30 class Module;
31 class LLVMContext;
32 template<class GraphType> struct GraphTraits;
33
34 /// The instances of the Type class are immutable: once they are created,
35 /// they are never changed.  Also note that only one instance of a particular
36 /// type is ever created.  Thus seeing if two types are equal is a matter of
37 /// doing a trivial pointer comparison. To enforce that no two equal instances
38 /// are created, Type instances can only be created via static factory methods 
39 /// in class Type and in derived classes.
40 /// 
41 /// Once allocated, Types are never free'd, unless they are an abstract type
42 /// that is resolved to a more concrete type.
43 /// 
44 /// Types themself don't have a name, and can be named either by:
45 /// - using SymbolTable instance, typically from some Module,
46 /// - using convenience methods in the Module class (which uses module's 
47 ///    SymbolTable too).
48 ///
49 /// Opaque types are simple derived types with no state.  There may be many
50 /// different Opaque type objects floating around, but two are only considered
51 /// identical if they are pointer equals of each other.  This allows us to have
52 /// two opaque types that end up resolving to different concrete types later.
53 ///
54 /// Opaque types are also kinda weird and scary and different because they have
55 /// to keep a list of uses of the type.  When, through linking, parsing, or
56 /// bitcode reading, they become resolved, they need to find and update all
57 /// users of the unknown type, causing them to reference a new, more concrete
58 /// type.  Opaque types are deleted when their use list dwindles to zero users.
59 ///
60 /// @brief Root of type hierarchy
61 class Type : public AbstractTypeUser {
62 public:
63   //===--------------------------------------------------------------------===//
64   /// Definitions of all of the base types for the Type system.  Based on this
65   /// value, you can cast to a "DerivedType" subclass (see DerivedTypes.h)
66   /// Note: If you add an element to this, you need to add an element to the
67   /// Type::getPrimitiveType function, or else things will break!
68   /// Also update LLVMTypeKind and LLVMGetTypeKind () in the C binding.
69   ///
70   enum TypeID {
71     // PrimitiveTypes - make sure LastPrimitiveTyID stays up to date.
72     VoidTyID = 0,    ///<  0: type with no size
73     FloatTyID,       ///<  1: 32-bit floating point type
74     DoubleTyID,      ///<  2: 64-bit floating point type
75     X86_FP80TyID,    ///<  3: 80-bit floating point type (X87)
76     FP128TyID,       ///<  4: 128-bit floating point type (112-bit mantissa)
77     PPC_FP128TyID,   ///<  5: 128-bit floating point type (two 64-bits, PowerPC)
78     LabelTyID,       ///<  6: Labels
79     MetadataTyID,    ///<  7: Metadata
80     X86_MMXTyID,     ///<  8: MMX vectors (64 bits, X86 specific)
81
82     // Derived types... see DerivedTypes.h file.
83     // Make sure FirstDerivedTyID stays up to date!
84     IntegerTyID,     ///<  9: Arbitrary bit width integers
85     FunctionTyID,    ///< 10: Functions
86     StructTyID,      ///< 11: Structures
87     ArrayTyID,       ///< 12: Arrays
88     PointerTyID,     ///< 13: Pointers
89     OpaqueTyID,      ///< 14: Opaque: type with unknown structure
90     VectorTyID,      ///< 15: SIMD 'packed' format, or other vector type
91
92     NumTypeIDs,                         // Must remain as last defined ID
93     LastPrimitiveTyID = X86_MMXTyID,
94     FirstDerivedTyID = IntegerTyID
95   };
96
97 private:
98   TypeID   ID : 8;    // The current base type of this type.
99   bool     Abstract : 1;  // True if type contains an OpaqueType
100   unsigned SubclassData : 23; //Space for subclasses to store data
101
102   /// RefCount - This counts the number of PATypeHolders that are pointing to
103   /// this type.  When this number falls to zero, if the type is abstract and
104   /// has no AbstractTypeUsers, the type is deleted.  This is only sensical for
105   /// derived types.
106   ///
107   mutable unsigned RefCount;
108
109   /// Context - This refers to the LLVMContext in which this type was uniqued.
110   LLVMContext &Context;
111   friend class LLVMContextImpl;
112
113   const Type *getForwardedTypeInternal() const;
114
115   // When the last reference to a forwarded type is removed, it is destroyed.
116   void destroy() const;
117
118 protected:
119   explicit Type(LLVMContext &C, TypeID id) :
120                              ID(id), Abstract(false), SubclassData(0),
121                              RefCount(0), Context(C),
122                              ForwardType(0), NumContainedTys(0),
123                              ContainedTys(0) {}
124   virtual ~Type() {
125     assert(AbstractTypeUsers.empty() && "Abstract types remain");
126   }
127
128   /// Types can become nonabstract later, if they are refined.
129   ///
130   inline void setAbstract(bool Val) { Abstract = Val; }
131
132   unsigned getRefCount() const { return RefCount; }
133
134   unsigned getSubclassData() const { return SubclassData; }
135   void setSubclassData(unsigned val) { SubclassData = val; }
136
137   /// ForwardType - This field is used to implement the union find scheme for
138   /// abstract types.  When types are refined to other types, this field is set
139   /// to the more refined type.  Only abstract types can be forwarded.
140   mutable const Type *ForwardType;
141
142
143   /// AbstractTypeUsers - Implement a list of the users that need to be notified
144   /// if I am a type, and I get resolved into a more concrete type.
145   ///
146   mutable std::vector<AbstractTypeUser *> AbstractTypeUsers;
147
148   /// NumContainedTys - Keeps track of how many PATypeHandle instances there
149   /// are at the end of this type instance for the list of contained types. It
150   /// is the subclasses responsibility to set this up. Set to 0 if there are no
151   /// contained types in this type.
152   unsigned NumContainedTys;
153
154   /// ContainedTys - A pointer to the array of Types (PATypeHandle) contained 
155   /// by this Type.  For example, this includes the arguments of a function 
156   /// type, the elements of a structure, the pointee of a pointer, the element
157   /// type of an array, etc.  This pointer may be 0 for types that don't 
158   /// contain other types (Integer, Double, Float).  In general, the subclass 
159   /// should arrange for space for the PATypeHandles to be included in the 
160   /// allocation of the type object and set this pointer to the address of the 
161   /// first element. This allows the Type class to manipulate the ContainedTys 
162   /// without understanding the subclass's placement for this array.  keeping 
163   /// it here also allows the subtype_* members to be implemented MUCH more 
164   /// efficiently, and dynamically very few types do not contain any elements.
165   PATypeHandle *ContainedTys;
166
167 public:
168   void print(raw_ostream &O) const;
169
170   /// @brief Debugging support: print to stderr
171   void dump() const;
172
173   /// @brief Debugging support: print to stderr (use type names from context
174   /// module).
175   void dump(const Module *Context) const;
176
177   /// getContext - Fetch the LLVMContext in which this type was uniqued.
178   LLVMContext &getContext() const { return Context; }
179
180   //===--------------------------------------------------------------------===//
181   // Accessors for working with types.
182   //
183
184   /// getTypeID - Return the type id for the type.  This will return one
185   /// of the TypeID enum elements defined above.
186   ///
187   TypeID getTypeID() const { return ID; }
188
189   /// isVoidTy - Return true if this is 'void'.
190   bool isVoidTy() const { return ID == VoidTyID; }
191
192   /// isFloatTy - Return true if this is 'float', a 32-bit IEEE fp type.
193   bool isFloatTy() const { return ID == FloatTyID; }
194   
195   /// isDoubleTy - Return true if this is 'double', a 64-bit IEEE fp type.
196   bool isDoubleTy() const { return ID == DoubleTyID; }
197
198   /// isX86_FP80Ty - Return true if this is x86 long double.
199   bool isX86_FP80Ty() const { return ID == X86_FP80TyID; }
200
201   /// isFP128Ty - Return true if this is 'fp128'.
202   bool isFP128Ty() const { return ID == FP128TyID; }
203
204   /// isPPC_FP128Ty - Return true if this is powerpc long double.
205   bool isPPC_FP128Ty() const { return ID == PPC_FP128TyID; }
206
207   /// isFloatingPointTy - Return true if this is one of the five floating point
208   /// types
209   bool isFloatingPointTy() const { return ID == FloatTyID || ID == DoubleTyID ||
210       ID == X86_FP80TyID || ID == FP128TyID || ID == PPC_FP128TyID; }
211
212   /// isX86_MMXTy - Return true if this is X86 MMX.
213   bool isX86_MMXTy() const { return ID == X86_MMXTyID; }
214
215   /// isFPOrFPVectorTy - Return true if this is a FP type or a vector of FP.
216   ///
217   bool isFPOrFPVectorTy() const;
218  
219   /// isLabelTy - Return true if this is 'label'.
220   bool isLabelTy() const { return ID == LabelTyID; }
221
222   /// isMetadataTy - Return true if this is 'metadata'.
223   bool isMetadataTy() const { return ID == MetadataTyID; }
224
225   /// isIntegerTy - True if this is an instance of IntegerType.
226   ///
227   bool isIntegerTy() const { return ID == IntegerTyID; } 
228
229   /// isIntegerTy - Return true if this is an IntegerType of the given width.
230   bool isIntegerTy(unsigned Bitwidth) const;
231
232   /// isIntOrIntVectorTy - Return true if this is an integer type or a vector of
233   /// integer types.
234   ///
235   bool isIntOrIntVectorTy() const;
236   
237   /// isFunctionTy - True if this is an instance of FunctionType.
238   ///
239   bool isFunctionTy() const { return ID == FunctionTyID; }
240
241   /// isStructTy - True if this is an instance of StructType.
242   ///
243   bool isStructTy() const { return ID == StructTyID; }
244
245   /// isArrayTy - True if this is an instance of ArrayType.
246   ///
247   bool isArrayTy() const { return ID == ArrayTyID; }
248
249   /// isPointerTy - True if this is an instance of PointerType.
250   ///
251   bool isPointerTy() const { return ID == PointerTyID; }
252
253   /// isOpaqueTy - True if this is an instance of OpaqueType.
254   ///
255   bool isOpaqueTy() const { return ID == OpaqueTyID; }
256
257   /// isVectorTy - True if this is an instance of VectorType.
258   ///
259   bool isVectorTy() const { return ID == VectorTyID; }
260
261   /// isAbstract - True if the type is either an Opaque type, or is a derived
262   /// type that includes an opaque type somewhere in it.
263   ///
264   inline bool isAbstract() const { return Abstract; }
265
266   /// canLosslesslyBitCastTo - Return true if this type could be converted 
267   /// with a lossless BitCast to type 'Ty'. For example, i8* to i32*. BitCasts 
268   /// are valid for types of the same size only where no re-interpretation of 
269   /// the bits is done.
270   /// @brief Determine if this type could be losslessly bitcast to Ty
271   bool canLosslesslyBitCastTo(const Type *Ty) const;
272
273   /// isEmptyTy - Return true if this type is empty, that is, it has no
274   /// elements or all its elements are empty.
275   bool isEmptyTy() const;
276
277   /// Here are some useful little methods to query what type derived types are
278   /// Note that all other types can just compare to see if this == Type::xxxTy;
279   ///
280   inline bool isPrimitiveType() const { return ID <= LastPrimitiveTyID; }
281   inline bool isDerivedType()   const { return ID >= FirstDerivedTyID; }
282
283   /// isFirstClassType - Return true if the type is "first class", meaning it
284   /// is a valid type for a Value.
285   ///
286   inline bool isFirstClassType() const {
287     // There are more first-class kinds than non-first-class kinds, so a
288     // negative test is simpler than a positive one.
289     return ID != FunctionTyID && ID != VoidTyID && ID != OpaqueTyID;
290   }
291
292   /// isSingleValueType - Return true if the type is a valid type for a
293   /// virtual register in codegen.  This includes all first-class types
294   /// except struct and array types.
295   ///
296   inline bool isSingleValueType() const {
297     return (ID != VoidTyID && ID <= LastPrimitiveTyID) ||
298             ID == IntegerTyID || ID == PointerTyID || ID == VectorTyID;
299   }
300
301   /// isAggregateType - Return true if the type is an aggregate type. This
302   /// means it is valid as the first operand of an insertvalue or
303   /// extractvalue instruction. This includes struct and array types, but
304   /// does not include vector types.
305   ///
306   inline bool isAggregateType() const {
307     return ID == StructTyID || ID == ArrayTyID;
308   }
309
310   /// isSized - Return true if it makes sense to take the size of this type.  To
311   /// get the actual size for a particular target, it is reasonable to use the
312   /// TargetData subsystem to do this.
313   ///
314   bool isSized() const {
315     // If it's a primitive, it is always sized.
316     if (ID == IntegerTyID || isFloatingPointTy() || ID == PointerTyID ||
317         ID == X86_MMXTyID)
318       return true;
319     // If it is not something that can have a size (e.g. a function or label),
320     // it doesn't have a size.
321     if (ID != StructTyID && ID != ArrayTyID && ID != VectorTyID)
322       return false;
323     // If it is something that can have a size and it's concrete, it definitely
324     // has a size, otherwise we have to try harder to decide.
325     return !isAbstract() || isSizedDerivedType();
326   }
327
328   /// getPrimitiveSizeInBits - Return the basic size of this type if it is a
329   /// primitive type.  These are fixed by LLVM and are not target dependent.
330   /// This will return zero if the type does not have a size or is not a
331   /// primitive type.
332   ///
333   /// Note that this may not reflect the size of memory allocated for an
334   /// instance of the type or the number of bytes that are written when an
335   /// instance of the type is stored to memory. The TargetData class provides
336   /// additional query functions to provide this information.
337   ///
338   unsigned getPrimitiveSizeInBits() const;
339
340   /// getScalarSizeInBits - If this is a vector type, return the
341   /// getPrimitiveSizeInBits value for the element type. Otherwise return the
342   /// getPrimitiveSizeInBits value for this type.
343   unsigned getScalarSizeInBits() const;
344
345   /// getFPMantissaWidth - Return the width of the mantissa of this type.  This
346   /// is only valid on floating point types.  If the FP type does not
347   /// have a stable mantissa (e.g. ppc long double), this method returns -1.
348   int getFPMantissaWidth() const;
349
350   /// getForwardedType - Return the type that this type has been resolved to if
351   /// it has been resolved to anything.  This is used to implement the
352   /// union-find algorithm for type resolution, and shouldn't be used by general
353   /// purpose clients.
354   const Type *getForwardedType() const {
355     if (!ForwardType) return 0;
356     return getForwardedTypeInternal();
357   }
358
359   /// getScalarType - If this is a vector type, return the element type,
360   /// otherwise return this.
361   const Type *getScalarType() const;
362
363   //===--------------------------------------------------------------------===//
364   // Type Iteration support
365   //
366   typedef PATypeHandle *subtype_iterator;
367   subtype_iterator subtype_begin() const { return ContainedTys; }
368   subtype_iterator subtype_end() const { return &ContainedTys[NumContainedTys];}
369
370   /// getContainedType - This method is used to implement the type iterator
371   /// (defined a the end of the file).  For derived types, this returns the
372   /// types 'contained' in the derived type.
373   ///
374   const Type *getContainedType(unsigned i) const {
375     assert(i < NumContainedTys && "Index out of range!");
376     return ContainedTys[i].get();
377   }
378
379   /// getNumContainedTypes - Return the number of types in the derived type.
380   ///
381   unsigned getNumContainedTypes() const { return NumContainedTys; }
382
383   //===--------------------------------------------------------------------===//
384   // Static members exported by the Type class itself.  Useful for getting
385   // instances of Type.
386   //
387
388   /// getPrimitiveType - Return a type based on an identifier.
389   static const Type *getPrimitiveType(LLVMContext &C, TypeID IDNumber);
390
391   //===--------------------------------------------------------------------===//
392   // These are the builtin types that are always available...
393   //
394   static const Type *getVoidTy(LLVMContext &C);
395   static const Type *getLabelTy(LLVMContext &C);
396   static const Type *getFloatTy(LLVMContext &C);
397   static const Type *getDoubleTy(LLVMContext &C);
398   static const Type *getMetadataTy(LLVMContext &C);
399   static const Type *getX86_FP80Ty(LLVMContext &C);
400   static const Type *getFP128Ty(LLVMContext &C);
401   static const Type *getPPC_FP128Ty(LLVMContext &C);
402   static const Type *getX86_MMXTy(LLVMContext &C);
403   static const IntegerType *getIntNTy(LLVMContext &C, unsigned N);
404   static const IntegerType *getInt1Ty(LLVMContext &C);
405   static const IntegerType *getInt8Ty(LLVMContext &C);
406   static const IntegerType *getInt16Ty(LLVMContext &C);
407   static const IntegerType *getInt32Ty(LLVMContext &C);
408   static const IntegerType *getInt64Ty(LLVMContext &C);
409
410   //===--------------------------------------------------------------------===//
411   // Convenience methods for getting pointer types with one of the above builtin
412   // types as pointee.
413   //
414   static const PointerType *getFloatPtrTy(LLVMContext &C, unsigned AS = 0);
415   static const PointerType *getDoublePtrTy(LLVMContext &C, unsigned AS = 0);
416   static const PointerType *getX86_FP80PtrTy(LLVMContext &C, unsigned AS = 0);
417   static const PointerType *getFP128PtrTy(LLVMContext &C, unsigned AS = 0);
418   static const PointerType *getPPC_FP128PtrTy(LLVMContext &C, unsigned AS = 0);
419   static const PointerType *getX86_MMXPtrTy(LLVMContext &C, unsigned AS = 0);
420   static const PointerType *getIntNPtrTy(LLVMContext &C, unsigned N,
421                                          unsigned AS = 0);
422   static const PointerType *getInt1PtrTy(LLVMContext &C, unsigned AS = 0);
423   static const PointerType *getInt8PtrTy(LLVMContext &C, unsigned AS = 0);
424   static const PointerType *getInt16PtrTy(LLVMContext &C, unsigned AS = 0);
425   static const PointerType *getInt32PtrTy(LLVMContext &C, unsigned AS = 0);
426   static const PointerType *getInt64PtrTy(LLVMContext &C, unsigned AS = 0);
427
428   /// Methods for support type inquiry through isa, cast, and dyn_cast:
429   static inline bool classof(const Type *) { return true; }
430
431   void addRef() const {
432     assert(isAbstract() && "Cannot add a reference to a non-abstract type!");
433     ++RefCount;
434   }
435
436   void dropRef() const {
437     assert(isAbstract() && "Cannot drop a reference to a non-abstract type!");
438     assert(RefCount && "No objects are currently referencing this object!");
439
440     // If this is the last PATypeHolder using this object, and there are no
441     // PATypeHandles using it, the type is dead, delete it now.
442     if (--RefCount == 0 && AbstractTypeUsers.empty())
443       this->destroy();
444   }
445   
446   /// addAbstractTypeUser - Notify an abstract type that there is a new user of
447   /// it.  This function is called primarily by the PATypeHandle class.
448   ///
449   void addAbstractTypeUser(AbstractTypeUser *U) const;
450   
451   /// removeAbstractTypeUser - Notify an abstract type that a user of the class
452   /// no longer has a handle to the type.  This function is called primarily by
453   /// the PATypeHandle class.  When there are no users of the abstract type, it
454   /// is annihilated, because there is no way to get a reference to it ever
455   /// again.
456   ///
457   void removeAbstractTypeUser(AbstractTypeUser *U) const;
458
459   /// getPointerTo - Return a pointer to the current type.  This is equivalent
460   /// to PointerType::get(Foo, AddrSpace).
461   const PointerType *getPointerTo(unsigned AddrSpace = 0) const;
462
463 private:
464   /// isSizedDerivedType - Derived types like structures and arrays are sized
465   /// iff all of the members of the type are sized as well.  Since asking for
466   /// their size is relatively uncommon, move this operation out of line.
467   bool isSizedDerivedType() const;
468
469   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
470   virtual void typeBecameConcrete(const DerivedType *AbsTy);
471
472 protected:
473   // PromoteAbstractToConcrete - This is an internal method used to calculate
474   // change "Abstract" from true to false when types are refined.
475   void PromoteAbstractToConcrete();
476   friend class TypeMapBase;
477 };
478
479 //===----------------------------------------------------------------------===//
480 // Define some inline methods for the AbstractTypeUser.h:PATypeHandle class.
481 // These are defined here because they MUST be inlined, yet are dependent on
482 // the definition of the Type class.
483 //
484 inline void PATypeHandle::addUser() {
485   assert(Ty && "Type Handle has a null type!");
486   if (Ty->isAbstract())
487     Ty->addAbstractTypeUser(User);
488 }
489 inline void PATypeHandle::removeUser() {
490   if (Ty->isAbstract())
491     Ty->removeAbstractTypeUser(User);
492 }
493
494 // Define inline methods for PATypeHolder.
495
496 /// get - This implements the forwarding part of the union-find algorithm for
497 /// abstract types.  Before every access to the Type*, we check to see if the
498 /// type we are pointing to is forwarding to a new type.  If so, we drop our
499 /// reference to the type.
500 ///
501 inline Type *PATypeHolder::get() const {
502   if (Ty == 0) return 0;
503   const Type *NewTy = Ty->getForwardedType();
504   if (!NewTy) return const_cast<Type*>(Ty);
505   return *const_cast<PATypeHolder*>(this) = NewTy;
506 }
507
508 inline void PATypeHolder::addRef() {
509   if (Ty && Ty->isAbstract())
510     Ty->addRef();
511 }
512
513 inline void PATypeHolder::dropRef() {
514   if (Ty && Ty->isAbstract())
515     Ty->dropRef();
516 }
517
518
519 //===----------------------------------------------------------------------===//
520 // Provide specializations of GraphTraits to be able to treat a type as a
521 // graph of sub types.
522
523 template <> struct GraphTraits<Type*> {
524   typedef Type NodeType;
525   typedef Type::subtype_iterator ChildIteratorType;
526
527   static inline NodeType *getEntryNode(Type *T) { return T; }
528   static inline ChildIteratorType child_begin(NodeType *N) {
529     return N->subtype_begin();
530   }
531   static inline ChildIteratorType child_end(NodeType *N) {
532     return N->subtype_end();
533   }
534 };
535
536 template <> struct GraphTraits<const Type*> {
537   typedef const Type NodeType;
538   typedef Type::subtype_iterator ChildIteratorType;
539
540   static inline NodeType *getEntryNode(const Type *T) { return T; }
541   static inline ChildIteratorType child_begin(NodeType *N) {
542     return N->subtype_begin();
543   }
544   static inline ChildIteratorType child_end(NodeType *N) {
545     return N->subtype_end();
546   }
547 };
548
549 template <> struct isa_impl<PointerType, Type> {
550   static inline bool doit(const Type &Ty) {
551     return Ty.getTypeID() == Type::PointerTyID;
552   }
553 };
554
555 raw_ostream &operator<<(raw_ostream &OS, const Type &T);
556
557 } // End llvm namespace
558
559 #endif