Skip to content
Snippets Groups Projects
  • Jessica Yu's avatar
    57baec7b
    scripts/nsdeps: make sure to pass all module source files to spatch · 57baec7b
    Jessica Yu authored
    
    The nsdeps script passes a list of the module source files to
    generate_deps_for_ns() as a space delimited string named $mod_source_files,
    which then passes it to spatch. But since $mod_source_files is not encased
    in quotes, each source file in that string is treated as a separate shell
    function argument (as $2, $3, $4, etc.).  However, the spatch invocation
    only refers to $2, so only the first file out of $mod_source_files is
    processed by spatch.
    
    This causes problems (namely, the MODULE_IMPORT_NS() statement doesn't
    get inserted) when a module is composed of many source files and the
    "main" module file containing the MODULE_LICENSE() statement is not the
    first file listed in $mod_source_files. Fix this by encasing
    $mod_source_files in quotes so that the entirety of the string is
    treated as a single argument and can be referred to as $2.
    
    In addition, put quotes in the variable assignment of mod_source_files
    to prevent any shell interpretation and field splitting.
    
    Reviewed-by: default avatarMasahiro Yamada <yamada.masahiro@socionext.com>
    Acked-by: default avatarMatthias Maennich <maennich@google.com>
    Signed-off-by: default avatarJessica Yu <jeyu@kernel.org>
    57baec7b
    History
    scripts/nsdeps: make sure to pass all module source files to spatch
    Jessica Yu authored
    
    The nsdeps script passes a list of the module source files to
    generate_deps_for_ns() as a space delimited string named $mod_source_files,
    which then passes it to spatch. But since $mod_source_files is not encased
    in quotes, each source file in that string is treated as a separate shell
    function argument (as $2, $3, $4, etc.).  However, the spatch invocation
    only refers to $2, so only the first file out of $mod_source_files is
    processed by spatch.
    
    This causes problems (namely, the MODULE_IMPORT_NS() statement doesn't
    get inserted) when a module is composed of many source files and the
    "main" module file containing the MODULE_LICENSE() statement is not the
    first file listed in $mod_source_files. Fix this by encasing
    $mod_source_files in quotes so that the entirety of the string is
    treated as a single argument and can be referred to as $2.
    
    In addition, put quotes in the variable assignment of mod_source_files
    to prevent any shell interpretation and field splitting.
    
    Reviewed-by: default avatarMasahiro Yamada <yamada.masahiro@socionext.com>
    Acked-by: default avatarMatthias Maennich <maennich@google.com>
    Signed-off-by: default avatarJessica Yu <jeyu@kernel.org>
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
nsdeps 1.94 KiB
#!/bin/sh
# SPDX-License-Identifier: GPL-2.0
# Linux kernel symbol namespace import generator
#
# This script requires a minimum spatch version.
SPATCH_REQ_VERSION="1.0.4"

DIR="$(dirname $(readlink -f $0))/.."
SPATCH="`which ${SPATCH:=spatch}`"
if [ ! -x "$SPATCH" ]; then
	echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
	exit 1
fi

SPATCH_REQ_VERSION_NUM=$(echo $SPATCH_REQ_VERSION | ${DIR}/scripts/ld-version.sh)
SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}')
SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh)

if [ "$SPATCH_VERSION_NUM" -lt "$SPATCH_REQ_VERSION_NUM" ] ; then
	echo "spatch needs to be version $SPATCH_REQ_VERSION or higher"
	exit 1
fi

generate_deps_for_ns() {
	$SPATCH --very-quiet --in-place --sp-file \
		$srctree/scripts/coccinelle/misc/add_namespace.cocci -D ns=$1 $2
}

generate_deps() {
	local mod_name=`basename $@ .ko`
	local mod_file=`echo $@ | sed -e 's/\.ko/\.mod/'`
	local ns_deps_file=`echo $@ | sed -e 's/\.ko/\.ns_deps/'`
	if [ ! -f "$ns_deps_file" ]; then return; fi
	local mod_source_files="`cat $mod_file | sed -n 1p                      \
					      | sed -e 's/\.o/\.c/g'           \
					      | sed "s|[^ ]* *|${srctree}/&|g"`"
	for ns in `cat $ns_deps_file`; do
		echo "Adding namespace $ns to module $mod_name (if needed)."
		generate_deps_for_ns $ns "$mod_source_files"
		# sort the imports
		for source_file in $mod_source_files; do
			sed '/MODULE_IMPORT_NS/Q' $source_file > ${source_file}.tmp
			offset=$(wc -l ${source_file}.tmp | awk '{print $1;}')
			cat $source_file | grep MODULE_IMPORT_NS | LANG=C sort -u >> ${source_file}.tmp
			tail -n +$((offset +1)) ${source_file} | grep -v MODULE_IMPORT_NS >> ${source_file}.tmp
			if ! diff -q ${source_file} ${source_file}.tmp; then
				mv ${source_file}.tmp ${source_file}
			else
				rm ${source_file}.tmp
			fi
		done
	done
}

for f in `cat $objtree/modules.order`; do
	generate_deps $f
done