LLVM  17.0.0git
Type.h
Go to the documentation of this file.
1 //===- llvm/Type.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 declaration of the Type class. For more "Type"
10 // stuff, look in DerivedTypes.h.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_IR_TYPE_H
15 #define LLVM_IR_TYPE_H
16 
17 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/Support/Casting.h"
20 #include "llvm/Support/Compiler.h"
22 #include "llvm/Support/TypeSize.h"
23 #include <cassert>
24 #include <cstdint>
25 #include <iterator>
26 
27 namespace llvm {
28 
29 class IntegerType;
30 struct fltSemantics;
31 class LLVMContext;
32 class PointerType;
33 class raw_ostream;
34 class StringRef;
35 template <typename PtrType> class SmallPtrSetImpl;
36 
37 /// The instances of the Type class are immutable: once they are created,
38 /// they are never changed. Also note that only one instance of a particular
39 /// type is ever created. Thus seeing if two types are equal is a matter of
40 /// doing a trivial pointer comparison. To enforce that no two equal instances
41 /// are created, Type instances can only be created via static factory methods
42 /// in class Type and in derived classes. Once allocated, Types are never
43 /// free'd.
44 ///
45 class Type {
46 public:
47  //===--------------------------------------------------------------------===//
48  /// Definitions of all of the base types for the Type system. Based on this
49  /// value, you can cast to a class defined in DerivedTypes.h.
50  /// Note: If you add an element to this, you need to add an element to the
51  /// Type::getPrimitiveType function, or else things will break!
52  /// Also update LLVMTypeKind and LLVMGetTypeKind () in the C binding.
53  ///
54  enum TypeID {
55  // PrimitiveTypes
56  HalfTyID = 0, ///< 16-bit floating point type
57  BFloatTyID, ///< 16-bit floating point type (7-bit significand)
58  FloatTyID, ///< 32-bit floating point type
59  DoubleTyID, ///< 64-bit floating point type
60  X86_FP80TyID, ///< 80-bit floating point type (X87)
61  FP128TyID, ///< 128-bit floating point type (112-bit significand)
62  PPC_FP128TyID, ///< 128-bit floating point type (two 64-bits, PowerPC)
63  VoidTyID, ///< type with no size
64  LabelTyID, ///< Labels
65  MetadataTyID, ///< Metadata
66  X86_MMXTyID, ///< MMX vectors (64 bits, X86 specific)
67  X86_AMXTyID, ///< AMX vectors (8192 bits, X86 specific)
68  TokenTyID, ///< Tokens
69 
70  // Derived types... see DerivedTypes.h file.
71  IntegerTyID, ///< Arbitrary bit width integers
72  FunctionTyID, ///< Functions
73  PointerTyID, ///< Pointers
74  StructTyID, ///< Structures
75  ArrayTyID, ///< Arrays
76  FixedVectorTyID, ///< Fixed width SIMD vector type
77  ScalableVectorTyID, ///< Scalable SIMD vector type
78  TypedPointerTyID, ///< Typed pointer used by some GPU targets
79  TargetExtTyID, ///< Target extension type
80  };
81 
82 private:
83  /// This refers to the LLVMContext in which this type was uniqued.
84  LLVMContext &Context;
85 
86  TypeID ID : 8; // The current base type of this type.
87  unsigned SubclassData : 24; // Space for subclasses to store data.
88  // Note that this should be synchronized with
89  // MAX_INT_BITS value in IntegerType class.
90 
91 protected:
92  friend class LLVMContextImpl;
93 
94  explicit Type(LLVMContext &C, TypeID tid)
95  : Context(C), ID(tid), SubclassData(0) {}
96  ~Type() = default;
97 
98  unsigned getSubclassData() const { return SubclassData; }
99 
100  void setSubclassData(unsigned val) {
101  SubclassData = val;
102  // Ensure we don't have any accidental truncation.
103  assert(getSubclassData() == val && "Subclass data too large for field");
104  }
105 
106  /// Keeps track of how many Type*'s there are in the ContainedTys list.
107  unsigned NumContainedTys = 0;
108 
109  /// A pointer to the array of Types contained by this Type. For example, this
110  /// includes the arguments of a function type, the elements of a structure,
111  /// the pointee of a pointer, the element type of an array, etc. This pointer
112  /// may be 0 for types that don't contain other types (Integer, Double,
113  /// Float).
114  Type * const *ContainedTys = nullptr;
115 
116 public:
117  /// Print the current type.
118  /// Omit the type details if \p NoDetails == true.
119  /// E.g., let %st = type { i32, i16 }
120  /// When \p NoDetails is true, we only print %st.
121  /// Put differently, \p NoDetails prints the type as if
122  /// inlined with the operands when printing an instruction.
123  void print(raw_ostream &O, bool IsForDebug = false,
124  bool NoDetails = false) const;
125 
126  void dump() const;
127 
128  /// Return the LLVMContext in which this type was uniqued.
129  LLVMContext &getContext() const { return Context; }
130 
131  //===--------------------------------------------------------------------===//
132  // Accessors for working with types.
133  //
134 
135  /// Return the type id for the type. This will return one of the TypeID enum
136  /// elements defined above.
137  TypeID getTypeID() const { return ID; }
138 
139  /// Return true if this is 'void'.
140  bool isVoidTy() const { return getTypeID() == VoidTyID; }
141 
142  /// Return true if this is 'half', a 16-bit IEEE fp type.
143  bool isHalfTy() const { return getTypeID() == HalfTyID; }
144 
145  /// Return true if this is 'bfloat', a 16-bit bfloat type.
146  bool isBFloatTy() const { return getTypeID() == BFloatTyID; }
147 
148  /// Return true if this is a 16-bit float type.
149  bool is16bitFPTy() const {
150  return getTypeID() == BFloatTyID || getTypeID() == HalfTyID;
151  }
152 
153  /// Return true if this is 'float', a 32-bit IEEE fp type.
154  bool isFloatTy() const { return getTypeID() == FloatTyID; }
155 
156  /// Return true if this is 'double', a 64-bit IEEE fp type.
157  bool isDoubleTy() const { return getTypeID() == DoubleTyID; }
158 
159  /// Return true if this is x86 long double.
160  bool isX86_FP80Ty() const { return getTypeID() == X86_FP80TyID; }
161 
162  /// Return true if this is 'fp128'.
163  bool isFP128Ty() const { return getTypeID() == FP128TyID; }
164 
165  /// Return true if this is powerpc long double.
166  bool isPPC_FP128Ty() const { return getTypeID() == PPC_FP128TyID; }
167 
168  /// Return true if this is a well-behaved IEEE-like type, which has a IEEE
169  /// compatible layout as defined by isIEEE(), and does not have unnormal
170  /// values
171  bool isIEEELikeFPTy() const {
172  switch (getTypeID()) {
173  case DoubleTyID:
174  case FloatTyID:
175  case HalfTyID:
176  case BFloatTyID:
177  case FP128TyID:
178  return true;
179  default:
180  return false;
181  }
182  }
183 
184  /// Return true if this is one of the floating-point types
185  bool isFloatingPointTy() const {
186  return isIEEELikeFPTy() || getTypeID() == X86_FP80TyID ||
188  }
189 
190  /// Returns true if this is a floating-point type that is an unevaluated sum
191  /// of multiple floating-point units.
192  /// An example of such a type is ppc_fp128, also known as double-double, which
193  /// consists of two IEEE 754 doubles.
194  bool isMultiUnitFPType() const {
195  return getTypeID() == PPC_FP128TyID;
196  }
197 
198  const fltSemantics &getFltSemantics() const;
199 
200  /// Return true if this is X86 MMX.
201  bool isX86_MMXTy() const { return getTypeID() == X86_MMXTyID; }
202 
203  /// Return true if this is X86 AMX.
204  bool isX86_AMXTy() const { return getTypeID() == X86_AMXTyID; }
205 
206  /// Return true if this is a target extension type.
207  bool isTargetExtTy() const { return getTypeID() == TargetExtTyID; }
208 
209  /// Return true if this is a FP type or a vector of FP.
210  bool isFPOrFPVectorTy() const { return getScalarType()->isFloatingPointTy(); }
211 
212  /// Return true if this is 'label'.
213  bool isLabelTy() const { return getTypeID() == LabelTyID; }
214 
215  /// Return true if this is 'metadata'.
216  bool isMetadataTy() const { return getTypeID() == MetadataTyID; }
217 
218  /// Return true if this is 'token'.
219  bool isTokenTy() const { return getTypeID() == TokenTyID; }
220 
221  /// True if this is an instance of IntegerType.
222  bool isIntegerTy() const { return getTypeID() == IntegerTyID; }
223 
224  /// Return true if this is an IntegerType of the given width.
225  bool isIntegerTy(unsigned Bitwidth) const;
226 
227  /// Return true if this is an integer type or a vector of integer types.
228  bool isIntOrIntVectorTy() const { return getScalarType()->isIntegerTy(); }
229 
230  /// Return true if this is an integer type or a vector of integer types of
231  /// the given width.
232  bool isIntOrIntVectorTy(unsigned BitWidth) const {
234  }
235 
236  /// Return true if this is an integer type or a pointer type.
237  bool isIntOrPtrTy() const { return isIntegerTy() || isPointerTy(); }
238 
239  /// True if this is an instance of FunctionType.
240  bool isFunctionTy() const { return getTypeID() == FunctionTyID; }
241 
242  /// True if this is an instance of StructType.
243  bool isStructTy() const { return getTypeID() == StructTyID; }
244 
245  /// True if this is an instance of ArrayType.
246  bool isArrayTy() const { return getTypeID() == ArrayTyID; }
247 
248  /// True if this is an instance of PointerType.
249  bool isPointerTy() const { return getTypeID() == PointerTyID; }
250 
251  /// True if this is an instance of an opaque PointerType.
252  bool isOpaquePointerTy() const;
253 
254  /// Return true if this is a pointer type or a vector of pointer types.
255  bool isPtrOrPtrVectorTy() const { return getScalarType()->isPointerTy(); }
256 
257  /// True if this is an instance of VectorType.
258  inline bool isVectorTy() const {
260  }
261 
262  /// Return true if this type could be converted with a lossless BitCast to
263  /// type 'Ty'. For example, i8* to i32*. BitCasts are valid for types of the
264  /// same size only where no re-interpretation of the bits is done.
265  /// Determine if this type could be losslessly bitcast to Ty
266  bool canLosslesslyBitCastTo(Type *Ty) const;
267 
268  /// Return true if this type is empty, that is, it has no elements or all of
269  /// its elements are empty.
270  bool isEmptyTy() const;
271 
272  /// Return true if the type is "first class", meaning it is a valid type for a
273  /// Value.
274  bool isFirstClassType() const {
275  return getTypeID() != FunctionTyID && getTypeID() != VoidTyID;
276  }
277 
278  /// Return true if the type is a valid type for a register in codegen. This
279  /// includes all first-class types except struct and array types.
280  bool isSingleValueType() const {
281  return isFloatingPointTy() || isX86_MMXTy() || isIntegerTy() ||
283  }
284 
285  /// Return true if the type is an aggregate type. This means it is valid as
286  /// the first operand of an insertvalue or extractvalue instruction. This
287  /// includes struct and array types, but does not include vector types.
288  bool isAggregateType() const {
289  return getTypeID() == StructTyID || getTypeID() == ArrayTyID;
290  }
291 
292  /// Return true if it makes sense to take the size of this type. To get the
293  /// actual size for a particular target, it is reasonable to use the
294  /// DataLayout subsystem to do this.
295  bool isSized(SmallPtrSetImpl<Type*> *Visited = nullptr) const {
296  // If it's a primitive, it is always sized.
297  if (getTypeID() == IntegerTyID || isFloatingPointTy() ||
299  getTypeID() == X86_AMXTyID)
300  return true;
301  // If it is not something that can have a size (e.g. a function or label),
302  // it doesn't have a size.
303  if (getTypeID() != StructTyID && getTypeID() != ArrayTyID &&
305  return false;
306  // Otherwise we have to try harder to decide.
307  return isSizedDerivedType(Visited);
308  }
309 
310  /// Return the basic size of this type if it is a primitive type. These are
311  /// fixed by LLVM and are not target-dependent.
312  /// This will return zero if the type does not have a size or is not a
313  /// primitive type.
314  ///
315  /// If this is a scalable vector type, the scalable property will be set and
316  /// the runtime size will be a positive integer multiple of the base size.
317  ///
318  /// Note that this may not reflect the size of memory allocated for an
319  /// instance of the type or the number of bytes that are written when an
320  /// instance of the type is stored to memory. The DataLayout class provides
321  /// additional query functions to provide this information.
322  ///
324 
325  /// If this is a vector type, return the getPrimitiveSizeInBits value for the
326  /// element type. Otherwise return the getPrimitiveSizeInBits value for this
327  /// type.
329 
330  /// Return the width of the mantissa of this type. This is only valid on
331  /// floating-point types. If the FP type does not have a stable mantissa (e.g.
332  /// ppc long double), this method returns -1.
334 
335  /// Return whether the type is IEEE compatible, as defined by the eponymous
336  /// method in APFloat.
337  bool isIEEE() const;
338 
339  /// If this is a vector type, return the element type, otherwise return
340  /// 'this'.
342  if (isVectorTy())
343  return getContainedType(0);
344  return const_cast<Type *>(this);
345  }
346 
347  //===--------------------------------------------------------------------===//
348  // Type Iteration support.
349  //
350  using subtype_iterator = Type * const *;
351 
355  return ArrayRef(subtype_begin(), subtype_end());
356  }
357 
358  using subtype_reverse_iterator = std::reverse_iterator<subtype_iterator>;
359 
362  }
365  }
366 
367  /// This method is used to implement the type iterator (defined at the end of
368  /// the file). For derived types, this returns the types 'contained' in the
369  /// derived type.
370  Type *getContainedType(unsigned i) const {
371  assert(i < NumContainedTys && "Index out of range!");
372  return ContainedTys[i];
373  }
374 
375  /// Return the number of types in the derived type.
376  unsigned getNumContainedTypes() const { return NumContainedTys; }
377 
378  //===--------------------------------------------------------------------===//
379  // Helper methods corresponding to subclass methods. This forces a cast to
380  // the specified subclass and calls its accessor. "getArrayNumElements" (for
381  // example) is shorthand for cast<ArrayType>(Ty)->getNumElements(). This is
382  // only intended to cover the core methods that are frequently used, helper
383  // methods should not be added here.
384 
385  inline unsigned getIntegerBitWidth() const;
386 
387  inline Type *getFunctionParamType(unsigned i) const;
388  inline unsigned getFunctionNumParams() const;
389  inline bool isFunctionVarArg() const;
390 
391  inline StringRef getStructName() const;
392  inline unsigned getStructNumElements() const;
393  inline Type *getStructElementType(unsigned N) const;
394 
395  inline uint64_t getArrayNumElements() const;
396 
398  assert(getTypeID() == ArrayTyID);
399  return ContainedTys[0];
400  }
401 
402  inline StringRef getTargetExtName() const;
403 
404  /// This method is deprecated without replacement. Pointer element types are
405  /// not available with opaque pointers.
406  [[deprecated("Deprecated without replacement, see "
407  "https://llvm.org/docs/OpaquePointers.html for context and "
408  "migration instructions")]]
411  }
412 
413  /// Only use this method in code that is not reachable with opaque pointers,
414  /// or part of deprecated methods that will be removed as part of the opaque
415  /// pointers transition.
419  "Attempting to get element type of opaque pointer");
420  return ContainedTys[0];
421  }
422 
423  /// Given vector type, change the element type,
424  /// whilst keeping the old number of elements.
425  /// For non-vectors simply returns \p EltTy.
426  inline Type *getWithNewType(Type *EltTy) const;
427 
428  /// Given an integer or vector type, change the lane bitwidth to NewBitwidth,
429  /// whilst keeping the old number of lanes.
430  inline Type *getWithNewBitWidth(unsigned NewBitWidth) const;
431 
432  /// Given scalar/vector integer type, returns a type with elements twice as
433  /// wide as in the original type. For vectors, preserves element count.
434  inline Type *getExtendedType() const;
435 
436  /// Get the address space of this pointer or pointer vector type.
437  inline unsigned getPointerAddressSpace() const;
438 
439  //===--------------------------------------------------------------------===//
440  // Static members exported by the Type class itself. Useful for getting
441  // instances of Type.
442  //
443 
444  /// Return a type based on an identifier.
445  static Type *getPrimitiveType(LLVMContext &C, TypeID IDNumber);
446 
447  //===--------------------------------------------------------------------===//
448  // These are the builtin types that are always available.
449  //
450  static Type *getVoidTy(LLVMContext &C);
451  static Type *getLabelTy(LLVMContext &C);
452  static Type *getHalfTy(LLVMContext &C);
453  static Type *getBFloatTy(LLVMContext &C);
454  static Type *getFloatTy(LLVMContext &C);
455  static Type *getDoubleTy(LLVMContext &C);
456  static Type *getMetadataTy(LLVMContext &C);
457  static Type *getX86_FP80Ty(LLVMContext &C);
458  static Type *getFP128Ty(LLVMContext &C);
459  static Type *getPPC_FP128Ty(LLVMContext &C);
460  static Type *getX86_MMXTy(LLVMContext &C);
461  static Type *getX86_AMXTy(LLVMContext &C);
462  static Type *getTokenTy(LLVMContext &C);
463  static IntegerType *getIntNTy(LLVMContext &C, unsigned N);
470  template <typename ScalarTy> static Type *getScalarTy(LLVMContext &C) {
471  int noOfBits = sizeof(ScalarTy) * CHAR_BIT;
472  if (std::is_integral<ScalarTy>::value) {
473  return (Type*) Type::getIntNTy(C, noOfBits);
474  } else if (std::is_floating_point<ScalarTy>::value) {
475  switch (noOfBits) {
476  case 32:
477  return Type::getFloatTy(C);
478  case 64:
479  return Type::getDoubleTy(C);
480  }
481  }
482  llvm_unreachable("Unsupported type in Type::getScalarTy");
483  }
485 
486  //===--------------------------------------------------------------------===//
487  // Convenience methods for getting pointer types with one of the above builtin
488  // types as pointee.
489  //
490  static PointerType *getHalfPtrTy(LLVMContext &C, unsigned AS = 0);
491  static PointerType *getBFloatPtrTy(LLVMContext &C, unsigned AS = 0);
492  static PointerType *getFloatPtrTy(LLVMContext &C, unsigned AS = 0);
493  static PointerType *getDoublePtrTy(LLVMContext &C, unsigned AS = 0);
494  static PointerType *getX86_FP80PtrTy(LLVMContext &C, unsigned AS = 0);
495  static PointerType *getFP128PtrTy(LLVMContext &C, unsigned AS = 0);
496  static PointerType *getPPC_FP128PtrTy(LLVMContext &C, unsigned AS = 0);
497  static PointerType *getX86_MMXPtrTy(LLVMContext &C, unsigned AS = 0);
498  static PointerType *getX86_AMXPtrTy(LLVMContext &C, unsigned AS = 0);
499  static PointerType *getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS = 0);
500  static PointerType *getInt1PtrTy(LLVMContext &C, unsigned AS = 0);
501  static PointerType *getInt8PtrTy(LLVMContext &C, unsigned AS = 0);
502  static PointerType *getInt16PtrTy(LLVMContext &C, unsigned AS = 0);
503  static PointerType *getInt32PtrTy(LLVMContext &C, unsigned AS = 0);
504  static PointerType *getInt64PtrTy(LLVMContext &C, unsigned AS = 0);
505 
506  /// Return a pointer to the current type. This is equivalent to
507  /// PointerType::get(Foo, AddrSpace).
508  /// TODO: Remove this after opaque pointer transition is complete.
509  PointerType *getPointerTo(unsigned AddrSpace = 0) const;
510 
511 private:
512  /// Derived types like structures and arrays are sized iff all of the members
513  /// of the type are sized as well. Since asking for their size is relatively
514  /// uncommon, move this operation out-of-line.
515  bool isSizedDerivedType(SmallPtrSetImpl<Type*> *Visited = nullptr) const;
516 };
517 
518 // Printing of types.
519 inline raw_ostream &operator<<(raw_ostream &OS, const Type &T) {
520  T.print(OS);
521  return OS;
522 }
523 
524 // allow isa<PointerType>(x) to work without DerivedTypes.h included.
525 template <> struct isa_impl<PointerType, Type> {
526  static inline bool doit(const Type &Ty) {
527  return Ty.getTypeID() == Type::PointerTyID;
528  }
529 };
530 
531 // Create wrappers for C Binding types (see CBindingWrapping.h).
533 
534 /* Specialized opaque type conversions.
535  */
537  return reinterpret_cast<Type**>(Tys);
538 }
539 
540 inline LLVMTypeRef *wrap(Type **Tys) {
541  return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
542 }
543 
544 } // end namespace llvm
545 
546 #endif // LLVM_IR_TYPE_H
i
i
Definition: README.txt:29
llvm::Type::isFunctionVarArg
bool isFunctionVarArg() const
Definition: DerivedTypes.h:149
llvm::Type::ArrayTyID
@ ArrayTyID
Arrays.
Definition: Type.h:75
llvm::Type::FloatTyID
@ FloatTyID
32-bit floating point type
Definition: Type.h:58
PointerType
Definition: ItaniumDemangle.h:588
llvm::Type::isSized
bool isSized(SmallPtrSetImpl< Type * > *Visited=nullptr) const
Return true if it makes sense to take the size of this type.
Definition: Type.h:295
llvm::Type::subtype_end
subtype_iterator subtype_end() const
Definition: Type.h:353
LLVM_READONLY
#define LLVM_READONLY
Definition: Compiler.h:196
llvm::Type::DoubleTyID
@ DoubleTyID
64-bit floating point type
Definition: Type.h:59
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::Type::getInt16PtrTy
static PointerType * getInt16PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:297
llvm::Type::getInt1Ty
static IntegerType * getInt1Ty(LLVMContext &C)
Definition: Type.cpp:238
llvm::Type::getFunctionNumParams
unsigned getFunctionNumParams() const
Definition: DerivedTypes.h:157
llvm::AArch64PACKey::ID
ID
Definition: AArch64BaseInfo.h:824
llvm::Type::getInt8PtrTy
static PointerType * getInt8PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:293
llvm::Type::isX86_MMXTy
bool isX86_MMXTy() const
Return true if this is X86 MMX.
Definition: Type.h:201
llvm::Type::getScalarTy
static Type * getScalarTy(LLVMContext &C)
Definition: Type.h:470
llvm::Type::getFP128Ty
static Type * getFP128Ty(LLVMContext &C)
Definition: Type.cpp:233
llvm::Type::isPointerTy
bool isPointerTy() const
True if this is an instance of PointerType.
Definition: Type.h:249
llvm::Type::VoidTyID
@ VoidTyID
type with no size
Definition: Type.h:63
llvm::Type::getTargetExtName
StringRef getTargetExtName() const
Definition: DerivedTypes.h:806
llvm::Type::getScalarType
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition: Type.h:341
TypeSize.h
llvm::Type::getFltSemantics
const fltSemantics & getFltSemantics() const
Definition: Type.cpp:66
ErrorHandling.h
llvm::Type::getPointerAddressSpace
unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
Definition: DerivedTypes.h:729
llvm::Type::X86_AMXTyID
@ X86_AMXTyID
AMX vectors (8192 bits, X86 specific)
Definition: Type.h:67
llvm::Type::getSubclassData
unsigned getSubclassData() const
Definition: Type.h:98
llvm::Type::getTypeID
TypeID getTypeID() const
Return the type id for the type.
Definition: Type.h:137
llvm::Type::isFPOrFPVectorTy
bool isFPOrFPVectorTy() const
Return true if this is a FP type or a vector of FP.
Definition: Type.h:210
llvm::Type
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
llvm::Type::getTokenTy
static Type * getTokenTy(LLVMContext &C)
Definition: Type.cpp:231
T
#define T
Definition: Mips16ISelLowering.cpp:341
llvm::Type::isX86_FP80Ty
bool isX86_FP80Ty() const
Return true if this is x86 long double.
Definition: Type.h:160
CBindingWrapping.h
llvm::Type::getPrimitiveType
static Type * getPrimitiveType(LLVMContext &C, TypeID IDNumber)
Return a type based on an identifier.
Definition: Type.cpp:36
llvm::Type::subtype_begin
subtype_iterator subtype_begin() const
Definition: Type.h:352
llvm::Type::subtype_iterator
Type *const * subtype_iterator
Definition: Type.h:350
llvm::Type::isFloatingPointTy
bool isFloatingPointTy() const
Return true if this is one of the floating-point types.
Definition: Type.h:185
llvm::Type::getNonOpaquePointerElementType
Type * getNonOpaquePointerElementType() const
Only use this method in code that is not reachable with opaque pointers, or part of deprecated method...
Definition: Type.h:416
llvm::Type::getInt32PtrTy
static PointerType * getInt32PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:301
llvm::Type::isMetadataTy
bool isMetadataTy() const
Return true if this is 'metadata'.
Definition: Type.h:216
llvm::Type::getInt8Ty
static IntegerType * getInt8Ty(LLVMContext &C)
Definition: Type.cpp:239
llvm::Type::getInt32Ty
static IntegerType * getInt32Ty(LLVMContext &C)
Definition: Type.cpp:241
llvm::Type::getWithNewType
Type * getWithNewType(Type *EltTy) const
Given vector type, change the element type, whilst keeping the old number of elements.
Definition: DerivedTypes.h:716
llvm::Type::getBFloatPtrTy
static PointerType * getBFloatPtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:253
Context
LLVMContext & Context
Definition: NVVMIntrRange.cpp:66
llvm::Type::isMultiUnitFPType
bool isMultiUnitFPType() const
Returns true if this is a floating-point type that is an unevaluated sum of multiple floating-point u...
Definition: Type.h:194
llvm::Type::getMetadataTy
static Type * getMetadataTy(LLVMContext &C)
Definition: Type.cpp:230
llvm::Type::isArrayTy
bool isArrayTy() const
True if this is an instance of ArrayType.
Definition: Type.h:246
DEFINE_ISA_CONVERSION_FUNCTIONS
#define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref)
Definition: CBindingWrapping.h:28
llvm::Type::isSingleValueType
bool isSingleValueType() const
Return true if the type is a valid type for a register in codegen.
Definition: Type.h:280
llvm::Type::getFP128PtrTy
static PointerType * getFP128PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:269
llvm::Type::MetadataTyID
@ MetadataTyID
Metadata.
Definition: Type.h:65
llvm::Type::getX86_AMXTy
static Type * getX86_AMXTy(LLVMContext &C)
Definition: Type.cpp:236
llvm::Type::FunctionTyID
@ FunctionTyID
Functions.
Definition: Type.h:72
llvm::Type::getPPC_FP128Ty
static Type * getPPC_FP128Ty(LLVMContext &C)
Definition: Type.cpp:234
llvm::Type::getDoubleTy
static Type * getDoubleTy(LLVMContext &C)
Definition: Type.cpp:229
C
(vector float) vec_cmpeq(*A, *B) C
Definition: README_ALTIVEC.txt:86
llvm::LLVMContextImpl
Definition: LLVMContextImpl.h:1402
llvm::Type::print
void print(raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
Print the current type.
Definition: AsmWriter.cpp:4669
llvm::Type::getPPC_FP128PtrTy
static PointerType * getPPC_FP128PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:273
llvm::Type::getStructName
StringRef getStructName() const
Definition: DerivedTypes.h:344
llvm::Type::isTargetExtTy
bool isTargetExtTy() const
Return true if this is a target extension type.
Definition: Type.h:207
llvm::Type::isVectorTy
bool isVectorTy() const
True if this is an instance of VectorType.
Definition: Type.h:258
llvm::IntegerType
Class to represent integer types.
Definition: DerivedTypes.h:40
llvm::Type::isTokenTy
bool isTokenTy() const
Return true if this is 'token'.
Definition: Type.h:219
llvm::Type::getScalarSizeInBits
unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
Definition: Type.cpp:188
llvm::unwrap
Attribute unwrap(LLVMAttributeRef Attr)
Definition: Attributes.h:285
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
LLVMTypeRef
struct LLVMOpaqueType * LLVMTypeRef
Each value in the LLVM IR has a type, an LLVMTypeRef.
Definition: Types.h:68
llvm::operator<<
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
Definition: APFixedPoint.h:292
llvm::Type::PointerTyID
@ PointerTyID
Pointers.
Definition: Type.h:73
llvm::Type::subtype_rbegin
subtype_reverse_iterator subtype_rbegin() const
Definition: Type.h:360
llvm::Type::getInt1PtrTy
static PointerType * getInt1PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:289
llvm::Type::isFunctionTy
bool isFunctionTy() const
True if this is an instance of FunctionType.
Definition: Type.h:240
llvm::Type::BFloatTyID
@ BFloatTyID
16-bit floating point type (7-bit significand)
Definition: Type.h:57
llvm::Type::getIntegerBitWidth
unsigned getIntegerBitWidth() const
Definition: DerivedTypes.h:97
llvm::CallingConv::ID
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
llvm::Type::getStructNumElements
unsigned getStructNumElements() const
Definition: DerivedTypes.h:348
llvm::Type::getExtendedType
Type * getExtendedType() const
Given scalar/vector integer type, returns a type with elements twice as wide as in the original type.
Definition: DerivedTypes.h:706
llvm::Type::isIntegerTy
bool isIntegerTy() const
True if this is an instance of IntegerType.
Definition: Type.h:222
llvm::Type::getIntNPtrTy
static PointerType * getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS=0)
Definition: Type.cpp:285
llvm::Type::isIEEELikeFPTy
bool isIEEELikeFPTy() const
Return true if this is a well-behaved IEEE-like type, which has a IEEE compatible layout as defined b...
Definition: Type.h:171
llvm::Type::subtypes
ArrayRef< Type * > subtypes() const
Definition: Type.h:354
llvm::Type::getArrayElementType
Type * getArrayElementType() const
Definition: Type.h:397
TypeID
Type::TypeID TypeID
Definition: Mips16HardFloat.cpp:103
val
The initial backend is deliberately restricted to z10 We should add support for later architectures at some point If an asm ties an i32 r result to an i64 the input will be treated as an leaving the upper bits uninitialised For i64 store i32 val
Definition: README.txt:15
llvm::Type::getFPMantissaWidth
int getFPMantissaWidth() const
Return the width of the mantissa of this type.
Definition: Type.cpp:193
llvm::RISCVFenceField::O
@ O
Definition: RISCVBaseInfo.h:274
uint64_t
llvm::Type::getWithNewBitWidth
Type * getWithNewBitWidth(unsigned NewBitWidth) const
Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old numb...
Definition: DerivedTypes.h:722
llvm::Type::X86_MMXTyID
@ X86_MMXTyID
MMX vectors (64 bits, X86 specific)
Definition: Type.h:66
const
aarch64 promote const
Definition: AArch64PromoteConstant.cpp:232
llvm::Type::getHalfPtrTy
static PointerType * getHalfPtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:249
llvm::Type::isIntOrPtrTy
bool isIntOrPtrTy() const
Return true if this is an integer type or a pointer type.
Definition: Type.h:237
llvm::LLVMContext
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:67
llvm::Type::getInt64PtrTy
static PointerType * getInt64PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:305
llvm::Type::subtype_rend
subtype_reverse_iterator subtype_rend() const
Definition: Type.h:363
llvm::PointerType
Class to represent pointers.
Definition: DerivedTypes.h:632
ArrayRef.h
llvm::Type::isHalfTy
bool isHalfTy() const
Return true if this is 'half', a 16-bit IEEE fp type.
Definition: Type.h:143
inline
into xmm2 addss xmm2 xmm1 xmm3 addss xmm3 movaps xmm0 unpcklps xmm0 ret seems silly when it could just be one addps Expand libm rounding functions inline
Definition: README-SSE.txt:72
llvm::Type::getX86_MMXPtrTy
static PointerType * getX86_MMXPtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:277
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::Type::getArrayNumElements
uint64_t getArrayNumElements() const
Definition: DerivedTypes.h:384
llvm::Type::isVoidTy
bool isVoidTy() const
Return true if this is 'void'.
Definition: Type.h:140
llvm::Type::getX86_FP80Ty
static Type * getX86_FP80Ty(LLVMContext &C)
Definition: Type.cpp:232
llvm::Type::getDoublePtrTy
static PointerType * getDoublePtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:261
llvm::Type::is16bitFPTy
bool is16bitFPTy() const
Return true if this is a 16-bit float type.
Definition: Type.h:149
llvm::Type::FP128TyID
@ FP128TyID
128-bit floating point type (112-bit significand)
Definition: Type.h:61
llvm::wrap
LLVMAttributeRef wrap(Attribute Attr)
Definition: Attributes.h:280
llvm::Type::setSubclassData
void setSubclassData(unsigned val)
Definition: Type.h:100
llvm::Type::Type
Type(LLVMContext &C, TypeID tid)
Definition: Type.h:94
llvm::ArrayRef
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: APInt.h:33
llvm::Type::PPC_FP128TyID
@ PPC_FP128TyID
128-bit floating point type (two 64-bits, PowerPC)
Definition: Type.h:62
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
llvm::Type::getStructElementType
Type * getStructElementType(unsigned N) const
Definition: DerivedTypes.h:352
llvm_unreachable
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Definition: ErrorHandling.h:143
llvm::Type::getNumContainedTypes
unsigned getNumContainedTypes() const
Return the number of types in the derived type.
Definition: Type.h:376
Compiler.h
S
add sub stmia L5 ldr r0 bl L_printf $stub Instead of a and a wouldn t it be better to do three moves *Return an aggregate type is even return S
Definition: README.txt:210
llvm::Type::isLabelTy
bool isLabelTy() const
Return true if this is 'label'.
Definition: Type.h:213
llvm::Type::isPtrOrPtrVectorTy
bool isPtrOrPtrVectorTy() const
Return true if this is a pointer type or a vector of pointer types.
Definition: Type.h:255
llvm::Type::TypedPointerTyID
@ TypedPointerTyID
Typed pointer used by some GPU targets.
Definition: Type.h:78
llvm::Type::getContext
LLVMContext & getContext() const
Return the LLVMContext in which this type was uniqued.
Definition: Type.h:129
llvm::Type::getInt128Ty
static IntegerType * getInt128Ty(LLVMContext &C)
Definition: Type.cpp:243
llvm::Type::getFloatPtrTy
static PointerType * getFloatPtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:257
llvm::Type::IntegerTyID
@ IntegerTyID
Arbitrary bit width integers.
Definition: Type.h:71
llvm::Type::NumContainedTys
unsigned NumContainedTys
Keeps track of how many Type*'s there are in the ContainedTys list.
Definition: Type.h:107
llvm::Type::getInt64Ty
static IntegerType * getInt64Ty(LLVMContext &C)
Definition: Type.cpp:242
llvm::Type::getIntNTy
static IntegerType * getIntNTy(LLVMContext &C, unsigned N)
Definition: Type.cpp:245
llvm::Type::isFloatTy
bool isFloatTy() const
Return true if this is 'float', a 32-bit IEEE fp type.
Definition: Type.h:154
llvm::Type::getHalfTy
static Type * getHalfTy(LLVMContext &C)
Definition: Type.cpp:226
llvm::Type::FixedVectorTyID
@ FixedVectorTyID
Fixed width SIMD vector type.
Definition: Type.h:76
llvm::Type::isEmptyTy
bool isEmptyTy() const
Return true if this type is empty, that is, it has no elements or all of its elements are empty.
Definition: Type.cpp:146
llvm::Type::isIntOrIntVectorTy
bool isIntOrIntVectorTy() const
Return true if this is an integer type or a vector of integer types.
Definition: Type.h:228
llvm::TypeSize
Definition: TypeSize.h:314
Casting.h
llvm::fltSemantics
Definition: APFloat.cpp:71
llvm::BitWidth
constexpr unsigned BitWidth
Definition: BitmaskEnum.h:147
llvm::Type::isIEEE
bool isIEEE() const
Return whether the type is IEEE compatible, as defined by the eponymous method in APFloat.
Definition: Type.cpp:79
llvm::Type::getPointerTo
PointerType * getPointerTo(unsigned AddrSpace=0) const
Return a pointer to the current type.
Definition: Type.cpp:776
llvm::Type::TokenTyID
@ TokenTyID
Tokens.
Definition: Type.h:68
llvm::Type::isDoubleTy
bool isDoubleTy() const
Return true if this is 'double', a 64-bit IEEE fp type.
Definition: Type.h:157
llvm::Type::isPPC_FP128Ty
bool isPPC_FP128Ty() const
Return true if this is powerpc long double.
Definition: Type.h:166
llvm::Type::getBFloatTy
static Type * getBFloatTy(LLVMContext &C)
Definition: Type.cpp:227
llvm::Type::dump
void dump() const
Definition: AsmWriter.cpp:4942
llvm::Type::ContainedTys
Type *const * ContainedTys
A pointer to the array of Types contained by this Type.
Definition: Type.h:114
llvm::Type::getX86_FP80PtrTy
static PointerType * getX86_FP80PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:265
llvm::Type::LabelTyID
@ LabelTyID
Labels.
Definition: Type.h:64
llvm::Type::getVoidTy
static Type * getVoidTy(LLVMContext &C)
Definition: Type.cpp:224
llvm::Type::StructTyID
@ StructTyID
Structures.
Definition: Type.h:74
llvm::Type::isOpaquePointerTy
bool isOpaquePointerTy() const
True if this is an instance of an opaque PointerType.
Definition: Type.cpp:60
llvm::Type::isStructTy
bool isStructTy() const
True if this is an instance of StructType.
Definition: Type.h:243
llvm::isa_impl< PointerType, Type >::doit
static bool doit(const Type &Ty)
Definition: Type.h:526
llvm::Type::isBFloatTy
bool isBFloatTy() const
Return true if this is 'bfloat', a 16-bit bfloat type.
Definition: Type.h:146
llvm::Type::isIntOrIntVectorTy
bool isIntOrIntVectorTy(unsigned BitWidth) const
Return true if this is an integer type or a vector of integer types of the given width.
Definition: Type.h:232
llvm::Type::~Type
~Type()=default
llvm::Type::getPointerElementType
Type * getPointerElementType() const
This method is deprecated without replacement.
Definition: Type.h:409
N
#define N
llvm::Type::subtype_reverse_iterator
std::reverse_iterator< subtype_iterator > subtype_reverse_iterator
Definition: Type.h:358
llvm::Type::getInt16Ty
static IntegerType * getInt16Ty(LLVMContext &C)
Definition: Type.cpp:240
llvm::Type::ScalableVectorTyID
@ ScalableVectorTyID
Scalable SIMD vector type.
Definition: Type.h:77
llvm::ArrayRef
ArrayRef(const T &OneElt) -> ArrayRef< T >
llvm::SmallPtrSetImpl
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:344
llvm::Type::getLabelTy
static Type * getLabelTy(LLVMContext &C)
Definition: Type.cpp:225
llvm::Type::isAggregateType
bool isAggregateType() const
Return true if the type is an aggregate type.
Definition: Type.h:288
llvm::Type::TypeID
TypeID
Definitions of all of the base types for the Type system.
Definition: Type.h:54
llvm::Type::getX86_MMXTy
static Type * getX86_MMXTy(LLVMContext &C)
Definition: Type.cpp:235
llvm::Type::getFunctionParamType
Type * getFunctionParamType(unsigned i) const
Definition: DerivedTypes.h:153
llvm::Type::canLosslesslyBitCastTo
bool canLosslesslyBitCastTo(Type *Ty) const
Return true if this type could be converted with a lossless BitCast to type 'Ty'.
Definition: Type.cpp:104
llvm::Type::TargetExtTyID
@ TargetExtTyID
Target extension type.
Definition: Type.h:79
llvm::Type::getContainedType
Type * getContainedType(unsigned i) const
This method is used to implement the type iterator (defined at the end of the file).
Definition: Type.h:370
llvm::Type::isFP128Ty
bool isFP128Ty() const
Return true if this is 'fp128'.
Definition: Type.h:163
llvm::Type::getX86_AMXPtrTy
static PointerType * getX86_AMXPtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:281
llvm::Type::HalfTyID
@ HalfTyID
16-bit floating point type
Definition: Type.h:56
llvm::Type::X86_FP80TyID
@ X86_FP80TyID
80-bit floating point type (X87)
Definition: Type.h:60
llvm::isa_impl
Definition: Casting.h:63
llvm::Type::getFloatTy
static Type * getFloatTy(LLVMContext &C)
Definition: Type.cpp:228
llvm::Type::getFloatingPointTy
static Type * getFloatingPointTy(LLVMContext &C, const fltSemantics &S)
Definition: Type.cpp:83
llvm::Type::isX86_AMXTy
bool isX86_AMXTy() const
Return true if this is X86 AMX.
Definition: Type.h:204
llvm::Type::isFirstClassType
bool isFirstClassType() const
Return true if the type is "first class", meaning it is a valid type for a Value.
Definition: Type.h:274
llvm::Type::getPrimitiveSizeInBits
TypeSize getPrimitiveSizeInBits() const LLVM_READONLY
Return the basic size of this type if it is a primitive type.
Definition: Type.cpp:163