Odczytywanie raportów

Raport Valgrind składa się z trzech części:

• Prefiks identyfikatora procesu w każdym wierszu
• Jeden lub więcej bloków błędów pojawiających się w trakcie działania
• Końcowe podsumowanie HEAP and LEAK SUMMARY przy zakończeniu programu

Umiejętność odczytywania każdej z tych części zamienia ścianę tekstu w precyzyjną listę zadań.

Każdy wiersz Valgrind rozpoczyna się od ==PID==, na przykład ==12345==.

Jest to identyfikator procesu, a nie część danych wyjściowych programu. Pozwala oddzielić komunikaty Valgrind od wywołań printf programu, gdy oba strumienie korzystają z tego samego terminala.

Oto rzeczywisty blok dotyczący nieprawidłowego zapisu:

==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)

Pierwszy wiersz określa rodzaj i rozmiar błędu: „Invalid write of size 4”.

Rozmiar 4 oznacza dostęp do 4 bajtów, zwykle do wartości typu int. Ten jeden wiersz informuje, jakiej kategorii błędu należy się spodziewać, zanim przeczyta Pan/Pani resztę raportu.

Wiersz at wskazuje najbardziej wewnętrzną ramkę, w której wystąpił błąd. Każdy wiersz by przedstawia wywołującego znajdującego się o jeden poziom wyżej.

Należy czytać od góry do dołu, od najgłębszej do najbardziej zewnętrznej ramki. Pierwsza ramka zawierająca nazwę Państwa pliku jest niemal zawsze miejscem wystąpienia błędu.

Wiersz Address ... określa położenie dostępu względem znanego bloku:

• 0 bytes after a block of size 20 alloc'd — przepełnienie następujące bezpośrednio za końcem
• 4 bytes inside a block of size 4 free'd — użycie po zwolnieniu
• on thread 1's stack — dostęp do stosu

Pokazuje również miejsce, w którym ten blok został zaalokowany lub zwolniony.

Przy zakończeniu programu wyświetlane jest rozliczenie alokacji:

==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

Wartość większa od zera przy „in use at exit” oznacza, że czegoś nie zwolniono.

Poniżej podsumowania sterty wycieki są pogrupowane:

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

Należy dodać --leak-check=full, aby do każdego utraconego bloku dołączyć ślad wywołań.

Ostatni wiersz zawiera podsumowanie wszystkich błędów:

ERROR SUMMARY: 2 errors from 2 contexts

„Kontekst” oznacza unikalne miejsce wystąpienia błędu. Jeśli wadliwy wiersz wykona się milion razy w pętli, nadal będzie to jeden kontekst. Celem jest uzyskanie 0 errors from 0 contexts.

Należy analizować raport metodycznie:

• Najpierw naprawić błędy nieprawidłowego dostępu, ponieważ powodują uszkodzenie danych
• Następnie błędy dotyczące niezainicjalizowanych wartości
• Potem wycieki oznaczone jako definitely i indirectly lost
• Po każdej poprawce uruchomić program ponownie; jedna przyczyna źródłowa często usuwa kilka zgłoszeń

Niektóre błędy pochodzą z bibliotek, których nie można naprawić, takich jak środowisko uruchomieniowe C lub sterownik karty graficznej. Należy wygenerować plik wyciszeń, aby ukryć te komunikaty bez maskowania własnych błędów.

--gen-suppressions=all wypisuje gotowe wpisy wyciszeń, które można zapisać, a następnie ponownie przekazać za pomocą --suppressions=file.

Proszę zinterpretować jeden wiersz raportu.

Potrafi już Pan/Pani czytać raporty Valgrind od początku do końca:

• Prefiksy ==PID== oznaczają wiersze Valgrind i oddzielają je od danych wyjściowych programu
• Każdy blok błędu zawiera jego rodzaj, rozmiar, ślad stosu oraz informację o adresie
• Podsumowania HEAP/LEAK rozliczają alokacje i utraconą pamięć
• ERROR SUMMARY zlicza unikalne konteksty; należy dążyć do zera

Najpierw należy usuwać błędy dostępu, a następnie wycieki, uruchamiając program ponownie po drodze.