Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3d0431a8 authored by Quentin Perret's avatar Quentin Perret
Browse files

BACKPORT: FROMLIST: kbuild: allow symbol whitelisting with TRIM_UNUSED_KSYMS 



CONFIG_TRIM_UNUSED_KSYMS currently removes all unused exported symbols
from ksymtab. This works really well when using in-tree drivers, but
cannot be used in its current form if some of them are out-of-tree.

Indeed, even if the list of symbols required by out-of-tree drivers is
known at compile time, the only solution today to guarantee these don't
get trimmed is to set CONFIG_TRIM_UNUSED_KSYMS=n. This not only wastes
space, but also makes it difficult to control the ABI usable by vendor
modules in distribution kernels such as Android. Being able to control
the kernel ABI surface is particularly useful to ship a unique Generic
Kernel Image (GKI) for all vendors, which is a first step in the
direction of getting all vendors to contribute their code upstream.

As such, attempt to improve the situation by enabling users to specify a
symbol 'whitelist' at compile time. Any symbol specified in this
whitelist will be kept exported when CONFIG_TRIM_UNUSED_KSYMS is set,
even if it has no in-tree user. The whitelist is defined as a simple
text file, listing symbols, one per line.

[ BACKPORT: 60ae1b194b45 not present, sed 3rd line of modules.order ]

Bug: 148277666
Acked-by: default avatarJessica Yu <jeyu@kernel.org>
Acked-by: default avatarNicolas Pitre <nico@fluxnic.net>
Tested-by: default avatarMatthias Maennich <maennich@google.com>
Reviewed-by: default avatarMatthias Maennich <maennich@google.com>
Signed-off-by: default avatarQuentin Perret <qperret@google.com>
Link: https://lore.kernel.org/lkml/20200218094139.78835-2-qperret@google.com
Change-Id: Ie9a4bbb8eebb20202623f084859fb89e55a32698
parent 9d9f11f7

init/Kconfig

+13 −0
Original line number Diff line number Diff line
@@ -2120,6 +2120,19 @@ config TRIM_UNUSED_KSYMS 


	  If unsure, or if you need to build out-of-tree modules, say N.



config UNUSED_KSYMS_WHITELIST

	string "Whitelist of symbols to keep in ksymtab"

	depends on TRIM_UNUSED_KSYMS

	help

	  By default, all unused exported symbols will be un-exported from the

	  build when TRIM_UNUSED_KSYMS is selected.



	  UNUSED_KSYMS_WHITELIST allows to whitelist symbols that must be kept

	  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.



endif # MODULES



config MODULES_TREE_LOOKUP

scripts/adjust_autoksyms.sh

+12 −0
Original line number Diff line number Diff line
@@ -40,6 +40,17 @@ esac 
# We need access to CONFIG_ symbols

. include/config/auto.conf



ksym_wl=/dev/null

if [ -n "$CONFIG_UNUSED_KSYMS_WHITELIST" ]; then

	# Use 'eval' to expand the whitelist path and check if it is relative

	eval ksym_wl="$CONFIG_UNUSED_KSYMS_WHITELIST"

	[ "${ksym_wl}" != "${ksym_wl#/}" ] || ksym_wl="$abs_srctree/$ksym_wl"

	if [ ! -f "$ksym_wl" ]; then

		echo "ERROR: '$ksym_wl' whitelist file not found" >&2

		exit 1

	fi

fi



# Generate a new ksym list file with symbols needed by the current

# set of modules.

cat > "$new_ksyms_file" << EOT
@@ -50,6 +61,7 @@ cat > "$new_ksyms_file" << EOT 
EOT

sed 's/ko$/mod/' modules.order |

xargs -n1 sed -n -e '3{s/ /\n/g;/^$/!p;}' -- |

cat - "$ksym_wl" |

sort -u |

sed -e 's/\(.*\)/#define __KSYM_\1 1/' >> "$new_ksyms_file"