feat: embed version and package metadata in binary by CHMANG · Pull Request #243 · microsoft/windows-drivers-rs

CHMANG · 2024-11-13T01:54:26Z

Includes automation capability to generate Resource files for both WDM and WDF driver development models by using cargo metadata.
Compile the Resource file using Resource compiler and link the compiled resource file into the application driver executable using the linker.

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

microsoft-github-policy-service · 2024-11-13T02:04:39Z

@CHMANG please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

wmmc88 · 2024-11-19T18:55:53Z

+serde = "1.0"
+serde_json = "1.0"


These should be workspace dependencies

wmmc88 · 2024-11-19T19:20:35Z

+    pub fn get_rc_root_path(&self) -> Result<String, ConfigError> {
+        let bin_directory = self.wdk_content_root.join("bin");
+
+        // Add Windows SDK library paths based on logic from WindowsDriver.KernelMode.props &


This comment is copy-pasted. please clean up so that it makes sense

wmmc88 · 2024-11-19T19:29:20Z

+    ///
+    /// This function will return an error if any of the required paths do not
+    /// exist.
+    pub fn get_rc_root_path(&self) -> Result<String, ConfigError> {


This looks like the same logic as in: https://github.com/CHMANG/windows-drivers-rs/blob/37f74cae7207571347706806121088917f5040ba/crates/wdk-build/src/cargo_make.rs#L516-L517

Can this logic be commonized to a single place in utils as a free function that takes in a wdk content root path? that way it can be called in both setup_path and in this function.

also can this Config method be named get_bin_path since all the arch-specific bins are here.

wmmc88 · 2024-11-19T20:02:37Z

+        let km_include_path = windows_sdk_include_path.join("km");
+        if !km_include_path.is_dir() {
            return Err(ConfigError::DirectoryNotFound {
-                directory: crt_include_path.to_string_lossy().into(),
+                directory: km_include_path.to_string_lossy().into(),
            });
        }
        include_paths.push(
-            crt_include_path
+            km_include_path
                .canonicalize()?
                .strip_extended_length_path_prefix()?,
        );

-        let km_or_um_include_path = windows_sdk_include_path.join(match self.driver_config {
-            DriverConfig::Wdm | DriverConfig::Kmdf(_) => "km",
-            DriverConfig::Umdf(_) => "um",
-        });
-        if !km_or_um_include_path.is_dir() {
+        let kit_shared_include_path = windows_sdk_include_path.join("shared");
+        if !kit_shared_include_path.is_dir() {
            return Err(ConfigError::DirectoryNotFound {
-                directory: km_or_um_include_path.to_string_lossy().into(),
+                directory: kit_shared_include_path.to_string_lossy().into(),
            });
        }
        include_paths.push(
-            km_or_um_include_path
+            kit_shared_include_path
                .canonicalize()?
                .strip_extended_length_path_prefix()?,
        );
-
-        let kit_shared_include_path = windows_sdk_include_path.join("shared");
-        if !kit_shared_include_path.is_dir() {
+        
+        let um_include_path = windows_sdk_include_path.join("um");
+        if !um_include_path.is_dir() {
            return Err(ConfigError::DirectoryNotFound {
-                directory: kit_shared_include_path.to_string_lossy().into(),
+                directory: um_include_path.to_string_lossy().into(),
            });
        }
        include_paths.push(
-            kit_shared_include_path
+            um_include_path
                .canonicalize()?
                .strip_extended_length_path_prefix()?,
        );
-
+    


Why are you changing the include path logic? This changes how all the bindings are generated and break it.

The logic here strictly matches what happens in the vcxproj files of the WDK. If RC compilation requires different includes, it should be handled elsewhere

wmmc88 · 2024-11-19T20:03:13Z

+    );
+}
+// function to get and set RC File with package metadata
+fn getandset_rcfile(


please follow rust conventions for function names

wmmc88 · 2024-11-19T20:13:31Z

+    let mut productversion = String::new();
+    let mut name = String::new();
+
+    match fs::read_to_string("Cargo.toml") {


This is very hacky to get the crate version. You should use the env vars that cargo provides you: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates

wmmc88 · 2024-11-19T20:15:22Z

+        original_filename = ver_originalfilename
+    );
+
+    std::fs::write("resources.rc", rc_content).expect("Unable to write RC file");


error handling is needed in this module rather than panicking

wmmc88 · 2024-11-19T20:16:24Z

+fn get_packagemetadatadetails() -> (String, String, String) {
+    // Run the 'cargo metadata' command and capture its output
+    let path = env::var("CARGO_MANIFEST_DIR").unwrap();
+    let meta = MetadataCommand::new()


Rather than do additional parsing here, do you think it would be better to bake this into the WDK config struct @ayodejiige ?

wmmc88 · 2024-11-19T20:17:30Z

+    // Create the RC file content
+    let rc_content = format!(
+        r#"#include <windows.h>
+#include <ntverp.h>


Is there an MSDN doc that this template is pulled from? Are these all required? optional?

wmmc88 · 2024-11-19T20:20:26Z

+    path::{Path, PathBuf},
+    process::Command,
+};
+use cargo_metadata::MetadataCommand;


I think this file should probably be restructured such that it is some ResourceCompile builder, rather than a set of free functions. I think the process of compiling the rc file should be separated from the process of writing the rc file from a template to filesystem. This way, we could reuse it for different rc files, if needed

Copilot

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

Comments skipped due to low confidence (1)

crates/wdk-build/src/resource_compile.rs:10

The new behavior introduced in the generate_and_compile_rc_file function and related functions should be covered by tests to ensure reliability.

pub fn generate_and_compile_rc_file(include_paths: Vec<PathBuf>, rc_exe_root_path: String) {

CHMANG added 13 commits October 23, 2024 17:01

Create resource_compiler.rs

ea1d68d

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update lib.rs

8998bfe

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update Cargo.toml

00ed121

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update Cargo.toml

bddc2c5

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update lib.rs

f1b8451

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Create resource_compile.rs

651df25

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Delete crates/wdk-build/src/resource_compiler.rs

60b1f76

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update resource_compile.rs

13f371c

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update lib.rs

afcab56

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update lib.rs

7041a32

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update resource_compile.rs

3a75411

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update resource_compile.rs

ce35c0a

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Merge branch 'main' into CHMANG-patch-1

2c0cd67

wmmc88 changed the title ~~Rust Versioning and package metadata integration~~ feat: embed version and package metadata in binary Nov 13, 2024

CHMANG added 3 commits November 12, 2024 18:10

format fixes

5268075

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update lib.rs

49ef8ec

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

Update resource_compile.rs

37f74ca

Signed-off-by: CHMANG <CHMANG@MICROSOFT.COM>

wmmc88 self-requested a review November 19, 2024 18:57

wmmc88 requested changes Nov 19, 2024

View reviewed changes

CHMANG added 2 commits November 23, 2024 17:16

updating to rust conventions

b36fba8

updating calling function name

edcd7c0

wmmc88 requested a review from Copilot December 5, 2024 00:03

Copilot AI reviewed Dec 5, 2024

View reviewed changes

Alan632 mentioned this pull request Jun 23, 2026

feat: add PE resource version + metadata generation #661

Open

		serde = "1.0"
		serde_json = "1.0"

Uh oh!

Conversation

CHMANG commented Nov 13, 2024

Uh oh!

microsoft-github-policy-service Bot commented Nov 13, 2024

Contribution License Agreement

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants