Change CARGO_TRIM_PATHS to the profile option

Author: cbeuw

text/3127-trim-paths.md

@@ -137,16 +137,17 @@ If `trim-paths` is not `none` or `false`, then the following paths are sanitised
 2. Path to the working directory will be stripped. E.g. `/home/username/crate/src/lib.rs` -> `src/lib.rs`.
 3. Path to packages outside of the working directory will be replaced with `[package name]-[version]`. E.g. `/home/username/deps/foo/src/lib.rs` -> `foo-0.1.0/src/lib.rs`
 
-Paths requiring sanitisation can be retrieved by build scripts at their execution time from the environment variable `CARGO_TRIM_PATHS`, in comma-separated format.
-If a build script does anything that may result in these, or any other absolute paths, to be included in compilation outputs, such as by invoking a C compiler, then the build script should make sure they are trimmed.
-Cargo's mapping scheme (what Cargo will map these paths to) is not provided in `CARGO_TRIM_PATHS`, and build scripts are free to decide as long as they are reproducible and privacy preserving.
-
 When a path to the source files of the standard and core library is *not* in scope for sanitisation, the emitted path will depend on if `rust-src` component
 is present. If it is, then some paths will point to the copy of the source files on your file system; if it isn't, then they will
 show up as `/rustc/[rustc commit hash]/library/...` (just like when it is selected for sanitisation). Paths to all other source files will not be affected.
 
 This will not affect any hard-coded paths in the source code, such as in strings.
 
+### Environment variables Cargo sets for build scripts
+* `CARGO_TRIM_PATHS` - The value of `trim-paths` profile option. If the build script introduces absolute paths to built artefacts (such as
+by invoking a compiler), the user may request them to be sanitised in different types of artefacts. Common paths requiring sanitisation
+include `OUT_DIR` and `CARGO_MANIFEST_DIR`, plus any other introduced by the build script, such as include directories.
+
 # Reference-level explanation
 [reference-level-explanation]: #reference-level-explanation
 
@@ -159,9 +160,6 @@ If `trim-paths` is anything else, then its value is supplied directly to `rustc`
 - If the compilation unit is under the working directory, from the the working directory absolute path to empty string.
   If it's outside the working directory, from the absolute path of the package root to `[package name]-[package version]`.
 
-If a package in the dependency tree has build scripts, then the absolute path to the package root is supplied by
-the environment variable `CARGO_TRIM_PATHS` when executing build scripts.
-
 The default value of `trim-paths` is `object` for release profile. As a result, panic messages (which are always embedded) are sanitised. If debug information is embedded, then they are sanitised; if they are split then they are kept untouched, but the paths to these split files are sanitised.
 
 Some interactions with compiler-intrinsic macros need to be considered:
@@ -239,20 +237,28 @@ She can ship her binary like Alice, without worrying about leaking usernames.
 
 ## Hana needs to compile a C program in their build script
 
-They can consult `CARGO_TRIM_PATHS` in their build script to find out which paths need to be sanitised 
+They can consult `CARGO_TRIM_PATHS` in their build script to find out paths in what places the user wants sanitised
 
 ```rust
 // in build.rs
+use std::env;
+use std::process::Command;
 
 let mut gcc = Command::new("gcc");
-
-if let Ok(paths) = std::env::var("CARGO_TRIM_PATHS") {
-   for to_trim in paths.split(','){
-      gcc.arg(format!("-ffile-prefix-map={to_trim}=redacted"));
-   }
+let out_dir = env::var("OUT_DIR").unwrap();
+let scope = env::var("CARGO_TRIM_PATHS").unwrap();
+
+if scope != "none" && scope != "false" {
+   // Runtime working directory of the build script
+   let cwd = env::var("CARGO_MANIFEST_DIR").unwrap();
+   let gcc_scope = match scope.as_str() {
+      "macro" => "-fmacro-prefix-map",
+      _       => "-ffile-prefix-map",
+   };
+   gcc.args([&format!("{gcc_scope}={cwd}=redacted"), &format!("{gcc_scope}={out_dir}=redacted")]);
 }
 
-gcc.args(["-std=c11", "-O2", "-o=lib.o", "lib.c"]);
+gcc.args(["-std=c11", &format!("-o={out_dir}/lib.o"), "lib.c"]);
 
 let output = gcc.output();