kho: add test for kexec handover
Subsystems (5)
Mike Rapoport
maintainerPATCH v2 1/1 kho: add test for kexec handover
From: "Mike Rapoport (Microsoft)" <[email protected]>
Testing kexec handover requires a kernel driver that will generate some data and preserve it with KHO on the first boot and then restore that data and verify it was preserved properly after kexec.
To facilitate such test, along with the kernel driver responsible for data generation, preservation and restoration add a script that runs a kernel in a VM with a minimal /init. The /init enables KHO, loads a kernel image for kexec and runs kexec reboot. After the boot of the kexeced kernel, the driver verifies that the data was properly preserved.
---
v2 changes:
* fix section mismatch warning in lib/test_kho.c
* address Thomas' comments about nolibc and initrd generation
v1: https://lore.kernel.org/all/[email protected]
MAINTAINERS | 1 + lib/Kconfig.debug | 21 ++ lib/Makefile | 1 + lib/test_kho.c | 305 +++++++++++++++++++++++++ tools/testing/selftests/kho/arm64.conf | 9 + tools/testing/selftests/kho/init.c | 98 ++++++++ tools/testing/selftests/kho/vmtest.sh | 185 +++++++++++++++ tools/testing/selftests/kho/x86.conf | 7 + 8 files changed, 627 insertions(+) create mode 100644 lib/test_kho.c create mode 100644 tools/testing/selftests/kho/arm64.conf create mode 100644 tools/testing/selftests/kho/init.c create mode 100755 tools/testing/selftests/kho/vmtest.sh create mode 100644 tools/testing/selftests/kho/x86.conf
MAINTAINERS +1 -0
@@ -13356,6 +13356,7 @@ F: Documentation/admin-guide/mm/kho.rst F: Documentation/core-api/kho/* F: include/linux/kexec_handover.h F: kernel/kexec_handover.c +F: tools/testing/selftests/kho/ KEYS-ENCRYPTED M: Mimi Zohar <[email protected]>
lib/Kconfig.debug +21 -0
@@ -3225,6 +3225,27 @@ config TEST_OBJPOOL If unsure, say N. +config TEST_KEXEC_HANDOVER + bool "Test for Kexec HandOver" + default n + depends on KEXEC_HANDOVER + help + This option enables test for Kexec HandOver (KHO). + The test consists of two parts: saving kernel data before kexec and + restoring the data after kexec and verifying that it was properly + handed over. This test module creates and saves data on the boot of + the first kernel and restores and verifies the data on the boot of + kexec'ed kernel. + + For detailed documentation about KHO, see Documentation/core-api/kho. + + To run the test run: + + tools/testing/selftests/kho/vmtest.sh -h + + If unsure, say N. + + config INT_POW_KUNIT_TEST tristate "Integer exponentiation (int_pow) test" if !KUNIT_ALL_TESTS depends on KUNIT
lib/Makefile +1 -0
@@ -102,6 +102,7 @@ obj-$(CONFIG_TEST_HMM) += test_hmm.o obj-$(CONFIG_TEST_FREE_PAGES) += test_free_pages.o obj-$(CONFIG_TEST_REF_TRACKER) += test_ref_tracker.o obj-$(CONFIG_TEST_OBJPOOL) += test_objpool.o +obj-$(CONFIG_TEST_KEXEC_HANDOVER) += test_kho.o obj-$(CONFIG_TEST_FPU) += test_fpu.o test_fpu-y := test_fpu_glue.o test_fpu_impl.o
lib/test_kho.c new file +305 -0
305 lines not on this page · raw message
tools/testing/selftests/kho/arm64.conf new file +9 -0
@@ -0,0 +1,9 @@ +QEMU_CMD="qemu-system-aarch64 -M virt -cpu max" +QEMU_KCONFIG=" +CONFIG_SERIAL_AMBA_PL010=y +CONFIG_SERIAL_AMBA_PL010_CONSOLE=y +CONFIG_SERIAL_AMBA_PL011=y +CONFIG_SERIAL_AMBA_PL011_CONSOLE=y +" +KERNEL_IMAGE="Image" +KERNEL_CMDLINE="console=ttyAMA0"
tools/testing/selftests/kho/init.c new file +98 -0
98 lines not on this page · raw message
tools/testing/selftests/kho/vmtest.sh new file +185 -0
185 lines not on this page · raw message
tools/testing/selftests/kho/x86.conf new file +7 -0
@@ -0,0 +1,7 @@ +QEMU_CMD=qemu-system-x86_64 +QEMU_KCONFIG=" +CONFIG_SERIAL_8250=y +CONFIG_SERIAL_8250_CONSOLE=y +" +KERNEL_IMAGE="bzImage" +KERNEL_CMDLINE="console=ttyS0"
base-commit: 89be9a83ccf1f88522317ce02f854f30d6115c41
Signature · 1 line
2.47.2
Quoted 6 lines · Mike Rapoport
From: "Mike Rapoport (Microsoft)" <[email protected]>
Testing kexec handover requires a kernel driver that will generate some data and preserve it with KHO on the first boot and then restore that data and verify it was preserved properly after kexec.
Quoted 8 lines
To facilitate such test, along with the kernel driver responsible for data generation, preservation and restoration add a script that runs a kernel in a VM with a minimal /init. The /init enables KHO, loads a kernel image for kexec and runs kexec reboot. After the boot of the kexeced kernel, the driver verifies that the data was properly preserved.
Signed-off-by Mike Rapoport (Microsoft) <[email protected]>
Looking at it while awake brought up some more nitpicks. In any case:
tools/testing/selftests/kho/init.c line 3
Quoted 9 lines
tools/testing/selftests/kho/init.c new file +3
-0@@ -0,0 +1,98 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include <errno.h>
Not actually used.
tools/testing/selftests/kho/init.c line 14
Quoted 11 lines
tools/testing/selftests/kho/init.c new file +11
-0+#include <stdio.h> +#include <unistd.h> +#include <fcntl.h> +#include <sys/syscall.h> +#include <sys/mount.h> +#include <sys/reboot.h> + +/* from arch/x86/include/asm/setup.h */ +#define COMMAND_LINE_SIZE 2048 + +/* from include/linux/kexex.h */
"kexec.h"
tools/testing/selftests/kho/init.c line 15
Quoted 1 line
tools/testing/selftests/kho/init.c new file +1
-0+#define KEXEC_FILE_NO_INITRAMFS 0x00000004
This is actually part of the UAPI headers, why not use it from there?
tools/testing/selftests/kho/init.c line 17
Quoted 2 lines
tools/testing/selftests/kho/init.c new file +2
-0+ +#define KHO_FINILIZE "/debugfs/kho/out/finalize"
KHO_FINALIZE
Quoted 86 lines
tools/testing/selftests/kho/init.c new file +81
-0+#define KERNEL_IMAGE "/kernel" + +static int mount_filesystems (void ) +{ +if (mount ("debugfs" ,"/debugfs" ,"debugfs" ,0 ,NULL ) <0 ) +return -1 ; + +return mount ("proc" ,"/proc" ,"proc" ,0 ,NULL ); +} + +static int kho_enable (void ) +{ +const char enable[] ="1" ; +int fd; + + fd =open (KHO_FINILIZE ,O_RDWR ); +if (fd <0 ) +return -1 ; + +if (write (fd, enable,sizeof (enable)) !=sizeof (enable)) +return 1 ; + +close (fd); +return 0 ; +} + +static long kexec_file_load (int kernel_fd,int initrd_fd, +unsigned long cmdline_len,const char *cmdline, +unsigned long flags) +{ +return syscall (__NR_kexec_file_load, kernel_fd, initrd_fd, cmdline_len, + cmdline, flags); +} + +static int kexec_load (void ) +{ +char cmdline[COMMAND_LINE_SIZE ]; +ssize_t len; +int fd, err; + + fd =open ("/proc/cmdline" ,O_RDONLY ); +if (fd <0 ) +return -1 ; + + len =read (fd, cmdline,sizeof (cmdline)); +close (fd); +if (len <0 ) +return -1 ; + +/* replace \n with \0 */ + cmdline[len -1 ] =0 ; + fd =open (KERNEL_IMAGE ,O_RDONLY ); +if (fd <0 ) +return -1 ; + + err =kexec_file_load (fd,-1 , len, cmdline,KEXEC_FILE_NO_INITRAMFS ); +close (fd); + +return err ? :0 ; +} + +int main (int argc,char *argv[]) +{ +if (mount_filesystems ()) + goto err_reboot; + +if (kho_enable ()) + goto err_reboot; + +if (kexec_load ()) + goto err_reboot; + +if (reboot (RB_KEXEC )) + goto err_reboot; + +return 0 ; + +err_reboot: +reboot (RB_AUTOBOOT ); +return -1 ; +}tools/testing/selftests/kho/vmtest.sh new file +0
-0
(...)
tools/testing/selftests/kho/vmtest.sh line 87
Quoted 8 lines
tools/testing/selftests/kho/vmtest.sh new file +8
-0+function mkinitrd() { + local kernel=$1 + + "$CROSS_COMPILE"gcc -s -static -Os -nostdinc -nostdlib \ + -fno-asynchronous-unwind-tables -fno-ident \ + -I "$headers_dir/include" \ + -I "$kernel_dir/tools/include/nolibc" \ + -o "$tmp_dir/init" "$test_dir/init.c"
You could build this as a userprog as part of kbuild. Then it will also work automatically with clang.
tools/testing/selftests/kho/vmtest.sh line 98
Quoted 11 lines
tools/testing/selftests/kho/vmtest.sh new file +11
-0+ + cat > "$tmp_dir/cpio_list" <<EOF +dir /dev 0755 0 0 +dir /proc 0755 0 0 +dir /debugfs 0755 0 0 +nod /dev/console 0600 0 0 c 5 1 +file /init $tmp_dir/init 0755 0 0 +file /kernel $kernel 0644 0 0 +EOF + + "$build_dir/usr/gen_init_cpio" "$tmp_dir/cpio_list" > "$initrd"
This could also be hooked up to kbuild.
Quoted 1 line
+}
(...)
Pratyush Yadav
maintainerHi Mike,
Quoted 6 lines · Mike Rapoport
From: "Mike Rapoport (Microsoft)" <[email protected]>
Testing kexec handover requires a kernel driver that will generate some data and preserve it with KHO on the first boot and then restore that data and verify it was preserved properly after kexec.
Quoted 6 lines
To facilitate such test, along with the kernel driver responsible for data generation, preservation and restoration add a script that runs a kernel in a VM with a minimal /init. The /init enables KHO, loads a kernel image for kexec and runs kexec reboot. After the boot of the kexeced kernel, the driver verifies that the data was properly preserved.
Nice! Thanks for working on this.
I see that a lot of the driver assumes KHO cleans everything up on free. That stops being true with Pasha' proposed LUO patches. The series also gets rid of the notifier chain. So this test would need a bit of a refactor once those patches land.
Other than this, I only have some minor comments below.
Quoted 9 lines
Signed-off-by Mike Rapoport (Microsoft) <[email protected]>---
v2 changes:
* fix section mismatch warning inlib/test_kho.c
* address Thomas' comments about nolibc and initrd generation
[...
Quoted 70 lines
lib/test_kho.c new file +64
-0@@ -0,0 +1,305 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* +* Test module for KHO +* Copyright (c) 2025 Microsoft Corporation. +* +* Authors: +* Saurabh Sengar <[email protected]> +* Mike Rapoport <[email protected]> +*/ + +#define pr_fmt (fmt) KBUILD_MODNAME ": " fmt + +#include <linux/mm.h> +#include <linux/gfp.h> +#include <linux/slab.h> +#include <linux/kexec.h> +#include <linux/libfdt.h> +#include <linux/module.h> +#include <linux/printk.h> +#include <linux/vmalloc.h> +#include <linux/kexec_handover.h> + +#include <net/checksum.h> + +#define KHO_TEST_MAGIC 0x4b484f21/* KHO! */ +#define KHO_TEST_FDT "kho_test" +#define KHO_TEST_COMPAT "kho-test-v1" + +static long max_mem = (PAGE_SIZE <<MAX_PAGE_ORDER ) *2 ; +module_param (max_mem, long,0644 ); + +struct kho_test_state { +unsigned int nr_folios; +struct folio **folios; +struct folio *fdt; +__wsum csum; +}; + +static struct kho_test_state kho_test_state; + +static int kho_test_notifier (struct notifier_block *self,unsigned long cmd, +void *v) +{ +struct kho_test_state *state = &kho_test_state; +struct kho_serialization *ser = v; +int err =0 ; + +switch (cmd) { +case KEXEC_KHO_ABORT : +return NOTIFY_DONE ; +case KEXEC_KHO_FINALIZE : +/* Handled below */ +break ; +default : +return NOTIFY_BAD ; + } + + err |=kho_preserve_folio (state->fdt); + err |=kho_add_subtree (ser,KHO_TEST_FDT ,folio_address (state->fdt)); + +return err ?NOTIFY_BAD :NOTIFY_DONE ; +} + +static struct notifier_block kho_test_nb = {
lib/test_kho.c line 74
Quoted 10 lines
lib/test_kho.c new file +10
-0+ .notifier_call = kho_test_notifier, +}; + +static int kho_test_save_data (struct kho_test_state *state,void *fdt) +{ + phys_addr_t *folios_info __free(kvfree) = NULL; +int err =0 ; + + folios_info =kvmalloc_array (state->nr_folios,sizeof (*folios_info), +GFP_KERNEL );
Since you copy this data into the FDT anyway, why not use fdt_property_placeholder() instead? You can just build the list directly in the FDT then and avoid the memcpy().
lib/test_kho.c line 82
Quoted 8 lines
lib/test_kho.c new file +8
-0+if (!folios_info) +return -ENOMEM ; + +for (int i =0 ; i < state->nr_folios; i++) { +struct folio *folio = state->folios[i]; +unsigned int order =folio_order (folio); + + folios_info[i] =virt_to_phys (folio_address (folio)) | order;
I did something similar for memfd preservation -- stashed some extra data into the unused bits in the physical address. Perhaps we should come up with a neat abstraction to do it more cleanly?
Not needed for this patch, just thinking out loud.
Quoted 28 lines
lib/test_kho.c new file +28
-0+ + err =kho_preserve_folio (folio); +if (err) +return err; + } + + err |=fdt_begin_node (fdt,"data" ); + err |=fdt_property (fdt,"nr_folios" , &state->nr_folios, +sizeof (state->nr_folios)); + err |=fdt_property (fdt,"folios_info" , folios_info, + state->nr_folios *sizeof (*folios_info)); + err |=fdt_property (fdt,"csum" , &state->csum,sizeof (state->csum)); + err |=fdt_end_node (fdt); + +return err; +} + +static int kho_test_prepare_fdt (struct kho_test_state *state) +{ +const char compatible[] =KHO_TEST_COMPAT ; +unsigned int magic =KHO_TEST_MAGIC ; +ssize_t fdt_size; +int err =0 ; +void *fdt; + + fdt_size = state->nr_folios *sizeof (phys_addr_t) +PAGE_SIZE ; + state->fdt =folio_alloc (GFP_KERNEL ,get_order (fdt_size)); +if (!state->fdt)
lib/test_kho.c line 120
Quoted 10 lines
lib/test_kho.c new file +10
-0+return -ENOMEM ; + + fdt =folio_address (state->fdt); + + err |=fdt_create (fdt, fdt_size); + err |=fdt_finish_reservemap (fdt); + + err |=fdt_begin_node (fdt,"" ); + err |=fdt_property (fdt,"compatible" , compatible,sizeof (compatible)); + err |=fdt_property (fdt,"magic" , &magic,sizeof (magic));
Doesn't the compatible pretty much do what magic does? Instead of a magic number, it is a "magic" string, no?
Quoted 17 lines
lib/test_kho.c new file +17
-0+ err |=kho_test_save_data (state, fdt); + err |=fdt_end_node (fdt); + + err |=fdt_finish (fdt); + +if (err) +folio_put (state->fdt); + +return err; +} + +static int kho_test_generate_data (struct kho_test_state *state) +{ +size_t alloc_size =0 ; +__wsum csum =0 ; + +while (alloc_size < max_mem) {
lib/test_kho.c line 147
Quoted 10 lines
lib/test_kho.c new file +10
-0+int order =get_random_u32 () %NR_PAGE_ORDERS ; +struct folio *folio; +unsigned int size; +void *addr; + +/* cap allocation so that we won't exceed max_mem */ +if (alloc_size + (PAGE_SIZE << order) > max_mem) { + order =get_order (max_mem - alloc_size); +if (order) + order--;
I'm guessing this is because get_order() rounds up, so you want to make sure you don't exceed max_mem due to the rounding up. If so, a comment would be nice here.
Quoted 10 lines
lib/test_kho.c new file +10
-0+ } + size =PAGE_SIZE << order; + + folio =folio_alloc (GFP_KERNEL | __GFP_NORETRY, order); +if (!folio) + goto err_free_folios; + + state->folios[state->nr_folios++] = folio; + addr =folio_address (folio); +get_random_bytes (addr, size);
lib/test_kho.c line 167
Quoted 10 lines
lib/test_kho.c new file +10
-0+ csum =csum_partial (addr, size, csum); + alloc_size += size; + } + + state->csum = csum; +return 0 ; + +err_free_folios: +for (int i =0 ; i < state->nr_folios; i++) +folio_put (state->folios[i]);
Reset state->nr_folios as well? kho_test_cleanup() reads it.
lib/test_kho.c line 174
Quoted 7 lines
lib/test_kho.c new file +7
-0+return -ENOMEM ; +} + +static int kho_test_save (void ) +{ +struct kho_test_state *state = &kho_test_state; + struct folio **folios __free(kvfree) = NULL;
The __free causes a use-after-free and double-free in kho_test_cleanup().
Quoted 24 lines
lib/test_kho.c new file +24
-0+unsigned long max_nr; +int err; + + max_mem =PAGE_ALIGN (max_mem); + max_nr = max_mem >>PAGE_SHIFT ; + + folios =kvmalloc_array (max_nr,sizeof (*state->folios),GFP_KERNEL ); +if (!folios) +return -ENOMEM ; + state->folios = folios; + + err =kho_test_generate_data (state); +if (err) +return err; + + err =kho_test_prepare_fdt (state); +if (err) +return err; + +return register_kho_notifier (&kho_test_nb); +} + +static int kho_test_restore_data (const void *fdt,int node) +{
lib/test_kho.c line 208
Quoted 10 lines
lib/test_kho.c new file +10
-0+const unsigned int *nr_folios; +const phys_addr_t *folios_info; +const __wsum *old_csum; +__wsum csum =0 ; +int len; + + node =fdt_path_offset (fdt,"/data" ); + + nr_folios =fdt_getprop (fdt, node,"nr_folios" , &len); +if (!nr_folios || len !=sizeof (*nr_folios))
Thinking out loud, this kind of pattern is repeated throughout the memfd preservation code, and likely will be used by other users of KHO as well. I suppose something like the proposed KSTATE mechanism would let us abstract these away. Something for later down the line...
Quoted 11 lines
lib/test_kho.c new file +11
-0+return -EINVAL ; + + old_csum =fdt_getprop (fdt, node,"csum" , &len); +if (!old_csum || len !=sizeof (*old_csum)) +return -EINVAL ; + + folios_info =fdt_getprop (fdt, node,"folios_info" , &len); +if (!folios_info || len !=sizeof (*folios_info) * *nr_folios) +return -EINVAL ; + +for (int i =0 ; i < *nr_folios; i++) {
lib/test_kho.c line 229
Quoted 10 lines
lib/test_kho.c new file +10
-0+unsigned int order = folios_info[i] & ~PAGE_MASK ; +phys_addr_t phys = folios_info[i] &PAGE_MASK ; +unsigned int size =PAGE_SIZE << order; +struct folio *folio; + + folio =kho_restore_folio (phys); +if (!folio) +break ; + +if (folio_order (folio) != order)
Restore and put the rest of the folios as well so they aren't leaked?
Quoted 54 lines
lib/test_kho.c new file +54
-0+break ; + + csum =csum_partial (folio_address (folio), size, csum); +folio_put (folio); + } + +if (csum != *old_csum) +return -EINVAL ; + +return 0 ; +} + +static int kho_test_restore (phys_addr_t fdt_phys) +{ +void *fdt =phys_to_virt (fdt_phys); +const unsigned int *magic; +int node, len, err; + + node =fdt_path_offset (fdt,"/" ); +if (node <0 ) +return -EINVAL ; + +if (fdt_node_check_compatible (fdt, node,KHO_TEST_COMPAT )) +return -EINVAL ; + + magic =fdt_getprop (fdt, node,"magic" , &len); +if (!magic || len !=sizeof (*magic)) +return -EINVAL ; + +if (*magic !=KHO_TEST_MAGIC ) +return -EINVAL ; + + err =kho_test_restore_data (fdt, node); +if (err) +return err; + +pr_info ("KHO restore succeeded\n" ); +return 0 ; +} + +static int __init kho_test_init (void ) +{ +phys_addr_t fdt_phys; +int err; + + err =kho_retrieve_subtree (KHO_TEST_FDT , &fdt_phys); +if (!err) +return kho_test_restore (fdt_phys); + +if (err != -ENOENT ) { +pr_warn ("failed to retrieve %s FDT: %d\n" ,KHO_TEST_FDT , err); +return err; + } +
lib/test_kho.c line 293
Quoted 10 lines
lib/test_kho.c new file +10
-0+return kho_test_save (); +} +module_init (kho_test_init); + +static void kho_test_cleanup (void ) +{ +for (int i =0 ; i < kho_test_state.nr_folios; i++) +folio_put (kho_test_state.folios[i]); + +kvfree (kho_test_state.folios);
Free state->fdt as well?
Quoted 11 lines
lib/test_kho.c new file +11
-0+} + +static void __exit kho_test_exit(void) +{ +unregister_kho_notifier (&kho_test_nb); +kho_test_cleanup (); +} +module_exit (kho_test_exit); + +MODULE_AUTHOR ("Mike Rapoport <[email protected]>" ); +MODULE_DESCRIPTION ("KHO test module" );
[...]
Signature · 2 lines
Regards, Pratyush Yadav