Driver TestingRavi Gollapudi's thoughts on testing device drivers for Windowshttp://blogs.msdn.com/ravig/atom.xmlCommunity Server2007-05-29T22:43:00ZChecklist for testing device drivers ...http://blogs.msdn.com/ravig/archive/2007/06/19/checklist-for-testing-device-drivers.aspx2007-06-19T20:34:00Z2007-06-19T20:34:00Z<P class=MsoNormal style="MARGIN: 0in 0in 10pt"><FONT face=Calibri size=3>So I have been working on coming up with a short checklist for testing device drivers. There are several tools in the WDK that are very useful to find bugs in device drivers. At a minimum, I think the below should ideally be run on every driver package (more details about all these tools are in the WDK documentation):</FONT></P>
<P class=MsoListParagraphCxSpFirst style="MARGIN: 0in 0in 0pt 0.5in; TEXT-INDENT: -0.25in; mso-list: l0 level1 lfo1"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>1.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>Static Analysis tools:</FONT></P>
<P class=MsoListParagraphCxSpMiddle style="MARGIN: 0in 0in 0pt 1in; TEXT-INDENT: -0.25in; mso-list: l0 level2 lfo1; mso-add-space: auto"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>a.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>Prefast For Drivers (PFD) (%BASEDIR%\tools\pfd): This is a compile time static analysis tool that specifically looks for the potential presence of common device driver bugs. This works with both C and C++ code.</FONT></P>
<P class=MsoListParagraphCxSpMiddle style="MARGIN: 0in 0in 0pt 1in; TEXT-INDENT: -0.25in; mso-list: l0 level2 lfo1; mso-add-space: auto"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>b.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>Static Driver Verifier (SDV) (%BASEDIR%\tools\sdv): This is a rigorous static analysis tool for WDM only device drivers written in C.</FONT></P>
<P class=MsoListParagraphCxSpMiddle style="MARGIN: 0in 0in 0pt 1in; TEXT-INDENT: -0.25in; mso-list: l0 level2 lfo1; mso-add-space: auto"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>c.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>ChkINF (%BASEDIR%\tools\chkinf). Driver Installation errors are IMO very easy to run into. This is a very useful tool to figure out any potential problems in INF files even before attempting to use them to install a driver. </FONT></P>
<P class=MsoListParagraphCxSpMiddle style="MARGIN: 0in 0in 0pt 1in; mso-add-space: auto"><?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" /><o:p><FONT face=Calibri size=3> </FONT></o:p></P>
<P class=MsoListParagraphCxSpMiddle style="MARGIN: 0in 0in 0pt 0.5in; TEXT-INDENT: -0.25in; mso-list: l0 level1 lfo1"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>2.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>Runtime tools: Using the below with Driver Verifier turned on would be most beneficial (ideally a mix of I/O, Pnp and Power management tests should be used). Also, early in the development process, it would help to use checked binaries for testing.</FONT></P>
<P class=MsoListParagraphCxSpMiddle style="MARGIN: 0in 0in 0pt 1in; TEXT-INDENT: -0.25in; mso-list: l0 level2 lfo1; mso-add-space: auto"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>a.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>Device Path Exerciser or dc2 (in %BASEDIR%\tools\dc2 directory in the Vista RTM WDK): This tool sends a bunch of valid and invalid I/Os to a driver and is a great security test. As the htm file in the dc2 directory in the WDK, “a comprehensive set of tests on your driver can be run using the command: dc2 /hct /dr your-driver-name”. <SPAN style="mso-spacerun: yes"> </SPAN>For drivers using IoCreateDeviceSecure with a restrictive SDDL string, the “-im” option may have to be used in addition.</FONT></P>
<P class=MsoListParagraphCxSpMiddle style="MARGIN: 0in 0in 0pt 1in; TEXT-INDENT: -0.25in; mso-list: l0 level2 lfo1; mso-add-space: auto"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>b.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>Pnpdtest (in <SPAN style="mso-spacerun: yes"> </SPAN>%BASEDIR%\tools\pnpdtest): This tool tests pnp implementation in a driver and running the stress test on your driver would be a very useful thing to do. </FONT></P>
<P class=MsoListParagraphCxSpLast style="MARGIN: 0in 0in 10pt 1in; TEXT-INDENT: -0.25in; mso-list: l0 level2 lfo1; mso-add-space: auto"><SPAN style="mso-bidi-font-family: Calibri; mso-bidi-theme-font: minor-latin"><SPAN style="mso-list: Ignore"><FONT face=Calibri size=3>c.</FONT><SPAN style="FONT: 7pt 'Times New Roman'"> </SPAN></SPAN></SPAN><FONT face=Calibri size=3>WDTF Sleep_Stress_With_IO.wsf (in %BASEDIR%\tools\WDTF\%_BUILDARCH%fre\samplescripts): This cycles the system through different power states and also does some basic i/o testing. As an alternative, the pwrtest tool (in %BASEDIR%\tools\acpi\pwrtest) can also be run.</FONT></P>
<P class=MsoListParagraphCxSpFirst style="MARGIN: 0in 0in 0pt 0.5in; TEXT-INDENT: -0.25in; mso-list: l0 level1 lfo1"><FONT face=Calibri size=3> </P></FONT><img src="http://blogs.msdn.com/aggbug.aspx?PostID=3408811" width="1" height="1">ravi_gollapudihttp://blogs.msdn.com/members/ravi_gollapudi.aspxAbout Mehttp://blogs.msdn.com/ravig/archive/2007/05/29/about-me.aspx2007-05-30T00:43:00Z2007-05-30T00:43:00Z<P>I am currently working as a Software Design Engineer in Test in the <A class="" href="http://www.microsoft.com/whdc/driver/wdf/default.mspx" mce_href="http://www.microsoft.com/whdc/driver/wdf/default.mspx">Windows Driver Foundation</A> group. I have been in Microsoft for over 7 years now after graduating from Michigan State University. After joining Microsoft, I have worked as a Support Engineer in the DDK Developer Support team for about 3 years. During this time, I have primarily worked on storage drivers. I then moved to the <A class="" href="http://www.microsoft.com/whdc/driver/wdf/KMDF.mspx" mce_href="http://www.microsoft.com/whdc/driver/wdf/KMDF.mspx">Kernel Mode Driver Framework</A> team initially as a Test Developer. I was the Test Lead for KMDF for over 3 years and worked on KMDF versions 1.0 through 1.5 (Details on how to get the latest version are available <A class="" href="http://www.microsoft.com/whdc/driver/wdf/KMDF_pkg.mspx" mce_href="http://www.microsoft.com/whdc/driver/wdf/KMDF_pkg.mspx">here</A>)</P>
<P>I am planning to post some of my thoughts on how to test drivers in this blog. </P>
<P>-Ravi</P><img src="http://blogs.msdn.com/aggbug.aspx?PostID=2976044" width="1" height="1">ravi_gollapudihttp://blogs.msdn.com/members/ravi_gollapudi.aspx