Skip to contentSkip to conversation

module: allow UNUSED_KSYMS_WHITELIST to be relative against objtree.

PATCH Superseded Yifan Hong 3 participants 5 messages Apr 10, 2024 – Apr 11, 2024

Subsystems (2)
lore
Share & tools
lore

Yifan Hong

author
#0 lore raw

PATCH 1/1 module: allow UNUSED_KSYMS_WHITELIST to be relative against objtree.

If UNUSED_KSYMS_WHITELIST is a file generated before Kbuild runs, and the source tree is in a read-only filesystem, the developer must put the file somewhere and specify an absolute path to UNUSED_KSYMS_WHITELIST. This worked, but if IKCONFIG=y, an absolute path is embedded into .config and eventually into vmlinux, causing the build to be less reproducible when building on a different machine.

This patch makes the handling of UNUSED_KSYMS_WHITELIST to be similar to MODULE_SIG_KEY.

First, check if UNUSED_KSYMS_WHITELIST is an absolute path, just as before this patch. If so, use the path as is.

If it is a relative path, use wildcard to check the existence of the file below objtree first. If it does not exist, fall back to the original behavior of adding $(srctree)/ before the value.

After this patch, the developer can put the generated file in objtree, then use a relative path against objtree in .config, eradicating any absolute paths that may be evaluated differently on different machines.

---
 kernel/module/Kconfig    | 2 +-
 scripts/Makefile.modpost | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
kernel/module/Kconfig +1 -1
index f3e0329337f6..cb8377a18927 100644
@@ -392,7 +392,7 @@ config UNUSED_KSYMS_WHITELIST
 	  exported at all times, even in absence of in-tree users. The value to
 	  set here is the path to a text file containing the list of symbols,
 	  one per line. The path can be absolute, or relative to the kernel
-	  source tree.
+	  source or obj tree.
 
 config MODULES_TREE_LOOKUP
 	def_bool y
scripts/Makefile.modpost +1 -1
index 739402f45509..efdf0cf39cf1 100644
@@ -94,7 +94,7 @@ targets += .vmlinux.objs
 
 ifdef CONFIG_TRIM_UNUSED_KSYMS
 ksym-wl := $(CONFIG_UNUSED_KSYMS_WHITELIST)
-ksym-wl := $(if $(filter-out /%, $(ksym-wl)),$(srctree)/)$(ksym-wl)
+ksym-wl := $(if $(wildcard $(ksym-wl)),,$(srctree)/)$(ksym-wl)
 modpost-args += -t $(addprefix -u , $(ksym-wl))
 modpost-deps += $(ksym-wl)
 endif
Signature · 1 line
2.44.0.478.gd926399ef9-goog
author
#1 lore raw

PATCH v2 1/1 module: allow UNUSED_KSYMS_WHITELIST to be relative against objtree.

If UNUSED_KSYMS_WHITELIST is a file generated before Kbuild runs, and the source tree is in a read-only filesystem, the developer must put the file somewhere and specify an absolute path to UNUSED_KSYMS_WHITELIST. This worked, but if IKCONFIG=y, an absolute path is embedded into .config and eventually into vmlinux, causing the build to be less reproducible when building on a different machine.

This patch makes the handling of UNUSED_KSYMS_WHITELIST to be similar to MODULE_SIG_KEY.

First, check if UNUSED_KSYMS_WHITELIST is an absolute path, just as before this patch. If so, use the path as is.

If it is a relative path, use wildcard to check the existence of the file below objtree first. If it does not exist, fall back to the original behavior of adding $(srctree)/ before the value.

After this patch, the developer can put the generated file in objtree, then use a relative path against objtree in .config, eradicating any absolute paths that may be evaluated differently on different machines.

---
V1 -> V2: properly handle absolute paths by treating
them as-is.

 kernel/module/Kconfig    | 2 +-
 scripts/Makefile.modpost | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
kernel/module/Kconfig +1 -1
index f3e0329337f6..cb8377a18927 100644
@@ -392,7 +392,7 @@ config UNUSED_KSYMS_WHITELIST
 	  exported at all times, even in absence of in-tree users. The value to
 	  set here is the path to a text file containing the list of symbols,
 	  one per line. The path can be absolute, or relative to the kernel
-	  source tree.
+	  source or obj tree.
 
 config MODULES_TREE_LOOKUP
 	def_bool y
scripts/Makefile.modpost +1 -1
index 739402f45509..36952638bbc6 100644
@@ -94,7 +94,7 @@ targets += .vmlinux.objs
 
 ifdef CONFIG_TRIM_UNUSED_KSYMS
 ksym-wl := $(CONFIG_UNUSED_KSYMS_WHITELIST)
-ksym-wl := $(if $(filter-out /%, $(ksym-wl)),$(srctree)/)$(ksym-wl)
+ksym-wl := $(if $(filter-out /%, $(ksym-wl)),$(if $(wildcard $(ksym-wl)),,$(srctree)/))$(ksym-wl)
 modpost-args += -t $(addprefix -u , $(ksym-wl))
 modpost-deps += $(ksym-wl)
 endif
Signature · 1 line
2.44.0.478.gd926399ef9-goog
Reviewed-by on v2 1/1
#2 lore raw
Quoted 23 lines · Yifan Hong

If UNUSED_KSYMS_WHITELIST is a file generated before Kbuild runs, and the source tree is in a read-only filesystem, the developer must put the file somewhere and specify an absolute path to UNUSED_KSYMS_WHITELIST. This worked, but if IKCONFIG=y, an absolute path is embedded into .config and eventually into vmlinux, causing the build to be less reproducible when building on a different machine.

This patch makes the handling of UNUSED_KSYMS_WHITELIST to be similar to MODULE_SIG_KEY.

First, check if UNUSED_KSYMS_WHITELIST is an absolute path, just as before this patch. If so, use the path as is.

If it is a relative path, use wildcard to check the existence of the file below objtree first. If it does not exist, fall back to the original behavior of adding $(srctree)/ before the value.

Quoted 6 lines

After this patch, the developer can put the generated file in objtree, then use a relative path against objtree in .config, eradicating any absolute paths that may be evaluated differently on different machines.

I wonder if we should have a macro to do it so we can have a common macro for the other time this is done for sig-key in scripts/Makefile.modinst?

maybe-srctree = $(if $(wildcard $1),,$(srctree)/)$1

I'd let Masahiro/others decide if it's worth it. Otherwise,

Quoted 38 lines

---
V1 -> V2: properly handle absolute paths by treating
them as-is.

 kernel/module/Kconfig    | 2 +-
 scripts/Makefile.modpost | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
kernel/module/Kconfig +1 -1
index f3e0329337f6..cb8377a18927 100644
@@ -392,7 +392,7 @@ config UNUSED_KSYMS_WHITELIST
 	  exported at all times, even in absence of in-tree users. The value to
 	  set here is the path to a text file containing the list of symbols,
 	  one per line. The path can be absolute, or relative to the kernel
-	  source tree.
+	  source or obj tree.
 
 config MODULES_TREE_LOOKUP
 	def_bool y
scripts/Makefile.modpost +1 -1
index 739402f45509..36952638bbc6 100644
@@ -94,7 +94,7 @@ targets += .vmlinux.objs
 
 ifdef CONFIG_TRIM_UNUSED_KSYMS
 ksym-wl := $(CONFIG_UNUSED_KSYMS_WHITELIST)
-ksym-wl := $(if $(filter-out /%, $(ksym-wl)),$(srctree)/)$(ksym-wl)
+ksym-wl := $(if $(filter-out /%, $(ksym-wl)),$(if $(wildcard $(ksym-wl)),,$(srctree)/))$(ksym-wl)
 modpost-args += -t $(addprefix -u , $(ksym-wl))
 modpost-deps += $(ksym-wl)
 endif
Signature · 1 line
2.44.0.478.gd926399ef9-goog
author
#3 lore raw
Quoted 36 lines · Elliot Berman
Quoted 23 lines · Yifan Hong

If UNUSED_KSYMS_WHITELIST is a file generated before Kbuild runs, and the source tree is in a read-only filesystem, the developer must put the file somewhere and specify an absolute path to UNUSED_KSYMS_WHITELIST. This worked, but if IKCONFIG=y, an absolute path is embedded into .config and eventually into vmlinux, causing the build to be less reproducible when building on a different machine.

This patch makes the handling of UNUSED_KSYMS_WHITELIST to be similar to MODULE_SIG_KEY.

First, check if UNUSED_KSYMS_WHITELIST is an absolute path, just as before this patch. If so, use the path as is.

If it is a relative path, use wildcard to check the existence of the file below objtree first. If it does not exist, fall back to the original behavior of adding $(srctree)/ before the value.

Quoted 6 lines

After this patch, the developer can put the generated file in objtree, then use a relative path against objtree in .config, eradicating any absolute paths that may be evaluated differently on different machines.

I wonder if we should have a macro to do it so we can have a common macro for the other time this is done for sig-key in scripts/Makefile.modinst?

Quoted 5 lines

maybe-srctree = $(if $(wildcard $1),,$(srctree)/)$1

I'd let Masahiro/others decide if it's worth it. Otherwise,

Thanks for your review!

Also maybe relevant: I notice that SYSTEM_TRUSTED_KEYS is yet another path in .config, but it is used as-is in certs/Makefile, without adding the $(srctree) prefix. If we had this macro, I think it should be applied to all of UNUSED_KSYMS_WHITELIST, MODULE_SIG_KEY, SYSTEM_TRUSTED_KEYS, and potentially other paths.

But these configs are beyond my knowledge and beyond the scope of this patch, so I decide not to touch them at this moment.

Quoted 39 lines
Quoted 39 lines

---
V1 -> V2: properly handle absolute paths by treating
them as-is.

 kernel/module/Kconfig    | 2 +-
 scripts/Makefile.modpost | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
kernel/module/Kconfig +1 -1
index f3e0329337f6..cb8377a18927 100644
@@ -392,7 +392,7 @@ config UNUSED_KSYMS_WHITELIST
        exported at all times, even in absence of in-tree users. The value to
        set here is the path to a text file containing the list of symbols,
        one per line. The path can be absolute, or relative to the kernel
-       source tree.
+       source or obj tree.
 
 config MODULES_TREE_LOOKUP
      def_bool y
scripts/Makefile.modpost +1 -2
index 739402f45509..36952638bbc6 100644
@@ -94,7 +94,7 @@ targets += .vmlinux.objs
 
 ifdef CONFIG_TRIM_UNUSED_KSYMS
 ksym-wl := $(CONFIG_UNUSED_KSYMS_WHITELIST)
-ksym-wl := $(if $(filter-out /%, $(ksym-wl)),$(srctree)/)$(ksym-wl)
+ksym-wl := $(if $(filter-out /%, $(ksym-wl)),$(if $(wildcard $(ksym-wl)),,$(srctree)/))$(ksym-wl)
 modpost-args += -t $(addprefix -u , $(ksym-wl))
 modpost-deps += $(ksym-wl)
 endif
--

2.44.0.478.gd926399ef9-goog

maintainer
#4 lore raw
In reply to Yifan Hong
Quoted 23 lines · Yifan Hong

If UNUSED_KSYMS_WHITELIST is a file generated before Kbuild runs, and the source tree is in a read-only filesystem, the developer must put the file somewhere and specify an absolute path to UNUSED_KSYMS_WHITELIST. This worked, but if IKCONFIG=y, an absolute path is embedded into .config and eventually into vmlinux, causing the build to be less reproducible when building on a different machine.

This patch makes the handling of UNUSED_KSYMS_WHITELIST to be similar to MODULE_SIG_KEY.

First, check if UNUSED_KSYMS_WHITELIST is an absolute path, just as before this patch. If so, use the path as is.

If it is a relative path, use wildcard to check the existence of the file below objtree first. If it does not exist, fall back to the original behavior of adding $(srctree)/ before the value.

Quoted 6 lines

After this patch, the developer can put the generated file in objtree, then use a relative path against objtree in .config, eradicating any absolute paths that may be evaluated differently on different machines.

Applied and pushed, thanks.

Luis