Expand description
Read DWARF debugging information.
Example Usage
Print out all of the functions in the debuggee program:
// Read the DWARF sections with whatever object loader you're using.
// These closures should return a `Reader` instance (e.g. `EndianSlice`).
let loader = |section: gimli::SectionId| { get_file_section_reader(section.name()) };
let sup_loader = |section: gimli::SectionId| { get_sup_file_section_reader(section.name()) };
let mut dwarf = gimli::Dwarf::load(loader)?;
dwarf.load_sup(sup_loader)?;
// Iterate over all compilation units.
let mut iter = dwarf.units();
while let Some(header) = iter.next()? {
// Parse the abbreviations and other information for this compilation unit.
let unit = dwarf.unit(header)?;
// Iterate over all of this compilation unit's entries.
let mut entries = unit.entries();
while let Some((_, entry)) = entries.next_dfs()? {
// If we find an entry for a function, print it.
if entry.tag() == gimli::DW_TAG_subprogram {
println!("Found a function: {:?}", entry);
}
}
}Full example programs:
-
ddbug, a utility giving insight into code generation by making debugging information readable -
dwprod, a tiny utility to list the compilers used to create each compilation unit within a shared library or executable (viaDW_AT_producer) -
dwarf-validate, a program to validate the integrity of some DWARF and its references between sections and compilation units.
API Structure
-
Basic familiarity with DWARF is assumed.
-
The
Dwarftype contains the commonly used DWARF sections. It has methods that simplify access to debugging data that spans multiple sections. Use of this type is optional, but recommended. -
Each section gets its own type. Consider these types the entry points to the library:
-
DebugAbbrev: The.debug_abbrevsection. -
DebugAddr: The.debug_addrsection. -
DebugAranges: The.debug_arangessection. -
DebugFrame: The.debug_framesection. -
DebugInfo: The.debug_infosection. -
DebugLine: The.debug_linesection. -
DebugLineStr: The.debug_line_strsection. -
DebugLoc: The.debug_locsection. -
DebugLocLists: The.debug_loclistssection. -
DebugPubNames: The.debug_pubnamessection. -
DebugPubTypes: The.debug_pubtypessection. -
DebugRanges: The.debug_rangessection. -
DebugRngLists: The.debug_rnglistssection. -
DebugStr: The.debug_strsection. -
DebugStrOffsets: The.debug_str_offsetssection. -
DebugTypes: The.debug_typessection. -
EhFrame: The.eh_framesection. -
EhFrameHdr: The.eh_frame_hdrsection.
-
-
Each section type exposes methods for accessing the debugging data encoded in that section. For example, the
DebugInfostruct has theunitsmethod for iterating over the compilation units defined within it. -
Offsets into a section are strongly typed: an offset into
.debug_infois theDebugInfoOffsettype. It cannot be used to index into theDebugLinetype becauseDebugLinerepresents the.debug_linesection. There are similar types for offsets relative to a compilation unit rather than a section.
Using with FallibleIterator
The standard library’s Iterator trait and related APIs do not play well
with iterators where the next operation is fallible. One can make the
Iterator’s associated Item type be a Result<T, E>, however the
provided methods cannot gracefully handle the case when an Err is
returned.
This situation led to the
fallible-iterator crate’s
existence. You can read more of the rationale for its existence in its
docs. The crate provides the helpers you have come to expect (eg map,
filter, etc) for iterators that can fail.
gimli’s many lazy parsing iterators are a perfect match for the
fallible-iterator crate’s FallibleIterator trait because parsing is not
done eagerly. Parse errors later in the input might only be discovered after
having iterated through many items.
To use gimli iterators with FallibleIterator, import the crate and trait
into your code:
// Use the `FallibleIterator` trait so its methods are in scope!
use fallible_iterator::FallibleIterator;
use gimli::{DebugAranges, EndianSlice, LittleEndian};
fn find_sum_of_address_range_lengths(aranges: DebugAranges<EndianSlice<LittleEndian>>)
-> gimli::Result<u64>
{
// `DebugAranges::headers` returns a `FallibleIterator`!
aranges.headers()
// `flat_map` is provided by `FallibleIterator`!
.flat_map(|header| Ok(header.entries()))
// `map` is provided by `FallibleIterator`!
.map(|arange| Ok(arange.length()))
// `fold` is provided by `FallibleIterator`!
.fold(0, |sum, len| Ok(sum + len))
}Structs
An abbreviation describes the shape of a DebuggingInformationEntry’s type:
its code, tag type, whether it has children, and its set of attributes.
A set of type abbreviations.
A single parsed arange.
An iterator over the aranges from a .debug_aranges section.
A header for a set of entries in the .debug_arange section.
An iterator over the headers of a .debug_aranges section.
An attribute in a DebuggingInformationEntry, consisting of a name and
associated value.
The description of an attribute in an abbreviated type. It is a pair of name and form.
An iterator over a particular entry’s attributes.
We support the z-style augmentation defined by .eh_frame.
Optional base addresses for the relative DW_EH_PE_* encoded pointers.
A lazy iterator parsing call frame instructions.
An iterator over CIE and FDE entries in a .debug_frame or .eh_frame
section.
A Common Information Entry holds information that is shared among many Frame Description Entries. There is at least one CIE in every non-empty
.debug_framesection.
A line number program that has previously been run to completion.
The DebugAbbrev struct represents the abbreviations describing
DebuggingInformationEntrys’ attribute names and forms found in the
.debug_abbrev section.
The raw contents of the .debug_addr section.
The DebugAranges struct represents the DWARF address range information
found in the .debug_aranges section.
DebugFrame contains the .debug_frame section’s frame unwinding
information required to unwind to and recover registers from older frames on
the stack. For example, this is useful for a debugger that wants to print
locals in a backtrace.
The DebugInfo struct represents the DWARF debugging information found in
the .debug_info section.
An iterator over the units of a .debug_info section.
The DebugLine struct contains the source location to instruction mapping
found in the .debug_line section.
The DebugLineStr struct represents the DWARF strings
found in the .debug_line_str section.
The raw contents of the .debug_loc section.
The DebugLocLists struct represents the DWARF data
found in the .debug_loclists section.
The DebugPubNames struct represents the DWARF public names information
found in the .debug_pubnames section.
The DebugPubTypes struct represents the DWARF public types information
found in the .debug_info section.
The raw contents of the .debug_ranges section.
The DebugRngLists struct represents the contents of the
.debug_rnglists section.
The DebugStr struct represents the DWARF strings
found in the .debug_str section.
The raw contents of the .debug_str_offsets section.
The DebugTypes struct represents the DWARF type information
found in the .debug_types section.
An iterator over the type-units of this .debug_types section.
A Debugging Information Entry (DIE).
All of the commonly used DWARF sections, and other common information.
EhFrame contains the frame unwinding information needed during exception
handling found in the .eh_frame section.
EhFrameHdr contains the information about the .eh_frame_hdr section.
The CFI binary search table that is an optional part of the .eh_frame_hdr section.
A &[u8] slice with endianity metadata.
A cursor into the Debugging Information Entries tree for a compilation unit.
A raw reader of the data that defines the Debugging Information Entries.
The state information for a tree view of the Debugging Information Entries.
An iterator that allows traversal of the children of an
EntriesTreeNode.
A node in the Debugging Information Entry tree.
A DWARF expression evaluator.
The bytecode for a DWARF expression or location description.
An entry in the LineProgramHeader’s file_names set.
The format of a component of an include directory or file name entry.
A FrameDescriptionEntry is a set of CFA instructions for an address range.
A line number program that has not been run to completion.
An iterator yielding parsed instructions.
A header for a line number program in the .debug_line section, as defined
in section 6.2.4 of the standard.
A row in the line number program’s resulting matrix.
Executes a LineProgram to iterate over the rows in the matrix of line number information.
A sequence within a line number program. A sequence, as defined in section 6.2.5 of the standard, is a linear subset of a line number program within which addresses are monotonically increasing.
An iterator over a location list.
A location list entry from the .debug_loc or .debug_loclists sections.
The DWARF data found in .debug_loc and .debug_loclists sections.
An iterator for the operations in an expression.
ParsedEhFrameHdr contains the parsed information from the .eh_frame_hdr section.
A partially parsed FrameDescriptionEntry.
The description of a single piece of the result of a DWARF expression.
A single parsed pubname.
An iterator over the pubnames from a .debug_pubnames section.
A single parsed pubtype.
An iterator over the pubtypes from a .debug_pubtypes section.
An address range from the .debug_ranges, .debug_rnglists, or .debug_aranges sections.
An iterator for the address ranges of a DebuggingInformationEntry.
The DWARF data found in .debug_ranges and .debug_rnglists sections.
A raw iterator over a location list.
A raw iterator over an address range list.
An identifier for an offset within a section reader.
An unordered iterator for register rules.
An iterator over an address range list.
Optional base addresses for the relative DW_EH_PE_* encoded pointers
in a particular section.
Common context needed when evaluating the call frame unwinding information.
All of the commonly used information for a unit in the .debug_info or .debug_types
sections.
The common fields for the headers of compilation units and type units.
An offset into the current compilation or type unit.
An unwinding context.
The UnwindTable iteratively evaluates a FrameDescriptionEntry’s
CallFrameInstruction program, yielding the each row one at a time.
A row in the virtual unwind table that describes how to find the values of the registers in the previous frame for a range of PC addresses.
Enums
The value of an attribute in a DebuggingInformationEntry.
A parsed call frame instruction.
The canonical frame address (CFA) recovery rules.
Either a CommonInformationEntry (CIE) or a FrameDescriptionEntry (FDE).
The type of column that a row is referring to.
A reference to a DIE, either relative to the current CU or relative to the section.
An error that occurred when parsing.
The state of an Evaluation after evaluating a DWARF expression.
The evaluation is either Complete, or it requires more data
to continue, as described by the variant.
A parsed line number program instruction.
A single location of a piece of the result of a DWARF expression.
A single decoded DWARF expression operation.
A decoded pointer.
A raw entry in .debug_loclists.
A raw entry in .debug_rnglists
An entry in the abstract CFI table that describes how to find the value of a register.
This enum specifies the type of the unit and any type specific data carried in the header (e.g. the type signature/type offset of a type unit).
The value of an entry on the DWARF stack.
The type of an entry on the DWARF stack.
Traits
A LineProgram provides access to a LineProgramHeader and
a way to add files to the files table if necessary. Gimli consumers should
never need to use or see this trait.
A trait for reading the data from a DWARF section.
A trait for offsets with a DWARF section.
A convenience trait for loading DWARF sections from object files. To be used like:
An offset into an UnwindSection.
A section holding unwind information: either .debug_frame or
.eh_frame. See DebugFrame and
EhFrame respectively.
Type Definitions
Deprecated. CompleteLineNumberProgram has been renamed to CompleteLineProgram.
EndianBuf has been renamed to EndianSlice. For ease of upgrading across
gimli versions, we export this type alias.
Deprecated. IncompleteLineNumberProgram has been renamed to IncompleteLineProgram.
Deprecated. LineNumberProgram has been renamed to LineProgram.
Deprecated. LineNumberProgramHeader has been renamed to LineProgramHeader.
Deprecated. LineNumberRow has been renamed to LineRow.
Deprecated. LineNumberSequence has been renamed to LineSequence.
Deprecated. Opcode has been renamed to LineInstruction.
Deprecated. OpcodesIter has been renamed to LineInstructions.
The result of a parse.
Deprecated. StateMachine has been renamed to LineRows.