LLVM  14.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
llvm::DebugHandlerBase Class Referenceabstract

Base class for debug information backends. More...

#include "llvm/CodeGen/DebugHandlerBase.h"

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

Public Member Functions

void beginModule (Module *M) override
 
void beginInstruction (const MachineInstr *MI) override
 Process beginning of an instruction. More...
 
void endInstruction () override
 Process end of an instruction. More...
 
void beginFunction (const MachineFunction *MF) override
 Gather pre-function debug information. More...
 
void endFunction (const MachineFunction *MF) override
 Gather post-function debug information. More...
 
void beginBasicBlock (const MachineBasicBlock &MBB) override
 Process beginning of a basic block during basic block sections. More...
 
void endBasicBlock (const MachineBasicBlock &MBB) override
 Process end of a basic block during basic block sections. More...
 
MCSymbolgetLabelBeforeInsn (const MachineInstr *MI)
 Return Label preceding the instruction. More...
 
MCSymbolgetLabelAfterInsn (const MachineInstr *MI)
 Return Label immediately following the instruction. More...
 
const InstructionOrderinggetInstOrdering () const
 
- Public Member Functions inherited from llvm::AsmPrinterHandler
virtual ~AsmPrinterHandler ()
 Pin vtable to this file. More...
 
virtual void setSymbolSize (const MCSymbol *Sym, uint64_t Size)=0
 For symbols that have a size designated (e.g. More...
 
virtual void endModule ()=0
 Emit all sections that should come after the content. More...
 
virtual void markFunctionEnd ()
 
virtual void beginFragment (const MachineBasicBlock *MBB, ExceptionSymbolProvider ESP)
 
virtual void endFragment ()
 
virtual void beginFunclet (const MachineBasicBlock &MBB, MCSymbol *Sym=nullptr)
 Emit target-specific EH funclet machinery. More...
 
virtual void endFunclet ()
 

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. More...
 
static bool isUnsignedDIType (const DIType *Ty)
 Return true if type encoding is unsigned. More...
 

Protected Member Functions

 DebugHandlerBase (AsmPrinter *A)
 
void identifyScopeMarkers ()
 Indentify instructions that are marking the beginning of or ending of a scope. More...
 
void requestLabelBeforeInsn (const MachineInstr *MI)
 Ensure that a label will be emitted before MI. More...
 
void requestLabelAfterInsn (const MachineInstr *MI)
 Ensure that a label will be emitted after MI. More...
 
virtual void beginFunctionImpl (const MachineFunction *MF)=0
 
virtual void endFunctionImpl (const MachineFunction *MF)=0
 
virtual void skippedNonDebugFunction ()
 

Protected Attributes

AsmPrinterAsm
 Target of debug info emission. More...
 
MachineModuleInfoMMI
 Collected machine module information. More...
 
DebugLoc PrevInstLoc
 Previous instruction's location information. More...
 
MCSymbolPrevLabel = nullptr
 
const MachineBasicBlockPrevInstBB = nullptr
 
DebugLoc PrologEndLoc
 This location indicates end of function prologue and beginning of function body. More...
 
const MachineInstrCurMI = nullptr
 If nonnull, stores the current machine instruction we're processing. More...
 
LexicalScopes LScopes
 
DbgValueHistoryMap DbgValues
 History of DBG_VALUE and clobber instructions for each user variable. More...
 
DbgLabelInstrMap DbgLabels
 Mapping of inlined labels and DBG_LABEL machine instruction. More...
 
DenseMap< const MachineInstr *, MCSymbol * > LabelsBeforeInsn
 Maps instruction with label emitted before instruction. More...
 
DenseMap< const MachineInstr *, MCSymbol * > LabelsAfterInsn
 Maps instruction with label emitted after instruction. More...
 

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 102 of file DebugHandlerBase.cpp.

Member Function Documentation

◆ beginBasicBlock()

void DebugHandlerBase::beginBasicBlock ( const MachineBasicBlock MBB)
overridevirtual

Process beginning of a basic block during basic block sections.

Reimplemented from llvm::AsmPrinterHandler.

Definition at line 418 of file DebugHandlerBase.cpp.

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

◆ beginFunction()

void DebugHandlerBase::beginFunction ( const MachineFunction MF)
overridevirtual

◆ beginFunctionImpl()

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

◆ beginInstruction()

void DebugHandlerBase::beginInstruction ( const MachineInstr MI)
overridevirtual

◆ beginModule()

void DebugHandlerBase::beginModule ( Module M)
overridevirtual

Reimplemented from llvm::AsmPrinterHandler.

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

Definition at line 104 of file DebugHandlerBase.cpp.

References Asm, and M.

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

◆ endBasicBlock()

void DebugHandlerBase::endBasicBlock ( const MachineBasicBlock MBB)
overridevirtual

Process end of a basic block during basic block sections.

Reimplemented from llvm::AsmPrinterHandler.

Definition at line 425 of file DebugHandlerBase.cpp.

References llvm::MachineBasicBlock::isEndSection(), MBB, and PrevLabel.

◆ endFunction()

void DebugHandlerBase::endFunction ( const MachineFunction MF)
overridevirtual

Gather post-function debug information.

Please note that some AsmPrinter implementations may not call beginFunction at all.

Implements llvm::AsmPrinterHandler.

Definition at line 408 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::DwarfDebug, llvm::BTFDebug, and llvm::CodeViewDebug.

Referenced by endFunction().

◆ endInstruction()

void DebugHandlerBase::endInstruction ( )
overridevirtual

◆ 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 148 of file DebugHandlerBase.cpp.

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

◆ getInstOrdering()

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

Definition at line 141 of file DebugHandlerBase.h.

◆ getLabelAfterInsn()

MCSymbol * DebugHandlerBase::getLabelAfterInsn ( const MachineInstr MI)

Return Label immediately following the instruction.

Definition at line 143 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 136 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 113 of file DebugHandlerBase.cpp.

References llvm::SmallVectorImpl< T >::append(), assert(), llvm::LexicalScopes::getCurrentFunctionScope(), LScopes, llvm::SmallVectorImpl< T >::pop_back_val(), requestLabelAfterInsn(), requestLabelBeforeInsn(), and S.

Referenced by beginFunction().

◆ isUnsignedDIType()

bool DebugHandlerBase::isUnsignedDIType ( const DIType Ty)
static

Return true if type encoding is unsigned.

Definition at line 176 of file DebugHandlerBase.cpp.

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

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

◆ requestLabelAfterInsn()

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

Ensure that a label will be emitted after MI.

Definition at line 105 of file DebugHandlerBase.h.

References LabelsAfterInsn, and MI.

Referenced by 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 100 of file DebugHandlerBase.h.

References LabelsBeforeInsn, and MI.

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

◆ skippedNonDebugFunction()

virtual void llvm::DebugHandlerBase::skippedNonDebugFunction ( )
inlineprotectedvirtual

Reimplemented in llvm::DwarfDebug.

Definition at line 111 of file DebugHandlerBase.h.

Referenced by beginFunction().

Member Data Documentation

◆ Asm

AsmPrinter* llvm::DebugHandlerBase::Asm
protected

◆ CurMI

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

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

Definition at line 76 of file DebugHandlerBase.h.

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

◆ DbgLabels

DbgLabelInstrMap llvm::DebugHandlerBase::DbgLabels
protected

Mapping of inlined labels and DBG_LABEL machine instruction.

Definition at line 85 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 82 of file DebugHandlerBase.h.

Referenced by beginFunction(), and endFunction().

◆ LabelsAfterInsn

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

Maps instruction with label emitted after instruction.

Definition at line 93 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 90 of file DebugHandlerBase.h.

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

◆ LScopes

LexicalScopes llvm::DebugHandlerBase::LScopes
protected

◆ MMI

MachineModuleInfo* llvm::DebugHandlerBase::MMI
protected

◆ PrevInstBB

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

◆ 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 llvm::BTFDebug::beginInstruction(), and llvm::DwarfDebug::beginInstruction().

◆ PrevLabel

MCSymbol* llvm::DebugHandlerBase::PrevLabel = nullptr
protected

◆ 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: