mirror of
https://github.com/torvalds/linux.git
synced 2025-11-03 01:59:51 +02:00
3d5bef5d47
Rust kernel code is supposed to use the custom mapping of C FFI types, i.e. those from the `ffi` crate, rather than the ones coming from `core`. Thus, to minimize mistakes and to simplify the code everywhere, just provide them in the `kernel` prelude and ask in the Coding Guidelines to use them directly, i.e. as a single segment path. After this lands, we can start cleaning up the existing users. Ideally, we would use something like Clippy's `disallowed-types` to prevent the use of the `core` ones, but that one sees through aliases. Link: https://lore.kernel.org/rust-for-linux/CANiq72kc4gzfieD-FjuWfELRDXXD2vLgPv4wqk3nt4pjdPQ=qg@mail.gmail.com/ Reviewed-by: Danilo Krummrich <dakr@kernel.org> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Link: https://lore.kernel.org/r/20250413005650.1745894-1-ojeda@kernel.org [ Reworded content of the documentation to focus on how to use the aliases first. - Miguel ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
48 lines
1.3 KiB
Rust
48 lines
1.3 KiB
Rust
// 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::*;
|
|
//! ```
|
|
|
|
#[doc(no_inline)]
|
|
pub use core::pin::Pin;
|
|
|
|
pub use ::ffi::{
|
|
c_char, c_int, c_long, c_longlong, c_schar, c_short, c_uchar, c_uint, c_ulong, c_ulonglong,
|
|
c_ushort, c_void,
|
|
};
|
|
|
|
pub use crate::alloc::{flags::*, Box, KBox, KVBox, KVVec, KVec, VBox, VVec, Vec};
|
|
|
|
#[doc(no_inline)]
|
|
pub use macros::{export, module, vtable};
|
|
|
|
pub use pin_init::{init, pin_data, pin_init, pinned_drop, InPlaceWrite, Init, PinInit, Zeroable};
|
|
|
|
pub use super::{build_assert, build_error};
|
|
|
|
// `super::std_vendor` is hidden, which makes the macro inline for some reason.
|
|
#[doc(no_inline)]
|
|
pub use super::dbg;
|
|
pub use super::fmt;
|
|
pub use super::{dev_alert, dev_crit, dev_dbg, dev_emerg, dev_err, dev_info, dev_notice, dev_warn};
|
|
pub use super::{pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn};
|
|
|
|
pub use super::{try_init, try_pin_init};
|
|
|
|
pub use super::static_assert;
|
|
|
|
pub use super::error::{code::*, Error, Result};
|
|
|
|
pub use super::{str::CStr, ThisModule};
|
|
|
|
pub use super::init::InPlaceInit;
|
|
|
|
pub use super::current;
|