LLVM  10.0.0svn
DerivedTypes.h
Go to the documentation of this file.
1 //===- llvm/DerivedTypes.h - Classes for handling data types ----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains the declarations of classes that represent "derived
10 // types". These are things like "arrays of x" or "structure of x, y, z" or
11 // "function returning x taking (y,z) as parameters", etc...
12 //
13 // The implementations of these classes live in the Type.cpp file.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #ifndef LLVM_IR_DERIVEDTYPES_H
18 #define LLVM_IR_DERIVEDTYPES_H
19 
20 #include "llvm/ADT/ArrayRef.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/IR/Type.h"
24 #include "llvm/Support/Casting.h"
25 #include "llvm/Support/Compiler.h"
27 #include <cassert>
28 #include <cstdint>
29 
30 namespace llvm {
31 
32 class Value;
33 class APInt;
34 class LLVMContext;
35 
36 /// Class to represent integer types. Note that this class is also used to
37 /// represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and
38 /// Int64Ty.
39 /// Integer representation type
40 class IntegerType : public Type {
41  friend class LLVMContextImpl;
42 
43 protected:
44  explicit IntegerType(LLVMContext &C, unsigned NumBits) : Type(C, IntegerTyID){
45  setSubclassData(NumBits);
46  }
47 
48 public:
49  /// This enum is just used to hold constants we need for IntegerType.
50  enum {
51  MIN_INT_BITS = 1, ///< Minimum number of bits that can be specified
52  MAX_INT_BITS = (1<<24)-1 ///< Maximum number of bits that can be specified
53  ///< Note that bit width is stored in the Type classes SubclassData field
54  ///< which has 24 bits. This yields a maximum bit width of 16,777,215
55  ///< bits.
56  };
57 
58  /// This static method is the primary way of constructing an IntegerType.
59  /// If an IntegerType with the same NumBits value was previously instantiated,
60  /// that instance will be returned. Otherwise a new one will be created. Only
61  /// one instance with a given NumBits value is ever created.
62  /// Get or create an IntegerType instance.
63  static IntegerType *get(LLVMContext &C, unsigned NumBits);
64 
65  /// Get the number of bits in this IntegerType
66  unsigned getBitWidth() const { return getSubclassData(); }
67 
68  /// Return a bitmask with ones set for all of the bits that can be set by an
69  /// unsigned version of this type. This is 0xFF for i8, 0xFFFF for i16, etc.
70  uint64_t getBitMask() const {
71  return ~uint64_t(0UL) >> (64-getBitWidth());
72  }
73 
74  /// Return a uint64_t with just the most significant bit set (the sign bit, if
75  /// the value is treated as a signed number).
76  uint64_t getSignBit() const {
77  return 1ULL << (getBitWidth()-1);
78  }
79 
80  /// For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.
81  /// @returns a bit mask with ones set for all the bits of this type.
82  /// Get a bit mask for this type.
83  APInt getMask() const;
84 
85  /// This method determines if the width of this IntegerType is a power-of-2
86  /// in terms of 8 bit bytes.
87  /// @returns true if this is a power-of-2 byte width.
88  /// Is this a power-of-2 byte-width IntegerType ?
89  bool isPowerOf2ByteWidth() const;
90 
91  /// Methods for support type inquiry through isa, cast, and dyn_cast.
92  static bool classof(const Type *T) {
93  return T->getTypeID() == IntegerTyID;
94  }
95 };
96 
97 unsigned Type::getIntegerBitWidth() const {
98  return cast<IntegerType>(this)->getBitWidth();
99 }
100 
101 /// Class to represent function types
102 ///
103 class FunctionType : public Type {
104  FunctionType(Type *Result, ArrayRef<Type*> Params, bool IsVarArgs);
105 
106 public:
107  FunctionType(const FunctionType &) = delete;
108  FunctionType &operator=(const FunctionType &) = delete;
109 
110  /// This static method is the primary way of constructing a FunctionType.
111  static FunctionType *get(Type *Result,
112  ArrayRef<Type*> Params, bool isVarArg);
113 
114  /// Create a FunctionType taking no parameters.
115  static FunctionType *get(Type *Result, bool isVarArg);
116 
117  /// Return true if the specified type is valid as a return type.
118  static bool isValidReturnType(Type *RetTy);
119 
120  /// Return true if the specified type is valid as an argument type.
121  static bool isValidArgumentType(Type *ArgTy);
122 
123  bool isVarArg() const { return getSubclassData()!=0; }
124  Type *getReturnType() const { return ContainedTys[0]; }
125 
127 
128  param_iterator param_begin() const { return ContainedTys + 1; }
131  return makeArrayRef(param_begin(), param_end());
132  }
133 
134  /// Parameter type accessors.
135  Type *getParamType(unsigned i) const { return ContainedTys[i+1]; }
136 
137  /// Return the number of fixed parameters this function type requires.
138  /// This does not consider varargs.
139  unsigned getNumParams() const { return NumContainedTys - 1; }
140 
141  /// Methods for support type inquiry through isa, cast, and dyn_cast.
142  static bool classof(const Type *T) {
143  return T->getTypeID() == FunctionTyID;
144  }
145 };
146 static_assert(alignof(FunctionType) >= alignof(Type *),
147  "Alignment sufficient for objects appended to FunctionType");
148 
150  return cast<FunctionType>(this)->isVarArg();
151 }
152 
153 Type *Type::getFunctionParamType(unsigned i) const {
154  return cast<FunctionType>(this)->getParamType(i);
155 }
156 
157 unsigned Type::getFunctionNumParams() const {
158  return cast<FunctionType>(this)->getNumParams();
159 }
160 
161 /// A handy container for a FunctionType+Callee-pointer pair, which can be
162 /// passed around as a single entity. This assists in replacing the use of
163 /// PointerType::getElementType() to access the function's type, since that's
164 /// slated for removal as part of the [opaque pointer types] project.
166 public:
167  // Allow implicit conversion from types which have a getFunctionType member
168  // (e.g. Function and InlineAsm).
169  template <typename T, typename U = decltype(&T::getFunctionType)>
171  : FnTy(Fn ? Fn->getFunctionType() : nullptr), Callee(Fn) {}
172 
174  : FnTy(FnTy), Callee(Callee) {
175  assert((FnTy == nullptr) == (Callee == nullptr));
176  }
177 
178  FunctionCallee(std::nullptr_t) {}
179 
180  FunctionCallee() = default;
181 
182  FunctionType *getFunctionType() { return FnTy; }
183 
184  Value *getCallee() { return Callee; }
185 
186  explicit operator bool() { return Callee; }
187 
188 private:
189  FunctionType *FnTy = nullptr;
190  Value *Callee = nullptr;
191 };
192 
193 /// Common super class of ArrayType, StructType and VectorType.
194 class CompositeType : public Type {
195 protected:
196  explicit CompositeType(LLVMContext &C, TypeID tid) : Type(C, tid) {}
197 
198 public:
199  /// Given an index value into the type, return the type of the element.
200  Type *getTypeAtIndex(const Value *V) const;
201  Type *getTypeAtIndex(unsigned Idx) const;
202  bool indexValid(const Value *V) const;
203  bool indexValid(unsigned Idx) const;
204 
205  /// Methods for support type inquiry through isa, cast, and dyn_cast.
206  static bool classof(const Type *T) {
207  return T->getTypeID() == ArrayTyID ||
208  T->getTypeID() == StructTyID ||
209  T->getTypeID() == VectorTyID;
210  }
211 };
212 
213 /// Class to represent struct types. There are two different kinds of struct
214 /// types: Literal structs and Identified structs.
215 ///
216 /// Literal struct types (e.g. { i32, i32 }) are uniqued structurally, and must
217 /// always have a body when created. You can get one of these by using one of
218 /// the StructType::get() forms.
219 ///
220 /// Identified structs (e.g. %foo or %42) may optionally have a name and are not
221 /// uniqued. The names for identified structs are managed at the LLVMContext
222 /// level, so there can only be a single identified struct with a given name in
223 /// a particular LLVMContext. Identified structs may also optionally be opaque
224 /// (have no body specified). You get one of these by using one of the
225 /// StructType::create() forms.
226 ///
227 /// Independent of what kind of struct you have, the body of a struct type are
228 /// laid out in memory consecutively with the elements directly one after the
229 /// other (if the struct is packed) or (if not packed) with padding between the
230 /// elements as defined by DataLayout (which is required to match what the code
231 /// generator for a target expects).
232 ///
233 class StructType : public CompositeType {
235 
236  enum {
237  /// This is the contents of the SubClassData field.
238  SCDB_HasBody = 1,
239  SCDB_Packed = 2,
240  SCDB_IsLiteral = 4,
241  SCDB_IsSized = 8
242  };
243 
244  /// For a named struct that actually has a name, this is a pointer to the
245  /// symbol table entry (maintained by LLVMContext) for the struct.
246  /// This is null if the type is an literal struct or if it is a identified
247  /// type that has an empty name.
248  void *SymbolTableEntry = nullptr;
249 
250 public:
251  StructType(const StructType &) = delete;
252  StructType &operator=(const StructType &) = delete;
253 
254  /// This creates an identified struct.
255  static StructType *create(LLVMContext &Context, StringRef Name);
256  static StructType *create(LLVMContext &Context);
257 
258  static StructType *create(ArrayRef<Type *> Elements, StringRef Name,
259  bool isPacked = false);
260  static StructType *create(ArrayRef<Type *> Elements);
261  static StructType *create(LLVMContext &Context, ArrayRef<Type *> Elements,
262  StringRef Name, bool isPacked = false);
263  static StructType *create(LLVMContext &Context, ArrayRef<Type *> Elements);
264  template <class... Tys>
265  static typename std::enable_if<are_base_of<Type, Tys...>::value,
267  create(StringRef Name, Type *elt1, Tys *... elts) {
268  assert(elt1 && "Cannot create a struct type with no elements with this");
269  SmallVector<llvm::Type *, 8> StructFields({elt1, elts...});
270  return create(StructFields, Name);
271  }
272 
273  /// This static method is the primary way to create a literal StructType.
274  static StructType *get(LLVMContext &Context, ArrayRef<Type*> Elements,
275  bool isPacked = false);
276 
277  /// Create an empty structure type.
278  static StructType *get(LLVMContext &Context, bool isPacked = false);
279 
280  /// This static method is a convenience method for creating structure types by
281  /// specifying the elements as arguments. Note that this method always returns
282  /// a non-packed struct, and requires at least one element type.
283  template <class... Tys>
284  static typename std::enable_if<are_base_of<Type, Tys...>::value,
286  get(Type *elt1, Tys *... elts) {
287  assert(elt1 && "Cannot create a struct type with no elements with this");
288  LLVMContext &Ctx = elt1->getContext();
289  SmallVector<llvm::Type *, 8> StructFields({elt1, elts...});
290  return llvm::StructType::get(Ctx, StructFields);
291  }
292 
293  bool isPacked() const { return (getSubclassData() & SCDB_Packed) != 0; }
294 
295  /// Return true if this type is uniqued by structural equivalence, false if it
296  /// is a struct definition.
297  bool isLiteral() const { return (getSubclassData() & SCDB_IsLiteral) != 0; }
298 
299  /// Return true if this is a type with an identity that has no body specified
300  /// yet. These prints as 'opaque' in .ll files.
301  bool isOpaque() const { return (getSubclassData() & SCDB_HasBody) == 0; }
302 
303  /// isSized - Return true if this is a sized type.
304  bool isSized(SmallPtrSetImpl<Type *> *Visited = nullptr) const;
305 
306  /// Return true if this is a named struct that has a non-empty name.
307  bool hasName() const { return SymbolTableEntry != nullptr; }
308 
309  /// Return the name for this struct type if it has an identity.
310  /// This may return an empty string for an unnamed struct type. Do not call
311  /// this on an literal type.
312  StringRef getName() const;
313 
314  /// Change the name of this type to the specified name, or to a name with a
315  /// suffix if there is a collision. Do not call this on an literal type.
316  void setName(StringRef Name);
317 
318  /// Specify a body for an opaque identified type.
319  void setBody(ArrayRef<Type*> Elements, bool isPacked = false);
320 
321  template <typename... Tys>
322  typename std::enable_if<are_base_of<Type, Tys...>::value, void>::type
323  setBody(Type *elt1, Tys *... elts) {
324  assert(elt1 && "Cannot create a struct type with no elements with this");
325  SmallVector<llvm::Type *, 8> StructFields({elt1, elts...});
326  setBody(StructFields);
327  }
328 
329  /// Return true if the specified type is valid as a element type.
330  static bool isValidElementType(Type *ElemTy);
331 
332  // Iterator access to the elements.
334 
337  ArrayRef<Type *> const elements() const {
338  return makeArrayRef(element_begin(), element_end());
339  }
340 
341  /// Return true if this is layout identical to the specified struct.
342  bool isLayoutIdentical(StructType *Other) const;
343 
344  /// Random access to the elements
345  unsigned getNumElements() const { return NumContainedTys; }
346  Type *getElementType(unsigned N) const {
347  assert(N < NumContainedTys && "Element number out of range!");
348  return ContainedTys[N];
349  }
350 
351  /// Methods for support type inquiry through isa, cast, and dyn_cast.
352  static bool classof(const Type *T) {
353  return T->getTypeID() == StructTyID;
354  }
355 };
356 
358  return cast<StructType>(this)->getName();
359 }
360 
361 unsigned Type::getStructNumElements() const {
362  return cast<StructType>(this)->getNumElements();
363 }
364 
366  return cast<StructType>(this)->getElementType(N);
367 }
368 
369 /// This is the superclass of the array and vector type classes. Both of these
370 /// represent "arrays" in memory. The array type represents a specifically sized
371 /// array, and the vector type represents a specifically sized array that allows
372 /// for use of SIMD instructions. SequentialType holds the common features of
373 /// both, which stem from the fact that both lay their components out in memory
374 /// identically.
376  Type *ContainedType; ///< Storage for the single contained type.
377  uint64_t NumElements;
378 
379 protected:
380  SequentialType(TypeID TID, Type *ElType, uint64_t NumElements)
381  : CompositeType(ElType->getContext(), TID), ContainedType(ElType),
382  NumElements(NumElements) {
383  ContainedTys = &ContainedType;
384  NumContainedTys = 1;
385  }
386 
387 public:
388  SequentialType(const SequentialType &) = delete;
389  SequentialType &operator=(const SequentialType &) = delete;
390 
391  /// For scalable vectors, this will return the minimum number of elements
392  /// in the vector.
393  uint64_t getNumElements() const { return NumElements; }
394  Type *getElementType() const { return ContainedType; }
395 
396  /// Methods for support type inquiry through isa, cast, and dyn_cast.
397  static bool classof(const Type *T) {
398  return T->getTypeID() == ArrayTyID || T->getTypeID() == VectorTyID;
399  }
400 };
401 
402 /// Class to represent array types.
403 class ArrayType : public SequentialType {
404  ArrayType(Type *ElType, uint64_t NumEl);
405 
406 public:
407  ArrayType(const ArrayType &) = delete;
408  ArrayType &operator=(const ArrayType &) = delete;
409 
410  /// This static method is the primary way to construct an ArrayType
411  static ArrayType *get(Type *ElementType, uint64_t NumElements);
412 
413  /// Return true if the specified type is valid as a element type.
414  static bool isValidElementType(Type *ElemTy);
415 
416  /// Methods for support type inquiry through isa, cast, and dyn_cast.
417  static bool classof(const Type *T) {
418  return T->getTypeID() == ArrayTyID;
419  }
420 };
421 
422 uint64_t Type::getArrayNumElements() const {
423  return cast<ArrayType>(this)->getNumElements();
424 }
425 
426 /// Class to represent vector types.
427 class VectorType : public SequentialType {
428  /// A fully specified VectorType is of the form <vscale x n x Ty>. 'n' is the
429  /// minimum number of elements of type Ty contained within the vector, and
430  /// 'vscale x' indicates that the total element count is an integer multiple
431  /// of 'n', where the multiple is either guaranteed to be one, or is
432  /// statically unknown at compile time.
433  ///
434  /// If the multiple is known to be 1, then the extra term is discarded in
435  /// textual IR:
436  ///
437  /// <4 x i32> - a vector containing 4 i32s
438  /// <vscale x 4 x i32> - a vector containing an unknown integer multiple
439  /// of 4 i32s
440 
441  VectorType(Type *ElType, unsigned NumEl, bool Scalable = false);
442  VectorType(Type *ElType, ElementCount EC);
443 
444  // If true, the total number of elements is an unknown multiple of the
445  // minimum 'NumElements' from SequentialType. Otherwise the total number
446  // of elements is exactly equal to 'NumElements'.
447  bool Scalable;
448 
449 public:
450  VectorType(const VectorType &) = delete;
451  VectorType &operator=(const VectorType &) = delete;
452 
453  /// This static method is the primary way to construct an VectorType.
454  static VectorType *get(Type *ElementType, ElementCount EC);
455  static VectorType *get(Type *ElementType, unsigned NumElements,
456  bool Scalable = false) {
457  return VectorType::get(ElementType, {NumElements, Scalable});
458  }
459 
460  /// This static method gets a VectorType with the same number of elements as
461  /// the input type, and the element type is an integer type of the same width
462  /// as the input element type.
464  unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
465  assert(EltBits && "Element size must be of a non-zero size");
466  Type *EltTy = IntegerType::get(VTy->getContext(), EltBits);
467  return VectorType::get(EltTy, VTy->getElementCount());
468  }
469 
470  /// This static method is like getInteger except that the element types are
471  /// twice as wide as the elements in the input type.
473  unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
474  Type *EltTy = IntegerType::get(VTy->getContext(), EltBits * 2);
475  return VectorType::get(EltTy, VTy->getElementCount());
476  }
477 
478  /// This static method is like getInteger except that the element types are
479  /// half as wide as the elements in the input type.
481  unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
482  assert((EltBits & 1) == 0 &&
483  "Cannot truncate vector element with odd bit-width");
484  Type *EltTy = IntegerType::get(VTy->getContext(), EltBits / 2);
485  return VectorType::get(EltTy, VTy->getElementCount());
486  }
487 
488  /// This static method returns a VectorType with half as many elements as the
489  /// input type and the same element type.
491  auto EltCnt = VTy->getElementCount();
492  assert ((EltCnt.Min & 1) == 0 &&
493  "Cannot halve vector with odd number of elements.");
494  return VectorType::get(VTy->getElementType(), EltCnt/2);
495  }
496 
497  /// This static method returns a VectorType with twice as many elements as the
498  /// input type and the same element type.
500  auto EltCnt = VTy->getElementCount();
501  assert((VTy->getNumElements() * 2ull) <= UINT_MAX &&
502  "Too many elements in vector");
503  return VectorType::get(VTy->getElementType(), EltCnt*2);
504  }
505 
506  /// Return true if the specified type is valid as a element type.
507  static bool isValidElementType(Type *ElemTy);
508 
509  /// Return an ElementCount instance to represent the (possibly scalable)
510  /// number of elements in the vector.
512  uint64_t MinimumEltCnt = getNumElements();
513  assert(MinimumEltCnt <= UINT_MAX && "Too many elements in vector");
514  return { (unsigned)MinimumEltCnt, Scalable };
515  }
516 
517  /// Returns whether or not this is a scalable vector (meaning the total
518  /// element count is a multiple of the minimum).
519  bool isScalable() const {
520  return Scalable;
521  }
522 
523  /// Return the minimum number of bits in the Vector type.
524  /// Returns zero when the vector is a vector of pointers.
525  unsigned getBitWidth() const {
526  return getNumElements() * getElementType()->getPrimitiveSizeInBits();
527  }
528 
529  /// Methods for support type inquiry through isa, cast, and dyn_cast.
530  static bool classof(const Type *T) {
531  return T->getTypeID() == VectorTyID;
532  }
533 };
534 
535 unsigned Type::getVectorNumElements() const {
536  return cast<VectorType>(this)->getNumElements();
537 }
538 
540  return cast<VectorType>(this)->isScalable();
541 }
542 
543 /// Class to represent pointers.
544 class PointerType : public Type {
545  explicit PointerType(Type *ElType, unsigned AddrSpace);
546 
547  Type *PointeeTy;
548 
549 public:
550  PointerType(const PointerType &) = delete;
551  PointerType &operator=(const PointerType &) = delete;
552 
553  /// This constructs a pointer to an object of the specified type in a numbered
554  /// address space.
555  static PointerType *get(Type *ElementType, unsigned AddressSpace);
556 
557  /// This constructs a pointer to an object of the specified type in the
558  /// generic address space (address space zero).
559  static PointerType *getUnqual(Type *ElementType) {
560  return PointerType::get(ElementType, 0);
561  }
562 
563  Type *getElementType() const { return PointeeTy; }
564 
565  /// Return true if the specified type is valid as a element type.
566  static bool isValidElementType(Type *ElemTy);
567 
568  /// Return true if we can load or store from a pointer to this type.
569  static bool isLoadableOrStorableType(Type *ElemTy);
570 
571  /// Return the address space of the Pointer type.
572  inline unsigned getAddressSpace() const { return getSubclassData(); }
573 
574  /// Implement support type inquiry through isa, cast, and dyn_cast.
575  static bool classof(const Type *T) {
576  return T->getTypeID() == PointerTyID;
577  }
578 };
579 
581  return cast<PointerType>(getScalarType())->getAddressSpace();
582 }
583 
584 } // end namespace llvm
585 
586 #endif // LLVM_IR_DERIVEDTYPES_H
uint64_t CallInst * C
FunctionCallee(std::nullptr_t)
Definition: DerivedTypes.h:178
CompositeType(LLVMContext &C, TypeID tid)
Definition: DerivedTypes.h:196
LLVMContext & Context
This class represents lattice values for constants.
Definition: AllocatorList.h:23
Type * getParamType(unsigned i) const
Parameter type accessors.
Definition: DerivedTypes.h:135
Type * getElementType(unsigned N) const
Definition: DerivedTypes.h:346
unsigned getFunctionNumParams() const
Definition: DerivedTypes.h:157
bool isSized(SmallPtrSetImpl< Type *> *Visited=nullptr) const
Return true if it makes sense to take the size of this type.
Definition: Type.h:264
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
ArrayRef< Type * > const elements() const
Definition: DerivedTypes.h:337
A handy container for a FunctionType+Callee-pointer pair, which can be passed around as a single enti...
Definition: DerivedTypes.h:165
unsigned getNumElements() const
Random access to the elements.
Definition: DerivedTypes.h:345
static bool classof(const Type *T)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:417
static PointerType * get(Type *ElementType, unsigned AddressSpace)
This constructs a pointer to an object of the specified type in a numbered address space...
Definition: Type.cpp:632
ElementCount getElementCount() const
Return an ElementCount instance to represent the (possibly scalable) number of elements in the vector...
Definition: DerivedTypes.h:511
13: Structures
Definition: Type.h:72
Type * getStructElementType(unsigned N) const
Definition: DerivedTypes.h:365
unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
Definition: DerivedTypes.h:580
param_iterator param_end() const
Definition: DerivedTypes.h:129
bool isOpaque() const
Return true if this is a type with an identity that has no body specified yet.
Definition: DerivedTypes.h:301
SequentialType(TypeID TID, Type *ElType, uint64_t NumElements)
Definition: DerivedTypes.h:380
static bool classof(const Type *T)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:142
15: Pointers
Definition: Type.h:74
static VectorType * getTruncatedElementVectorType(VectorType *VTy)
This static method is like getInteger except that the element types are half as wide as the elements ...
Definition: DerivedTypes.h:480
12: Functions
Definition: Type.h:71
Type *const * ContainedTys
A pointer to the array of Types contained by this Type.
Definition: Type.h:110
LLVMContext & getContext() const
Return the LLVMContext in which this type was uniqued.
Definition: Type.h:129
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:343
unsigned getBitWidth() const
Return the minimum number of bits in the Vector type.
Definition: DerivedTypes.h:525
APInt getMask() const
For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.
Definition: Type.cpp:268
ArrayRef< T > makeArrayRef(const T &OneElt)
Construct an ArrayRef from a single element.
Definition: ArrayRef.h:450
TypeID getTypeID() const
Return the type id for the type.
Definition: Type.h:137
uint64_t getArrayNumElements() const
Definition: DerivedTypes.h:422
static bool classof(const Type *T)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:530
Class to represent struct types.
Definition: DerivedTypes.h:233
static StringRef getName(Value *V)
TypeID
Definitions of all of the base types for the Type system.
Definition: Type.h:54
Type * getFunctionParamType(unsigned i) const
Definition: DerivedTypes.h:153
uint64_t getNumElements() const
For scalable vectors, this will return the minimum number of elements in the vector.
Definition: DerivedTypes.h:393
static StructType * get(LLVMContext &Context, ArrayRef< Type *> Elements, bool isPacked=false)
This static method is the primary way to create a literal StructType.
Definition: Type.cpp:341
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:877
Class to represent function types.
Definition: DerivedTypes.h:103
Class to represent array types.
Definition: DerivedTypes.h:403
bool isVarArg() const
Definition: DerivedTypes.h:123
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
uint64_t getBitMask() const
Return a bitmask with ones set for all of the bits that can be set by an unsigned version of this typ...
Definition: DerivedTypes.h:70
Type(LLVMContext &C, TypeID tid)
Definition: Type.h:90
unsigned getBitWidth() const
Get the number of bits in this IntegerType.
Definition: DerivedTypes.h:66
Type *const * subtype_iterator
Definition: Type.h:312
Type::subtype_iterator element_iterator
Definition: DerivedTypes.h:333
Class to represent pointers.
Definition: DerivedTypes.h:544
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return &#39;this&#39;.
Definition: Type.h:303
11: Arbitrary bit width integers
Definition: Type.h:70
static VectorType * getHalfElementsVectorType(VectorType *VTy)
This static method returns a VectorType with half as many elements as the input type and the same ele...
Definition: DerivedTypes.h:490
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:64
static std::enable_if< are_base_of< Type, Tys... >::value, StructType * >::type create(StringRef Name, Type *elt1, Tys *... elts)
Definition: DerivedTypes.h:267
FunctionCallee(FunctionType *FnTy, Value *Callee)
Definition: DerivedTypes.h:173
unsigned getNumParams() const
Return the number of fixed parameters this function type requires.
Definition: DerivedTypes.h:139
static bool classof(const Type *T)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:206
element_iterator element_end() const
Definition: DerivedTypes.h:336
ArrayRef< Type * > params() const
Definition: DerivedTypes.h:130
param_iterator param_begin() const
Definition: DerivedTypes.h:128
static VectorType * getInteger(VectorType *VTy)
This static method gets a VectorType with the same number of elements as the input type...
Definition: DerivedTypes.h:463
static bool classof(const Type *T)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:397
unsigned getStructNumElements() const
Definition: DerivedTypes.h:361
unsigned getAddressSpace() const
Return the address space of the Pointer type.
Definition: DerivedTypes.h:572
Class to represent integer types.
Definition: DerivedTypes.h:40
static VectorType * getDoubleElementsVectorType(VectorType *VTy)
This static method returns a VectorType with twice as many elements as the input type and the same el...
Definition: DerivedTypes.h:499
bool isFunctionVarArg() const
Definition: DerivedTypes.h:149
14: Arrays
Definition: Type.h:73
This is the superclass of the array and vector type classes.
Definition: DerivedTypes.h:375
Maximum number of bits that can be specified.
Definition: DerivedTypes.h:52
static IntegerType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing an IntegerType.
Definition: Type.cpp:239
static PointerType * getUnqual(Type *ElementType)
This constructs a pointer to an object of the specified type in the generic address space (address sp...
Definition: DerivedTypes.h:559
bool isScalable() const
Returns whether or not this is a scalable vector (meaning the total element count is a multiple of th...
Definition: DerivedTypes.h:519
16: SIMD &#39;packed&#39; format, or other vector type
Definition: Type.h:75
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:837
static bool classof(const Type *T)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:352
Type::subtype_iterator param_iterator
Definition: DerivedTypes.h:126
AddressSpace
Definition: NVPTXBaseInfo.h:21
Type * getReturnType() const
Definition: DerivedTypes.h:124
static VectorType * getExtendedElementVectorType(VectorType *VTy)
This static method is like getInteger except that the element types are twice as wide as the elements...
Definition: DerivedTypes.h:472
unsigned getVectorNumElements() const
Definition: DerivedTypes.h:535
Symbol info for RuntimeDyld.
bool isLiteral() const
Return true if this type is uniqued by structural equivalence, false if it is a struct definition...
Definition: DerivedTypes.h:297
Class to represent vector types.
Definition: DerivedTypes.h:427
Class for arbitrary precision integers.
Definition: APInt.h:69
amdgpu Simplify well known AMD library false FunctionCallee Callee
element_iterator element_begin() const
Definition: DerivedTypes.h:335
Common super class of ArrayType, StructType and VectorType.
Definition: DerivedTypes.h:194
static bool classof(const Type *T)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:92
std::enable_if< are_base_of< Type, Tys... >::value, void >::type setBody(Type *elt1, Tys *... elts)
Definition: DerivedTypes.h:323
unsigned getSubclassData() const
Definition: Type.h:94
bool isPowerOf2ByteWidth() const
This method determines if the width of this IntegerType is a power-of-2 in terms of 8 bit bytes...
Definition: Type.cpp:263
bool isPacked() const
Definition: DerivedTypes.h:293
unsigned getIntegerBitWidth() const
Definition: DerivedTypes.h:97
static VectorType * get(Type *ElementType, ElementCount EC)
This static method is the primary way to construct an VectorType.
Definition: Type.cpp:609
#define N
static bool isValidElementType(Type *Ty)
Predicate for the element types that the SLP vectorizer supports.
FunctionType * getFunctionType()
Definition: DerivedTypes.h:182
uint64_t getSignBit() const
Return a uint64_t with just the most significant bit set (the sign bit, if the value is treated as a ...
Definition: DerivedTypes.h:76
bool getVectorIsScalable() const
Definition: DerivedTypes.h:539
static bool classof(const Type *T)
Implement support type inquiry through isa, cast, and dyn_cast.
Definition: DerivedTypes.h:575
IntegerType(LLVMContext &C, unsigned NumBits)
Definition: DerivedTypes.h:44
void setSubclassData(unsigned val)
Definition: Type.h:96
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
traits class for checking whether type T is a base class for all the given types in the variadic list...
Definition: STLExtras.h:1019
unsigned getPrimitiveSizeInBits() const LLVM_READONLY
Return the basic size of this type if it is a primitive type.
Definition: Type.cpp:114
LLVM Value Representation.
Definition: Value.h:73
Minimum number of bits that can be specified.
Definition: DerivedTypes.h:51
Type * getElementType() const
Definition: DerivedTypes.h:394
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
bool hasName() const
Return true if this is a named struct that has a non-empty name.
Definition: DerivedTypes.h:307
Type * getElementType() const
Definition: DerivedTypes.h:563
unsigned NumContainedTys
Keeps track of how many Type*&#39;s there are in the ContainedTys list.
Definition: Type.h:103
StringRef getStructName() const
Definition: DerivedTypes.h:357