EventTrace विंडोज के लिए। हाई-स्पीड नेटवर्क ड्राइवर डीबगिंग

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

प्रागितिहास

विंडोज टेक्नोलॉजी के लिए इवेंटट्रेस को पहले विंडोज 2k में शामिल किया गया था और तब से यह सभी बाद के ओएस का एक वफादार साथी रहा है, धीरे-धीरे सॉफ्टवेयर की बढ़ती संख्या को भेद रहा है: ड्राइवरों से उपयोगकर्ता अनुप्रयोगों तक।
यह कहना मुश्किल है कि यह एक सफलता थी, लेकिन ईटीडब्ल्यू में एक हाइलाइट - गति है। ड्राइवर की गहराई से प्रति सेकंड हजारों डिबगिंग संदेशों के प्रदर्शन पर एक अल्प प्रभाव के साथ एक इंजीनियर की कल्पना के लिए जगह मिलती है। और अगर हम इसे प्राप्त जानकारी के विस्तार और सटीकता से जोड़ते हैं, तो जीवन बादल रहित होने लगता है।
इस भावना से प्रेरित होकर, हमने लागू करना शुरू किया। कठिनाइयाँ लगभग तुरंत शुरू हुईं और इन कठिनाइयों का नाम था - ट्रेस व्यू । यह उपयोगिता, डिबग संदेशों को प्राप्त करने और देखने के लिए डिज़ाइन की गई है, हठपूर्वक वह नहीं करना चाहता था जो इसके लिए बनाया गया था।
यदि संदेश वितरण तकनीक पर अच्छी तरह से काम किया गया था - ETW ने आसानी से दसियों को निगल लिया, लेकिन यह रसीद के साथ काम नहीं करता था, तो ऐसा लगता था कि TraceView निगम की आंतों में एक अकेला इंजीनियर द्वारा अपनी आवश्यकताओं के लिए बनाया गया था और गलती से DDK में समाप्त हो गया था।

समस्या

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

निर्णय

स्वतंत्र अनुसंधान के विचार को हमारे आर एंड डी विभाग के नेतृत्व ने समझ और उत्साह के साथ बधाई दी थी, लेकिन कार्यों की एक सूची को संकलित करने और तोते में इसका मूल्यांकन करने के बाद, यह स्पष्ट हो गया कि हमारे पास ऐसे मुक्त संसाधन नहीं थे। यह केवल सबसे बुनियादी कार्यक्षमता के लिए लगभग 6 मानव-महीने था। और, जैसा कि आप जानते हैं - भूख खाने के साथ आती है।
"विफलताओं" की एक श्रृंखला के बावजूद, मैं इस विचार को नहीं भूल सकता था। इस प्रकार, लगभग एक साल पहले शाम की एक श्रृंखला शुरू हुई, जब, एक नौकरी से आया, मैं दूसरे के लिए आगे बढ़ा। इस काम के परिणामस्वरूप, निम्नलिखित एप्लिकेशन और लाइब्रेरी पैदा हुए (स्रोत कोड Apache 2.0 लाइसेंस के तहत वितरित किए गए हैं):

• बाइकाल - एक सर्वर-आधारित ढांचा अनुप्रयोग, जिसमें विस्तार मॉड्यूल जुड़े हुए हैं (प्रदाता, रिपॉजिटरी, दर्शक);
• हैंगर - एक ईटीडब्ल्यू सत्र का प्रबंधन करने वाला एक क्लाइंट एप्लिकेशन, संदेश प्राप्त करता है और उन्हें बाइकाल को अग्रेषित करता है;
• P7.Trace - C ++ पुस्तकालय विकसित अनुप्रयोग के डिबग संदेशों को संसाधित करने और उन्हें बाइकाल तक प्रसारित करने के लिए जिम्मेदार है। संक्षेप में, यह एक ईटीडब्ल्यू प्रतिस्थापन है जो विंडोज और लिनक्स दोनों पर काम कर सकता है;

इस सारे सामान की खासियत क्या है? ETW के साथ के रूप में, यह गति है। यह आधुनिक होम पीसी के लिए प्रति सेकंड लाखों डिबग संदेशों के बारे में है। उदाहरण के लिए: I7-870 की जोड़ी और एक गीगाबिट नेटवर्क प्रारूप के 2 मिलियन से अधिक संदेशों को निगल सकता है:

Trace(“Here is my trace and here are my values: %d %d”, iVal1, iVal2); 

स्ट्रिंग और मापदंडों के स्पष्ट प्रारूप के अलावा, निम्न डेटा भी प्रेषित किया जाता है:

• "चिंता" का स्तर (ट्रेस, सूचना, चेतावनी, त्रुटि, आदि);
• 100 नैनो सेकंड के लिए सही समय;
• प्रोसेसर की संख्या जिस पर कोड निष्पादित किया गया था;
• वर्तमान धागे की आईडी;
• मॉड्यूल आईडी;
• फ़ंक्शन का नाम, फ़ाइल, फ़ाइल में लाइन नंबर;
• क्रम संख्या;
• प्रक्रिया के बारे में जानकारी (नाम, आईडी, निर्माण समय);

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

अंगारा

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

ETW सत्र मापदंडों

प्रत्येक ETW सत्र का प्रारंभिक बिंदु नियंत्रण GUID है, आपकी किसी स्रोत फ़ाइल में समान रेखाएँ हैं:

 //{63423ADB-D156-4281-BA74-8ACAEDDBD810} #define WPP_CONTROL_GUIDS \ WPP_DEFINE_CONTROL_GUID(ProviderGuid, (63423ADB, D156, 48d5, B0BC, 8ACAEDDBD810),\ WPP_DEFINE_BIT(DBG_PROVIDER) /* bit 0 = 0x00000001 */ \ /* You can have up to 32 defines. If you want more than that,\ you have to provide another trace control GUID */\ ) 

हम WPP_DEFINE_CONTROL_GUID के मान में रुचि रखते हैं, जिसे फॉर्म {63423ADB-D156-4281-BA74-8ACAEDDBD810} के रूप में लिखा जा सकता है, याद रखें - आपको अभी भी इसकी आवश्यकता है।

दूसरा सबसे महत्वपूर्ण तत्व जिसे आपके ड्राइवर की आवश्यकता होगी वह है ट्रेस मैसेज फॉर्मेट फ़ाइल (TMF)। फ़ाइल डिबग संदेशों के प्रारूप का वर्णन करती है, और इसमें संदेश के बारे में अतिरिक्त जानकारी भी होती है। इस फ़ाइल को प्राप्त करने का सबसे आसान तरीका आपके ड्राइवर के सफलतापूर्वक निर्माण के बाद निम्नलिखित कमांड चलाना है:

 Tracepdb.exe -f MyDriver.pdb -o MyTraceMessageFormatFile.tmf 

Tracepdb.exe सुविधा को DDK के साथ आपूर्ति की जाती है, डिफ़ॉल्ट पथ है: C: \ WinDDK \ {संस्करण} \ tools \ tracing \

सेटिंग्स। प्रदाता

तो, हम एक नियंत्रण GUID और TMF फ़ाइल से लैस हैं - यह अंगारा कॉन्फ़िगरेशन फ़ाइल को संपादित करने का समय है, इसे "Angara.xml" कहा जाता है और निष्पादन योग्य फ़ाइलों के समान फ़ोल्डर में स्थित है। इसे किसी भी संपादक के साथ खोलें जो UTF-16 को समझता है, और हम संपादन शुरू कर सकते हैं।

पहला भाग जिसमें हम रुचि रखते हैं, ईटीडब्ल्यू प्रदाता को समर्पित है:

 <Provider TMF="." GUID="{63423ADB-D156-48d5-B0BC-8ACAEDDBD810}" Level="5" Flags="0xFFFFFFFFFFFFFFFF" Filter="" Platform="X32" /> 

केवल दो आवश्यक पैरामीटर हैं:

• TMF - TMF फ़ाइलों के साथ फ़ोल्डर का पथ, जो आपने उत्पन्न किया;
• GUID - वही नियंत्रण GUID;

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

सेटिंग्स। नेटवर्क

अगला भाग नेटवर्क कनेक्टिविटी के बारे में है:

 <P7Trace Address="localhost" Port="9009" Packet="1472" Name="MyChannel" Verbosity="1" /> 

केवल एक आवश्यक पैरामीटर है - पता, आपको आईपी पता (IPv4 / IPv6) या पीसी का प्रतीकात्मक नाम दर्ज करना होगा, जिस पर बैकल चल रहा है। प्रलेखन में वैकल्पिक मापदंडों का विस्तार से वर्णन किया गया है ।

सेटिंग्स। स्तरों

अंतिम खंड एक मानचित्र है जिस पर बैकल को समझे जाने वाले संदेश स्तर पर ईटीडब्ल्यू संदेश स्तर का रूपांतरण होता है:

 <Levels> <Trace> <WPP Text="TRACE_LEVEL_VERBOSE"/> </Trace> <Debug> <WPP Text="TRACE_LEVEL_NONE"/> </Debug> <Info> <WPP Text="TRACE_LEVEL_INFORMATION"/> </Info> <Warning> <WPP Text="TRACE_LEVEL_WARNING"/> </Warning> <Error> <WPP Text="TRACE_LEVEL_ERROR"/> </Error> <Critical> <WPP Text="TRACE_LEVEL_FATAL"/> <WPP Text="TRACE_LEVEL_CRITICAL"/> </Critical> </Levels> 

इस अनुभाग का संपादन केवल तभी आवश्यक है जब आपने अपने ड्राइवर के स्रोत कोड में मैक्रो को फिर से परिभाषित किया हो, उदाहरण के लिए:

 // Define debug levels #define NONE 0 // Tracing is not on #define FATAL 1 // Abnormal exit or termination #define ERROR 2 // Severe errors that need logging #define WARNING 3 // Warnings such as allocation failure #define INFO 4 // Includes non-error cases such as Entry-Exit #define TRACE 5 // Detailed traces from intermediate steps #define LOUD 6 // Detailed trace from every step 

इस स्थिति में, XML अनुभाग निम्नलिखित रूप लेगा:

 <Levels> <Trace> <WPP Text="LOUD"/> </Trace> <Debug> <WPP Text="TRACE"/> </Debug> <Info> <WPP Text="INFO"/> </Info> <Warning> <WPP Text="WARNING"/> </Warning> <Error> <WPP Text="ERROR"/> </Error> <Critical> <WPP Text="FATAL"/> </Critical> </Levels> 

प्रारंभ

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

 Angara_32.exe Angara.xml # Angara_64.exe Angara.xml 

हैंगर का एक उदाहरण:

एनबी : पुराने ऑपरेटिंग सिस्टम (विंडोज 2k, एक्सपी) पर, एक ईटीडब्ल्यू सत्र एक मध्यवर्ती फ़ाइल के बिना काम नहीं कर सकता है, इसलिए इन ओएस संस्करणों पर हैंगर शुरू करते समय, याद रखें कि हैंगर कुल 250 एमबी से 1 जीबी की कुल मात्रा के साथ कई अस्थायी फाइलें बनाने की कोशिश करेगा, यदि असफलता - प्रक्रिया समाप्त हो जाएगी।

दिखावट

संपूर्ण चित्रमय इंटरफ़ेस, या बल्कि, इसकी अनुपस्थिति, निम्नलिखित चित्र द्वारा वर्णित किया जा सकता है:

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

• मुख्य आँकड़े (अंगारा):
  
  • भेजें - भेजे गए संदेशों की संख्या
  • अस्वीकृत - कुल (सभी कारणों से) भेजने के लिए अस्वीकार किए गए संदेशों की संख्या
  • अज्ञात - अज्ञात संदेशों की संख्या, यह काउंटर किसी संदेश के आने पर हर बार बढ़ता है, जिसका वर्णन TMF फ़ाइलों में नहीं मिल सकता है। संभावित कारण आवश्यक TMF फ़ाइल की कमी है या TMF फ़ाइल पुरानी है (यह ड्राइवर को संकलित करने के बाद उत्पन्न नहीं हुई थी)
  • टीपीएस - प्रति सेकंड भेजे गए संदेशों की अनुमानित संख्या
  
  
• नेटवर्क सांख्यिकी (P7):
  
  • मुफ्त मेम। - मुक्त आंतरिक मेमोरी का प्रतिशत।
  • Rej। कोई कनेक्ट नहीं। - सर्वर से कनेक्शन की कमी के कारण भेजने के लिए अस्वीकार किए गए संदेशों की संख्या (बाइकाल)
  • Rej। मेमोरी नहीं - मेमोरी की कमी के कारण अस्वीकृत संदेशों की संख्या
  • Rej। आंतरिक - आंतरिक विफलताओं के कारण अस्वीकार किए गए संदेशों की संख्या
  
  
• ETW आँकड़े:
  
  • ईटीडब्ल्यू के अंदर खोए संदेशों की संख्या - निशान खो गए
  • बफ़र्स हार गए - ETW के अंदर बफ़र्स की संख्या कम हो गई
  • Realt। Buf। खो - ETW के अंदर खो वास्तविक समय बफ़र्स की संख्या
  • टूटा हुआ सीक। - बेहिसाब ईटीडब्ल्यू नुकसान की संख्या, निगरानी इस धारणा पर आधारित है कि आने वाले संदेशों की संख्या में एक-एक करके रैखिक वृद्धि होती है।
  
  

निष्कर्ष

मेरी कहानी यहां समाप्त होती है, मुझे उम्मीद है कि यहां प्रस्तुत उपयोगिताओं से ड्राइवरों और एप्लिकेशन सॉफ़्टवेयर के डेवलपर्स के कठिन लेकिन रचनात्मक जीवन की सुविधा होगी।

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