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"
23#include <cassert>
24#include <cstdint>
25#include <iterator>
26
27namespace llvm {
28
29class IntegerType;
30struct fltSemantics;
31class LLVMContext;
32class PointerType;
33class raw_ostream;
34class StringRef;
35template <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///
45class Type {
46public:
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
82private:
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
91protected:
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
116public:
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
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.
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
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.
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
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
396
399 return ContainedTys[0];
400 }
401
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.
446
447 //===--------------------------------------------------------------------===//
448 // These are the builtin types that are always available.
449 //
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);
507
508 /// Return a pointer to the current type. This is equivalent to
509 /// PointerType::get(Foo, AddrSpace).
510 /// TODO: Remove this after opaque pointer transition is complete.
511 PointerType *getPointerTo(unsigned AddrSpace = 0) const;
512
513private:
514 /// Derived types like structures and arrays are sized iff all of the members
515 /// of the type are sized as well. Since asking for their size is relatively
516 /// uncommon, move this operation out-of-line.
517 bool isSizedDerivedType(SmallPtrSetImpl<Type*> *Visited = nullptr) const;
518};
519
520// Printing of types.
522 T.print(OS);
523 return OS;
524}
525
526// allow isa<PointerType>(x) to work without DerivedTypes.h included.
527template <> struct isa_impl<PointerType, Type> {
528 static inline bool doit(const Type &Ty) {
529 return Ty.getTypeID() == Type::PointerTyID;
530 }
531};
532
533// Create wrappers for C Binding types (see CBindingWrapping.h).
535
536/* Specialized opaque type conversions.
537 */
539 return reinterpret_cast<Type**>(Tys);
540}
541
542inline LLVMTypeRef *wrap(Type **Tys) {
543 return reinterpret_cast<LLVMTypeRef*>(const_cast<Type**>(Tys));
544}
545
546} // end namespace llvm
547
548#endif // LLVM_IR_TYPE_H
aarch64 promote const
always inline
#define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref)
#define LLVM_READONLY
Definition: Compiler.h:196
Type::TypeID TypeID
LLVMContext & Context
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
Class to represent integer types.
Definition: DerivedTypes.h:40
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:67
Class to represent pointers.
Definition: DerivedTypes.h:632
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:344
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
static PointerType * getInt32PtrTy(LLVMContext &C, unsigned AS=0)
~Type()=default
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
static PointerType * getFP128PtrTy(LLVMContext &C, unsigned AS=0)
static PointerType * getPPC_FP128PtrTy(LLVMContext &C, unsigned AS=0)
static Type * getHalfTy(LLVMContext &C)
unsigned getIntegerBitWidth() const
Type * getStructElementType(unsigned N) const
static Type * getDoubleTy(LLVMContext &C)
const fltSemantics & getFltSemantics() const
bool isVectorTy() const
True if this is an instance of VectorType.
Definition: Type.h:258
static Type * getFloatingPointTy(LLVMContext &C, const fltSemantics &S)
bool isX86_FP80Ty() const
Return true if this is x86 long double.
Definition: Type.h:160
static PointerType * getHalfPtrTy(LLVMContext &C, unsigned AS=0)
PointerType * getPointerTo(unsigned AddrSpace=0) const
Return a pointer to the current type.
bool isArrayTy() const
True if this is an instance of ArrayType.
Definition: Type.h:246
static PointerType * getInt1PtrTy(LLVMContext &C, unsigned AS=0)
static Type * getX86_FP80Ty(LLVMContext &C)
static PointerType * getX86_FP80PtrTy(LLVMContext &C, unsigned AS=0)
static PointerType * getX86_MMXPtrTy(LLVMContext &C, unsigned AS=0)
bool isLabelTy() const
Return true if this is 'label'.
Definition: Type.h:213
static Type * getBFloatTy(LLVMContext &C)
bool isIntOrIntVectorTy() const
Return true if this is an integer type or a vector of integer types.
Definition: Type.h:228
bool isPointerTy() const
True if this is an instance of PointerType.
Definition: Type.h:249
static PointerType * getBFloatPtrTy(LLVMContext &C, unsigned AS=0)
static IntegerType * getInt1Ty(LLVMContext &C)
Type * getArrayElementType() const
Definition: Type.h:397
bool isFloatTy() const
Return true if this is 'float', a 32-bit IEEE fp type.
Definition: Type.h:154
bool isEmptyTy() const
Return true if this type is empty, that is, it has no elements or all of its elements are empty.
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
void dump() const
bool isIntegerTy(unsigned Bitwidth) const
Return true if this is an IntegerType of the given width.
static Type * getX86_AMXTy(LLVMContext &C)
bool isBFloatTy() const
Return true if this is 'bfloat', a 16-bit bfloat type.
Definition: Type.h:146
static Type * getMetadataTy(LLVMContext &C)
StringRef getStructName() const
Type *const * subtype_iterator
Definition: Type.h:350
unsigned getStructNumElements() const
unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
uint64_t getArrayNumElements() const
TypeID
Definitions of all of the base types for the Type system.
Definition: Type.h:54
@ X86_MMXTyID
MMX vectors (64 bits, X86 specific)
Definition: Type.h:66
@ X86_AMXTyID
AMX vectors (8192 bits, X86 specific)
Definition: Type.h:67
@ FunctionTyID
Functions.
Definition: Type.h:72
@ ArrayTyID
Arrays.
Definition: Type.h:75
@ TypedPointerTyID
Typed pointer used by some GPU targets.
Definition: Type.h:78
@ HalfTyID
16-bit floating point type
Definition: Type.h:56
@ TargetExtTyID
Target extension type.
Definition: Type.h:79
@ VoidTyID
type with no size
Definition: Type.h:63
@ ScalableVectorTyID
Scalable SIMD vector type.
Definition: Type.h:77
@ LabelTyID
Labels.
Definition: Type.h:64
@ FloatTyID
32-bit floating point type
Definition: Type.h:58
@ StructTyID
Structures.
Definition: Type.h:74
@ IntegerTyID
Arbitrary bit width integers.
Definition: Type.h:71
@ FixedVectorTyID
Fixed width SIMD vector type.
Definition: Type.h:76
@ BFloatTyID
16-bit floating point type (7-bit significand)
Definition: Type.h:57
@ DoubleTyID
64-bit floating point type
Definition: Type.h:59
@ X86_FP80TyID
80-bit floating point type (X87)
Definition: Type.h:60
@ PPC_FP128TyID
128-bit floating point type (two 64-bits, PowerPC)
Definition: Type.h:62
@ MetadataTyID
Metadata.
Definition: Type.h:65
@ TokenTyID
Tokens.
Definition: Type.h:68
@ PointerTyID
Pointers.
Definition: Type.h:73
@ FP128TyID
128-bit floating point type (112-bit significand)
Definition: Type.h:61
ArrayRef< Type * > subtypes() const
Definition: Type.h:354
bool isSingleValueType() const
Return true if the type is a valid type for a register in codegen.
Definition: Type.h:280
bool isX86_MMXTy() const
Return true if this is X86 MMX.
Definition: Type.h:201
void print(raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
Print the current type.
unsigned getNumContainedTypes() const
Return the number of types in the derived type.
Definition: Type.h:376
bool isPPC_FP128Ty() const
Return true if this is powerpc long double.
Definition: Type.h:166
unsigned NumContainedTys
Keeps track of how many Type*'s there are in the ContainedTys list.
Definition: Type.h:107
static Type * getX86_MMXTy(LLVMContext &C)
static IntegerType * getIntNTy(LLVMContext &C, unsigned N)
bool isFP128Ty() const
Return true if this is 'fp128'.
Definition: Type.h:163
bool is16bitFPTy() const
Return true if this is a 16-bit float type.
Definition: Type.h:149
StringRef getTargetExtName() const
unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
static Type * getVoidTy(LLVMContext &C)
static Type * getLabelTy(LLVMContext &C)
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
Type(LLVMContext &C, TypeID tid)
Definition: Type.h:94
bool isStructTy() const
True if this is an instance of StructType.
Definition: Type.h:243
bool isFirstClassType() const
Return true if the type is "first class", meaning it is a valid type for a Value.
Definition: Type.h:274
static Type * getFP128Ty(LLVMContext &C)
Type * getWithNewBitWidth(unsigned NewBitWidth) const
Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old numb...
bool isTargetExtTy() const
Return true if this is a target extension type.
Definition: Type.h:207
bool isSized(SmallPtrSetImpl< Type * > *Visited=nullptr) const
Return true if it makes sense to take the size of this type.
Definition: Type.h:295
static IntegerType * getInt16Ty(LLVMContext &C)
bool isAggregateType() const
Return true if the type is an aggregate type.
Definition: Type.h:288
bool isHalfTy() const
Return true if this is 'half', a 16-bit IEEE fp type.
Definition: Type.h:143
Type * getWithNewType(Type *EltTy) const
Given vector type, change the element type, whilst keeping the old number of elements.
LLVMContext & getContext() const
Return the LLVMContext in which this type was uniqued.
Definition: Type.h:129
static Type * getPrimitiveType(LLVMContext &C, TypeID IDNumber)
Return a type based on an identifier.
int getFPMantissaWidth() const
Return the width of the mantissa of this type.
Type *const * ContainedTys
A pointer to the array of Types contained by this Type.
Definition: Type.h:114
unsigned getSubclassData() const
Definition: Type.h:98
static IntegerType * getInt8Ty(LLVMContext &C)
bool isIEEE() const
Return whether the type is IEEE compatible, as defined by the eponymous method in APFloat.
std::reverse_iterator< subtype_iterator > subtype_reverse_iterator
Definition: Type.h:358
Type * getPointerElementType() const
This method is deprecated without replacement.
Definition: Type.h:409
static IntegerType * getInt128Ty(LLVMContext &C)
bool isFunctionVarArg() const
static PointerType * getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS=0)
static PointerType * getX86_AMXPtrTy(LLVMContext &C, unsigned AS=0)
bool isDoubleTy() const
Return true if this is 'double', a 64-bit IEEE fp type.
Definition: Type.h:157
static PointerType * getDoublePtrTy(LLVMContext &C, unsigned AS=0)
void setSubclassData(unsigned val)
Definition: Type.h:100
static PointerType * getInt8PtrTy(LLVMContext &C, unsigned AS=0)
static Type * getTokenTy(LLVMContext &C)
bool isFloatingPointTy() const
Return true if this is one of the floating-point types.
Definition: Type.h:185
bool isPtrOrPtrVectorTy() const
Return true if this is a pointer type or a vector of pointer types.
Definition: Type.h:255
subtype_iterator subtype_begin() const
Definition: Type.h:352
bool isX86_AMXTy() const
Return true if this is X86 AMX.
Definition: Type.h:204
static Type * getScalarTy(LLVMContext &C)
Definition: Type.h:470
bool isFunctionTy() const
True if this is an instance of FunctionType.
Definition: Type.h:240
bool canLosslesslyBitCastTo(Type *Ty) const
Return true if this type could be converted with a lossless BitCast to type 'Ty'.
bool isIntOrPtrTy() const
Return true if this is an integer type or a pointer type.
Definition: Type.h:237
static IntegerType * getInt32Ty(LLVMContext &C)
static PointerType * getFloatPtrTy(LLVMContext &C, unsigned AS=0)
static IntegerType * getInt64Ty(LLVMContext &C)
Type * getExtendedType() const
Given scalar/vector integer type, returns a type with elements twice as wide as in the original type.
static Type * getFloatTy(LLVMContext &C)
bool isIntegerTy() const
True if this is an instance of IntegerType.
Definition: Type.h:222
TypeID getTypeID() const
Return the type id for the type.
Definition: Type.h:137
static Type * getWasm_FuncrefTy(LLVMContext &C)
bool isTokenTy() const
Return true if this is 'token'.
Definition: Type.h:219
Type * getFunctionParamType(unsigned i) const
subtype_reverse_iterator subtype_rend() const
Definition: Type.h:363
bool isFPOrFPVectorTy() const
Return true if this is a FP type or a vector of FP.
Definition: Type.h:210
TypeSize getPrimitiveSizeInBits() const LLVM_READONLY
Return the basic size of this type if it is a primitive type.
subtype_reverse_iterator subtype_rbegin() const
Definition: Type.h:360
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
subtype_iterator subtype_end() const
Definition: Type.h:353
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
static PointerType * getInt16PtrTy(LLVMContext &C, unsigned AS=0)
static PointerType * getInt64PtrTy(LLVMContext &C, unsigned AS=0)
static Type * getPPC_FP128Ty(LLVMContext &C)
bool isOpaquePointerTy() const
True if this is an instance of an opaque PointerType.
unsigned getFunctionNumParams() const
static Type * getWasm_ExternrefTy(LLVMContext &C)
bool isVoidTy() const
Return true if this is 'void'.
Definition: Type.h:140
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition: Type.h:341
bool isMetadataTy() const
Return true if this is 'metadata'.
Definition: Type.h:216
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
struct LLVMOpaqueType * LLVMTypeRef
Each value in the LLVM IR has a type, an LLVMTypeRef.
Definition: Types.h:68
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
Attribute unwrap(LLVMAttributeRef Attr)
Definition: Attributes.h:285
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
Definition: APFixedPoint.h:292
constexpr unsigned BitWidth
Definition: BitmaskEnum.h:147
LLVMAttributeRef wrap(Attribute Attr)
Definition: Attributes.h:280
#define N
static bool doit(const Type &Ty)
Definition: Type.h:528