]>
Commit | Line | Data |
---|---|---|
94b46f34 XL |
1 | # libbacktrace |
2 | A C library that may be linked into a C/C++ program to produce symbolic backtraces | |
3 | ||
4 | Initially written by Ian Lance Taylor <iant@golang.org>. | |
5 | ||
6 | This is version 1.0. | |
7 | It is likely that this will always be version 1.0. | |
8 | ||
9 | The libbacktrace library may be linked into a program or library and | |
10 | used to produce symbolic backtraces. | |
11 | Sample uses would be to print a detailed backtrace when an error | |
12 | occurs or to gather detailed profiling information. | |
13 | ||
14 | The libbacktrace library is provided under a BSD license. | |
15 | See the source files for the exact license text. | |
16 | ||
17 | The public functions are declared and documented in the header file | |
18 | backtrace.h, which should be #include'd by a user of the library. | |
19 | ||
20 | Building libbacktrace will generate a file backtrace-supported.h, | |
21 | which a user of the library may use to determine whether backtraces | |
22 | will work. | |
23 | See the source file backtrace-supported.h.in for the macros that it | |
24 | defines. | |
25 | ||
26 | As of January 2018, libbacktrace only supports ELF, PE/COFF, and XCOFF | |
27 | executables with DWARF debugging information. | |
28 | The library is written to make it straightforward to add support for | |
29 | other object file and debugging formats. | |
30 | ||
31 | The library relies on the C++ unwind API defined at | |
32 | https://itanium-cxx-abi.github.io/cxx-abi/abi-eh.html | |
33 | This API is provided by GCC. |