[net-next,v2] rust: net::phy scope ThisModule usage in the module_phy_driver macro

Commit Message

Rahul Rameshbabu Dec. 14, 2024, 7:43 p.m. UTC

Similar to the use of $crate::Module, ThisModule should be referred to as
$crate::ThisModule in the macro evaluation. The reason the macro previously
did not cause any errors is because all the users of the macro would use
kernel::prelude::*, bringing ThisModule into scope.

Signed-off-by: Rahul Rameshbabu <[e-mail]>
Reviewed-by: FUJITA Tomonori <[e-mail]>
Reviewed-by: Alice Ryhl <[e-mail]>
---

Notes:
    Notes:
        v1->v2:
            Dropped the Fixes: tag and target net-next.
    
        How I came up with this change:
    
            I was working on my own rust bindings and rust driver when I compared my
            macro_rule to the one used for module_phy_driver. I noticed, if I made a
            driver that does not use kernel::prelude::*, that the ThisModule type
            identifier used in the macro would cause an error without being scoped in
            the macro_rule. I believe the correct implementation for the macro is one
            where the types used are correctly expanded with needed scopes.

 rust/kernel/net/phy.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


base-commit: 9bc5c9515b4817e994579b21c32c033cbb3b0e6c

Comments

[e-mail] Dec. 17, 2024, 12:40 p.m. UTC | #1

Hello:

This patch was applied to netdev/net-next.git (main)
by Paolo Abeni <[e-mail]>:

On Sat, 14 Dec 2024 19:43:06 +0000 you wrote:
> Similar to the use of $crate::Module, ThisModule should be referred to as
> $crate::ThisModule in the macro evaluation. The reason the macro previously
> did not cause any errors is because all the users of the macro would use
> kernel::prelude::*, bringing ThisModule into scope.
> 
> Signed-off-by: Rahul Rameshbabu <[e-mail]>
> Reviewed-by: FUJITA Tomonori <[e-mail]>
> Reviewed-by: Alice Ryhl <[e-mail]>
> 
> [...]

Here is the summary with links:
  - [net-next,v2] rust: net::phy scope ThisModule usage in the module_phy_driver macro
    https://git.kernel.org/netdev/net-next/c/d22f955cc2cb

You are awesome, thank you!

Patch

diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs
index b89c681d97c0..00c3100f5ebd 100644
--- a/rust/kernel/net/phy.rs
+++ b/rust/kernel/net/phy.rs
@@ -837,7 +837,7 @@  const fn as_int(&self) -> u32 {
 ///         [::kernel::net::phy::create_phy_driver::<PhySample>()];
 ///
 ///     impl ::kernel::Module for Module {
-///         fn init(module: &'static ThisModule) -> Result<Self> {
+///         fn init(module: &'static ::kernel::ThisModule) -> Result<Self> {
 ///             let drivers = unsafe { &mut DRIVERS };
 ///             let mut reg = ::kernel::net::phy::Registration::register(
 ///                 module,
@@ -903,7 +903,7 @@  struct Module {
                 [$($crate::net::phy::create_phy_driver::<$driver>()),+];
 
             impl $crate::Module for Module {
-                fn init(module: &'static ThisModule) -> Result<Self> {
+                fn init(module: &'static $crate::ThisModule) -> Result<Self> {
                     // SAFETY: The anonymous constant guarantees that nobody else can access
                     // the `DRIVERS` static. The array is used only in the C side.
                     let drivers = unsafe { &mut DRIVERS };