LLVM  10.0.0svn
Public Member Functions | Static Public Member Functions | List of all members
llvm::PointerType Class Reference

Class to represent pointers. More...

#include "llvm/IR/DerivedTypes.h"

Inheritance diagram for llvm::PointerType:
Inheritance graph
Collaboration diagram for llvm::PointerType:
Collaboration graph

Public Member Functions

 PointerType (const PointerType &)=delete
PointerTypeoperator= (const PointerType &)=delete
TypegetElementType () const
unsigned getAddressSpace () const
 Return the address space of the Pointer type. More...
- Public Member Functions inherited from llvm::Type
void print (raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
 Print the current type. More...
void dump () const
LLVMContextgetContext () const
 Return the LLVMContext in which this type was uniqued. More...
TypeID getTypeID () const
 Return the type id for the type. More...
bool isVoidTy () const
 Return true if this is 'void'. More...
bool isHalfTy () const
 Return true if this is 'half', a 16-bit IEEE fp type. More...
bool isFloatTy () const
 Return true if this is 'float', a 32-bit IEEE fp type. More...
bool isDoubleTy () const
 Return true if this is 'double', a 64-bit IEEE fp type. More...
bool isX86_FP80Ty () const
 Return true if this is x86 long double. More...
bool isFP128Ty () const
 Return true if this is 'fp128'. More...
bool isPPC_FP128Ty () const
 Return true if this is powerpc long double. More...
bool isFloatingPointTy () const
 Return true if this is one of the six floating-point types. More...
const fltSemanticsgetFltSemantics () const
bool isX86_MMXTy () const
 Return true if this is X86 MMX. More...
bool isFPOrFPVectorTy () const
 Return true if this is a FP type or a vector of FP. More...
bool isLabelTy () const
 Return true if this is 'label'. More...
bool isMetadataTy () const
 Return true if this is 'metadata'. More...
bool isTokenTy () const
 Return true if this is 'token'. More...
bool isIntegerTy () const
 True if this is an instance of IntegerType. More...
bool isIntegerTy (unsigned Bitwidth) const
 Return true if this is an IntegerType of the given width. More...
bool isIntOrIntVectorTy () const
 Return true if this is an integer type or a vector of integer types. More...
bool isIntOrIntVectorTy (unsigned BitWidth) const
 Return true if this is an integer type or a vector of integer types of the given width. More...
bool isIntOrPtrTy () const
 Return true if this is an integer type or a pointer type. More...
bool isFunctionTy () const
 True if this is an instance of FunctionType. More...
bool isStructTy () const
 True if this is an instance of StructType. More...
bool isArrayTy () const
 True if this is an instance of ArrayType. More...
bool isPointerTy () const
 True if this is an instance of PointerType. More...
bool isPtrOrPtrVectorTy () const
 Return true if this is a pointer type or a vector of pointer types. More...
bool isVectorTy () const
 True if this is an instance of VectorType. More...
bool canLosslesslyBitCastTo (Type *Ty) const
 Return true if this type could be converted with a lossless BitCast to type 'Ty'. More...
bool isEmptyTy () const
 Return true if this type is empty, that is, it has no elements or all of its elements are empty. More...
bool isFirstClassType () const
 Return true if the type is "first class", meaning it is a valid type for a Value. More...
bool isSingleValueType () const
 Return true if the type is a valid type for a register in codegen. More...
bool isAggregateType () const
 Return true if the type is an aggregate type. More...
bool isSized (SmallPtrSetImpl< Type *> *Visited=nullptr) const
 Return true if it makes sense to take the size of this type. More...
TypeSize getPrimitiveSizeInBits () const LLVM_READONLY
 Return the basic size of this type if it is a primitive type. More...
unsigned getScalarSizeInBits () const LLVM_READONLY
 If this is a vector type, return the getPrimitiveSizeInBits value for the element type. More...
int getFPMantissaWidth () const
 Return the width of the mantissa of this type. More...
TypegetScalarType () const
 If this is a vector type, return the element type, otherwise return 'this'. More...
subtype_iterator subtype_begin () const
subtype_iterator subtype_end () const
ArrayRef< Type * > subtypes () const
subtype_reverse_iterator subtype_rbegin () const
subtype_reverse_iterator subtype_rend () const
TypegetContainedType (unsigned i) const
 This method is used to implement the type iterator (defined at the end of the file). More...
unsigned getNumContainedTypes () const
 Return the number of types in the derived type. More...
unsigned getIntegerBitWidth () const
TypegetFunctionParamType (unsigned i) const
unsigned getFunctionNumParams () const
bool isFunctionVarArg () const
StringRef getStructName () const
unsigned getStructNumElements () const
TypegetStructElementType (unsigned N) const
TypegetSequentialElementType () const
uint64_t getArrayNumElements () const
TypegetArrayElementType () const
bool getVectorIsScalable () const
unsigned getVectorNumElements () const
ElementCount getVectorElementCount () const
TypegetVectorElementType () const
TypegetPointerElementType () const
TypegetWithNewBitWidth (unsigned NewBitWidth) const
 Given an integer or vector type, change the lane bitwidth to NewBitwidth, whilst keeping the old number of lanes. More...
TypegetExtendedType () const
 Given scalar/vector integer type, returns a type with elements twice as wide as in the original type. More...
unsigned getPointerAddressSpace () const
 Get the address space of this pointer or pointer vector type. More...
PointerTypegetPointerTo (unsigned AddrSpace=0) const
 Return a pointer to the current type. More...

Static Public Member Functions

static PointerTypeget (Type *ElementType, unsigned AddressSpace)
 This constructs a pointer to an object of the specified type in a numbered address space. More...
static PointerTypegetUnqual (Type *ElementType)
 This constructs a pointer to an object of the specified type in the generic address space (address space zero). More...
static bool isValidElementType (Type *ElemTy)
 Return true if the specified type is valid as a element type. More...
static bool isLoadableOrStorableType (Type *ElemTy)
 Return true if we can load or store from a pointer to this type. More...
static bool classof (const Type *T)
 Implement support type inquiry through isa, cast, and dyn_cast. More...
- Static Public Member Functions inherited from llvm::Type
static TypegetPrimitiveType (LLVMContext &C, TypeID IDNumber)
 Return a type based on an identifier. More...
static TypegetVoidTy (LLVMContext &C)
static TypegetLabelTy (LLVMContext &C)
static TypegetHalfTy (LLVMContext &C)
static TypegetFloatTy (LLVMContext &C)
static TypegetDoubleTy (LLVMContext &C)
static TypegetMetadataTy (LLVMContext &C)
static TypegetX86_FP80Ty (LLVMContext &C)
static TypegetFP128Ty (LLVMContext &C)
static TypegetPPC_FP128Ty (LLVMContext &C)
static TypegetX86_MMXTy (LLVMContext &C)
static TypegetTokenTy (LLVMContext &C)
static IntegerTypegetIntNTy (LLVMContext &C, unsigned N)
static IntegerTypegetInt1Ty (LLVMContext &C)
static IntegerTypegetInt8Ty (LLVMContext &C)
static IntegerTypegetInt16Ty (LLVMContext &C)
static IntegerTypegetInt32Ty (LLVMContext &C)
static IntegerTypegetInt64Ty (LLVMContext &C)
static IntegerTypegetInt128Ty (LLVMContext &C)
template<typename ScalarTy >
static TypegetScalarTy (LLVMContext &C)
static PointerTypegetHalfPtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetFloatPtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetDoublePtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetX86_FP80PtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetFP128PtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetPPC_FP128PtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetX86_MMXPtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetIntNPtrTy (LLVMContext &C, unsigned N, unsigned AS=0)
static PointerTypegetInt1PtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetInt8PtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetInt16PtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetInt32PtrTy (LLVMContext &C, unsigned AS=0)
static PointerTypegetInt64PtrTy (LLVMContext &C, unsigned AS=0)

Additional Inherited Members

- Public Types inherited from llvm::Type
enum  TypeID {
  VoidTyID = 0, HalfTyID, FloatTyID, DoubleTyID,
  X86_FP80TyID, FP128TyID, PPC_FP128TyID, LabelTyID,
  MetadataTyID, X86_MMXTyID, TokenTyID, IntegerTyID,
  FunctionTyID, StructTyID, ArrayTyID, PointerTyID,
 Definitions of all of the base types for the Type system. More...
using subtype_iterator = Type *const *
using subtype_reverse_iterator = std::reverse_iterator< subtype_iterator >
- Protected Member Functions inherited from llvm::Type
 Type (LLVMContext &C, TypeID tid)
 ~Type ()=default
unsigned getSubclassData () const
void setSubclassData (unsigned val)
- Static Protected Member Functions inherited from llvm::Type
static bool isSequentialType (TypeID TyID)
- Protected Attributes inherited from llvm::Type
unsigned NumContainedTys = 0
 Keeps track of how many Type*'s there are in the ContainedTys list. More...
Type *constContainedTys = nullptr
 A pointer to the array of Types contained by this Type. More...

Detailed Description

Class to represent pointers.

Definition at line 579 of file DerivedTypes.h.

Constructor & Destructor Documentation

◆ PointerType()

llvm::PointerType::PointerType ( const PointerType )

Member Function Documentation

◆ classof()

static bool llvm::PointerType::classof ( const Type T)

Implement support type inquiry through isa, cast, and dyn_cast.

Definition at line 610 of file DerivedTypes.h.

References llvm::Type::getTypeID(), and llvm::Type::PointerTyID.

◆ get()

PointerType * PointerType::get ( Type ElementType,
unsigned  AddressSpace 

This constructs a pointer to an object of the specified type in a numbered address space.

Definition at line 637 of file Type.cpp.

References llvm::LLVMContextImpl::Alloc, llvm::LLVMContextImpl::ASPointerTypes, assert(), llvm::Type::getContext(), isValidElementType(), llvm::LLVMContext::pImpl, and llvm::LLVMContextImpl::PointerTypes.

Referenced by llvm::VNCoercion::analyzeLoadFromClobberingMemInst(), atomicSizeSupported(), buildPCRelGlobalAddress(), llvm::ConstantFoldGetElementPtr(), llvm::createAMDGPUPrintfRuntimeBinding(), llvm::orc::createIRTypedAddress(), llvm::createMemCpyLoopKnownSize(), llvm::createMemCpyLoopUnknownSize(), createMemSetLoop(), createPrivateNonConstGlobalForString(), DecodeFixedType(), llvm::SIFrameLowering::emitEntryFunctionPrologue(), FunctionNumber(), getAccessType(), llvm::ConstantExpr::getAddrSpaceCast(), GetCtorAndDtorPriority(), llvm::SelectionDAG::getEVTAlignment(), getFoldedAlignOf(), getFoldedSizeOf(), llvm::GetElementPtrInst::getGEPReturnType(), GetHeapSROAValue(), llvm::VNCoercion::getLoadValueForLoad(), llvm::VNCoercion::getMemInstValueForLoadHelper(), getMulHu(), getNegativeIsTrueBoolVec(), llvm::Module::getOrInsertFunction(), llvm::Module::getOrInsertGlobal(), getOrInsertGlobal(), llvm::Type::getPointerTo(), llvm::AMDGPULegalizerInfo::getSegmentAperture(), getUnqual(), llvm::SCEVExpander::hoistIVInc(), INITIALIZE_PASS(), instrumentMaskedLoadOrStore(), inversePermutation(), isCallPromotable(), isLoadInvariantInLoop(), llvm::SITargetLowering::isTypeDesirableForOp(), LLVMPointerType(), llvm::TargetLowering::LowerCallTo(), llvm::R600TargetLowering::LowerFormalArguments(), llvm::NVPTXTargetLowering::LowerFormalArguments(), llvm::AMDGPUCallLowering::lowerReturn(), llvm::RandomIRBuilder::newSink(), parseOptionalLinkageAux(), PerformHeapAllocSRoA(), performMaskedAtomicOp(), llvm::R600TargetLowering::ReplaceNodeResults(), llvm::SITargetLowering::shouldEmitPCReloc(), shouldFixMainFunction(), shouldKeepInEntry(), simplifyAllocaArraySize(), SimplifyGEPInst(), simplifyNeonVld1(), simplifyX86MaskedLoad(), simplifyX86MaskedStore(), TypeSizeToSizeIndex(), llvm::AMDGPULibCalls::useNative(), llvm::InstCombiner::visitAddrSpaceCast(), and llvm::InstCombiner::visitAllocaInst().

◆ getAddressSpace()

unsigned llvm::PointerType::getAddressSpace ( ) const

Return the address space of the Pointer type.

Definition at line 607 of file DerivedTypes.h.

References llvm::Type::getSubclassData().

Referenced by llvm::MachineIRBuilder::buildGlobalValue(), canDemoteGlobalVar(), llvm::CastInst::castIsValid(), llvm::orc::cloneGlobalVariableDecl(), llvm::FunctionComparator::cmpConstants(), llvm::FunctionComparator::cmpTypes(), llvm::ConstantFoldGetElementPtr(), ConvertDoubleToBytes(), llvm::convertToDeclaration(), llvm::GlobalAlias::create(), llvm::createAMDGPUFunctionInliningPass(), llvm::createAMDGPUPrintfRuntimeBinding(), createGlobalFwdRef(), llvm::NVPTXAsmPrinter::doFinalization(), FindAllMemoryUses(), forceRenaming(), llvm::GlobalValue::getAddressSpace(), llvm::ConstantExpr::getAddrSpaceCast(), getArrayElements(), getAttrKindEncoding(), llvm::getCallsiteCost(), llvm::X86TTIImpl::getGatherScatterOpCost(), llvm::getInlineCost(), getNaturalGEPWithOffset(), getOpenCLAlignment(), getTypePartition(), llvm::SCEVExpander::hoistIVInc(), INITIALIZE_PASS(), llvm::isAllocaPromotable(), isCallPromotable(), isContiguous(), llvm::AMDGPU::isGlobalSegment(), llvm::AMDGPU::isGroupSegment(), isKnownTypeIdMember(), llvm::DataLayout::isNonIntegralPointerType(), isObjectDereferencedInBlock(), llvm::AMDGPU::isReadOnlySegment(), isTypeCongruent(), isUnmergeableGlobal(), isZeroLengthArray(), matchIntrinsicType(), maybePrintComdat(), MergeAliasResults(), PrintLLVMName(), processInternalGlobal(), RetagMask(), selectJumpTableArmEncoding(), llvm::SITargetLowering::shouldEmitFixup(), llvm::SITargetLowering::shouldEmitGOTReloc(), SRAGlobal(), TryToShrinkGlobalToBoolean(), llvm::InstCombiner::visitAddrSpaceCast(), llvm::InstCombiner::visitBitCast(), llvm::ObjectSizeOffsetVisitor::visitConstantPointerNull(), and llvm::InstCombiner::visitGetElementPtrInst().

◆ getElementType()

Type* llvm::PointerType::getElementType ( ) const

◆ getUnqual()

static PointerType* llvm::PointerType::getUnqual ( Type ElementType)

◆ isLoadableOrStorableType()

bool PointerType::isLoadableOrStorableType ( Type ElemTy)

Return true if we can load or store from a pointer to this type.

Definition at line 668 of file Type.cpp.

References llvm::Type::isFunctionTy(), and isValidElementType().

◆ isValidElementType()

bool PointerType::isValidElementType ( Type ElemTy)

Return true if the specified type is valid as a element type.

Definition at line 663 of file Type.cpp.

References llvm::Type::isLabelTy(), llvm::Type::isMetadataTy(), llvm::Type::isTokenTy(), and llvm::Type::isVoidTy().

Referenced by llvm::GlobalVariable::GlobalVariable(), maybeSetDSOLocal(), and parseOptionalLinkageAux().

◆ operator=()

PointerType& llvm::PointerType::operator= ( const PointerType )

The documentation for this class was generated from the following files: