LLVM  6.0.0svn
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DILocation Class Reference

Debug location. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DILocation:
Inheritance graph
[legend]
Collaboration diagram for llvm::DILocation:
Collaboration graph
[legend]

Public Member Functions

void replaceOperandWith (unsigned I, Metadata *New)=delete
 
 DEFINE_MDNODE_GET (DILocation,(unsigned Line, unsigned Column, Metadata *Scope, Metadata *InlinedAt=nullptr),(Line, Column, Scope, InlinedAt)) DEFINE_MDNODE_GET(DILocation
 
const DILocationcloneWithDiscriminator (unsigned Discriminator) const
 Returns a new DILocation with updated Discriminator. More...
 
const DILocationsetBaseDiscriminator (unsigned BD) const
 Returns a new DILocation with updated base discriminator BD. More...
 
unsigned getDuplicationFactor () const
 Returns the duplication factor stored in the discriminator. More...
 
unsigned getCopyIdentifier () const
 Returns the copy identifier stored in the discriminator. More...
 
unsigned getBaseDiscriminator () const
 Returns the base discriminator stored in the discriminator. More...
 
const DILocationcloneWithDuplicationFactor (unsigned DF) const
 Returns a new DILocation with duplication factor DF encoded in the discriminator. More...
 
MetadatagetRawScope () const
 
MetadatagetRawInlinedAt () 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. More...
 
LLVMContextgetContext () const
 
void replaceOperandWith (unsigned I, Metadata *New)
 Replace a specific operand. More...
 
bool isResolved () const
 Check if node is fully resolved. More...
 
bool isUniqued () const
 
bool isDistinct () const
 
bool isTemporary () const
 
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary. More...
 
void resolveCycles ()
 Resolve cycles. More...
 
void resolve ()
 Resolve a unique, unresolved node. More...
 
op_iterator op_begin () const
 
op_iterator op_end () const
 
op_range operands () const
 
const MDOperandgetOperand (unsigned I) const
 
unsigned getNumOperands () const
 Return number of MDNode operands. More...
 
bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access. More...
 

Static Public Member Functions

static const DILocationgetMergedLocation (const DILocation *LocA, const DILocation *LocB, const Instruction *ForInst=nullptr)
 When two instructions are combined into a single instruction we also need to combine the original locations into a single location. More...
 
static unsigned getBaseDiscriminatorFromDiscriminator (unsigned D)
 Returns the base discriminator for a given encoded discriminator D. More...
 
static unsigned getDuplicationFactorFromDiscriminator (unsigned D)
 Returns the duplication factor for a given encoded discriminator D. More...
 
static unsigned getCopyIdentifierFromDiscriminator (unsigned D)
 Returns the copy identifier for a given encoded discriminator D. More...
 
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. More...
 
template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type replaceWithPermanent (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a permanent one. More...
 
template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type replaceWithUniqued (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a uniqued one. More...
 
template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type replaceWithDistinct (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a distinct one. More...
 
static bool classof (const Metadata *MD)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging. More...
 
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)
 

Public Attributes

unsigned Line
 
unsigned unsigned Column
 
unsigned unsigned DILocalScopeScope
 
unsigned unsigned DILocalScope DILocationInlinedAt
 

Friends

class LLVMContextImpl
 
class MDNode
 

Additional Inherited Members

- Public Types inherited from llvm::MDNode
using op_iterator = const MDOperand *
 
using op_range = iterator_range< op_iterator >
 
- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...
- Protected Member Functions inherited from llvm::MDNode
 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata *> Ops1, ArrayRef< Metadata *> Ops2=None)
 
 ~MDNode ()=default
 
void * operator new (size_t Size, unsigned NumOps)
 
void operator delete (void *Mem)
 
void operator delete (void *, unsigned)
 Required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 Required by std, but never called. More...
 
void dropAllReferences ()
 
MDOperandmutable_begin ()
 
MDOperandmutable_end ()
 
mutable_op_range mutable_operands ()
 
void setOperand (unsigned I, Metadata *New)
 Set an operand. More...
 
void storeDistinctInContext ()
 
- 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

Debug location.

A debug location in source code, used for debug info and otherwise.

Definition at line 1264 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

Definition at line 1463 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ cloneWithDiscriminator()

const DILocation * llvm::DILocation::cloneWithDiscriminator ( unsigned  Discriminator) const
inline

Returns a new DILocation with updated Discriminator.

Definition at line 1810 of file DebugInfoMetadata.h.

References llvm::dyn_cast(), llvm::MDNode::get(), and llvm::DIScope::getScope().

◆ cloneWithDuplicationFactor()

const DILocation * llvm::DILocation::cloneWithDuplicationFactor ( unsigned  DF) const
inline

Returns a new DILocation with duplication factor DF encoded in the discriminator.

Definition at line 1845 of file DebugInfoMetadata.h.

Referenced by llvm::InnerLoopVectorizer::setDebugLocFromInst().

◆ DEFINE_MDNODE_GET()

llvm::DILocation::DEFINE_MDNODE_GET ( DILocation  ,
(unsigned Line, unsigned Column, Metadata *Scope, Metadata *InlinedAt=nullptr)  ,
(Line, Column, Scope, InlinedAt  
)

◆ getBaseDiscriminator()

unsigned llvm::DILocation::getBaseDiscriminator ( ) const
inline

Returns the base discriminator stored in the discriminator.

Definition at line 1826 of file DebugInfoMetadata.h.

Referenced by callsiteIsHot(), and SortCallTargets().

◆ getBaseDiscriminatorFromDiscriminator()

static unsigned llvm::DILocation::getBaseDiscriminatorFromDiscriminator ( unsigned  D)
inlinestatic

Returns the base discriminator for a given encoded discriminator D.

Definition at line 1433 of file DebugInfoMetadata.h.

◆ getCopyIdentifier()

unsigned llvm::DILocation::getCopyIdentifier ( ) const
inline

Returns the copy identifier stored in the discriminator.

Definition at line 1834 of file DebugInfoMetadata.h.

◆ getCopyIdentifierFromDiscriminator()

static unsigned llvm::DILocation::getCopyIdentifierFromDiscriminator ( unsigned  D)
inlinestatic

Returns the copy identifier for a given encoded discriminator D.

Definition at line 1450 of file DebugInfoMetadata.h.

◆ getDuplicationFactor()

unsigned llvm::DILocation::getDuplicationFactor ( ) const
inline

Returns the duplication factor stored in the discriminator.

Definition at line 1830 of file DebugInfoMetadata.h.

◆ getDuplicationFactorFromDiscriminator()

static unsigned llvm::DILocation::getDuplicationFactorFromDiscriminator ( unsigned  D)
inlinestatic

Returns the duplication factor for a given encoded discriminator D.

Definition at line 1441 of file DebugInfoMetadata.h.

◆ getMergedLocation()

const DILocation * DILocation::getMergedLocation ( const DILocation LocA,
const DILocation LocB,
const Instruction ForInst = nullptr 
)
static

When two instructions are combined into a single instruction we also need to combine the original locations into a single location.

When the locations are the same we can use either location. When they differ, we need a third location which is distinct from either. If they have the same file/line but have a different discriminator we could create a location with a new discriminator. If they are from different files/lines the location is ambiguous and can't be represented in a single line entry. In this case, no location should be set, unless the merged instruction is a call, which we will set the merged debug location as line 0 of the nearest common scope where 2 locations are inlined from. This only applies to Instruction; for MachineInstruction, as it is post-inline, we will treat the call instruction the same way as other instructions.

ForInst: The Instruction the merged DILocation is for. If the Instruction is unavailable or non-existent, use nullptr.

Definition at line 72 of file DebugInfoMetadata.cpp.

References llvm::SmallPtrSetImpl< PtrType >::count(), llvm::MDNode::get(), llvm::MDNode::getContext(), and llvm::SmallPtrSetImpl< PtrType >::insert().

Referenced by llvm::Instruction::applyMergedLocation(), llvm::MachineBasicBlock::findBranchDebugLoc(), mergeOperations(), and updateOperand().

◆ getRawInlinedAt()

Metadata* llvm::DILocation::getRawInlinedAt ( ) const
inline

Definition at line 1457 of file DebugInfoMetadata.h.

Referenced by isDINode(), and llvm::MDNodeKeyImpl< DILocation >::isKeyOf().

◆ getRawScope()

Metadata* llvm::DILocation::getRawScope ( ) const
inline

◆ replaceOperandWith()

void llvm::DILocation::replaceOperandWith ( unsigned  I,
Metadata New 
)
delete

◆ setBaseDiscriminator()

const DILocation * llvm::DILocation::setBaseDiscriminator ( unsigned  BD) const
inline

Returns a new DILocation with updated base discriminator BD.

Definition at line 1838 of file DebugInfoMetadata.h.

Referenced by addDiscriminators().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 1265 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 1266 of file DebugInfoMetadata.h.

Member Data Documentation

◆ Column

unsigned unsigned llvm::DILocation::Column

Definition at line 1322 of file DebugInfoMetadata.h.

◆ InlinedAt

unsigned unsigned DILocalScope DILocation* llvm::DILocation::InlinedAt

Definition at line 1323 of file DebugInfoMetadata.h.

◆ Line

unsigned llvm::DILocation::Line

Definition at line 1322 of file DebugInfoMetadata.h.

◆ Scope

unsigned unsigned DILocalScope* llvm::DILocation::Scope

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