fix!: remove linker map file from driver packages

.github/workflows/build.yaml

@@ -14,8 +14,6 @@ concurrency:
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
 env:
-  # TODO: Remove when cargo-wdk supports Cargo build-dir layout v2 (see https://github.com/microsoft/windows-drivers-rs/issues/709).
-  CARGO_UNSTABLE_BUILD_DIR_NEW_LAYOUT: 'false'
   RUSTFLAGS: >-
     -D warnings
     -C target-feature=+crt-static

.github/workflows/test.yaml

@@ -13,11 +13,6 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.event.compare || github.head_ref || github.ref }}
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
-env:
-  # TODO: Remove when cargo-wdk supports Cargo build-dir layout v2 (see https://github.com/microsoft/windows-drivers-rs/issues/709).
-  # The whitelist in function `sanitize_env_vars` in crates/cargo-wdk/tests/test_utils/mod.rs should also be removed once this env var is removed.
-  CARGO_UNSTABLE_BUILD_DIR_NEW_LAYOUT: 'false'
-
 jobs:
   test:
     name: Test

crates/cargo-wdk/src/actions/build/package_task.rs

@@ -102,15 +102,13 @@ pub struct PackageTask<'a> {
     src_driver_binary_file_path: PathBuf,
     src_renamed_driver_binary_file_path: PathBuf,
     src_pdb_file_path: PathBuf,
-    src_map_file_path: PathBuf,
     src_cert_file_path: PathBuf,
 
     // destination paths
     dest_root_package_folder: PathBuf,
     dest_inf_file_path: PathBuf,
     dest_driver_binary_path: PathBuf,
     dest_pdb_file_path: PathBuf,
-    dest_map_file_path: PathBuf,
     dest_cert_file_path: PathBuf,
     dest_cat_file_path: PathBuf,
 
@@ -172,10 +170,6 @@ impl<'a> PackageTask<'a> {
             .target_dir
             .join(format!("{package_name}.{src_driver_binary_extension}"));
         let src_pdb_file_path = params.target_dir.join(format!("{package_name}.pdb"));
-        let src_map_file_path = params
-            .target_dir
-            .join("deps")
-            .join(format!("{package_name}.map"));
         let src_cert_file_path = params.target_dir.join(format!("{WDR_LOCAL_TEST_CERT}.cer"));
 
         // destination paths
@@ -193,7 +187,6 @@ impl<'a> PackageTask<'a> {
         let dest_driver_binary_path =
             dest_root_package_folder.join(format!("{package_name}.{dest_driver_binary_extension}"));
         let dest_pdb_file_path = dest_root_package_folder.join(format!("{package_name}.pdb"));
-        let dest_map_file_path = dest_root_package_folder.join(format!("{package_name}.map"));
         let dest_cert_file_path =
             dest_root_package_folder.join(format!("{WDR_LOCAL_TEST_CERT}.cer"));
         let dest_cat_file_path = dest_root_package_folder.join(format!("{package_name}.cat"));
@@ -212,13 +205,11 @@ impl<'a> PackageTask<'a> {
             src_driver_binary_file_path,
             src_renamed_driver_binary_file_path,
             src_pdb_file_path,
-            src_map_file_path,
             src_cert_file_path,
             dest_root_package_folder,
             dest_inf_file_path,
             dest_driver_binary_path,
             dest_pdb_file_path,
-            dest_map_file_path,
             dest_cert_file_path,
             dest_cat_file_path,
             arch: params.target_arch,
@@ -281,7 +272,6 @@ impl<'a> PackageTask<'a> {
         )?;
         self.copy(&self.src_pdb_file_path, &self.dest_pdb_file_path)?;
         self.copy(&self.src_inx_file_path, &self.dest_inf_file_path)?;
-        self.copy(&self.src_map_file_path, &self.dest_map_file_path)?;
         self.run_stampinf()?;
         self.run_inf2cat()?;
         self.run_infverif()?;
@@ -764,10 +754,6 @@ mod tests {
             target_dir.join("test_package.sys")
         );
         assert_eq!(task.src_pdb_file_path, target_dir.join("test_package.pdb"));
-        assert_eq!(
-            task.src_map_file_path,
-            target_dir.join("deps").join("test_package.map")
-        );
         assert_eq!(
             task.src_cert_file_path,
             target_dir.join("WDRLocalTestCert.cer")
@@ -779,7 +765,6 @@ mod tests {
             dest_root.join("test_package.sys")
         );
         assert_eq!(task.dest_pdb_file_path, dest_root.join("test_package.pdb"));
-        assert_eq!(task.dest_map_file_path, dest_root.join("test_package.map"));
         assert_eq!(
             task.dest_cert_file_path,
             dest_root.join("WDRLocalTestCert.cer")

crates/cargo-wdk/src/actions/build/tests.rs

@@ -479,7 +479,6 @@ pub fn given_a_driver_project_when_self_signed_exists_then_it_should_skip_callin
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(driver_name, &cwd, target_arch, None)
         .expect_inf2cat(driver_name, &cwd, target_arch, None)
         .expect_self_signed_cert_file_exists(&cwd, false)
@@ -533,7 +532,6 @@ pub fn given_a_driver_project_when_package_dir_exists_then_it_is_removed_and_rec
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(driver_name, &cwd, target_arch, None)
         .expect_inf2cat(driver_name, &cwd, target_arch, None)
         .expect_self_signed_cert_file_exists(&cwd, false)
@@ -684,7 +682,6 @@ pub fn given_a_driver_project_when_stampinf_command_execution_fails_then_package
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(
             driver_name,
             &cwd,
@@ -745,7 +742,6 @@ pub fn given_a_driver_project_when_inf2cat_command_execution_fails_then_package_
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(driver_name, &cwd, target_arch, None)
         .expect_inf2cat(
             driver_name,
@@ -807,7 +803,6 @@ pub fn given_a_driver_project_when_certmgr_command_execution_fails_then_package_
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(driver_name, &cwd, target_arch, None)
         .expect_inf2cat(driver_name, &cwd, target_arch, None)
         .expect_infverif(driver_name, &cwd, None, None)
@@ -867,7 +862,6 @@ pub fn given_a_driver_project_when_makecert_command_execution_fails_then_package
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(driver_name, &cwd, target_arch, None)
         .expect_inf2cat(driver_name, &cwd, target_arch, None)
         .expect_infverif(driver_name, &cwd, None, None)
@@ -928,7 +922,6 @@ pub fn given_a_driver_project_when_signtool_command_execution_fails_then_package
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(driver_name, &cwd, target_arch, None)
         .expect_inf2cat(driver_name, &cwd, target_arch, None)
         .expect_infverif(driver_name, &cwd, None, None)
@@ -991,7 +984,6 @@ pub fn given_a_driver_project_when_infverif_command_execution_fails_then_package
         .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
         .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
         .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-        .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
         .expect_stampinf(driver_name, &cwd, target_arch, None)
         .expect_inf2cat(driver_name, &cwd, target_arch, None)
         .expect_infverif(driver_name, &cwd, None, Some(expected_output));
@@ -1306,7 +1298,6 @@ pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_cwd_i
         .expect_copy_driver_binary_sys_to_package_folder(driver_name_1, &workspace_root_dir, true)
         .expect_copy_pdb_file_to_package_folder(driver_name_1, &workspace_root_dir, true)
         .expect_copy_inx_file_to_package_folder(driver_name_1, &cwd, true, &workspace_root_dir)
-        .expect_copy_map_file_to_package_folder(driver_name_1, &workspace_root_dir, true)
         .expect_stampinf(driver_name_1, &workspace_root_dir, target_arch, None)
         .expect_inf2cat(driver_name_1, &workspace_root_dir, target_arch, None)
         .expect_self_signed_cert_file_exists(&workspace_root_dir, false)
@@ -2033,7 +2024,6 @@ impl TestBuildAction {
             .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
             .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
             .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-            .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
             .expect_stampinf(driver_name, &cwd, target_arch, None)
             .expect_inf2cat(driver_name, &cwd, target_arch, None)
             .expect_self_signed_cert_file_exists(&cwd, false)
@@ -2065,7 +2055,6 @@ impl TestBuildAction {
             .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
             .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
             .expect_copy_inx_file_to_package_folder(driver_name, &cwd, true, &cwd)
-            .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
             .expect_stampinf(driver_name, &cwd, target_arch, None)
             .expect_inf2cat(driver_name, &cwd, target_arch, None)
             .expect_infverif(driver_name, &cwd, None, None)
@@ -2086,7 +2075,6 @@ impl TestBuildAction {
             .expect_copy_driver_binary_sys_to_package_folder(driver_name, &cwd, true)
             .expect_copy_pdb_file_to_package_folder(driver_name, &cwd, true)
             .expect_copy_inx_file_to_package_folder(driver_name, &cwd.join(driver_name), true, &cwd)
-            .expect_copy_map_file_to_package_folder(driver_name, &cwd, true)
             .expect_stampinf(driver_name, &cwd, target_arch, None)
             .expect_inf2cat(driver_name, &cwd, target_arch, None)
             .expect_self_signed_cert_file_exists(&cwd, false)
@@ -2435,45 +2423,6 @@ impl TestBuildAction {
         self
     }
 
-    fn expect_copy_map_file_to_package_folder(
-        mut self,
-        driver_name: &str,
-        driver_dir: &Path,
-        is_success: bool,
-    ) -> Self {
-        let expected_driver_name_underscored = driver_name.replace('-', "_");
-        let expected_target_dir = self.setup_target_dir(driver_dir);
-        let expected_final_package_dir_path =
-            expected_target_dir.join(format!("{expected_driver_name_underscored}_package"));
-        let mock_non_zero_bytes_copied_size = 1000u64;
-
-        // copy map file to package directory
-        let expected_src_driver_map_path = expected_target_dir
-            .join("deps")
-            .join(format!("{expected_driver_name_underscored}.map"));
-        let expected_dest_driver_map_path =
-            expected_final_package_dir_path.join(format!("{expected_driver_name_underscored}.map"));
-        self.mock_fs_provider
-            .expect_copy()
-            .with(
-                eq(expected_src_driver_map_path.clone()),
-                eq(expected_dest_driver_map_path.clone()),
-            )
-            .once()
-            .returning(move |_, _| {
-                if is_success {
-                    Ok(mock_non_zero_bytes_copied_size)
-                } else {
-                    Err(FileError::CopyError(
-                        expected_src_driver_map_path.clone(),
-                        expected_dest_driver_map_path.clone(),
-                        std::io::Error::new(std::io::ErrorKind::UnexpectedEof, "copy error"),
-                    ))
-                }
-            });
-        self
-    }
-
     fn expect_copy_self_signed_cert_file_to_package_folder(
         mut self,
         driver_name: &str,

crates/cargo-wdk/tests/build_command_test.rs

@@ -376,7 +376,7 @@ mod sign_mode {
             let package_dir = format!("{target_dir}/{driver_name}_package");
 
             assert_dir_exists(&package_dir);
-            for ext in ["cat", "inf", "map", "pdb", "sys"] {
+            for ext in ["cat", "inf", "pdb", "sys"] {
                 assert_file_exists(&format!("{package_dir}/{driver_name}.{ext}"));
             }
 
@@ -428,7 +428,7 @@ mod sign_mode {
             );
 
             assert_dir_exists(&package_dir);
-            for ext in ["cat", "inf", "map", "pdb", "sys"] {
+            for ext in ["cat", "inf", "pdb", "sys"] {
                 assert_file_exists(&format!("{package_dir}/{driver_name}.{ext}"));
             }
         });
@@ -891,18 +891,13 @@ fn verify_driver_package_files(
     // Verify files exist in package folder
     assert_dir_exists(&package_path);
 
-    for ext in ["cat", "inf", "map", "pdb", driver_binary_extension] {
+    for ext in ["cat", "inf", "pdb", driver_binary_extension] {
         assert_file_exists(&format!("{package_path}/{driver_name}.{ext}"));
     }
 
     assert_file_exists(&format!("{package_path}/WDRLocalTestCert.cer"));
 
     // Verify hashes of files copied from debug to package folder
-    assert_file_hash(
-        &format!("{package_path}/{driver_name}.map"),
-        &format!("{target_folder_path}/deps/{driver_name}.map"),
-    );
-
     assert_file_hash(
         &format!("{package_path}/{driver_name}.pdb"),
         &format!("{target_folder_path}/{driver_name}.pdb"),

crates/cargo-wdk/tests/test_utils/mod.rs

@@ -313,8 +313,6 @@ fn sanitize_env_vars(cmd: &mut Command) {
             // non-default locations
             && var_upper != "CARGO_HOME"
             && var_upper != "RUSTUP_HOME"
-            // TODO: Remove this whitelist once the env var is removed from test.yaml (see https://github.com/microsoft/windows-drivers-rs/issues/709)
-            && var_upper != "CARGO_UNSTABLE_BUILD_DIR_NEW_LAYOUT"
         {
             Some(var)
         } else {

crates/wdk-build/rust-driver-makefile.toml

@@ -380,29 +380,6 @@ script_runner_args = [
   "${CARGO_MAKE_CURRENT_TASK_INITIAL_MAKEFILE_DIRECTORY}",
 ]
 
-[tasks.copy-map-to-package]
-dependencies = ["build"]
-private = true
-script = '''
-//! ```cargo
-//! [dependencies]
-//! wdk-build = { path = ".", version = "0.5.1" }
-//! ```
-#![allow(unused_doc_comments)]
-
-wdk_build::cargo_make::copy_to_driver_package_folder(
-    wdk_build::cargo_make::get_wdk_build_output_directory().join(format!(
-        "deps/{}.map",
-        wdk_build::cargo_make::get_current_package_name()
-    )),
-)?
-'''
-script_runner = "@rust"
-script_runner_args = [
-  "--base-path",
-  "${CARGO_MAKE_CURRENT_TASK_INITIAL_MAKEFILE_DIRECTORY}",
-]
-
 [tasks.inf2cat]
 args = [
   "/driver:${WDK_BUILD_OUTPUT_DIRECTORY}/${CARGO_MAKE_CRATE_FS_NAME}_package",
@@ -522,7 +499,6 @@ dependencies = [
   "copy-driver-binary-to-package",
   "copy-pdb-to-package",
   "copy-inf-to-package",
-  "copy-map-to-package",
   "copy-certificate-to-package",
   "sign-driver-binary",
   "verify-signature-driver-binary",