llvm::MDString Class Reference

A single uniqued string. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::MDString:

Public Types
using	iterator = StringRef::iterator
Public Types inherited from llvm::Metadata
enum	MetadataKind

Public Member Functions
	MDString (const MDString &)=delete
MDString &	operator= (MDString &&)=delete
MDString &	operator= (const MDString &)=delete
LLVM_ABI StringRef	getString () const
unsigned	getLength () const
iterator	begin () const
	Pointer to the first byte of the string.
iterator	end () const
	Pointer to one byte past the end of the string.
const unsigned char *	bytes_begin () const
const unsigned char *	bytes_end () const
Public Member Functions inherited from llvm::Metadata
unsigned	getMetadataID () const
LLVM_ABI void	dump () const
	User-friendly dump.
LLVM_ABI void	dump (const Module *M) const
LLVM_ABI void	print (raw_ostream &OS, const Module *M=nullptr, bool IsForDebug=false) const
	Print.
LLVM_ABI void	print (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr, bool IsForDebug=false) const
LLVM_ABI void	printAsOperand (raw_ostream &OS, const Module *M=nullptr) const
	Print as operand.
LLVM_ABI void	printAsOperand (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const

Static Public Member Functions
static LLVM_ABI MDString *	get (LLVMContext &Context, StringRef Str)
static MDString *	get (LLVMContext &Context, const char *Str)
static bool	classof (const Metadata *MD)
	Methods for support type inquiry through isa, cast, and dyn_cast.

Friends
class	StringMapEntryStorage< MDString >

Additional Inherited Members
Static Public Attributes inherited from llvm::Metadata
static constexpr const unsigned	PoisonGeneratingIDs []
	Metadata IDs that may generate poison.
Protected Types inherited from llvm::Metadata
enum	StorageType { Uniqued , Distinct , Temporary }
	Active type of storage. More...
Protected Member Functions inherited from llvm::Metadata
	Metadata (unsigned ID, StorageType Storage)
	~Metadata ()=default
void	handleChangedOperand (void *, Metadata *)
	Default handling of a changed operand, which asserts.
Protected Attributes inherited from llvm::Metadata
unsigned char	Storage: 7
	Storage flag for non-uniqued, otherwise unowned, metadata.
unsigned char	SubclassData1: 1
unsigned short	SubclassData16 = 0
unsigned	SubclassData32 = 0

Detailed Description

A single uniqued string.

These are used to efficiently contain a byte sequence for metadata. MDString is always unnamed.

Definition at line 721 of file Metadata.h.

Member Typedef Documentation

iterator

using llvm::MDString::iterator = StringRef::iterator

Definition at line 742 of file Metadata.h.

Constructor & Destructor Documentation

MDString()

llvm::MDString::MDString ( const MDString & )

delete

Member Function Documentation

begin()

iterator llvm::MDString::begin ( ) const

inline

Pointer to the first byte of the string.

Definition at line 745 of file Metadata.h.

References llvm::StringRef::begin(), and getString().

bytes_begin()

const unsigned char * llvm::MDString::bytes_begin ( ) const

inline

Definition at line 750 of file Metadata.h.

References llvm::StringRef::bytes_begin(), and getString().

bytes_end()

const unsigned char * llvm::MDString::bytes_end ( ) const

inline

Definition at line 751 of file Metadata.h.

References llvm::StringRef::bytes_end(), and getString().

classof()

bool llvm::MDString::classof ( const Metadata * MD )

inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast.

Definition at line 754 of file Metadata.h.

References llvm::Metadata::getMetadataID(), and llvm::Metadata::Metadata().

end()

iterator llvm::MDString::end ( ) const

inline

Pointer to one byte past the end of the string.

Definition at line 748 of file Metadata.h.

References llvm::StringRef::end(), and getString().

get() [1/2]

MDString * llvm::MDString::get ( LLVMContext & Context, const char * Str )

inlinestatic

Definition at line 734 of file Metadata.h.

References get().

get() [2/2]

MDString * MDString::get ( LLVMContext & Context, StringRef Str )

static

Definition at line 608 of file Metadata.cpp.

References I.

Referenced by addRuntimeUnrollDisableMetaData(), llvm::SPIRVGlobalRegistry::buildAssignType(), constructEntryMetadata(), convertToLocalCopy(), llvm::coro::BaseCloner::create(), createMIBNode(), llvm::createPGONameMetadata(), llvm::MDBuilder::createString(), createStringMetadata(), llvm::DIBuilder::createTemplateTemplateParameter(), DisableAllLoopOptsOnLoop(), llvm::embedBufferInModule(), llvm::emitAMDGPUPrintfCall(), emitAssignName(), emitShaderModelVersionMD(), llvm::MDNode::fromCaptureComponents(), get(), llvm::dxil::ResourceInfo::getAsMetadata(), llvm::DIMacroNode::getCanonicalMDString(), llvm::DINode::getCanonicalMDString(), getKeyFPValMD(), getKeyValMD(), getKeyValMD(), llvm::MMRAMetadata::getTagMD(), llvm::GCNTTIImpl::instCombineIntrinsic(), LLVMMDStringInContext(), LLVMMDStringInContext2(), lowerPtrAnnotation(), parseAnnotation(), llvm::LLParser::parseMDField(), postUnswitch(), llvm::sandboxir::Region::Region(), llvm::SimplifyTypeTestsPass::run(), runImpl(), llvm::LoopVectorizeHints::setAlreadyVectorized(), llvm::Loop::setLoopAlreadyUnrolled(), llvm::Loop::setLoopMustProgress(), solveTypeName(), updateSubprogramLinkageName(), upgradeLoopTag(), llvm::UpgradeModuleFlags(), and upgradeRetainReleaseMarker().

getLength()

unsigned llvm::MDString::getLength ( ) const

inline

Definition at line 740 of file Metadata.h.

References getString(), and llvm::StringRef::size().

getString()

StringRef MDString::getString

(

)

const

Definition at line 618 of file Metadata.cpp.

Referenced by llvm::addStringMetadataToLoop(), begin(), bytes_begin(), bytes_end(), llvm::cacheAnnotationFromMD(), llvm::MachineFunction::CallSiteInfo::CallSiteInfo(), createProfileFileNameVar(), llvm::WebAssemblyAsmPrinter::emitEndOfAsmFile(), end(), llvm::hlsl::rootsig::extractMdStringValue(), extractNumericCGTypeId(), llvm::findOptionMDForLoopID(), getArgAccessQual(), GetFunctionFromMDNode(), getHiPELiteral(), getKernelArgTypeQual(), getLength(), getSummaryFromMD(), llvm::GetUnrollMetadata(), getValMD(), hasAnyUnrollPragma(), isCanonical(), isKeyValuePair(), llvm::LegalizerHelper::lowerReadWriteRegister(), and llvm::makePostTransformationMetadata().

operator=() [1/2]

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

delete

References LLVM_ABI.

operator=() [2/2]

MDString & llvm::MDString::operator= ( MDString && )

delete

Friends And Related Symbol Documentation

StringMapEntryStorage< MDString >

friend class StringMapEntryStorage< MDString >

friend

Definition at line 638 of file Metadata.h.

---

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

• include/llvm/IR/Metadata.h
• lib/IR/Metadata.cpp