🔋 👌🏼 📪 CppCat स्टेटिक विश्लेषक अवलोकन 👩🏽‍⚕️ 💱 🧞

हाल ही में, C ++ कोड के स्थैतिक विश्लेषण के लिए एक नया उपकरण Habré - CppCat में प्रस्तुत किया गया था। अपने पिछले प्रोजेक्ट (PVS-Studio) के बारे में, इसके लेखकों ने लंबे समय तक और हैबर पर विस्तार से बात की। उसके प्रति मेरा दृष्टिकोण दुगुना था - एक तरफ, स्थिर विश्लेषण, निश्चित रूप से, की जरूरत है। उसके साथ उसके बिना बेहतर है। दूसरी ओर, पीवीएस-स्टूडियो अपने पैमाने से डर गया, एक तरह का "उद्यम", और एक कीमत पर भी। मुझे इस बात का अच्छा अंदाजा था कि लगभग 50 की एक प्रोजेक्ट टीम इसे कैसे खरीद सकती है, लेकिन मुझे समझ नहीं आया कि लगभग 5 में से एक भी डेवलपर या टीम क्या कर सकती है। मुझे याद है कि मैंने सुझाव दिया था कि किसी तरह लेखक पीवीएस को क्लाउड में एक सेवा के रूप में तैनात करते हैं और समय पर इसकी पहुंच बेचते हैं। लेकिन वे अपने तरीके से चले गए और अपेक्षाकृत कम पैसे के लिए एक स्ट्रिप-डाउन संस्करण बनाया (ऐसा बजट "के माध्यम से तोड़ने" या यहां तक कि सिर्फ अपने लिए खरीदने के लिए काफी संभव है)।

चलो देखते हैं कि क्या खेल मोमबत्ती के लायक है।

पहली चीज जो मुझे इंस्टालेशन के दौरान सही नहीं लगती, वह है विज़ुअल स्टूडियो 2005 \ 2008 के साथ एकीकरण की कमी। नहीं, मैं समझता हूं कि स्टूडियो के पुराने संस्करणों में एक्सटेंशन के लिए एक पूरी तरह से अलग एपीआई था और शायद इसे समर्थन करने के लिए अतिरिक्त प्रयासों की आवश्यकता है, लेकिन सी ++ एक युवा भाषा बिल्कुल नहीं है, कई परियोजनाएं जिन्हें मैंने अभी भी VS2008 पर लाइव किया है और कोई भी नहीं यदि वह आवश्यक नहीं है तो प्रति तिमाही एक दर्जन लाइनों को संपादित करने के लिए उन्हें स्थानांतरित करने की योजना नहीं है। यह पता चला है कि विरासत के साथ काम करने के लिए आपको अभी भी एक पूर्ण-विकसित पीवीएस-स्टूडियो की आवश्यकता है। अच्छा ठीक है।

विज़ुअल स्टूडियो के साथ एकीकरण में न्यूनतम प्रसन्नता: अंकों के एक जोड़े के लिए एक मेनू, एक टूलबार - अधिक कुछ नहीं। "बिल्ड पर विश्लेषण सक्षम करें" डिफ़ॉल्ट रूप से सक्षम है। क्यों? यह मुझे अधिक तर्कसंगत लगता है कि प्रत्येक बिल्ड की गति को धीमा न करें, लेकिन पूरे प्रोजेक्ट का विश्लेषण करें, उदाहरण के लिए, रिपॉजिटरी के लिए प्रतिबद्ध होने से पहले। आप अपने आप को svn \ git क्लाइंट के प्री-कमिट हुक के लिए एक अनुस्मारक बना सकते हैं कि एक स्थिर विश्लेषक के साथ नए कोड की जांच करना अच्छा होगा।

परीक्षणों की निष्पक्षता के लिए, मैंने तीन परियोजनाओं को चुना:

नोटपैड ++ (जो मुझे लगता है कि खराब कोड है)
ZeroMQ (जिसे मैं अच्छा नमूना कोड मानता हूं)
मेरी पुरानी कार्य परियोजनाओं में से एक - मैंने कई साल पहले लिखा था, निश्चित रूप से इसमें बहुत सारी गलतियाँ हैं

नोटपैड ++ और जीरोएमक्यू को चुना गया था क्योंकि मुझे उन दोनों को विकसित करने का बहुत कम अनुभव था - शाब्दिक रूप से यहाँ और वहाँ के एक जोड़े से, लेकिन कम से कम मुझे यह पता लगाने की ज़रूरत नहीं थी कि कैसे संकलित करें और जांच करें (मुझे VS2010 के तहत निर्माण की संभावना के बारे में निश्चित रूप से पता था)।

नोटपैड ++

परियोजना में 86 फाइलें, पूर्ण स्कैन के लिए 2 मिनट। CppCat से संदिग्ध कोड के बारे में 48 संदेश (प्रति फ़ाइल औसत 0.55 संदेश)

एक सामान्य गलती है जब एक बाइट को स्थानांतरित करने की कोशिश की जाती है, तो तार्किक 'और' और बिटवाइज़ 'और' भ्रमित होते हैं।

ToAscii(wParam,(lParam >> 16) && 0xff,keys,&dwReturnedValue,0); // V560. A part of conditional expression is always true/false.

नकारात्मक प्रकार की जाँच

 WPARAM wParam ... if(wParam<0) // V547. Expression is always true/false.

सूचकांक -1 के साथ एक सरणी सेल का संभावित पता

 j=lstrlen(BGHS[SelfIndex].editstring); BGHS[SelfIndex].editstring[j-1]=0x00; // V557. Array overrun is possible.

यह बिल्कुल भी नहीं है कि यह एक गलती है - यह संभव है कि इससे पहले कि शून्यता के लिए एक लाइन की जाँच की जाए, लेकिन यह बेहतर है कि मैं किसी मामले की आशा न करूं।

दोहरा काम। एक बात स्पष्ट रूप से सतही है।

 lpcs = &cs; lpcs = (LPCREATESTRUCT)lParam; // V519. The 'x' variable is assigned values twice successively. Perhaps this is a mistake.

भवन की स्थिति में बकवास।

 if(MATCH) { return returnvalue+MAX_GRIDS; } if(!MATCH)) // V560. A part of conditional expression is always true/false. { return -1; }

सही ढंग से आवंटित स्मृति के लिए गलत जांच

 char *source = new char[docLength]; if (source == NULL) // V668. There is no sense in testing the pointer against null, as the memory was allocated using the 'new' operator. The exception will be generated in the case of memory allocation error. return;

मेरे व्यक्तिगत आंकड़ों के अनुसार, यह किसी भी C ++ कोड में सबसे आम गलती है (यह इस परियोजना में 24 बार होता है)। C से स्मृति आबंटन फ़ंक्शन में इसकी जड़ें हैं, जो NULL को त्रुटि पर लौटाता है। लेकिन जाँच करने के लिए C ++ में नए ऑपरेटर का उपयोग करते समय, "क्या उपलब्ध मेमोरी रन आउट हो गई है?" आपको std को पकड़ने की आवश्यकता है :: bad_alloc अपवाद, और NULL के लिए परिणाम की जांच नहीं।

अतिरिक्त व्यामोह

 TCHAR intStr[5]; ... if (!intStr) // V600. Consider inspecting the condition. The 'Foo' pointer is always not equal to NULL.

यदि कार्यक्रम में यह बात सामने आती है कि पांच वर्णों के स्थानीय रूप से घोषित सरणी में सूचक NULL हो जाता है - कुछ इतना खराब हो गया कि बस गिरना बेहतर है।

एक ही स्थिति की दोहरी जांच

 do { ... } while(openFound.success && (styleAt == SCE_H_DOUBLESTRING || styleAt == SCE_H_DOUBLESTRING) && searchStartPoint > 0);

यहां उन्होंने उद्धरण (डबल और सिंगल) खोजने की कोशिश की, लेकिन वास्तव में डबल चेक डबल। SCE_H_SINGLESTRING के साथ दूसरे चेक को बदलने की योजना के साथ कॉपी-पेस्ट करें, जो प्रक्रिया में भूल गया था। सबसे उपयोगी बग में से एक वास्तव में XML पार्सर में एक बग है, और न केवल "सुधार सलाह" है।

गलत (मेरी राय में) प्रतिक्रियाएं

दो लगातार अगर एक ही स्थिति के साथ ब्लॉक

 //Setup GUI if (!_beforeSpecialView.isPostIt) // V581. The conditional expressions of the 'if' operators situated alongside each other are identical. { ... } //Set old style if not fullscreen if (!_beforeSpecialView.isPostIt) { ... }

यहां मैं CppCat से सहमत नहीं हूं। कौन जानता है कि प्रोग्रामर ने इस तरह लिखने का फैसला क्यों किया? कोड मान्य है, अच्छी तरह से काम करता है। यह एक "हटाने के लिए भूल गया!" नहीं हो सकता, क्योंकि गलती है, अन्यथा वहाँ "और" होगा। बस इस तरह के एक डिजाइन कोड।

"&& 'ऑपरेशन की कुछ त्रुटियाँ" की तुलना में अधिक है "|| ऑपरेशन »

 printPage = (!(_pdlg.Flags & PD_PAGENUMS) || (pageNum >= _pdlg.nFromPage) && (pageNum <= _pdlg.nToPage));

CppCat हठपूर्वक मानता है कि प्रोग्रामर संचालन की प्राथमिकताओं को नहीं जानते हैं। इस मामले में, अर्थ और स्वच्छता दोनों में, यह स्पष्ट है कि प्रोग्रामर जानता था कि वह क्या कर रहा था। बेशक, "स्पष्ट रूप से निहित से बेहतर है," लेकिन कोई त्रुटि नहीं है।

विश्लेषक यह नहीं मानता है कि अर्थहीन कोड अन्य संकलन कुंजियों के साथ समझ में आ सकता है।

 if (unicodeSupported) ::DispatchMessageW(&msg); else // V523. The 'then' statement is equivalent to the 'else' statement ::DispatchMessage(&msg);

ऐसा इसलिए है क्योंकि "#ffine DispatchMessage DispatchMessageW" पहले लिखा गया था। लेकिन यहाँ एक बात है - यह प्रतिस्थापन सशर्त संकलन मैक्रोज़ द्वारा सक्षम है। इस स्थिति में, कोड का वास्तव में कोई मतलब नहीं है, लेकिन यदि आप अन्य कुंजियों के साथ प्रोजेक्ट को संकलित करते हैं, तो डिस्पैसमैसेज DispatchMessageA को इंगित करेगा, जिसका अर्थ है कि कोड समझ में आएगा।
बेशक, मुझे दोष लगता है: "क्या अन्य संकलन विकल्प हो सकते हैं" यह अनुमान लगाने के लिए एक स्थिर विश्लेषक की आवश्यकता अनुचित है। लेकिन प्रोग्रामर से इस बारे में सोचने से नुकसान नहीं होता है।

नोटपैड ++ आउटपुट
48 त्रुटि संदेशों में से, मेरी राय में, लगभग 38 वास्तव में ध्यान देने योग्य हैं और कोड में कुछ बदलाव। इनमें से, 30 स्थान स्पष्ट कीड़े हैं, और 8 उपयोगी हैं, लेकिन वैकल्पिक शैलीगत परिवर्तन। मैं कोड लॉजिक के संदर्भ में CppCat के 10 पदों को झूठा मानता हूं। कुल मिलाकर - बुरा नहीं है।

ZeroMq

72 फाइलें, विश्लेषण के लिए 1 मिनट।

बिल्कुल 1 संदिग्ध जगह मिली। और वह वास्तव में गलत है।

 rc = pipe_->write (&probe_msg_); // zmq_assert (rc) is not applicable here, since it is not a bug. pipe_->flush (); rc = probe_msg_.close (); // V519. The 'x' variable is assigned values twice successively. Perhaps this is a mistake.

विश्लेषक इस तथ्य से परेशान है कि किसी को अपने पहले और दूसरे असाइनमेंट के बीच खराब आरसी की आवश्यकता नहीं है। हां, कोई जरूरत नहीं। लेकिन आखिरकार:

डिबगिंग के दौरान एक ब्रेकपॉइंट सेट करना सुविधाजनक है और देखें कि यह किसके बराबर है।
एक टिप्पणी है जो बताती है कि आरसी चेक पहले (या हो सकता है) यहां था। वह यह भी कहता है कि निश्चित रूप से इस चेक की जरूरत नहीं है।

विश्लेषक, टिप्पणियों को पढ़ने के लिए, निश्चित रूप से बाध्य नहीं है, और इसलिए यह नहीं जानता कि यहां सब कुछ ठीक क्यों है।

ZeroMq पर निष्कर्ष
कोड में एक संदिग्ध जगह के बारे में एक भी उपयोगी संदेश नहीं। ठीक है, मैंने शुरू से ही कहा था कि इस पुस्तकालय के कोड के बारे में मेरी बहुत राय है।

मेरा प्रोजेक्ट

420 फाइलें (8 उपप्रोजेक्ट में), विश्लेषण के लिए 9 मिनट, 99 चेतावनी। यह प्रति फ़ाइल औसतन 0.23 चेतावनी है।

प्रकार std :: सूची का उपयोग करने में बेवकूफ गलती

 void CHttpDownloaderBase::GetResponseHeader(const std::string& strHeaderName, std::list<std::string>& listValues) const { listValues.empty(); // V530. The return value of function 'Foo' is required to be utilized. ...

भ्रम यह है कि कुछ चौखटों में खाली कंटेनर प्रकार विधि वास्तव में कंटेनर को साफ करती है। लेकिन std :: सूची के लिए, यह केवल एक शून्य जांच है। स्पष्ट के साथ प्रतिस्थापित करने की आवश्यकता है ()

इसके पहले उपयोग के बाद पॉइंटर को चेक करना

 const char *xml_attr(xml_t* xml, const char *attr) { ... const char *name = xml->name; if (! xml || ! xml->attr) // V595. The pointer was utilized before it was verified against nullptr. return NULL;

अपरिभाषित व्यवहार

 while (*(n = ++s + strspn(s, XML_WS))) // V567. Undefined behavior. The variable is modified while being used twice between sequence points. {...}

दरअसल, VS2010 से C ++ कंपाइलर पर, यह कोड इरादा के अनुसार काम करता है। लेकिन औपचारिक रूप से - हाँ, मानक कहते हैं "अनिश्चित व्यवहार।" इसे ठीक करने के लिए बेहतर है।

कुख्यात संचालक प्राथमिकताएँ

 if (!text[++r] == '\\') // V562. It's odd to compare a bool type value with a value of N. { break; } if (!text[++r] == 'u') // V562. It's odd to compare a bool type value with a value of N. { break; }

यह आसान है, ऑपरेटर "!" "==" से अधिक प्राथमिकता है

सूचक अंकगणित

 TCHAR *ch = path + lstrlen(path) - 1; // V532. Consider inspecting the statement of '*pointer++' pattern. Probably meant: '(*pointer)++'. while (*ch && *ch != '\\') *ch--;

CppCat का सुझाव कि मैं पॉइंटर द्वारा मान बदलना चाहता था गलत है, मैं पॉइंटर को ही बदलना चाहता था। फिर भी, इस संदेश से कुछ लाभ होता है - यह सूचक द्वारा मूल्य लेने के एक अनावश्यक संचालन को इंगित करता है - "*"। इसका उपयोग यहां नहीं किया गया है, जिसका अर्थ है कि आप बस "ch--" लिख सकते हैं

अतिरिक्त स्थिति

 while (*p1 != 0 && *p1 == _T(' ')) // V590. Consider inspecting this expression. The expression is excessive or contains a misprint. p1++;

यह सरल है - यदि आप किसी स्थान के साथ p1 की तुलना करते हैं, तो पहले चेक की आवश्यकता नहीं है।

अतिरिक्त संचालन

  m_dwInPartPos = 0; m_pcOutData = NULL; ... m_dwInPartPos = 0; // V519. The 'x' variable is assigned values twice successively.

नहीं कि एनम

 if (type == eRT_unk) // V556. The values of different enum types are compared. return false;

C ++ के सबसे बड़े दुखों में से एक (अच्छी तरह से, कम से कम जब तक नए मानक में एनम वर्गों के आगमन) नहीं है, यह है कि एनम वास्तव में एक अलग इकाई नहीं है, बल्कि संख्याओं का एक सेट है। एक enum में eRt_unk और दूसरे में eResourceUn पहचाना होने के बाद, मैं बस भाग्यशाली था कि वे दोनों बराबर थे 0. त्रुटि वर्षों से कोड में थी, हालांकि सब कुछ भाग्य से बाहर था।

खैर, और जहां शैली के क्लासिक्स के बिना: = तुलना में == के बजाय

 if (scheme == ZLIB_COMPRESSION) out.push(boost::iostreams::zlib_compressor()); else if (scheme = GZIP_COMPRESSION) out.push(boost::iostreams::gzip_compressor()); // V559. Suspicious assignment inside the condition expression of 'if/while/for' operator.

खैर, मैं क्या कह सकता हूं - एक बेवकूफ गलती, कोई बहाना नहीं है।

झूठी सकारात्मकता

किसी व्यूह की सीमा से परे जाना

 int len = lstrlen(szLogDir); TCHAR ch = szLogDir[len-1]; // V557. Array overrun is possible.

वास्तव में, लेन वेरिएबल को "> 0" के लिए चेक नहीं किया जाता है, लेकिन कोड के ठीक ऊपर, szLogDir स्ट्रिंग को गैर-शून्य के लिए चेक किया जाता है। दूसरा चेक विश्वसनीयता नहीं जोड़ेगा।

संदेहास्पद खराबी

मुझे अपने कोड में ऐसा एक टुकड़ा मिला:

 if (m_packets[i] != NULL) delete m_packets[i];

CppCat ने इसके बारे में कुछ नहीं कहा, हालांकि, मेरी राय में, ऐसे मामलों में पीवीएस-स्टूडियो ने कहा कि पूर्ण को हटाना सुरक्षित था।

मेरे प्रोजेक्ट पर निष्कर्ष
99 चेतावनियों में से, लगभग 65 मामले में, बग्स का वितरण और कोड में सिर्फ "सुधार" कहीं 50/50 के आसपास था।

निष्कर्ष

आकर्षण आते हैं

आराम
कीमत
असली कीड़े ढूँढता है

विपक्ष

VS2005 \ VS2008 के साथ एकीकरण का अभाव
झूठी सकारात्मकता का कुछ प्रतिशत

एक ऋण हो सकता है, लेकिन नहीं!

64-बिट चेक के लिए समर्थन का अभाव।

मुझे कभी समझ में नहीं आया कि पीवीएस-स्टूडियो के डेवलपर्स ने हमेशा उन पर ध्यान केंद्रित क्यों किया। विंडोज x64 के तहत, 32-बिट प्रोग्राम्स का निर्माण कार्य करता है, और तदनुसार, 64-बिट संस्करण बनाने का प्रश्न अक्सर तब होता है जब आपको ड्राइवर लिखने की आवश्यकता होती है, या जब प्रोग्राम को 3 जीबी से अधिक रैम की आवश्यकता होती है। मेरे आंकड़ों में, यह लगभग 10-15% परियोजनाएं हैं।

MsBuild के साथ एकीकरण की कमी, आदि।

रिपॉजिटरी के लिए प्रतिबद्ध होने से पहले, कोड को मैन्युअल रूप से जांचना मेरे लिए तर्कसंगत लगता है। प्रत्येक बिल्ड (धीरे) के साथ नहीं, बिल्ड सर्वर पर नहीं (अंतःक्रियात्मक रूप से नहीं), लेकिन उस तरह से। इसमें ज्यादा समय नहीं लगेगा, आपने सहकर्मियों के सामने खुद को अपमानित नहीं किया है - यह सुविधाजनक है।

एक प्लस हो सकता है, लेकिन नहीं!

सेटिंग्स में तपस्या

CppCat बहुत गंभीर निकला। पर्याप्त लचीलापन नहीं है: आप फ़ाइलों, फ़ोल्डरों, स्कैनिंग से किसी फ़ाइल की एक विशिष्ट पंक्ति को बाहर कर सकते हैं। लेकिन फ़ाइल के हिस्से को कैसे बाहर करना है? किसी विशिष्ट त्रुटि या त्रुटि वर्ग के लिए जाँच को अक्षम कैसे करें? और अगर विश्व स्तर पर नहीं, लेकिन फाइलों के हिस्से के लिए? यह या तो असंभव है, या मैंने कम प्रलेखन पढ़ा है।

इच्छा-सूची

होटल 1

यह उन टिप्पणियों के बारे में जानकारी संग्रहीत करने में सक्षम होगा जो सत्यापन से बाहर किए गए चेतावनियों को कोड में नहीं, बल्कि कहीं-कहीं एक बाहरी फ़ाइल में रखी गई हैं, जिन्हें रिपॉजिटरी की ओर से बाहर रखा जा सकता है। सभी सहकर्मी एक ही स्थिर विश्लेषण उपकरण का उपयोग नहीं कर सकते हैं, और कोड में "// - V: is_test_ok & =: 501" जैसे कोड पढ़ना और उनके उद्देश्य पर आश्चर्यचकित होना कष्टप्रद हो सकता है।

होटलका २

चेतावनी संदर्भ मेनू में विकल्प "कॉपी" और Ctrl + V हॉटकी जोड़ना अच्छा होगा। रिपॉजिटरी के लिए कमेंट टेक्स्ट में इन चेतावनियों को कॉपी करना बहुत सुविधाजनक होगा। अब, आप निश्चित रूप से, दस्तावेज खोल सकते हैं और वहां से शीर्षक की प्रतिलिपि बना सकते हैं - लेकिन पाठ को वहां सामान्यीकृत किया जाता है, और सत्यापन के परिणाम कोड में विशिष्ट लाइनों को इंगित करते हैं, चर के नाम सुविधाजनक और समझ में आते हैं।

अंतिम निष्कर्ष

CppCat के बारे में क्या अच्छा है यह गणना करने में आसानी है कि क्या खरीद उपकरण इसके लायक है। आइए हमबे: 80,000 रूबल ($ 2,370) पर हाल की समीक्षा से एक वैक्यूम में औसत सी ++ प्रोग्रामर का औसत वेतन लेते हैं। तो उनके 1 घंटे के काम का खर्च लगभग $ 14 है। मुझे लगता है कि आप इस बात से सहमत होंगे कि ऊपर वर्णित लोगों के समान बग ढूंढना और ठीक करना (और भले ही आप यह नहीं जानते कि आप जो खोज रहे हैं वह कम से कम एक घंटे का काम है)। CppCat की लागत $ 250 है। यह 17 घंटे के काम की तरह है। यदि आपकी परियोजना में आप बग फिक्सिंग पर 17 घंटे से अधिक समय बिताने की योजना बना रहे हैं (और ऐसी क्या परियोजनाएं हैं जहां वे कम योजना बनाते हैं?), तो खरीद उचित है।

सामान्य तौर पर, छोटी परियोजनाओं और व्यक्तिगत डेवलपर्स की देखभाल के लिए CppCat के लेखकों को धन्यवाद। मैं VS2008 के साथ विशलिस्ट और एकीकरण के कार्यान्वयन के लिए आशा करता हूं।

CppCat स्टेटिक विश्लेषक अवलोकन