feat: enable CI workflows to use NuGet WDK packages #236
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| nuget restore .\packages.config -PackagesDirectory C:\WDK | ||
| Write-Host "WDK installed at C:\WDK" | ||
| $folders = @( | ||
| "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591", | ||
| "C:\WDK\Microsoft.Windows.SDK.CPP.x64.10.0.26100.1591", | ||
| "C:\WDK\Microsoft.Windows.SDK.CPP.arm64.10.0.26100.1591", | ||
| "C:\WDK\Microsoft.Windows.WDK.ARM64.10.0.26100.1591", | ||
| "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591" | ||
| ) | ||
| foreach ($folder in $folders) { | ||
| if (-Not (Test-Path $folder)) { | ||
| Write-Error "Required folder $folder is missing." | ||
| exit 1 | ||
| } | ||
| } | ||
| function Copy-File { | ||
| param ( | ||
| [string]$sourcePath, | ||
| [string]$destinationPath, | ||
| [string]$fileName | ||
| ) | ||
|
|
||
| if (Test-Path $sourcePath) { | ||
| Copy-Item -Path $sourcePath -Destination $destinationPath -Force | ||
| Write-Host "Copied $fileName to $destinationPath" | ||
| } else { | ||
| Write-Error "$fileName not found at $sourcePath" | ||
| } | ||
| } | ||
|
|
||
| # Copying signtool to WDK bin folder | ||
| $signtoolx64 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\x64\signtool.exe" | ||
| $signtoolX86 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\x86\signtool.exe" | ||
| $destinationx64 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\x64" | ||
| $destinationX86 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\x86" | ||
|
|
||
| Copy-File -sourcePath $signtoolX64 -destinationPath $destinationX64 -fileName "signtool.exe" | ||
| Copy-File -sourcePath $signtoolX86 -destinationPath $destinationX86 -fileName "signtool.exe" | ||
|
|
||
| # Copying certmgr to WDK bin folder | ||
| $certmgrx86 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\x86\certmgr.exe" | ||
| $certmgrX64 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\x64\certmgr.exe" | ||
| $certmgrARM64 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\arm64\certmgr.exe" | ||
| $destinationx86 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\x86" | ||
| $destinationx64 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\x64" | ||
| $destinationARM64 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\ARM64" | ||
|
|
||
| Copy-File -sourcePath $certmgrx86 -destinationPath $destinationx86 -fileName "certmgr.exe" | ||
| Copy-File -sourcePath $certmgrX64 -destinationPath $destinationx64 -fileName "certmgr.exe" | ||
| Copy-File -sourcePath $certmgrARM64 -destinationPath $destinationARM64 -fileName "certmgr.exe" | ||
|
|
||
| # Copying makecert to WDK bin folder | ||
| $makecertx86 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\x86\MakeCert.exe" | ||
| $makecertX64 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\x64\MakeCert.exe" | ||
| $makecertARM64 = "C:\WDK\Microsoft.Windows.SDK.CPP.10.0.26100.1591\c\bin\10.0.26100.0\arm64\MakeCert.exe" | ||
| $destinationx86 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\x86" | ||
| $destinationx64 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\x64" | ||
| $destinationARM64 = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\bin\10.0.26100.0\ARM64" | ||
|
|
||
| Copy-File -sourcePath $makecertx86 -destinationPath $destinationx86 -fileName "MakeCert.exe" | ||
| Copy-File -sourcePath $makecertX64 -destinationPath $destinationx64 -fileName "MakeCert.exe" | ||
| Copy-File -sourcePath $makecertARM64 -destinationPath $destinationARM64 -fileName "MakeCert.exe" | ||
|
|
||
| function Copy-Folder { | ||
| param ( | ||
| [string]$sourceFolder, | ||
| [string]$destinationFolder | ||
| ) | ||
|
|
||
| if (Test-Path $sourceFolder) { | ||
| Copy-Item -Path $sourceFolder -Destination $destinationFolder -Recurse -Force | ||
| Write-Host "Copied $sourceFolder to $destinationFolder" | ||
| } else { | ||
| Write-Error "Source folder $sourceFolder not found" | ||
| } | ||
| } | ||
|
|
||
| # Copying km, um, kmdf, umdf ARM64 headers to x64 folders | ||
| Copy-Folder -sourceFolder "C:\WDK\Microsoft.Windows.WDK.ARM64.10.0.26100.1591\c\Lib\10.0.26100.0\km\arm64" -destinationFolder "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\Lib\10.0.26100.0\km" | ||
| Copy-Folder -sourceFolder "C:\WDK\Microsoft.Windows.WDK.ARM64.10.0.26100.1591\c\Lib\10.0.26100.0\um\arm64" -destinationFolder "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\Lib\10.0.26100.0\um" | ||
| Copy-Folder -sourceFolder "C:\WDK\Microsoft.Windows.WDK.ARM64.10.0.26100.1591\c\Lib\wdf\kmdf\ARM64" -destinationFolder "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\Lib\wdf\kmdf" | ||
| Copy-Folder -sourceFolder "C:\WDK\Microsoft.Windows.WDK.ARM64.10.0.26100.1591\c\Lib\wdf\umdf\ARM64" -destinationFolder "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c\Lib\wdf\umdf" | ||
|
|
||
| # Set NugetWdkContentRoot environment variable | ||
| $NugetWdkContentRoot = "C:\WDK\Microsoft.Windows.WDK.x64.10.0.26100.1591\c" | ||
| Write-Output "NugetWdkContentRoot=$NugetWdkContentRoot" >> $env:GITHUB_ENV | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,6 +20,7 @@ jobs: | |
| matrix: | ||
| wdk: | ||
|
There was a problem hiding this comment. Rather than special casing the NI WDK, I think you should explicityly add another matrix dimension for WDK source. Then you can exclude the WDK versions from nuget that aren't available via the exclude feature. It would look something like: matrix:
wdk_source: [nuget, winget]
wdk_version:
- 10.0.22621 # NI WDK
- 10.0.26100 #GE WDK
exclude:
# 10.0.22621 not available on nuget
- wdk_source: nuget
wdk_version: 10.0.22621This way, your later steps can switch on |
||
| - Microsoft.WindowsWDK.10.0.22621 # NI WDK | ||
| - Microsoft.Windows.WDK # Latest WDK | ||
|
There was a problem hiding this comment. Even with nuget, we want to be able to test specific versions of the kit |
||
|
|
||
| llvm: | ||
| - 17.0.6 | ||
|
|
@@ -57,6 +58,7 @@ jobs: | |
| clang --version | ||
|
|
||
| - name: Install WDK (${{ matrix.wdk }}) | ||
| if: matrix.wdk == 'Microsoft.WindowsWDK.10.0.22621' | ||
| run: | | ||
| if ((Get-WinGetPackage -Id ${{ matrix.wdk }} -Source winget -MatchOption Equals).Id -eq '${{ matrix.wdk }}') { | ||
| Write-Host "${{ matrix.wdk }} is already installed. Attempting to update..." | ||
|
|
@@ -65,6 +67,11 @@ jobs: | |
| Write-Host "Installing ${{ matrix.wdk }}..." | ||
| Install-WinGetPackage -Id ${{ matrix.wdk }} -Source winget -MatchOption Equals -Mode Silent -Force | ||
| } | ||
|
|
||
| - name: Install ${{ matrix.wdk }} (NuGet) | ||
| if: matrix.wdk == 'Microsoft.Windows.WDK' | ||
| run: | | ||
| ./.github/scripts/nuget-install-wdk.ps1 | ||
|
|
||
| - name: Install Rust Toolchain (${{ matrix.rust_toolchain }}) | ||
| uses: dtolnay/rust-toolchain@master | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -98,6 +98,19 @@ pub fn detect_wdk_content_root() -> Option<PathBuf> { | |
| ); | ||
| } | ||
|
|
||
| // If NugetWdkContentRoot is present in environment, use it | ||
| if let Ok(wdk_content_root) = env::var("NugetWdkContentRoot") { | ||
|
There was a problem hiding this comment. I don't think we should be doing custom handling here for nuget since There was a problem hiding this comment. I understand. The C samples use the Build-SampleSet.ps1 script. Adding the There was a problem hiding this comment. I very much do not want to add new scaffolding to windows-drivers-rs when existing mechanisms exist. In order to make sure this doesn't diverge from the original kit, I think you need to find out how C/C++ WDK handles pointing to the WDKContentRoot when using the new nuget install methods. For eWDK, we check for the env vars that eWDK prompts set. For installed WDK, we look for the reg keys that the WDK installer sets. For nuget, we should use whatever mechanism DDX has for nuget for root discovery. @NateD-MSFT do you have insight/contacts for this? There was a problem hiding this comment. I'll spin up a thread with the WDK team to ask. |
||
| let path = Path::new(wdk_content_root.as_str()); | ||
| if path.is_dir() { | ||
| return Some(path.to_path_buf()); | ||
| } | ||
| eprintln!( | ||
| "NugetWdkContentRoot was detected to be {}, but does not exist or is not a valid \ | ||
| directory.", | ||
| path.display() | ||
| ); | ||
| } | ||
|
|
||
| // If MicrosoftKitRoot environment variable is set, use it to set WDKContentRoot | ||
| if let Ok(microsoft_kit_root) = env::var("MicrosoftKitRoot") { | ||
| let path = Path::new(microsoft_kit_root.as_str()); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <packages> | ||
| <package id="Microsoft.Windows.SDK.CPP" version="10.0.26100.1591" targetFramework="native" /> | ||
| <package id="Microsoft.Windows.SDK.CPP.x64" version="10.0.26100.1591" targetFramework="native" /> | ||
| <package id="Microsoft.Windows.SDK.CPP.arm64" version="10.0.26100.1591" targetFramework="native" /> | ||
| <package id="Microsoft.Windows.WDK.x64" version="10.0.26100.1591" targetFramework="native" /> | ||
| <package id="Microsoft.Windows.WDK.arm64" version="10.0.26100.1591" targetFramework="native" /> | ||
| </packages> | ||
|
There was a problem hiding this comment. nit: newline at end of file is missing |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,20 +19,7 @@ use wdk::println; | |
| #[cfg(not(test))] | ||
| use wdk_alloc::WdkAllocator; | ||
| use wdk_sys::{ | ||
| call_unsafe_wdf_function_binding, ntddk::DbgPrint, DRIVER_OBJECT, NTSTATUS, PCUNICODE_STRING, PDRIVER_OBJECT, ULONG, UNICODE_STRING, WCHAR, WDFDEVICE, WDFDEVICE_INIT, WDFDRIVER, WDF_DRIVER_CONFIG, WDF_NO_HANDLE, WDF_NO_OBJECT_ATTRIBUTES | ||
|
There was a problem hiding this comment. Not a blocker, but I am curious how this reformat wasn't caught sooner by CI/other pipeline checkins. There was a problem hiding this comment. I think this change actually needs to be reverted? I suspect that whats going on is that:
There are some gaps in the top-level examples and tests folders where certain pipelines are not fully covering them. spent some time figuring out what gaps there are (mostly due to changes related to #186 ) and will be adding the rundown to github in a pr |
||
| }; | ||
|
|
||
| #[cfg(not(test))] | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is there all this manual copying of folders after the nuget packages are restored? this seems very brittle
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
setup_pathfunction sets thebinandtoolsroot W.R.T standard WDK's directory structure. However, with NuGet I noticed that some bins and headers were placed in a different path. So, this script moves them under the root thatsetup_pathis using.windows-drivers-rs/crates/wdk-build/src/cargo_make.rs
Line 515 in 10a8e37
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this function actually uses
detect_wdk_content_root, so as long as that's detecting nuget properly, then we're all set.see #236 (comment) for more details, but the tl;dr is that the nuget WDK's use in c drivers works by setting the include and bin paths via modifying the vcxproj. as stated in my linked comment, since there is no path forward to use the same solution that nuget uses in c drivers (ie. vcxproj is not supported by our rust tooling), we should rely on the env vars used by ewdk