2022-02-11 19:25:34 +00:00
|
|
|
// SPDX-License-Identifier: GPL-2.0
|
|
|
|
|
|
|
|
|
|
//! The `kernel` prelude.
|
|
|
|
|
//!
|
|
|
|
|
//! These are the most common items used by Rust code in the kernel,
|
|
|
|
|
//! intended to be imported by all Rust code, for convenience.
|
|
|
|
|
//!
|
|
|
|
|
//! # Examples
|
|
|
|
|
//!
|
|
|
|
|
//! ```
|
|
|
|
|
//! use kernel::prelude::*;
|
|
|
|
|
//! ```
|
|
|
|
|
|
2022-12-14 09:34:51 +00:00
|
|
|
#[doc(no_inline)]
|
2022-02-11 19:25:34 +00:00
|
|
|
pub use core::pin::Pin;
|
2022-11-10 16:41:13 +00:00
|
|
|
|
2024-10-04 15:41:25 +00:00
|
|
|
pub use crate::alloc::{flags::*, Box, KBox, KVBox, KVVec, KVec, VBox, VVec, Vec};
|
2022-11-10 16:41:13 +00:00
|
|
|
|
2022-12-14 09:34:51 +00:00
|
|
|
#[doc(no_inline)]
|
rust: add #[export] macro
Rust has two different tools for generating function declarations to
call across the FFI boundary:
* bindgen. Generates Rust declarations from a C header.
* cbindgen. Generates C headers from Rust declarations.
However, we only use bindgen in the kernel. This means that when C code
calls a Rust function by name, its signature must be duplicated in both
Rust code and a C header, and the signature needs to be kept in sync
manually.
Introducing cbindgen as a mandatory dependency to build the kernel would
be a rather complex and large change, so we do not consider that at this
time. Instead, to eliminate this manual checking, introduce a new macro
that verifies at compile time that the two function declarations use the
same signature. The idea is to run the C declaration through bindgen,
and then have rustc verify that the function pointers have the same
type.
The signature must still be written twice, but at least you can no
longer get it wrong. If the signatures don't match, you will get errors
that look like this:
error[E0308]: `if` and `else` have incompatible types
--> <linux>/rust/kernel/print.rs:22:22
|
21 | #[export]
| --------- expected because of this
22 | unsafe extern "C" fn rust_fmt_argument(
| ^^^^^^^^^^^^^^^^^ expected `u8`, found `i8`
|
= note: expected fn item `unsafe extern "C" fn(*mut u8, *mut u8, *mut c_void) -> *mut u8 {bindings::rust_fmt_argument}`
found fn item `unsafe extern "C" fn(*mut i8, *mut i8, *const c_void) -> *mut i8 {print::rust_fmt_argument}`
It is unfortunate that the error message starts out by saying "`if` and
`else` have incompatible types", but I believe the rest of the error
message is reasonably clear and not too confusing.
Reviewed-by: Tamir Duberstein <tamird@gmail.com>
Reviewed-by: Andreas Hindborg <a.hindborg@kernel.org>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Alice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20250303-export-macro-v3-3-41fbad85a27f@google.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
2025-03-03 08:45:14 +00:00
|
|
|
pub use macros::{export, module, pin_data, pinned_drop, vtable, Zeroable};
|
2022-11-10 16:41:13 +00:00
|
|
|
|
2024-11-23 22:28:49 +00:00
|
|
|
pub use super::{build_assert, build_error};
|
2022-11-10 16:41:38 +00:00
|
|
|
|
2022-12-14 09:34:51 +00:00
|
|
|
// `super::std_vendor` is hidden, which makes the macro inline for some reason.
|
|
|
|
|
#[doc(no_inline)]
|
|
|
|
|
pub use super::dbg;
|
2024-10-22 21:31:45 +00:00
|
|
|
pub use super::fmt;
|
|
|
|
|
pub use super::{dev_alert, dev_crit, dev_dbg, dev_emerg, dev_err, dev_info, dev_notice, dev_warn};
|
2022-12-14 09:34:51 +00:00
|
|
|
pub use super::{pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn};
|
2022-11-10 16:41:13 +00:00
|
|
|
|
2023-04-08 12:26:17 +00:00
|
|
|
pub use super::{init, pin_init, try_init, try_pin_init};
|
|
|
|
|
|
2022-11-10 16:41:36 +00:00
|
|
|
pub use super::static_assert;
|
|
|
|
|
|
2022-11-10 16:41:23 +00:00
|
|
|
pub use super::error::{code::*, Error, Result};
|
2022-11-10 16:41:13 +00:00
|
|
|
|
2022-11-10 16:41:28 +00:00
|
|
|
pub use super::{str::CStr, ThisModule};
|
2023-04-08 12:26:17 +00:00
|
|
|
|
2025-03-08 11:04:34 +00:00
|
|
|
pub use super::init::{InPlaceWrite, Init, PinInit};
|
|
|
|
|
pub use super::init_ext::InPlaceInit;
|
2023-04-11 05:45:40 +00:00
|
|
|
|
|
|
|
|
pub use super::current;
|
