linux-kernel - Re: [PATCH v4 3/5] rust: driver: Consolidate `Adapter` methods using `#[cfg]`

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <aEhMCVJG3c7zVbyU@cassiopeiae>
Date: Tue, 10 Jun 2025 17:15:21 +0200
From: Danilo Krummrich <dakr@...nel.org>
To: Igor Korotin <igor.korotin.linux@...il.com>
Cc: ojeda@...nel.org, alex.gaynor@...il.com, rafael@...nel.org,
	gregkh@...uxfoundation.org, linux-kernel@...r.kernel.org,
	rust-for-linux@...r.kernel.org, linux-acpi@...r.kernel.org,
	boqun.feng@...il.com, gary@...yguo.net, bjorn3_gh@...tonmail.com,
	benno.lossin@...ton.me, a.hindborg@...nel.org, aliceryhl@...gle.com,
	tmgross@...ch.edu, lenb@...nel.org, wedsonaf@...il.com,
	viresh.kumar@...aro.org, alex.hung@....com,
	dingxiangfei2009@...il.com
Subject: Re: [PATCH v4 3/5] rust: driver: Consolidate `Adapter` methods using
 `#[cfg]`

On Tue, Jun 10, 2025 at 04:05:38PM +0100, Igor Korotin wrote:
> Refactor the `acpi_id_info` and `of_id_info` methods in the `Adapter` trait
> to reduce duplication. Previously, each method had two versions selected
> via `#[cfg(...)]` and `#[cfg(not(...))]`. This change merges them into a
> single method per case by using `#[cfg]` blocks within the method bodies.
> 
> Suggested-by: Benno Lossin <lossin@...nel.org>
> Signed-off-by: Igor Korotin <igor.korotin.linux@...il.com>
> ---
>  rust/kernel/driver.rs | 76 +++++++++++++++++++++----------------------
>  1 file changed, 38 insertions(+), 38 deletions(-)
> 
> diff --git a/rust/kernel/driver.rs b/rust/kernel/driver.rs
> index 638f1d270af8..805f61bd4a50 100644
> --- a/rust/kernel/driver.rs
> +++ b/rust/kernel/driver.rs
> @@ -147,30 +147,30 @@ pub trait Adapter {
>      /// Returns the driver's private data from the matching entry in the [`acpi::IdTable`], if any.
>      ///
>      /// If this returns `None`, it means there is no match with an entry in the [`acpi::IdTable`].
> -    #[cfg(CONFIG_ACPI)]
>      fn acpi_id_info(dev: &device::Device) -> Option<&'static Self::IdInfo> {
> -        let table = Self::acpi_id_table()?;
> +        #[cfg(not(CONFIG_ACPI))] {
> +            let _ = dev;
> +            return None;
> +        }
>  
> -        // SAFETY:
> -        // - `table` has static lifetime, hence it's valid for read,
> -        // - `dev` is guaranteed to be valid while it's alive, and so is `pdev.as_ref().as_raw()`.
> -        let raw_id = unsafe { bindings::acpi_match_device(table.as_ptr(), dev.as_raw()) };
> +        #[cfg(CONFIG_ACPI)] {
> +            let table = Self::acpi_id_table()?;
>  
> -        if raw_id.is_null() {
> -            None
> -        } else {
> -            // SAFETY: `DeviceId` is a `#[repr(transparent)` wrapper of `struct of_device_id` and
> -            // does not add additional invariants, so it's safe to transmute.
> -            let id = unsafe { &*raw_id.cast::<acpi::DeviceId>() };
> +            // SAFETY:
> +            // - `table` has static lifetime, hence it's valid for read,
> +            // - `dev` is guaranteed to be valid while it's alive, and so is `pdev.as_ref().as_raw()`.
> +            let raw_id = unsafe { bindings::acpi_match_device(table.as_ptr(), dev.as_raw()) };
>  
> -            Some(table.info(<acpi::DeviceId as crate::device_id::RawDeviceId>::index(id)))
> -        }
> -    }
> +            if raw_id.is_null() {
> +                None
> +            } else {
> +                // SAFETY: `DeviceId` is a `#[repr(transparent)` wrapper of `struct of_device_id` and
> +                // does not add additional invariants, so it's safe to transmute.
> +                let id = unsafe { &*raw_id.cast::<acpi::DeviceId>() };
>  
> -    #[cfg(not(CONFIG_ACPI))]
> -    #[allow(missing_docs)]
> -    fn acpi_id_info(_dev: &device::Device) -> Option<&'static Self::IdInfo> {
> -        None
> +                Some(table.info(<acpi::DeviceId as crate::device_id::RawDeviceId>::index(id)))
> +            }
> +        }
>      }

It seems there has been a misunderstanding, the idea was to refactor
Adapter::of_id_info() in one patch and introduce Adapter::acpi_id_info() in a
subsequent patch already being the suggested implementation by Benno.

We try to avoid introducing code, just to change it again in a subsequent patch.