Чтение отчётов

Отчёт Valgrind состоит из трёх частей:

• префикс ID процесса в каждой строке
• Один или несколько блоков ошибок по мере их возникновения
• Итоговая сводка HEAP и LEAK при завершении

Умение читать каждую часть превращает стену текста в точный список задач.

Каждая строка Valgrind начинается с ==PID==, например ==12345==.

Это ID процесса, а не часть вывода Вашей программы. Он позволяет отделить сообщения Valgrind от вывода программы через printf, когда оба вывода направляются в один терминал.

Вот настоящий блок с ошибкой записи:

==12345== Invalid write of size 4
==12345== at 0x4005A1: main (prog.c:6)
==12345== Address 0x520304c is 0 bytes after a block of size 20 alloc'd
==12345== at 0x4838B40: malloc
==12345== by 0x40058E: main (prog.c:5)

В первой строке указаны вид и размер ошибки: 'Invalid write of size 4'.

Размер 4 означает доступ к 4 байтам, обычно к значению типа int. Уже эта строка сообщает, какую категорию ошибки следует искать, ещё до дальнейшего чтения отчёта.

Строка at соответствует самому внутреннему кадру — месту возникновения ошибки. Каждая строка by содержит вызывающую функцию на уровень выше.

Читайте строки сверху вниз: от самого глубокого кадра к самому внешнему. Первый кадр с именем Вашего файла почти всегда указывает на место ошибки.

Строка Address ... указывает расположение доступа относительно известного блока:

• 0 bytes after a block of size 20 alloc'd — переполнение сразу за концом блока
• 4 bytes inside a block of size 4 free'd — использование после освобождения
• on thread 1's stack — доступ к стеку

В ней также указано, где этот блок был выделен или освобождён.

При завершении Вы получаете сведения о выделении памяти:

==12345== HEAP SUMMARY:
==12345== in use at exit: 20 bytes in 1 blocks
==12345== total heap usage: 3 allocs, 2 frees, 1,044 bytes allocated

Значение 'in use at exit' больше нуля означает, что что-то не было освобождено.

Ниже сводки кучи утечки распределяются по категориям:

definitely lost: 20 bytes in 1 blocks
indirectly lost: 0 bytes in 0 blocks
possibly lost: 0 bytes in 0 blocks
still reachable: 0 bytes in 0 blocks

Добавьте --leak-check=full, чтобы прикрепить трассировку к каждому потерянному блоку.

В самой последней строке подсчитывается всё:

ERROR SUMMARY: 2 errors from 2 contexts

«Контекст» — это уникальное место ошибки. Если строка с ошибкой выполняется в цикле миллион раз, это всё равно один контекст. Ваша цель — 0 errors from 0 contexts.

Работайте с отчётом методично:

• Сначала исправьте ошибки недопустимого доступа — они вызывают повреждение данных
• Затем исправьте ошибки неинициализированных значений
• После этого устраните утечки с пометками definitely и indirectly lost
• После каждого исправления запускайте программу снова: одна корневая причина часто устраняет сразу несколько сообщений

Некоторые ошибки исходят из библиотек, которые Вы не можете исправить, например из среды выполнения C или графического драйвера. Создайте файл подавления, чтобы скрыть такие сообщения, не маскируя собственные ошибки.

--gen-suppressions=all выводит готовые записи подавления. Сохраните их и снова передайте с помощью --suppressions=file.

Интерпретируйте одну строку отчёта.

Теперь Вы умеете читать отчёты Valgrind от начала до конца:

• Префиксы ==PID== обозначают строки Valgrind и отделяют их от вывода программы
• Каждый блок ошибки содержит её вид, размер, трассировку стека и примечание об адресе
• Сводки HEAP/LEAK учитывают выделенную и потерянную память
• Сводка ERROR подсчитывает уникальные контексты; стремитесь к нулю

Сначала устраняйте ошибки доступа, затем утечки, повторно запуская программу после каждого изменения.