Base class for debug information backends. More...

#include "llvm/CodeGen/DebugHandlerBase.h"

Inheritance diagram for llvm::DebugHandlerBase:

[legend]

Public Member Functions
void	beginModule (Module *M) override

void	beginInstruction (const MachineInstr *MI) override
	Process beginning of an instruction.

void	endInstruction () override
	Process end of an instruction.

void	beginFunction (const MachineFunction *MF) override
	Gather pre-function debug information.

void	endFunction (const MachineFunction *MF) override
	Gather post-function debug information.

void	beginBasicBlockSection (const MachineBasicBlock &MBB) override
	Process the beginning of a new basic-block-section within a function.

void	endBasicBlockSection (const MachineBasicBlock &MBB) override
	Process the end of a basic-block-section within a function.

MCSymbol *	getLabelBeforeInsn (const MachineInstr *MI)
	Return Label preceding the instruction.

MCSymbol *	getLabelAfterInsn (const MachineInstr *MI)
	Return Label immediately following the instruction.

const InstructionOrdering &	getInstOrdering () const

Public Member Functions inherited from llvm::AsmPrinterHandler
virtual	~AsmPrinterHandler ()
	Pin vtable to this file.

virtual void	setSymbolSize (const MCSymbol *Sym, uint64_t Size)=0
	For symbols that have a size designated (e.g.

virtual void	beginModule (Module *M)

virtual void	endModule ()=0
	Emit all sections that should come after the content.

virtual void	beginFunction (const MachineFunction *MF)=0
	Gather pre-function debug information.

virtual void	markFunctionEnd ()

virtual void	endFunction (const MachineFunction *MF)=0
	Gather post-function debug information.

virtual void	beginBasicBlockSection (const MachineBasicBlock &MBB)
	Process the beginning of a new basic-block-section within a function.

virtual void	endBasicBlockSection (const MachineBasicBlock &MBB)
	Process the end of a basic-block-section within a function.

virtual void	beginFunclet (const MachineBasicBlock &MBB, MCSymbol *Sym=nullptr)
	Emit target-specific EH funclet machinery.

virtual void	endFunclet ()

virtual void	beginInstruction (const MachineInstr *MI)=0
	Process beginning of an instruction.

virtual void	endInstruction ()=0
	Process end of an instruction.

Static Public Member Functions
static uint64_t	getBaseTypeSize (const DIType *Ty)
	If this type is derived from a base type then return base type size.

static bool	isUnsignedDIType (const DIType *Ty)
	Return true if type encoding is unsigned.

Protected Member Functions
	DebugHandlerBase (AsmPrinter *A)

void	identifyScopeMarkers ()
	Indentify instructions that are marking the beginning of or ending of a scope.

void	requestLabelBeforeInsn (const MachineInstr *MI)
	Ensure that a label will be emitted before MI.

void	requestLabelAfterInsn (const MachineInstr *MI)
	Ensure that a label will be emitted after MI.

virtual void	beginFunctionImpl (const MachineFunction *MF)=0

virtual void	endFunctionImpl (const MachineFunction *MF)=0

virtual void	skippedNonDebugFunction ()

Protected Attributes
AsmPrinter *	Asm = nullptr
	Target of debug info emission.

MachineModuleInfo *	MMI = nullptr
	Collected machine module information.

DebugLoc	PrevInstLoc
	Previous instruction's location information.

MCSymbol *	PrevLabel = nullptr

const MachineBasicBlock *	PrevInstBB = nullptr

DebugLoc	PrologEndLoc
	This location indicates end of function prologue and beginning of function body.

const MachineBasicBlock *	EpilogBeginBlock = nullptr
	This block includes epilogue instructions.

const MachineInstr *	CurMI = nullptr
	If nonnull, stores the current machine instruction we're processing.

LexicalScopes	LScopes

DbgValueHistoryMap	DbgValues
	History of DBG_VALUE and clobber instructions for each user variable.

DbgLabelInstrMap	DbgLabels
	Mapping of inlined labels and DBG_LABEL machine instruction.

DenseMap< const MachineInstr , MCSymbol >	LabelsBeforeInsn
	Maps instruction with label emitted before instruction.

DenseMap< const MachineInstr , MCSymbol >	LabelsAfterInsn
	Maps instruction with label emitted after instruction.

Detailed Description

Base class for debug information backends.

Common functionality related to tracking which variables and scopes are alive at a given PC live here.

Definition at line 53 of file DebugHandlerBase.h.

Constructor & Destructor Documentation

◆ DebugHandlerBase()

DebugHandlerBase::DebugHandlerBase ( AsmPrinter * A )

protected

Definition at line 100 of file DebugHandlerBase.cpp.

Member Function Documentation

◆ beginBasicBlockSection()

void DebugHandlerBase::beginBasicBlockSection ( const MachineBasicBlock & MBB )

overridevirtual

Process the beginning of a new basic-block-section within a function.

Always called immediately after beginFunction for the first basic-block. When basic-block-sections are enabled, called before the first block of each such section.

Reimplemented from llvm::AsmPrinterHandler.

Definition at line 419 of file DebugHandlerBase.cpp.

References EpilogBeginBlock, llvm::MachineBasicBlock::getSymbol(), llvm::MachineBasicBlock::isEntryBlock(), MBB, and PrevLabel.

◆ beginFunction()

void DebugHandlerBase::beginFunction ( const MachineFunction * MF )

overridevirtual

Gather pre-function debug information.

Every beginFunction(MF) call should be followed by an endFunction(MF) call.

Implements llvm::AsmPrinterHandler.

Definition at line 250 of file DebugHandlerBase.cpp.

References llvm::any_of(), Asm, assert(), beginFunctionImpl(), llvm::calculateDbgEntityHistory(), DbgLabels, DbgValues, llvm::DbgValueHistoryMap::dump(), llvm::LexicalScopes::empty(), llvm::DbgValueHistoryMap::empty(), llvm::DbgLabelInstrMap::empty(), llvm::getDISubprogram(), llvm::MachineFunction::getFunction(), llvm::AsmPrinter::getFunctionBegin(), llvm::MachineFunction::getName(), llvm::TargetSubtargetInfo::getRegisterInfo(), llvm::DILocalVariable::getScope(), llvm::MachineFunction::getSubtarget(), hasDebugInfo(), I, identifyScopeMarkers(), llvm::LexicalScopes::initialize(), llvm::InstructionOrdering::initialize(), llvm::DILocalVariable::isParameter(), LabelsBeforeInsn, LLVM_DEBUG, LScopes, llvm::AsmPrinter::MF, MI, MMI, PrevInstBB, PrevInstLoc, PrevLabel, requestLabelAfterInsn(), requestLabelBeforeInsn(), skippedNonDebugFunction(), llvm::DbgValueHistoryMap::trimLocationRanges(), and TrimVarLocs.

◆ beginFunctionImpl()

virtual void llvm::DebugHandlerBase::beginFunctionImpl ( const MachineFunction * MF )

protectedpure virtual

Implemented in llvm::CodeViewDebug, llvm::DwarfDebug, and llvm::BTFDebug.

Referenced by beginFunction().

◆ beginInstruction()

void DebugHandlerBase::beginInstruction ( const MachineInstr * MI )

overridevirtual

Process beginning of an instruction.

Implements llvm::AsmPrinterHandler.

Reimplemented in llvm::CodeViewDebug, llvm::DwarfDebug, and llvm::BTFDebug.

Definition at line 348 of file DebugHandlerBase.cpp.

References Asm, assert(), llvm::MCContext::createTempSymbol(), CurMI, llvm::MachineModuleInfo::getContext(), llvm::MachineModuleInfo::hasDebugInfo(), I, LabelsBeforeInsn, MI, MMI, llvm::AsmPrinter::OutStreamer, and PrevLabel.

Referenced by llvm::CodeViewDebug::beginInstruction(), llvm::DwarfDebug::beginInstruction(), and llvm::BTFDebug::beginInstruction().

◆ beginModule()

void DebugHandlerBase::beginModule ( Module * M )

overridevirtual

Reimplemented from llvm::AsmPrinterHandler.

Reimplemented in llvm::CodeViewDebug, and llvm::DwarfDebug.

Definition at line 102 of file DebugHandlerBase.cpp.

References Asm.

Referenced by llvm::DwarfDebug::beginModule().

◆ endBasicBlockSection()

void DebugHandlerBase::endBasicBlockSection ( const MachineBasicBlock & MBB )

overridevirtual

Process the end of a basic-block-section within a function.

When basic-block-sections are enabled, called after the last block in each such section (including the last section in the function). When basic-block-sections are disabled, called at the end of a function, immediately prior to markFunctionEnd.

Reimplemented from llvm::AsmPrinterHandler.

Definition at line 425 of file DebugHandlerBase.cpp.

References PrevLabel.

◆ endFunction()

void DebugHandlerBase::endFunction ( const MachineFunction * MF )

overridevirtual

Gather post-function debug information.

Implements llvm::AsmPrinterHandler.

Definition at line 409 of file DebugHandlerBase.cpp.

References Asm, llvm::InstructionOrdering::clear(), llvm::DbgValueHistoryMap::clear(), llvm::DbgLabelInstrMap::clear(), DbgLabels, DbgValues, endFunctionImpl(), hasDebugInfo(), LabelsAfterInsn, LabelsBeforeInsn, and MMI.

◆ endFunctionImpl()

virtual void llvm::DebugHandlerBase::endFunctionImpl ( const MachineFunction * MF )

protectedpure virtual

Implemented in llvm::CodeViewDebug, llvm::DwarfDebug, and llvm::BTFDebug.

Referenced by endFunction().

◆ endInstruction()

void DebugHandlerBase::endInstruction ( )

overridevirtual

Process end of an instruction.

Implements llvm::AsmPrinterHandler.

Definition at line 374 of file DebugHandlerBase.cpp.

References Asm, assert(), llvm::MCContext::createTempSymbol(), CurMI, llvm::MachineModuleInfo::getContext(), llvm::MachineBasicBlock::getEndSymbol(), llvm::ilist_node_with_parent< NodeTy, ParentTy, Options >::getNextNode(), llvm::MachineInstr::getParent(), llvm::MachineModuleInfo::hasDebugInfo(), I, llvm::MachineBasicBlock::isEndSection(), llvm::MachineInstr::isMetaInstruction(), LabelsAfterInsn, MMI, llvm::AsmPrinter::OutStreamer, PrevInstBB, and PrevLabel.

◆ getBaseTypeSize()

uint64_t DebugHandlerBase::getBaseTypeSize ( const DIType * Ty )

static

If this type is derived from a base type then return base type size.

Definition at line 146 of file DebugHandlerBase.cpp.

References assert(), getBaseTypeSize(), llvm::DIType::getSizeInBits(), and llvm::DINode::getTag().

Referenced by getBaseTypeSize().

◆ getInstOrdering()

const InstructionOrdering & llvm::DebugHandlerBase::getInstOrdering ( ) const

inline

Definition at line 144 of file DebugHandlerBase.h.

◆ getLabelAfterInsn()

MCSymbol * DebugHandlerBase::getLabelAfterInsn ( const MachineInstr * MI )

Return Label immediately following the instruction.

Definition at line 141 of file DebugHandlerBase.cpp.

References LabelsAfterInsn, and MI.

Referenced by llvm::DwarfCompileUnit::attachRangesOrLowHighPC(), llvm::CodeViewDebug::endFunctionImpl(), and llvm::DwarfDebug::isLexicalScopeDIENull().

◆ getLabelBeforeInsn()

MCSymbol * DebugHandlerBase::getLabelBeforeInsn ( const MachineInstr * MI )

Return Label preceding the instruction.

Definition at line 134 of file DebugHandlerBase.cpp.

References assert(), LabelsBeforeInsn, and MI.

Referenced by llvm::DwarfCompileUnit::attachRangesOrLowHighPC(), and llvm::CodeViewDebug::endFunctionImpl().

◆ identifyScopeMarkers()

void DebugHandlerBase::identifyScopeMarkers ( )

protected

Indentify instructions that are marking the beginning of or ending of a scope.

Definition at line 111 of file DebugHandlerBase.cpp.

References llvm::SmallVectorImpl< T >::append(), assert(), llvm::SmallVectorBase< Size_T >::empty(), llvm::LexicalScope::getChildren(), llvm::LexicalScopes::getCurrentFunctionScope(), llvm::LexicalScope::getRanges(), llvm::LexicalScope::isAbstractScope(), LScopes, llvm::SmallVectorImpl< T >::pop_back_val(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), requestLabelAfterInsn(), and requestLabelBeforeInsn().

Referenced by beginFunction().

◆ isUnsignedDIType()

bool DebugHandlerBase::isUnsignedDIType ( const DIType * Ty )

static

Return true if type encoding is unsigned.

Definition at line 175 of file DebugHandlerBase.cpp.

References assert(), llvm::DIType::getName(), llvm::DINode::getTag(), and isUnsignedDIType().

Referenced by llvm::DwarfUnit::addConstantValue(), llvm::DwarfUnit::constructTypeDIE(), and isUnsignedDIType().

◆ requestLabelAfterInsn()

void llvm::DebugHandlerBase::requestLabelAfterInsn ( const MachineInstr * MI )

inlineprotected

Ensure that a label will be emitted after MI.

Definition at line 108 of file DebugHandlerBase.h.

References LabelsAfterInsn, and MI.

Referenced by beginFunction(), llvm::CodeViewDebug::beginFunctionImpl(), llvm::DwarfDebug::beginInstruction(), and identifyScopeMarkers().

◆ requestLabelBeforeInsn()

void llvm::DebugHandlerBase::requestLabelBeforeInsn ( const MachineInstr * MI )

inlineprotected

Ensure that a label will be emitted before MI.

Definition at line 103 of file DebugHandlerBase.h.

References LabelsBeforeInsn, and MI.

Referenced by beginFunction(), llvm::CodeViewDebug::beginFunctionImpl(), llvm::DwarfDebug::beginInstruction(), and identifyScopeMarkers().

◆ skippedNonDebugFunction()

virtual void llvm::DebugHandlerBase::skippedNonDebugFunction ( )

inlineprotectedvirtual

Reimplemented in llvm::DwarfDebug.

Definition at line 114 of file DebugHandlerBase.h.

Referenced by beginFunction().

Member Data Documentation

◆ Asm

AsmPrinter* llvm::DebugHandlerBase::Asm = nullptr

protected

Target of debug info emission.

Definition at line 58 of file DebugHandlerBase.h.

◆ CurMI

const MachineInstr* llvm::DebugHandlerBase::CurMI = nullptr

protected

If nonnull, stores the current machine instruction we're processing.

Definition at line 79 of file DebugHandlerBase.h.

Referenced by beginInstruction(), llvm::DwarfDebug::beginInstruction(), llvm::BTFDebug::beginInstruction(), endInstruction(), and llvm::DwarfDebug::endModule().

◆ DbgLabels

DbgLabelInstrMap llvm::DebugHandlerBase::DbgLabels

protected

Mapping of inlined labels and DBG_LABEL machine instruction.

Definition at line 88 of file DebugHandlerBase.h.

Referenced by beginFunction(), and endFunction().

◆ DbgValues

DbgValueHistoryMap llvm::DebugHandlerBase::DbgValues

protected

History of DBG_VALUE and clobber instructions for each user variable.

Variables are listed in order of appearance.

Definition at line 85 of file DebugHandlerBase.h.

Referenced by beginFunction(), and endFunction().

◆ EpilogBeginBlock

const MachineBasicBlock* llvm::DebugHandlerBase::EpilogBeginBlock = nullptr

protected

This block includes epilogue instructions.

Definition at line 76 of file DebugHandlerBase.h.

Referenced by beginBasicBlockSection(), and llvm::DwarfDebug::beginInstruction().

◆ LabelsAfterInsn

DenseMap<const MachineInstr *, MCSymbol *> llvm::DebugHandlerBase::LabelsAfterInsn

protected

Maps instruction with label emitted after instruction.

Definition at line 96 of file DebugHandlerBase.h.

Referenced by endFunction(), endInstruction(), getLabelAfterInsn(), and requestLabelAfterInsn().

◆ LabelsBeforeInsn

DenseMap<const MachineInstr *, MCSymbol *> llvm::DebugHandlerBase::LabelsBeforeInsn

protected

Maps instruction with label emitted before instruction.

FIXME: Make this private from DwarfDebug, we have the necessary accessors for it.

Definition at line 93 of file DebugHandlerBase.h.

Referenced by beginFunction(), beginInstruction(), endFunction(), getLabelBeforeInsn(), and requestLabelBeforeInsn().

◆ LScopes

LexicalScopes llvm::DebugHandlerBase::LScopes

protected

Definition at line 81 of file DebugHandlerBase.h.

Referenced by beginFunction(), llvm::DwarfDebug::beginFunctionImpl(), llvm::CodeViewDebug::endFunctionImpl(), llvm::DwarfDebug::endFunctionImpl(), and identifyScopeMarkers().

◆ MMI

MachineModuleInfo* llvm::DebugHandlerBase::MMI = nullptr

protected

Collected machine module information.

Definition at line 61 of file DebugHandlerBase.h.

Referenced by beginFunction(), llvm::CodeViewDebug::beginFunctionImpl(), beginInstruction(), llvm::CodeViewDebug::beginModule(), llvm::DwarfDebug::beginModule(), llvm::DwarfDebug::DwarfDebug(), endFunction(), llvm::CodeViewDebug::endFunctionImpl(), endInstruction(), llvm::CodeViewDebug::endModule(), and llvm::DwarfDebug::endModule().

◆ PrevInstBB

const MachineBasicBlock* llvm::DebugHandlerBase::PrevInstBB = nullptr

protected

Definition at line 69 of file DebugHandlerBase.h.

Referenced by beginFunction(), llvm::CodeViewDebug::beginInstruction(), llvm::DwarfDebug::beginInstruction(), and endInstruction().

◆ PrevInstLoc

DebugLoc llvm::DebugHandlerBase::PrevInstLoc

protected

Previous instruction's location information.

This is used to determine label location to indicate scope boundaries in debug info. We track the previous instruction's source location (if not line 0), whether it was a label, and its parent BB.

Definition at line 67 of file DebugHandlerBase.h.

Referenced by beginFunction(), llvm::DwarfDebug::beginInstruction(), and llvm::BTFDebug::beginInstruction().

◆ PrevLabel

MCSymbol* llvm::DebugHandlerBase::PrevLabel = nullptr

protected

Definition at line 68 of file DebugHandlerBase.h.

Referenced by beginBasicBlockSection(), beginFunction(), beginInstruction(), llvm::DwarfDebug::beginInstruction(), endBasicBlockSection(), llvm::DwarfDebug::endFunctionImpl(), and endInstruction().

◆ PrologEndLoc

DebugLoc llvm::DebugHandlerBase::PrologEndLoc

protected

This location indicates end of function prologue and beginning of function body.

Definition at line 73 of file DebugHandlerBase.h.

Referenced by llvm::CodeViewDebug::beginFunctionImpl(), llvm::DwarfDebug::beginFunctionImpl(), llvm::DwarfDebug::beginInstruction(), and llvm::DwarfDebug::emitInitialLocDirective().

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

include/llvm/CodeGen/DebugHandlerBase.h
lib/CodeGen/AsmPrinter/DebugHandlerBase.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DebugHandlerBase()

Member Function Documentation

◆ beginBasicBlockSection()

◆ beginFunction()

◆ beginFunctionImpl()

◆ beginInstruction()

◆ beginModule()

◆ endBasicBlockSection()

◆ endFunction()

◆ endFunctionImpl()

◆ endInstruction()

◆ getBaseTypeSize()

◆ getInstOrdering()

◆ getLabelAfterInsn()

◆ getLabelBeforeInsn()

◆ identifyScopeMarkers()

◆ isUnsignedDIType()

◆ requestLabelAfterInsn()

◆ requestLabelBeforeInsn()

◆ skippedNonDebugFunction()

Member Data Documentation

◆ Asm

◆ CurMI

◆ DbgLabels

◆ DbgValues

◆ EpilogBeginBlock

◆ LabelsAfterInsn

◆ LabelsBeforeInsn

◆ LScopes

◆ MMI

◆ PrevInstBB

◆ PrevInstLoc

◆ PrevLabel

◆ PrologEndLoc