DerivedTypes.h

Go to the documentation of this file.

//===- llvm/DerivedTypes.h - Classes for handling data types ----*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file contains the declarations of classes that represent "derived
// types". These are things like "arrays of x" or "structure of x, y, z" or
// "function returning x taking (y,z) as parameters", etc...
//
// The implementations of these classes live in the Type.cpp file.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_IR_DERIVEDTYPES_H
#define LLVM_IR_DERIVEDTYPES_H

#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/IR/Type.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/TypeSize.h"
#include <cassert>
#include <cstdint>

namespace llvm {

class Value;
class APInt;
class LLVMContext;
template <typename T> class Expected;
class Error;

/// Class to represent integer types. Note that this class is also used to
/// represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and
/// Int64Ty.
/// Integer representation type
class IntegerType : publicType {
friendclass LLVMContextImpl;

protected:
explicitIntegerType(LLVMContext &C, unsigned NumBits) : Type(C, IntegerTyID){
setSubclassData(NumBits);
 }

public:
 /// This enum is just used to hold constants we need for IntegerType.
enum {
MIN_INT_BITS = 1, ///< Minimum number of bits that can be specified
MAX_INT_BITS = (1<<23) ///< Maximum number of bits that can be specified
 ///< Note that bit width is stored in the Type classes SubclassData field
 ///< which has 24 bits. SelectionDAG type legalization can require a
 ///< power of 2 IntegerType, so limit to the largest representable power
 ///< of 2, 8388608.
 };

 /// This static method is the primary way of constructing an IntegerType.
 /// If an IntegerType with the same NumBits value was previously instantiated,
 /// that instance will be returned. Otherwise a new one will be created. Only
 /// one instance with a given NumBits value is ever created.
 /// Get or create an IntegerType instance.
staticIntegerType *get(LLVMContext &C, unsigned NumBits);

 /// Returns type twice as wide the input type.
IntegerType *getExtendedType() const {
returnType::getIntNTy(getContext(), 2 * getScalarSizeInBits());
 }

 /// Get the number of bits in this IntegerType
unsignedgetBitWidth() const { returngetSubclassData(); }

 /// Return a bitmask with ones set for all of the bits that can be set by an
 /// unsigned version of this type. This is 0xFF for i8, 0xFFFF for i16, etc.
uint64_tgetBitMask() const {
return~uint64_t(0UL) >> (64-getBitWidth());
 }

 /// Return a uint64_t with just the most significant bit set (the sign bit, if
 /// the value is treated as a signed number).
uint64_tgetSignBit() const {
return 1ULL << (getBitWidth()-1);
 }

 /// For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.
 /// @returns a bit mask with ones set for all the bits of this type.
 /// Get a bit mask for this type.
APIntgetMask() const;

 /// Methods for support type inquiry through isa, cast, and dyn_cast.
staticboolclassof(constType *T) {
returnT->getTypeID() == IntegerTyID;
 }
};

unsignedType::getIntegerBitWidth() const {
return cast<IntegerType>(this)->getBitWidth();
}

/// Class to represent function types
///
class FunctionType : publicType {
FunctionType(Type *Result, ArrayRef<Type*> Params, bool IsVarArgs);

public:
FunctionType(constFunctionType &) = delete;
FunctionType &operator=(constFunctionType &) = delete;

 /// This static method is the primary way of constructing a FunctionType.
staticFunctionType *get(Type *Result,
ArrayRef<Type*> Params, boolisVarArg);

 /// Create a FunctionType taking no parameters.
staticFunctionType *get(Type *Result, boolisVarArg);

 /// Return true if the specified type is valid as a return type.
staticboolisValidReturnType(Type *RetTy);

 /// Return true if the specified type is valid as an argument type.
staticboolisValidArgumentType(Type *ArgTy);

boolisVarArg() const { returngetSubclassData()!=0; }
Type *getReturnType() const { returnContainedTys[0]; }

using param_iterator = Type::subtype_iterator;

param_iteratorparam_begin() const { returnContainedTys + 1; }
param_iteratorparam_end() const { return &ContainedTys[NumContainedTys]; }
ArrayRef<Type *>params() const {
returnArrayRef(param_begin(), param_end());
 }

 /// Parameter type accessors.
Type *getParamType(unsigned i) const {
assert(i < getNumParams() && "getParamType() out of range!");
returnContainedTys[i + 1];
 }

 /// Return the number of fixed parameters this function type requires.
 /// This does not consider varargs.
unsignedgetNumParams() const { returnNumContainedTys - 1; }

 /// Methods for support type inquiry through isa, cast, and dyn_cast.
staticboolclassof(constType *T) {
returnT->getTypeID() == FunctionTyID;
 }
};
static_assert(alignof(FunctionType) >= alignof(Type *),
"Alignment sufficient for objects appended to FunctionType");

boolType::isFunctionVarArg() const {
return cast<FunctionType>(this)->isVarArg();
}

Type *Type::getFunctionParamType(unsigned i) const {
return cast<FunctionType>(this)->getParamType(i);
}

unsignedType::getFunctionNumParams() const {
return cast<FunctionType>(this)->getNumParams();
}

/// A handy container for a FunctionType+Callee-pointer pair, which can be
/// passed around as a single entity. This assists in replacing the use of
/// PointerType::getElementType() to access the function's type, since that's
/// slated for removal as part of the [opaque pointer types] project.
class FunctionCallee {
public:
// Allow implicit conversion from types which have a getFunctionType member
// (e.g. Function and InlineAsm).
template <typename T, typename U = decltype(&T::getFunctionType)>
FunctionCallee(T *Fn)
 : FnTy(Fn ? Fn->getFunctionType() : nullptr), Callee(Fn) {}

FunctionCallee(FunctionType *FnTy, Value *Callee)
 : FnTy(FnTy), Callee(Callee) {
assert((FnTy == nullptr) == (Callee == nullptr));
 }

FunctionCallee(std::nullptr_t) {}

FunctionCallee() = default;

FunctionType *getFunctionType() { return FnTy; }

Value *getCallee() { return Callee; }

explicitoperatorbool() { return Callee; }

private:
FunctionType *FnTy = nullptr;
Value *Callee = nullptr;
};

/// Class to represent struct types. There are two different kinds of struct
/// types: Literal structs and Identified structs.
///
/// Literal struct types (e.g. { i32, i32 }) are uniqued structurally, and must
/// always have a body when created. You can get one of these by using one of
/// the StructType::get() forms.
///
/// Identified structs (e.g. %foo or %42) may optionally have a name and are not
/// uniqued. The names for identified structs are managed at the LLVMContext
/// level, so there can only be a single identified struct with a given name in
/// a particular LLVMContext. Identified structs may also optionally be opaque
/// (have no body specified). You get one of these by using one of the
/// StructType::create() forms.
///
/// Independent of what kind of struct you have, the body of a struct type are
/// laid out in memory consecutively with the elements directly one after the
/// other (if the struct is packed) or (if not packed) with padding between the
/// elements as defined by DataLayout (which is required to match what the code
/// generator for a target expects).
///
class StructType : publicType {
StructType(LLVMContext &C) : Type(C, StructTyID) {}

enum {
 /// This is the contents of the SubClassData field.
 SCDB_HasBody = 1,
 SCDB_Packed = 2,
 SCDB_IsLiteral = 4,
 SCDB_IsSized = 8,
 SCDB_ContainsScalableVector = 16,
 SCDB_NotContainsScalableVector = 32,
 SCDB_ContainsNonGlobalTargetExtType = 64,
 SCDB_NotContainsNonGlobalTargetExtType = 128,
 SCDB_ContainsNonLocalTargetExtType = 64,
 SCDB_NotContainsNonLocalTargetExtType = 128,
 };

 /// For a named struct that actually has a name, this is a pointer to the
 /// symbol table entry (maintained by LLVMContext) for the struct.
 /// This is null if the type is an literal struct or if it is a identified
 /// type that has an empty name.
void *SymbolTableEntry = nullptr;

public:
StructType(constStructType &) = delete;
StructType &operator=(constStructType &) = delete;

 /// This creates an identified struct.
staticStructType *create(LLVMContext &Context, StringRefName);
staticStructType *create(LLVMContext &Context);

staticStructType *create(ArrayRef<Type *> Elements, StringRefName,
boolisPacked = false);
staticStructType *create(ArrayRef<Type *> Elements);
staticStructType *create(LLVMContext &Context, ArrayRef<Type *> Elements,
StringRefName, boolisPacked = false);
staticStructType *create(LLVMContext &Context, ArrayRef<Type *> Elements);
template <class... Tys>
static std::enable_if_t<are_base_of<Type, Tys...>::value, StructType *>
create(StringRefName, Type *elt1, Tys *... elts) {
assert(elt1 && "Cannot create a struct type with no elements with this");
returncreate(ArrayRef<Type *>({elt1, elts...}), Name);
 }

 /// This static method is the primary way to create a literal StructType.
staticStructType *get(LLVMContext &Context, ArrayRef<Type*> Elements,
boolisPacked = false);

 /// Create an empty structure type.
staticStructType *get(LLVMContext &Context, boolisPacked = false);

 /// This static method is a convenience method for creating structure types by
 /// specifying the elements as arguments. Note that this method always returns
 /// a non-packed struct, and requires at least one element type.
template <class... Tys>
static std::enable_if_t<are_base_of<Type, Tys...>::value, StructType *>
get(Type *elt1, Tys *... elts) {
assert(elt1 && "Cannot create a struct type with no elements with this");
LLVMContext &Ctx = elt1->getContext();
returnStructType::get(Ctx, ArrayRef<Type *>({elt1, elts...}));
 }

 /// Return the type with the specified name, or null if there is none by that
 /// name.
staticStructType *getTypeByName(LLVMContext &C, StringRefName);

boolisPacked() const { return (getSubclassData() & SCDB_Packed) != 0; }

 /// Return true if this type is uniqued by structural equivalence, false if it
 /// is a struct definition.
boolisLiteral() const { return (getSubclassData() & SCDB_IsLiteral) != 0; }

 /// Return true if this is a type with an identity that has no body specified
 /// yet. These prints as 'opaque' in .ll files.
boolisOpaque() const { return (getSubclassData() & SCDB_HasBody) == 0; }

 /// isSized - Return true if this is a sized type.
boolisSized(SmallPtrSetImpl<Type *> *Visited = nullptr) const;

 /// Returns true if this struct contains a scalable vector.
boolisScalableTy(SmallPtrSetImpl<const Type *> &Visited) const;
using Type::isScalableTy;

 /// Return true if this type is or contains a target extension type that
 /// disallows being used as a global.
bool
containsNonGlobalTargetExtType(SmallPtrSetImpl<const Type *> &Visited) const;
using Type::containsNonGlobalTargetExtType;

 /// Return true if this type is or contains a target extension type that
 /// disallows being used as a local.
bool
containsNonLocalTargetExtType(SmallPtrSetImpl<const Type *> &Visited) const;
using Type::containsNonLocalTargetExtType;

 /// Returns true if this struct contains homogeneous scalable vector types.
 /// Note that the definition of homogeneous scalable vector type is not
 /// recursive here. That means the following structure will return false
 /// when calling this function.
 /// {{<vscale x 2 x i32>, <vscale x 4 x i64>},
 /// {<vscale x 2 x i32>, <vscale x 4 x i64>}}
boolcontainsHomogeneousScalableVectorTypes() const;

 /// Return true if this struct is non-empty and all element types are the
 /// same.
boolcontainsHomogeneousTypes() const;

 /// Return true if this is a named struct that has a non-empty name.
boolhasName() const { returnSymbolTableEntry != nullptr; }

 /// Return the name for this struct type if it has an identity.
 /// This may return an empty string for an unnamed struct type. Do not call
 /// this on an literal type.
StringRefgetName() const;

 /// Change the name of this type to the specified name, or to a name with a
 /// suffix if there is a collision. Do not call this on an literal type.
voidsetName(StringRefName);

 /// Specify a body for an opaque identified type, which must not make the type
 /// recursive.
voidsetBody(ArrayRef<Type*> Elements, boolisPacked = false);

 /// Specify a body for an opaque identified type or return an error if it
 /// would make the type recursive.
ErrorsetBodyOrError(ArrayRef<Type *> Elements, boolisPacked = false);

 /// Return an error if the body for an opaque identified type would make it
 /// recursive.
ErrorcheckBody(ArrayRef<Type *> Elements);

 /// Return true if the specified type is valid as a element type.
staticboolisValidElementType(Type *ElemTy);

// Iterator access to the elements.
using element_iterator = Type::subtype_iterator;

element_iteratorelement_begin() const { returnContainedTys; }
element_iteratorelement_end() const { return &ContainedTys[NumContainedTys];}
ArrayRef<Type *>elements() const {
returnArrayRef(element_begin(), element_end());
 }

 /// Return true if this is layout identical to the specified struct.
boolisLayoutIdentical(StructType *Other) const;

 /// Random access to the elements
unsignedgetNumElements() const { returnNumContainedTys; }
Type *getElementType(unsignedN) const {
assert(N < NumContainedTys && "Element number out of range!");
returnContainedTys[N];
 }
 /// Given an index value into the type, return the type of the element.
Type *getTypeAtIndex(constValue *V) const;
Type *getTypeAtIndex(unsignedN) const { returngetElementType(N); }
boolindexValid(constValue *V) const;
boolindexValid(unsignedIdx) const { returnIdx < getNumElements(); }

 /// Methods for support type inquiry through isa, cast, and dyn_cast.
staticboolclassof(constType *T) {
returnT->getTypeID() == StructTyID;
 }
};

StringRef Type::getStructName() const {
return cast<StructType>(this)->getName();
}

unsignedType::getStructNumElements() const {
return cast<StructType>(this)->getNumElements();
}

Type *Type::getStructElementType(unsignedN) const {
return cast<StructType>(this)->getElementType(N);
}

/// Class to represent array types.
class ArrayType : publicType {
 /// The element type of the array.
Type *ContainedType;
 /// Number of elements in the array.
uint64_t NumElements;

ArrayType(Type *ElType, uint64_t NumEl);

public:
ArrayType(constArrayType &) = delete;
ArrayType &operator=(constArrayType &) = delete;

uint64_tgetNumElements() const { return NumElements; }
Type *getElementType() const { return ContainedType; }

 /// This static method is the primary way to construct an ArrayType
staticArrayType *get(Type *ElementType, uint64_t NumElements);

 /// Return true if the specified type is valid as a element type.
staticboolisValidElementType(Type *ElemTy);

 /// Methods for support type inquiry through isa, cast, and dyn_cast.
staticboolclassof(constType *T) {
returnT->getTypeID() == ArrayTyID;
 }
};

uint64_tType::getArrayNumElements() const {
return cast<ArrayType>(this)->getNumElements();
}

/// Base class of all SIMD vector types
class VectorType : publicType {
 /// A fully specified VectorType is of the form <vscale x n x Ty>. 'n' is the
 /// minimum number of elements of type Ty contained within the vector, and
 /// 'vscale x' indicates that the total element count is an integer multiple
 /// of 'n', where the multiple is either guaranteed to be one, or is
 /// statically unknown at compile time.
 ///
 /// If the multiple is known to be 1, then the extra term is discarded in
 /// textual IR:
 ///
 /// <4 x i32> - a vector containing 4 i32s
 /// <vscale x 4 x i32> - a vector containing an unknown integer multiple
 /// of 4 i32s

 /// The element type of the vector.
Type *ContainedType;

protected:
 /// The element quantity of this vector. The meaning of this value depends
 /// on the type of vector:
 /// - For FixedVectorType = <ElementQuantity x ty>, there are
 /// exactly ElementQuantity elements in this vector.
 /// - For ScalableVectorType = <vscale x ElementQuantity x ty>,
 /// there are vscale * ElementQuantity elements in this vector, where
 /// vscale is a runtime-constant integer greater than 0.
constunsignedElementQuantity;

VectorType(Type *ElType, unsignedEQ, Type::TypeID TID);

public:
VectorType(constVectorType &) = delete;
VectorType &operator=(constVectorType &) = delete;

Type *getElementType() const { return ContainedType; }

 /// This static method is the primary way to construct an VectorType.
staticVectorType *get(Type *ElementType, ElementCount EC);

staticVectorType *get(Type *ElementType, unsigned NumElements,
bool Scalable) {
returnVectorType::get(ElementType,
ElementCount::get(NumElements, Scalable));
 }

staticVectorType *get(Type *ElementType, constVectorType *Other) {
returnVectorType::get(ElementType, Other->getElementCount());
 }

 /// This static method gets a VectorType with the same number of elements as
 /// the input type, and the element type is an integer type of the same width
 /// as the input element type.
staticVectorType *getInteger(VectorType *VTy) {
unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
assert(EltBits && "Element size must be of a non-zero size");
Type *EltTy = IntegerType::get(VTy->getContext(), EltBits);
returnVectorType::get(EltTy, VTy->getElementCount());
 }

 /// This static method is like getInteger except that the element types are
 /// twice as wide as the elements in the input type.
staticVectorType *getExtendedElementVectorType(VectorType *VTy) {
assert(VTy->isIntOrIntVectorTy() && "VTy expected to be a vector of ints.");
auto *EltTy = cast<IntegerType>(VTy->getElementType());
returnVectorType::get(EltTy->getExtendedType(), VTy->getElementCount());
 }

// This static method gets a VectorType with the same number of elements as
// the input type, and the element type is an integer or float type which
// is half as wide as the elements in the input type.
staticVectorType *getTruncatedElementVectorType(VectorType *VTy) {
Type *EltTy;
if (VTy->getElementType()->isFloatingPointTy()) {
switch(VTy->getElementType()->getTypeID()) {
caseDoubleTyID:
 EltTy = Type::getFloatTy(VTy->getContext());
break;
caseFloatTyID:
 EltTy = Type::getHalfTy(VTy->getContext());
break;
default:
llvm_unreachable("Cannot create narrower fp vector element type");
 }
 } else {
unsigned EltBits = VTy->getElementType()->getPrimitiveSizeInBits();
assert((EltBits & 1) == 0 &&
"Cannot truncate vector element with odd bit-width");
 EltTy = IntegerType::get(VTy->getContext(), EltBits / 2);
 }
returnVectorType::get(EltTy, VTy->getElementCount());
 }

// This static method returns a VectorType with a larger number of elements
// of a smaller type than the input element type. For example, a <4 x i64>
// subdivided twice would return <16 x i16>
staticVectorType *getSubdividedVectorType(VectorType *VTy, int NumSubdivs) {
for (int i = 0; i < NumSubdivs; ++i) {
 VTy = VectorType::getDoubleElementsVectorType(VTy);
 VTy = VectorType::getTruncatedElementVectorType(VTy);
 }
return VTy;
 }

 /// This static method returns a VectorType with half as many elements as the
 /// input type and the same element type.
staticVectorType *getHalfElementsVectorType(VectorType *VTy) {
auto EltCnt = VTy->getElementCount();
assert(EltCnt.isKnownEven() &&
"Cannot halve vector with odd number of elements.");
returnVectorType::get(VTy->getElementType(),
 EltCnt.divideCoefficientBy(2));
 }

 /// This static method returns a VectorType with twice as many elements as the
 /// input type and the same element type.
staticVectorType *getDoubleElementsVectorType(VectorType *VTy) {
auto EltCnt = VTy->getElementCount();
assert((EltCnt.getKnownMinValue() * 2ull) <= UINT_MAX &&
"Too many elements in vector");
returnVectorType::get(VTy->getElementType(), EltCnt * 2);
 }

 /// Return true if the specified type is valid as a element type.
staticboolisValidElementType(Type *ElemTy);

 /// Return an ElementCount instance to represent the (possibly scalable)
 /// number of elements in the vector.
inlineElementCountgetElementCount() const;

 /// Methods for support type inquiry through isa, cast, and dyn_cast.
staticboolclassof(constType *T) {
returnT->getTypeID() == FixedVectorTyID ||
T->getTypeID() == ScalableVectorTyID;
 }
};

/// Class to represent fixed width SIMD vectors
class FixedVectorType : publicVectorType {
protected:
FixedVectorType(Type *ElTy, unsigned NumElts)
 : VectorType(ElTy, NumElts, FixedVectorTyID) {}

public:
staticFixedVectorType *get(Type *ElementType, unsigned NumElts);

staticFixedVectorType *get(Type *ElementType, constFixedVectorType *FVTy) {
returnget(ElementType, FVTy->getNumElements());
 }

staticFixedVectorType *getInteger(FixedVectorType *VTy) {
return cast<FixedVectorType>(VectorType::getInteger(VTy));
 }

staticFixedVectorType *getExtendedElementVectorType(FixedVectorType *VTy) {
return cast<FixedVectorType>(VectorType::getExtendedElementVectorType(VTy));
 }

staticFixedVectorType *getTruncatedElementVectorType(FixedVectorType *VTy) {
return cast<FixedVectorType>(
VectorType::getTruncatedElementVectorType(VTy));
 }

staticFixedVectorType *getSubdividedVectorType(FixedVectorType *VTy,
int NumSubdivs) {
return cast<FixedVectorType>(
VectorType::getSubdividedVectorType(VTy, NumSubdivs));
 }

staticFixedVectorType *getHalfElementsVectorType(FixedVectorType *VTy) {
return cast<FixedVectorType>(VectorType::getHalfElementsVectorType(VTy));
 }

staticFixedVectorType *getDoubleElementsVectorType(FixedVectorType *VTy) {
return cast<FixedVectorType>(VectorType::getDoubleElementsVectorType(VTy));
 }

staticboolclassof(constType *T) {
returnT->getTypeID() == FixedVectorTyID;
 }

unsignedgetNumElements() const { returnElementQuantity; }
};

/// Class to represent scalable SIMD vectors
class ScalableVectorType : publicVectorType {
protected:
ScalableVectorType(Type *ElTy, unsigned MinNumElts)
 : VectorType(ElTy, MinNumElts, ScalableVectorTyID) {}

public:
staticScalableVectorType *get(Type *ElementType, unsigned MinNumElts);

staticScalableVectorType *get(Type *ElementType,
constScalableVectorType *SVTy) {
returnget(ElementType, SVTy->getMinNumElements());
 }

staticScalableVectorType *getInteger(ScalableVectorType *VTy) {
return cast<ScalableVectorType>(VectorType::getInteger(VTy));
 }

staticScalableVectorType *
getExtendedElementVectorType(ScalableVectorType *VTy) {
return cast<ScalableVectorType>(
VectorType::getExtendedElementVectorType(VTy));
 }

staticScalableVectorType *
getTruncatedElementVectorType(ScalableVectorType *VTy) {
return cast<ScalableVectorType>(
VectorType::getTruncatedElementVectorType(VTy));
 }

staticScalableVectorType *getSubdividedVectorType(ScalableVectorType *VTy,
int NumSubdivs) {
return cast<ScalableVectorType>(
VectorType::getSubdividedVectorType(VTy, NumSubdivs));
 }

staticScalableVectorType *
getHalfElementsVectorType(ScalableVectorType *VTy) {
return cast<ScalableVectorType>(VectorType::getHalfElementsVectorType(VTy));
 }

staticScalableVectorType *
getDoubleElementsVectorType(ScalableVectorType *VTy) {
return cast<ScalableVectorType>(
VectorType::getDoubleElementsVectorType(VTy));
 }

 /// Get the minimum number of elements in this vector. The actual number of
 /// elements in the vector is an integer multiple of this value.
unsignedgetMinNumElements() const { returnElementQuantity; }

staticboolclassof(constType *T) {
returnT->getTypeID() == ScalableVectorTyID;
 }
};

inlineElementCountVectorType::getElementCount() const {
returnElementCount::get(ElementQuantity, isa<ScalableVectorType>(this));
}

/// Class to represent pointers.
class PointerType : publicType {
explicitPointerType(LLVMContext &C, unsigned AddrSpace);

public:
PointerType(constPointerType &) = delete;
PointerType &operator=(constPointerType &) = delete;

 /// This constructs a pointer to an object of the specified type in a numbered
 /// address space.
staticPointerType *get(Type *ElementType, unsignedAddressSpace);
 /// This constructs an opaque pointer to an object in a numbered address
 /// space.
staticPointerType *get(LLVMContext &C, unsignedAddressSpace);

 /// This constructs a pointer to an object of the specified type in the
 /// default address space (address space zero).
staticPointerType *getUnqual(Type *ElementType) {
returnPointerType::get(ElementType, 0);
 }

 /// This constructs an opaque pointer to an object in the
 /// default address space (address space zero).
staticPointerType *getUnqual(LLVMContext &C) {
returnPointerType::get(C, 0);
 }

 /// Return true if the specified type is valid as a element type.
staticboolisValidElementType(Type *ElemTy);

 /// Return true if we can load or store from a pointer to this type.
staticboolisLoadableOrStorableType(Type *ElemTy);

 /// Return the address space of the Pointer type.
inlineunsignedgetAddressSpace() const { returngetSubclassData(); }

 /// Implement support type inquiry through isa, cast, and dyn_cast.
staticboolclassof(constType *T) {
returnT->getTypeID() == PointerTyID;
 }
};

Type *Type::getExtendedType() const {
assert(
isIntOrIntVectorTy() &&
"Original type expected to be a vector of integers or a scalar integer.");
if (auto *VTy = dyn_cast<VectorType>(this))
returnVectorType::getExtendedElementVectorType(
const_cast<VectorType *>(VTy));
return cast<IntegerType>(this)->getExtendedType();
}

Type *Type::getWithNewType(Type *EltTy) const {
if (auto *VTy = dyn_cast<VectorType>(this))
returnVectorType::get(EltTy, VTy->getElementCount());
return EltTy;
}

Type *Type::getWithNewBitWidth(unsigned NewBitWidth) const {
assert(
isIntOrIntVectorTy() &&
"Original type expected to be a vector of integers or a scalar integer.");
returngetWithNewType(getIntNTy(getContext(), NewBitWidth));
}

unsignedType::getPointerAddressSpace() const {
return cast<PointerType>(getScalarType())->getAddressSpace();
}

/// Class to represent target extensions types, which are generally
/// unintrospectable from target-independent optimizations.
///
/// Target extension types have a string name, and optionally have type and/or
/// integer parameters. The exact meaning of any parameters is dependent on the
/// target.
class TargetExtType : publicType {
TargetExtType(LLVMContext &C, StringRef Name, ArrayRef<Type *> Types,
ArrayRef<unsigned> Ints);

// These strings are ultimately owned by the context.
StringRef Name;
unsigned *IntParams;

public:
TargetExtType(constTargetExtType &) = delete;
TargetExtType &operator=(constTargetExtType &) = delete;

 /// Return a target extension type having the specified name and optional
 /// type and integer parameters.
staticTargetExtType *get(LLVMContext &Context, StringRef Name,
ArrayRef<Type *> Types = {},
ArrayRef<unsigned> Ints = {});

 /// Return a target extension type having the specified name and optional
 /// type and integer parameters, or an appropriate Error if it fails the
 /// parameters check.
static Expected<TargetExtType *> getOrError(LLVMContext &Context,
 StringRef Name,
 ArrayRef<Type *> Types = {},
 ArrayRef<unsigned> Ints = {});

 /// Check that a newly created target extension type has the expected number
 /// of type parameters and integer parameters, returning the type itself if OK
 /// or an appropriate Error if not.
static Expected<TargetExtType *> checkParams(TargetExtType *TTy);

 /// Return the name for this target extension type. Two distinct target
 /// extension types may have the same name if their type or integer parameters
 /// differ.
StringRefgetName() const { return Name; }

 /// Return the type parameters for this particular target extension type. If
 /// there are no parameters, an empty array is returned.
ArrayRef<Type *>type_params() const {
returnArrayRef(type_param_begin(), type_param_end());
 }

using type_param_iterator = Type::subtype_iterator;
type_param_iteratortype_param_begin() const { returnContainedTys; }
type_param_iteratortype_param_end() const {
return &ContainedTys[NumContainedTys];
 }

Type *getTypeParameter(unsigned i) const { returngetContainedType(i); }
unsignedgetNumTypeParameters() const { returngetNumContainedTypes(); }

 /// Return the integer parameters for this particular target extension type.
 /// If there are no parameters, an empty array is returned.
ArrayRef<unsigned>int_params() const {
returnArrayRef(IntParams, getNumIntParameters());
 }

unsignedgetIntParameter(unsigned i) const { return IntParams[i]; }
unsignedgetNumIntParameters() const { returngetSubclassData(); }

enumProperty {
 /// zeroinitializer is valid for this target extension type.
HasZeroInit = 1U << 0,
 /// This type may be used as the value type of a global variable.
CanBeGlobal = 1U << 1,
 /// This type may be allocated on the stack, either as the allocated type
 /// of an alloca instruction or as a byval function parameter.
CanBeLocal = 1U << 2,
 };

 /// Returns true if the target extension type contains the given property.
boolhasProperty(Property Prop) const;

 /// Returns an underlying layout type for the target extension type. This
 /// type can be used to query size and alignment information, if it is
 /// appropriate (although note that the layout type may also be void). It is
 /// not legal to bitcast between this type and the layout type, however.
Type *getLayoutType() const;

 /// Methods for support type inquiry through isa, cast, and dyn_cast.
staticboolclassof(constType *T) { returnT->getTypeID() == TargetExtTyID; }
};

StringRef Type::getTargetExtName() const {
return cast<TargetExtType>(this)->getName();
}

} // end namespace llvm

#endif // LLVM_IR_DERIVEDTYPES_H