9 releases (breaking)

0.8.0 Aug 6, 2024
0.7.0 Aug 14, 2023
0.6.0 Apr 21, 2023
0.5.0 Feb 22, 2023
0.1.1 Dec 18, 2021

#294 in Debugging

35 downloads per month

MIT/Apache

99KB
2K SLoC

thorin

thorin is an DWARF packaging utility for creating DWARF packages (*.dwp files) out of input DWARF objects (*.dwo files; or *.o files with .dwo sections), supporting both the pre-standard GNU extension format for DWARF packages and the standardized format introduced in DWARF 5.

thorin was written as part of the implementation of Split DWARF in rustc. A Rust implementation of a DWARF packaging utility is easier to integrate into the compiler and can support features like loading dwarf objects from archive files (or rustc's rlibs) which are helpful in supporting cross-crate Split DWARF packaging in rustc.

Usage

thorin can read input DWARF objects from executables or can package arbitrary input dwarf objects (including DWARF objects in archive files, such as Rust rlibs)! Install thorin using cargo:

$ cargo install thorin-dwp-bin
$ thorin --help
thorin 0.8.0
merge dwarf objects into dwarf packages

USAGE:
    thorin [OPTIONS] [--] [inputs]...

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -e, --exec <executables>...    Specify path to executables to read list of dwarf objects from
    -o, --output <output>          Specify path to write the dwarf package to [default: -]

ARGS:
    <inputs>...    Specify path to input dwarf objects and packages

If the input objects are of DWARF version 5 or greater, then the output package will be in DWARF 5 format. For version 4 and below, the GNU Extension format will be used for the output package.

Stability

thorin's command-line interface is intended to be stable and have limited breaking changes.


Name

thorin is named after Thorin Oakenshield from The Hobbit, as Thorin is a dwarf who leads other dwarves. thorin uses the gimli library (named after a dwarf from Lord of the Rings) to read DWARF format debug information, the name of which is a medieval fantasy complement to ELF, the file format for executables and object files.
You could also call this project rust-dwp, if you'd prefer that.

Author and acknowledgements

thorin is authored by David Wood of Huawei Technologies Research & Development (UK) Ltd. thorin is maintained by the Rust Compiler Team.
In addition, thanks to the authors of object and gimli, on which this utility depends heavily; and to Philip Craig for advice and reviews during initial implementation of thorin.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Code of conduct

When contributing or interacting with this project, we ask abide the Rust Code of Conduct and ask that you do too.

Dependencies

~10–17MB
~214K SLoC