Something went wrong. Try again.
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505// SPDX-License-Identifier: GPL-2.0
//! Crate for all kernel procedural macros.
// When fixdep scans this, it will find this string `CONFIG_RUSTC_VERSION_TEXT`// and thus add a dependency on `include/config/RUSTC_VERSION_TEXT`, which is// touched by Kconfig when the version string from the compiler changes.
// Stable since Rust 1.87.0.#![feature(extract_if)]//// Stable since Rust 1.88.0 under a different name, `proc_macro_span_file`,// which was added in Rust 1.88.0. This is why `cfg_attr` is used here, i.e.// to avoid depending on the full `proc_macro_span` on Rust >= 1.88.0.#![cfg_attr(not(CONFIG_RUSTC_HAS_SPAN_FILE), feature(proc_macro_span))]
mod concat_idents;mod export;mod fmt;mod for_lt;mod helpers;mod kunit;mod module;mod paste;mod vtable;
use proc_macro::TokenStream;
use syn::parse_macro_input;
/// Declares a kernel module.////// The `type` argument should be a type which implements the [`Module`]/// trait. Also accepts various forms of kernel metadata.////// The `params` field describe module parameters. Each entry has the form////// ```ignore/// parameter_name: type {/// default: default_value,/// description: "Description",/// }/// ```////// `type` may be one of////// - [`i8`]/// - [`u8`]/// - [`i8`]/// - [`u8`]/// - [`i16`]/// - [`u16`]/// - [`i32`]/// - [`u32`]/// - [`i64`]/// - [`u64`]/// - [`isize`]/// - [`usize`]////// C header: [`include/linux/moduleparam.h`](srctree/include/linux/moduleparam.h)////// [`Module`]: ../kernel/trait.Module.html////// # Examples////// ```ignore/// use kernel::prelude::*;////// module!{/// type: MyModule,/// name: "my_kernel_module",/// authors: ["Rust for Linux Contributors"],/// description: "My very own kernel module!",/// license: "GPL",/// alias: ["alternate_module_name"],/// params: {/// my_parameter: i64 {/// default: 1,/// description: "This parameter has a default of 1",/// },/// },/// }////// struct MyModule(i32);////// impl kernel::Module for MyModule {/// fn init(_module: &'static ThisModule) -> Result<Self> {/// let foo: i32 = 42;/// pr_info!("I contain: {}\n", foo);/// pr_info!("i32 param is: {}\n", module_parameters::my_parameter.read());/// Ok(Self(foo))/// }/// }/// # fn main() {}/// ```////// ## Firmware////// The following example shows how to declare a kernel module that needs/// to load binary firmware files. You need to specify the file names of/// the firmware in the `firmware` field. The information is embedded/// in the `modinfo` section of the kernel module. For example, a tool to/// build an initramfs uses this information to put the firmware files into/// the initramfs image.////// ```/// use kernel::prelude::*;////// module!{/// type: MyDeviceDriverModule,/// name: "my_device_driver_module",/// authors: ["Rust for Linux Contributors"],/// description: "My device driver requires firmware",/// license: "GPL",/// firmware: ["my_device_firmware1.bin", "my_device_firmware2.bin"],/// }////// struct MyDeviceDriverModule;////// impl kernel::Module for MyDeviceDriverModule {/// fn init(_module: &'static ThisModule) -> Result<Self> {/// Ok(Self)/// }/// }/// # fn main() {}/// ```////// # Supported argument types/// - `type`: type which implements the [`Module`] trait (required)./// - `name`: ASCII string literal of the name of the kernel module (required)./// - `authors`: array of ASCII string literals of the authors of the kernel module./// - `description`: string literal of the description of the kernel module./// - `license`: ASCII string literal of the license of the kernel module (required)./// - `alias`: array of ASCII string literals of the alias names of the kernel module./// - `firmware`: array of ASCII string literals of the firmware files of/// the kernel module.#[proc_macro]pub fn module(input: TokenStream) -> TokenStream { module::module(parse_macro_input!(input)) .unwrap_or_else(|e| e.into_compile_error()) .into()}
/// Declares or implements a vtable trait.////// Linux's use of pure vtables is very close to Rust traits, but they differ/// in how unimplemented functions are represented. In Rust, traits can provide/// default implementation for all non-required methods (and the default/// implementation could just return `Error::EINVAL`); Linux typically use C/// `NULL` pointers to represent these functions.////// This attribute closes that gap. A trait can be annotated with the/// `#[vtable]` attribute. Implementers of the trait will then also have to/// annotate the trait with `#[vtable]`. This attribute generates a `HAS_*`/// associated constant bool for each method in the trait that is set to true if/// the implementer has overridden the associated method.////// For a trait method to be optional, it must have a default implementation./// This is also the case for traits annotated with `#[vtable]`, but in this/// case the default implementation will never be executed. The reason for this/// is that the functions will be called through function pointers installed in/// C side vtables. When an optional method is not implemented on a `#[vtable]`/// trait, a `NULL` entry is installed in the vtable. Thus the default/// implementation is never called. Since these traits are not designed to be/// used on the Rust side, it should not be possible to call the default/// implementation. This is done to ensure that we call the vtable methods/// through the C vtable, and not through the Rust vtable. Therefore, the/// default implementation should call `build_error!`, which prevents/// calls to this function at compile time:////// ```compile_fail/// # // Intentionally missing `use`s to simplify `rusttest`./// build_error!(VTABLE_DEFAULT_ERROR)/// ```////// Note that you might need to import [`kernel::error::VTABLE_DEFAULT_ERROR`].////// This macro should not be used when all functions are required.////// # Examples////// ```/// use kernel::error::VTABLE_DEFAULT_ERROR;/// use kernel::prelude::*;////// // Declares a `#[vtable]` trait/// #[vtable]/// pub trait Operations: Send + Sync + Sized {/// fn foo(&self) -> Result<()> {/// build_error!(VTABLE_DEFAULT_ERROR)/// }////// fn bar(&self) -> Result<()> {/// build_error!(VTABLE_DEFAULT_ERROR)/// }/// }////// struct Foo;////// // Implements the `#[vtable]` trait/// #[vtable]/// impl Operations for Foo {/// fn foo(&self) -> Result<()> {/// # Err(EINVAL)/// // .../// }/// }////// assert_eq!(<Foo as Operations>::HAS_FOO, true);/// assert_eq!(<Foo as Operations>::HAS_BAR, false);/// ```////// [`kernel::error::VTABLE_DEFAULT_ERROR`]: ../kernel/error/constant.VTABLE_DEFAULT_ERROR.html#[proc_macro_attribute]pub fn vtable(attr: TokenStream, input: TokenStream) -> TokenStream { parse_macro_input!(attr as syn::parse::Nothing); vtable::vtable(parse_macro_input!(input)) .unwrap_or_else(|e| e.into_compile_error()) .into()}
/// Export a function so that C code can call it via a header file.////// Functions exported using this macro can be called from C code using the declaration in the/// appropriate header file. It should only be used in cases where C calls the function through a/// header file; cases where C calls into Rust via a function pointer in a vtable (such as/// `file_operations`) should not use this macro.////// This macro has the following effect:////// * Disables name mangling for this function./// * Verifies at compile-time that the function signature matches the declaration in the header/// file.////// You must declare the signature of the Rust function in a header file that is included by/// `rust/bindings/bindings_helper.h`.////// This macro is *not* the same as the C macros `EXPORT_SYMBOL_*`. All Rust symbols are currently/// automatically exported with `EXPORT_SYMBOL_GPL`.#[proc_macro_attribute]pub fn export(attr: TokenStream, input: TokenStream) -> TokenStream { parse_macro_input!(attr as syn::parse::Nothing); export::export(parse_macro_input!(input)).into()}
/// Like [`core::format_args!`], but automatically wraps arguments in [`kernel::fmt::Adapter`].////// This macro allows generating `fmt::Arguments` while ensuring that each argument is wrapped with/// `::kernel::fmt::Adapter`, which customizes formatting behavior for kernel logging.////// Named arguments used in the format string (e.g. `{foo}`) are detected and resolved from local/// bindings. All positional and named arguments are automatically wrapped.////// This macro is an implementation detail of other kernel logging macros like [`pr_info!`] and/// should not typically be used directly.////// [`kernel::fmt::Adapter`]: ../kernel/fmt/struct.Adapter.html/// [`pr_info!`]: ../kernel/macro.pr_info.html#[proc_macro]pub fn fmt(input: TokenStream) -> TokenStream { fmt::fmt(input.into()).into()}
/// Concatenate two identifiers.////// This is useful in macros that need to declare or reference items with names/// starting with a fixed prefix and ending in a user specified name. The resulting/// identifier has the span of the second argument.////// # Examples////// ```/// # const binder_driver_return_protocol_BR_OK: u32 = 0;/// # const binder_driver_return_protocol_BR_ERROR: u32 = 1;/// # const binder_driver_return_protocol_BR_TRANSACTION: u32 = 2;/// # const binder_driver_return_protocol_BR_REPLY: u32 = 3;/// # const binder_driver_return_protocol_BR_DEAD_REPLY: u32 = 4;/// # const binder_driver_return_protocol_BR_TRANSACTION_COMPLETE: u32 = 5;/// # const binder_driver_return_protocol_BR_INCREFS: u32 = 6;/// # const binder_driver_return_protocol_BR_ACQUIRE: u32 = 7;/// # const binder_driver_return_protocol_BR_RELEASE: u32 = 8;/// # const binder_driver_return_protocol_BR_DECREFS: u32 = 9;/// # const binder_driver_return_protocol_BR_NOOP: u32 = 10;/// # const binder_driver_return_protocol_BR_SPAWN_LOOPER: u32 = 11;/// # const binder_driver_return_protocol_BR_DEAD_BINDER: u32 = 12;/// # const binder_driver_return_protocol_BR_CLEAR_DEATH_NOTIFICATION_DONE: u32 = 13;/// # const binder_driver_return_protocol_BR_FAILED_REPLY: u32 = 14;/// use kernel::macros::concat_idents;////// macro_rules! pub_no_prefix {/// ($prefix:ident, $($newname:ident),+) => {/// $(pub(crate) const $newname: u32 = concat_idents!($prefix, $newname);)+/// };/// }////// pub_no_prefix!(/// binder_driver_return_protocol_,/// BR_OK,/// BR_ERROR,/// BR_TRANSACTION,/// BR_REPLY,/// BR_DEAD_REPLY,/// BR_TRANSACTION_COMPLETE,/// BR_INCREFS,/// BR_ACQUIRE,/// BR_RELEASE,/// BR_DECREFS,/// BR_NOOP,/// BR_SPAWN_LOOPER,/// BR_DEAD_BINDER,/// BR_CLEAR_DEATH_NOTIFICATION_DONE,/// BR_FAILED_REPLY/// );////// assert_eq!(BR_OK, binder_driver_return_protocol_BR_OK);/// ```#[proc_macro]pub fn concat_idents(input: TokenStream) -> TokenStream { concat_idents::concat_idents(parse_macro_input!(input)).into()}
/// Paste identifiers together.////// Within the `paste!` macro, identifiers inside `[<` and `>]` are concatenated together to form a/// single identifier.////// This is similar to the [`paste`] crate, but with pasting feature limited to identifiers and/// literals (lifetimes and documentation strings are not supported). There is a difference in/// supported modifiers as well.////// # Examples////// ```/// # const binder_driver_return_protocol_BR_OK: u32 = 0;/// # const binder_driver_return_protocol_BR_ERROR: u32 = 1;/// # const binder_driver_return_protocol_BR_TRANSACTION: u32 = 2;/// # const binder_driver_return_protocol_BR_REPLY: u32 = 3;/// # const binder_driver_return_protocol_BR_DEAD_REPLY: u32 = 4;/// # const binder_driver_return_protocol_BR_TRANSACTION_COMPLETE: u32 = 5;/// # const binder_driver_return_protocol_BR_INCREFS: u32 = 6;/// # const binder_driver_return_protocol_BR_ACQUIRE: u32 = 7;/// # const binder_driver_return_protocol_BR_RELEASE: u32 = 8;/// # const binder_driver_return_protocol_BR_DECREFS: u32 = 9;/// # const binder_driver_return_protocol_BR_NOOP: u32 = 10;/// # const binder_driver_return_protocol_BR_SPAWN_LOOPER: u32 = 11;/// # const binder_driver_return_protocol_BR_DEAD_BINDER: u32 = 12;/// # const binder_driver_return_protocol_BR_CLEAR_DEATH_NOTIFICATION_DONE: u32 = 13;/// # const binder_driver_return_protocol_BR_FAILED_REPLY: u32 = 14;/// macro_rules! pub_no_prefix {/// ($prefix:ident, $($newname:ident),+) => {/// ::kernel::macros::paste! {/// $(pub(crate) const $newname: u32 = [<$prefix $newname>];)+/// }/// };/// }////// pub_no_prefix!(/// binder_driver_return_protocol_,/// BR_OK,/// BR_ERROR,/// BR_TRANSACTION,/// BR_REPLY,/// BR_DEAD_REPLY,/// BR_TRANSACTION_COMPLETE,/// BR_INCREFS,/// BR_ACQUIRE,/// BR_RELEASE,/// BR_DECREFS,/// BR_NOOP,/// BR_SPAWN_LOOPER,/// BR_DEAD_BINDER,/// BR_CLEAR_DEATH_NOTIFICATION_DONE,/// BR_FAILED_REPLY/// );////// assert_eq!(BR_OK, binder_driver_return_protocol_BR_OK);/// ```////// # Modifiers////// For each identifier, it is possible to attach one or multiple modifiers to/// it.////// Currently supported modifiers are:/// * `span`: change the span of concatenated identifier to the span of the specified token. By/// default the span of the `[< >]` group is used./// * `lower`: change the identifier to lower case./// * `upper`: change the identifier to upper case.////// ```/// # const binder_driver_return_protocol_BR_OK: u32 = 0;/// # const binder_driver_return_protocol_BR_ERROR: u32 = 1;/// # const binder_driver_return_protocol_BR_TRANSACTION: u32 = 2;/// # const binder_driver_return_protocol_BR_REPLY: u32 = 3;/// # const binder_driver_return_protocol_BR_DEAD_REPLY: u32 = 4;/// # const binder_driver_return_protocol_BR_TRANSACTION_COMPLETE: u32 = 5;/// # const binder_driver_return_protocol_BR_INCREFS: u32 = 6;/// # const binder_driver_return_protocol_BR_ACQUIRE: u32 = 7;/// # const binder_driver_return_protocol_BR_RELEASE: u32 = 8;/// # const binder_driver_return_protocol_BR_DECREFS: u32 = 9;/// # const binder_driver_return_protocol_BR_NOOP: u32 = 10;/// # const binder_driver_return_protocol_BR_SPAWN_LOOPER: u32 = 11;/// # const binder_driver_return_protocol_BR_DEAD_BINDER: u32 = 12;/// # const binder_driver_return_protocol_BR_CLEAR_DEATH_NOTIFICATION_DONE: u32 = 13;/// # const binder_driver_return_protocol_BR_FAILED_REPLY: u32 = 14;/// macro_rules! pub_no_prefix {/// ($prefix:ident, $($newname:ident),+) => {/// ::kernel::macros::paste! {/// $(pub(crate) const fn [<$newname:lower:span>]() -> u32 { [<$prefix $newname:span>] })+/// }/// };/// }////// pub_no_prefix!(/// binder_driver_return_protocol_,/// BR_OK,/// BR_ERROR,/// BR_TRANSACTION,/// BR_REPLY,/// BR_DEAD_REPLY,/// BR_TRANSACTION_COMPLETE,/// BR_INCREFS,/// BR_ACQUIRE,/// BR_RELEASE,/// BR_DECREFS,/// BR_NOOP,/// BR_SPAWN_LOOPER,/// BR_DEAD_BINDER,/// BR_CLEAR_DEATH_NOTIFICATION_DONE,/// BR_FAILED_REPLY/// );////// assert_eq!(br_ok(), binder_driver_return_protocol_BR_OK);/// ```////// # Literals////// Literals can also be concatenated with other identifiers:////// ```/// macro_rules! create_numbered_fn {/// ($name:literal, $val:literal) => {/// ::kernel::macros::paste! {/// fn [<some_ $name _fn $val>]() -> u32 { $val }/// }/// };/// }////// create_numbered_fn!("foo", 100);////// assert_eq!(some_foo_fn100(), 100)/// ```////// [`paste`]: https://docs.rs/paste/#[proc_macro]pub fn paste(input: TokenStream) -> TokenStream { let mut tokens = proc_macro2::TokenStream::from(input).into_iter().collect(); paste::expand(&mut tokens); tokens .into_iter() .collect::<proc_macro2::TokenStream>() .into()}
/// Registers a KUnit test suite and its test cases using a user-space like syntax.////// This macro should be used on modules. If `CONFIG_KUNIT` (in `.config`) is `n`, the target module/// is ignored.////// # Examples////// ```ignore/// # use kernel::prelude::*;/// #[kunit_tests(kunit_test_suit_name)]/// mod tests {/// #[test]/// fn foo() {/// assert_eq!(1, 1);/// }////// #[test]/// fn bar() {/// assert_eq!(2, 2);/// }/// }/// ```#[proc_macro_attribute]pub fn kunit_tests(attr: TokenStream, input: TokenStream) -> TokenStream { kunit::kunit_tests(parse_macro_input!(attr), parse_macro_input!(input)) .unwrap_or_else(|e| e.into_compile_error()) .into()}
/// Obtain a type that implements [`ForLt`] for the given higher-ranked type.////// Please refer to the documentation of the [`ForLt`] trait.////// [`ForLt`]: trait.ForLt.html#[proc_macro]// The macro shares the name with the trait.#[allow(non_snake_case)]pub fn ForLt(input: TokenStream) -> TokenStream { for_lt::for_lt(parse_macro_input!(input)).into()}