Running Static Driver Verifier on KMDF USB template project

Question

Running Static Driver Verifier on KMDF USB template project

Andreas Brykt 1

I am trying Static Driver Verifier and wanted to start with running this on one of the template projects in Visual Studio 2019. I have followed the steps to install VS 2019, SDK for Windows 11 and WDK. https://learn.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk

I have selected Release configuration for x64 platform, and custom rule set picking only the "DriverCreate" rule. If I comment out the call to "WdfDriverCreate" and set the "status" variable to "STATUS_SUCCESS" then I get a "MustFix Defect" result. If I leave the code as it is from the template then I get "error" as result.

sdv/results/drivercreate_SDV.xml looks like this:

<?xml version="1.0"?>
<RuleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<defect>false</defect>
<Name>drivercreate</Name>
<Result>SDV_TOOLERROR</Result>
<IsPreCondition>false</IsPreCondition>
<IsMustFix>true</IsMustFix>
<isWarning>false</isWarning>
</RuleResult>

How can I fix this SDV_TOOLERROR result. I have tried this on two computers with the same result.

Tianyu Sun-MSFT 34,451 Reputation points Microsoft External Staff

2022-05-06T06:55:10.347+00:00

Hi @Andreas Brykt , welcome to Microsoft Q&A forum.

Could you elaborate every steps that you did after you installed related components? I’d like to try to reproduce your issue on my side and check deeper. Besides, did you also install Visual C++ Redistributable Packages for VS?

Regards,
Tianyu
Andreas Brykt 1 Reputation point

2022-05-06T08:23:04.077+00:00
Yes, I have installed C++ Redistributable Packages for VS.

Steps to reproduce:
With all steps in https://learn.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk done:

Open VS 2019 (I am using Professional), select new project and pick "Kernel Mode Driver, USB (KMDF).

Make sure the project builds.

Goto "Extensions -> Driver -> Launch Static Driver Verifier"

With Static Driver Verifier UI open, go to third tab "Rules" and choose "Custom Rule Selection".

Click "Clear All" buttom, and then tick the "DriverCreate" rule.

Go to first tab and click "Clean" and then "Start". Wait for Static Driver Verifier to complete.

Expected behaviour:

The results listed for the "drivercreate" rule is successful.

Actual:
The result is listed as "error".

If you navigate to $(SolutionDir)/<ProjectName>/sdv/results, then you can find an xml file for each rule that Static Driver Verifier have tried to validate the driver against.

If you examine drivercreate_SDV.xml you can see that SDV_TOOLERROR is reported. To me this sounds like some framework or setup error, not a actual defect in the code.

Just let me know if I can provide any more information.
Andreas Brykt 1 Reputation point

2022-05-16T15:39:55.36+00:00

Hi @Tianyu Sun-MSFT .

Did you have a chance yet to try and reproduce this issue?

Thanks!

Kind regards, Andreas
Tianyu Sun-MSFT 34,451 Reputation points Microsoft External Staff

2022-05-17T09:14:47.523+00:00

Hi Andreas,

Sorry for delay in reply, and thanks for your kind reminder.

I was blocked while trying to reproduce your issue, until I noticed that I had some components not installed. So I followed the steps you shared, but I didn’t get errors. I am considering if some components are missing. May I ask if you have selected and installed MSVC v142 – VS 2019 C++ x64/x86 build tools (V14.xx) component and some other related components which mentioned in Step 1 in VS Installer?

Kind Regards,
Tianyu
Andreas Brykt 1 Reputation point

2022-05-18T10:46:56.317+00:00

No worries @Tianyu Sun-MSFT and thanks for your reply!

I have followed the steps and everything should be installed. One thing that I am suspicious about is the windows SDK version. I have two versions of 10.0.22000 installed. See screenshot:

If I enable verbose build output in VS and search in the output then I don't get any matches with "10.0.22000.1". However, I can see for example:

$(WindowsSDK_ExecutablePath_x64)="C:\Program Files (x86)\Windows Kits\10\bin\10.0.22000.0\x64;;C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools\x64" (previous value: "C:\Program Files (x86)\Windows Kits\10\bin\10.0.22000.0\x64;") at C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\MSBuild\Microsoft\VC\v160\Microsoft.Cpp.WindowsSDK.props (200,5)

... so it looks like 10.0.22000.0 is used. Also, if I go to project properties I can't see any of the the SDK versions that shows in "Programs and Features".

Would be interesting to know how this compares to the output and settings for you.

Thanks!
..
Tianyu Sun-MSFT 34,451 Reputation points Microsoft External Staff

2022-05-19T07:35:59.447+00:00

Hi Andreas, I can see that, on my side, when I build the project, the output log also shows 10.0.22000.0 in use. And on my machine, I have two versions of Windows SDK installed => 10.0.19041.685(installed before) and 10.0.22000.194. I also checked the property page, I can see 10.0 (latest installed version), 10.0.22000.0 and of course 10.0.19041.0.

If you switch to Alert or Errors/Warnings tab in Static Driver Verifier window, will you see any recorded detailed error message? I’m not very familiar with Windows Driver, but maybe you can try to use command in Developer Command Prompt for VS 2019 to activate Static Driver Verifier diagnostics. The command line is like msbuild /t:sdv /p:Inputs="/check:* /debug" xxxx.vcxproj /p:Configuration="Release" /p:Platform=x64.(Static Driver Verifier Diagnostics)

Regards,
Tianyu

1 answer

Your answer

Tianyu Sun-MSFT 34,451 Reputation points Microsoft External Staff

2022-05-06T06:55:10.347+00:00

Hi @Andreas Brykt , welcome to Microsoft Q&A forum.

Could you elaborate every steps that you did after you installed related components? I’d like to try to reproduce your issue on my side and check deeper. Besides, did you also install Visual C++ Redistributable Packages for VS?

Regards,
Tianyu
Andreas Brykt 1 Reputation point

2022-05-06T08:23:04.077+00:00

Yes, I have installed C++ Redistributable Packages for VS.

Steps to reproduce:
With all steps in https://learn.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk done:

Open VS 2019 (I am using Professional), select new project and pick "Kernel Mode Driver, USB (KMDF).

Make sure the project builds.

Goto "Extensions -> Driver -> Launch Static Driver Verifier"

With Static Driver Verifier UI open, go to third tab "Rules" and choose "Custom Rule Selection".

Click "Clear All" buttom, and then tick the "DriverCreate" rule.

Go to first tab and click "Clean" and then "Start". Wait for Static Driver Verifier to complete.

Expected behaviour:

The results listed for the "drivercreate" rule is successful.

Actual:
The result is listed as "error".

If you navigate to $(SolutionDir)/<ProjectName>/sdv/results, then you can find an xml file for each rule that Static Driver Verifier have tried to validate the driver against.

If you examine drivercreate_SDV.xml you can see that SDV_TOOLERROR is reported. To me this sounds like some framework or setup error, not a actual defect in the code.

Just let me know if I can provide any more information.
Andreas Brykt 1 Reputation point

2022-05-16T15:39:55.36+00:00

Hi @Tianyu Sun-MSFT .

Did you have a chance yet to try and reproduce this issue?

Thanks!

Kind regards, Andreas
Tianyu Sun-MSFT 34,451 Reputation points Microsoft External Staff

2022-05-17T09:14:47.523+00:00

Hi Andreas,

Sorry for delay in reply, and thanks for your kind reminder.

I was blocked while trying to reproduce your issue, until I noticed that I had some components not installed. So I followed the steps you shared, but I didn’t get errors. I am considering if some components are missing. May I ask if you have selected and installed MSVC v142 – VS 2019 C++ x64/x86 build tools (V14.xx) component and some other related components which mentioned in Step 1 in VS Installer?

Kind Regards,
Tianyu
Andreas Brykt 1 Reputation point

2022-05-18T10:46:56.317+00:00

No worries @Tianyu Sun-MSFT and thanks for your reply!

I have followed the steps and everything should be installed. One thing that I am suspicious about is the windows SDK version. I have two versions of 10.0.22000 installed. See screenshot:

If I enable verbose build output in VS and search in the output then I don't get any matches with "10.0.22000.1". However, I can see for example:

$(WindowsSDK_ExecutablePath_x64)="C:\Program Files (x86)\Windows Kits\10\bin\10.0.22000.0\x64;;C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools\x64" (previous value: "C:\Program Files (x86)\Windows Kits\10\bin\10.0.22000.0\x64;") at C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\MSBuild\Microsoft\VC\v160\Microsoft.Cpp.WindowsSDK.props (200,5)

... so it looks like 10.0.22000.0 is used. Also, if I go to project properties I can't see any of the the SDK versions that shows in "Programs and Features".

Would be interesting to know how this compares to the output and settings for you.

Thanks!
..
Tianyu Sun-MSFT 34,451 Reputation points Microsoft External Staff

2022-05-19T07:35:59.447+00:00

Hi Andreas, I can see that, on my side, when I build the project, the output log also shows 10.0.22000.0 in use. And on my machine, I have two versions of Windows SDK installed => 10.0.19041.685(installed before) and 10.0.22000.194. I also checked the property page, I can see 10.0 (latest installed version), 10.0.22000.0 and of course 10.0.19041.0.

If you switch to Alert or Errors/Warnings tab in Static Driver Verifier window, will you see any recorded detailed error message? I’m not very familiar with Windows Driver, but maybe you can try to use command in Developer Command Prompt for VS 2019 to activate Static Driver Verifier diagnostics. The command line is like msbuild /t:sdv /p:Inputs="/check:* /debug" xxxx.vcxproj /p:Configuration="Release" /p:Platform=x64.(Static Driver Verifier Diagnostics)

Regards,
Tianyu

Answer 1

Andreas Brykt 1

I've attached the output from running msbuild /t:sdv /p:Inputs="/check:* /debug" TestSdv.vcxproj /p:Configuration="Release" /p:Platform=x64 in 205105-output.txt

sdv/drivercreate_SDV.xml still says that the result is SDV_TOOLERROR.

   <?xml version="1.0"?>  
   <RuleResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">  
     <defect>false</defect>  
     <Name>drivercreate</Name>  
     <Result>SDV_TOOLERROR</Result>  
     <IsPreCondition>false</IsPreCondition>  
     <IsMustFix>true</IsMustFix>  
     <isWarning>false</isWarning>  
   </RuleResult>

I've searched the log in output.txt but I cannot find anything that points to the problem.

Can you find anything that can give us a clue?

Thanks!

/Regards

Andreas

Andreas Brykt 1 Reputation point

2022-05-31T14:50:22.663+00:00

Hi @Tianyu Sun-MSFT !

Did you have a chance to take a look at the log that I attached previously?

Thanks!

Best regards,

Andreas
Tianyu Sun-MSFT 34,451 Reputation points Microsoft External Staff

2022-06-02T09:24:19.263+00:00
Hi @Andreas Brykt , yes, I have checked the log file, I also didn’t find any clue in it. You may try following suggestions:

Repair Visual Studio 2019 from VS Installer and reset VS settings if possible.

Reinstall the related installed SDK(s) or repair them from Control Panel > Right-click them/it > Change > Repair.

Check if there are any extensions/applications installed which may affect SDV diagnostic, like antivirus software…

Regards,
Tianyu

Share via

Running Static Driver Verifier on KMDF USB template project

1 answer

Your answer