Независна рецензија ПВС-Студио (Линук, Ц++)

Видео сам публикацију коју је ПВС научио да анализира под Линуком и одлучио сам да је испробам на сопственим пројектима. И ево шта је из тога произашло.

Садржина

1. Прозодија
2. Против
3. Резултати
4. Афтерворд

Прозодија

Одзивна подршка

Затражио сам пробни кључ и послали су ми га истог дана.

Прилично јасна документација

Успели смо да покренемо анализатор без икаквих проблема. Помоћ за команде конзоле је такође доступна (иако овде има неких притужби, погледајте одељак Против).

Могућност вишенитне анализе

Анализатор има "стандардну" опцију -j, што омогућава да се анализа спроводи паралелно у неколико задатака. Ово штеди много времена.

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

Много различитих излазних формата, од текста до малог веба. Веб интерфејс је згодан, концизан, са наговештајима поред редова у коду и везама до дијагностичких описа.

Једноставна интеграција у склоп

Сва документација је на њиховој веб страници, могу само рећи да ако је ваш пројекат направљен помоћу ЦМаке-а, онда је све врло једноставно.

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

Ако генеришете излаз у режиму fullhtml, онда свака порука има везу до дијагностичког описа, са објашњењима, примерима кода и додатним везама.

Против

Непознавање језика Ц++ од стране анализатора

Нажалост, ПВС понекад прави синтаксичке грешке и генерише лажно позитивне поруке када је код потпуно исправан.

На пример, постоји функција која враћа 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, за то је ауто. Али ПВС је произвео следеће поруке:

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

И тек тада сам схватио да су то биле битне маске! И треба ти сумирајИ не адд значења. На пример, да бисте добили општу дијагностику, дијагностику за микрооптимизације и МИСРА, потребно је да их сумирате (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

Овде су се појавили неки „нивои“ којих раније није било, а ни у документацији нисам нашао ништа о њима.

Генерално, није јасно. Зато сам све поставио на максимум.

Гомила глупих псовки на Цатцх

Два од три пројекта која сам анализирао користе библиотеку за тестирање јединица ЦатцхКСНУМКС. А лавовски део порука (!!! 90 од 138 у једној и 297 од 344 у другој!!!) има следећи облик:

Не узима у обзир мултитхреадинг

Постоји много лажних позитивних резултата о наводно непроменљивим варијаблама или бесконачним петљама, док се рад са овим варијаблама одвија из различитих нити, а да то није тако, јединични тестови не би функционисали.

Међутим, може ли статички анализатор то уопште узети у обзир? Не знам.

Резултати

ПВС није пронашао никакве праве грешке у мојим пројектима отвореног кода Бурст и прокима, као и у радном нацрту, који из очигледних разлога не могу да представим. Истина, вреди имати на уму да су неки недостаци већ ухваћени и исправљени раније коришћењем Цппцхецк и scan-build.

Генерално, утисак са свих ових анализатора је приближно исти: да, они нешто ухвате, понекад чак и нешто важно, али генерално компајлер је довољан.

Могуће је (а ја лично тако мислим) да наш тим користи праксе развоја софтвера које нам омогућавају да генеришемо минималну количину усраног кода. Боље је не стварати проблеме него их херојски превазилазити.

Због тога, узимам себи слободу да дам неколико савета како да пишете у Ц++ тако да никоме не откинете ноге и не ударите грабљама у чело.

Искористите дијагностику компајлера на најбољи начин

Наш тим користи (и саветује вам) следеће опције компилације:

-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

Омогућите их у свом пројекту и научите много о свом коду.

Држите се стандарда

Покушајте да не користите ствари зависне од платформе ако постоје стандардни аналоги, а ако апсолутно не можете без њих, умотајте их у посебне блокове за макрое (или нешто друго) и једноставно не дозволите да се ваш код компајлира под неподржаним условима.

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

Сабирање мора бити сабирање, множење мора бити множење, позив функције мора бити позив функције, копија мора бити копија, ношење мора бити ношење, контејнер мора бити итерабле, итератор мора имати промоцију ++ и дереференцирање *. И тако даље и тако даље.

Мислим да је идеја јасна. Постоје утврђене конвенције које нису обавезујуће, али које сви корисници и читаоци вашег кода очекују да виде. Не покушавајте да надмудрите друге, иначе ћете надмудрити себе.

Напишите компатибилан код

Пре свега, мислим на стандардну библиотеку. Веома је пожељно да се интерфејси ваших класа и функција могу користити са стандардним и другим библиотекама (на пример, Боост).

Слободно погледајте СТЛ и Боост интерфејсе. Уз ретке изузетке, тамо ћете видети достојан узор.

Искористите све алате отвореног кода

За исту статичку анализу, постоје најмање два отворена бесплатна алата која се могу повезати само једном на било који пројекат са ЦМаке буилд системом.

Више о томе можете прочитати у мојој недавној публикацији.

Афтерворд

На крају, желим да нагласим да се не залажем да се не користи ПВС или било који други статички анализатор. Али охрабрујем вас да размислите о томе како се догодило да статички анализатор стално проналази значајне грешке у вашем коду.

Ово је само последица. Морамо тражити и елиминисати узрок.

Извор: ввв.хабр.цом