diff --git a/doc/valgrind.txt b/doc/valgrind.txt new file mode 100644 index 000000000..067e29618 --- /dev/null +++ b/doc/valgrind.txt @@ -0,0 +1,19 @@ +If you're having certain types of crashes, such as those associated with +memory corruption, a bug marshal may ask you to run Asterisk under valgrind. +You should follow these steps, to give the bug marshal the maximum amount +of information about the crash. + +1. Run 'make menuselect' and in the Compiler Options, enable MALLOC_DEBUG + and DONT_OPTIMIZE. A bug marshal may also ask you to enable additional + compiler flags, such as DEBUG_THREADS, depending upon the nature of the + issue. + +2. Rebuild and install Asterisk. + +3. Run Asterisk as follows: + valgrind --log-file-exact=valgrind.txt asterisk -vvvvcg 2>malloc_debug.txt + +4. Reproduce the issue. Following the manifestation of the issue (or when + the process crashes), upload the two files, valgrind.txt and + malloc_debug.txt to the issue tracker. +