Commit 15f2f931 authored by Miguel Ojeda's avatar Miguel Ojeda
Browse files

rust: use the `build_error!` macro, not the hidden function 



Code and some examples were using the function, rather than the macro. The
macro is what is documented.

Thus move users to the macro.

Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20241123222849.350287-1-ojeda@kernel.org


[ Applied the change to the new miscdevice cases. - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 2a87f8b0

rust/kernel/block/mq/operations.rs

+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ pub trait Operations: Sized { 
    /// Called by the kernel to poll the device for completed requests. Only

    /// used for poll queues.

    fn poll() -> bool {

        crate::build_error(crate::error::VTABLE_DEFAULT_ERROR)

        crate::build_error!(crate::error::VTABLE_DEFAULT_ERROR)

    }

}

rust/kernel/miscdevice.rs

+2 −2
Original line number Diff line number Diff line
@@ -116,7 +116,7 @@ fn ioctl( 
        _cmd: u32,

        _arg: usize,

    ) -> Result<isize> {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Handler for ioctls.
@@ -132,7 +132,7 @@ fn compat_ioctl( 
        _cmd: u32,

        _arg: usize,

    ) -> Result<isize> {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }

}

rust/kernel/net/phy.rs

+9 −9
Original line number Diff line number Diff line
@@ -587,17 +587,17 @@ pub trait Driver { 


    /// Issues a PHY software reset.

    fn soft_reset(_dev: &mut Device) -> Result {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Sets up device-specific structures during discovery.

    fn probe(_dev: &mut Device) -> Result {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Probes the hardware to determine what abilities it has.

    fn get_features(_dev: &mut Device) -> Result {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Returns true if this is a suitable driver for the given phydev.
@@ -609,32 +609,32 @@ fn match_phy_device(_dev: &Device) -> bool { 
    /// Configures the advertisement and resets auto-negotiation

    /// if auto-negotiation is enabled.

    fn config_aneg(_dev: &mut Device) -> Result {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Determines the negotiated speed and duplex.

    fn read_status(_dev: &mut Device) -> Result<u16> {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Suspends the hardware, saving state if needed.

    fn suspend(_dev: &mut Device) -> Result {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Resumes the hardware, restoring state if needed.

    fn resume(_dev: &mut Device) -> Result {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Overrides the default MMD read function for reading a MMD register.

    fn read_mmd(_dev: &mut Device, _devnum: u8, _regnum: u16) -> Result<u16> {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Overrides the default MMD write function for writing a MMD register.

    fn write_mmd(_dev: &mut Device, _devnum: u8, _regnum: u16, _val: u16) -> Result {

        kernel::build_error(VTABLE_DEFAULT_ERROR)

        kernel::build_error!(VTABLE_DEFAULT_ERROR)

    }



    /// Callback for notification of link change.

rust/macros/lib.rs

+4 −4
Original line number Diff line number Diff line
@@ -123,12 +123,12 @@ pub fn module(ts: TokenStream) -> TokenStream { 
/// 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 `kernel::build_error`, which prevents

/// default implementation should call `kernel::build_error!`, which prevents

/// calls to this function at compile time:

///

/// ```compile_fail

/// # // Intentionally missing `use`s to simplify `rusttest`.

/// kernel::build_error(VTABLE_DEFAULT_ERROR)

/// kernel::build_error!(VTABLE_DEFAULT_ERROR)

/// ```

///

/// Note that you might need to import [`kernel::error::VTABLE_DEFAULT_ERROR`].
@@ -145,11 +145,11 @@ pub fn module(ts: TokenStream) -> TokenStream { 
/// #[vtable]

/// pub trait Operations: Send + Sync + Sized {

///     fn foo(&self) -> Result<()> {

///         kernel::build_error(VTABLE_DEFAULT_ERROR)

///         kernel::build_error!(VTABLE_DEFAULT_ERROR)

///     }

///

///     fn bar(&self) -> Result<()> {

///         kernel::build_error(VTABLE_DEFAULT_ERROR)

///         kernel::build_error!(VTABLE_DEFAULT_ERROR)

///     }

/// }

///