feat: add linker directive for VHF lib + move static linker directives from wdk-build to wdk-sys by Alan632 · Pull Request #685 · microsoft/windows-drivers-rs

Alan632 · 2026-06-18T18:48:20Z

Summary

Adds conditionally compiled linker directives for the VHF library tied to the "hid" feature.

Moves build script emitted static linker directives (cargo::rustc-link-lib=static=*) from wdk-build/src/lib.rs into bindgen generated files as conditionally compiled attributes. The Rust source insertion happens in wdk-sys/build.rs while the backend logic and Rust source string build lives in wdk-build/src/lib.rs (closely following the pattern the bindgen generated headers use). This allows conditional compilation of linker directives (and eventually link args) without having to rely on cross crate feature signaling, and guards against issues from version drift (in case multiple versions of wdk-build are used in one project).

This PR is a redesign of and supersedes PR!653.

Verification

Verified both kmdf and umdf drivers built with "hid" and Vhf functions linked against VhfKm.lib and VhfUm.lib respectively. Additionally, inspected each driver's linker .map file for evidence of the respective Vhf symbols.

Bindgen generated files are also inspected post build for the presence of the link attributes.

… directives from wdk-build/src/lib.rs into wdk-sys/build.rs

Copilot

Pull request overview

This PR updates how native WDK libraries are linked by moving static rustc-link-lib directives out of wdk-build’s configure_binary_build prints and into wdk-sys’s generated bindings via #[link(...)] attributes. It also adds conditional linker directives for the VHF library when the hid feature is enabled, selecting VhfKm vs VhfUm based on driver model.

Changes:

Emit base driver-model-specific native library link directives into bindgen output (ntddk.rs/windows.rs) from wdk-sys/build.rs.
Add hid-gated #[link] directives for VhfKm (KMDF/WDM) and VhfUm (UMDF).
Remove the corresponding cargo::rustc-link-lib=static=* emissions from wdk-build::Config::configure_binary_build (leaving link-arg prints in place).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
crates/wdk-sys/build.rs	Adds a reusable `#[link]` directive helper and injects conditional link directives into generated bindings (including VHF for `hid`).
crates/wdk-build/src/lib.rs	Stops emitting static `rustc-link-lib` lines (now handled by `wdk-sys`), retaining `cdylib` link-args and documenting future move.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

codecov-commenter · 2026-06-18T19:21:05Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.61%. Comparing base (a96fd81) to head (ac529c7).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #685      +/-   ##
==========================================
+ Coverage   79.93%   80.61%   +0.67%     
==========================================
  Files          26       26              
  Lines        5633     5829     +196     
  Branches     5633     5829     +196     
==========================================
+ Hits         4503     4699     +196     
  Misses       1002     1002              
  Partials      128      128

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ts by utilizing ApiSubset similar to the headers

…indows-drivers-rs into vhf_lib_linker_args-v2

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

…utes out when building non-driver test wdk-sys-tests (wdk-sys-tests does not call configure_binary_build thus no search paths are emitted and ungated link attributes fail the build/test)

…on, library selection, and link directive string creation) -removed raw strings in lieu of types to tightly constrain LinkDirective creation w/o needing assert checks -removed and compacted unneeded functions from original implementation

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

… attributes to ensure wdk-sys builds correctly when compiled for test - add unit tests - add PartialEq and Eq traits to LinkKind, LinkModifier, and LinkDirective

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

leon-xd

Great work. Few changes here and there but the overall shape is very solid!

…indows-drivers-rs into vhf_lib_linker_args-v2

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

+        }
+
+        #[test]
+        fn render_static_directive_includes_no_bundle_modifier() {


+        }
+
+        #[test]
+        fn base_directives_are_all_static_no_bundle() {


Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

- add doctest to wdk-sys-tests - add cdylib driver unit test to mixed-package-kmdf-workspace, and update Cargo.toml

…indows-drivers-rs into vhf_lib_linker_args-v2

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

+//! Like the driver unit test in `tests/mixed-package-kmdf-workspace`, it
+//! references a bindgen generated WDM type (`DRIVER_OBJECT`) via a const
+//! `size_of` — so the doctest actually links `wdk-sys`'s generated bindings
+//!  while touching only a type (never a KM function


leon-xd · 2026-07-07T05:57:48Z

-    /// [`ApiSubset`] rather than a set like
-    /// [`Config::bindgen_header_contents`].
+    /// Each generated bindings file requests only the native libraries
+    /// introduced by its own [`ApiSubset`]. This avoids duplicate `#[link]`


nit: i think we can delete this entire paragraph, the first sentence is pretty much saying the same thing as the paragraph above and not sure how necessary the second sentence is but i'm fine to keep it if you feel it's necessary

I can see how it's redundant, removed that paragraph.

leon-xd

good changes

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (3)

crates/wdk-build/src/lib.rs:2253

The test name render_static_directive_includes_no_bundle_modifier is misleading: the assertion expects the rendered attribute to include modifiers = "-bundle" (i.e., the -bundle modifier is present to disable bundling). Renaming the test to reflect what it actually checks will make failures easier to interpret.

        fn render_static_directive_includes_no_bundle_modifier() {

tests/mixed-package-kmdf-workspace/crates/driver/src/lib.rs:10

Minor doc-comment grammar/whitespace: the blank doc line has trailing whitespace, and the sentence reads better with a comma after cargo test.

//! 
//! Running `cargo test` the crate is built as a std test harness with
//! `wdk-sys`'s `test-stubs` feature enabled (see dev-dependencies): that

tests/wdk-sys-tests/src/lib.rs:18

There’s an extra leading space in the doc comment (//! while ...) and a small hyphenation nit (“bindgen generated” → “bindgen-generated”). Cleaning this up avoids odd rendering in rustdoc.

//! references a bindgen generated WDM type (`DRIVER_OBJECT`) via a const
//! `size_of` — so the doctest actually links `wdk-sys`'s generated bindings
//!  while touching only a type (never a KM function
//! binding that `test-stubs` leaves unlinked).

- fix: a doc comment - formatting

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

wmmc88 · 2026-07-20T21:58:17Z

+    /// Each emitted directive is gated behind
+    /// `#[cfg(not(any(test, feature = "test-stubs")))]`, evaluated in the crate
+    /// that compiles the generated bindings (`wdk-sys`). The directives are
+    /// therefore suppressed when `wdk-sys` is built with its `test-stubs`
+    /// feature, or when `wdk-sys` is itself compiled as a test target (e.g.
+    /// `cargo test -p wdk-sys`).


Please audit all your comments. This is an implementation detail and only one possible use of this function

vhf library linker directive redesign, pull out static library linker…

88d3948

… directives from wdk-build/src/lib.rs into wdk-sys/build.rs

Copilot AI review requested due to automatic review settings June 18, 2026 18:48

Alan632 self-assigned this Jun 18, 2026

Copilot started reviewing on behalf of Alan632 June 18, 2026 18:49 View session

Merge branch 'main' into vhf_lib_linker_args-v2

ed27cc2

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread crates/wdk-sys/build.rs Outdated

Comment thread crates/wdk-build/src/lib.rs

Comment thread crates/wdk-sys/build.rs Outdated

Alan Ngo added 2 commits June 18, 2026 15:58

moved mechanism and data logic into wdk-build, wdk-sys now only selec…

0cce966

…ts by utilizing ApiSubset similar to the headers

Merge branch 'vhf_lib_linker_args-v2' of https://github.com/Alan632/w…

e8756f1

…indows-drivers-rs into vhf_lib_linker_args-v2

Copilot AI review requested due to automatic review settings June 18, 2026 23:04

Copilot started reviewing on behalf of Alan632 June 18, 2026 23:04 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread crates/wdk-build/src/lib.rs Outdated

Comment thread crates/wdk-build/src/lib.rs

Comment thread crates/wdk-build/src/lib.rs

wmmc88 requested changes Jun 18, 2026

View reviewed changes

Alan Ngo added 2 commits June 19, 2026 11:29

utilize the test-stubs feature in wdk-sys to gate the new link attrib…

a3b51b8

…utes out when building non-driver test wdk-sys-tests (wdk-sys-tests does not call configure_binary_build thus no search paths are emitted and ungated link attributes fail the build/test)

Copilot AI review requested due to automatic review settings June 19, 2026 23:42

Copilot started reviewing on behalf of Alan632 June 19, 2026 23:42 View session

Copilot AI reviewed Jun 19, 2026

View reviewed changes

- add a cfg() conditional compilation guard on not(test)) to the link…

f8f26b7

… attributes to ensure wdk-sys builds correctly when compiled for test - add unit tests - add PartialEq and Eq traits to LinkKind, LinkModifier, and LinkDirective

wmmc88 mentioned this pull request Jun 22, 2026

Running tests on cdylib driver crates cause failure in Github Actions Runner #502

Open

Alan632 marked this pull request as ready for review June 23, 2026 00:45

Copilot AI review requested due to automatic review settings June 23, 2026 00:45

Copilot started reviewing on behalf of Alan632 June 23, 2026 00:46 View session

Copilot AI reviewed Jun 23, 2026

View reviewed changes

leon-xd requested changes Jun 29, 2026

View reviewed changes

Alan632 and others added 3 commits June 30, 2026 11:49

Merge branch 'main' into vhf_lib_linker_args-v2

20cced8

Addressing PR comments

f0d20e6

Merge branch 'vhf_lib_linker_args-v2' of https://github.com/Alan632/w…

f179fb7

…indows-drivers-rs into vhf_lib_linker_args-v2

Copilot AI review requested due to automatic review settings July 2, 2026 16:45

Copilot started reviewing on behalf of Alan632 July 2, 2026 16:46 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Comment thread crates/wdk-build/src/lib.rs Outdated

}

#[test]

fn render_static_directive_includes_no_bundle_modifier() {

Comment thread crates/wdk-build/src/lib.rs Outdated

}

#[test]

fn base_directives_are_all_static_no_bundle() {

Alan Ngo and others added 2 commits July 2, 2026 09:50

formatting

9e6f1c8

Merge branch 'main' into vhf_lib_linker_args-v2

2967d71

Copilot AI review requested due to automatic review settings July 2, 2026 16:51

Copilot started reviewing on behalf of Alan632 July 2, 2026 16:51 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Alan Ngo added 3 commits July 6, 2026 12:41

- add new line after unsafe block in link directive return string

8348a3f

- add doctest to wdk-sys-tests - add cdylib driver unit test to mixed-package-kmdf-workspace, and update Cargo.toml

Merge branch 'vhf_lib_linker_args-v2' of https://github.com/Alan632/w…

11453ac

…indows-drivers-rs into vhf_lib_linker_args-v2

forgot to update unit tests with change to render function

082282c

Copilot AI review requested due to automatic review settings July 6, 2026 21:01

toml formatting

0b5deed

Copilot started reviewing on behalf of Alan632 July 6, 2026 21:13 View session

Copilot AI reviewed Jul 6, 2026

View reviewed changes

leon-xd reviewed Jul 7, 2026

View reviewed changes

Merge branch 'main' into vhf_lib_linker_args-v2

d828928

Copilot AI review requested due to automatic review settings July 20, 2026 16:39

Copilot started reviewing on behalf of Alan632 July 20, 2026 16:40 View session

Copilot AI reviewed Jul 20, 2026

View reviewed changes

- fix: naming of a couple tests for clarity

ac529c7

- fix: a doc comment - formatting

Copilot AI review requested due to automatic review settings July 20, 2026 18:50

Copilot started reviewing on behalf of Alan632 July 20, 2026 18:51 View session

Copilot AI reviewed Jul 20, 2026

View reviewed changes

wmmc88 reviewed Jul 20, 2026

View reviewed changes

Uh oh!

Conversation

Alan632 commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Verification

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

leon-xd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leon-xd Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

Alan632 Jul 20, 2026

Choose a reason for hiding this comment

Uh oh!

leon-xd left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Alan632 commented Jun 18, 2026 •

edited

Loading

codecov-commenter commented Jun 18, 2026 •

edited

Loading