Фильтруем логи санитайзеров и valgrind на примере приложения с Qt26.11.2023 22:00

Полученная информация поможет нам организовать сокрытие отчета об ошибках в используемых библиотеках. Подробнее о видах фильтрации логов можно прочитать в документации (https://valgrind.org/docs/manual/manual-core.html#manual-core.suppress). Нас же будет интересовать скрытие всей информации об ошибках в библиотеках. Создадим файл qwidget.supp и заблокируем вывод ошибок в лог :

Пример:

{
   
   Memcheck:Leak
   ...
   obj:/usr/lib/x86_64-linux-gnu/libgtk-x11*
}

Все фильтры

{
   
   Memcheck:Leak
   ...
   obj:/usr/lib/x86_64-linux-gnu/libgtk-x11*
}
{  
   
   Memcheck:Cond
   ...
   obj:/usr/lib/x86_64-linux-gnu/libgtk-x11*
}
{
   
   Memcheck:Leak
   ...
   obj:/usr/lib/x86_64-linux-gnu/libcairo*
}
{  
   
   Memcheck:Cond
   ...
   obj:/usr/lib/x86_64-linux-gnu/libcairo*
}
{
   
   Memcheck:Leak
   ...
   obj:/usr/lib/x86_64-linux-gnu/libX11*
}
{  
   
   Memcheck:Cond
   ...
   obj:/usr/lib/x86_64-linux-gnu/libX11*
}
{
   
   Memcheck:Leak
   ...
   obj:/usr/lib/x86_64-linux-gnu/libglib*
}
{  
   
   Memcheck:Cond
   ...
   obj:/usr/lib/x86_64-linux-gnu/libglib*
}
{
   
   Memcheck:Leak
   ...
   obj:/usr/lib/x86_64-linux-gnu/libfontconfig*
}
{  
   
   Memcheck:Cond
   ...
   obj:/usr/lib/x86_64-linux-gnu/libfontconfig*
}
{
   
   Memcheck:Leak
   ...
   obj:/usr/lib/x86_64-linux-gnu/libQt5*
}
{  
   
   Memcheck:Cond
   ...
   obj:/usr/lib/x86_64-linux-gnu/libQt5*
}

Затем перезапустим сдобавлением флага –suppressions, после которого укажем путь к файлу с фильтрами qwidget.supp

# bin/bash

export DIR="_debug_wid"
if ! [[ -d "$DIR" ]];
then
mkdir "$DIR"
fi;

cd $DIR

cmake -DCMAKE_BUILD_TYPE=Debug ../cmake-qt-widgets

make -j$(nproc) 

valgrind --leak-check=full --error-limit=no --suppressions=../qwidget.supp --log-file=qt-widgets-test.log ./cmake-qt-widgets

Лог будет содержать только общую информацию о найденных ошибках

==74932== HEAP SUMMARY:
==74932==     in use at exit: 1,694,522 bytes in 19,826 blocks
==74932==   total heap usage: 71,338 allocs, 51,512 frees, 1,957,135,144 bytes allocated
==74932== 
==74932== LEAK SUMMARY:
==74932==    definitely lost: 0 bytes in 0 blocks
==74932==    indirectly lost: 0 bytes in 0 blocks
==74932==      possibly lost: 0 bytes in 0 blocks
==74932==    still reachable: 0 bytes in 0 blocks
==74932==                       of which reachable via heuristic:
==74932==                         length64           : 6,848 bytes in 77 blocks
==74932==                         newarray           : 1,904 bytes in 39 blocks
==74932==         suppressed: 1,453,330 bytes in 18,834 blocks
==74932== 
==74932== For lists of detected and suppressed errors, rerun with: -s
==74932== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 41 from 41)

Теперь удостоверимся в том, что новые ошибки не будут игнорироваться, изменим исходный код нашего приложения, добавив туда утечку памяти:

int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
    QMainWindow m ;
    m.show();
    std::printf( "Run!\n");
    int* leak = new int(5);
    leak = nullptr;
    return a.exec();
}

Сборка и запуск обновленного кода приведет к добавлению в лог информации о нашей ошибке:

4 bytes in 1 blocks are definitely lost in loss record 41 of 6,398
at 0x483BE63: operator new(unsigned long) (in /usr/lib/x86_64-linux-gnu/valgrind/vgpreload_memcheck-amd64-linux.so) by 0x10932D: main (main.cpp:16)
....
ERROR SUMMARY: 1 errors from 1 contexts (suppressed: 41 from 41)

Создание фильтров для санитайзеров

Удалим из нашего кода с утечку памяти:

int* leak = new int(5);
leak = nullptr;

Для запуска нашего приложения под санитайзерами придется предопределить переменные среды (CFLAGS, CXXFLAGS, LDFLAGS, LSAN_OPTIONS, ASAN_OPTIONS, UBSAN_OPTIONS):

# bin/bash

CUR_PATH=$PWD
PROJECT="qwgt"
echo $CUR_PATH

export DIR="_debug_$PROJECT"
if ! [[ -d "$DIR" ]];
then
mkdir "$DIR"
fi;

export DIR_SAN="_sanit_$PROJECT"
if ! [[ -d "$DIR_SAN" ]];
then
mkdir "$DIR_SAN"
fi;

cd $DIR

export CFLAGS="$CFLAGS -g -fsanitize=address,undefined"
export CXXFLAGS="$CXXFLAGS $CFLAGS"
export LDFLAGS="-fsanitize=address,undefined"
export LSAN_OPTIONS="fast_unwind_on_malloc=0"
export ASAN_OPTIONS="halt_on_error=0 detect_leaks=1"
export UBSAN_OPTIONS="print_stacktrace=1"
echo 'set env done.'

cmake -DCMAKE_BUILD_TYPE=Debug -DCHECK_COVER=ON -DUSE_SANITIZERS=ON ..
cmake --build . -- -j$(nproc)

cd ./cmake-qt-widgets
./cmake-qt-widgets 2> $CUR_PATH/$DIR_SAN/sanit.log

В логе мы увидим несколько тысяч строк примерно такого содержания:

Indirect leak of 3 byte(s) in 1 object(s) allocated from:
    #27 0x7fbee755f39c in QApplicationPrivate::initialize() (/lib/x86_64-linux-gnu/libQt5Widgets.so.5+0x17139c)
    #28 0x7fbee755f3f7 in QApplicationPrivate::init() (/lib/x86_64-linux-gnu/libQt5Widgets.so.5+0x1713f7)
    #29 0x5561cf0908e3 in main /media/build/35CA936957ED7A1D/cppProj/cmake-code-cov-sanit/cmake-qt-widgets/main.cpp:12

SUMMARY: AddressSanitizer: 17831 byte(s) leaked in 630 allocation(s).

Т.е. санитайзеры, как и valgrind, детектируют ряд ошибок в системных библиотеках, но мы уже морально готовы к этому и, все еще, хотим получать информацию только об ошибках сделаных именно нами. Для этого создадим файл leak_suppr.txt и заполним его следующим текстом:

# This is a known leak.
leak:lsan_error::error
leak:QApplicationPrivate::init
leak:libgobject
leak:libpango
leak:libfontconfig

В документации санитайзеров (https://clang.llvm.org/docs/LeakSanitizer.html; https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer) о видах фильтрации логов инормации не так много, но примеры можно найти тут (https://sources.debian.org/src/qtwebengine-opensource-src/5.7.1+dfsg-6.1/src/3rdparty/chromium/build/sanitizers/lsan_suppressions.cc/ ; https://chromium.googlesource.com/external/github.com/google/proto-quic/+/0a5589a3da02d9e7eacf17dbef3ddaefc08b3f58/src/build/sanitizers/lsan_suppressions.cc). Добавим в переменную окружения LSAN_OPTIONS упоминание о нашем фильтре suppressions=$CUR_PATH/leak_suppr.txt и запустим наш код:

# bin/bash

CUR_PATH=$PWD
PROJECT="qwgt"
echo $CUR_PATH

export DIR="_debug_$PROJECT"
if ! [[ -d "$DIR" ]];
then
mkdir "$DIR"
fi;

export DIR_SAN="_sanit_$PROJECT"
if ! [[ -d "$DIR_SAN" ]];
then
mkdir "$DIR_SAN"
fi;

cd $DIR

export CFLAGS="$CFLAGS -g -fsanitize=address,undefined"
export CXXFLAGS="$CXXFLAGS $CFLAGS"
export LDFLAGS="-fsanitize=address,undefined"
export LSAN_OPTIONS="fast_unwind_on_malloc=0 suppressions=$CUR_PATH/leak_suppr.txt"
export ASAN_OPTIONS="halt_on_error=0 detect_leaks=1"
export UBSAN_OPTIONS="print_stacktrace=1"
echo 'set env done.'

cmake -DCMAKE_BUILD_TYPE=Debug -DCHECK_COVER=ON -DUSE_SANITIZERS=ON ..
cmake --build . -- -j$(nproc)

cd ./cmake-qt-widgets
./cmake-qt-widgets 2> $CUR_PATH/$DIR_SAN/sanit.log

Мы опять получим лог, который будет содержать только общую информацию о найденных ошибках:

-----------------------------------------------------
 Suppressions used:
   count      bytes template
     630      17831 libfontconfig
-----------------------------------------------------

Теперь вернем наш код с утечкой памяти:

int* leak = new int(5);
leak = nullptr;

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

  =================================================================
  ==18029==ERROR: LeakSanitizer: detected memory leaks
  
  Direct leak of 4 byte(s) in 1 object(s) allocated from:
      #0 0x7f915636c587 in operator new(unsigned long) ../../../../src/libsani    tizer/asan/asan_new_delete.cc:104
      #1 0x5644af09eb22 in main /media/build/35CA936957ED7A1D/cppProj/cmake-co    de-cov-sanit/cmake-qt-widgets/main.cpp:16
      #2 0x7f91541dc082 in __libc_start_main ../csu/libc-start.c:308
      #3 0x5644af09e73d in _start (/media/build/35CA936957ED7A1D/cppProj/cmake    -code-cov-sanit/_debug_qwgt/cmake-qt-widgets/cmake-code-cov-s    anit-qt-widgets+0x373d)
 
  -----------------------------------------------------
  Suppressions used:
    count      bytes template
      630      17831 libfontconfig
  -----------------------------------------------------
  
  SUMMARY: AddressSanitizer: 4 byte(s) leaked in 1 allocation(s).

Заключение

Приведенные выше методы проверки кода на ошибки относительно просто объединить с запуском тестов и интегрировать в CI вашего проекта, что, без сомнения, повысит уровень качества вашего ПО и откроет новые грани восприятия, используемых вами, сторонних библиотек.

© Habrahabr.ru