इलेक्ट्रॉनिक आर्ट्स द्वारा लगभग परफेक्ट लाइब्रेरी

हमारा ध्यान हाल ही में GitHub पर इलेक्ट्रॉनिक आर्ट्स भंडार द्वारा आकर्षित किया गया था। यह छोटा है, और वहां उपलब्ध तेईस परियोजनाओं में से केवल कुछ C ++ लाइब्रेरी दिलचस्प लग रही थीं: EASTL, EAStdC, EABase, EAThread, EATest, EAMain, और EAAssert। परियोजनाएँ खुद भी छोटी हैं (प्रत्येक के बारे में 10 फाइलें), इसलिए बग केवल 20 फाइलों की "सबसे बड़ी" परियोजना में पाए गए: डी लेकिन हमने उन्हें ढूंढ लिया, और वे दिलचस्प दिखते हैं! जैसा कि मैं इस पोस्ट को लिख रहा था, हम ईए गेम्स और कंपनी नीति: डी की जीवंत चर्चा कर रहे थे

परिचय

इलेक्ट्रॉनिक आर्ट्स (EA) एक अमेरिकी वीडियो गेम कंपनी है। GitHub और कुछ C ++ प्रोजेक्ट्स पर इसका एक छोटा सा भंडार है , अर्थात् C ++ लाइब्रेरीज़: EASTL, EAStdC, EABase, EAThread, EATest, EAMain, और EAAssert। वे छोटे हैं, और पीवीएस-स्टूडियो विश्लेषक केवल "सबसे बड़ी" परियोजना, ईएएसटीडीसी (20 फाइलें) में किसी भी कीड़े को खोजने में कामयाब रहे। इस तरह के आकार के साथ, आप समग्र रूप से गुणवत्ता का न्याय नहीं कर सकते हैं , इसलिए बस निम्नलिखित पांच चेतावनियों पर एक नज़र डालें और अपने लिए निर्णय लें।

चेतावनी १

V524 यह अजीब है कि '>>' फ़ंक्शन का शरीर '<<' फ़ंक्शन के शरीर के पूरी तरह से समकक्ष है। EAFixedPoint.h 287

template <class T, int upShiftInt, int downShiftInt, int upMulInt, int downDivInt> struct FPTemplate { .... FPTemplate operator<<(int numBits) const { return value << numBits; } FPTemplate operator>>(int numBits) const { return value << numBits; } FPTemplate& operator<<=(int numBits) { value <<= numBits; return *this;} FPTemplate& operator>>=(int numBits) { value >>= numBits; return *this;} .... } 

शिफ्ट ऑपरेटरों को ओवरलोड करते समय, प्रोग्रामर ने उनमें से एक में << के बजाय << लिखकर टाइपो बनाया। यह कॉपी-पेस्ट गलती की तरह दिखता है।

चेतावनी २

V557 ऐरे ओवररन संभव है। 'NFormatLength' सूचकांक का मूल्य 16 तक पहुंच सकता है। EASprintfOrdered.cpp 246

 static const int kSpanFormatCapacity = 16; struct Span8 { .... char mFormat[kSpanFormatCapacity]; .... }; static int OVprintfCore(....) { .... EA_ASSERT(nFormatLength < kSpanFormatCapacity); if(nFormatLength < kSpanFormatCapacity) spans[spanIndex].mFormat[nFormatLength++] = *p; // <= else return -1; switch(*p) { case 'b': case 'd': case 'i': case 'u': case 'o': case 'x': case 'X': case 'g': case 'G': case 'e': case 'E': case 'f': case 'F': case 'a': case 'A': case 'p': case 'c': case 'C': case 's': case 'S': case 'n': { // Finalize the current span. spans[spanIndex].mpEnd = p + 1; spans[spanIndex].mFormat[nFormatLength] = 0; // <= spans[spanIndex].mFormatChar = *p; if(++spanIndex == kSpanCapacity) break; .... } 

स्पैन [स्पैनइंडेक्स] .mFormat सरणी में 16 तत्व होते हैं, इसलिए अंतिम वैध तत्व का सूचकांक 15 है । अपने वर्तमान रूप में, OVprintfCore फ़ंक्शन nFormatLength के सूचकांक को बढ़ाकर 16 तक कर देता है यदि इसका उच्चतम संभव सूचकांक है, अर्थात 15 । उसके बाद, स्विच स्टेटमेंट में एक सरणी-आउट-ऑफ-बाउंड त्रुटि होगी।

इस टुकड़े को दो बार कॉपी किया गया था:

• V557 ऐरे ओवररन संभव है। 'NFormatLength' सूचकांक का मूल्य 16 तक पहुंच सकता है। EASprintfOrdered.cpp 614
• V557 ऐरे ओवररन संभव है। 'NFormatLength' सूचकांक का मूल्य 16 तक पहुंच सकता है। EASprintfOrdered.cpp 977

चेतावनी ३

V560 सशर्त अभिव्यक्ति का एक हिस्सा हमेशा सच होता है: (परिणाम> = 0)। EASprintfOrdered.cpp 489

 static int OVprintfCore(....) { .... for(result = 1; (result >= 0) && (p < pEnd); ++p) { if(pWriteFunction8(p, 1, pWriteFunctionContext8, kWFSIntermediate) < 0) return -1; nWriteCountSum += result; } .... } 

परिणाम = = 0 स्थिति हमेशा सही होती है क्योंकि परिणाम चर को लूप में कहीं भी नहीं बदला जाता है। कोड बिल्कुल भी सही नहीं लगता है, और इसमें कुछ गलती होनी चाहिए।

इस टुकड़े को दो बार कॉपी किया गया था:

• V560 सशर्त अभिव्यक्ति का एक हिस्सा हमेशा सच होता है: (परिणाम> = 0)। EASprintfOrdered.cpp 852
• V560 सशर्त अभिव्यक्ति का एक हिस्सा हमेशा सच होता है: (परिणाम> = 0)। EASprintfOrdered.cpp 1215

चेतावनी ४

V1009 सरणी आरंभीकरण की जाँच करें। केवल पहला तत्व स्पष्ट रूप से आरंभिक है। बाकी तत्वों को शून्य से आरंभ किया जाता है। EASprintfOrdered.cpp 151

 static int OVprintfCore(....) { .... int spanArgOrder[kArgCapacity] = { -1 }; .... } 

यह आवश्यक रूप से बग नहीं है, लेकिन लेखकों को चेतावनी दी जानी चाहिए कि केवल स्पैनऑर्गऑर्डर सरणी का पहला तत्व -1 से शुरू होता है, जबकि बाकी सभी को 0 पर सेट किया जाएगा।

इस टुकड़े को दो बार कॉपी किया गया था:

• V1009 सरणी आरंभीकरण की जाँच करें। केवल पहला तत्व स्पष्ट रूप से आरंभिक है। बाकी तत्वों को शून्य से आरंभ किया जाता है। EASprintfOrdered.cpp 518
• V1009 सरणी आरंभीकरण की जाँच करें। केवल पहला तत्व स्पष्ट रूप से आरंभिक है। बाकी तत्वों को शून्य से आरंभ किया जाता है। EASprintfOrdered.cpp 881

चेतावनी ५

V728 एक अत्यधिक जाँच को सरल बनाया जा सकता है। द '(A &&! B) || (ए! और बी) 'अभिव्यक्ति' बूल (ए)! = बूल (बी) 'अभिव्यक्ति के बराबर है। int128.h 1242

 inline void int128_t::Modulus(....) const { .... bool bDividendNegative = false; bool bDivisorNegative = false; .... if( (bDividendNegative && !bDivisorNegative) || (!bDividendNegative && bDivisorNegative)) { quotient.Negate(); } .... } 

मैंने इस उदाहरण को स्पष्टता के लिए प्रारूपित किया, लेकिन इसके मूल रूप में, यह स्थिति बहुत लंबी है और पढ़ने में कठिन है। लेकिन हम सशर्त अभिव्यक्ति को सरल बनाकर इसे बेहतर बना सकते हैं, जैसा कि विश्लेषक सुझाव देते हैं:

 if( bDividendNegative != bDivisorNegative) { quotient.Negate(); } 

कोड अब बहुत छोटा है, जो हालत के तर्क को समझ लेना आसान बनाता है।

निष्कर्ष

जैसा कि आपने देखा होगा, अधिकांश चेतावनियों में दो और डुप्लिकेट होते हैं, और वे सभी डुप्लिकेट एक ही फ़ाइल में पाए जाते हैं। कोड दोहराव एक बहुत खराब विरोधी पैटर्न है क्योंकि यह प्रोग्राम रखरखाव को बहुत जटिल करता है। जब कीड़े ऐसे कोड में रेंगते हैं, तो प्रोग्राम की स्थिरता बहुत कम हो जाती है क्योंकि वे सभी कोड में फैल जाते हैं।

उम्मीद है, ईए कुछ अन्य दिलचस्प परियोजनाओं को अपलोड करेंगे और हम उनकी रिपॉजिटरी पर एक बार फिर से जाएँगे :)। इस बीच, पीवीएस-स्टूडियो को डाउनलोड करने और अपने स्वयं के प्रोजेक्ट पर प्रयास करने के लिए आपका स्वागत है।