[go: up one dir, main page]

gimli 0.2.0

A zero-copy DWARF debugging format parser.
Documentation 
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

# `gimli`

[![](http://meritbadge.herokuapp.com/gimli)![](https://img.shields.io/crates/d/gimli.png)](https://crates.io/crates/gimli)

[![Build Status](https://travis-ci.org/fitzgen/gimli.png?branch=master)](https://travis-ci.org/fitzgen/gimli)

[![Coverage Status](https://coveralls.io/repos/github/fitzgen/gimli/badge.svg?branch=master)](https://coveralls.io/github/fitzgen/gimli?branch=master)

A zero-copy parser for the DWARF debugging format.

Bring your own object file loader: `gimli` makes no assumptions about what kind
of object file you're working with. The flipside to that is that it's up to you
to provide an ELF loader on Linux or Mach-O loader on OSX.

## Install

Either

    $ cargo add gimli

or add this to your `Cargo.toml`:

    [dependencies]
    gimli = "0.2.0"

## Documentation

[Documentation](http://fitzgen.github.io/gimli/gimli/index.html)

## TODO

* Better documentation and examples

* Gracefully handle all reserved values and vendor extensibility points
    * Might need to support some extensions like DWZ compressor which is used
      heavily for system libraries on at least Fedora.

* Be more future compatible by using "unknown" variants rather than throwing
  parse errors when we find something unexpected

* DWARF expressions and location descriptions

* ~~A CompilationUnitHeader iterator that skips across the DIE tree and just
  yields each header.~~
    * Factor this out and also have a `TypeUnitIterator` -- where do
      `PartialUnit`s fall into this again?

* Cursor-based DIE parsing
    * ~~next_dfs()~~
    * next_sibling()
    * ~~Needs to hold a reference to the current DIE to reuse the attribute parse
      when possible~~
    * implement two iterators on top of this:
        * iterate all DIEs in dfs
        * given a DIE, iterate its direct children

* Make a common `Unit` trait for all `CompilationUnit`, `TypeUnit`, and
  `PartialUnit` so DIEs can just have a fat pointer to their unit rather than be
  generic.