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