1 //===-- llvm/DerivedTypes.h - Classes for handling data types ---*- 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 declarations of classes that represent "derived
11 // types". These are things like "arrays of x" or "structure of x, y, z" or
12 // "function returning x taking (y,z) as parameters", etc...
14 // The implementations of these classes live in the Type.cpp file.
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_IR_DERIVEDTYPES_H
19 #define LLVM_IR_DERIVEDTYPES_H
21 #include "llvm/IR/Type.h"
22 #include "llvm/Support/Compiler.h"
23 #include "llvm/Support/DataTypes.h"
30 template<typename T> class ArrayRef;
33 /// Class to represent integer types. Note that this class is also used to
34 /// represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and
36 /// @brief Integer representation type
37 class IntegerType : public Type {
38 friend class LLVMContextImpl;
41 explicit IntegerType(LLVMContext &C, unsigned NumBits) : Type(C, IntegerTyID){
42 setSubclassData(NumBits);
45 /// This enum is just used to hold constants we need for IntegerType.
47 MIN_INT_BITS = 1, ///< Minimum number of bits that can be specified
48 MAX_INT_BITS = (1<<23)-1 ///< Maximum number of bits that can be specified
49 ///< Note that bit width is stored in the Type classes SubclassData field
50 ///< which has 23 bits. This yields a maximum bit width of 8,388,607 bits.
53 /// This static method is the primary way of constructing an IntegerType.
54 /// If an IntegerType with the same NumBits value was previously instantiated,
55 /// that instance will be returned. Otherwise a new one will be created. Only
56 /// one instance with a given NumBits value is ever created.
57 /// @brief Get or create an IntegerType instance.
58 static IntegerType *get(LLVMContext &C, unsigned NumBits);
60 /// @brief Get the number of bits in this IntegerType
61 unsigned getBitWidth() const { return getSubclassData(); }
63 /// getBitMask - Return a bitmask with ones set for all of the bits
64 /// that can be set by an unsigned version of this type. This is 0xFF for
65 /// i8, 0xFFFF for i16, etc.
66 uint64_t getBitMask() const {
67 return ~uint64_t(0UL) >> (64-getBitWidth());
70 /// getSignBit - Return a uint64_t with just the most significant bit set (the
71 /// sign bit, if the value is treated as a signed number).
72 uint64_t getSignBit() const {
73 return 1ULL << (getBitWidth()-1);
76 /// For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.
77 /// @returns a bit mask with ones set for all the bits of this type.
78 /// @brief Get a bit mask for this type.
79 APInt getMask() const;
81 /// This method determines if the width of this IntegerType is a power-of-2
82 /// in terms of 8 bit bytes.
83 /// @returns true if this is a power-of-2 byte width.
84 /// @brief Is this a power-of-2 byte-width IntegerType ?
85 bool isPowerOf2ByteWidth() const;
87 /// Methods for support type inquiry through isa, cast, and dyn_cast.
88 static inline bool classof(const Type *T) {
89 return T->getTypeID() == IntegerTyID;
94 /// FunctionType - Class to represent function types
96 class FunctionType : public Type {
97 FunctionType(const FunctionType &) LLVM_DELETED_FUNCTION;
98 const FunctionType &operator=(const FunctionType &) LLVM_DELETED_FUNCTION;
99 FunctionType(Type *Result, ArrayRef<Type*> Params, bool IsVarArgs);
102 /// FunctionType::get - This static method is the primary way of constructing
105 static FunctionType *get(Type *Result,
106 ArrayRef<Type*> Params, bool isVarArg);
108 /// FunctionType::get - Create a FunctionType taking no parameters.
110 static FunctionType *get(Type *Result, bool isVarArg);
112 /// isValidReturnType - Return true if the specified type is valid as a return
114 static bool isValidReturnType(Type *RetTy);
116 /// isValidArgumentType - Return true if the specified type is valid as an
118 static bool isValidArgumentType(Type *ArgTy);
120 bool isVarArg() const { return getSubclassData()!=0; }
121 Type *getReturnType() const { return ContainedTys[0]; }
123 typedef Type::subtype_iterator param_iterator;
124 param_iterator param_begin() const { return ContainedTys + 1; }
125 param_iterator param_end() const { return &ContainedTys[NumContainedTys]; }
127 /// Parameter type accessors.
128 Type *getParamType(unsigned i) const { return ContainedTys[i+1]; }
130 /// getNumParams - Return the number of fixed parameters this function type
131 /// requires. This does not consider varargs.
133 unsigned getNumParams() const { return NumContainedTys - 1; }
135 /// Methods for support type inquiry through isa, cast, and dyn_cast.
136 static inline bool classof(const Type *T) {
137 return T->getTypeID() == FunctionTyID;
142 /// CompositeType - Common super class of ArrayType, StructType, PointerType
144 class CompositeType : public Type {
146 explicit CompositeType(LLVMContext &C, TypeID tid) : Type(C, tid) { }
149 /// getTypeAtIndex - Given an index value into the type, return the type of
152 Type *getTypeAtIndex(const Value *V);
153 Type *getTypeAtIndex(unsigned Idx);
154 bool indexValid(const Value *V) const;
155 bool indexValid(unsigned Idx) const;
157 /// Methods for support type inquiry through isa, cast, and dyn_cast.
158 static inline bool classof(const Type *T) {
159 return T->getTypeID() == ArrayTyID ||
160 T->getTypeID() == StructTyID ||
161 T->getTypeID() == PointerTyID ||
162 T->getTypeID() == VectorTyID;
167 /// StructType - Class to represent struct types. There are two different kinds
168 /// of struct types: Literal structs and Identified structs.
170 /// Literal struct types (e.g. { i32, i32 }) are uniqued structurally, and must
171 /// always have a body when created. You can get one of these by using one of
172 /// the StructType::get() forms.
174 /// Identified structs (e.g. %foo or %42) may optionally have a name and are not
175 /// uniqued. The names for identified structs are managed at the LLVMContext
176 /// level, so there can only be a single identified struct with a given name in
177 /// a particular LLVMContext. Identified structs may also optionally be opaque
178 /// (have no body specified). You get one of these by using one of the
179 /// StructType::create() forms.
181 /// Independent of what kind of struct you have, the body of a struct type are
182 /// laid out in memory consequtively with the elements directly one after the
183 /// other (if the struct is packed) or (if not packed) with padding between the
184 /// elements as defined by DataLayout (which is required to match what the code
185 /// generator for a target expects).
187 class StructType : public CompositeType {
188 StructType(const StructType &) LLVM_DELETED_FUNCTION;
189 const StructType &operator=(const StructType &) LLVM_DELETED_FUNCTION;
190 StructType(LLVMContext &C)
191 : CompositeType(C, StructTyID), SymbolTableEntry(nullptr) {}
193 /// This is the contents of the SubClassData field.
200 /// SymbolTableEntry - For a named struct that actually has a name, this is a
201 /// pointer to the symbol table entry (maintained by LLVMContext) for the
202 /// struct. This is null if the type is an literal struct or if it is
203 /// a identified type that has an empty name.
205 void *SymbolTableEntry;
208 /// StructType::create - This creates an identified struct.
209 static StructType *create(LLVMContext &Context, StringRef Name);
210 static StructType *create(LLVMContext &Context);
212 static StructType *create(ArrayRef<Type*> Elements,
214 bool isPacked = false);
215 static StructType *create(ArrayRef<Type*> Elements);
216 static StructType *create(LLVMContext &Context,
217 ArrayRef<Type*> Elements,
219 bool isPacked = false);
220 static StructType *create(LLVMContext &Context, ArrayRef<Type*> Elements);
221 static StructType *create(StringRef Name, Type *elt1, ...) END_WITH_NULL;
223 /// StructType::get - This static method is the primary way to create a
224 /// literal StructType.
225 static StructType *get(LLVMContext &Context, ArrayRef<Type*> Elements,
226 bool isPacked = false);
228 /// StructType::get - Create an empty structure type.
230 static StructType *get(LLVMContext &Context, bool isPacked = false);
232 /// StructType::get - This static method is a convenience method for creating
233 /// structure types by specifying the elements as arguments. Note that this
234 /// method always returns a non-packed struct, and requires at least one
236 static StructType *get(Type *elt1, ...) END_WITH_NULL;
238 bool isPacked() const { return (getSubclassData() & SCDB_Packed) != 0; }
240 /// isLiteral - Return true if this type is uniqued by structural
241 /// equivalence, false if it is a struct definition.
242 bool isLiteral() const { return (getSubclassData() & SCDB_IsLiteral) != 0; }
244 /// isOpaque - Return true if this is a type with an identity that has no body
245 /// specified yet. These prints as 'opaque' in .ll files.
246 bool isOpaque() const { return (getSubclassData() & SCDB_HasBody) == 0; }
248 /// isSized - Return true if this is a sized type.
249 bool isSized(SmallPtrSetImpl<const Type*> *Visited = nullptr) const;
251 /// hasName - Return true if this is a named struct that has a non-empty name.
252 bool hasName() const { return SymbolTableEntry != nullptr; }
254 /// getName - Return the name for this struct type if it has an identity.
255 /// This may return an empty string for an unnamed struct type. Do not call
256 /// this on an literal type.
257 StringRef getName() const;
259 /// setName - Change the name of this type to the specified name, or to a name
260 /// with a suffix if there is a collision. Do not call this on an literal
262 void setName(StringRef Name);
264 /// setBody - Specify a body for an opaque identified type.
265 void setBody(ArrayRef<Type*> Elements, bool isPacked = false);
266 void setBody(Type *elt1, ...) END_WITH_NULL;
268 /// isValidElementType - Return true if the specified type is valid as a
270 static bool isValidElementType(Type *ElemTy);
273 // Iterator access to the elements.
274 typedef Type::subtype_iterator element_iterator;
275 element_iterator element_begin() const { return ContainedTys; }
276 element_iterator element_end() const { return &ContainedTys[NumContainedTys];}
278 /// isLayoutIdentical - Return true if this is layout identical to the
279 /// specified struct.
280 bool isLayoutIdentical(StructType *Other) const;
282 /// Random access to the elements
283 unsigned getNumElements() const { return NumContainedTys; }
284 Type *getElementType(unsigned N) const {
285 assert(N < NumContainedTys && "Element number out of range!");
286 return ContainedTys[N];
289 /// Methods for support type inquiry through isa, cast, and dyn_cast.
290 static inline bool classof(const Type *T) {
291 return T->getTypeID() == StructTyID;
295 /// SequentialType - This is the superclass of the array, pointer and vector
296 /// type classes. All of these represent "arrays" in memory. The array type
297 /// represents a specifically sized array, pointer types are unsized/unknown
298 /// size arrays, vector types represent specifically sized arrays that
299 /// allow for use of SIMD instructions. SequentialType holds the common
300 /// features of all, which stem from the fact that all three lay their
301 /// components out in memory identically.
303 class SequentialType : public CompositeType {
304 Type *ContainedType; ///< Storage for the single contained type.
305 SequentialType(const SequentialType &) LLVM_DELETED_FUNCTION;
306 const SequentialType &operator=(const SequentialType &) LLVM_DELETED_FUNCTION;
309 SequentialType(TypeID TID, Type *ElType)
310 : CompositeType(ElType->getContext(), TID), ContainedType(ElType) {
311 ContainedTys = &ContainedType;
316 Type *getElementType() const { return ContainedTys[0]; }
318 /// Methods for support type inquiry through isa, cast, and dyn_cast.
319 static inline bool classof(const Type *T) {
320 return T->getTypeID() == ArrayTyID ||
321 T->getTypeID() == PointerTyID ||
322 T->getTypeID() == VectorTyID;
327 /// ArrayType - Class to represent array types.
329 class ArrayType : public SequentialType {
330 uint64_t NumElements;
332 ArrayType(const ArrayType &) LLVM_DELETED_FUNCTION;
333 const ArrayType &operator=(const ArrayType &) LLVM_DELETED_FUNCTION;
334 ArrayType(Type *ElType, uint64_t NumEl);
336 /// ArrayType::get - This static method is the primary way to construct an
339 static ArrayType *get(Type *ElementType, uint64_t NumElements);
341 /// isValidElementType - Return true if the specified type is valid as a
343 static bool isValidElementType(Type *ElemTy);
345 uint64_t getNumElements() const { return NumElements; }
347 /// Methods for support type inquiry through isa, cast, and dyn_cast.
348 static inline bool classof(const Type *T) {
349 return T->getTypeID() == ArrayTyID;
353 /// VectorType - Class to represent vector types.
355 class VectorType : public SequentialType {
356 unsigned NumElements;
358 VectorType(const VectorType &) LLVM_DELETED_FUNCTION;
359 const VectorType &operator=(const VectorType &) LLVM_DELETED_FUNCTION;
360 VectorType(Type *ElType, unsigned NumEl);
362 /// VectorType::get - This static method is the primary way to construct an
365 static VectorType *get(Type *ElementType, unsigned NumElements);
367 /// VectorType::getInteger - This static method gets a VectorType with the
368 /// same number of elements as the input type, and the element type is an
369 /// integer type of the same width as the input element type.
371 static VectorType *getInteger(VectorType *VTy) {
372 unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
373 assert(EltBits && "Element size must be of a non-zero size");
374 Type *EltTy = IntegerType::get(VTy->getContext(), EltBits);
375 return VectorType::get(EltTy, VTy->getNumElements());
378 /// VectorType::getExtendedElementVectorType - This static method is like
379 /// getInteger except that the element types are twice as wide as the
380 /// elements in the input type.
382 static VectorType *getExtendedElementVectorType(VectorType *VTy) {
383 unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
384 Type *EltTy = IntegerType::get(VTy->getContext(), EltBits * 2);
385 return VectorType::get(EltTy, VTy->getNumElements());
388 /// VectorType::getTruncatedElementVectorType - This static method is like
389 /// getInteger except that the element types are half as wide as the
390 /// elements in the input type.
392 static VectorType *getTruncatedElementVectorType(VectorType *VTy) {
393 unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
394 assert((EltBits & 1) == 0 &&
395 "Cannot truncate vector element with odd bit-width");
396 Type *EltTy = IntegerType::get(VTy->getContext(), EltBits / 2);
397 return VectorType::get(EltTy, VTy->getNumElements());
400 /// VectorType::getHalfElementsVectorType - This static method returns
401 /// a VectorType with half as many elements as the input type and the
402 /// same element type.
404 static VectorType *getHalfElementsVectorType(VectorType *VTy) {
405 unsigned NumElts = VTy->getNumElements();
406 assert ((NumElts & 1) == 0 &&
407 "Cannot halve vector with odd number of elements.");
408 return VectorType::get(VTy->getElementType(), NumElts/2);
411 /// VectorType::getDoubleElementsVectorType - This static method returns
412 /// a VectorType with twice as many elements as the input type and the
413 /// same element type.
415 static VectorType *getDoubleElementsVectorType(VectorType *VTy) {
416 unsigned NumElts = VTy->getNumElements();
417 return VectorType::get(VTy->getElementType(), NumElts*2);
420 /// isValidElementType - Return true if the specified type is valid as a
422 static bool isValidElementType(Type *ElemTy);
424 /// @brief Return the number of elements in the Vector type.
425 unsigned getNumElements() const { return NumElements; }
427 /// @brief Return the number of bits in the Vector type.
428 /// Returns zero when the vector is a vector of pointers.
429 unsigned getBitWidth() const {
430 return NumElements * getElementType()->getPrimitiveSizeInBits();
433 /// Methods for support type inquiry through isa, cast, and dyn_cast.
434 static inline bool classof(const Type *T) {
435 return T->getTypeID() == VectorTyID;
440 /// PointerType - Class to represent pointers.
442 class PointerType : public SequentialType {
443 PointerType(const PointerType &) LLVM_DELETED_FUNCTION;
444 const PointerType &operator=(const PointerType &) LLVM_DELETED_FUNCTION;
445 explicit PointerType(Type *ElType, unsigned AddrSpace);
447 /// PointerType::get - This constructs a pointer to an object of the specified
448 /// type in a numbered address space.
449 static PointerType *get(Type *ElementType, unsigned AddressSpace);
451 /// PointerType::getUnqual - This constructs a pointer to an object of the
452 /// specified type in the generic address space (address space zero).
453 static PointerType *getUnqual(Type *ElementType) {
454 return PointerType::get(ElementType, 0);
457 /// isValidElementType - Return true if the specified type is valid as a
459 static bool isValidElementType(Type *ElemTy);
461 /// @brief Return the address space of the Pointer type.
462 inline unsigned getAddressSpace() const { return getSubclassData(); }
464 /// Implement support type inquiry through isa, cast, and dyn_cast.
465 static inline bool classof(const Type *T) {
466 return T->getTypeID() == PointerTyID;
470 } // End llvm namespace