Skip to contentSkip to conversation

rust: build: remap path to avoid absolute path

PATCH Applied Gary Guo 3 participants 3 messages Feb 26 – Mar 6

Subsystems (2)
lore
Share & tools
lore

Gary Guo

author
#0 lore raw

PATCH v2 1/1 rust: build: remap path to avoid absolute path

From: Gary Guo <[email protected]>

When building with a out directory (O=), absolute paths can end up in the file name in #[track_caller] or the panic message. This is not desirable as this leaks the exact path being used to build the kernel and means that the same location can appear in two forms (relative or absolute).

This is reported by Asahi [1] and is being workaround in [2] previously to force everything to be absolute path. Using absolute path for everything sovles the inconsistency, however it does not address the reproducibility issue. So, fix this by remap all absolute paths to srctree to relative path instead.

This is previously attemped in commit dbdffaf50ff9 ("kbuild, rust: use -fremap-path-prefix to make paths relative") but that was reverted as remapping debug info causes some tool (e.g. objdump) to be unable to find sources. Therefore, use --remap-path-scope to only remap macros but leave debuginfo untouched. --remap-path-scope is only stable in Rust 1.95, so use rustc-option to detect its presence. This feature has been available as -Zremap-path-scope for all versions that we support; hwoever due to bugs in the Rust compiler, it does not work reliably until 1.94. I opted to not enable it for 1.94 as it's just a single version that we missed.

This change can be validated by building a kernel with O=, strip debug info on vmlinux, and then check if the absolute path exists in strings vmlinux, e.g. strings vmlinux |grep \/home.

---
Changes since v1:
- Restrict remap scope to macro only
- Add to RUSTFLAGS instead of adding directly to scripts/Makefile.build

---
 Makefile      | 3 +++
 rust/Makefile | 5 +++--
 2 files changed, 6 insertions(+), 2 deletions(-)
Makefile +3 -0
index e944c6e71e81..f6a54bf1db00 100644
@@ -1113,6 +1113,9 @@ KBUILD_CFLAGS += -fno-builtin-wcslen
 # change __FILE__ to the relative path to the source directory
 ifdef building_out_of_srctree
 KBUILD_CPPFLAGS += -fmacro-prefix-map=$(srcroot)/=
+ifeq ($(call rustc-option-yn, --remap-path-scope=macro),y)
+KBUILD_RUSTFLAGS += --remap-path-prefix=$(srcroot)/= --remap-path-scope=macro
+endif
 endif
 
 # include additional Makefiles when needed
rust/Makefile +3 -2
index 629b3bdd2b20..9a04022643ce 100644
@@ -148,7 +148,8 @@ doctests_modifiers_workaround := $(rustdoc_modifiers_workaround)$(if $(call rust
 quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $<
       cmd_rustdoc = \
 	OBJTREE=$(abspath $(objtree)) \
-	$(RUSTDOC) $(filter-out $(skip_flags) --remap-path-prefix=%,$(if $(rustdoc_host),$(rust_common_flags),$(rust_flags))) \
+	$(RUSTDOC) $(filter-out $(skip_flags) --remap-path-prefix=% --remap-path-scope=%, \
+			$(if $(rustdoc_host),$(rust_common_flags),$(rust_flags))) \
 		$(rustc_target_flags) -L$(objtree)/$(obj) \
 		-Zunstable-options --generate-link-to-definition \
 		--output $(rustdoc_output) \
@@ -334,7 +335,7 @@ quiet_cmd_rustdoc_test_kernel = RUSTDOC TK $<
 	rm -rf $(objtree)/$(obj)/test/doctests/kernel; \
 	mkdir -p $(objtree)/$(obj)/test/doctests/kernel; \
 	OBJTREE=$(abspath $(objtree)) \
-	$(RUSTDOC) --test $(filter-out --remap-path-prefix=%,$(rust_flags)) \
+	$(RUSTDOC) --test $(filter-out --remap-path-prefix=% --remap-path-scope=%,$(rust_flags)) \
 		-L$(objtree)/$(obj) --extern ffi --extern pin_init \
 		--extern kernel --extern build_error --extern macros \
 		--extern bindings --extern uapi \

base-commit: 877552aa875839314afad7154b5a561889e87ea9

Signature · 1 line
2.51.2
maintainer Acked-by on v2 1/1
#1 lore raw
Quoted 32 lines · Gary Guo

From: Gary Guo <[email protected]>

When building with a out directory (O=), absolute paths can end up in the file name in #[track_caller] or the panic message. This is not desirable as this leaks the exact path being used to build the kernel and means that the same location can appear in two forms (relative or absolute).

This is reported by Asahi [1] and is being workaround in [2] previously to force everything to be absolute path. Using absolute path for everything sovles the inconsistency, however it does not address the reproducibility issue. So, fix this by remap all absolute paths to srctree to relative path instead.

This is previously attemped in commit dbdffaf50ff9 ("kbuild, rust: use -fremap-path-prefix to make paths relative") but that was reverted as remapping debug info causes some tool (e.g. objdump) to be unable to find sources. Therefore, use --remap-path-scope to only remap macros but leave debuginfo untouched. --remap-path-scope is only stable in Rust 1.95, so use rustc-option to detect its presence. This feature has been available as -Zremap-path-scope for all versions that we support; hwoever due to bugs in the Rust compiler, it does not work reliably until 1.94. I opted to not enable it for 1.94 as it's just a single version that we missed.

This change can be validated by building a kernel with O=, strip debug info on vmlinux, and then check if the absolute path exists in strings vmlinux, e.g. strings vmlinux |grep \/home.

Quoted 9 lines

---
Changes since v1:
- Restrict remap scope to macro only
- Add to RUSTFLAGS instead of adding directly to scripts/Makefile.build

---
 Makefile      | 3 +++
 rust/Makefile | 5 +++--
 2 files changed, 6 insertions(+), 2 deletions(-)
Applied
#2 lore raw
In reply to Gary Guo
Quoted 28 lines · Gary Guo

From: Gary Guo <[email protected]>

When building with a out directory (O=), absolute paths can end up in the file name in #[track_caller] or the panic message. This is not desirable as this leaks the exact path being used to build the kernel and means that the same location can appear in two forms (relative or absolute).

This is reported by Asahi [1] and is being workaround in [2] previously to force everything to be absolute path. Using absolute path for everything sovles the inconsistency, however it does not address the reproducibility issue. So, fix this by remap all absolute paths to srctree to relative path instead.

This is previously attemped in commit dbdffaf50ff9 ("kbuild, rust: use -fremap-path-prefix to make paths relative") but that was reverted as remapping debug info causes some tool (e.g. objdump) to be unable to find sources. Therefore, use --remap-path-scope to only remap macros but leave debuginfo untouched. --remap-path-scope is only stable in Rust 1.95, so use rustc-option to detect its presence. This feature has been available as -Zremap-path-scope for all versions that we support; hwoever due to bugs in the Rust compiler, it does not work reliably until 1.94. I opted to not enable it for 1.94 as it's just a single version that we missed.

This change can be validated by building a kernel with O=, strip debug info on vmlinux, and then check if the absolute path exists in strings vmlinux, e.g. strings vmlinux |grep \/home.

Quoted 5 lines

Applied to rust-fixes -- thanks everyone!

[ Reworded for few typos. - Miguel ]

Cheers,
Miguel