gmh5225 / wdkmetadata

Tooling to generate metadata for Win32 APIs in the Windows Driver Kit (WDK).

Overview

This repository produces metadata for the Windows Driver Kit (WDK) using the tooling provided by the win32metadata project. The metadata is published to NuGet.org as the Microsoft.Windows.WDK.Win32Metadata NuGet package. This mirrors the Microsoft.Windows.SDK.Win32Metadata package that it depends on.

DISCLAIMER: wdkmetadata is EXPERIMENTAL and intended to provide a place for the community to build out rich metadata for the WDK to enable driver development in language projections like the windows crate for Rust.

Principles

• This repository is sponsored by Microsoft but will primarily be driven by outside collaborators and community contributions
• This repository will use public tooling provided by Microsoft.Windows.WinmdGenerator wherever possible
• This repository will aim to mirror win32metadata in layout and development experience to provide a consistent contributor experience across the WDK and the SDK
• This repository will provide foundational metadata for native APIs that ship in the WDK and will not provide abstractions
• This repository does not change the license of the original WDK and SDK headers used to generate the metadata. Any such artifacts checked into this repository support metadata production only and do not imply a change of their original licenses.

Repository Bootstrap

• [DONE] Clone the win32metadata repo
• [DONE] Remove win32metadata baggage (samples, scripts, sources, tests, etc.) and onboard to Microsoft.Windows.WinmdGenerator
• [DONE] Rename generation/SDK to generation/WDK and rename Windows.Win32.winmd to Windows.Wdk.winmd
• [DONE] Import WDK headers
  • NOTE: This repository needs both SDK headers and WDK headers since the WDK headers depend on the SDK headers to compile. Original SDK and WDK headers for Windows 11 Build 22000 were checked into IdlHeaders and then recompiled to RecompiledIdlHeaders using an adapted version of RecompileIdlFilesForScraping. Only WDK headers should be added to partitions in this repository.
• [DONE] Create example API partition (https://github.com/microsoft/win32metadata/issues/509)
• [DONE] Produce Microsoft.Windows.WDK.Win32Metadata NuGet package for Windows.Wdk.winmd
• [DONE] Port over full/incremental build support from win32metadata
• [DONE] Port over baseline diffing support from win32metadata
• [DONE] Port over CI and release pipelines from win32metadata
• [DONE] Port over header ingestion script from win32metadata and include WDK headers
• [DONE] Port over automatic import library detection to minimize changes to libMappings.rsp
  • NOTE: When adding new headers or troubleshooting why APIs may not be emitted in the winmd, make sure that libMappings.rsp has entries for the APIs with a valid import library that includes the proper extension (e.g. dll, drv, exe, etc.).
• Onboard outside collaborators and community contributors