This class gathers all debug information during compilation and is responsible for emitting to llvm globals or pass directly to the backend. More...

#include "/opt/doxygen-docs/src/llvm/tools/clang/lib/CodeGen/CGDebugInfo.h"

Public Member Functions
	CGDebugInfo (CodeGenModule &CGM)

	~CGDebugInfo ()

void	finalize ()

void	registerVLASizeExpression (QualType Ty, llvm::Metadata *SizeExpr)
	Register VLA size expression debug node with the qualified type. More...

void	setLocation (SourceLocation Loc)
	Update the current source location. More...

SourceLocation	getLocation () const
	Return the current source location. More...

void	setInlinedAt (llvm::MDNode *InlinedAt)
	Update the current inline scope. More...

llvm::MDNode *	getInlinedAt () const

llvm::DebugLoc	SourceLocToDebugLoc (SourceLocation Loc)

void	EmitLocation (CGBuilderTy &Builder, SourceLocation Loc)
	Emit metadata to indicate a change in line/column information in the source file. More...

void	EmitFunctionStart (GlobalDecl GD, SourceLocation Loc, SourceLocation ScopeLoc, QualType FnType, llvm::Function *Fn, bool CurFnIsThunk, CGBuilderTy &Builder)
	Emit a call to llvm.dbg.function.start to indicate start of a new function. More...

void	EmitInlineFunctionStart (CGBuilderTy &Builder, GlobalDecl GD)
	Start a new scope for an inlined function. More...

void	EmitInlineFunctionEnd (CGBuilderTy &Builder)
	End an inlined function scope. More...

void	EmitFunctionDecl (GlobalDecl GD, SourceLocation Loc, QualType FnType)
	Emit debug info for a function declaration. More...

void	EmitFunctionEnd (CGBuilderTy &Builder, llvm::Function *Fn)
	Constructs the debug code for exiting a function. More...

void	EmitLexicalBlockStart (CGBuilderTy &Builder, SourceLocation Loc)
	Emit metadata to indicate the beginning of a new lexical block and push the block onto the stack. More...

void	EmitLexicalBlockEnd (CGBuilderTy &Builder, SourceLocation Loc)
	Emit metadata to indicate the end of a new lexical block and pop the current block. More...

llvm::DILocalVariable *	EmitDeclareOfAutoVariable (const VarDecl Decl, llvm::Value AI, CGBuilderTy &Builder)
	Emit call to `llvm.dbg.declare` for an automatic variable declaration. More...

void	EmitDeclareOfBlockDeclRefVariable (const VarDecl variable, llvm::Value storage, CGBuilderTy &Builder, const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint=nullptr)
	Emit call to `llvm.dbg.declare` for an imported variable declaration in a block. More...

void	EmitDeclareOfArgVariable (const VarDecl Decl, llvm::Value AI, unsigned ArgNo, CGBuilderTy &Builder)
	Emit call to `llvm.dbg.declare` for an argument variable declaration. More...

void	EmitDeclareOfBlockLiteralArgVariable (const CGBlockInfo &block, StringRef Name, unsigned ArgNo, llvm::AllocaInst *LocalAddr, CGBuilderTy &Builder)
	Emit call to `llvm.dbg.declare` for the block-literal argument to a block invocation function. More...

void	EmitGlobalVariable (llvm::GlobalVariable GV, const VarDecl Decl)
	Emit information about a global variable. More...

void	EmitGlobalVariable (const ValueDecl *VD, const APValue &Init)
	Emit a constant global variable's debug info. More...

void	EmitUsingDirective (const UsingDirectiveDecl &UD)
	Emit C++ using directive. More...

void	EmitExplicitCastType (QualType Ty)
	Emit the type explicitly casted to. More...

void	EmitUsingDecl (const UsingDecl &UD)
	Emit C++ using declaration. More...

void	EmitImportDecl (const ImportDecl &ID)
	Emit an declaration. More...

llvm::DIImportedEntity *	EmitNamespaceAlias (const NamespaceAliasDecl &NA)
	Emit C++ namespace alias. More...

llvm::DIType *	getOrCreateRecordType (QualType Ty, SourceLocation L)
	Emit record type's standalone debug info. More...

llvm::DIType *	getOrCreateInterfaceType (QualType Ty, SourceLocation Loc)
	Emit an Objective-C interface type standalone debug info. More...

llvm::DIType *	getOrCreateStandaloneType (QualType Ty, SourceLocation Loc)
	Emit standalone debug info for a type. More...

void	completeType (const EnumDecl *ED)

void	completeType (const RecordDecl *RD)

void	completeRequiredType (const RecordDecl *RD)

void	completeClassData (const RecordDecl *RD)

void	completeClass (const RecordDecl *RD)

void	completeTemplateDefinition (const ClassTemplateSpecializationDecl &SD)

void	completeUnusedClass (const CXXRecordDecl &D)

llvm::DIMacro *	CreateMacro (llvm::DIMacroFile *Parent, unsigned MType, SourceLocation LineLoc, StringRef Name, StringRef Value)
	Create debug info for a macro defined by a #define directive or a macro undefined by a #undef directive. More...

llvm::DIMacroFile *	CreateTempMacroFile (llvm::DIMacroFile *Parent, SourceLocation LineLoc, SourceLocation FileLoc)
	Create debug info for a file referenced by an #include directive. More...


void	setDwoId (uint64_t Signature)
	Module debugging: Support for building PCMs. More...

void	setModuleMap (ModuleMap &MMap)
	When generating debug information for a clang module or precompiled header, this module map will be used to determine the module of origin of each Decl. More...

void	setPCHDescriptor (ExternalASTSource::ASTSourceDescriptor PCH)
	When generating debug information for a clang module or precompiled header, this module map will be used to determine the module of origin of each Decl. More...

Friends
class	ApplyDebugLocation

class	SaveAndRestoreLocation

Detailed Description

This class gathers all debug information during compilation and is responsible for emitting to llvm globals or pass directly to the backend.

Definition at line 54 of file CGDebugInfo.h.

Constructor & Destructor Documentation

◆ CGDebugInfo()

CGDebugInfo::CGDebugInfo ( CodeGenModule & CGM )

Definition at line 64 of file CGDebugInfo.cpp.

References clang::CodeGenOptions::DebugPrefixMap, and clang::CodeGen::CodeGenModule::getCodeGenOpts().

◆ ~CGDebugInfo()

CGDebugInfo::~CGDebugInfo ( )

Definition at line 73 of file CGDebugInfo.cpp.

Member Function Documentation

◆ completeClass()

void CGDebugInfo::completeClass ( const RecordDecl * RD )

Definition at line 1922 of file CGDebugInfo.cpp.

References clang::codegenoptions::DebugLineTablesOnly, and clang::QualType::getAsOpaquePtr().

◆ completeClassData()

void CGDebugInfo::completeClassData ( const RecordDecl * RD )

Definition at line 1908 of file CGDebugInfo.cpp.

References clang::RecordDecl::getDefinition(), isClassOrMethodDLLImport(), and isDefinedInClangModule().

◆ completeRequiredType()

void CGDebugInfo::completeRequiredType ( const RecordDecl * RD )

Definition at line 1991 of file CGDebugInfo.cpp.

References clang::ObjCObjectType::getBaseType(), clang::RecordType::getDecl(), clang::ObjCTypeParamType::getDecl(), clang::RecordDecl::getDefinition(), clang::Decl::getLocation(), clang::NamedDecl::getName(), clang::TypedefNameDecl::getUnderlyingType(), clang::TagDecl::isCompleteDefinition(), shouldOmitDefinition(), and clang::T.

◆ completeTemplateDefinition()

void CGDebugInfo::completeTemplateDefinition ( const ClassTemplateSpecializationDecl & SD )

Definition at line 2692 of file CGDebugInfo.cpp.

References clang::codegenoptions::DebugLineTablesOnly.

◆ completeType() [1/2]

void CGDebugInfo::completeType ( const EnumDecl * ED )

Definition at line 1856 of file CGDebugInfo.cpp.

References clang::codegenoptions::DebugLineTablesOnly, and clang::QualType::getAsOpaquePtr().

◆ completeType() [2/2]

void CGDebugInfo::completeType ( const RecordDecl * RD )

Definition at line 1869 of file CGDebugInfo.cpp.

References clang::codegenoptions::LimitedDebugInfo.

◆ completeUnusedClass()

void CGDebugInfo::completeUnusedClass ( const CXXRecordDecl & D )

◆ CreateMacro()

llvm::DIMacro * CGDebugInfo::CreateMacro	(	llvm::DIMacroFile *	Parent,
		unsigned	MType,
		SourceLocation	LineLoc,
		StringRef	Name,
		StringRef	Value
	)

Create debug info for a macro defined by a #define directive or a macro undefined by a #undef directive.

Definition at line 2600 of file CGDebugInfo.cpp.

Referenced by clang::MacroPPCallbacks::MacroUndefined().

◆ CreateTempMacroFile()

llvm::DIMacroFile * CGDebugInfo::CreateTempMacroFile	(	llvm::DIMacroFile *	Parent,
		SourceLocation	LineLoc,
		SourceLocation	FileLoc
	)

Create debug info for a file referenced by an #include directive.

Definition at line 2607 of file CGDebugInfo.cpp.

References clang::SourceLocation::isInvalid(), and Line.

◆ EmitDeclareOfArgVariable()

void CGDebugInfo::EmitDeclareOfArgVariable	(	const VarDecl *	Decl,
		llvm::Value *	AI,
		unsigned	ArgNo,
		CGBuilderTy &	Builder
	)

Emit call to llvm.dbg.declare for an argument variable declaration.

Definition at line 3785 of file CGDebugInfo.cpp.

References clang::codegenoptions::LimitedDebugInfo, and clang::operator<().

◆ EmitDeclareOfAutoVariable()

llvm::DILocalVariable * CGDebugInfo::EmitDeclareOfAutoVariable	(	const VarDecl *	Decl,
		llvm::Value *	AI,
		CGBuilderTy &	Builder
	)

Emit call to llvm.dbg.declare for an automatic variable declaration.

Returns a pointer to the DILocalVariable associated with the llvm.dbg.declare, or nullptr otherwise.

Definition at line 3700 of file CGDebugInfo.cpp.

References clang::codegenoptions::LimitedDebugInfo, and clang::None.

Referenced by clang::CodeGen::CodeGenFunction::EmitAndRegisterVariableArrayDimensions().

◆ EmitDeclareOfBlockDeclRefVariable()

void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable	(	const VarDecl *	variable,
		llvm::Value *	storage,
		CGBuilderTy &	Builder,
		const CGBlockInfo &	blockInfo,
		llvm::Instruction *	InsertPoint = `nullptr`
	)

Emit call to llvm.dbg.declare for an imported variable declaration in a block.

Definition at line 3714 of file CGDebugInfo.cpp.

References clang::CharUnits::fromQuantity(), clang::CodeGen::CGBlockInfo::getCapture(), getDeclAlignIfRequired(), clang::CodeGen::CGBlockInfo::Capture::getIndex(), clang::Decl::getLocation(), clang::NamedDecl::getName(), clang::CharUnits::getQuantity(), clang::ValueDecl::getType(), clang::Decl::hasAttr(), clang::codegenoptions::LimitedDebugInfo, Line, clang::ImplicitParamDecl::ObjCSelf, and clang::CodeGen::CGBlockInfo::StructureType.

◆ EmitDeclareOfBlockLiteralArgVariable()

void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable	(	const CGBlockInfo &	block,
		StringRef	Name,
		unsigned	ArgNo,
		llvm::AllocaInst *	LocalAddr,
		CGBuilderTy &	Builder
	)

Emit call to llvm.dbg.declare for the block-literal argument to a block invocation function.

Definition at line 3802 of file CGDebugInfo.cpp.

◆ EmitExplicitCastType()

void CGDebugInfo::EmitExplicitCastType ( QualType Ty )

Emit the type explicitly casted to.

Definition at line 4257 of file CGDebugInfo.cpp.

References clang::codegenoptions::LimitedDebugInfo.

◆ EmitFunctionDecl()

void CGDebugInfo::EmitFunctionDecl	(	GlobalDecl	GD,
		SourceLocation	Loc,
		QualType	FnType
	)

Emit debug info for a function declaration.

Definition at line 3356 of file CGDebugInfo.cpp.

◆ EmitFunctionEnd()

void CGDebugInfo::EmitFunctionEnd	(	CGBuilderTy &	Builder,
		llvm::Function *	Fn
	)

Constructs the debug code for exiting a function.

Definition at line 3484 of file CGDebugInfo.cpp.

◆ EmitFunctionStart()

void CGDebugInfo::EmitFunctionStart	(	GlobalDecl	GD,
		SourceLocation	Loc,
		SourceLocation	ScopeLoc,
		QualType	FnType,
		llvm::Function *	Fn,
		bool	CurFnIsThunk,
		CGBuilderTy &	Builder
	)

Emit a call to llvm.dbg.function.start to indicate start of a new function.

Parameters

Loc	The location of the function header.
ScopeLoc	The location of the function body.

Definition at line 3276 of file CGDebugInfo.cpp.

◆ EmitGlobalVariable() [1/2]

void CGDebugInfo::EmitGlobalVariable	(	llvm::GlobalVariable *	GV,
		const VarDecl *	Decl
	)

Emit information about a global variable.

Definition at line 3989 of file CGDebugInfo.cpp.

References clang::Type::castAs(), clang::VarDecl::getCanonicalDecl(), getDeclAlignIfRequired(), clang::ValueDecl::getType(), clang::Decl::hasAttr(), clang::RecordDecl::isAnonymousStructOrUnion(), clang::Type::isUnionType(), clang::codegenoptions::LimitedDebugInfo, and clang::T.

Referenced by clang::CodeGen::CodeGenFunction::EmitStaticVarDecl().

◆ EmitGlobalVariable() [2/2]

void CGDebugInfo::EmitGlobalVariable	(	const ValueDecl *	VD,
		const APValue &	Init
	)

Emit a constant global variable's debug info.

Definition at line 4040 of file CGDebugInfo.cpp.

References getDeclAlignIfRequired(), clang::Decl::getLocation(), clang::Decl::hasAttr(), and clang::codegenoptions::LimitedDebugInfo.

◆ EmitImportDecl()

void CGDebugInfo::EmitImportDecl ( const ImportDecl & ID )

Emit an declaration.

Definition at line 4144 of file CGDebugInfo.cpp.

References clang::Decl::getDeclContext(), clang::ImportDecl::getImportedModule(), and clang::Decl::getLocation().

◆ EmitInlineFunctionEnd()

void CGDebugInfo::EmitInlineFunctionEnd ( CGBuilderTy & Builder )

End an inlined function scope.

Definition at line 3413 of file CGDebugInfo.cpp.

Referenced by clang::CodeGen::ApplyInlineDebugLocation::~ApplyInlineDebugLocation().

◆ EmitInlineFunctionStart()

void CGDebugInfo::EmitInlineFunctionStart	(	CGBuilderTy &	Builder,
		GlobalDecl	GD
	)

Start a new scope for an inlined function.

Definition at line 3398 of file CGDebugInfo.cpp.

◆ EmitLexicalBlockEnd()

void CGDebugInfo::EmitLexicalBlockEnd	(	CGBuilderTy &	Builder,
		SourceLocation	Loc
	)

Emit metadata to indicate the end of a new lexical block and pop the current block.

Definition at line 3471 of file CGDebugInfo.cpp.

◆ EmitLexicalBlockStart()

void CGDebugInfo::EmitLexicalBlockStart	(	CGBuilderTy &	Builder,
		SourceLocation	Loc
	)

Emit metadata to indicate the beginning of a new lexical block and push the block onto the stack.

Definition at line 3454 of file CGDebugInfo.cpp.

◆ EmitLocation()

void CGDebugInfo::EmitLocation	(	CGBuilderTy &	Builder,
		SourceLocation	Loc
	)

Emit metadata to indicate a change in line/column information in the source file.

If the location is invalid, the previous location will be reused.

Definition at line 3419 of file CGDebugInfo.cpp.

◆ EmitNamespaceAlias()

llvm::DIImportedEntity * CGDebugInfo::EmitNamespaceAlias ( const NamespaceAliasDecl & NA )

Emit C++ namespace alias.

Definition at line 4158 of file CGDebugInfo.cpp.

References clang::NamespaceAliasDecl::getAliasedNamespace(), clang::Decl::getDeclContext(), clang::Decl::getLocation(), clang::NamedDecl::getName(), and clang::codegenoptions::LimitedDebugInfo.

◆ EmitUsingDecl()

void CGDebugInfo::EmitUsingDecl ( const UsingDecl & UD )

Emit C++ using declaration.

Definition at line 4117 of file CGDebugInfo.cpp.

References clang::Type::getAs(), clang::ValueDecl::getType(), clang::codegenoptions::LimitedDebugInfo, clang::UsingDecl::shadow_begin(), and clang::UsingDecl::shadow_size().

◆ EmitUsingDirective()

void CGDebugInfo::EmitUsingDirective ( const UsingDirectiveDecl & UD )

Emit C++ using directive.

Definition at line 4104 of file CGDebugInfo.cpp.

References clang::Decl::getDeclContext(), clang::Decl::getLocation(), clang::UsingDirectiveDecl::getNominatedNamespace(), clang::NamespaceDecl::isAnonymousNamespace(), and clang::codegenoptions::LimitedDebugInfo.

◆ finalize()

void CGDebugInfo::finalize ( )

Definition at line 4205 of file CGDebugInfo.cpp.

◆ getInlinedAt()

llvm::MDNode* clang::CodeGen::CGDebugInfo::getInlinedAt ( ) const

inline

Returns: the current inline scope.

Definition at line 353 of file CGDebugInfo.h.

References clang::markup::EmitLocation().

◆ getLocation()

SourceLocation clang::CodeGen::CGDebugInfo::getLocation ( ) const

inline

Return the current source location.

This does not necessarily correspond to the IRBuilder's current DebugLoc.

Definition at line 346 of file CGDebugInfo.h.

◆ getOrCreateInterfaceType()

llvm::DIType * CGDebugInfo::getOrCreateInterfaceType	(	QualType	Ty,
		SourceLocation	Loc
	)

Emit an Objective-C interface type standalone debug info.

Definition at line 1840 of file CGDebugInfo.cpp.

◆ getOrCreateRecordType()

llvm::DIType * CGDebugInfo::getOrCreateRecordType	(	QualType	Ty,
		SourceLocation	L
	)

Emit record type's standalone debug info.

Definition at line 1833 of file CGDebugInfo.cpp.

References clang::codegenoptions::LimitedDebugInfo, and clang::T.

◆ getOrCreateStandaloneType()

llvm::DIType * CGDebugInfo::getOrCreateStandaloneType	(	QualType	Ty,
		SourceLocation	Loc
	)

Emit standalone debug info for a type.

Definition at line 1845 of file CGDebugInfo.cpp.

References clang::QualType::getAsOpaquePtr(), clang::QualType::isNull(), clang::codegenoptions::LimitedDebugInfo, and clang::T.

◆ registerVLASizeExpression()

void clang::CodeGen::CGDebugInfo::registerVLASizeExpression	(	QualType	Ty,
		llvm::Metadata *	SizeExpr
	)

inline

Register VLA size expression debug node with the qualified type.

Definition at line 318 of file CGDebugInfo.h.

Referenced by clang::CodeGen::CodeGenFunction::EmitAndRegisterVariableArrayDimensions().

◆ setDwoId()

void CGDebugInfo::setDwoId ( uint64_t Signature )

Module debugging: Support for building PCMs.

Set the main CU's DwoId field to Signature.

Definition at line 4199 of file CGDebugInfo.cpp.

◆ setInlinedAt()

void clang::CodeGen::CGDebugInfo::setInlinedAt ( llvm::MDNode * InlinedAt )

inline

Update the current inline scope.

All subsequent calls to EmitLocation will create a location with this inlinedAt field.

Definition at line 350 of file CGDebugInfo.h.

◆ setLocation()

void CGDebugInfo::setLocation ( SourceLocation Loc )

Update the current source location.

If

loc is invalid it is ignored.

Definition at line 167 of file CGDebugInfo.cpp.

References clang::Decl::getDeclContext(), clang::SourceManager::getPresumedLoc(), clang::SourceLocation::isInvalid(), and SM.

Referenced by clang::CodeGen::CodeGenFunction::EmitStaticVarDecl().

◆ setModuleMap()

void clang::CodeGen::CGDebugInfo::setModuleMap ( ModuleMap & MMap )

inline

When generating debug information for a clang module or precompiled header, this module map will be used to determine the module of origin of each Decl.

Definition at line 330 of file CGDebugInfo.h.

◆ setPCHDescriptor()

void clang::CodeGen::CGDebugInfo::setPCHDescriptor ( ExternalASTSource::ASTSourceDescriptor PCH )

inline

When generating debug information for a clang module or precompiled header, this module map will be used to determine the module of origin of each Decl.

Definition at line 335 of file CGDebugInfo.h.

◆ SourceLocToDebugLoc()

llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc ( SourceLocation Loc )

Definition at line 4266 of file CGDebugInfo.cpp.

Friends And Related Function Documentation

◆ ApplyDebugLocation

friend class ApplyDebugLocation

friend

Definition at line 55 of file CGDebugInfo.h.

◆ SaveAndRestoreLocation

friend class SaveAndRestoreLocation

friend

Definition at line 56 of file CGDebugInfo.h.

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

lib/CodeGen/CGDebugInfo.h
lib/CodeGen/CGDebugInfo.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CGDebugInfo()

◆ ~CGDebugInfo()

Member Function Documentation

◆ completeClass()

◆ completeClassData()

◆ completeRequiredType()

◆ completeTemplateDefinition()

◆ completeType() [1/2]

◆ completeType() [2/2]

◆ completeUnusedClass()

◆ CreateMacro()

◆ CreateTempMacroFile()

◆ EmitDeclareOfArgVariable()

◆ EmitDeclareOfAutoVariable()

◆ EmitDeclareOfBlockDeclRefVariable()

◆ EmitDeclareOfBlockLiteralArgVariable()

◆ EmitExplicitCastType()

◆ EmitFunctionDecl()

◆ EmitFunctionEnd()

◆ EmitFunctionStart()

◆ EmitGlobalVariable() [1/2]

◆ EmitGlobalVariable() [2/2]

◆ EmitImportDecl()

◆ EmitInlineFunctionEnd()

◆ EmitInlineFunctionStart()

◆ EmitLexicalBlockEnd()

◆ EmitLexicalBlockStart()

◆ EmitLocation()

◆ EmitNamespaceAlias()

◆ EmitUsingDecl()

◆ EmitUsingDirective()

◆ finalize()

◆ getInlinedAt()

◆ getLocation()

◆ getOrCreateInterfaceType()

◆ getOrCreateRecordType()

◆ getOrCreateStandaloneType()

◆ registerVLASizeExpression()

◆ setDwoId()

◆ setInlinedAt()

◆ setLocation()

◆ setModuleMap()

◆ setPCHDescriptor()

◆ SourceLocToDebugLoc()

Friends And Related Function Documentation

◆ ApplyDebugLocation

◆ SaveAndRestoreLocation