The legacy "replace" field in struct klp_patch will be replaced by the provides/obsoletes mechanism. As a result, the atomic replace selftests fail to build against kernels that only support provides/obsoletes.
Adapt the selftests so that they build and run on both old and new kernels. On kernels without the legacy "replace" support, the replace-related test cases are skipped with a SKIP message instead of being run. Also introduce the CONFIG_KLP_HAS_PROVIDES compile-time marker in kernel/livepatch/Kconfig. It defaults to n and will be set to y once the provides/obsoletes support is implemented later in this series. The provides/obsoletes-based selftests will be added later in this series, after the legacy "replace" field has been substituted by the new mechanism. Suggested-by: Petr Mladek <[email protected]> Signed-off-by: Yafang Shao <[email protected]> Acked-by: Song Liu <[email protected]> Reviewed-by: Petr Mladek <[email protected]> Tested-by: Petr Mladek <[email protected]> Acked-by: Miroslav Benes <[email protected]> --- kernel/livepatch/Kconfig | 14 +++ .../testing/selftests/livepatch/functions.sh | 42 +++++++- .../selftests/livepatch/test-callbacks.sh | 43 +++++--- .../selftests/livepatch/test-kprobe.sh | 2 +- .../selftests/livepatch/test-livepatch.sh | 102 ++++++++++-------- .../test_modules/test_klp_callbacks_demo2.c | 16 +++ .../test_modules/test_klp_meminfo_lp.c | 16 +++ .../livepatch/test_modules/test_klp_state.c | 7 ++ .../livepatch/test_modules/test_klp_state2.c | 7 ++ 9 files changed, 186 insertions(+), 63 deletions(-) diff --git a/kernel/livepatch/Kconfig b/kernel/livepatch/Kconfig index 4c0a9c18d0b2..d1eb971abb1a 100644 --- a/kernel/livepatch/Kconfig +++ b/kernel/livepatch/Kconfig @@ -30,3 +30,17 @@ config KLP_BUILD select OBJTOOL help Enable klp-build support + +config KLP_HAS_PROVIDES + def_bool n + help + Compile-time marker for the livepatch provides/obsoletes support. + It is always set when the kernel is built with the scoped atomic + replace model, i.e. struct klp_patch provides the "provides" and + "obsoletes" fields instead of the legacy "replace" flag. + + The option itself does not enable or add any functionality; it + only serves as a compile-time marker so that out-of-tree modules + and tools (e.g. the livepatch kselftests) can detect kernels that + speak the provides/obsoletes interface and adapt to it with + #ifdef CONFIG_KLP_HAS_PROVIDES. diff --git a/tools/testing/selftests/livepatch/functions.sh b/tools/testing/selftests/livepatch/functions.sh index 8352c8d509a5..2458db8faa64 100644 --- a/tools/testing/selftests/livepatch/functions.sh +++ b/tools/testing/selftests/livepatch/functions.sh @@ -27,14 +27,26 @@ function log() { echo "$1" > /dev/kmsg } -# skip(msg) - testing can't proceed +# skip_exit(msg) - testing can't proceed # msg - explanation -function skip() { +function skip_exit() { log "SKIP: $1" echo "SKIP: $1" >&2 exit $ksft_skip } +# skip(test, reason) - skip the test for a specific reason +# test - a test case +# reason - reason to skip it +function skip() { + local test="$1" + local reason="$2" + + echo -n "TEST: $test ... " + echo "SKIP ($reason)" + log "===== TEST: $test SKIPPED: $reason =====" +} + # root test function is_root() { uid=$(id -u) @@ -120,7 +132,7 @@ function set_ftrace_enabled() { return fi - skip "failed to set kernel.ftrace_enabled = $1" + skip_exit "failed to set kernel.ftrace_enabled = $1" fi echo "livepatch: kernel.ftrace_enabled = $result" > /dev/kmsg @@ -357,6 +369,30 @@ function does_sysfs_exist() { [[ -f "$SYSFS_KLP_DIR/$mod/$attr" ]] } +# detect_provides_attr() - detect whether the running kernel supports the +# livepatch "provides" attribute and set HAS_PROVIDES_ATTR accordingly. +# The provides/obsoletes based tests are only run when HAS_PROVIDES_ATTR +# is set. +function detect_provides_attr() { + HAS_PROVIDES_ATTR=0 + + if [[ -r /proc/config.gz ]] && + zgrep -q "CONFIG_KLP_HAS_PROVIDES=y" /proc/config.gz 2>/dev/null; then + HAS_PROVIDES_ATTR=1 + return 0 + fi + + # /proc/config.gz is available only when CONFIG_IKCONFIG_PROC is + # enabled. Fall back to probing the "provides" sysfs attribute, + # which requires loading and unloading a livepatch. + load_lp test_klp_cmdline_lp + if does_sysfs_exist test_klp_cmdline_lp "provides"; then + HAS_PROVIDES_ATTR=1 + fi + disable_lp test_klp_cmdline_lp + unload_lp test_klp_cmdline_lp +} + # check_sysfs_rights(modname, rel_path, expected_rights) - check sysfs # path permissions # modname - livepatch module creating the sysfs interface diff --git a/tools/testing/selftests/livepatch/test-callbacks.sh b/tools/testing/selftests/livepatch/test-callbacks.sh index 2a03deb26a12..210a9f938204 100755 --- a/tools/testing/selftests/livepatch/test-callbacks.sh +++ b/tools/testing/selftests/livepatch/test-callbacks.sh @@ -10,6 +10,7 @@ MOD_TARGET=test_klp_callbacks_mod MOD_TARGET_BUSY=test_klp_callbacks_busy setup_config +detect_provides_attr # Test a combination of loading a kernel module and a livepatch that @@ -458,16 +459,17 @@ $MOD_TARGET_BUSY: ${MOD_TARGET_BUSY}_exit" # execute as each patch progresses through its (un)patching # transition. -start_test "multiple livepatches" +function test_multiple_livepatches() { + start_test "multiple livepatches" -load_lp $MOD_LIVEPATCH -load_lp $MOD_LIVEPATCH2 -disable_lp $MOD_LIVEPATCH2 -disable_lp $MOD_LIVEPATCH -unload_lp $MOD_LIVEPATCH2 -unload_lp $MOD_LIVEPATCH + load_lp $MOD_LIVEPATCH + load_lp $MOD_LIVEPATCH2 + disable_lp $MOD_LIVEPATCH2 + disable_lp $MOD_LIVEPATCH + unload_lp $MOD_LIVEPATCH2 + unload_lp $MOD_LIVEPATCH -check_result "% insmod test_modules/$MOD_LIVEPATCH.ko + check_result "% insmod test_modules/$MOD_LIVEPATCH.ko livepatch: enabling patch '$MOD_LIVEPATCH' livepatch: '$MOD_LIVEPATCH': initializing patching transition $MOD_LIVEPATCH: pre_patch_callback: vmlinux @@ -499,6 +501,7 @@ $MOD_LIVEPATCH: post_unpatch_callback: vmlinux livepatch: '$MOD_LIVEPATCH': unpatching complete % rmmod $MOD_LIVEPATCH2 % rmmod $MOD_LIVEPATCH" +} # Load multiple livepatches, but the second as an 'atomic-replace' @@ -515,15 +518,16 @@ livepatch: '$MOD_LIVEPATCH': unpatching complete # - Once the atomic replace module is loaded, only its pre and post # unpatch callbacks are executed. -start_test "atomic replace" +function test_atomic_replace() { + start_test "atomic replace" -load_lp $MOD_LIVEPATCH -load_lp $MOD_LIVEPATCH2 replace=1 -disable_lp $MOD_LIVEPATCH2 -unload_lp $MOD_LIVEPATCH2 -unload_lp $MOD_LIVEPATCH + load_lp $MOD_LIVEPATCH + load_lp $MOD_LIVEPATCH2 replace=1 + disable_lp $MOD_LIVEPATCH2 + unload_lp $MOD_LIVEPATCH2 + unload_lp $MOD_LIVEPATCH -check_result "% insmod test_modules/$MOD_LIVEPATCH.ko + check_result "% insmod test_modules/$MOD_LIVEPATCH.ko livepatch: enabling patch '$MOD_LIVEPATCH' livepatch: '$MOD_LIVEPATCH': initializing patching transition $MOD_LIVEPATCH: pre_patch_callback: vmlinux @@ -548,6 +552,15 @@ $MOD_LIVEPATCH2: post_unpatch_callback: vmlinux livepatch: '$MOD_LIVEPATCH2': unpatching complete % rmmod $MOD_LIVEPATCH2 % rmmod $MOD_LIVEPATCH" +} + +if [[ "$HAS_PROVIDES_ATTR" == "1" ]]; then + skip "multiple livepatches" "legacy replace attribute not present" + skip "atomic replace" "legacy replace attribute not present" +else + test_multiple_livepatches + test_atomic_replace +fi exit 0 diff --git a/tools/testing/selftests/livepatch/test-kprobe.sh b/tools/testing/selftests/livepatch/test-kprobe.sh index 81ab6d4760aa..75d9093c1742 100755 --- a/tools/testing/selftests/livepatch/test-kprobe.sh +++ b/tools/testing/selftests/livepatch/test-kprobe.sh @@ -5,7 +5,7 @@ . $(dirname $0)/functions.sh -grep -q kprobe_ftrace_ops /proc/kallsyms || skip "test-kprobe requires CONFIG_KPROBES_ON_FTRACE" +grep -q kprobe_ftrace_ops /proc/kallsyms || skip_exit "test-kprobe requires CONFIG_KPROBES_ON_FTRACE" MOD_LIVEPATCH=test_klp_cmdline_lp MOD_KPROBE=test_klp_cmdline_kp diff --git a/tools/testing/selftests/livepatch/test-livepatch.sh b/tools/testing/selftests/livepatch/test-livepatch.sh index 5380b5f174d4..645fa6cd3cf5 100755 --- a/tools/testing/selftests/livepatch/test-livepatch.sh +++ b/tools/testing/selftests/livepatch/test-livepatch.sh @@ -12,6 +12,7 @@ MOD_TARGET=test_klp_mod_target MOD_TARGET_PATCH=test_klp_mod_patch setup_config +detect_provides_attr # - load a livepatch that modifies the output from /proc/cmdline and @@ -55,31 +56,32 @@ livepatch: '$MOD_LIVEPATCH1': unpatching complete # - unload the second livepatch and verify that the first is still active # - unload the first livepatch and verify none are active -start_test "multiple livepatches" +function test_multiple_livepatches() { + start_test "multiple livepatches" -load_lp $MOD_LIVEPATCH1 + load_lp $MOD_LIVEPATCH1 -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -load_lp $MOD_REPLACE replace=0 + load_lp $MOD_REPLACE replace=0 -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -disable_lp $MOD_REPLACE -unload_lp $MOD_REPLACE + disable_lp $MOD_REPLACE + unload_lp $MOD_REPLACE -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -disable_lp $MOD_LIVEPATCH1 -unload_lp $MOD_LIVEPATCH1 + disable_lp $MOD_LIVEPATCH1 + unload_lp $MOD_LIVEPATCH1 -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -check_result "% insmod test_modules/$MOD_LIVEPATCH1.ko + check_result "% insmod test_modules/$MOD_LIVEPATCH1.ko livepatch: enabling patch '$MOD_LIVEPATCH1' livepatch: '$MOD_LIVEPATCH1': initializing patching transition livepatch: '$MOD_LIVEPATCH1': starting patching transition @@ -107,6 +109,7 @@ livepatch: '$MOD_LIVEPATCH1': starting unpatching transition livepatch: '$MOD_LIVEPATCH1': completing unpatching transition livepatch: '$MOD_LIVEPATCH1': unpatching complete % rmmod $MOD_LIVEPATCH1" +} # - load a livepatch that modifies the output from /proc/cmdline and @@ -119,46 +122,47 @@ livepatch: '$MOD_LIVEPATCH1': unpatching complete # atomic replace livepatch is still active # - remove the atomic replace livepatch and verify that none are active -start_test "atomic replace livepatch" +function test_atomic_replace_livepatch() { + start_test "atomic replace livepatch" -load_lp $MOD_LIVEPATCH1 + load_lp $MOD_LIVEPATCH1 -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -for mod in $MOD_LIVEPATCH2 $MOD_LIVEPATCH3; do - load_lp "$mod" -done + for mod in $MOD_LIVEPATCH2 $MOD_LIVEPATCH3; do + load_lp "$mod" + done -mods=($SYSFS_KLP_DIR/*) -nmods=${#mods[@]} -if [ "$nmods" -ne 3 ]; then - die "Expecting three modules listed, found $nmods" -fi + mods=($SYSFS_KLP_DIR/*) + nmods=${#mods[@]} + if [ "$nmods" -ne 3 ]; then + die "Expecting three modules listed, found $nmods" + fi -load_lp $MOD_REPLACE replace=1 + load_lp $MOD_REPLACE replace=1 -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -loop_until 'mods=($SYSFS_KLP_DIR/*); nmods=${#mods[@]}; [[ "$nmods" -eq 1 ]]' || - die "Expecting only one moduled listed, found $nmods" + loop_until 'mods=($SYSFS_KLP_DIR/*); nmods=${#mods[@]}; [[ "$nmods" -eq 1 ]]' || + die "Expecting only one moduled listed, found $nmods" -# These modules were disabled by the atomic replace -for mod in $MOD_LIVEPATCH3 $MOD_LIVEPATCH2 $MOD_LIVEPATCH1; do - unload_lp "$mod" -done + # These modules were disabled by the atomic replace + for mod in $MOD_LIVEPATCH3 $MOD_LIVEPATCH2 $MOD_LIVEPATCH1; do + unload_lp "$mod" + done -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -disable_lp $MOD_REPLACE -unload_lp $MOD_REPLACE + disable_lp $MOD_REPLACE + unload_lp $MOD_REPLACE -grep 'live patched' /proc/cmdline > /dev/kmsg -grep 'live patched' /proc/meminfo > /dev/kmsg + grep 'live patched' /proc/cmdline > /dev/kmsg + grep 'live patched' /proc/meminfo > /dev/kmsg -check_result "% insmod test_modules/$MOD_LIVEPATCH1.ko + check_result "% insmod test_modules/$MOD_LIVEPATCH1.ko livepatch: enabling patch '$MOD_LIVEPATCH1' livepatch: '$MOD_LIVEPATCH1': initializing patching transition livepatch: '$MOD_LIVEPATCH1': starting patching transition @@ -196,6 +200,16 @@ livepatch: '$MOD_REPLACE': starting unpatching transition livepatch: '$MOD_REPLACE': completing unpatching transition livepatch: '$MOD_REPLACE': unpatching complete % rmmod $MOD_REPLACE" +} + + +if [[ "$HAS_PROVIDES_ATTR" == "1" ]]; then + skip "multiple livepatches" "legacy replace attribute not present" + skip "atomic replace livepatch" "legacy replace attribute not present" +else + test_multiple_livepatches + test_atomic_replace_livepatch +fi # - load a target module that provides /proc/test_klp_mod_target with diff --git a/tools/testing/selftests/livepatch/test_modules/test_klp_callbacks_demo2.c b/tools/testing/selftests/livepatch/test_modules/test_klp_callbacks_demo2.c index 5417573e80af..6c46ce575f5c 100644 --- a/tools/testing/selftests/livepatch/test_modules/test_klp_callbacks_demo2.c +++ b/tools/testing/selftests/livepatch/test_modules/test_klp_callbacks_demo2.c @@ -7,9 +7,16 @@ #include <linux/kernel.h> #include <linux/livepatch.h> +#ifdef CONFIG_KLP_HAS_PROVIDES +/* + * TODO: Add provides/obsoletes module parameters for the + * provides/obsoletes based tests (to be added later). + */ +#else static int replace; module_param(replace, int, 0644); MODULE_PARM_DESC(replace, "replace (default=0)"); +#endif static const char *const module_state[] = { [MODULE_STATE_LIVE] = "[MODULE_STATE_LIVE] Normal state", @@ -72,12 +79,21 @@ static struct klp_object objs[] = { static struct klp_patch patch = { .mod = THIS_MODULE, .objs = objs, +#ifndef CONFIG_KLP_HAS_PROVIDES /* set .replace in the init function below for demo purposes */ +#endif }; static int test_klp_callbacks_demo2_init(void) { +#ifdef CONFIG_KLP_HAS_PROVIDES + /* + * TODO: Set provides/obsoletes from the module parameters + * for the provides/obsoletes based tests (to be added later). + */ +#else patch.replace = replace; +#endif return klp_enable_patch(&patch); } diff --git a/tools/testing/selftests/livepatch/test_modules/test_klp_meminfo_lp.c b/tools/testing/selftests/livepatch/test_modules/test_klp_meminfo_lp.c index f2477b217aab..0c434a27672d 100644 --- a/tools/testing/selftests/livepatch/test_modules/test_klp_meminfo_lp.c +++ b/tools/testing/selftests/livepatch/test_modules/test_klp_meminfo_lp.c @@ -7,9 +7,16 @@ #include <linux/kernel.h> #include <linux/livepatch.h> +#ifdef CONFIG_KLP_HAS_PROVIDES +/* + * TODO: Add provides/obsoletes module parameters for the + * provides/obsoletes based tests (to be added later). + */ +#else static int replace; module_param(replace, int, 0644); MODULE_PARM_DESC(replace, "replace (default=0)"); +#endif #include <linux/seq_file.h> static int livepatch_meminfo_proc_show(struct seq_file *m, void *v) @@ -36,12 +43,21 @@ static struct klp_object objs[] = { static struct klp_patch patch = { .mod = THIS_MODULE, .objs = objs, +#ifndef CONFIG_KLP_HAS_PROVIDES /* set .replace in the init function below for demo purposes */ +#endif }; static int test_klp_meminfo_lp_init(void) { +#ifdef CONFIG_KLP_HAS_PROVIDES + /* + * TODO: Set provides/obsoletes from the module parameters + * for the provides/obsoletes based tests (to be added later). + */ +#else patch.replace = replace; +#endif return klp_enable_patch(&patch); } diff --git a/tools/testing/selftests/livepatch/test_modules/test_klp_state.c b/tools/testing/selftests/livepatch/test_modules/test_klp_state.c index 57a4253acb01..4d419a58cf65 100644 --- a/tools/testing/selftests/livepatch/test_modules/test_klp_state.c +++ b/tools/testing/selftests/livepatch/test_modules/test_klp_state.c @@ -142,7 +142,14 @@ static struct klp_patch patch = { .mod = THIS_MODULE, .objs = objs, .states = states, +#ifdef CONFIG_KLP_HAS_PROVIDES + /* + * TODO: Add provides/obsoletes module parameters for the + * provides/obsoletes based tests (to be added later). + */ +#else .replace = true, +#endif }; static int test_klp_callbacks_demo_init(void) diff --git a/tools/testing/selftests/livepatch/test_modules/test_klp_state2.c b/tools/testing/selftests/livepatch/test_modules/test_klp_state2.c index c978ea4d5e67..4f70f0619967 100644 --- a/tools/testing/selftests/livepatch/test_modules/test_klp_state2.c +++ b/tools/testing/selftests/livepatch/test_modules/test_klp_state2.c @@ -171,7 +171,14 @@ static struct klp_patch patch = { .mod = THIS_MODULE, .objs = objs, .states = states, +#ifdef CONFIG_KLP_HAS_PROVIDES + /* + * TODO: Add provides/obsoletes module parameters for the + * provides/obsoletes based tests (to be added later). + */ +#else .replace = true, +#endif }; static int test_klp_callbacks_demo_init(void) -- 2.52.0
