C++ Crash Explainer

A beginner-friendly developer tool that translates cryptic C++ AddressSanitizer (ASan) and LeakSanitizer (LSan) diagnostic reports into plain, actionable English.

🎯 Supported Diagnostic Categories

Compiling C++ programs with -fsanitize=address is the gold standard for catching memory safety errors (like buffer overflows and use-after-free bugs). However, the default diagnostic output is verbose, technical, and often overwhelms students and beginners.

C++ Crash Explainer parses the raw ASan crash report and provides:

1. Error Type: What kind of bug happened in clear terms.
2. Where: The exact source file, line number, and function where the crash occurred.
3. What The Report Tells Us: Facts extracted from the report (how many bytes were read/written, buffer size, allocation site).
4. What To Check Next: Actionable hints on common root causes (off-by-one errors, loop boundaries, pointer math).
5. Limitations: Clear statements on what the report cannot know so beginners don't make assumptions.

🚀 Quick Start

Installation

pip install cpp-crash-explainer

Usage

Pass a saved AddressSanitizer report file directly:

cpp-crash-explainer report.txt

Or pipe a crash output directly via standard input:

./my_program 2>&1 | cpp-crash-explainer

💡 Example

Given an AddressSanitizer heap-buffer-overflow report, the tool outputs:

C++ CRASH EXPLAINER

ERROR TYPE
Heap buffer overflow

WHAT HAPPENED
The program attempted to read or write memory outside the valid boundaries of a dynamically allocated (heap) array or object.

WHERE
/home/student/projects/buffer_test.cpp:14 (in function 'main')

WHAT THE REPORT TELLS US
The program crashed while reading 4 byte(s). The memory access occurred 4 byte(s) past the end of a 40-byte allocated heap buffer. The heap buffer was allocated at /home/student/projects/buffer_test.cpp:10.

WHAT TO CHECK NEXT
1. Check the array/buffer indexing at the crash location to see if the index exceeds the size.
2. Remember that in C++, an array of size N has valid indices from 0 to N-1 (off-by-one errors are common).
3. Check loop bounds (e.g., using '<=' instead of '<').
4. If using raw pointers or manual allocation (new[] / malloc), verify that the allocated byte size matches the data type.

LIMITATIONS
AddressSanitizer detects that an out-of-bounds address was accessed, but it cannot know what value you intended to calculate or why the index became invalid. You must inspect the logic leading up to the access.

🧪 Running Tests

pytest