LLVM 18.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DIFile Class Reference

File. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIFile:
Inheritance graph
[legend]

Classes

struct  ChecksumInfo
 A single checksum, represented by a Kind and a Value (a string). More...
 

Public Types

enum  ChecksumKind { CSK_MD5 = 1 , CSK_SHA1 = 2 , CSK_SHA256 = 3 , CSK_Last = CSK_SHA256 }
 Which algorithm (e.g. More...
 
- Public Types inherited from llvm::DINode
enum  DIFlags : uint32_t { FlagAccessibility = FlagPrivate | FlagProtected | FlagPublic , FlagPtrToMemberRep }
 Debug info flags. More...
 
- Public Types inherited from llvm::MDNode
using op_iterator = const MDOperand *
 
using op_range = iterator_range< op_iterator >
 

Public Member Functions

 DEFINE_MDNODE_GET (DIFile,(StringRef Filename, StringRef Directory, std::optional< ChecksumInfo< StringRef > > CS=std::nullopt, std::optional< StringRef > Source=std::nullopt),(Filename, Directory, CS, Source)) DEFINE_MDNODE_GET(DIFile
 
- Public Member Functions inherited from llvm::DIScope
DIFilegetFile () const
 
StringRef getFilename () const
 
StringRef getDirectory () const
 
std::optional< StringRefgetSource () const
 
StringRef getName () const
 
DIScopegetScope () const
 
MetadatagetRawFile () const
 Return the raw underlying file.
 
- Public Member Functions inherited from llvm::DINode
dwarf::Tag getTag () const
 
- Public Member Functions inherited from llvm::MDNode
 MDNode (const MDNode &)=delete
 
void operator= (const MDNode &)=delete
 
void * operator new (size_t)=delete
 
TempMDNode clone () const
 Create a (temporary) clone of this.
 
LLVMContextgetContext () const
 
void replaceOperandWith (unsigned I, Metadata *New)
 Replace a specific operand.
 
bool isResolved () const
 Check if node is fully resolved.
 
bool isUniqued () const
 
bool isDistinct () const
 
bool isTemporary () const
 
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary.
 
void resolveCycles ()
 Resolve cycles.
 
void resolve ()
 Resolve a unique, unresolved node.
 
op_iterator op_begin () const
 
op_iterator op_end () const
 
ArrayRef< MDOperandoperands () const
 
const MDOperandgetOperand (unsigned I) const
 
unsigned getNumOperands () const
 Return number of MDNode operands.
 
bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access.
 
void printTree (raw_ostream &OS, const Module *M=nullptr) const
 Print in tree shape.
 
void printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
 
void dumpTree () const
 User-friendly dump in tree shape.
 
void dumpTree (const Module *M) const
 

Static Public Member Functions

static std::optional< ChecksumKindgetChecksumKind (StringRef CSKindStr)
 
static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::DIScope
static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::DINode
static DIFlags getFlag (StringRef Flag)
 
static StringRef getFlagString (DIFlags Flag)
 
static DIFlags splitFlags (DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
 Split up a flags bitfield.
 
static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::MDNode
static MDTupleget (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetIfExists (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetDistinct (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static TempMDTuple getTemporary (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static void deleteTemporary (MDNode *N)
 Deallocate a node created by getTemporary.
 
template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithPermanent (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a permanent one.
 
template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithUniqued (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a uniqued one.
 
template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithDistinct (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a distinct one.
 
static bool classof (const Metadata *MD)
 Methods for support type inquiry through isa, cast, and dyn_cast:
 
static MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging.
 
static MDNodeintersect (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericTBAA (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericFPMath (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericRange (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAliasScope (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAlignmentOrDereferenceable (MDNode *A, MDNode *B)
 
static MDNodegetMergedProfMetadata (MDNode *A, MDNode *B, const Instruction *AInstr, const Instruction *BInstr)
 Merge !prof metadata from two instructions.
 

Public Attributes

MDStringFilename
 
MDString MDStringDirectory
 
MDString MDString std::optional< ChecksumInfo< MDString * > > CS = std::nullopt
 
MDString MDString std::optional< ChecksumInfo< MDString * > > MDStringSource
 

Friends

class LLVMContextImpl
 
class MDNode
 

Additional Inherited Members

- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...
- Protected Member Functions inherited from llvm::DIScope
 DIScope (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops)
 
 ~DIScope ()=default
 
- Protected Member Functions inherited from llvm::DINode
 DINode (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~DINode ()=default
 
template<class Ty >
Ty * getOperandAs (unsigned I) const
 
StringRef getStringOperand (unsigned I) const
 
void setTag (unsigned Tag)
 Allow subclasses to mutate the tag.
 
- Protected Member Functions inherited from llvm::MDNode
 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~MDNode ()=default
 
void * operator new (size_t Size, size_t NumOps, StorageType Storage)
 
void operator delete (void *Mem)
 
void operator delete (void *, unsigned)
 Required by std, but never called.
 
void operator delete (void *, unsigned, bool)
 Required by std, but never called.
 
void dropAllReferences ()
 
MDOperandmutable_begin ()
 
MDOperandmutable_end ()
 
mutable_op_range mutable_operands ()
 
void setOperand (unsigned I, Metadata *New)
 Set an operand.
 
unsigned getNumUnresolved () const
 
void setNumUnresolved (unsigned N)
 
void storeDistinctInContext ()
 
void resize (size_t NumOps)
 Resize the node to hold NumOps operands.
 
- Static Protected Member Functions inherited from llvm::DINode
static MDStringgetCanonicalMDString (LLVMContext &Context, StringRef S)
 
- Static Protected Member Functions inherited from llvm::MDNode
template<class T , class StoreT >
static TstoreImpl (T *N, StorageType Storage, StoreT &Store)
 
template<class T >
static TstoreImpl (T *N, StorageType Storage)
 

Detailed Description

File.

TODO: Merge with directory/file node (including users). TODO: Canonicalize paths on creation.

Definition at line 563 of file DebugInfoMetadata.h.

Member Enumeration Documentation

◆ ChecksumKind

Which algorithm (e.g.

MD5) a checksum was generated with.

The encoding is explicit because it is used directly in Bitcode. The value 0 is reserved to indicate the absence of a checksum in Bitcode.

Enumerator
CSK_MD5 
CSK_SHA1 
CSK_SHA256 
CSK_Last 

Definition at line 572 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

static bool llvm::DIFile::classof ( const Metadata MD)
inlinestatic

Definition at line 670 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ DEFINE_MDNODE_GET()

llvm::DIFile::DEFINE_MDNODE_GET ( DIFile  ,
(StringRef Filename, StringRef Directory, std::optional< ChecksumInfo< StringRef > > CS=std::nullopt, std::optional< StringRef > Source=std::nullopt)  ,
(Filename, Directory, CS, Source)   
)

◆ getChecksumKind()

std::optional< DIFile::ChecksumKind > DIFile::getChecksumKind ( StringRef  CSKindStr)
static

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 564 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 565 of file DebugInfoMetadata.h.

Member Data Documentation

◆ CS

MDString MDString std::optional<ChecksumInfo<MDString *> > llvm::DIFile::CS = std::nullopt

Definition at line 641 of file DebugInfoMetadata.h.

◆ Directory

MDString MDString* llvm::DIFile::Directory

Definition at line 640 of file DebugInfoMetadata.h.

◆ Filename

MDString* llvm::DIFile::Filename

Definition at line 640 of file DebugInfoMetadata.h.

◆ Source

MDString MDString std::optional<ChecksumInfo<MDString *> > MDString* llvm::DIFile::Source
Initial value:
= nullptr),
(Filename, Directory, CS, Source))
TempDIFile clone() const { return cloneImpl(); }
StringRef getFilename() const { return getStringOperand(0); }
StringRef getDirectory() const { return getStringOperand(1); }
std::optional<ChecksumInfo<StringRef>> getChecksum() const {
std::optional<ChecksumInfo<StringRef>> StringRefChecksum;
if (Checksum)
StringRefChecksum.emplace(Checksum->Kind, Checksum->Value->getString());
return StringRefChecksum;
}
std::optional<StringRef> getSource() const {
return Source ? std::optional<StringRef>(Source->getString())
: std::nullopt;
}
MDString *getRawFilename() const { return getOperandAs<MDString>(0); }
MDString *getRawDirectory() const { return getOperandAs<MDString>(1); }
std::optional<ChecksumInfo<MDString *>> getRawChecksum() const {
return Checksum;
}
MDString *getRawSource() const { return Source; }
static StringRef getChecksumKindAsString(ChecksumKind CSKind)
MDString MDString * Directory
MDString * Filename
ChecksumKind
Which algorithm (e.g.
MDString MDString std::optional< ChecksumInfo< MDString * > > CS
StringRef getStringOperand(unsigned I) const
StringRef getFilename() const
StringRef getDirectory() const
std::optional< StringRef > getSource() const
TempMDNode clone() const
Create a (temporary) clone of this.
Definition: Metadata.cpp:560
StringRef getString() const
Definition: Metadata.cpp:509
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858

Definition at line 642 of file DebugInfoMetadata.h.


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