Независим преглед на PVS-Studio (Linux, C++)

Видях публикация, която гласи, че PVS наистина е научил как да анализира под Линукс, и реших да опитам в проектите си. И ето какво се получи.

Съдържание

1. Плюсове
2. Минуси
3. Резюме
4. Следсловие

Плюсове

Отзивчива поддръжка

Попитах за пробен ключ и в същия ден ми го изпратиха.

Достатъчно ясна документация

Успях да стартирам анализатора без особени проблеми. Има и справка за консолните команди (въпреки че тук има забележки, вижте раздела Минуси).

Възможност за многопоточно анализиране

Анализаторът има "стандартна" опция -j, която позволява да се извършва анализ паралелно в няколко задачи. Това спестява значително време.

Добра визуализация

Много различни формати на изход, от текстов до малка уеб интерфейс. Уеб интерфейсът е удобен, лаконичен, с подсказки до редовете в кода и линкове към описанията на диагностика.

Лесна интеграция в компилация

Цялата документация е на сайта им, само ще кажа, че ако вашият проект е компилиран с помощта на CMake, всичко е много просто.

Добри описания на диагностиките

Ако генерирате изход в режим fullhtml, то всяко съобщение има линк към описанието на диагностиката, с разяснения, примери за код и допълнителни линкове.

Минуси

Неизвестен анализатор на C++

За съжаление, PVS понякога греши в синтаксиса и генерира фалшиво положителни съобщения при напълно коректен код.

Например, има функция, която връща празен:

template 
auto copy (const void * source, void * destination)
    ->
        std::enable_if_t
        <
            std::is_copy_constructible::value
        >
{
    new (destination) T(*static_cast(source));
}

Да, ключовата дума auto може да означава празен, затова е и auto. Но PVS издаде следните съобщения:

dynamic_tuple_management.hpp:29:1: грешка: V591 Не-void функция трябва да върне стойност.
dynamic_tuple_management.hpp:29:1: грешка: V2542 Функция с не-void тип на връщане трябва да върне стойност от всички изходни пътеки.

Много бавен сайт

Да, в уеб интерфейса до всяко съобщение има линк към съответното описание на диагностика с примери. Но при натискане на линка се налага да изчакаш доста дълго, а понякога се случва и 504 Gateway Time-out.

Език

Всички описания са на руски, това е отлично. Но линковете от доклада винаги водят към английската версия. Би било добре да има възможност за превключване на езика, за да може диагностиките да се преглеждат веднага на руски. В интерфейса не намерих такава възможност.

Неудобно е да се работи с нивата на диагностика през конзолата

Нека започнем с това, че двете използвани команди (това pvs-studio-analyzer и plog-converter) имат различни формати за задаване на диагностики.

Справката за pvs-studio-analyzer казва:

-a [MODE], --analysis-mode [MODE]
    MODE определя типа на предупрежденията:
    1 - 64-битови грешки;
    2 - запазени;
    4 - Обща анализа;
    8 - Микрооптимизации;
    16 - Специфични запитвания от клиенти;
    32 - MISRA.
    Режимите могат да се комбинират чрез добавяне на стойности.
    По подразбиране: 4

Дълго време се опитвах да разбера къде трябва да добавям («adding the values») ключовете. Опитвах се да ги изброявам с запетая:

pvs-studio-analyzer analyze ... -a 1,4,16

Опитвах се да задавам ключа няколко пъти:

pvs-studio-analyzer analyze ... -a 1 -a 4 -a 16

И едва след това осъзнах, че това са битови маски! И трябва да сумирам, а не добавям стойностите. Например, за да получа общи диагностики, диагностики по микрооптимизации и MISRA, трябва да ги сумирам (4 + 8 + 32 = 44):

pvs-studio-analyzer analyze ... -a 44

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

Освен това, има и инструмент plog-converter, който генерира човешки четима информация за статичния анализ. Има и други особености.

Справката за програмата plog-converter съобщава:

-a, --analyzer            Посочва анализатор(и) и ниво(а), които да се
                          използват за филтриране, т.е.
                          'GA:1,2;64:1;OP:1,2,3;CS:1;MISRA:1,2'
                          По подразбиране: GA:1,2

Появиха се някакви «нивота», които преди не съществуваха, и в документацията не намерих нищо за тях.

Общо взето, не е ясно. Затова всичко на максимални стойности го поставях.

Куп объркващи оплаквания на Catch

В два от трите проекта, които анализирах, се използва библиотека за модулно тестване Catch2. И огромната част от съобщенията (!!! 90 от 138 в един и 297 от 344 в друг !!!) имат следния вид:

Не отчита многопоточността

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

Впрочем, може ли наистина статичният анализатор да отчете такова нещо? Не знам.

Резюме

PVS не намери нито една истинска грешка в моите отворени проекти Burst и Proxima, както и в работния проект, който, по известни причини, не мога да представя. Вярно е, че вече бяха идентифицирани и коригирани някои недоразумения с помощта на Cppcheck и scan-build.

Общото впечатление от всички тези анализатори е приблизително същото: да, нещо улавят, понякога дори нещо важно, но като цяло компилаторът е достатъчен.

Възможно е (и на мен ми е приятно да мисля така), че нашият екип използва практики за разработка на софтуер, които позволяват генерирането на минимално количество лош код. По-добре е да не създаваме проблеми, отколкото героично да ги преодолеем.

Затова си позволявам да дам няколко съвета как да пишете на C++, така че да не нараните никого и да не си нанасяте удари по главата.

Използвайте диагностика на компилатора на максимум.

Нашият екип използва (и ви съветва) следните опции за компилиране:

-Werror

-Wall
-Wextra
-Wpedantic

-Wcast-align
-Wcast-qual
-Wconversion
-Wctor-dtor-privacy
-Wenum-compare
-Wfloat-equal
-Wnon-virtual-dtor
-Wold-style-cast
-Woverloaded-virtual
-Wredundant-decls
-Wsign-conversion
-Wsign-promo

Включете ги в проекта си, ще научите много ново за кода си.

Придържайте се към стандарта.

Опитвайте се да избягвате платформи, ако имате стандартни аналози. А ако не можете да минете без тях, обградете ги със специални блокове за макроси (или по друг начин) и просто не позволявайте компилирането на вашия код в неподдържани условия.

Дръжте се на стандартната семантика на операциите

Събирането трябва да бъде събиране, умножението — умножение, извикването на функция — извикване на функция, копирането трябва да копира, преместването — да премества, контейнера трябва да е итерируем, итераторът трябва да има напредване ++ и разименуване *. И така нататък, и така нататък.

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

Пишете съвместим код

Първоначално имам предвид стандартната библиотека. Много е желателно интерфейсите на вашите класове и функции да могат да се използват със стандартни и други библиотеки (например Boost).

Не се колебайте да погледнете интерфейсите на STL и Boost. С изключение на редки случаи, там ще видите достойни примери за подражание.

Използвайте максимално отворените инструменти

Има поне два открити безплатни инструмента за статичен анализ, които лесно могат да се свържат с всеки проект, използващ системата за изграждане CMake.

Повече информация можете да прочетете в моята последна публикация.

Следсловие

Накрая искам да подчертая, че не призовавам да не се използва PVS или други статични анализатори. Но ви призовавам да се замислите как така се е случило, че статичният анализатор постоянно открива значителни грешки във вашия код.

Това е само следствие. Трябва да търсите и отстранявате причината.

Източник: habr.com