1 // SPDX-License-Identifier: GPL-2.0
3 //! The `kernel` crate.
5 //! This crate contains the kernel APIs that have been ported or wrapped for
6 //! usage by Rust code in the kernel and is shared by all of them.
8 //! In other words, all the rest of the Rust code in the kernel (e.g. kernel
9 //! modules written in Rust) depends on [`core`], [`alloc`] and this crate.
11 //! If you need a kernel C API that is not ported or wrapped yet here, then
12 //! do so first instead of bypassing this crate.
15 #![feature(allocator_api)]
16 #![feature(coerce_unsized)]
17 #![feature(dispatch_from_dyn)]
18 #![feature(new_uninit)]
19 #![feature(offset_of)]
20 #![feature(ptr_metadata)]
21 #![feature(receiver_trait)]
24 // Ensure conditional compilation based on the kernel configuration works;
25 // otherwise we may silently break things like initcall handling.
26 #[cfg(not(CONFIG_RUST))]
27 compile_error!("Missing kernel configuration for conditional compilation");
29 // Allow proc-macros to refer to `::kernel` inside the `kernel` crate (this crate).
30 extern crate self as kernel;
58 pub use build_error::build_error;
60 /// Prefix to appear before log messages printed from within the `kernel` crate.
61 const __LOG_PREFIX: &[u8] = b"rust_kernel\0";
63 /// The top level entrypoint to implementing a kernel module.
65 /// For any teardown or cleanup operations, your type may implement [`Drop`].
66 pub trait Module: Sized + Sync {
67 /// Called at module initialization time.
69 /// Use this method to perform whatever setup or registration your module
72 /// Equivalent to the `module_init` macro in the C API.
73 fn init(module: &'static ThisModule) -> error::Result<Self>;
76 /// Equivalent to `THIS_MODULE` in the C API.
78 /// C header: `include/linux/export.h`
79 pub struct ThisModule(*mut bindings::module);
81 // SAFETY: `THIS_MODULE` may be used from all threads within a module.
82 unsafe impl Sync for ThisModule {}
85 /// Creates a [`ThisModule`] given the `THIS_MODULE` pointer.
89 /// The pointer must be equal to the right `THIS_MODULE`.
90 pub const unsafe fn from_ptr(ptr: *mut bindings::module) -> ThisModule {
95 #[cfg(not(any(testlib, test)))]
97 fn panic(info: &core::panic::PanicInfo<'_>) -> ! {
98 pr_emerg!("{}\n", info);
100 unsafe { bindings::BUG() };