sample: rust: Add a selftest module

fbq · fbq · commit 235092f2caaf · 2022-07-08T15:54:29.000-07:00
This provides a temporary place to put "pure tests" for Rust
funtionality and wrappers.

Signed-off-by: Boqun Feng &lt;boqun.feng@gmail.com&gt;
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -363,6 +363,11 @@ jobs:
           grep '] rust_semaphore_c: Rust semaphore sample (in C, for comparison) (init)$' qemu-stdout.log
           grep '] rust_semaphore_c: Rust semaphore sample (in C, for comparison) (exit)$' qemu-stdout.log
 
+      - run: |
+          grep '] rust_selftests: Rust self tests (init)$' qemu-stdout.log
+          grep '] rust_selftests: All tests passed. Congratulations!$' qemu-stdout.log
+          grep '] rust_selftests: Rust self tests (exit)$' qemu-stdout.log
+
       # Report
       - run: |
           cat ${{ env.BUILD_DIR }}.config
diff --git a/.github/workflows/kernel-arm-debug.config b/.github/workflows/kernel-arm-debug.config
@@ -1781,6 +1781,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 # CONFIG_STRICT_DEVMEM is not set
 
 #
diff --git a/.github/workflows/kernel-arm-release.config b/.github/workflows/kernel-arm-release.config
@@ -1705,6 +1705,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 # CONFIG_STRICT_DEVMEM is not set
 
 #
@@ -1789,4 +1790,4 @@ CONFIG_RUST_KERNEL_KUNIT_TEST=y
 # end of Rust hacking
 # end of Kernel hacking
 
-CONFIG_WERROR=y
+CONFIG_WERROR=y
diff --git a/.github/workflows/kernel-arm64-debug-thinlto.config b/.github/workflows/kernel-arm64-debug-thinlto.config
@@ -1438,6 +1438,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 
 #
 # arm64 Debugging
diff --git a/.github/workflows/kernel-arm64-debug.config b/.github/workflows/kernel-arm64-debug.config
@@ -1433,6 +1433,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 
 #
 # arm64 Debugging
diff --git a/.github/workflows/kernel-arm64-release-thinlto.config b/.github/workflows/kernel-arm64-release-thinlto.config
@@ -1356,6 +1356,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 
 #
 # arm64 Debugging
@@ -1397,4 +1398,4 @@ CONFIG_RUST_KERNEL_KUNIT_TEST=y
 # end of Rust hacking
 # end of Kernel hacking
 
-CONFIG_WERROR=y
+CONFIG_WERROR=y
diff --git a/.github/workflows/kernel-arm64-release.config b/.github/workflows/kernel-arm64-release.config
@@ -1351,6 +1351,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 
 #
 # arm64 Debugging
@@ -1392,4 +1393,4 @@ CONFIG_RUST_KERNEL_KUNIT_TEST=y
 # end of Rust hacking
 # end of Kernel hacking
 
-CONFIG_WERROR=y
+CONFIG_WERROR=y
diff --git a/.github/workflows/kernel-ppc64le-debug.config b/.github/workflows/kernel-ppc64le-debug.config
@@ -1493,6 +1493,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 CONFIG_ARCH_HAS_DEVMEM_IS_ALLOWED=y
 # CONFIG_STRICT_DEVMEM is not set
 
diff --git a/.github/workflows/kernel-ppc64le-release.config b/.github/workflows/kernel-ppc64le-release.config
@@ -1455,6 +1455,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 CONFIG_ARCH_HAS_DEVMEM_IS_ALLOWED=y
 # CONFIG_STRICT_DEVMEM is not set
 
@@ -1500,4 +1501,4 @@ CONFIG_RUST_KERNEL_KUNIT_TEST=y
 # end of Rust hacking
 # end of Kernel hacking
 
-CONFIG_WERROR=y
+CONFIG_WERROR=y
diff --git a/.github/workflows/kernel-riscv64-debug.config b/.github/workflows/kernel-riscv64-debug.config
@@ -1287,6 +1287,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 # CONFIG_STRICT_DEVMEM is not set
 
 #
diff --git a/.github/workflows/kernel-riscv64-release.config b/.github/workflows/kernel-riscv64-release.config
@@ -1203,6 +1203,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 # CONFIG_STRICT_DEVMEM is not set
 
 #
@@ -1239,4 +1240,4 @@ CONFIG_RUST_KERNEL_KUNIT_TEST=y
 # end of Rust hacking
 # end of Kernel hacking
 
-CONFIG_WERROR=y
+CONFIG_WERROR=y
diff --git a/.github/workflows/kernel-x86_64-debug-thinlto.config b/.github/workflows/kernel-x86_64-debug-thinlto.config
@@ -1442,6 +1442,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 CONFIG_ARCH_HAS_DEVMEM_IS_ALLOWED=y
 # CONFIG_STRICT_DEVMEM is not set
 
diff --git a/.github/workflows/kernel-x86_64-debug.config b/.github/workflows/kernel-x86_64-debug.config
@@ -1445,6 +1445,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 CONFIG_ARCH_HAS_DEVMEM_IS_ALLOWED=y
 # CONFIG_STRICT_DEVMEM is not set
 
diff --git a/.github/workflows/kernel-x86_64-release-thinlto.config b/.github/workflows/kernel-x86_64-release-thinlto.config
@@ -1398,6 +1398,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 CONFIG_ARCH_HAS_DEVMEM_IS_ALLOWED=y
 # CONFIG_STRICT_DEVMEM is not set
 
@@ -1447,4 +1448,4 @@ CONFIG_RUST_KERNEL_KUNIT_TEST=y
 # end of Rust hacking
 # end of Kernel hacking
 
-CONFIG_WERROR=y
+CONFIG_WERROR=y
diff --git a/.github/workflows/kernel-x86_64-release.config b/.github/workflows/kernel-x86_64-release.config
@@ -1393,6 +1393,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m
 CONFIG_SAMPLE_RUST_SEMAPHORE_C=m
 CONFIG_SAMPLE_RUST_RANDOM=m
 CONFIG_SAMPLE_RUST_HOSTPROGS=y
+CONFIG_SAMPLE_RUST_SELFTESTS=m
 CONFIG_ARCH_HAS_DEVMEM_IS_ALLOWED=y
 # CONFIG_STRICT_DEVMEM is not set
 
@@ -1442,4 +1443,4 @@ CONFIG_RUST_KERNEL_KUNIT_TEST=y
 # end of Rust hacking
 # end of Kernel hacking
 
-CONFIG_WERROR=y
+CONFIG_WERROR=y
diff --git a/.github/workflows/qemu-init.sh b/.github/workflows/qemu-init.sh
@@ -27,6 +27,9 @@ busybox  rmmod rust_semaphore.ko
 busybox insmod rust_semaphore_c.ko
 busybox  rmmod rust_semaphore_c.ko
 
+busybox insmod rust_selftests.ko
+busybox  rmmod rust_selftests.ko
+
 busybox insmod rust_module_parameters_loadable_default.ko
 busybox insmod rust_module_parameters_loadable_custom.ko \
     my_bool=n \
diff --git a/.github/workflows/qemu-initramfs.desc b/.github/workflows/qemu-initramfs.desc
@@ -14,6 +14,7 @@ file    /rust_miscdev.ko            samples/rust/rust_miscdev.ko            0755
 file    /rust_stack_probing.ko      samples/rust/rust_stack_probing.ko      0755 0 0
 file    /rust_semaphore.ko          samples/rust/rust_semaphore.ko          0755 0 0
 file    /rust_semaphore_c.ko        samples/rust/rust_semaphore_c.ko        0755 0 0
+file    /rust_selftests.ko          samples/rust/rust_selftests.ko          0755 0 0
 
 file    /rust_module_parameters_loadable_default.ko  samples/rust/rust_module_parameters_loadable_default.ko  0755 0 0
 file    /rust_module_parameters_loadable_custom.ko   samples/rust/rust_module_parameters_loadable_custom.ko   0755 0 0
diff --git a/samples/rust/Kconfig b/samples/rust/Kconfig
@@ -155,4 +155,11 @@ config SAMPLE_RUST_HOSTPROGS
 
 	  If unsure, say N.
 
+config SAMPLE_RUST_SELFTESTS
+	tristate "Self tests"
+	help
+	  This option builds the self test cases for Rust.
+
+	  If unsure, say N.
+
 endif # SAMPLES_RUST
diff --git a/samples/rust/Makefile b/samples/rust/Makefile
@@ -14,5 +14,6 @@ obj-$(CONFIG_SAMPLE_RUST_PLATFORM)		+= rust_platform.o
 obj-$(CONFIG_SAMPLE_RUST_NETFILTER)		+= rust_netfilter.o
 obj-$(CONFIG_SAMPLE_RUST_ECHO_SERVER)		+= rust_echo_server.o
 obj-$(CONFIG_SAMPLE_RUST_FS)			+= rust_fs.o
+obj-$(CONFIG_SAMPLE_RUST_SELFTESTS)		+= rust_selftests.o
 
 subdir-$(CONFIG_SAMPLE_RUST_HOSTPROGS)		+= hostprogs
diff --git a/samples/rust/rust_selftests.rs b/samples/rust/rust_selftests.rs
@@ -0,0 +1,99 @@
+// SPDX-License-Identifier: GPL-2.0
+
+//! Self test cases for Rust.
+
+use kernel::prelude::*;
+// Keep the `use` for a test in its test function. Module-level `use`s are only for the test
+// framework.
+
+module! {
+    type: RustSelftests,
+    name: b"rust_selftests",
+    author: b"Rust for Linux Contributors",
+    description: b"Self test cases for Rust",
+    license: b"GPL",
+}
+
+struct RustSelftests;
+
+/// A summary of testing.
+///
+/// A test can
+///
+/// * pass (successfully), or
+/// * fail (without hitting any error), or
+/// * hit an error (interrupted).
+///
+/// This is the type that differentiates the first two (pass and fail) cases.
+///
+/// When a test hits an error, the test function should skip and return the error. Note that this
+/// doesn't mean the test fails, for example if the system doesn't have enough memory for
+/// testing, the test function may return an `Err(ENOMEM)` and skip.
+#[allow(dead_code)]
+enum TestSummary {
+    Pass,
+    Fail,
+}
+
+use TestSummary::Fail;
+use TestSummary::Pass;
+
+macro_rules! do_tests {
+    ($($name:ident),*) => {
+        let mut total = 0;
+        let mut pass = 0;
+        let mut fail = 0;
+
+        $({
+            total += 1;
+
+            match $name() {
+                Ok(Pass) => {
+                    pass += 1;
+                    pr_info!("{} passed!", stringify!($name));
+                },
+                Ok(Fail) => {
+                    fail += 1;
+                    pr_info!("{} failed!", stringify!($name));
+                },
+                Err(err) => {
+                    pr_info!("{} hit error {:?}", stringify!($name), err);
+                }
+            }
+        })*
+
+        pr_info!("{} tests run, {} passed, {} failed, {} hit errors\n",
+                 total, pass, fail, total - pass - fail);
+
+        if total == pass {
+            pr_info!("All tests passed. Congratulations!\n");
+        }
+    }
+}
+
+/// An example of test.
+#[allow(dead_code)]
+fn test_example() -> Result<TestSummary> {
+    // `use` declarations for the test can be put here, e.g. `use foo::bar;`.
+
+    // Always pass.
+    Ok(Pass)
+}
+
+impl kernel::Module for RustSelftests {
+    fn init(_name: &'static CStr, _module: &'static ThisModule) -> Result<Self> {
+        pr_info!("Rust self tests (init)\n");
+
+        do_tests! {
+            test_example // TODO: Remove when there is at least a real test.
+        };
+
+        Ok(RustSelftests)
+    }
+}
+
+impl Drop for RustSelftests {
+    fn drop(&mut self) {
+        pr_info!("Rust self tests (exit)\n");
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1781,6 +1781,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m`
`1781`	`1781`	`CONFIG_SAMPLE_RUST_SEMAPHORE_C=m`
`1782`	`1782`	`CONFIG_SAMPLE_RUST_RANDOM=m`
`1783`	`1783`	`CONFIG_SAMPLE_RUST_HOSTPROGS=y`
	`1784`	`+CONFIG_SAMPLE_RUST_SELFTESTS=m`
`1784`	`1785`	`# CONFIG_STRICT_DEVMEM is not set`
`1785`	`1786`
`1786`	`1787`	`#`
Original file line number	Diff line number	Diff line change
`@@ -1438,6 +1438,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m`
`1438`	`1438`	`CONFIG_SAMPLE_RUST_SEMAPHORE_C=m`
`1439`	`1439`	`CONFIG_SAMPLE_RUST_RANDOM=m`
`1440`	`1440`	`CONFIG_SAMPLE_RUST_HOSTPROGS=y`
	`1441`	`+CONFIG_SAMPLE_RUST_SELFTESTS=m`
`1441`	`1442`
`1442`	`1443`	`#`
`1443`	`1444`	`# arm64 Debugging`
Original file line number	Diff line number	Diff line change
`@@ -1433,6 +1433,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m`
`1433`	`1433`	`CONFIG_SAMPLE_RUST_SEMAPHORE_C=m`
`1434`	`1434`	`CONFIG_SAMPLE_RUST_RANDOM=m`
`1435`	`1435`	`CONFIG_SAMPLE_RUST_HOSTPROGS=y`
	`1436`	`+CONFIG_SAMPLE_RUST_SELFTESTS=m`
`1436`	`1437`
`1437`	`1438`	`#`
`1438`	`1439`	`# arm64 Debugging`
Original file line number	Diff line number	Diff line change
`@@ -1287,6 +1287,7 @@ CONFIG_SAMPLE_RUST_SEMAPHORE=m`
`1287`	`1287`	`CONFIG_SAMPLE_RUST_SEMAPHORE_C=m`
`1288`	`1288`	`CONFIG_SAMPLE_RUST_RANDOM=m`
`1289`	`1289`	`CONFIG_SAMPLE_RUST_HOSTPROGS=y`
	`1290`	`+CONFIG_SAMPLE_RUST_SELFTESTS=m`
`1290`	`1291`	`# CONFIG_STRICT_DEVMEM is not set`
`1291`	`1292`
`1292`	`1293`	`#`