1 // SPDX-License-Identifier: GPL-2.0 2 3 //! The `kernel` crate. 4 //! 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. 7 //! 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. 10 //! 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. 13 14 #![no_std] 15 #![feature(coerce_unsized)] 16 #![feature(dispatch_from_dyn)] 17 #![feature(new_uninit)] 18 #![feature(receiver_trait)] 19 #![feature(unsize)] 20 21 // Ensure conditional compilation based on the kernel configuration works; 22 // otherwise we may silently break things like initcall handling. 23 #[cfg(not(CONFIG_RUST))] 24 compile_error!("Missing kernel configuration for conditional compilation"); 25 26 // Allow proc-macros to refer to `::kernel` inside the `kernel` crate (this crate). 27 extern crate self as kernel; 28 29 pub mod alloc; 30 #[cfg(CONFIG_BLOCK)] 31 pub mod block; 32 mod build_assert; 33 pub mod cred; 34 pub mod device; 35 pub mod error; 36 #[cfg(CONFIG_RUST_FW_LOADER_ABSTRACTIONS)] 37 pub mod firmware; 38 pub mod fs; 39 pub mod init; 40 pub mod ioctl; 41 #[cfg(CONFIG_KUNIT)] 42 pub mod kunit; 43 pub mod list; 44 #[cfg(CONFIG_NET)] 45 pub mod net; 46 pub mod page; 47 pub mod pid_namespace; 48 pub mod prelude; 49 pub mod print; 50 pub mod rbtree; 51 pub mod security; 52 pub mod seq_file; 53 pub mod sizes; 54 mod static_assert; 55 #[doc(hidden)] 56 pub mod std_vendor; 57 pub mod str; 58 pub mod sync; 59 pub mod task; 60 pub mod time; 61 pub mod types; 62 pub mod uaccess; 63 pub mod workqueue; 64 65 #[doc(hidden)] 66 pub use bindings; 67 pub use macros; 68 pub use uapi; 69 70 #[doc(hidden)] 71 pub use build_error::build_error; 72 73 /// Prefix to appear before log messages printed from within the `kernel` crate. 74 const __LOG_PREFIX: &[u8] = b"rust_kernel\0"; 75 76 /// The top level entrypoint to implementing a kernel module. 77 /// 78 /// For any teardown or cleanup operations, your type may implement [`Drop`]. 79 pub trait Module: Sized + Sync + Send { 80 /// Called at module initialization time. 81 /// 82 /// Use this method to perform whatever setup or registration your module 83 /// should do. 84 /// 85 /// Equivalent to the `module_init` macro in the C API. 86 fn init(module: &'static ThisModule) -> error::Result<Self>; 87 } 88 89 /// Equivalent to `THIS_MODULE` in the C API. 90 /// 91 /// C header: [`include/linux/export.h`](srctree/include/linux/export.h) 92 pub struct ThisModule(*mut bindings::module); 93 94 // SAFETY: `THIS_MODULE` may be used from all threads within a module. 95 unsafe impl Sync for ThisModule {} 96 97 impl ThisModule { 98 /// Creates a [`ThisModule`] given the `THIS_MODULE` pointer. 99 /// 100 /// # Safety 101 /// 102 /// The pointer must be equal to the right `THIS_MODULE`. 103 pub const unsafe fn from_ptr(ptr: *mut bindings::module) -> ThisModule { 104 ThisModule(ptr) 105 } 106 107 /// Access the raw pointer for this module. 108 /// 109 /// It is up to the user to use it correctly. 110 pub const fn as_ptr(&self) -> *mut bindings::module { 111 self.0 112 } 113 } 114 115 #[cfg(not(any(testlib, test)))] 116 #[panic_handler] 117 fn panic(info: &core::panic::PanicInfo<'_>) -> ! { 118 pr_emerg!("{}\n", info); 119 // SAFETY: FFI call. 120 unsafe { bindings::BUG() }; 121 } 122 123 /// Produces a pointer to an object from a pointer to one of its fields. 124 /// 125 /// # Safety 126 /// 127 /// The pointer passed to this macro, and the pointer returned by this macro, must both be in 128 /// bounds of the same allocation. 129 /// 130 /// # Examples 131 /// 132 /// ``` 133 /// # use kernel::container_of; 134 /// struct Test { 135 /// a: u64, 136 /// b: u32, 137 /// } 138 /// 139 /// let test = Test { a: 10, b: 20 }; 140 /// let b_ptr = &test.b; 141 /// // SAFETY: The pointer points at the `b` field of a `Test`, so the resulting pointer will be 142 /// // in-bounds of the same allocation as `b_ptr`. 143 /// let test_alias = unsafe { container_of!(b_ptr, Test, b) }; 144 /// assert!(core::ptr::eq(&test, test_alias)); 145 /// ``` 146 #[macro_export] 147 macro_rules! container_of { 148 ($ptr:expr, $type:ty, $($f:tt)*) => {{ 149 let ptr = $ptr as *const _ as *const u8; 150 let offset: usize = ::core::mem::offset_of!($type, $($f)*); 151 ptr.sub(offset) as *const $type 152 }} 153 } 154