एक नए स्थिर विश्लेषक का विकास: पीवीएस-स्टूडियो जावा

PVS-Studio स्थैतिक विश्लेषक C, C ++ और C # की दुनिया में त्रुटियों और संभावित कमजोरियों का पता लगाने के लिए एक उपकरण के रूप में जाना जाता है। हालांकि, हमारे पास वित्तीय क्षेत्र से कुछ ग्राहक हैं, क्योंकि यह पता चला है कि जावा और आईबीएम आरपीजी (!) अब वहां मांग में हैं। लेकिन हम हमेशा एंटरप्राइज़ की दुनिया के करीब जाना चाहते थे, इसलिए, कुछ विचार के बाद, हमने एक जावा विश्लेषक बनाना शुरू करने का फैसला किया।

परिचय

बेशक, चिंताएँ थीं। आईबीएम आरपीजी में विश्लेषक बाजार को लेना आसान है। मुझे इस बात पर बिल्कुल यकीन नहीं है कि इस भाषा के स्थिर विश्लेषण के लिए अच्छे साधन हैं। जावा दुनिया में, चीजें पूरी तरह से अलग हैं। स्थैतिक विश्लेषण के लिए पहले से ही उपकरणों की एक पंक्ति है, और आगे बढ़ने के लिए, आपको वास्तव में शक्तिशाली और शांत विश्लेषक बनाने की आवश्यकता है।

फिर भी, हमारी कंपनी के पास जावा के स्थिर विश्लेषण के लिए कई उपकरणों का उपयोग करने का अनुभव है, और हमें यकीन है कि हम कई चीजों को बेहतर तरीके से कर सकते हैं।

इसके अलावा, हमारे पास एक जावा विश्लेषक में हमारे सी ++ विश्लेषक की पूरी शक्ति का उपयोग करने का एक विचार था। लेकिन पहले बातें पहले।

लकड़ी

सबसे पहले, यह तय करना आवश्यक था कि हम वाक्यविन्यास वृक्ष और शब्दार्थ मॉडल कैसे प्राप्त करेंगे।

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

यह ध्यान देने योग्य है कि बस एक वाक्यविन्यास वृक्ष पर्याप्त नहीं है। विश्लेषक को अर्थ संबंधी जानकारी भी चाहिए। उदाहरण के लिए, हमें पेड़ के सभी तत्वों के प्रकारों को जानना होगा, चर घोषणा में जाने में सक्षम होना चाहिए, आदि।

हमने सिंटैक्स ट्री और सिमेंटिक मॉडल प्राप्त करने के लिए कई विकल्पों की जांच की:

• ANTLR (जावा के लिए व्याकरण के साथ)
• JavaParser और JavaSymbolSolver
• ग्रहण JDT से ग्रहण का ASTParser
• चम्मच

हमने लगभग तुरंत ANTLR का उपयोग करने के विचार को त्याग दिया, क्योंकि यह अनावश्यक रूप से विश्लेषक के विकास को जटिल करेगा (शब्दार्थ विश्लेषण को अपने दम पर लागू करना होगा)। अंत में, हमने चम्मच लाइब्रेरी में रुकने का फैसला किया:

• यह न केवल एक पार्सर है, बल्कि एक संपूर्ण पारिस्थितिकी तंत्र है - यह न केवल एक पार्स ट्री प्रदान करता है, बल्कि अर्थ विश्लेषण के लिए भी अवसर प्रदान करता है, उदाहरण के लिए, यह आपको चर के प्रकारों के बारे में जानकारी प्राप्त करने की अनुमति देता है, चर घोषणा पर जाता है, माता-पिता वर्ग के बारे में जानकारी प्राप्त करता है, और इसी तरह।
• यह ग्रहण JDT पर आधारित है और कोड संकलित करने में सक्षम है।
• यह जावा के नवीनतम संस्करण का समर्थन करता है और इसे लगातार अपडेट किया जाता है।
• अच्छा प्रलेखन और स्पष्ट एपीआई।

यहां एक मेटामॉडल का एक उदाहरण है जो चम्मच प्रदान करता है और हम नैदानिक ​​नियम बनाते समय काम करते हैं:

यह मेटामॉडल निम्नलिखित कोड से मेल खाता है:

class TestClass { void test(int a, int b) { int x = (a + b) * 4; System.out.println(x); } } 

चम्मच के बारे में एक अच्छी बात यह है कि यह सिंटेक्स ट्री (नोड्स को हटाने और जोड़ना) को सरल बनाता है जिससे इसे काम करना आसान हो जाता है। इसी समय, मूल के सरलीकृत मेटामोडेल के शब्दार्थ समतुल्य की गारंटी है।

हमारे लिए, इसका मतलब है, उदाहरण के लिए, कि हमें अब किसी पेड़ पर चढ़ते समय अतिरिक्त कोष्ठक को छोड़ने के बारे में चिंता करने की आवश्यकता नहीं है। इसके अलावा, प्रत्येक अभिव्यक्ति को एक ब्लॉक में रखा जाता है, आयात का पता चलता है, और कुछ अन्य समान सरलीकरण किए जाते हैं।

उदाहरण के लिए, एक कोड इस तरह:

 for (int i = ((0)); (i < 10); i++) if (cond) return (((42))); 

निम्नानुसार प्रस्तुत किया जाएगा:

 for (int i = 0; i < 10; i++) { if (cond) { return 42; } } 

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

पैटर्न-आधारित विश्लेषण द्वारा पाई गई त्रुटि का सबसे सरल उदाहरण jMonkeyEngine प्रोजेक्ट से निम्न कोड है:

 if (p.isConnected()) { log.log(Level.FINE, "Connection closed:{0}.", p); } else { log.log(Level.FINE, "Connection closed:{0}.", p); } 

यदि कथन का तत्कालीन और अन्य खंड समान हैं, तो सबसे अधिक संभावना है, एक तार्किक त्रुटि है।

यहाँ हाइव परियोजना से एक और समान उदाहरण है:

 if (obj instanceof Number) { // widening conversion return ((Number) obj).doubleValue(); } else if (obj instanceof HiveDecimal) { // <= return ((HiveDecimal) obj).doubleValue(); } else if (obj instanceof String) { return Double.valueOf(obj.toString()); } else if (obj instanceof Timestamp) { return new TimestampWritable((Timestamp)obj).getDouble(); } else if (obj instanceof HiveDecimal) { // <= return ((HiveDecimal) obj).doubleValue(); } else if (obj instanceof BigDecimal) { return ((BigDecimal) obj).doubleValue(); } 

इस कोड में प्रपत्र के अनुक्रम में दो समान स्थितियाँ हैं यदि (....) और यदि (....) अन्य (यदि) । यह तार्किक त्रुटि के लिए कोड के इस खंड की जाँच करने या डुप्लिकेट कोड को हटाने के लायक है।

डेटा प्रवाह विश्लेषण

सिंटैक्स ट्री और सिमेंटिक मॉडल के अलावा, विश्लेषक को डेटा प्रवाह का विश्लेषण करने के लिए एक तंत्र की आवश्यकता होती है।

डेटा प्रवाह का विश्लेषण आपको कार्यक्रम में प्रत्येक बिंदु पर चर और अभिव्यक्तियों के मान्य मूल्यों की गणना करने की अनुमति देता है और, इसके लिए धन्यवाद, त्रुटियों को ढूंढें। हम इन मान्य मूल्यों को वर्चुअल वैल्यू कहते हैं।

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

 void func(byte x) // x: [-128..127] { int y = 5; // y: [5] ... } 

हर बार एक चर के मूल्य में परिवर्तन होता है, डेटा फ़्लो इंजन वर्चुअल मान को पुन: गणना करता है। उदाहरण के लिए:

 void func() { int x = 5; // x: [5] x += 7; // x: [12] ... } 

डेटा फ़्लो इंजन नियंत्रण कथनों को भी संसाधित करता है:

 void func(int x) // x: [-2147483648..2147483647] { if (x > 3) { // x: [4..2147483647] if (x < 10) { // x: [4..9] } } else { // x: [-2147483648..3] } ... } 

इस उदाहरण में, फ़ंक्शन में प्रवेश करते समय, चर x के मानों की सीमा के बारे में कोई जानकारी नहीं होती है, इसलिए इसे चर के प्रकार (-2147483648 से 2147483647 तक) के अनुसार सेट किया जाता है। फिर पहला सशर्त ब्लॉक एक बाधा x > 3 लगाता है, और सीमाएं संयुक्त होती हैं। परिणामस्वरूप, तत्कालीन ब्लॉक में x के लिए मानों की श्रेणी 4 से 2147483647 तक है, और दूसरे ब्लॉक में -2147483648 से 3. तक है। दूसरी स्थिति x <10 को उसी तरह से संसाधित किया जाता है।

इसके अलावा, आपको विशुद्ध रूप से प्रतीकात्मक गणना करने में सक्षम होना चाहिए। सबसे सरल उदाहरण:

 void f1(int a, int b, int c) { a = c; b = c; if (a == b) // <= always true .... } 

यहां, वेरिएबल a को वैल्यू c असाइन किया जाता है , वेरिएबल b को वैल्यू c भी असाइन किया जाता है, जिसके बाद a और b की तुलना की जाती है। इस मामले में, त्रुटि को खोजने के लिए, बस दाहिनी ओर की लकड़ी के टुकड़े को याद रखें।

यहाँ वर्ण गणना के साथ थोड़ा और जटिल उदाहरण दिया गया है:

 void f2(int a, int b, int c) { if (a < b) { if (b < c) { if (c < a) // <= always false .... } } } 

ऐसे मामलों में, प्रतीकात्मक रूप में असमानताओं की प्रणाली को हल करना पहले से ही आवश्यक है।

डेटा प्रवाह तंत्र विश्लेषक को त्रुटियों को खोजने में मदद करता है जो पैटर्न-आधारित विश्लेषण का उपयोग करना बहुत मुश्किल है।

इन त्रुटियों में शामिल हैं:

• अतिप्रवाह;
• सरणी में विदेश जा रहे हैं;
• अशक्त या संभावित अशक्त संदर्भ द्वारा पहुंच;
• अर्थहीन स्थितियां (हमेशा सच / झूठ);
• मेमोरी और संसाधन लीक;
• विभाजन 0 से;
• और कुछ अन्य।

कमजोरियों की खोज करते समय डेटा प्रवाह विश्लेषण विशेष रूप से महत्वपूर्ण है। उदाहरण के लिए, यदि कोई निश्चित प्रोग्राम उपयोगकर्ता से इनपुट प्राप्त करता है, तो संभावना है कि इनपुट का उपयोग सेवा से वंचित करने, या सिस्टम पर नियंत्रण प्राप्त करने के लिए किया जाएगा। उदाहरणों में कुछ इनपुट के लिए बफर ओवरफ्लो का कारण बनने वाली त्रुटियां शामिल हैं, या, उदाहरण के लिए, SQL इंजेक्शन। दोनों मामलों में, इस तरह की त्रुटियों और कमजोरियों का पता लगाने के लिए स्थैतिक विश्लेषक के लिए, डेटा प्रवाह और चर के संभावित मूल्यों की निगरानी करना आवश्यक है।

मुझे कहना होगा कि डेटा प्रवाह विश्लेषण तंत्र एक जटिल और व्यापक तंत्र है, और इस लेख में मैंने केवल बहुत मूल बातों को छुआ है।

आइए त्रुटियों के कुछ उदाहरणों को देखें जिन्हें डेटा प्रवाह तंत्र का उपयोग करके पता लगाया जा सकता है।

छत्ता परियोजना:

 public static boolean equal(byte[] arg1, final int start1, final int len1, byte[] arg2, final int start2, final int len2) { if (len1 != len2) { // <= return false; } if (len1 == 0) { return true; } .... if (len1 == len2) { // <= .... } } 

स्थिति len1 == len2 हमेशा संतुष्ट रहती है, क्योंकि विपरीत जाँच पहले ही ऊपर की जा चुकी है।

उसी परियोजना का एक और उदाहरण:

 if (instances != null) { // <= Set<String> oldKeys = new HashSet<>(instances.keySet()); if (oldKeys.removeAll(latestKeys)) { .... } this.instances.keySet().removeAll(oldKeys); this.instances.putAll(freshInstances); } else { this.instances.putAll(freshInstances); // <= } 

यहां, दूसरे ब्लॉक में, नल पॉइंटर की डेरेफ्रेंसिंग होने की गारंटी है। नोट: यहाँ उदाहरण इस. instances के समान हैं।

JMonkeyEngine परियोजना से उदाहरण:

 public static int convertNewtKey(short key) { .... if (key >= 0x10000) { return key - 0x10000; } return 0; } 

यहां कुंजी चर की तुलना संख्या 65536 के साथ की गई है, हालांकि, यह टाइप शॉर्ट का है , और शॉर्ट के लिए अधिकतम संभव मूल्य 32767 है। तदनुसार, शर्त कभी पूरी नहीं होती है।

जेनकिंस परियोजना से एक उदाहरण:

 public final R getSomeBuildWithWorkspace() { int cnt = 0; for (R b = getLastBuild(); cnt < 5 && b ! = null; b = b.getPreviousBuild()) { FilePath ws = b.getWorkspace(); if (ws != null) return b; } return null; } 

इस कोड को पाँच तक सीमित करने के लिए cnt वैरिएबल को पेश किया गया था, लेकिन इसे बढ़ाना भूल गया, जिसके परिणामस्वरूप चेक बेकार है।

एनोटेशन तंत्र

इसके अलावा, विश्लेषक को एनोटेशन तंत्र की आवश्यकता होती है। एनोटेशन एक मार्कअप सिस्टम है जो विश्लेषक को उनके हस्ताक्षर का विश्लेषण करने के अलावा प्राप्त होने वाले तरीकों और कक्षाओं के बारे में अतिरिक्त जानकारी प्रदान करता है। मैनुअल अंकन एक लंबी और समय लेने वाली प्रक्रिया है, क्योंकि सर्वोत्तम परिणाम प्राप्त करने के लिए, आपको बड़ी संख्या में मानक जावा कक्षाओं और विधियों की व्याख्या करने की आवश्यकता है। यह लोकप्रिय पुस्तकालयों की व्याख्या करने के लिए भी समझ में आता है। सामान्य तौर पर, एनोटेशन को मानक विधियों और कक्षाओं के अनुबंधों के बारे में विश्लेषक के ज्ञान आधार के रूप में माना जा सकता है।

यहां एक त्रुटि का एक छोटा सा उदाहरण है जिसे एनोटेशन का उपयोग करके पता लगाया जा सकता है:

 int test(int a, int b) { ... return Math.max(a, a); } 

इस उदाहरण में, टाइपो के कारण, उसी चर को पहले तर्क के रूप में Math.max विधि के दूसरे तर्क के रूप में पारित किया गया था। ऐसी अभिव्यक्ति निरर्थक और संदेहास्पद है।

यह जानते हुए कि मैथमैक्स पद्धति के तर्क हमेशा अलग-अलग होने चाहिए, स्थैतिक विश्लेषक इस तरह के कोड के लिए चेतावनी जारी कर सकेंगे।

आगे देखते हुए, मैं अंतर्निहित कक्षाओं और तरीकों (C ++ कोड) के हमारे मार्कअप के कुछ उदाहरण दूंगा:

 Class("java.lang.Math") - Function("abs", Type::Int32) .Pure() .Set(FunctionClassification::NoDiscard) .Returns(Arg1, [](const Int &v) { return v.Abs(); }) - Function("max", Type::Int32, Type::Int32) .Pure() .Set(FunctionClassification::NoDiscard) .Requires(NotEquals(Arg1, Arg2) .Returns(Arg1, Arg2, [](const Int &v1, const Int &v2) { return v1.Max(v2); }) Class("java.lang.String", TypeClassification::String) - Function("split", Type::Pointer) .Pure() .Set(FunctionClassification::NoDiscard) .Requires(NotNull(Arg1)) .Returns(Ptr(NotNullPointer)) Class("java.lang.Object") - Function("equals", Type::Pointer) .Pure() .Set(FunctionClassification::NoDiscard) .Requires(NotEquals(This, Arg1)) Class("java.lang.System") - Function("exit", Type::Int32) .Set(FunctionClassification::NoReturn) 

स्पष्टीकरण:

• वर्ग - एनोटेट वर्ग;
• समारोह - एनोटेट वर्ग की विधि;
• शुद्ध - एनोटेशन यह दर्शाता है कि विधि साफ है, अर्थात। नियतात्मक और दुष्प्रभावों के बिना;
• सेट - विधि के लिए एक मनमाना ध्वज सेट करना।
• FunctionClassification :: NoDiscard - एक ध्वज का अर्थ है कि विधि का वापसी मूल्य उपयोग किया जाना चाहिए;
• फंक्शनक्लासिफिकेशन :: NoReturn - यह दर्शाता है कि विधि नियंत्रण वापस नहीं करती है;
• Arg1 , Arg2 , ... , ArgN - विधि के तर्क;
• रिटर्न - विधि का वापसी मूल्य;
• आवश्यकता है - विधि के लिए एक अनुबंध।

यह ध्यान देने योग्य है कि मैनुअल मार्कअप के अलावा, एनोटेशन के लिए एक और दृष्टिकोण है - बाइट कोड के आधार पर अनुबंधों का स्वचालित आउटपुट। यह स्पष्ट है कि यह दृष्टिकोण आपको केवल कुछ विशेष प्रकार के अनुबंधों को प्रदर्शित करने की अनुमति देता है, लेकिन यह सभी आश्रितों से सामान्य रूप से अतिरिक्त जानकारी प्राप्त करना संभव बनाता है, और न केवल उन लोगों से जो मैन्युअल रूप से एनोटेट किए गए थे।

वैसे, पहले से ही एक उपकरण मौजूद है जो @Nullable , NotNull जैसे अनुबंधों को बाइटकोड - FABA पर आधारित प्रदर्शित कर सकता है। जैसा कि मैं इसे समझता हूं, IntelliJ IDEA में FABA व्युत्पन्न का उपयोग किया जाता है।

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

काम पर नैदानिक ​​नियम अक्सर एनोटेशन का संदर्भ देते हैं। डायग्नोस्टिक्स के अलावा, एनोटेशन डेटा फ्लो तंत्र का उपयोग करते हैं। उदाहरण के लिए, java.lang.Math.abs पद्धति के एनोटेशन का उपयोग करके, यह संख्या मॉड्यूल के लिए मूल्य की सही गणना कर सकता है। उसी समय, आपको कोई अतिरिक्त कोड लिखने की ज़रूरत नहीं है - बस विधि को सही तरीके से चिह्नित करें।

हाइबरनेट प्रोजेक्ट से त्रुटि के एक उदाहरण पर विचार करें जिसे एनोटेशन के माध्यम से पता लगाया जा सकता है:

 public boolean equals(Object other) { if (other instanceof Id) { Id that = (Id) other; return purchaseSequence.equals(this.purchaseSequence) && that.purchaseNumber == this.purchaseNumber; } else { return false; } } 

इस कोड में, बराबरी () विधि खरीद की तुलना वस्तु के साथ ही करती है। निश्चित रूप से यह एक टाइपो है और दाईं ओर होना चाहिए।

कैसे डॉ। फ्रेंकस्टीन भागों से एक विश्लेषक की तरह

चूंकि डेटा प्रवाह और एनोटेशन के तंत्र स्वयं एक विशेष भाषा से बहुत अधिक बंधे नहीं हैं, इसलिए हमारे सी ++ विश्लेषक से इन तंत्रों का पुन: उपयोग करने का निर्णय लिया गया। इससे हमें अपने जावा विश्लेषक में C ++ विश्लेषक कोर की सभी शक्ति जल्दी से प्राप्त करने की अनुमति मिली। इसके अलावा, यह निर्णय इस तथ्य से भी प्रभावित था कि इन तंत्रों को आधुनिक सी ++ में मेटाप्रोग्रामिंग और टेम्पलेट मैजिक के एक गुच्छा के साथ लिखा गया था, और तदनुसार, किसी अन्य भाषा में स्थानांतरित करने के लिए बहुत उपयुक्त नहीं हैं।

जावा भाग को C ++ कर्नेल के साथ जोड़ने के लिए, हमने SWIG (सरलीकृत आवरण और इंटरफ़ेस जेनरेटर) का उपयोग करने का निर्णय लिया - सी और सी ++ प्रोग्राम को अन्य भाषाओं में लिखे गए प्रोग्रामों के साथ जोड़ने के लिए स्वचालित रूप से रैपर और इंटरफेस उत्पन्न करने का उपकरण। जावा के लिए, SWIG जेएनआई (जावा नेटिव इंटरफ़ेस) कोड उत्पन्न करता है।

SWIG उन मामलों के लिए बहुत अच्छा है जहां पहले से ही C ++ कोड की एक बड़ी मात्रा है जिसे जावा प्रोजेक्ट में एकीकृत करने की आवश्यकता है।

मैं SWIG के साथ काम करने का एक न्यूनतम उदाहरण दूंगा। मान लीजिए कि हमारे पास C ++ क्लास है जिसे हम जावा प्रोजेक्ट में इस्तेमाल करना चाहते हैं:

CoolClass.h

 class CoolClass { public: int val; CoolClass(int val); void printMe(); }; 

CoolClass.cpp

 #include <iostream> #include "CoolClass.h" CoolClass::CoolClass(int v) : val(v) {} void CoolClass::printMe() { std::cout << "val: " << val << '\n'; } 

पहले आपको सभी निर्यात किए गए फ़ंक्शन और कक्षाओं के विवरण के साथ एक SWIG इंटरफ़ेस फ़ाइल बनाने की आवश्यकता है। इस फ़ाइल में भी, यदि आवश्यक हो, तो अतिरिक्त सेटिंग्स की जाती हैं।

Example.i

 %module MyModule %{ #include "CoolClass.h" %} %include "CoolClass.h" 

उसके बाद, आप SWIG चला सकते हैं:

 $ swig -c++ -java Example.i 

यह निम्नलिखित फाइलें उत्पन्न करेगा:

• CoolClass.java - एक वर्ग जिसके साथ हम सीधे जावा परियोजना में काम करेंगे;
• MyModule.java - एक मॉड्यूल वर्ग जिसमें सभी मुफ्त कार्य और चर रखे जाते हैं;
• MyModuleJNI.java - जावा रैपर;
• Example_wrap.cxx - C ++ रैपर।

अब आपको परिणामी .java फ़ाइलों को Java प्रोजेक्ट और .cxx फ़ाइल को C ++ प्रोजेक्ट में जोड़ना होगा।

अंत में, आपको C ++ प्रोजेक्ट को डायनामिक लाइब्रेरी के रूप में संकलित करने और इसे System.loadLibary () का उपयोग करके जावा प्रोजेक्ट में लोड करने की आवश्यकता है :

App.java

 class App { static { System.loadLibary("example"); } public static void main(String[] args) { CoolClass obj = new CoolClass(42); obj.printMe(); } } 

योजनाबद्ध रूप से, इसे निम्नानुसार दर्शाया जा सकता है:

बेशक, एक वास्तविक परियोजना में सब कुछ इतना आसान नहीं है और आपको थोड़ा और प्रयास करना होगा:

• C ++ से टेम्पलेट कक्षाओं और विधियों का उपयोग करने के लिए, उन्हें % टेम्पलेट निर्देश का उपयोग करके सभी स्वीकृत टेम्पलेट मापदंडों के लिए त्वरित किया जाना चाहिए;
• कुछ मामलों में, आपको अपवादों को पकड़ने की आवश्यकता हो सकती है जिन्हें जावा भाग में C ++ भाग से फेंक दिया जाता है। डिफ़ॉल्ट रूप से, SWIG C ++ से अपवादों को नहीं पकड़ता है (segfault होता है), हालांकि, % अपवाद निर्देश का उपयोग करके ऐसा करना संभव है;
• SWIG % निर्देश का उपयोग करते हुए आपको जावा की ओर से प्लस कोड का विस्तार करने की अनुमति देता है। उदाहरण के लिए, हमारी परियोजना में, हम आभासी मूल्यों में toString () पद्धति को जोड़ते हैं ताकि हम उन्हें जावा डीबगर में देख सकें;
• C ++ से RAII व्यवहार का अनुकरण करने के लिए, AutoClosable Interface को सभी वर्गों के हित में लागू किया गया है;
• निर्देशक तंत्र क्रॉस-भाषा बहुरूपता के उपयोग की अनुमति देता है;
• उन प्रकारों के लिए जिन्हें केवल C ++ (उनके मेमोरी पूल पर) के अंदर आवंटित किया गया है, निर्माणकर्ताओं और फाइनलर्स को प्रदर्शन में सुधार के लिए हटा दिया जाता है। कचरा संग्रहकर्ता इन प्रकारों की अनदेखी करेगा।

आप SWIG प्रलेखन में इन सभी तंत्रों के बारे में अधिक पढ़ सकते हैं।

हमारा विश्लेषक ग्रेडेल का उपयोग करके बनाया गया है, जो सीएमके को कॉल करता है, जो बदले में, SWIG को कॉल करता है और C ++ भाग को संकलित करता है। प्रोग्रामर के लिए, यह लगभग अपूर्ण रूप से होता है, इसलिए हम विकास के दौरान किसी विशेष असुविधा का अनुभव नहीं करते हैं।

हमारे C ++ विश्लेषक का कोर विंडोज, लिनक्स, मैकओएस के तहत बनाया गया है, इसलिए जावा विश्लेषक भी इन ओएस में काम करता है।

एक नैदानिक ​​नियम क्या है?

निदान खुद और विश्लेषण के लिए कोड जावा में लिखे गए हैं। यह चम्मच के साथ घनिष्ठ बातचीत के कारण है। प्रत्येक नैदानिक ​​नियम एक आगंतुक है, जिसके तरीके अतिभारित हैं, जिसमें हमारे लिए रुचि के तत्वों को दरकिनार किया गया है:

उदाहरण के लिए, V6004 नैदानिक ​​ढांचा इस तरह दिखता है:

 class V6004 extends PvsStudioRule { .... @Override public void visitCtIf(CtIf ifElement) { // if ifElement.thenStatement statement is equivalent to // ifElement.elseStatement statement => add warning V6004 } } 

प्लग-इन

परियोजना में स्थिर विश्लेषक के सबसे आसान एकीकरण के लिए, हमने मावेन और ग्रैडल असेंबली सिस्टम के लिए प्लगइन्स विकसित किए हैं। उपयोगकर्ता केवल हमारे प्लगइन को परियोजना में जोड़ सकता है।

ग्रेडेल के लिए:

 .... apply plugin: com.pvsstudio.PvsStudioGradlePlugin pvsstudio { outputFile = 'path/to/output.json' .... } 

मावेन के लिए:

 .... <plugin> <groupId>com.pvsstudio</groupId> <artifactId>pvsstudio-maven-plugin</artifactId> <version>0.1</version> <configuration> <analyzer> <outputFile>path/to/output.json</outputFile> .... </analyzer> </configuration> </plugin> 

उसके बाद, प्लगइन स्वतंत्र रूप से परियोजना संरचना प्राप्त करेगा और विश्लेषण शुरू करेगा।

इसके अलावा, हमने IntelliJ IDEA के लिए एक प्रोटोटाइप प्लगइन विकसित किया है।

यह प्लगइन एंड्रॉइड स्टूडियो में भी काम करता है।

ग्रहण के लिए एक प्लगइन वर्तमान में विकास के अधीन है।

वृद्धिशील विश्लेषण

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

वृद्धिशील विश्लेषण में कई चरण शामिल हैं:

• चम्मच मेटामोडेल कैशिंग;
• मेटामोडेल के बदले हुए हिस्से का पुनर्निर्माण;
• बदली हुई फाइलों का विश्लेषण।

हमारे परीक्षण प्रणाली

वास्तविक परियोजनाओं पर जावा विश्लेषक का परीक्षण करने के लिए, हमने एक विशेष टूलकिट लिखा है जो आपको खुली परियोजनाओं के डेटाबेस के साथ काम करने की अनुमति देता है। यह ^ डब्ल्यू पायथन + टिंकर में लिखा गया था और क्रॉस-प्लेटफॉर्म है।

यह निम्नानुसार काम करता है:

• एक विशिष्ट संस्करण की परीक्षण परियोजना GitHub पर भंडार से डाउनलोड की जाती है;
• परियोजना को इकट्ठा किया जा रहा है;
• हमारे प्लगइन को pom.xml या build.gradle (git apply का उपयोग करके) में जोड़ा जाता है;
• स्थैतिक विश्लेषक प्लगइन का उपयोग करके लॉन्च किया गया है;
• परिणामी रिपोर्ट की तुलना इस परियोजना के लिए बेंचमार्क के साथ की गई है।

यह दृष्टिकोण सुनिश्चित करता है कि विश्लेषक कोड को बदलने के परिणामस्वरूप अच्छी प्रतिक्रियाएं नहीं खोई गई हैं। नीचे हमारे परीक्षण उपयोगिता का इंटरफ़ेस है।

उन परियोजनाओं की रिपोर्ट जिनमें मानक के साथ कोई अंतर है उन्हें लाल रंग में चिह्नित किया गया है। अनुमोदन बटन आपको संदर्भ के रूप में रिपोर्ट के वर्तमान संस्करण को बचाने की अनुमति देता है।

त्रुटि के उदाहरण

परंपरा से, मैं विभिन्न खुली परियोजनाओं से कई त्रुटियों का हवाला दूंगा जो हमारे जावा विश्लेषक ने पाया। भविष्य में, प्रत्येक परियोजना पर अधिक विस्तृत रिपोर्ट के साथ लेख लिखने की योजना है।

हाइबरनेट परियोजना

PVS-Studio चेतावनी: V6009 फ़ंक्शन 'बराबर' को विषम तर्क प्राप्त होते हैं। तर्कों का निरीक्षण करें: यह, 1. पर्चेजकार्ड.जवा 57

 public boolean equals(Object other) { if (other instanceof Id) { Id that = (Id) other; return purchaseSequence.equals(this.purchaseSequence) && that.purchaseNumber == this.purchaseNumber; } else { return false; } } 

इस कोड में, बराबरी () विधि खरीद की तुलना वस्तु के साथ ही करती है। सबसे अधिक संभावना है, यह एक टाइपो है और दाईं ओर होना चाहिए।

PVS-Studio चेतावनी: V6009 फ़ंक्शन 'बराबर' को विषम तर्क प्राप्त होते हैं। तर्कों का निरीक्षण करें: यह, 1. ListHashcodeChangeTest.java 232

 public void removeBook(String title) { for( Iterator<Book> it = books.iterator(); it.hasNext(); ) { Book book = it.next(); if ( title.equals( title ) ) { it.remove(); } } } 

पिछले एक के समान एक ऑपरेशन - दाईं ओर book.title होना चाहिए, शीर्षक नहीं।

प्रोजेक्ट हाइव

पीवीएस-स्टूडियो चेतावनी : V6007 अभिव्यक्ति 'colOrScalar1.equals ("कॉलम")' हमेशा गलत है। GenVectorCode.java 2768

पीवीएस-स्टूडियो चेतावनी : V6007 अभिव्यक्ति 'colOrScalar1.equals ("स्केलर")' हमेशा गलत है। GenVectorCode.java 2774

पीवीएस-स्टूडियो चेतावनी : V6007 अभिव्यक्ति 'colOrScalar1.equals ("कॉलम")' हमेशा गलत है। GenVectorCode.java 2785

 String colOrScalar1 = tdesc[4]; .... if (colOrScalar1.equals("Col") && colOrScalar1.equals("Column")) { .... } else if (colOrScalar1.equals("Col") && colOrScalar1.equals("Scalar")) { .... } else if (colOrScalar1.equals("Scalar") && colOrScalar1.equals("Column")) { .... } 

संचालक यहाँ स्पष्ट रूप से भ्रमित हैं और इसके बजाय ' ||' ' &&' का उपयोग किया।

JavaParser प्रोजेक्ट

PVS-Studio चेतावनी : V6001 समान उप-अभिव्यक्तियाँ हैं 'tokenRange.getBegin ()। GetRange ()। IsPresent ()' बाईं ओर और '&&' ऑपरेटर के दाईं ओर। नोड.जावा 213

 public Node setTokenRange(TokenRange tokenRange) { this.tokenRange = tokenRange; if (tokenRange == null || !(tokenRange.getBegin().getRange().isPresent() && tokenRange.getBegin().getRange().isPresent())) { range = null; } else { range = new Range( tokenRange.getBegin().getRange().get().begin, tokenRange.getEnd().getRange().get().end); } return this; } 

विश्लेषक ने पाया कि समान अभिव्यक्तियाँ && ऑपरेटर के बाईं और दाईं ओर हैं (जबकि कॉल श्रृंखला की सभी विधियाँ साफ़ हैं)। सबसे अधिक संभावना है, दूसरे मामले में tokenRange.getEnd () , और tokenRange.getBegin () का उपयोग करना आवश्यक है।

PVS- स्टूडियो चेतावनी: एक लूप के अंदर निरंतर सूचकांक द्वारा 'typeDeclaration.getTypeParameters ()' ऑब्जेक्ट के तत्व तक V6016 संदिग्ध पहुंच। संकल्प। संदर्भ। Java 265

 if (!isRawType()) { for (int i=0; i<typeDeclaration.getTypeParams().size(); i++) { typeParametersMap.add( new Pair<>(typeDeclaration.getTypeParams().get(0), typeParametersValues().get(i))); } } 

विश्लेषक ने लूप के अंदर एक स्थिर सूचकांक पर संग्रह आइटम तक संदिग्ध पहुंच का पता लगाया। इस कोड में कोई त्रुटि हो सकती है।

जेनकिंस प्रोजेक्ट

पीवीएस-स्टूडियो चेतावनी : V6007 अभिव्यक्ति 'cnt <5' हमेशा सच होती है। AbstractProject.java 557

 public final R getSomeBuildWithWorkspace() { int cnt = 0; for (R b = getLastBuild(); cnt < 5 && b ! = null; b = b.getPreviousBuild()) { FilePath ws = b.getWorkspace(); if (ws != null) return b; } return null; } 

इस कोड को पाँच तक सीमित करने के लिए cnt वैरिएबल को पेश किया गया था , लेकिन इसे बढ़ाना भूल गया, जिसके परिणामस्वरूप चेक बेकार है।

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

पीवीएस-स्टूडियो चेतावनी : V6007 एक्सप्रेशन 'स्पार्कऐप्लिकेशंस! = नल' हमेशा सच होता है। स्पार्कफिल्टर.जावा 127

 if (StringUtils.isNotBlank(applications)) { final String[] sparkApplications = applications.split(","); if (sparkApplications != null && sparkApplications.length > 0) { ... } } 

विभाजित विधि द्वारा लौटाए गए परिणाम के अशक्त के लिए जाँच करना व्यर्थ है, क्योंकि यह विधि हमेशा एक संग्रह लौटाती है और कभी भी अशक्त नहीं लौटती है ।

चम्मच परियोजना

PVS-Studio चेतावनी: V6001 समान उप-भाव हैं '! MgetSimpleName ()। StartsWith ("सेट") बाईं ओर और' && 'ऑपरेटर के दाईं ओर स्थित है। स्पूनटेस्ट हेल्पर्स.जावा 108

 if (!m.getSimpleName().startsWith("set") && !m.getSimpleName().startsWith("set")) { continue; } 

इस कोड में, समान अभिव्यक्तियाँ && ऑपरेटर के बाईं और दाईं ओर हैं (कॉल श्रृंखला के सभी तरीके साफ़ हैं)। सबसे अधिक संभावना है, कोड में एक तार्किक त्रुटि है।

PVS-Studio चेतावनी : V6007 अभिव्यक्ति 'idxOfScopeBoundTypeParam> = 0' हमेशा सत्य होता है। MethodTypingContext.java 243

 private boolean isSameMethodFormalTypeParameter(....) { .... int idxOfScopeBoundTypeParam = getIndexOfTypeParam(....); if (idxOfScopeBoundTypeParam >= 0) { // <= int idxOfSuperBoundTypeParam = getIndexOfTypeParam(....); if (idxOfScopeBoundTypeParam >= 0) { // <= return idxOfScopeBoundTypeParam == idxOfSuperBoundTypeParam; } } .... } 

यहां वे दूसरी स्थिति में सील कर दिए गए और इसके बजाय idxOfSuperBoundTypeParam ने idxOfScopeBoundTypeParam लिखा ।

स्प्रिंग सिक्योरिटी प्रोजेक्ट

PVS-Studio चेतावनी: V6001 बाईं और 'के दाईं ओर समान उप-अभिव्यक्तियाँ हैं' || ऑपरेटर। चेक लाइनें: 38, 39. AnyRequestMatcher.java 38

 @Override @SuppressWarnings("deprecation") public boolean equals(Object obj) { return obj instanceof AnyRequestMatcher || obj instanceof security.web.util.matcher.AnyRequestMatcher; } 

ऑपरेशन पिछले एक के समान है - यहां एक ही वर्ग का नाम अलग-अलग तरीकों से लिखा गया है।

PVS-Studio चेतावनी: V6006 ऑब्जेक्ट बनाया गया था, लेकिन इसका उपयोग नहीं किया जा रहा है। 'थ्रो' कीवर्ड गायब हो सकता है। डाइजेस्ट ऑथेंटिकेशनफिल्टर.जावा 434

 if (!expectedNonceSignature.equals(nonceTokens[1])) { new BadCredentialsException( DigestAuthenticationFilter.this.messages .getMessage("DigestAuthenticationFilter.nonceCompromised", new Object[] { nonceAsPlainText }, "Nonce token compromised {0}")); } 

इस कोड में, वे अपवाद से पहले फेंक जोड़ना भूल गए । परिणामस्वरूप, BadCredentialsException अपवाद ऑब्जेक्ट को फेंक दिया जाता है , लेकिन किसी भी तरह से उपयोग नहीं किया जाता है, अर्थात। एक अपवाद नहीं फेंका गया है।

पीवीएस-स्टूडियो चेतावनी: V6030 'के दाईं ओर स्थित विधि' | बाएं ऑपरेंड के मूल्य की परवाह किए बिना ऑपरेटरों को बुलाया जाएगा। शायद, '' का उपयोग करना बेहतर है। RedirectUrlBuilder.java 38

 public void setScheme(String scheme) { if (!("http".equals(scheme) | "https".equals(scheme))) { throw new IllegalArgumentException("..."); } this.scheme = scheme; } 

इस कोड में, का उपयोग | अनुचित, इसका उपयोग करते समय, दाएं पक्ष की गणना की जाएगी भले ही बाईं ओर पहले से ही सच हो। इस मामले में, यह कोई व्यावहारिक अर्थ नहीं रखता है, इसलिए ऑपरेटर | के साथ बदलने के लायक || ।

इंटेलीज आईडिया प्रोजेक्ट

पीवीएस-स्टूडियो चेतावनी: V6008 'संपादक' की संभावित अशक्तता। IntroduceVariableBase.java:609

 final PsiElement nameSuggestionContext = editor == null ? null : file.findElementAt(...); // <= final RefactoringSupportProvider supportProvider = LanguageRefactoringSupport.INSTANCE.forLanguage(...); final boolean isInplaceAvailableOnDataContext = supportProvider != null && editor.getSettings().isVariableInplaceRenameEnabled() && // <= ... 

विश्लेषक ने पाया कि इस कोड में संपादक अशक्त सूचक की गड़बड़ी हो सकती है । यह एक अतिरिक्त चेक जोड़ने के लायक है।

PVS-Studio चेतावनी: V6007 अभिव्यक्ति हमेशा झूठी है। RefResolveServiceImpl.java:814

 @Override public boolean contains(@NotNull VirtualFile file) { .... return false & !myProjectFileIndex.isUnderSourceRootOfType(....); } 

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

पीवीएस-स्टूडियो चेतावनी : V6007 अभिव्यक्ति 'परिणाम [0]' हमेशा गलत है। CopyClassesHandler.java:298

 final boolean[] result = new boolean[] {false}; // <= Runnable command = () -> { PsiDirectory target; if (targetDirectory instanceof PsiDirectory) { target = (PsiDirectory)targetDirectory; } else { target = WriteAction.compute(() -> ((MoveDestination)targetDirectory).getTargetDirectory( defaultTargetDirectory)); } try { Collection<PsiFile> files = doCopyClasses(classes, map, copyClassName, target, project); if (files != null) { if (openInEditor) { for (PsiFile file : files) { CopyHandler.updateSelectionInActiveProjectView( file, project, selectInActivePanel); } EditorHelper.openFilesInEditor( files.toArray(PsiFile.EMPTY_ARRAY)); } } } catch (IncorrectOperationException ex) { Messages.showMessageDialog(project, ex.getMessage(), RefactoringBundle.message("error.title"), Messages.getErrorIcon()); } }; CommandProcessor processor = CommandProcessor.getInstance(); processor.executeCommand(project, command, commandName, null); if (result[0]) { // <= ToolWindowManager.getInstance(project).invokeLater(() -> ToolWindowManager.getInstance(project) .activateEditorComponent()); } 

मुझे संदेह है कि यहां वे किसी तरह परिणाम में मूल्य बदलना भूल गए । इस वजह से, विश्लेषक रिपोर्ट करता है कि अगर जाँच (परिणाम [0]) व्यर्थ है।

निष्कर्ष

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

निकट भविष्य के लिए हमारी योजनाएं इस प्रकार हैं:

• बाइटकोड के आधार पर आउटपुट एनोटेशन;
• चींटी पर परियोजनाओं में एकीकरण (2018 में कोई और इसका उपयोग करता है?);
• ग्रहण के लिए प्लगइन (विकास के तहत);
• इससे भी अधिक निदान और एनोटेशन;
• डेटा प्रवाह के तंत्र में सुधार।

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

यदि आप इस लेख को अंग्रेजी बोलने वाले दर्शकों के साथ साझा करना चाहते हैं, तो कृपया अनुवाद के लिंक का उपयोग करें: Egor Bredikhin। एक नए स्थैतिक विश्लेषक का विकास: