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

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

Съдържание

1. Професионалисти
2. Против
3. Резултати от
4. послеслов

Професионалисти

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

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

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

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

Възможност за многонишков анализ

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

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

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

Лесна интеграция в монтажа

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

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

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

Против

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

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

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

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

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

dynamic_tuple_management.hpp:29:1: error: V591 Non-void function should return a value.
dynamic_tuple_management.hpp:29:1: error: V2542 Function with a non-void return type should return a value from all exit paths.

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

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

Език

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

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

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

Помощ за pvs-studio-analyzer чете:

-a [MODE], --analysis-mode [MODE]
    MODE defines the type of warnings:
    1 - 64-bit errors;
    2 - reserved;
    4 - General Analysis;
    8 - Micro-optimizations;
    16 - Customers Specific Requests;
    32 - MISRA.
    Modes can be combined by adding the values
    Default: 4

Прекарах дълго време в опити да разбера къде да отида добави („добавяне на стойностите“) ключове. Опитах се да ги изброя разделени със запетаи:

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            Specifies analyzer(s) and level(s) to be
                          used for filtering, i.e.
                          'GA:1,2;64:1;OP:1,2,3;CS:1;MISRA:1,2'
                          Default: GA:1,2

Тук се появиха някои „нива“, които не бяха там преди, и аз също не намерих нищо за тях в документацията.

Като цяло не е ясно. Затова настроих всичко на максимум.

Куп глупави псувни по адрес на Catch

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

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

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

Но може ли статичен анализатор дори да вземе това предвид? не знам

Резултати от

PVS не намери реални грешки в моите проекти с отворен код Burst и Проксима, както и в работен проект, който по обясними причини не мога да представя. Вярно е, че си струва да се има предвид, че някои недостатъци вече са уловени и коригирани по-рано с помощта 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 или други статични анализатори. Но ви насърчавам да помислите как се е случило така, че статичният анализатор постоянно намира значителни грешки във вашия код.

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

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