automated/linux/modules/modules.sh

#!/bin/sh
# SPDX-License-Identifier: GPL-2.0-only
# Copyright (C) 2024 Linaro Ltd.

# shellcheck disable=SC1091
. ../../lib/sh-test-lib
OUTPUT="$(pwd)/output"
RESULT_FILE="${OUTPUT}/result.txt"
export RESULT_FILE

MODULES_LIST=""
MODULES_SUBDIRS=""
MODULE_MODPROBE_NUMBER="1"
SKIPLIST=""
SHARD_NUMBER=1
SHARD_INDEX=1
MEMORY_TOLERANCE=512

usage() {
	echo "Usage: $0 [-d <subdir of the modules directory> ]
		[-l <space separated module list> ]
		[-c <Number of load/unload of a module> ]
		[-i <sharding bucket to run> ]
		[-n <number of shard buckets to create> ]
		[-s <skiplist modules to skip> ]
		[-t <memory tolerance in KB for leak detection> ]
		[-h ]" 1>&2
	exit 0
}

while getopts "c:d:i:l:n:s:t:h" o; do
	case "$o" in
		d) MODULES_SUBDIRS="${OPTARG}" ;;
		l) MODULES_LIST="${OPTARG}" ;;
		c) MODULE_MODPROBE_NUMBER="${OPTARG}" ;;
		i) SHARD_INDEX="${OPTARG}" ;;
		n) SHARD_NUMBER="${OPTARG}" ;;
		s) SKIPLIST="${OPTARG}" ;;
		t) MEMORY_TOLERANCE="${OPTARG}" ;;
		h|*) usage ;;
	esac
done

get_mem_usage_kb() {
	grep -i "MemAvailable:" /proc/meminfo | awk '{ print $2 }'
}

check_module_memory_leaks_cumulative() {
	local module=$1
	local mem_start=$2
	local mem_end=$3
	local diff_kb
	diff_kb=$((mem_start - mem_end))
	echo "memcheck cumulative: start ${mem_start}, end ${mem_end}, diff ${diff_kb}"
	if [ "$diff_kb" -lt "-${MEMORY_TOLERANCE}" ]; then
		report_fail "memcheck_${module}"
	else
		report_pass "memcheck_${module}"
	fi
}

get_modules_list() {
	if [ -z "${MODULES_LIST}" ]; then
		if [ -n "${MODULES_SUBDIRS}" ]; then
			subdir=$(echo "${MODULES_SUBDIRS}" | tr ' ' '|')
			grep -E "kernel/(${subdir})" /lib/modules/"$(uname -r)"/modules.order > /tmp/find_modules.txt
		else
			# No subdir given, default to all modules
			cat /lib/modules/"$(uname -r)"/modules.order > /tmp/find_modules.txt
		fi

		if [ -n "${SKIPLIST}" ]; then
			skiplist=$(echo "${SKIPLIST}" | tr ' ' '|')
			grep -E -v "(${skiplist})" /tmp/find_modules.txt > /tmp/modules_to_run.txt
		else
			cp /tmp/find_modules.txt /tmp/modules_to_run.txt
		fi

		split --verbose --numeric-suffixes=1 -n l/"${SHARD_INDEX}"/"${SHARD_NUMBER}" /tmp/modules_to_run.txt > /tmp/shardfile
		echo "============== Tests to run ==============="
		cat /tmp/shardfile
		echo "===========End Tests to run ==============="
		if [ -s /tmp/shardfile ]; then
			report_pass "shardfile"
		else
			report_fail "shardfile"
		fi
		while IFS= read -r line
		do
			module_basename=$(basename "${line}")
			module_name=${module_basename%.*}
			MODULES_LIST="${MODULES_LIST} ${module_name}"
		done < /tmp/shardfile
	fi
}

report() {
	local _modprop_flag="${1}"
	local _module="${2}"
	local _text="${3}"
	local _num="${4}"
	echo
	echo "${_text} module: ${_module}"
	if ! modprobe "${_module}" "${_modprop_flag}"; then
		report_fail "${_text}_module_${_num}_${_module}"
	else
		report_pass "${_text}_module_${_num}_${_module}"
	fi
}

scan_dmesg_for_errors() {
	echo "=== Scanning dmesg for errors ==="
	dmesg -l 0,1,2,3,4,5 | grep -Ei "BUG:|WARNING:|Oops:|Call Trace:" && report_fail "dmesg_error_scan" || report_pass "dmesg_error_scan"
}

check_module_unloaded() {
	local _module="$1"
	if lsmod | grep "^${_module} " > /dev/null; then
		echo "Module ${_module} still loaded after removal!"
		report_fail "module_stuck_${_module}"
	else
		report_pass "module_unloaded_${_module}"
	fi
}

kmemleak_scan() {
	if [ -e /sys/kernel/debug/kmemleak ]; then
		echo "Triggering kmemleak scan..."
		echo scan > /sys/kernel/debug/kmemleak
		sleep 5
		if grep -q . /sys/kernel/debug/kmemleak; then
			echo "Potential memory leaks detected:"
			cat /sys/kernel/debug/kmemleak
			report_fail "kmemleak_detected"
		else
			report_pass "kmemleak_no_leaks"
		fi
	else
		echo "kmemleak not available, skipping scan."
	fi
}

run () {
	for module in ${MODULES_LIST}; do
		# don't insert/remove modules that is already inserted.
		if ! lsmod | grep "^${module}"; then
			for num in $(seq "${MODULE_MODPROBE_NUMBER}"); do
				dmesg -C
				mem_before=$(get_mem_usage_kb)
				report "" "${module}" "insert" "${num}"
				echo
				echo "modinfo ${module}"
				modinfo "${module}"
				scan_dmesg_for_errors

				report "--remove" "${module}" "remove" "${num}"
				scan_dmesg_for_errors

				check_module_unloaded "${module}"
				mem_after=$(get_mem_usage_kb)
				check_module_memory_leaks_cumulative "$mem_before" "$mem_after" "$module"
			done
		fi
	done
}

# Test run.
! check_root && error_msg "This script must be run as root"
create_out_dir "${OUTPUT}"
info_msg "Output directory: ${OUTPUT}"
info_msg "About to run  load/unload kernel modules ..."
get_modules_list
run
kmemleak_scan