1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
//! `gimli` is a blazing fast library for consuming the //! [DWARF debugging format](http://dwarfstd.org/). //! //! * [Example Usage](#example-usage) //! * [API Structure](#api-structure) //! * [Using with `FallibleIterator`](#using-with-fallibleiterator) //! * [Cargo Features](#cargo-features) //! //! ## Example Usage //! //! Print out all of the functions in the debuggee program: //! //! ```rust,no_run //! extern crate gimli; //! //! # fn example() -> Result<(), gimli::Error> { //! # let debug_info_buf = []; //! # let debug_abbrev_buf = []; //! # let read_debug_info = || &debug_info_buf; //! # let read_debug_abbrev = || &debug_abbrev_buf; //! // Read the .debug_info and .debug_abbrev sections with whatever object //! // loader you're using. //! let endian = gimli::LittleEndian; //! let debug_info = gimli::DebugInfo::new(read_debug_info(), endian); //! let debug_abbrev = gimli::DebugAbbrev::new(read_debug_abbrev(), endian); //! //! // Iterate over all compilation units. //! let mut iter = debug_info.units(); //! while let Some(unit) = try!(iter.next()) { //! // Parse the abbreviations for this compilation unit. //! let abbrevs = try!(unit.abbreviations(&debug_abbrev)); //! //! // Iterate over all of this compilation unit's entries. //! let mut entries = unit.entries(&abbrevs); //! while let Some((_, entry)) = try!(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); //! } //! } //! } //! # unreachable!() //! # } //! ``` //! //! Full example programs: //! //! * [A `dwarfdump` //! clone](https://github.com/gimli-rs/gimli/blob/master/examples/dwarfdump.rs) //! //! * [An `addr2line` clone](https://github.com/gimli-rs/addr2line) //! //! * [`ddbug`](https://github.com/philipc/ddbug), a utility giving insight into //! code generation by making debugging information readable //! //! * [`dwprod`](https://github.com/fitzgen/dwprod), a tiny utility to list the //! compilers used to create each compilation unit within a shared library or //! executable (via `DW_AT_producer`) //! //! * [`dwarf-validate`](http://github.com/gimli-rs/gimli/blob/master/examples/dwarf-validate.rs), //! a program to validate the integrity of some DWARF and its references //! between sections and ocmpilation units. //! //! ## API Structure //! //! * Basic familiarity with DWARF is assumed. //! //! * Each section gets its own type. Consider these types the entry points to //! the library: //! //! * [`DebugAbbrev`](./struct.DebugAbbrev.html): The `.debug_abbrev` section. //! //! * [`DebugAranges`](./struct.DebugAranges.html): The `.debug_aranges` //! section. //! //! * [`DebugFrame`](./struct.DebugFrame.html): The `.debug_frame` section. //! //! * [`DebugInfo`](./struct.DebugInfo.html): The `.debug_info` section. //! //! * [`DebugLine`](./struct.DebugLine.html): The `.debug_line` section. //! //! * [`DebugLoc`](./struct.DebugLoc.html): The `.debug_loc` section. //! //! * [`DebugPubNames`](./struct.DebugPubNames.html): The `.debug_pubnames` //! section. //! //! * [`DebugPubTypes`](./struct.DebugPubTypes.html): The `.debug_pubtypes` //! section. //! //! * [`DebugRanges`](./struct.DebugRanges.html): The `.debug_ranges` section. //! //! * [`DebugStr`](./struct.DebugStr.html): The `.debug_str` section. //! //! * [`DebugTypes`](./struct.DebugTypes.html): The `.debug_types` section. //! //! * [`EhFrame`](./struct.EhFrame.html): The `.eh_frame` section. //! //! * [`EhFrameHdr`](./struct.EhFrameHdr.html): The `.eh_frame_hdr` section. //! //! * Each section type exposes methods for accessing the debugging data encoded //! in that section. For example, the [`DebugInfo`](./struct.DebugInfo.html) //! struct has the [`units`](./struct.DebugInfo.html#method.units) method for //! iterating over the compilation units defined within it. //! //! * Offsets into a section are strongly typed: an offset into `.debug_info` is //! the [`DebugInfoOffset`](./struct.DebugInfoOffset.html) type. It cannot be //! used to index into the [`DebugLine`](./struct.DebugLine.html) type because //! `DebugLine` represents the `.debug_line` section. 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`](https://crates.io/crates/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: //! //! ``` //! // Add the `fallible-iterator` crate. Don't forget to add it to your //! // `Cargo.toml`, too! //! extern crate fallible_iterator; //! extern crate gimli; //! //! // Use the `FallibleIterator` trait so its methods are in scope! //! use fallible_iterator::FallibleIterator; //! use gimli::{DebugAranges, EndianBuf, LittleEndian}; //! //! fn find_sum_of_address_range_lengths(aranges: DebugAranges<EndianBuf<LittleEndian>>) //! -> gimli::Result<u64> //! { //! // `DebugAranges::items` returns a `FallibleIterator`! //! aranges.items() //! // `map` is provided by `FallibleIterator`! //! .map(|arange| arange.length()) //! // `fold` is provided by `FallibleIterator`! //! .fold(0, |sum, len| sum + len) //! } //! //! # fn main() {} //! ``` //! //! ## Cargo Features //! //! Cargo features that can be enabled with `gimli`: //! //! * `std`: Enabled by default. Use the `std` library. Disabling this feature //! allows using `gimli` in embedded environments that do not have access to //! `std`. Note that even when `std` is disabled, `gimli` still requires an //! implementation of the `alloc` crate, and you must enable the `nightly` //! feature. //! //! * `alloc`: Nightly only. Enables usage of the unstable, nightly-only //! `#![feature(alloc)]` Rust feature that allows `gimli` to use boxes and //! collection types in a `#[no_std]` environment. #![deny(missing_docs)] #![deny(missing_debug_implementations)] // Allow clippy warnings when we aren't building with clippy. #![allow(unknown_lints)] // False positives with `fallible_iterator`. #![allow(should_implement_trait)] // Many false positives involving `continue`. #![allow(never_loop)] // False positives when block expressions are used inside an assertion. #![allow(panic_params)] #![no_std] #![cfg_attr(feature = "alloc", feature(alloc))] #[cfg(feature = "std")] #[macro_use] extern crate std; #[cfg(not(feature = "std"))] #[macro_use] extern crate alloc; #[cfg(not(feature = "std"))] #[macro_use] extern crate core as std; extern crate arrayvec; extern crate byteorder; extern crate fallible_iterator; extern crate stable_deref_trait; #[cfg(feature = "std")] mod imports { pub use std::borrow; pub use std::boxed; pub use std::collections::btree_map; pub use std::rc; pub use std::string; pub use std::sync::Arc; pub use std::vec; } #[cfg(not(feature = "std"))] mod imports { pub use alloc::sync::Arc; pub use alloc::borrow; pub use alloc::boxed; pub use alloc::collections::btree_map; pub use alloc::rc; pub use alloc::string; pub use alloc::vec; } use imports::*; pub use stable_deref_trait::{CloneStableDeref, StableDeref}; mod cfi; pub use cfi::*; mod constants; pub use constants::*; mod endianity; pub use endianity::{BigEndian, Endianity, LittleEndian, NativeEndian, RunTimeEndian}; mod endian_slice; pub use endian_slice::EndianSlice; mod endian_reader; pub use endian_reader::{EndianArcSlice, EndianRcSlice, EndianReader}; /// `EndianBuf` has been renamed to `EndianSlice`. For ease of upgrading across /// `gimli` versions, we export this type alias. #[deprecated(note = "EndianBuf has been renamed to EndianSlice, use that instead.")] pub type EndianBuf<'input, Endian> = EndianSlice<'input, Endian>; pub mod leb128; mod parser; pub use parser::{Error, Format, Result}; pub use parser::{DebugMacinfoOffset, Pointer}; mod reader; pub use reader::{Reader, ReaderOffset}; mod abbrev; pub use abbrev::{Abbreviation, Abbreviations, AttributeSpecification, DebugAbbrev, DebugAbbrevOffset}; mod aranges; pub use aranges::{ArangeEntry, ArangeEntryIter, DebugAranges}; mod line; pub use line::*; mod loclists; pub use loclists::{DebugLoc, DebugLocLists, LocListIter, LocationListEntry, LocationLists, LocationListsOffset, RawLocListEntry, RawLocListIter}; mod lookup; mod op; pub use op::*; mod pubnames; pub use pubnames::{DebugPubNames, PubNamesEntry, PubNamesEntryIter}; mod pubtypes; pub use pubtypes::{DebugPubTypes, PubTypesEntry, PubTypesEntryIter}; mod rnglists; pub use rnglists::{DebugRanges, DebugRngLists, Range, RangeLists, RangeListsOffset, RawRngListEntry, RngListIter}; mod str; pub use str::*; #[cfg(test)] mod test_util; mod unit; pub use unit::{CompilationUnitHeader, CompilationUnitHeadersIter, DebugInfo, DebugInfoOffset, UnitOffset}; pub use unit::{DebugTypeSignature, DebugTypes, DebugTypesOffset, TypeUnitHeader, TypeUnitHeadersIter}; pub use unit::{DebuggingInformationEntry, EntriesCursor, EntriesTree, EntriesTreeIter, EntriesTreeNode}; pub use unit::{Attribute, AttributeValue, AttrsIter}; mod value; pub use value::{Value, ValueType}; /// A convenience trait for loading DWARF sections from object files. To be /// used like: /// /// ``` /// use gimli::{DebugInfo, EndianBuf, LittleEndian, Reader, Section}; /// /// fn load_section<R, S, F>(loader: F) -> S /// where R: Reader, S: Section<R>, F: FnOnce(&'static str) -> R /// { /// let data = loader(S::section_name()); /// S::from(data) /// } /// /// let buf = [0x00, 0x01, 0x02, 0x03]; /// let reader = EndianBuf::new(&buf, LittleEndian); /// /// let debug_info: DebugInfo<_> = load_section(|_: &'static str| reader); /// ``` pub trait Section<R: Reader>: From<R> { /// Returns the ELF section name for this type. fn section_name() -> &'static str; }