Stores all information relating to a compile unit, be it in its original instance in the object file to its brand new cloned and generated DIE tree. More...

#include "llvm/DWARFLinker/DWARFLinkerCompileUnit.h"

Classes
struct	AccelInfo

struct	DIEInfo
	Information gathered about a DIE in the object file. More...

Public Member Functions
	CompileUnit (DWARFUnit &OrigUnit, unsigned ID, bool CanUseODR, StringRef ClangModuleName)

DWARFUnit &	getOrigUnit () const

unsigned	getUniqueID () const

void	createOutputDIE ()

DIE *	getOutputUnitDIE () const

bool	hasODR () const

bool	isClangModule () const

uint16_t	getLanguage ()

StringRef	getSysRoot ()
	Return the DW_AT_LLVM_sysroot of the compile unit or an empty StringRef.

const std::string &	getClangModuleName () const

DIEInfo &	getInfo (unsigned Idx)

const DIEInfo &	getInfo (unsigned Idx) const

DIEInfo &	getInfo (const DWARFDie &Die)

uint64_t	getStartOffset () const

uint64_t	getNextUnitOffset () const

void	setStartOffset (uint64_t DebugInfoSize)

std::optional< uint64_t >	getLowPc () const

uint64_t	getHighPc () const

bool	hasLabelAt (uint64_t Addr) const

const RangesTy &	getFunctionRanges () const

const RngListAttributesTy &	getRangesAttributes ()

std::optional< PatchLocation >	getUnitRangesAttribute () const

const LocListAttributesTy &	getLocationAttributes () const

void	markEverythingAsKept ()
	Mark every DIE in this unit as kept.

uint64_t	computeNextUnitOffset (uint16_t DwarfVersion)
	Compute the end offset for this unit.

void	noteForwardReference (DIE Die, const CompileUnit RefUnit, DeclContext *Ctxt, PatchLocation Attr)
	Keep track of a forward reference to DIE `Die` in `RefUnit` by `Attr`.

void	fixupForwardReferences ()
	Apply all fixups recorded by noteForwardReference().

void	addLabelLowPc (uint64_t LabelLowPc, int64_t PcOffset)
	Add the low_pc of a label that is relocated by applying offset `PCOffset`.

void	addFunctionRange (uint64_t LowPC, uint64_t HighPC, int64_t PCOffset)
	Add a function range [`LowPC`, `HighPC`) that is relocated by applying offset `PCOffset`.

void	noteRangeAttribute (const DIE &Die, PatchLocation Attr)
	Keep track of a DW_AT_range attribute that we will need to patch up later.

void	noteLocationAttribute (PatchLocation Attr)
	Keep track of a location attribute pointing to a location list in the debug_loc section.

void	addNamespaceAccelerator (const DIE *Die, DwarfStringPoolEntryRef Name)
	Add a name accelerator entry for Die with Name.

void	addNameAccelerator (const DIE *Die, DwarfStringPoolEntryRef Name, bool SkipPubnamesSection=false)
	Add a name accelerator entry for Die with Name.

void	addObjCAccelerator (const DIE *Die, DwarfStringPoolEntryRef Name, bool SkipPubnamesSection=false)
	Add various accelerator entries for `Die` with `Name` which is stored in the string table at `Offset`.

void	addTypeAccelerator (const DIE *Die, DwarfStringPoolEntryRef Name, bool ObjcClassImplementation, uint32_t QualifiedNameHash)
	Add a type accelerator entry for `Die` with `Name` which is stored in the string table at `Offset`.

const std::vector< AccelInfo > &	getPubnames () const

const std::vector< AccelInfo > &	getPubtypes () const

const std::vector< AccelInfo > &	getNamespaces () const

const std::vector< AccelInfo > &	getObjC () const

MCSymbol *	getLabelBegin ()

void	setLabelBegin (MCSymbol *S)

Detailed Description

Stores all information relating to a compile unit, be it in its original instance in the object file to its brand new cloned and generated DIE tree.

Definition at line 61 of file DWARFLinkerCompileUnit.h.

Constructor & Destructor Documentation

◆ CompileUnit()

llvm::CompileUnit::CompileUnit	(	DWARFUnit &	OrigUnit,
		unsigned	ID,
		bool	CanUseODR,
		StringRef	ClangModuleName
	)

inline

Definition at line 106 of file DWARFLinkerCompileUnit.h.

References llvm::DWARFUnit::getNumDIEs(), llvm::DWARFUnit::getUnitDIE(), and llvm::dwarf::toUnsigned().

Member Function Documentation

◆ addFunctionRange()

void CompileUnit::addFunctionRange	(	uint64_t	LowPC,
		uint64_t	HighPC,
		int64_t	PCOffset
	)

Add a function range [LowPC, HighPC) that is relocated by applying offset PCOffset.

Definition at line 162 of file DWARFLinkerCompileUnit.cpp.

References llvm::AddressRangesMap::insert().

◆ addLabelLowPc()

void CompileUnit::addLabelLowPc	(	uint64_t	LabelLowPc,
		int64_t	PcOffset
	)

Add the low_pc of a label that is relocated by applying offset PCOffset.

Definition at line 158 of file DWARFLinkerCompileUnit.cpp.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::insert().

◆ addNameAccelerator()

void llvm::CompileUnit::addNameAccelerator	(	const DIE *	Die,
		DwarfStringPoolEntryRef	Name,
		bool	SkipPubnamesSection = `false`
	)

Add a name accelerator entry for Die with Name.

Definition at line 196 of file DWARFLinkerCompileUnit.cpp.

References Name.

◆ addNamespaceAccelerator()

void llvm::CompileUnit::addNamespaceAccelerator	(	const DIE *	Die,
		DwarfStringPoolEntryRef	Name
	)

Add a name accelerator entry for Die with Name.

Definition at line 185 of file DWARFLinkerCompileUnit.cpp.

References Name.

◆ addObjCAccelerator()

void llvm::CompileUnit::addObjCAccelerator	(	const DIE *	Die,
		DwarfStringPoolEntryRef	Name,
		bool	SkipPubnamesSection = `false`
	)

Add various accelerator entries for Die with Name which is stored in the string table at Offset.

Name must be an Objective-C selector.

Definition at line 190 of file DWARFLinkerCompileUnit.cpp.

References Name.

◆ addTypeAccelerator()

void llvm::CompileUnit::addTypeAccelerator	(	const DIE *	Die,
		DwarfStringPoolEntryRef	Name,
		bool	ObjcClassImplementation,
		uint32_t	QualifiedNameHash
	)

Add a type accelerator entry for Die with Name which is stored in the string table at Offset.

Definition at line 202 of file DWARFLinkerCompileUnit.cpp.

References Name.

◆ computeNextUnitOffset()

uint64_t llvm::CompileUnit::computeNextUnitOffset ( uint16_t DwarfVersion )

Compute the end offset for this unit.

Must be called after the CU's DIEs have been cloned.

Returns: the next unit offset (which is also the current debug_info section size).

Definition at line 124 of file DWARFLinkerCompileUnit.cpp.

◆ createOutputDIE()

void llvm::CompileUnit::createOutputDIE ( )

inline

Definition at line 130 of file DWARFLinkerCompileUnit.h.

References llvm::DWARFDie::getTag(), and llvm::DWARFUnit::getUnitDIE().

◆ fixupForwardReferences()

void llvm::CompileUnit::fixupForwardReferences ( )

Apply all fixups recorded by noteForwardReference().

Definition at line 140 of file DWARFLinkerCompileUnit.cpp.

References assert(), llvm::DeclContext::getCanonicalDIEOffset(), llvm::DIE::getOffset(), getStartOffset(), llvm::DeclContext::hasCanonicalDIE(), llvm::Ref, and llvm::PatchLocation::set().

◆ getClangModuleName()

const std::string & llvm::CompileUnit::getClangModuleName ( ) const

inline

Definition at line 144 of file DWARFLinkerCompileUnit.h.

◆ getFunctionRanges()

const RangesTy & llvm::CompileUnit::getFunctionRanges ( ) const

inline

Definition at line 162 of file DWARFLinkerCompileUnit.h.

◆ getHighPc()

uint64_t llvm::CompileUnit::getHighPc ( ) const

inline

Definition at line 159 of file DWARFLinkerCompileUnit.h.

◆ getInfo() [1/3]

DIEInfo & llvm::CompileUnit::getInfo ( const DWARFDie & Die )

inline

Definition at line 149 of file DWARFLinkerCompileUnit.h.

References llvm::DWARFUnit::getDIEIndex(), getOrigUnit(), and Idx.

◆ getInfo() [2/3]

DIEInfo & llvm::CompileUnit::getInfo ( unsigned Idx )

inline

Definition at line 146 of file DWARFLinkerCompileUnit.h.

References Idx.

◆ getInfo() [3/3]

const DIEInfo & llvm::CompileUnit::getInfo ( unsigned Idx ) const

inline

Definition at line 147 of file DWARFLinkerCompileUnit.h.

References Idx.

◆ getLabelBegin()

MCSymbol * llvm::CompileUnit::getLabelBegin ( )

inline

Definition at line 260 of file DWARFLinkerCompileUnit.h.

◆ getLanguage()

uint16_t llvm::CompileUnit::getLanguage ( )

Definition at line 46 of file DWARFLinkerCompileUnit.cpp.

References getOrigUnit(), llvm::DWARFUnit::getUnitDIE(), and llvm::dwarf::toUnsigned().

◆ getLocationAttributes()

const LocListAttributesTy & llvm::CompileUnit::getLocationAttributes ( ) const

inline

Definition at line 170 of file DWARFLinkerCompileUnit.h.

◆ getLowPc()

std::optional< uint64_t > llvm::CompileUnit::getLowPc ( ) const

inline

Definition at line 158 of file DWARFLinkerCompileUnit.h.

◆ getNamespaces()

const std::vector< AccelInfo > & llvm::CompileUnit::getNamespaces ( ) const

inline

Definition at line 257 of file DWARFLinkerCompileUnit.h.

◆ getNextUnitOffset()

uint64_t llvm::CompileUnit::getNextUnitOffset ( ) const

inline

Definition at line 155 of file DWARFLinkerCompileUnit.h.

◆ getObjC()

const std::vector< AccelInfo > & llvm::CompileUnit::getObjC ( ) const

inline

Definition at line 258 of file DWARFLinkerCompileUnit.h.

◆ getOrigUnit()

DWARFUnit & llvm::CompileUnit::getOrigUnit ( ) const

inline

Definition at line 126 of file DWARFLinkerCompileUnit.h.

Referenced by getInfo(), getLanguage(), and getSysRoot().

◆ getOutputUnitDIE()

DIE * llvm::CompileUnit::getOutputUnitDIE ( ) const

inline

Definition at line 132 of file DWARFLinkerCompileUnit.h.

References llvm::DIEUnit::getUnitDie().

◆ getPubnames()

const std::vector< AccelInfo > & llvm::CompileUnit::getPubnames ( ) const

inline

Definition at line 255 of file DWARFLinkerCompileUnit.h.

◆ getPubtypes()

const std::vector< AccelInfo > & llvm::CompileUnit::getPubtypes ( ) const

inline

Definition at line 256 of file DWARFLinkerCompileUnit.h.

◆ getRangesAttributes()

const RngListAttributesTy & llvm::CompileUnit::getRangesAttributes ( )

inline

Definition at line 164 of file DWARFLinkerCompileUnit.h.

◆ getStartOffset()

uint64_t llvm::CompileUnit::getStartOffset ( ) const

inline

Definition at line 154 of file DWARFLinkerCompileUnit.h.

Referenced by fixupForwardReferences().

◆ getSysRoot()

StringRef llvm::CompileUnit::getSysRoot ( )

Return the DW_AT_LLVM_sysroot of the compile unit or an empty StringRef.

Definition at line 54 of file DWARFLinkerCompileUnit.cpp.

References getOrigUnit(), llvm::DWARFUnit::getUnitDIE(), llvm::StringRef::str(), and llvm::dwarf::toStringRef().

◆ getUniqueID()

unsigned llvm::CompileUnit::getUniqueID ( ) const

inline

Definition at line 128 of file DWARFLinkerCompileUnit.h.

◆ getUnitRangesAttribute()

std::optional< PatchLocation > llvm::CompileUnit::getUnitRangesAttribute ( ) const

inline

Definition at line 166 of file DWARFLinkerCompileUnit.h.

◆ hasLabelAt()

bool llvm::CompileUnit::hasLabelAt ( uint64_t Addr ) const

inline

Definition at line 160 of file DWARFLinkerCompileUnit.h.

References Addr, and llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::count().

◆ hasODR()

bool llvm::CompileUnit::hasODR ( ) const

inline

Definition at line 138 of file DWARFLinkerCompileUnit.h.

◆ isClangModule()

bool llvm::CompileUnit::isClangModule ( ) const

inline

Definition at line 139 of file DWARFLinkerCompileUnit.h.

◆ markEverythingAsKept()

void llvm::CompileUnit::markEverythingAsKept ( )

Mark every DIE in this unit as kept.

This function also marks variables as InDebugMap so that they appear in the reconstructed accelerator tables.

Definition at line 62 of file DWARFLinkerCompileUnit.cpp.

References llvm::Data, llvm::DWARFUnit::getDIEAtIndex(), llvm::DIE::getTag(), I, Idx, llvm::inFunctionScope(), and llvm::dwarf::toStringRef().

◆ noteForwardReference()

void llvm::CompileUnit::noteForwardReference	(	DIE *	Die,
		const CompileUnit *	RefUnit,
		DeclContext *	Ctxt,
		PatchLocation	Attr
	)

Keep track of a forward reference to DIE Die in RefUnit by Attr.

Keep track of a forward cross-cu reference from this unit to Die that lives in RefUnit.

The attribute should be fixed up later to point to the absolute offset of Die in the debug_info section or to the canonical offset of Ctxt if it is non-null.

Definition at line 135 of file DWARFLinkerCompileUnit.cpp.

◆ noteLocationAttribute()

void llvm::CompileUnit::noteLocationAttribute ( PatchLocation Attr )

Keep track of a location attribute pointing to a location list in the debug_loc section.

Definition at line 181 of file DWARFLinkerCompileUnit.cpp.

References llvm::SmallVectorImpl< T >::emplace_back().

◆ noteRangeAttribute()

void llvm::CompileUnit::noteRangeAttribute	(	const DIE &	Die,
		PatchLocation	Attr
	)

Keep track of a DW_AT_range attribute that we will need to patch up later.

Definition at line 172 of file DWARFLinkerCompileUnit.cpp.

References llvm::SmallVectorImpl< T >::emplace_back(), and llvm::DIE::getTag().

◆ setLabelBegin()

void llvm::CompileUnit::setLabelBegin ( MCSymbol * S )

inline

Definition at line 261 of file DWARFLinkerCompileUnit.h.

◆ setStartOffset()

void llvm::CompileUnit::setStartOffset ( uint64_t DebugInfoSize )

inline

Definition at line 156 of file DWARFLinkerCompileUnit.h.

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

include/llvm/DWARFLinker/DWARFLinkerCompileUnit.h
lib/DWARFLinker/DWARFLinkerCompileUnit.cpp
lib/DWARFLinkerParallel/DWARFLinkerCompileUnit.cpp

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CompileUnit()

Member Function Documentation

◆ addFunctionRange()

◆ addLabelLowPc()

◆ addNameAccelerator()

◆ addNamespaceAccelerator()

◆ addObjCAccelerator()

◆ addTypeAccelerator()

◆ computeNextUnitOffset()

◆ createOutputDIE()

◆ fixupForwardReferences()

◆ getClangModuleName()

◆ getFunctionRanges()

◆ getHighPc()

◆ getInfo() [1/3]

◆ getInfo() [2/3]

◆ getInfo() [3/3]

◆ getLabelBegin()

◆ getLanguage()

◆ getLocationAttributes()

◆ getLowPc()

◆ getNamespaces()

◆ getNextUnitOffset()

◆ getObjC()

◆ getOrigUnit()

◆ getOutputUnitDIE()

◆ getPubnames()

◆ getPubtypes()

◆ getRangesAttributes()

◆ getStartOffset()

◆ getSysRoot()

◆ getUniqueID()

◆ getUnitRangesAttribute()

◆ hasLabelAt()

◆ hasODR()

◆ isClangModule()

◆ markEverythingAsKept()

◆ noteForwardReference()

◆ noteLocationAttribute()

◆ noteRangeAttribute()

◆ setLabelBegin()

◆ setStartOffset()