LLVM 24.0.0git
Public Types | Public Member Functions | List of all members
llvm::DebugInfoFinder Class Reference

Utility to find all debug info in a module. More...

#include "llvm/IR/DebugInfo.h"

Public Types

using DIMacroEntry = std::pair<DIMacro *, DIMacroFile *>
using compile_unit_iterator
using subprogram_iterator = SmallVectorImpl<DISubprogram *>::const_iterator
using global_variable_expression_iterator
using type_iterator = SmallVectorImpl<DIType *>::const_iterator
using scope_iterator = SmallVectorImpl<DIScope *>::const_iterator
using macro_iterator = SmallVectorImpl<DIMacroEntry>::const_iterator

Public Member Functions

LLVM_ABI void processModule (const Module &M)
 Process entire module and collect debug info anchors.
LLVM_ABI void processInstruction (const Module &M, const Instruction &I)
 Process a single instruction and collect debug info anchors.
LLVM_ABI void processVariable (const DILocalVariable *DVI)
 Process a DILocalVariable.
LLVM_ABI void processLocation (const Module &M, const DILocation *Loc)
 Process debug info location.
LLVM_ABI void processDbgRecord (const Module &M, const DbgRecord &DR)
 Process a DbgRecord.
LLVM_ABI void processSubprogram (DISubprogram *SP)
 Process subprogram.
LLVM_ABI void reset ()
 Clear all lists.
iterator_range< compile_unit_iterator > compile_units () const
iterator_range< subprogram_iterator > subprograms () const
iterator_range< global_variable_expression_iterator > global_variables () const
iterator_range< type_iterator > types () const
iterator_range< scope_iterator > scopes () const
iterator_range< macro_iterator > macros () const
unsigned compile_unit_count () const
unsigned global_variable_count () const
unsigned subprogram_count () const
unsigned type_count () const
unsigned scope_count () const
unsigned macro_count () const

Detailed Description

Utility to find all debug info in a module.

DebugInfoFinder tries to list all debug info MDNodes used in a module. To list debug info MDNodes used by an instruction, DebugInfoFinder uses processDeclare, processValue and processLocation to handle DbgDeclareInst, DbgValueInst and DbgLoc attached to instructions. processModule will go through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes used by the CUs.

Definition at line 105 of file DebugInfo.h.

Member Typedef Documentation

◆ compile_unit_iterator

using llvm::DebugInfoFinder::compile_unit_iterator
Initial value:
SmallVectorImpl<DICompileUnit *>::const_iterator
llvm::SmallVectorImpl::const_iterator
typename SuperClass::const_iterator const_iterator
Definition SmallVector.h:597

Definition at line 142 of file DebugInfo.h.

◆ DIMacroEntry

using llvm::DebugInfoFinder::DIMacroEntry = std::pair<DIMacro *, DIMacroFile *>

Definition at line 141 of file DebugInfo.h.

◆ global_variable_expression_iterator

using llvm::DebugInfoFinder::global_variable_expression_iterator
Initial value:
SmallVectorImpl<DIGlobalVariableExpression *>::const_iterator

Definition at line 145 of file DebugInfo.h.

◆ macro_iterator

using llvm::DebugInfoFinder::macro_iterator = SmallVectorImpl<DIMacroEntry>::const_iterator

Definition at line 149 of file DebugInfo.h.

◆ scope_iterator

using llvm::DebugInfoFinder::scope_iterator = SmallVectorImpl<DIScope *>::const_iterator

Definition at line 148 of file DebugInfo.h.

◆ subprogram_iterator

using llvm::DebugInfoFinder::subprogram_iterator = SmallVectorImpl<DISubprogram *>::const_iterator

Definition at line 144 of file DebugInfo.h.

◆ type_iterator

using llvm::DebugInfoFinder::type_iterator = SmallVectorImpl<DIType *>::const_iterator

Definition at line 147 of file DebugInfo.h.

Member Function Documentation

◆ compile_unit_count()

unsigned llvm::DebugInfoFinder::compile_unit_count ( ) const
inline

Definition at line 165 of file DebugInfo.h.

◆ compile_units()

iterator_range< compile_unit_iterator > llvm::DebugInfoFinder::compile_units ( ) const
inline

Definition at line 151 of file DebugInfo.h.

Referenced by llvm::CloneFunctionInto(), printModuleDebugInfo(), llvm::dxil::DXILDebugInfoPass::run(), and stripDeadDebugInfoImpl().

◆ global_variable_count()

unsigned llvm::DebugInfoFinder::global_variable_count ( ) const
inline

Definition at line 166 of file DebugInfo.h.

◆ global_variables()

iterator_range< global_variable_expression_iterator > llvm::DebugInfoFinder::global_variables ( ) const
inline

Definition at line 155 of file DebugInfo.h.

Referenced by printModuleDebugInfo(), and llvm::dxil::DXILDebugInfoPass::run().

◆ macro_count()

unsigned llvm::DebugInfoFinder::macro_count ( ) const
inline

Definition at line 170 of file DebugInfo.h.

◆ macros()

iterator_range< macro_iterator > llvm::DebugInfoFinder::macros ( ) const
inline

Definition at line 163 of file DebugInfo.h.

Referenced by printModuleDebugInfo().

◆ processDbgRecord()

void DebugInfoFinder::processDbgRecord ( const Module & M,
const DbgRecord & DR )

Process a DbgRecord.

Definition at line 243 of file DebugInfo.cpp.

References llvm::dyn_cast(), llvm::DebugLoc::get(), llvm::DbgRecord::getDebugLoc(), processLocation(), and processVariable().

Referenced by processInstruction().

◆ processInstruction()

void DebugInfoFinder::processInstruction ( const Module & M,
const Instruction & I )

Process a single instruction and collect debug info anchors.

Definition at line 224 of file DebugInfo.cpp.

References llvm::dyn_cast(), I, processDbgRecord(), processLocation(), and processVariable().

Referenced by collectDebugInfoFromInstructions(), processModule(), and stripDeadDebugInfoImpl().

◆ processLocation()

void DebugInfoFinder::processLocation ( const Module & M,
const DILocation * Loc )

Process debug info location.

Definition at line 236 of file DebugInfo.cpp.

References processLocation().

Referenced by processDbgRecord(), processInstruction(), and processLocation().

◆ processModule()

void DebugInfoFinder::processModule ( const Module & M)

Process entire module and collect debug info anchors.

Definition at line 183 of file DebugInfo.cpp.

References llvm::cast_or_null(), F, I, processInstruction(), and processSubprogram().

Referenced by llvm::SPIRVNonSemanticDebugHandler::beginModule(), and llvm::dxil::DXILDebugInfoPass::run().

◆ processSubprogram()

void DebugInfoFinder::processSubprogram ( DISubprogram * SP)

Process subprogram.

Definition at line 389 of file DebugInfo.cpp.

References llvm::dyn_cast(), processVariable(), and T.

Referenced by processModule(), and stripDeadDebugInfoImpl().

◆ processVariable()

void DebugInfoFinder::processVariable ( const DILocalVariable * DVI)

Process a DILocalVariable.

Definition at line 418 of file DebugInfo.cpp.

References llvm::DILocalVariable::getScope(), and llvm::DIVariable::getType().

Referenced by processDbgRecord(), processInstruction(), and processSubprogram().

◆ reset()

void DebugInfoFinder::reset ( )

Clear all lists.

Definition at line 173 of file DebugInfo.cpp.

Referenced by llvm::dxil::DXILDebugInfoPass::run().

◆ scope_count()

unsigned llvm::DebugInfoFinder::scope_count ( ) const
inline

Definition at line 169 of file DebugInfo.h.

◆ scopes()

iterator_range< scope_iterator > llvm::DebugInfoFinder::scopes ( ) const
inline

Definition at line 161 of file DebugInfo.h.

Referenced by llvm::dxil::DXILDebugInfoPass::run().

◆ subprogram_count()

unsigned llvm::DebugInfoFinder::subprogram_count ( ) const
inline

Definition at line 167 of file DebugInfo.h.

◆ subprograms()

iterator_range< subprogram_iterator > llvm::DebugInfoFinder::subprograms ( ) const
inline

Definition at line 153 of file DebugInfo.h.

Referenced by llvm::SPIRVNonSemanticDebugHandler::beginModule(), printModuleDebugInfo(), and llvm::dxil::DXILDebugInfoPass::run().

◆ type_count()

unsigned llvm::DebugInfoFinder::type_count ( ) const
inline

Definition at line 168 of file DebugInfo.h.

◆ types()

iterator_range< type_iterator > llvm::DebugInfoFinder::types ( ) const
inline

Definition at line 159 of file DebugInfo.h.

Referenced by llvm::SPIRVNonSemanticDebugHandler::beginModule(), printModuleDebugInfo(), and llvm::dxil::DXILDebugInfoPass::run().

The documentation for this class was generated from the following files:
Generated on for LLVM by doxygen 1.14.0