60f18c225f
This macro provides similar functionality to the unstable feature
`concat_idents` without having to rely on it.
For instance:
let x_1 = 42;
let x_2 = concat_idents!(x, _1);
assert!(x_1 == x_2);
It has different behavior with respect to macro hygiene. Unlike
the unstable `concat_idents!` macro, it allows, for example,
referring to local variables by taking the span of the second
macro as span for the output identifier.
Signed-off-by: Björn Roy Baron <bjorn3_gh@protonmail.com>
Reviewed-by: Finn Behrens <me@kloenk.dev>
Reviewed-by: Gary Guo <gary@garyguo.net>
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
117 lines
3.3 KiB
Rust
117 lines
3.3 KiB
Rust
// SPDX-License-Identifier: GPL-2.0
|
|
|
|
//! Crate for all kernel procedural macros.
|
|
|
|
mod concat_idents;
|
|
mod helpers;
|
|
mod module;
|
|
|
|
use proc_macro::TokenStream;
|
|
|
|
/// Declares a kernel module.
|
|
///
|
|
/// The `type` argument should be a type which implements the [`Module`]
|
|
/// trait. Also accepts various forms of kernel metadata.
|
|
///
|
|
/// C header: [`include/linux/moduleparam.h`](../../../include/linux/moduleparam.h)
|
|
///
|
|
/// [`Module`]: ../kernel/trait.Module.html
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```ignore
|
|
/// use kernel::prelude::*;
|
|
///
|
|
/// module!{
|
|
/// type: MyModule,
|
|
/// name: b"my_kernel_module",
|
|
/// author: b"Rust for Linux Contributors",
|
|
/// description: b"My very own kernel module!",
|
|
/// license: b"GPL",
|
|
/// params: {
|
|
/// my_i32: i32 {
|
|
/// default: 42,
|
|
/// permissions: 0o000,
|
|
/// description: b"Example of i32",
|
|
/// },
|
|
/// writeable_i32: i32 {
|
|
/// default: 42,
|
|
/// permissions: 0o644,
|
|
/// description: b"Example of i32",
|
|
/// },
|
|
/// },
|
|
/// }
|
|
///
|
|
/// struct MyModule;
|
|
///
|
|
/// impl kernel::Module for MyModule {
|
|
/// fn init() -> Result<Self> {
|
|
/// // If the parameter is writeable, then the kparam lock must be
|
|
/// // taken to read the parameter:
|
|
/// {
|
|
/// let lock = THIS_MODULE.kernel_param_lock();
|
|
/// pr_info!("i32 param is: {}\n", writeable_i32.read(&lock));
|
|
/// }
|
|
/// // If the parameter is read only, it can be read without locking
|
|
/// // the kernel parameters:
|
|
/// pr_info!("i32 param is: {}\n", my_i32.read());
|
|
/// Ok(Self)
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
///
|
|
/// # Supported argument types
|
|
/// - `type`: type which implements the [`Module`] trait (required).
|
|
/// - `name`: byte array of the name of the kernel module (required).
|
|
/// - `author`: byte array of the author of the kernel module.
|
|
/// - `description`: byte array of the description of the kernel module.
|
|
/// - `license`: byte array of the license of the kernel module (required).
|
|
/// - `alias`: byte array of alias name of the kernel module.
|
|
#[proc_macro]
|
|
pub fn module(ts: TokenStream) -> TokenStream {
|
|
module::module(ts)
|
|
}
|
|
|
|
/// 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
|
|
///
|
|
/// ```ignore
|
|
/// use kernel::macro::concat_idents;
|
|
///
|
|
/// macro_rules! pub_no_prefix {
|
|
/// ($prefix:ident, $($newname:ident),+) => {
|
|
/// $(pub(crate) const $newname: u32 = kernel::macros::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(ts: TokenStream) -> TokenStream {
|
|
concat_idents::concat_idents(ts)
|
|
}
|