Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rodlie/breakdown
A library (and tools) for parsing crash dumps
https://github.com/rodlie/breakdown
crash-details crash-dump crash-reporting google-breakpad linux macos mingw natron parsing-crash-dumps windows
Last synced: 13 days ago
JSON representation
A library (and tools) for parsing crash dumps
- Host: GitHub
- URL: https://github.com/rodlie/breakdown
- Owner: rodlie
- License: bsd-3-clause
- Created: 2020-04-02T05:51:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-02T15:59:24.000Z (over 1 year ago)
- Last Synced: 2024-10-11T02:45:06.202Z (about 1 month ago)
- Topics: crash-details, crash-dump, crash-reporting, google-breakpad, linux, macos, mingw, natron, parsing-crash-dumps, windows
- Language: C++
- Homepage:
- Size: 15.6 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Breakdown
Various applications and libraries for dumping symbols from binaries files and parsing crash dumps on Windows (MinGW-only), macOS (untested) and Linux.
Breakdown uses a [fork](https://github.com/NatronGitHub/breakpad) of Google Breakpad.
## Build and install
Requires pkg-config, CMake (3.0+), a c++11 compatible compiler (only GCC tested) and libzip.
```
git clone https://github.com/rodlie/breakdown
cd breakdown
git submodule update -i --recursive
mkdir build && cd build
cmake -DCMAKE_INSTALL_PREFIX=/usr .. && make
make DESTDIR= install
```
```
└── usr
├── bin
│ ├── breakdown-dumper
│ └── breakdown-parser
├── include
│ └── Breakdown
│ └── breakdown.h
├── lib64
│ ├── libBreakdown.so -> libBreakdown.so.2
│ ├── libBreakdown.so.2 -> libBreakdown.so.2.0.0
│ ├── libBreakdown.so.2.0.0
│ └── pkgconfig
│ └── breakdown.pc
└── share
└── doc
└── Breakdown-2.0.0
├── LICENSE
├── LICENSE.breakpad
└── README.md
```
## Symbols Storage
Symbols are stored using the following directory structure:
* ````
* ```` *(example: ``Natron-bin``)*
* ```` *(example: ``69CDA01A0F236F7C71CD19E5A20A21AC0``)*
* ```` *(example: ``Natron-bin.sym.zip``)*
```` and ```` must match line 1 in the symbol file.
Example : ``MODULE Linux x86_64 69CDA01A0F236F7C71CD19E5A20A21AC0 Natron-bin``
**Note that Breakdown only supports zipped symbols (``filename.sym.zip``)**
## Creating Symbols
Example:
```
breakdown-dumper Natron-bin > Natron-bin.sym
export SYMBOL_BIN=`head -1 Natron-bin.sym | awk '{print $5}'`
export SYMBOL_ID=`head -1 Natron-bin.sym | awk '{print $4}'`
mkdir -p symbols/$SYMBOL_BIN/$SYMBOL_ID
zip -9 Natron-bin.sym.zip Natron-bin.sym
mv Natron-bin.sym.zip symbols/$SYMBOL_BIN/$SYMBOL_ID/
```
```
symbols
└── Natron-bin
└── 69CDA01A0F236F7C71CD19E5A20A21AC0
└── Natron-bin.sym.zip
2 directories, 1 file
```
## Usage Example (library)
```
#include
std::string filename = "crash.dmp";
std::vector storage;
storage.push_back("symbols");
std::string result = Breakdown::generateCrashResultPlainText(filename, storage);
```
## Usage Example (application)
```
breakdown-parser symbols crash.dmp > result.txt
```
```
OS : Linux (0.0.0 Linux 4.4.172 #2 SMP Wed Jan 30 17:11:07 CST 2019 x86_64)
TYPE : SIGSEGV /0x00000000
MODULE : Natron-bin
FUNCTION : Natron::crash_application()
SOURCE : Settings.cpp:2228
...
```