PVS-Studio-ს დამოუკიდებელი მიმოხილვა (Linux, C++)

მე ვნახე პუბლიკაცია, რომლის ანალიზიც PVS-მა ლინუქსის ქვეშ ისწავლა და გადავწყვიტე გამომეცადა ის ჩემს პროექტებზე. და ეს არის ის, რაც გამოვიდა მისგან.

ინფორმაციის

1. დადებითი
2. Cons
3. შედეგები
4. Afterword

დადებითი

საპასუხო მხარდაჭერა

საცდელი გასაღები მოვითხოვე და იმავე დღეს გამომიგზავნეს.

საკმაოდ მკაფიო დოკუმენტაცია

ჩვენ მოვახერხეთ ანალიზატორის გაშვება უპრობლემოდ. ასევე ხელმისაწვდომია კონსოლის ბრძანებების დახმარება (თუმცა აქ არის გარკვეული საჩივრები, იხილეთ სექცია Cons).

მრავალძაფიანი ანალიზის შესაძლებლობა

ანალიზატორს აქვს "სტანდარტული" ვარიანტი -j, რაც საშუალებას იძლევა ანალიზი ჩატარდეს პარალელურად რამდენიმე ამოცანაში. ეს დაზოგავს დიდ დროს.

კარგი ვიზუალიზაცია

მრავალი განსხვავებული გამომავალი ფორმატი, ტექსტიდან დაწყებული პატარა ვებ-მუწუკამდე. ვებ ინტერფეისი არის მოსახერხებელი, ლაკონური, მინიშნებებით კოდის ხაზების გვერდით და დიაგნოსტიკური აღწერილობების ბმულებით.

მარტივი ინტეგრაცია ასამბლეაში

მთელი დოკუმენტაცია მათ ვებსაიტზეა, მხოლოდ იმის თქმა შემიძლია, რომ თუ თქვენი პროექტი აგებულია CMake-ის გამოყენებით, მაშინ ყველაფერი ძალიან მარტივია.

კარგი დიაგნოსტიკური აღწერილობები

თუ გამომავალს გამოიმუშავებთ რეჟიმში fullhtml, შემდეგ თითოეულ შეტყობინებას აქვს ბმული დიაგნოსტიკური აღწერილობის შესახებ, ახსნა-განმარტებით, კოდის მაგალითებით და დამატებითი ბმულებით.

Cons

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 Gateway Time-out.

ენა

ყველა აღწერა რუსულ ენაზეა, რაც შესანიშნავია. მაგრამ ანგარიშიდან ბმულები ყოველთვის ინგლისურ ვერსიამდე მიდის. კარგი იქნებოდა ენის შეცვლა რომ შეგეძლოთ დაუყოვნებლივ ნახოთ დიაგნოსტიკა რუსულად. მე ვერ ვიპოვე ასეთი ვარიანტი ინტერფეისში.

არასასიამოვნოა სადიაგნოსტიკო დონეებთან მუშაობა კონსოლის საშუალებით

დავიწყოთ იმით, რომ გამოყენებულია ორი ბრძანება (ეს 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-მა ვერ იპოვა რეალური შეცდომები ჩემს ღია კოდის პროექტებში ადიდებული и პროქსიმა, ასევე სამუშაო პროექტში, რომელსაც, გასაგები მიზეზების გამო, ვერ წარმოვადგენ. მართალია, უნდა გვახსოვდეს, რომ გარკვეული ხარვეზები უკვე დაფიქსირდა და გამოსწორდა ადრე გამოყენებით 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 build სისტემით.

ამის შესახებ მეტი შეგიძლიათ წაიკითხოთ ჩემს ბოლო პუბლიკაციაში.

Afterword

და ბოლოს, მინდა ხაზგასმით აღვნიშნო, რომ მე არ ვარ მომხრე არ გამოიყენოთ PVS ან სხვა სტატიკური ანალიზატორები. მაგრამ მე მოგიწოდებთ დაფიქრდეთ იმაზე, თუ როგორ მოხდა, რომ სტატიკური ანალიზატორი მუდმივად აღმოაჩენს მნიშვნელოვან შეცდომებს თქვენს კოდში.

ეს მხოლოდ შედეგია. ჩვენ უნდა ვეძებოთ და აღმოფხვრას მიზეზი.

წყარო: www.habr.com