]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
selftests/liveupdate: add simple kexec-based selftest for LUO
authorPasha Tatashin <pasha.tatashin@soleen.com>
Tue, 25 Nov 2025 16:58:47 +0000 (11:58 -0500)
committerAndrew Morton <akpm@linux-foundation.org>
Thu, 27 Nov 2025 22:24:41 +0000 (14:24 -0800)
Introduce a kexec-based selftest, luo_kexec_simple, to validate the
end-to-end lifecycle of a Live Update Orchestrator session across a
reboot.

While existing tests verify the uAPI in a pre-reboot context, this test
ensures that the core functionality—preserving state via Kexec Handover
and restoring it in a new kernel—works as expected.

The test operates in two stages, managing its state across the reboot by
preserving a dedicated "state session" containing a memfd.  This mechanism
dogfoods the LUO feature itself for state tracking, making the test
self-contained.

The test validates the following sequence:

Stage 1 (Pre-kexec):
 - Creates a test session (test-session).
 - Creates and preserves a memfd with a known data pattern into the test
   session.
 - Creates the state-tracking session to signal progression to Stage 2.
 - Executes a kexec reboot via a helper script.

Stage 2 (Post-kexec):
 - Retrieves the state-tracking session to confirm it is in the
   post-reboot stage.
 - Retrieves the preserved test session.
 - Restores the memfd from the test session and verifies its contents
   match the original data pattern written in Stage 1.
 - Finalizes both the test and state sessions to ensure a clean
   teardown.

The test relies on a helper script (do_kexec.sh) to perform the reboot and
a shared utility library (luo_test_utils.c) for common LUO operations,
keeping the main test logic clean and focused.

Link: https://lkml.kernel.org/r/20251125165850.3389713-18-pasha.tatashin@soleen.com
Signed-off-by: Pasha Tatashin <pasha.tatashin@soleen.com>
Reviewed-by: Zhu Yanjun <yanjun.zhu@linux.dev>
Reviewed-by: Mike Rapoport (Microsoft) <rppt@kernel.org>
Tested-by: David Matlack <dmatlack@google.com>
Cc: Aleksander Lobakin <aleksander.lobakin@intel.com>
Cc: Alexander Graf <graf@amazon.com>
Cc: Alice Ryhl <aliceryhl@google.com>
Cc: Andriy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: anish kumar <yesanishhere@gmail.com>
Cc: Anna Schumaker <anna.schumaker@oracle.com>
Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Cc: Bjorn Helgaas <bhelgaas@google.com>
Cc: Borislav Betkov <bp@alien8.de>
Cc: Chanwoo Choi <cw00.choi@samsung.com>
Cc: Chen Ridong <chenridong@huawei.com>
Cc: Chris Li <chrisl@kernel.org>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Daniel Wagner <wagi@kernel.org>
Cc: Danilo Krummrich <dakr@kernel.org>
Cc: Dan Williams <dan.j.williams@intel.com>
Cc: David Hildenbrand <david@redhat.com>
Cc: David Jeffery <djeffery@redhat.com>
Cc: David Rientjes <rientjes@google.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Guixin Liu <kanie@linux.alibaba.com>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: Hugh Dickins <hughd@google.com>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Ira Weiny <ira.weiny@intel.com>
Cc: Jann Horn <jannh@google.com>
Cc: Jason Gunthorpe <jgg@nvidia.com>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: Joanthan Cameron <Jonathan.Cameron@huawei.com>
Cc: Joel Granados <joel.granados@kernel.org>
Cc: Johannes Weiner <hannes@cmpxchg.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Lennart Poettering <lennart@poettering.net>
Cc: Leon Romanovsky <leon@kernel.org>
Cc: Leon Romanovsky <leonro@nvidia.com>
Cc: Lukas Wunner <lukas@wunner.de>
Cc: Marc Rutland <mark.rutland@arm.com>
Cc: Masahiro Yamada <masahiroy@kernel.org>
Cc: Matthew Maurer <mmaurer@google.com>
Cc: Miguel Ojeda <ojeda@kernel.org>
Cc: Myugnjoo Ham <myungjoo.ham@samsung.com>
Cc: Parav Pandit <parav@nvidia.com>
Cc: Pratyush Yadav <pratyush@kernel.org>
Cc: Pratyush Yadav <ptyadav@amazon.de>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Roman Gushchin <roman.gushchin@linux.dev>
Cc: Saeed Mahameed <saeedm@nvidia.com>
Cc: Samiullah Khawaja <skhawaja@google.com>
Cc: Song Liu <song@kernel.org>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Stuart Hayes <stuart.w.hayes@gmail.com>
Cc: Tejun Heo <tj@kernel.org>
Cc: Thomas Gleinxer <tglx@linutronix.de>
Cc: Thomas Weißschuh <linux@weissschuh.net>
Cc: Vincent Guittot <vincent.guittot@linaro.org>
Cc: William Tu <witu@nvidia.com>
Cc: Yoann Congal <yoann.congal@smile.fr>
Cc: Zijun Hu <quic_zijuhu@quicinc.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
tools/testing/selftests/liveupdate/Makefile
tools/testing/selftests/liveupdate/do_kexec.sh [new file with mode: 0755]
tools/testing/selftests/liveupdate/luo_kexec_simple.c [new file with mode: 0644]
tools/testing/selftests/liveupdate/luo_test_utils.c [new file with mode: 0644]
tools/testing/selftests/liveupdate/luo_test_utils.h [new file with mode: 0644]

index 620cb4ce85af8bb9c2ca0a457fbfe220a860d2d1..bbbec633970ca6bc3173bac79ba1b55fb49a4b10 100644 (file)
@@ -1,7 +1,13 @@
 # SPDX-License-Identifier: GPL-2.0-only
 
+LIB_C += luo_test_utils.c
+
 TEST_GEN_PROGS += liveupdate
 
+TEST_GEN_PROGS_EXTENDED += luo_kexec_simple
+
+TEST_FILES += do_kexec.sh
+
 include ../lib.mk
 
 CFLAGS += $(KHDR_INCLUDES)
diff --git a/tools/testing/selftests/liveupdate/do_kexec.sh b/tools/testing/selftests/liveupdate/do_kexec.sh
new file mode 100755 (executable)
index 0000000..3c7c6ca
--- /dev/null
@@ -0,0 +1,16 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0
+set -e
+
+# Use $KERNEL and $INITRAMFS to pass custom Kernel and optional initramfs
+
+KERNEL="${KERNEL:-/boot/bzImage}"
+set -- -l -s --reuse-cmdline "$KERNEL"
+
+INITRAMFS="${INITRAMFS:-/boot/initramfs}"
+if [ -f "$INITRAMFS" ]; then
+    set -- "$@" --initrd="$INITRAMFS"
+fi
+
+kexec "$@"
+kexec -e
diff --git a/tools/testing/selftests/liveupdate/luo_kexec_simple.c b/tools/testing/selftests/liveupdate/luo_kexec_simple.c
new file mode 100644 (file)
index 0000000..d7ac1f3
--- /dev/null
@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: GPL-2.0-only
+
+/*
+ * Copyright (c) 2025, Google LLC.
+ * Pasha Tatashin <pasha.tatashin@soleen.com>
+ *
+ * A simple selftest to validate the end-to-end lifecycle of a LUO session
+ * across a single kexec reboot.
+ */
+
+#include "luo_test_utils.h"
+
+#define TEST_SESSION_NAME "test-session"
+#define TEST_MEMFD_TOKEN 0x1A
+#define TEST_MEMFD_DATA "hello kexec world"
+
+/* Constants for the state-tracking mechanism, specific to this test file. */
+#define STATE_SESSION_NAME "kexec_simple_state"
+#define STATE_MEMFD_TOKEN 999
+
+/* Stage 1: Executed before the kexec reboot. */
+static void run_stage_1(int luo_fd)
+{
+       int session_fd;
+
+       ksft_print_msg("[STAGE 1] Starting pre-kexec setup...\n");
+
+       ksft_print_msg("[STAGE 1] Creating state file for next stage (2)...\n");
+       create_state_file(luo_fd, STATE_SESSION_NAME, STATE_MEMFD_TOKEN, 2);
+
+       ksft_print_msg("[STAGE 1] Creating session '%s' and preserving memfd...\n",
+                      TEST_SESSION_NAME);
+       session_fd = luo_create_session(luo_fd, TEST_SESSION_NAME);
+       if (session_fd < 0)
+               fail_exit("luo_create_session for '%s'", TEST_SESSION_NAME);
+
+       if (create_and_preserve_memfd(session_fd, TEST_MEMFD_TOKEN,
+                                     TEST_MEMFD_DATA) < 0) {
+               fail_exit("create_and_preserve_memfd for token %#x",
+                         TEST_MEMFD_TOKEN);
+       }
+
+       close(luo_fd);
+       daemonize_and_wait();
+}
+
+/* Stage 2: Executed after the kexec reboot. */
+static void run_stage_2(int luo_fd, int state_session_fd)
+{
+       int session_fd, mfd, stage;
+
+       ksft_print_msg("[STAGE 2] Starting post-kexec verification...\n");
+
+       restore_and_read_stage(state_session_fd, STATE_MEMFD_TOKEN, &stage);
+       if (stage != 2)
+               fail_exit("Expected stage 2, but state file contains %d", stage);
+
+       ksft_print_msg("[STAGE 2] Retrieving session '%s'...\n", TEST_SESSION_NAME);
+       session_fd = luo_retrieve_session(luo_fd, TEST_SESSION_NAME);
+       if (session_fd < 0)
+               fail_exit("luo_retrieve_session for '%s'", TEST_SESSION_NAME);
+
+       ksft_print_msg("[STAGE 2] Restoring and verifying memfd (token %#x)...\n",
+                      TEST_MEMFD_TOKEN);
+       mfd = restore_and_verify_memfd(session_fd, TEST_MEMFD_TOKEN,
+                                      TEST_MEMFD_DATA);
+       if (mfd < 0)
+               fail_exit("restore_and_verify_memfd for token %#x", TEST_MEMFD_TOKEN);
+       close(mfd);
+
+       ksft_print_msg("[STAGE 2] Test data verified successfully.\n");
+       ksft_print_msg("[STAGE 2] Finalizing test session...\n");
+       if (luo_session_finish(session_fd) < 0)
+               fail_exit("luo_session_finish for test session");
+       close(session_fd);
+
+       ksft_print_msg("[STAGE 2] Finalizing state session...\n");
+       if (luo_session_finish(state_session_fd) < 0)
+               fail_exit("luo_session_finish for state session");
+       close(state_session_fd);
+
+       ksft_print_msg("\n--- SIMPLE KEXEC TEST PASSED ---\n");
+}
+
+int main(int argc, char *argv[])
+{
+       return luo_test(argc, argv, STATE_SESSION_NAME,
+                       run_stage_1, run_stage_2);
+}
diff --git a/tools/testing/selftests/liveupdate/luo_test_utils.c b/tools/testing/selftests/liveupdate/luo_test_utils.c
new file mode 100644 (file)
index 0000000..3c8721c
--- /dev/null
@@ -0,0 +1,266 @@
+// SPDX-License-Identifier: GPL-2.0-only
+
+/*
+ * Copyright (c) 2025, Google LLC.
+ * Pasha Tatashin <pasha.tatashin@soleen.com>
+ */
+
+#define _GNU_SOURCE
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <getopt.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <sys/ioctl.h>
+#include <sys/syscall.h>
+#include <sys/mman.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <errno.h>
+#include <stdarg.h>
+
+#include "luo_test_utils.h"
+
+int luo_open_device(void)
+{
+       return open(LUO_DEVICE, O_RDWR);
+}
+
+int luo_create_session(int luo_fd, const char *name)
+{
+       struct liveupdate_ioctl_create_session arg = { .size = sizeof(arg) };
+
+       snprintf((char *)arg.name, LIVEUPDATE_SESSION_NAME_LENGTH, "%.*s",
+                LIVEUPDATE_SESSION_NAME_LENGTH - 1, name);
+
+       if (ioctl(luo_fd, LIVEUPDATE_IOCTL_CREATE_SESSION, &arg) < 0)
+               return -errno;
+
+       return arg.fd;
+}
+
+int luo_retrieve_session(int luo_fd, const char *name)
+{
+       struct liveupdate_ioctl_retrieve_session arg = { .size = sizeof(arg) };
+
+       snprintf((char *)arg.name, LIVEUPDATE_SESSION_NAME_LENGTH, "%.*s",
+                LIVEUPDATE_SESSION_NAME_LENGTH - 1, name);
+
+       if (ioctl(luo_fd, LIVEUPDATE_IOCTL_RETRIEVE_SESSION, &arg) < 0)
+               return -errno;
+
+       return arg.fd;
+}
+
+int create_and_preserve_memfd(int session_fd, int token, const char *data)
+{
+       struct liveupdate_session_preserve_fd arg = { .size = sizeof(arg) };
+       long page_size = sysconf(_SC_PAGE_SIZE);
+       void *map = MAP_FAILED;
+       int mfd = -1, ret = -1;
+
+       mfd = memfd_create("test_mfd", 0);
+       if (mfd < 0)
+               return -errno;
+
+       if (ftruncate(mfd, page_size) != 0)
+               goto out;
+
+       map = mmap(NULL, page_size, PROT_WRITE, MAP_SHARED, mfd, 0);
+       if (map == MAP_FAILED)
+               goto out;
+
+       snprintf(map, page_size, "%s", data);
+       munmap(map, page_size);
+
+       arg.fd = mfd;
+       arg.token = token;
+       if (ioctl(session_fd, LIVEUPDATE_SESSION_PRESERVE_FD, &arg) < 0)
+               goto out;
+
+       ret = 0;
+out:
+       if (ret != 0 && errno != 0)
+               ret = -errno;
+       if (mfd >= 0)
+               close(mfd);
+       return ret;
+}
+
+int restore_and_verify_memfd(int session_fd, int token,
+                            const char *expected_data)
+{
+       struct liveupdate_session_retrieve_fd arg = { .size = sizeof(arg) };
+       long page_size = sysconf(_SC_PAGE_SIZE);
+       void *map = MAP_FAILED;
+       int mfd = -1, ret = -1;
+
+       arg.token = token;
+       if (ioctl(session_fd, LIVEUPDATE_SESSION_RETRIEVE_FD, &arg) < 0)
+               return -errno;
+       mfd = arg.fd;
+
+       map = mmap(NULL, page_size, PROT_READ, MAP_SHARED, mfd, 0);
+       if (map == MAP_FAILED)
+               goto out;
+
+       if (expected_data && strcmp(expected_data, map) != 0) {
+               ksft_print_msg("Data mismatch! Expected '%s', Got '%s'\n",
+                              expected_data, (char *)map);
+               ret = -EINVAL;
+               goto out_munmap;
+       }
+
+       ret = mfd;
+out_munmap:
+       munmap(map, page_size);
+out:
+       if (ret < 0 && errno != 0)
+               ret = -errno;
+       if (ret < 0 && mfd >= 0)
+               close(mfd);
+       return ret;
+}
+
+int luo_session_finish(int session_fd)
+{
+       struct liveupdate_session_finish arg = { .size = sizeof(arg) };
+
+       if (ioctl(session_fd, LIVEUPDATE_SESSION_FINISH, &arg) < 0)
+               return -errno;
+
+       return 0;
+}
+
+void create_state_file(int luo_fd, const char *session_name, int token,
+                      int next_stage)
+{
+       char buf[32];
+       int state_session_fd;
+
+       state_session_fd = luo_create_session(luo_fd, session_name);
+       if (state_session_fd < 0)
+               fail_exit("luo_create_session for state tracking");
+
+       snprintf(buf, sizeof(buf), "%d", next_stage);
+       if (create_and_preserve_memfd(state_session_fd, token, buf) < 0)
+               fail_exit("create_and_preserve_memfd for state tracking");
+
+       /*
+        * DO NOT close session FD, otherwise it is going to be unpreserved
+        */
+}
+
+void restore_and_read_stage(int state_session_fd, int token, int *stage)
+{
+       char buf[32] = {0};
+       int mfd;
+
+       mfd = restore_and_verify_memfd(state_session_fd, token, NULL);
+       if (mfd < 0)
+               fail_exit("failed to restore state memfd");
+
+       if (read(mfd, buf, sizeof(buf) - 1) < 0)
+               fail_exit("failed to read state mfd");
+
+       *stage = atoi(buf);
+
+       close(mfd);
+}
+
+void daemonize_and_wait(void)
+{
+       pid_t pid;
+
+       ksft_print_msg("[STAGE 1] Forking persistent child to hold sessions...\n");
+
+       pid = fork();
+       if (pid < 0)
+               fail_exit("fork failed");
+
+       if (pid > 0) {
+               ksft_print_msg("[STAGE 1] Child PID: %d. Resources are pinned.\n", pid);
+               ksft_print_msg("[STAGE 1] You may now perform kexec reboot.\n");
+               exit(EXIT_SUCCESS);
+       }
+
+       /* Detach from terminal so closing the window doesn't kill us */
+       if (setsid() < 0)
+               fail_exit("setsid failed");
+
+       close(STDIN_FILENO);
+       close(STDOUT_FILENO);
+       close(STDERR_FILENO);
+
+       /* Change dir to root to avoid locking filesystems */
+       if (chdir("/") < 0)
+               exit(EXIT_FAILURE);
+
+       while (1)
+               sleep(60);
+}
+
+static int parse_stage_args(int argc, char *argv[])
+{
+       static struct option long_options[] = {
+               {"stage", required_argument, 0, 's'},
+               {0, 0, 0, 0}
+       };
+       int option_index = 0;
+       int stage = 1;
+       int opt;
+
+       optind = 1;
+       while ((opt = getopt_long(argc, argv, "s:", long_options, &option_index)) != -1) {
+               switch (opt) {
+               case 's':
+                       stage = atoi(optarg);
+                       if (stage != 1 && stage != 2)
+                               fail_exit("Invalid stage argument");
+                       break;
+               default:
+                       fail_exit("Unknown argument");
+               }
+       }
+       return stage;
+}
+
+int luo_test(int argc, char *argv[],
+            const char *state_session_name,
+            luo_test_stage1_fn stage1,
+            luo_test_stage2_fn stage2)
+{
+       int target_stage = parse_stage_args(argc, argv);
+       int luo_fd = luo_open_device();
+       int state_session_fd;
+       int detected_stage;
+
+       if (luo_fd < 0) {
+               ksft_exit_skip("Failed to open %s. Is the luo module loaded?\n",
+                              LUO_DEVICE);
+       }
+
+       state_session_fd = luo_retrieve_session(luo_fd, state_session_name);
+       if (state_session_fd == -ENOENT)
+               detected_stage = 1;
+       else if (state_session_fd >= 0)
+               detected_stage = 2;
+       else
+               fail_exit("Failed to check for state session");
+
+       if (target_stage != detected_stage) {
+               ksft_exit_fail_msg("Stage mismatch Requested --stage %d, but system is in stage %d.\n"
+                                  "(State session %s: %s)\n",
+                                  target_stage, detected_stage, state_session_name,
+                                  (detected_stage == 2) ? "EXISTS" : "MISSING");
+       }
+
+       if (target_stage == 1)
+               stage1(luo_fd);
+       else
+               stage2(luo_fd, state_session_fd);
+
+       return 0;
+}
diff --git a/tools/testing/selftests/liveupdate/luo_test_utils.h b/tools/testing/selftests/liveupdate/luo_test_utils.h
new file mode 100644 (file)
index 0000000..90099bf
--- /dev/null
@@ -0,0 +1,44 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+
+/*
+ * Copyright (c) 2025, Google LLC.
+ * Pasha Tatashin <pasha.tatashin@soleen.com>
+ *
+ * Utility functions for LUO kselftests.
+ */
+
+#ifndef LUO_TEST_UTILS_H
+#define LUO_TEST_UTILS_H
+
+#include <errno.h>
+#include <string.h>
+#include <linux/liveupdate.h>
+#include "../kselftest.h"
+
+#define LUO_DEVICE "/dev/liveupdate"
+
+#define fail_exit(fmt, ...)                                            \
+       ksft_exit_fail_msg("[%s:%d] " fmt " (errno: %s)\n",     \
+                          __func__, __LINE__, ##__VA_ARGS__, strerror(errno))
+
+int luo_open_device(void);
+int luo_create_session(int luo_fd, const char *name);
+int luo_retrieve_session(int luo_fd, const char *name);
+int luo_session_finish(int session_fd);
+
+int create_and_preserve_memfd(int session_fd, int token, const char *data);
+int restore_and_verify_memfd(int session_fd, int token, const char *expected_data);
+
+void create_state_file(int luo_fd, const char *session_name, int token,
+                      int next_stage);
+void restore_and_read_stage(int state_session_fd, int token, int *stage);
+
+void daemonize_and_wait(void);
+
+typedef void (*luo_test_stage1_fn)(int luo_fd);
+typedef void (*luo_test_stage2_fn)(int luo_fd, int state_session_fd);
+
+int luo_test(int argc, char *argv[], const char *state_session_name,
+            luo_test_stage1_fn stage1, luo_test_stage2_fn stage2);
+
+#endif /* LUO_TEST_UTILS_H */