LLVM: llvm::MDBuilder Class Reference (original) (raw)

#include "[llvm/IR/MDBuilder.h](MDBuilder%5F8h%5Fsource.html)"

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, bool IsExpected=false)
Return metadata containing two branch weights.
MDNode * createLikelyBranchWeights ()
Return metadata containing two branch weights, with significant bias towards true destination.
MDNode * createUnlikelyBranchWeights ()
Return metadata containing two branch weights, with significant bias towards false destination.
MDNode * createBranchWeights (ArrayRef< uint32_t > Weights, bool IsExpected=false)
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.

Definition at line 36 of file MDBuilder.h.

◆ PCSection

A pair of PC section name with auxilliary constant data.

Definition at line 140 of file MDBuilder.h.

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

◆ createAliasScope()

◆ createAliasScopeDomain()

◆ createAnonymousAARoot()

◆ createAnonymousAliasScope()

◆ createAnonymousAliasScopeDomain()

◆ 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 160 of file MDBuilder.h.

References createAnonymousAARoot().

◆ createBranchWeights() [1/2]

◆ createBranchWeights() [2/2]

Return metadata containing two branch weights.

Parameters

TrueWeight the weight of the true branch
FalseWeight the weight of the false branch
Do these weights come from __builtin_expect*

Definition at line 37 of file MDBuilder.cpp.

References createBranchWeights().

Referenced by llvm::SwitchInstProfUpdateWrapper::buildProfBranchWeightsMD(), CloneLoopBlocks(), ConnectEpilog(), ConnectProlog(), llvm::ConstantFoldTerminator(), createBranchWeights(), createBranchWeights(), llvm::createCallMatchingInvoke(), createLikelyBranchWeights(), createUnlikelyBranchWeights(), handleBrSelExpect(), handlePhiDef(), InsertStackProtectors(), llvm::makeGuardControlFlowExplicit(), llvm::setBranchWeights(), setBranchWeights(), llvm::setLoopEstimatedTripCount(), simplifySwitchOfCmpIntrinsic(), and llvm::UnrollRuntimeLoopRemainder().

◆ createCallbackEncoding()

◆ createCallees()

◆ createConstant()

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(), lowerKernelArguments(), llvm::scaleProfData(), llvm::setKCFIType(), and translateBranchMetadata().

◆ createFPMath()

MDNode * MDBuilder::createFPMath ( float Accuracy )

◆ createFunctionEntryCount()

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 71 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::Type::getInt64Ty(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::sort().

◆ createFunctionSectionPrefix()

◆ createIrrLoopHeaderWeight()

◆ createLikelyBranchWeights()

MDNode * MDBuilder::createLikelyBranchWeights ( )

◆ createLLVMStats()

◆ createMutableTBAAAccessTag()

MDNode * MDBuilder::createMutableTBAAAccessTag ( MDNode * Tag )

◆ createPCSections()

◆ createPseudoProbeDesc()

◆ createRange() [1/2]

Return metadata describing the range [Lo, Hi).

Definition at line 95 of file MDBuilder.cpp.

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

Referenced by annotateGridSizeLoadWithRangeMD(), llvm::copyNonnullMetadata(), createRange(), llvm::SITargetLowering::emitExpandAtomicAddrSpacePredicate(), lowerKernelArguments(), llvm::AMDGPUSubtarget::makeLIDRangeMetadata(), and upgradeAMDGCNIntrinsicCall().

◆ createRange() [2/2]

◆ createRTTIPointerPrologue()

◆ createString()

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(), createTBAAStructTypeNode(), and translateBranchMetadata().

◆ createTBAAAccessTag()

◆ createTBAANode()

◆ createTBAARoot()

◆ createTBAAScalarTypeNode()

◆ createTBAAStructNode()

◆ createTBAAStructTagNode()

◆ createTBAAStructTypeNode()

◆ createTBAATypeNode()

◆ createUnlikelyBranchWeights()

MDNode * MDBuilder::createUnlikelyBranchWeights ( )

◆ createUnpredictable()

MDNode * MDBuilder::createUnpredictable ( )

◆ mergeCallbackEncodings()

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