#include "llvm/IR/MDBuilder.h"

Classes
struct	TBAAStructField

Public Types
using	PCSection = std::pair< StringRef, SmallVector< Constant * > >
	A pair of PC section name with auxilliary constant data.

Public Member Functions
	MDBuilder (LLVMContext &context)

MDString *	createString (StringRef Str)
	Return the given string as metadata.

ConstantAsMetadata *	createConstant (Constant *C)
	Return the given constant as metadata.

MDNode *	createFPMath (float Accuracy)
	Return metadata with the given settings.

MDNode *	createBranchWeights (uint32_t TrueWeight, uint32_t FalseWeight)
	Return metadata containing two branch weights.

MDNode *	createBranchWeights (ArrayRef< uint32_t > Weights)
	Return metadata containing a number of branch weights.

MDNode *	createUnpredictable ()
	Return metadata specifying that a branch or switch is unpredictable.

MDNode *	createFunctionEntryCount (uint64_t Count, bool Synthetic, const DenseSet< GlobalValue::GUID > *Imports)
	Return metadata containing the entry `Count` for a function, a boolean \Synthetic indicating whether the counts were synthetized, and the GUIDs stored in `Imports` that need to be imported for sample PGO, to enable the same inlines as the profiled optimized binary.

MDNode *	createFunctionSectionPrefix (StringRef Prefix)
	Return metadata containing the section prefix for a function.

MDNode *	createPseudoProbeDesc (uint64_t GUID, uint64_t Hash, StringRef FName)
	Return metadata containing the pseudo probe descriptor for a function.

MDNode *	createLLVMStats (ArrayRef< std::pair< StringRef, uint64_t > > LLVMStatsVec)
	Return metadata containing llvm statistics.

MDNode *	createRange (const APInt &Lo, const APInt &Hi)
	Return metadata describing the range [Lo, Hi).

MDNode *	createRange (Constant Lo, Constant Hi)
	Return metadata describing the range [Lo, Hi).

MDNode *	createCallees (ArrayRef< Function * > Callees)
	Return metadata indicating the possible callees of indirect calls.

MDNode *	createCallbackEncoding (unsigned CalleeArgNo, ArrayRef< int > Arguments, bool VarArgsArePassed)
	Return metadata describing a callback (see llvm::AbstractCallSite).

MDNode *	mergeCallbackEncodings (MDNode ExistingCallbacks, MDNode NewCB)
	Merge the new callback encoding `NewCB` into `ExistingCallbacks`.

MDNode *	createRTTIPointerPrologue (Constant PrologueSig, Constant RTTI)
	Return metadata feeding to the CodeGen about how to generate a function prologue for the "function" santizier.

MDNode *	createPCSections (ArrayRef< PCSection > Sections)
	Return metadata for PC sections.

MDNode *	createAnonymousTBAARoot ()
	Return metadata appropriate for a TBAA root node.

MDNode *	createAnonymousAliasScopeDomain (StringRef Name=StringRef())
	Return metadata appropriate for an alias scope domain node.

MDNode *	createAnonymousAliasScope (MDNode *Domain, StringRef Name=StringRef())
	Return metadata appropriate for an alias scope root node.

MDNode *	createTBAARoot (StringRef Name)
	Return metadata appropriate for a TBAA root node with the given name.

MDNode *	createAliasScopeDomain (StringRef Name)
	Return metadata appropriate for an alias scope domain node with the given name.

MDNode *	createAliasScope (StringRef Name, MDNode *Domain)
	Return metadata appropriate for an alias scope node with the given name.

MDNode *	createTBAANode (StringRef Name, MDNode *Parent, bool isConstant=false)
	Return metadata for a non-root TBAA node with the given name, parent in the TBAA tree, and value for 'pointsToConstantMemory'.

MDNode *	createTBAAStructNode (ArrayRef< TBAAStructField > Fields)
	Return metadata for a tbaa.struct node with the given struct field descriptions.

MDNode *	createTBAAStructTypeNode (StringRef Name, ArrayRef< std::pair< MDNode *, uint64_t > > Fields)
	Return metadata for a TBAA struct node in the type DAG with the given name, a list of pairs (offset, field type in the type DAG).

MDNode *	createTBAAScalarTypeNode (StringRef Name, MDNode *Parent, uint64_t Offset=0)
	Return metadata for a TBAA scalar type node with the given name, an offset and a parent in the TBAA type DAG.

MDNode *	createTBAAStructTagNode (MDNode BaseType, MDNode AccessType, uint64_t Offset, bool IsConstant=false)
	Return metadata for a TBAA tag node with the given base type, access type and offset relative to the base type.

MDNode *	createTBAATypeNode (MDNode Parent, uint64_t Size, Metadata Id, ArrayRef< TBAAStructField > Fields=ArrayRef< TBAAStructField >())
	Return metadata for a TBAA type node in the TBAA type DAG with the given parent type, size in bytes, type identifier and a list of fields.

MDNode *	createTBAAAccessTag (MDNode BaseType, MDNode AccessType, uint64_t Offset, uint64_t Size, bool IsImmutable=false)
	Return metadata for a TBAA access tag with the given base type, final access type, offset of the access relative to the base type, size of the access and flag indicating whether the accessed object can be considered immutable for the purposes of the TBAA analysis.

MDNode *	createMutableTBAAAccessTag (MDNode *Tag)
	Return mutable version of the given mutable or immutable TBAA access tag.

MDNode *	createIrrLoopHeaderWeight (uint64_t Weight)
	Return metadata containing an irreducible loop header weight.

Protected Member Functions
MDNode *	createAnonymousAARoot (StringRef Name=StringRef(), MDNode *Extra=nullptr)
	Return metadata appropriate for a AA root node (scope or TBAA).

Detailed Description

Definition at line 36 of file MDBuilder.h.

Member Typedef Documentation

◆ PCSection

using llvm::MDBuilder::PCSection = std::pair<StringRef, SmallVector<Constant *> >

A pair of PC section name with auxilliary constant data.

Definition at line 125 of file MDBuilder.h.

Constructor & Destructor Documentation

◆ MDBuilder()

llvm::MDBuilder::MDBuilder ( LLVMContext & context )

inline

Definition at line 40 of file MDBuilder.h.

References Context.

Member Function Documentation

◆ createAliasScope()

MDNode * MDBuilder::createAliasScope	(	StringRef	Name,
		MDNode *	Domain
	)

Return metadata appropriate for an alias scope node with the given name.

This may be identified (uniqued) with other scopes with the same name and domain.

Definition at line 220 of file MDBuilder.cpp.

References createString(), llvm::MDNode::get(), and Name.

◆ createAliasScopeDomain()

MDNode * MDBuilder::createAliasScopeDomain ( StringRef Name )

Return metadata appropriate for an alias scope domain node with the given name.

This may be identified (uniqued) with other roots with the same name.

Definition at line 216 of file MDBuilder.cpp.

References createString(), llvm::MDNode::get(), and Name.

◆ createAnonymousAARoot()

MDNode * MDBuilder::createAnonymousAARoot	(	StringRef	Name = `StringRef()`,
		MDNode *	Extra = `nullptr`
	)

protected

Return metadata appropriate for a AA root node (scope or TBAA).

Each returned node is distinct from all other metadata and will never be identified (uniqued) with anything else.

Definition at line 182 of file MDBuilder.cpp.

References createString(), llvm::MDNode::getDistinct(), Name, and llvm::MDNode::replaceOperandWith().

Referenced by createAnonymousAliasScope(), createAnonymousAliasScopeDomain(), and createAnonymousTBAARoot().

◆ createAnonymousAliasScope()

MDNode * llvm::MDBuilder::createAnonymousAliasScope	(	MDNode *	Domain,
		StringRef	Name = `StringRef()`
	)

inline

Return metadata appropriate for an alias scope root node.

Each returned node is distinct from all other metadata and will never be identified (uniqued) with anything else.

Definition at line 159 of file MDBuilder.h.

References createAnonymousAARoot(), and Name.

Referenced by AddAliasScopeMetadata(), llvm::cloneNoAliasScopes(), llvm::createMemCpyLoopKnownSize(), and llvm::LoopVersioning::prepareNoAliasMetadata().

◆ createAnonymousAliasScopeDomain()

MDNode * llvm::MDBuilder::createAnonymousAliasScopeDomain ( StringRef Name = StringRef() )

inline

Return metadata appropriate for an alias scope domain node.

Each returned node is distinct from all other metadata and will never be identified (uniqued) with anything else.

Definition at line 152 of file MDBuilder.h.

References createAnonymousAARoot(), and Name.

Referenced by AddAliasScopeMetadata(), llvm::createMemCpyLoopKnownSize(), and llvm::LoopVersioning::prepareNoAliasMetadata().

◆ createAnonymousTBAARoot()

MDNode * llvm::MDBuilder::createAnonymousTBAARoot ( )

inline

Return metadata appropriate for a TBAA root node.

Each returned node is distinct from all other metadata and will never be identified (uniqued) with anything else.

Definition at line 145 of file MDBuilder.h.

References createAnonymousAARoot().

◆ createBranchWeights() [1/2]

MDNode * MDBuilder::createBranchWeights ( ArrayRef< uint32_t > Weights )

Return metadata containing a number of branch weights.

Definition at line 42 of file MDBuilder.cpp.

References assert(), createConstant(), createString(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt32Ty(), Int32Ty, and llvm::ArrayRef< T >::size().

◆ createBranchWeights() [2/2]

MDNode * MDBuilder::createBranchWeights	(	uint32_t	TrueWeight,
		uint32_t	FalseWeight
	)

Return metadata containing two branch weights.

Definition at line 37 of file MDBuilder.cpp.

References createBranchWeights().

Referenced by llvm::SwitchInstProfUpdateWrapper::buildProfBranchWeightsMD(), llvm::ConstantFoldTerminator(), createBranchWeights(), llvm::createCallMatchingInvoke(), fixupBranchWeights(), handleBrSelExpect(), handlePhiDef(), handleSwitchExpect(), llvm::makeGuardControlFlowExplicit(), llvm::pgo::promoteIndirectCall(), llvm::KCFIPass::run(), setBranchWeights(), llvm::setLoopEstimatedTripCount(), llvm::setProfMetadata(), updateBranchWeights(), updateLatchBranchWeightsForRemainderLoop(), and updatePredecessorProfileMetadata().

◆ createCallbackEncoding()

MDNode * MDBuilder::createCallbackEncoding	(	unsigned	CalleeArgNo,
		ArrayRef< int >	Arguments,
		bool	VarArgsArePassed
	)

Return metadata describing a callback (see llvm::AbstractCallSite).

Definition at line 107 of file MDBuilder.cpp.

References Arguments, createConstant(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt1Ty(), llvm::Type::getInt64Ty(), Int1, Int64, and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by llvm::OpenMPIRBuilder::createParallel(), and llvm::OpenMPIRBuilder::getOrCreateRuntimeFunction().

◆ createCallees()

MDNode * MDBuilder::createCallees ( ArrayRef< Function * > Callees )

Return metadata indicating the possible callees of indirect calls.

Definition at line 100 of file MDBuilder.cpp.

References createConstant(), F, llvm::MDNode::get(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by runCVP().

◆ createConstant()

ConstantAsMetadata * MDBuilder::createConstant ( Constant * C )

Return the given constant as metadata.

Definition at line 24 of file MDBuilder.cpp.

References llvm::CallingConv::C, and llvm::ConstantAsMetadata::get().

Referenced by addModuleFlags(), llvm::annotateValueSite(), createBranchWeights(), createCallbackEncoding(), createCallees(), createFPMath(), createFunctionEntryCount(), createIrrLoopHeaderWeight(), createLLVMStats(), createPCSections(), createPseudoProbeDesc(), createRange(), createRTTIPointerPrologue(), createTBAAAccessTag(), createTBAANode(), createTBAAScalarTypeNode(), createTBAAStructNode(), createTBAAStructTagNode(), createTBAAStructTypeNode(), createTBAATypeNode(), llvm::setKCFIType(), and llvm::CallInst::updateProfWeight().

◆ createFPMath()

MDNode * MDBuilder::createFPMath ( float Accuracy )

Return metadata with the given settings.

The special value 0.0 for the Accuracy parameter indicates the default (maximal precision) setting.

Definition at line 28 of file MDBuilder.cpp.

References assert(), createConstant(), llvm::MDNode::get(), llvm::ConstantFP::get(), and llvm::Type::getFloatTy().

◆ createFunctionEntryCount()

MDNode * MDBuilder::createFunctionEntryCount	(	uint64_t	Count,
		bool	Synthetic,
		const DenseSet< GlobalValue::GUID > *	Imports
	)

Return metadata containing the entry Count for a function, a boolean \Synthetic indicating whether the counts were synthetized, and the GUIDs stored in Imports that need to be imported for sample PGO, to enable the same inlines as the profiled optimized binary.

Definition at line 59 of file MDBuilder.cpp.

References llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::begin(), createConstant(), createString(), llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::end(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::sort().

Referenced by llvm::Function::setEntryCount().

◆ createFunctionSectionPrefix()

MDNode * MDBuilder::createFunctionSectionPrefix ( StringRef Prefix )

Return metadata containing the section prefix for a function.

Definition at line 78 of file MDBuilder.cpp.

References createString(), and llvm::MDNode::get().

Referenced by llvm::Function::setSectionPrefix().

◆ createIrrLoopHeaderWeight()

MDNode * MDBuilder::createIrrLoopHeaderWeight ( uint64_t Weight )

Return metadata containing an irreducible loop header weight.

Definition at line 330 of file MDBuilder.cpp.

References createConstant(), createString(), llvm::MDNode::get(), llvm::ConstantInt::get(), and llvm::Type::getInt64Ty().

Referenced by llvm::setIrrLoopHeaderMetadata().

◆ createLLVMStats()

MDNode * MDBuilder::createLLVMStats ( ArrayRef< std::pair< StringRef, uint64_t > > LLVMStatsVec )

Return metadata containing llvm statistics.

Definition at line 349 of file MDBuilder.cpp.

References createConstant(), createString(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), and I.

◆ createMutableTBAAAccessTag()

MDNode * MDBuilder::createMutableTBAAAccessTag ( MDNode * Tag )

Return mutable version of the given mutable or immutable TBAA access tag.

Definition at line 303 of file MDBuilder.cpp.

References createTBAAAccessTag(), createTBAAStructTagNode(), llvm::MDNode::getOperand(), llvm::Offset, and Size.

◆ createPCSections()

MDNode * MDBuilder::createPCSections ( ArrayRef< PCSection > Sections )

Return metadata for PC sections.

Definition at line 161 of file MDBuilder.cpp.

References llvm::CallingConv::C, createConstant(), createString(), llvm::SmallVectorBase< Size_T >::empty(), llvm::MDNode::get(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::SmallVectorImpl< T >::reserve(), and llvm::SmallVectorBase< Size_T >::size().

◆ createPseudoProbeDesc()

MDNode * MDBuilder::createPseudoProbeDesc	(	uint64_t	GUID,
		uint64_t	Hash,
		StringRef	FName
	)

Return metadata containing the pseudo probe descriptor for a function.

Definition at line 338 of file MDBuilder.cpp.

References createConstant(), createString(), llvm::MDNode::get(), llvm::ConstantInt::get(), and llvm::Type::getInt64Ty().

Referenced by llvm::SampleProfileProber::instrumentOneFunc().

◆ createRange() [1/2]

MDNode * MDBuilder::createRange	(	const APInt &	Lo,
		const APInt &	Hi
	)

Return metadata describing the range [Lo, Hi).

Definition at line 84 of file MDBuilder.cpp.

References assert(), createRange(), llvm::IntegerType::get(), llvm::ConstantInt::get(), llvm::Hi, and llvm::Lo.

Referenced by llvm::copyNonnullMetadata(), createRange(), and llvm::AMDGPUSubtarget::makeLIDRangeMetadata().

◆ createRange() [2/2]

MDNode * MDBuilder::createRange	(	Constant *	Lo,
		Constant *	Hi
	)

Return metadata describing the range [Lo, Hi).

Definition at line 91 of file MDBuilder.cpp.

References createConstant(), llvm::MDNode::get(), llvm::Hi, and llvm::Lo.

◆ createRTTIPointerPrologue()

MDNode * MDBuilder::createRTTIPointerPrologue	(	Constant *	PrologueSig,
		Constant *	RTTI
	)

Return metadata feeding to the CodeGen about how to generate a function prologue for the "function" santizier.

Definition at line 153 of file MDBuilder.cpp.

References createConstant(), llvm::MDNode::get(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ createString()

MDString * MDBuilder::createString ( StringRef Str )

Return the given string as metadata.

Definition at line 20 of file MDBuilder.cpp.

References llvm::MDString::get().

Referenced by llvm::Instruction::addAnnotationMetadata(), annotateFunctionWithHashMismatch(), llvm::annotateValueSite(), createAliasScope(), createAliasScopeDomain(), createAnonymousAARoot(), createBranchWeights(), createFunctionEntryCount(), createFunctionSectionPrefix(), createIrrLoopHeaderWeight(), createLLVMStats(), createPCSections(), createPseudoProbeDesc(), createTBAANode(), createTBAARoot(), createTBAAScalarTypeNode(), and createTBAAStructTypeNode().

◆ createTBAAAccessTag()

MDNode * MDBuilder::createTBAAAccessTag	(	MDNode *	BaseType,
		MDNode *	AccessType,
		uint64_t	Offset,
		uint64_t	Size,
		bool	IsImmutable = `false`
	)

Return metadata for a TBAA access tag with the given base type, final access type, offset of the access relative to the base type, size of the access and flag indicating whether the accessed object can be considered immutable for the purposes of the TBAA analysis.

Definition at line 289 of file MDBuilder.cpp.

References createConstant(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), Int64, llvm::Offset, and Size.

Referenced by createMutableTBAAAccessTag().

◆ createTBAANode()

MDNode * MDBuilder::createTBAANode	(	StringRef	Name,
		MDNode *	Parent,
		bool	isConstant = `false`
	)

Return metadata for a non-root TBAA node with the given name, parent in the TBAA tree, and value for 'pointsToConstantMemory'.

Definition at line 206 of file MDBuilder.cpp.

References createConstant(), createString(), Flags, llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), isConstant(), and Name.

◆ createTBAARoot()

MDNode * MDBuilder::createTBAARoot ( StringRef Name )

Return metadata appropriate for a TBAA root node with the given name.

This may be identified (uniqued) with other roots with the same name.

Definition at line 200 of file MDBuilder.cpp.

References createString(), llvm::MDNode::get(), and Name.

◆ createTBAAScalarTypeNode()

MDNode * MDBuilder::createTBAAScalarTypeNode	(	StringRef	Name,
		MDNode *	Parent,
		uint64_t	Offset = `0`
	)

Return metadata for a TBAA scalar type node with the given name, an offset and a parent in the TBAA type DAG.

Definition at line 253 of file MDBuilder.cpp.

References createConstant(), createString(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), Name, and llvm::Offset.

◆ createTBAAStructNode()

MDNode * MDBuilder::createTBAAStructNode ( ArrayRef< TBAAStructField > Fields )

Return metadata for a tbaa.struct node with the given struct field descriptions.

Definition at line 226 of file MDBuilder.cpp.

References createConstant(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), Int64, llvm::Offset, llvm::ArrayRef< T >::size(), and Size.

◆ createTBAAStructTagNode()

MDNode * MDBuilder::createTBAAStructTagNode	(	MDNode *	BaseType,
		MDNode *	AccessType,
		uint64_t	Offset,
		bool	IsConstant = `false`
	)

Return metadata for a TBAA tag node with the given base type, access type and offset relative to the base type.

Definition at line 262 of file MDBuilder.cpp.

References createConstant(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), Int64, and llvm::Offset.

Referenced by createMutableTBAAAccessTag().

◆ createTBAAStructTypeNode()

MDNode * MDBuilder::createTBAAStructTypeNode	(	StringRef	Name,
		ArrayRef< std::pair< MDNode *, uint64_t > >	Fields
	)

Return metadata for a TBAA struct node in the type DAG with the given name, a list of pairs (offset, field type in the type DAG).

Definition at line 239 of file MDBuilder.cpp.

References createConstant(), createString(), llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), Int64, and Name.

◆ createTBAATypeNode()

MDNode * MDBuilder::createTBAATypeNode	(	MDNode *	Parent,
		uint64_t	Size,
		Metadata *	Id,
		ArrayRef< TBAAStructField >	Fields = `ArrayRef<TBAAStructField>()`
	)

Return metadata for a TBAA type node in the TBAA type DAG with the given parent type, size in bytes, type identifier and a list of fields.

Definition at line 273 of file MDBuilder.cpp.

References createConstant(), E, llvm::MDNode::get(), llvm::ConstantInt::get(), llvm::Type::getInt64Ty(), I, Int64, llvm::Offset, llvm::ArrayRef< T >::size(), and Size.

◆ createUnpredictable()

MDNode * MDBuilder::createUnpredictable ( )

Return metadata specifying that a branch or switch is unpredictable.

Definition at line 55 of file MDBuilder.cpp.

References llvm::MDNode::get().

◆ mergeCallbackEncodings()

MDNode * MDBuilder::mergeCallbackEncodings	(	MDNode *	ExistingCallbacks,
		MDNode *	NewCB
	)

Merge the new callback encoding NewCB into ExistingCallbacks.

Definition at line 124 of file MDBuilder.cpp.

References assert(), llvm::MDNode::get(), llvm::MDNode::getNumOperands(), llvm::MDNode::getOperand(), and llvm::SmallVectorImpl< T >::resize().

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

include/llvm/IR/MDBuilder.h
lib/IR/MDBuilder.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ PCSection

Constructor & Destructor Documentation

◆ MDBuilder()

Member Function Documentation

◆ createAliasScope()

◆ createAliasScopeDomain()

◆ createAnonymousAARoot()

◆ createAnonymousAliasScope()

◆ createAnonymousAliasScopeDomain()

◆ createAnonymousTBAARoot()

◆ createBranchWeights() [1/2]

◆ createBranchWeights() [2/2]

◆ createCallbackEncoding()

◆ createCallees()

◆ createConstant()

◆ createFPMath()

◆ createFunctionEntryCount()

◆ createFunctionSectionPrefix()

◆ createIrrLoopHeaderWeight()

◆ createLLVMStats()

◆ createMutableTBAAAccessTag()

◆ createPCSections()

◆ createPseudoProbeDesc()

◆ createRange() [1/2]

◆ createRange() [2/2]

◆ createRTTIPointerPrologue()

◆ createString()

◆ createTBAAAccessTag()

◆ createTBAANode()

◆ createTBAARoot()

◆ createTBAAScalarTypeNode()

◆ createTBAAStructNode()

◆ createTBAAStructTagNode()

◆ createTBAAStructTypeNode()

◆ createTBAATypeNode()

◆ createUnpredictable()

◆ mergeCallbackEncodings()