Package ghidra.app.util.bin.format.dwarf

Class DIEContainer

java.lang.Object

ghidra.app.util.bin.format.dwarf.DIEContainer

All Implemented Interfaces:

Iterable<DebugInfoEntry>

public class DIEContainer NEW
extends Object
implements Iterable<DebugInfoEntry>

Provides access to a set of DIE records (and associated bits and bobs)

Field Summary

Fields

Change	Modifier and Type	Field	Description
	protected Map<Long,Map<Integer,DWARFAbbreviation>>	abbrCache
	protected DWARFIndirectTable	addressListTable
	protected WeakValueHashMap<Long,DIEAggregate>	aggsByOffset
	protected Map<Long,DWARFLine>	cachedDWARFLines
	protected TreeMap<Integer,DWARFCompilationUnit>	compUnitDieIndex
	protected List<DWARFCompilationUnit>	compUnits
	protected BinaryReader	debugAbbrBR
	protected BinaryReader	debugAddr
	protected BinaryReader	debugInfoBR
	protected BinaryReader	debugLineBR
	protected BinaryReader	debugLocation
	protected BinaryReader	debugLocLists
	protected BinaryReader	debugMacros
	protected BinaryReader	debugRanges
	protected BinaryReader	debugRngLists
	protected StringTable	debugStrings
	protected BinaryReader	debugStrOffsets
	protected long[]	dieOffsets
	protected WeakValueHashMap<Long,DebugInfoEntry>	diesByOffset
	protected DWARFProgram	dprog
	protected DWARFImportSummary	importSummary
	protected BitSet	indexHasRef
	protected StringTable	lineStrings
	protected DWARFIndirectTable	locationListTable
	protected int[]	parentIndexes
	protected DWARFIndirectTable	rangeListTable
	protected static final EnumSet<DWARFAttributeId>	REF_ATTRS
	protected DWARFSectionProvider	sectionProvider
	protected int[]	siblingIndexes
	protected DWARFIndirectTable	stringsOffsetTable
	protected int	totalAggregateCount
	protected org.apache.commons.collections4.ListValuedMap<Long,Long>	typeReferers

Constructor Summary

Constructors

Change	Constructor	Description
	DIEContainer(DWARFProgram dprog)

Method Summary

Change	Modifier and Type	Method	Description
	Iterable<DIEAggregate>	allAggregates()	Returns iterable that traverses all DIEAggregates in the program.
	void	close()
	void	dumpDIEs(PrintStream ps)
	Map<Integer,DWARFAbbreviation>	getAbbrevs(long abbrevOffset)
	long	getAddress(DWARFForm form, long value, DWARFCompilationUnit cu)	Returns an address value.
	DIEAggregate	getAggregate(long dieOffset)	Returns the DIEAggregate that contains the DebugInfoEntry specified by the offset.
	DIEAggregate	getAggregate(DebugInfoEntry die)	Returns the DIEAggregate that contains the specified DebugInfoEntry.
	int	getChildCount(int dieIndex)
	List<DebugInfoEntry>	getChildrenOf(int dieIndex)	Returns the children of the specified DIE
	List<DWARFCompilationUnit>	getCompilationUnits()
	BinaryReader	getDebugLineReader()
	DebugInfoEntry	getDIE(DWARFForm form, long rawOffset, DWARFCompilationUnit cu)	Return the DIE referenced by an attribute value (a DW_FORM and offset)
	DebugInfoEntry	getDIEByOffset(long dieOffset)	Returns the specified DIE record.
	DWARFLine	getLine(long offset, DWARFCompilationUnit cu, boolean readIfMissing)
	DWARFLine	getLine(DIEAggregate diea, DWARFAttributeId attribute)	Returns the DWARFLine info pointed to by the specified attribute.
	long	getLineDataSize()
	DWARFLocationList	getLocationList(DIEAggregate diea, DWARFAttributeId attrId)	Returns the DWARFLocationList pointed to by the specified attribute value.
	List<DWARFMacroInfoEntry>	getMacroEntries(DWARFMacroHeader macroHeader)
	DWARFMacroHeader	getMacroHeader(long offset, DWARFCompilationUnit cu)
	long	getOffsetOfIndexedElement(DWARFForm form, int index, DWARFCompilationUnit cu)	Returns the raw offset of an indexed item.
	int	getParentDepth(int dieIndex)	Returns the depth of the specified DIE.
	DebugInfoEntry	getParentOf(int dieIndex)	Returns the parent DIE of the specified (by index) DIE
	int	getPositionInParent(DebugInfoEntry die, Predicate<DWARFTag> dwTagFilter)
	DWARFProgram	getProgram()
	DWARFRangeList	getRangeList(DIEAggregate diea, DWARFAttributeId attribute)	Returns the DWARFRangeList pointed at by the specified attribute.
	BinaryReader	getReaderForCompUnit(DWARFCompilationUnit cu)
	String	getString(DWARFForm form, long offset, DWARFCompilationUnit cu)	Returns a DWARF attribute string value, as specified by a form, offset/index, and the cu.
	StringTable	getStringTable()
	int	getTotalAggregateCount()	Returns the total number of DIEAggregate objects in the entire program.
	List<DIEAggregate>	getTypeReferers(DIEAggregate targetDIEA, DWARFTag tag)	Returns a list of DIEAggregates that refer to the targetDIEA via an attribute of the specified tag type.
	boolean	hasLineInfo()
	void	indexData(TaskMonitor monitor)	Reads and indexes the DIE records found in the section.
	protected void	indexDIEAggregates(LongArrayList aggrTargets, TaskMonitor monitor)
	protected void	indexDIEATypeRefs(TaskMonitor monitor)
	void	init(TaskMonitor monitor)	Fetches required sections and sets up variables.
	ghidra.app.util.bin.format.dwarf.DIEContainer.DIEIterator	iterator()
	ghidra.app.util.bin.format.dwarf.DIEContainer.DIEIterator	unreferencedDIEs()
	protected void	updateSiblingIndexes(IntArrayList siblingIndexList, IntArrayList parentIndexList, int index)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

REF_ATTRS

protected static final EnumSet<DWARFAttributeId> REF_ATTRS

dprog

protected DWARFProgram dprog

sectionProvider

protected DWARFSectionProvider sectionProvider

abbrCache

protected Map<Long,Map<Integer,DWARFAbbreviation>> abbrCache

dieOffsets

protected long[] dieOffsets

siblingIndexes

protected int[] siblingIndexes

parentIndexes

protected int[] parentIndexes

compUnitDieIndex

protected TreeMap<Integer,DWARFCompilationUnit> compUnitDieIndex

compUnits

protected List<DWARFCompilationUnit> compUnits

addressListTable

protected DWARFIndirectTable addressListTable

locationListTable

protected DWARFIndirectTable locationListTable

rangeListTable

protected DWARFIndirectTable rangeListTable

stringsOffsetTable

protected DWARFIndirectTable stringsOffsetTable

indexHasRef

protected BitSet indexHasRef

diesByOffset

protected WeakValueHashMap<Long,DebugInfoEntry> diesByOffset

aggsByOffset

protected WeakValueHashMap<Long,DIEAggregate> aggsByOffset

typeReferers

protected org.apache.commons.collections4.ListValuedMap<Long,Long> typeReferers

totalAggregateCount

protected int totalAggregateCount

debugStrings

protected StringTable debugStrings

lineStrings

protected StringTable lineStrings

cachedDWARFLines

protected Map<Long,DWARFLine> cachedDWARFLines

debugLocation

protected BinaryReader debugLocation

debugLocLists

protected BinaryReader debugLocLists

debugRanges

protected BinaryReader debugRanges

debugRngLists

protected BinaryReader debugRngLists

debugInfoBR

protected BinaryReader debugInfoBR

debugLineBR

protected BinaryReader debugLineBR

debugAbbrBR

protected BinaryReader debugAbbrBR

debugAddr

protected BinaryReader debugAddr

debugStrOffsets

protected BinaryReader debugStrOffsets

debugMacros

protected BinaryReader debugMacros

importSummary

protected DWARFImportSummary importSummary

Constructor Details

DIEContainer

public DIEContainer(DWARFProgram dprog)

Method Details

init

public void init(TaskMonitor monitor)
          throws IOException

Fetches required sections and sets up variables.

Parameters:

monitor - TaskMonitor

Throws:

IOException - if error

indexData

public void indexData(TaskMonitor monitor)
               throws CancelledException,
DWARFException,
IOException

Reads and indexes the DIE records found in the section.

Parameters:

monitor - TaskMonitor

Throws:

CancelledException - if cancelled

DWARFException - if error

IOException - if error

close

public void close()

indexDIEATypeRefs

protected void indexDIEATypeRefs(TaskMonitor monitor)
                          throws CancelledException

Throws:

CancelledException

indexDIEAggregates

protected void indexDIEAggregates(LongArrayList aggrTargets,
 TaskMonitor monitor)
                           throws CancelledException,
DWARFException

Throws:

CancelledException

DWARFException

updateSiblingIndexes

protected void updateSiblingIndexes(IntArrayList siblingIndexList,
 IntArrayList parentIndexList,
 int index)

getDIE

public DebugInfoEntry getDIE(DWARFForm form,
 long rawOffset,
 DWARFCompilationUnit cu)
                      throws IOException

Return the DIE referenced by an attribute value (a DW_FORM and offset)

Parameters:

form - DWARFForm

rawOffset - index / offset from the numeric attribute

cu - compilation unit containing the value

Returns:

DebugInfoEntry, or null if doesn't exist

Throws:

IOException - if unsupported format for reference

getDIEByOffset

public DebugInfoEntry getDIEByOffset(long dieOffset)

Returns the specified DIE record.

Parameters:

dieOffset - offset of a DIE record

Returns:

DebugInfoEntry instance, or null if invalid offset

dumpDIEs

public void dumpDIEs(PrintStream ps)

getAggregate

public DIEAggregate getAggregate(DebugInfoEntry die)

Returns the DIEAggregate that contains the specified DebugInfoEntry.

Parameters:

die - DebugInfoEntry or null

Returns:

DIEAggregate that contains the specified DIE, or null if DIE null or the aggregate was not found.

getAggregate

public DIEAggregate getAggregate(long dieOffset)

Returns the DIEAggregate that contains the DebugInfoEntry specified by the offset.

Parameters:

dieOffset - offset of a DIE record

Returns:

DIEAggregate that contains the DIE record specified, or null if bad offset.

allAggregates

public Iterable<DIEAggregate> allAggregates()

Returns iterable that traverses all DIEAggregates in the program.

Returns:

sequence of DIEAggregatees

getTotalAggregateCount

public int getTotalAggregateCount()

Returns the total number of DIEAggregate objects in the entire program.

Returns:

the total number of DIEAggregate objects in the entire program.

getReaderForCompUnit

public BinaryReader getReaderForCompUnit(DWARFCompilationUnit cu)

getAbbrevs

public Map<Integer,DWARFAbbreviation> getAbbrevs(long abbrevOffset)
                                          throws IOException

Throws:

IOException

getProgram

public DWARFProgram getProgram()

getCompilationUnits

public List<DWARFCompilationUnit> getCompilationUnits()

getParentOf

public DebugInfoEntry getParentOf(int dieIndex)

Returns the parent DIE of the specified (by index) DIE

Parameters:

dieIndex - index of a DIE record

Returns:

parent DIE, or null if no parent (eg. root DIE)

getParentDepth

public int getParentDepth(int dieIndex)

Returns the depth of the specified DIE.

Parameters:

dieIndex - index of a DIE record

Returns:

parent/child depth of specified record, where 0 is the root DIE

getChildrenOf

public List<DebugInfoEntry> getChildrenOf(int dieIndex)

Returns the children of the specified DIE

Parameters:

dieIndex - index of a DIE record

Returns:

list of DIE instances that are children of the specified DIE

getChildCount

public int getChildCount(int dieIndex)

getOffsetOfIndexedElement

public long getOffsetOfIndexedElement(DWARFForm form,
 int index,
 DWARFCompilationUnit cu)
                               throws IOException

Returns the raw offset of an indexed item. For DW_FORM_addrx values, the returned value is not fixed up with Ghidra load offset.

Parameters:

form - DWARFForm of the index

index - int index into a lookup table (see addressListTable, locationListTable, rangeListTable, stringsOffsetTable)

cu - DWARFCompilationUnit

Returns:

raw offset of indexed item

Throws:

IOException - if error reading index table

getAddress

public long getAddress(DWARFForm form,
 long value,
 DWARFCompilationUnit cu)
                throws IOException

Returns an address value.

Parameters:

form - the format of the numeric value

value - raw offset or indirect address index (depending on the DWARFForm)

cu - DWARFCompilationUnit

Returns:

address

Throws:

IOException - if error reading indirect lookup tables

getLocationList

public DWARFLocationList getLocationList(DIEAggregate diea,
 DWARFAttributeId attrId)
                                  throws IOException

Returns the DWARFLocationList pointed to by the specified attribute value.

Parameters:

diea - DIEAggregate

attrId - attribute id that points to the location list

Returns:

DWARFLocationList, never null

Throws:

IOException - if specified attribute is not the correct type, or if other error reading data

getString

public String getString(DWARFForm form,
 long offset,
 DWARFCompilationUnit cu)
                 throws IOException

Returns a DWARF attribute string value, as specified by a form, offset/index, and the cu.

Parameters:

form - DWARFForm

offset - offset or index of the value

cu - DWARFCompilationUnit

Returns:

String value, never null

Throws:

IOException - if invalid form or bad offset/index

getStringTable

public StringTable getStringTable()

getRangeList

public DWARFRangeList getRangeList(DIEAggregate diea,
 DWARFAttributeId attribute)
                            throws IOException

Returns the DWARFRangeList pointed at by the specified attribute.

Parameters:

diea - DIEAggregate

attribute - attribute id to find in the DIEA

Returns:

DWARFRangeList, or null if attribute is not present

Throws:

IOException - if error reading range list

getLine

public DWARFLine getLine(DIEAggregate diea,
 DWARFAttributeId attribute)
                  throws IOException

Returns the DWARFLine info pointed to by the specified attribute.

Parameters:

diea - DIEAggregate

attribute - attribute id that points to the line info

Returns:

DWARFLine, never null, see DWARFLine.empty()

Throws:

IOException - if error reading line data

getLine

public DWARFLine getLine(long offset,
 DWARFCompilationUnit cu,
 boolean readIfMissing)
                  throws IOException

Throws:

IOException

getLineDataSize

public long getLineDataSize()

getDebugLineReader

public BinaryReader getDebugLineReader()

hasLineInfo

public boolean hasLineInfo()

getMacroHeader

public DWARFMacroHeader getMacroHeader(long offset,
 DWARFCompilationUnit cu)

getMacroEntries

public List<DWARFMacroInfoEntry> getMacroEntries(DWARFMacroHeader macroHeader)
                                          throws IOException

Throws:

IOException

getPositionInParent

public int getPositionInParent(DebugInfoEntry die,
 Predicate<DWARFTag> dwTagFilter)

iterator

public ghidra.app.util.bin.format.dwarf.DIEContainer.DIEIterator iterator()

Specified by:

iterator in interface Iterable<DebugInfoEntry>

unreferencedDIEs

public ghidra.app.util.bin.format.dwarf.DIEContainer.DIEIterator unreferencedDIEs()

getTypeReferers

public List<DIEAggregate> getTypeReferers(DIEAggregate targetDIEA,
 DWARFTag tag)

Returns a list of DIEAggregates that refer to the targetDIEA via an attribute of the specified tag type.

Parameters:

targetDIEA - DIEAggregate that might be pointed to by other DIEAs.

tag - the DWARFTag attribute type that is pointing DIEAs are using to refer to the target DIEA.

Returns:

list of DIEAs that point to the target, empty list if nothing found.