Re: [PATCH v7 01/16] rust: module: add trait `ModuleMetadata`

Gary Guo
2024-12-24T20:51:30Z

On Thu, 19 Dec 2024 18:04:03 +0100
Danilo Krummrich <dakr@kernel.org> wrote:

> In order to access static metadata of a Rust kernel module, add the
> `ModuleMetadata` trait.
>
> In particular, this trait provides the name of a Rust kernel module as
> specified by the `module!` macro.
>
> Signed-off-by: Danilo Krummrich <dakr@kernel.org>

Reviewed-by: Gary Guo <gary@garyguo.net>

> ---
> rust/kernel/lib.rs | 6 ++++++
> rust/macros/module.rs | 4 ++++
> 2 files changed, 10 insertions(+)
>
> diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs
> index e1065a7551a3..61b82b78b915 100644
> --- a/rust/kernel/lib.rs
> +++ b/rust/kernel/lib.rs
> @@ -116,6 +116,12 @@ fn init(module: &'static ThisModule) -> impl init::PinInit<Self, error::Error> {
> }
> }
>
> +/// Metadata attached to a [`Module`] or [`InPlaceModule`].
> +pub trait ModuleMetadata {
> + /// The name of the module as specified in the `module!` macro.
> + const NAME: &'static crate::str::CStr;
> +}
> +
> /// Equivalent to `THIS_MODULE` in the C API.
> ///
> /// C header: [`include/linux/init.h`](srctree/include/linux/init.h)
> diff --git a/rust/macros/module.rs b/rust/macros/module.rs
> index 2587f41b0d39..cdf94f4982df 100644
> --- a/rust/macros/module.rs
> +++ b/rust/macros/module.rs
> @@ -228,6 +228,10 @@ pub(crate) fn module(ts: TokenStream) -> TokenStream {
> kernel::ThisModule::from_ptr(core::ptr::null_mut())
> }};
>
> + impl kernel::ModuleMetadata for {type_} {{
> + const NAME: &'static kernel::str::CStr = kernel::c_str!(\"{name}\");
> + }}
> +
> // Double nested modules, since then nobody can access the public items inside.
> mod __module_init {{
> mod __module_init {{