rust: kernel: remove support for unused host `#[test]`s
Subsystems (4)
Miguel Ojeda
maintainerPATCH 1/1 rust: kernel: remove support for unused host `#[test]`s
Since commit 028df914e546 ("rust: str: convert rusttest tests into KUnit"), we do not have anymore host #[test]s that run in the host.
Moreover, we do not plan to add any new ones -- tests should generally run within KUnit, since there they are built the same way the kernel does. While we may want to have some way to define tests that can also be run outside the kernel, we still want to test within the kernel too [1], and thus would likely use a custom syntax anyway to define them.
Thus simplify the rusttest target by removing support for host #[test]s for the kernel crate.
This still maintains the support for the macros crate, even though we do not have any such tests there.
--- rust/Makefile | 9 +-------- rust/kernel/alloc.rs | 6 +++--- rust/kernel/error.rs | 4 ++-- rust/kernel/lib.rs | 2 +- 4 files changed, 7 insertions(+), 14 deletions(-)
rust/Makefile +1 -8
@@ -235,7 +235,7 @@ quiet_cmd_rustc_test = $(RUSTC_OR_CLIPPY_QUIET) T $< $(objtree)/$(obj)/test/$(subst rusttest-,,$@) $(rust_test_quiet) \ $(rustc_test_run_flags) -rusttest: rusttest-macros rusttest-kernel +rusttest: rusttest-macros rusttest-macros: private rustc_target_flags = --extern proc_macro \ --extern macros --extern kernel --extern pin_init
@@ -245,13 +245,6 @@ rusttest-macros: $(src)/macros/lib.rs \ +$(call if_changed,rustc_test) +$(call if_changed,rustdoc_test) -rusttest-kernel: private rustc_target_flags = --extern ffi --extern pin_init \ - --extern build_error --extern macros --extern bindings --extern uapi -rusttest-kernel: $(src)/kernel/lib.rs rusttestlib-ffi rusttestlib-kernel \ - rusttestlib-build_error rusttestlib-macros rusttestlib-bindings \ - rusttestlib-uapi rusttestlib-pin_init FORCE - +$(call if_changed,rustc_test) - ifdef CONFIG_CC_IS_CLANG bindgen_c_flags = $(c_flags) else
rust/kernel/alloc.rs +3 -3
@@ -2,16 +2,16 @@//! Implementation of the kernel's memory allocation infrastructure. -#[cfg(not(any(test, testlib)))] +#[cfg(not(testlib))] pub mod allocator;pub mod kbox;pub mod kvec;pub mod layout; -#[cfg(any(test, testlib))] +#[cfg(testlib)] pub mod allocator_test; -#[cfg(any(test, testlib))] +#[cfg(testlib)] pub use self::allocator_testas allocator;pub use self::kbox::Box ;
rust/kernel/error.rs +2 -2
@@ -157,7 +157,7 @@ pub fn to_ptr<T>(self) -> *mut T { }/// Returns a string representing the error, if one exists. -#[cfg(not(any(test, testlib)))] +#[cfg(not(testlib))] pub fn name (&self) ->Option <&'staticCStr > {// SAFETY: Just an FFI call, there are no extra safety requirements. let ptr =unsafe { bindings::errname (-self.0 .get ()) };
@@ -174,7 +174,7 @@ pub fn name(&self) -> Option<&'static CStr> {/// When `testlib` is configured, this always returns `None` to avoid the dependency on a /// kernel function so that tests that use this (e.g., by calling [`Result::unwrap`]) can still /// run in userspace. -#[cfg(any(test, testlib))] +#[cfg(testlib)] pub fn name (&self) ->Option <&'staticCStr > {None }
rust/kernel/lib.rs +1 -1
@@ -197,7 +197,7 @@ pub const fn as_ptr(&self) -> *mut bindings::module { } } -#[cfg(not(any(testlib, test)))] +#[cfg(not(testlib))] #[panic_handler] fn panic (info: &core::panic::PanicInfo <'_>) -> ! {pr_emerg! ("{}\n" , info);
base-commit: 89be9a83ccf1f88522317ce02f854f30d6115c41
Signature · 1 line
2.50.1
Quoted 13 lines · Miguel Ojeda
Since commit
028df914e546("rust: str: convertrusttesttests into KUnit"), we do not have anymore host#[test]s that run in the host.Moreover, we do not plan to add any new ones -- tests should generally run within KUnit, since there they are built the same way the kernel does. While we may want to have some way to define tests that can also be run outside the kernel, we still want to test within the kernel too [1], and thus would likely use a custom syntax anyway to define them.
Thus simplify the
rusttesttarget by removing support for host#[test]s for thekernelcrate.
Quoted 6 lines
This still maintains the support for the
macroscrate, even though we do not have any such tests there.Link https://lore.kernel.org/rust-for-linux/CABVgOS=AKHSfifp0S68K3jgNZAkALBr=7iFb=niryG5WDxjSrg@mail.gmail.com/ [1] open hereSigned-off-by Miguel Ojeda <[email protected]>---
With my (biased) KUnit hat on, this looks good to me.
_Maybe_ it's worth updating Documentation/rust/testing.rst, though it already says these are "mostly used for testing the macros crate's examples".
Cheers,
-- David
Quoted 97 lines
rust/Makefile | 9 +-------- rust/kernel/alloc.rs | 6 +++--- rust/kernel/error.rs | 4 ++-- rust/kernel/lib.rs | 2 +- 4 files changed, 7 insertions(+), 14 deletions(-)rust/Makefile +1
-8@@ -235,7 +235,7 @@ quiet_cmd_rustc_test = $(RUSTC_OR_CLIPPY_QUIET) T $< $(objtree)/$(obj)/test/$(subst rusttest-,,$@) $(rust_test_quiet) \ $(rustc_test_run_flags) -rusttest: rusttest-macros rusttest-kernel +rusttest: rusttest-macros rusttest-macros: private rustc_target_flags = --extern proc_macro \ --extern macros --extern kernel --extern pin_init@@ -245,13 +245,6 @@ rusttest-macros: $(src)/macros/lib.rs \ +$(call if_changed,rustc_test) +$(call if_changed,rustdoc_test) -rusttest-kernel: private rustc_target_flags = --extern ffi --extern pin_init \ - --extern build_error --extern macros --extern bindings --extern uapi -rusttest-kernel: $(src)/kernel/lib.rs rusttestlib-ffi rusttestlib-kernel \ - rusttestlib-build_error rusttestlib-macros rusttestlib-bindings \ - rusttestlib-uapi rusttestlib-pin_init FORCE - +$(call if_changed,rustc_test) - ifdef CONFIG_CC_IS_CLANG bindgen_c_flags = $(c_flags) elserust/kernel/alloc.rs +3
-3@@ -2,16 +2,16 @@//! Implementation of the kernel's memory allocation infrastructure. -#[cfg(not(any(test, testlib)))] +#[cfg(not(testlib))] pub mod allocator;pub mod kbox;pub mod kvec;pub mod layout; -#[cfg(any(test, testlib))] +#[cfg(testlib)] pub mod allocator_test; -#[cfg(any(test, testlib))] +#[cfg(testlib)] pub use self::allocator_testas allocator;pub use self::kbox::Box ;rust/kernel/error.rs +2
-2@@ -157,7 +157,7 @@ pub fn to_ptr<T>(self) -> *mut T { }/// Returns a string representing the error, if one exists. -#[cfg(not(any(test, testlib)))] +#[cfg(not(testlib))] pub fn name (&self) ->Option <&'staticCStr > {// SAFETY: Just an FFI call, there are no extra safety requirements. let ptr =unsafe { bindings::errname (-self.0 .get ()) };@@ -174,7 +174,7 @@ pub fn name(&self) -> Option<&'static CStr> {/// When `testlib` is configured, this always returns `None` to avoid the dependency on a /// kernel function so that tests that use this (e.g., by calling [`Result::unwrap`]) can still /// run in userspace. -#[cfg(any(test, testlib))] +#[cfg(testlib)] pub fn name (&self) ->Option <&'staticCStr > {None }rust/kernel/lib.rs +1
-1@@ -197,7 +197,7 @@ pub const fn as_ptr(&self) -> *mut bindings::module { } } -#[cfg(not(any(testlib, test)))] +#[cfg(not(testlib))] #[panic_handler] fn panic (info: &core::panic::PanicInfo <'_>) -> ! {pr_emerg! ("{}\n" , info);base-commit:
89be9a83ccf1f88522317ce02f854f30d6115c41--
2.50.1
Quoted 9 lines · Miguel Ojeda
Since commit
028df914e546("rust: str: convertrusttesttests into KUnit"), we do not have anymore host#[test]s that run in the host.Moreover, we do not plan to add any new ones -- tests should generally run within KUnit, since there they are built the same way the kernel does. While we may want to have some way to define tests that can also be run outside the kernel, we still want to test within the kernel too [1], and thus would likely use a custom syntax anyway to define them.
Quoted 8 lines
Thus simplify the
rusttesttarget by removing support for host#[test]s for thekernelcrate.This still maintains the support for the
macroscrate, even though we do not have any such tests there.
Nice! This should also allow us to remove the Cmalloc allocator subsequently.
Quoted 2 lines · Danilo Krummrich
Nice! This should also allow us to remove the Cmalloc allocator subsequently.
Yeah, unless we want to use it in the macros crate for an example or similar -- I didn't include the removal directly here mainly to split that decision into another step, but given this other issue in rusttest I just sent:
https://lore.kernel.org/rust-for-linux/[email protected]/
I think it is easiest to just get rid of it (and anyway eventually I want to run the tests from the macros crate within the kernel too).
I have sent a patch for that here:
https://lore.kernel.org/rust-for-linux/[email protected]/
Cheers,
Miguel
Quoted 9 lines · Miguel Ojeda
Since commit
028df914e546("rust: str: convertrusttesttests into KUnit"), we do not have anymore host#[test]s that run in the host.Moreover, we do not plan to add any new ones -- tests should generally run within KUnit, since there they are built the same way the kernel does. While we may want to have some way to define tests that can also be run outside the kernel, we still want to test within the kernel too [1], and thus would likely use a custom syntax anyway to define them.
Quoted 8 lines
Thus simplify the
rusttesttarget by removing support for host#[test]s for thekernelcrate.This still maintains the support for the
macroscrate, even though we do not have any such tests there.
Applied to alloc-next, thanks!