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