rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Alexandre Courbot" <acourbot@nvidia.com>
To: "Daniel Almeida" <daniel.almeida@collabora.com>,
	"Alexandre Courbot" <acourbot@nvidia.com>
Cc: "Danilo Krummrich" <dakr@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Trevor Gross" <tmgross@umich.edu>,
	rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] rust: io: always inline methods leading to build_assert
Date: Fri, 28 Nov 2025 09:27:41 +0900	[thread overview]
Message-ID: <DEJWHLBKP2OS.2EI14OGPEERJ0@nvidia.com> (raw)
In-Reply-To: <A1A280D4-836E-4D75-863E-30B1C276C80C@collabora.com>

On Thu Nov 27, 2025 at 11:53 PM JST, Daniel Almeida wrote:
>
>
>> On 27 Nov 2025, at 10:30, Alexandre Courbot <acourbot@nvidia.com> wrote:
>> 
>> `build_assert` relies on the compiler to optimize out its error path,
>> lest build fails with the dreaded error:
>> 
>>    ERROR: modpost: "rust_build_error" [drivers/gpu/nova-core/nova_core.ko] undefined!
>> 
>> It has been observed that very trivial code performing I/O accesses
>> (sometimes even using an immediate value) would seemingly randomly fail
>> with this error whenever `CLIPPY=1` was set. Removing the CLIPPY option
>> makes the error go away, but that's obviously not a great workaround.
>> Clippy appears to influence the way the compiler optimizes things,
>> making it on occasion generate a method where we would need it to inline
>> in order to satisfy a `build_assert`.
>> 
>> Fix this by instructing the compiler to always inline the methods
>> leading to `build_assert`. This stronger directive is effective even
>> when `CLIPPY=1` is specified, which gets rid of this error.
>> 
>> Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
>> ---
>> This is the same fix as for another build error triggered by the use of
>> `build_assert` [1], which signals that all callers of this macro should
>> all be tagged with `#[inline(always)]`, as inlining is a requirement for
>> `build_assert` to perform properly anyway.
>> 
>> [1] https://lore.kernel.org/all/DEEUYUOAEZU3.1J1HM2YQ10EX1@nvidia.com/
>> ---
>> rust/kernel/io.rs | 9 ++++++---
>> 1 file changed, 6 insertions(+), 3 deletions(-)
>> 
>> diff --git a/rust/kernel/io.rs b/rust/kernel/io.rs
>> index 98e8b84e68d1..f161ec8056ce 100644
>> --- a/rust/kernel/io.rs
>> +++ b/rust/kernel/io.rs
>> @@ -142,7 +142,8 @@ macro_rules! define_read {
>>         /// Bound checks are performed on compile time, hence if the offset is not known at compile
>>         /// time, the build will fail.
>>         $(#[$attr])*
>> -        #[inline]
>> +        // Always inline so the error path of `io_addr_assert` is optimized out.
>> +        #[inline(always)]
>>         pub fn $name(&self, offset: usize) -> $type_name {
>>             let addr = self.io_addr_assert::<$type_name>(offset);
>> 
>> @@ -171,7 +172,8 @@ macro_rules! define_write {
>>         /// Bound checks are performed on compile time, hence if the offset is not known at compile
>>         /// time, the build will fail.
>>         $(#[$attr])*
>> -        #[inline]
>> +        // Always inline so the error path of `io_addr_assert` is optimized out.
>> +        #[inline(always)]
>>         pub fn $name(&self, value: $type_name, offset: usize) {
>>             let addr = self.io_addr_assert::<$type_name>(offset);
>> 
>> @@ -239,7 +241,8 @@ fn io_addr<U>(&self, offset: usize) -> Result<usize> {
>>         self.addr().checked_add(offset).ok_or(EINVAL)
>>     }
>> 
>> -    #[inline]
>> +    // Always inline so the error path of `build_assert!` is optimized out.
>> +    #[inline(always)]
>>     fn io_addr_assert<U>(&self, offset: usize) -> usize {
>>         build_assert!(Self::offset_valid::<U>(offset, SIZE));
>> 
>> 
>> ---
>> base-commit: ea34511aaf755349999a1067b2984a541bee1492
>> change-id: 20251127-io-build-assert-3579a5bfb81c
>> 
>> Best regards,
>> -- 
>> Alexandre Courbot <acourbot@nvidia.com>
>> 
>> 
>
> Reviewed-by: Daniel Almeida <daniel.almeida@collabora.com>
>
> I also faced this with genmask, by the way, i.e.: using genmask with an
> in-bounds constant would trigger a build error. Very confusingly, this would be
> randomly solved by moving the genmask invocation around in the code.
>
> I wonder if the same fix is needed for it as well?

What you described is exactly the symptoms I was experimenting (notably
the "moving around sometimes fixes it" thing) so yeah, I think this also
applies to `bit_*` and `genmask_*` (and anything that invokes
`build_assert`, really).

  parent reply	other threads:[~2025-11-28  0:27 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-27 13:30 [PATCH] rust: io: always inline methods leading to build_assert Alexandre Courbot
2025-11-27 14:53 ` Daniel Almeida
2025-11-27 16:11   ` Miguel Ojeda
2025-11-28  0:27   ` Alexandre Courbot [this message]
2025-11-28  0:34     ` Alexandre Courbot

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DEJWHLBKP2OS.2EI14OGPEERJ0@nvidia.com \
    --to=acourbot@nvidia.com \
    --cc=a.hindborg@kernel.org \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dakr@kernel.org \
    --cc=daniel.almeida@collabora.com \
    --cc=gary@garyguo.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).