rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Joel Fernandes <joelagnelf@nvidia.com>
To: Benno Lossin <lossin@kernel.org>
Cc: linux-kernel@vger.kernel.org, "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>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>,
	acourbot@nvidia.com, "Alistair Popple" <apopple@nvidia.com>,
	"Timur Tabi" <ttabi@nvidia.com>,
	rust-for-linux@vger.kernel.org
Subject: Re: [PATCH] rust: print: Fix issue with rust_build_error
Date: Sat, 20 Sep 2025 20:45:17 -0400	[thread overview]
Message-ID: <20250921004517.GA2101443@joelbox2> (raw)
In-Reply-To: <DCXWEV3YO443.2EUZL32P96Z0D@kernel.org>

On Sat, Sep 20, 2025 at 10:09:30PM +0200, Benno Lossin wrote:
> On Sat Sep 20, 2025 at 6:19 PM CEST, Joel Fernandes wrote:
> > When printing just before calling io.write32(), modpost fails due to
> > build_assert's missing rust_build_error symbol. The issue is that, the
> > printk arguments are passed as reference in bindings code, thus Rust
> > cannot trust its value and fails to optimize away the build_assert.
> >
> > The issue can be reproduced with the following simple snippet:
> >   let offset = 0;
> >   pr_err!("{}", offset);
> >   io.write32(base, offset);
> 
> I took a long time to understand this and I think I got it now, but
> maybe I'm still wrong: passing `offset` to `printk` via a reference
> results in the compiler thinking that the value of `offset` might be
> changed (even though its a shared reference I assume). For this reason
> the `build_assert!` used by `io.write32` cannot be optimized away.

Yes, that's correct and that's my understanding. I in fact also dumped the IR
and see that the compiler is trying to reload the pointer to the offset. I
feel this is a compiler bug, and for immutable variables, the compiler should
not be reloading them even if they are passed to external code? Because if
external code is modifying immutable variables, that is buggy anyway.

> > Fix it by just using a closure to call printk. Rust captures the
> > arguments into the closure's arguments thus breaking the dependency.
> > This can be fixed by simply creating a variable alias for each variable
> > however the closure is a simple and concise fix.
> 
> I don't think this is the fix we want to have.

Yeah its ugly, though a small workaround. IMO ideally the fix should be in
the compiler. I want to send a proposal for this in fact. I looked at the MIR
and I believe with my limited understanding, that the MIR should be issuing a
copy before making a pointer of the immutable variable if pointers to
immutable variables are being passed to external functions.

If I were to send a proposal to the Rust language to start a discussion
leading to a potential RFC stage, would you mind guiding me on doing so?

> In fact it already
> doesn't compile all of the existing code:

Oh gosh, I should have run doctests. I just did a normal build. Let me see
if I can fix this closure issue.

> 
>     error[E0277]: the `?` operator can only be used in a closure that returns `Result` or `Option` (or another type that implements `FromResidual`)
>         --> rust/doctests_kernel_generated.rs:3446:70
>          |
>     3446 |     pr_info!("The frequency at index 0 is: {:?}\n", table.freq(index)?);
>          |     -----------------------------------------------------------------^-
>          |     |                                                                |
>          |     |                                                                cannot use the `?` operator in a closure that returns `()`
>          |     this function should return `Result` or `Option` to accept `?`
> 
> (originating from `rust/kernel/cpufreq.rs:217`)
> 
> Can't we just mark the pointer properly as read-only?

I found no way yet to do that. If there is something you'd like me to try,
let me know. But even if the pointer is a C const pointer, LLVM seems to
always want to reload it.

Thanks!

 - Joel


> 
> ---
> Cheers,
> Benno
> 
> > Another approach with using const-generics for the io.write32 API was
> > investigated, but it cannot work with code that dynamically calculates
> > the write offset.
> >
> > Disassembly of users of pr_err!() with/without patch shows identical
> > code generation, thus the fix has no difference in the final binary.
> >
> > Signed-off-by: Joel Fernandes <joelagnelf@nvidia.com>

  reply	other threads:[~2025-09-21  0:45 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-20 16:19 [PATCH] rust: print: Fix issue with rust_build_error Joel Fernandes
2025-09-20 19:34 ` Boqun Feng
2025-09-21  0:53   ` Joel Fernandes
2025-09-20 20:09 ` Benno Lossin
2025-09-21  0:45   ` Joel Fernandes [this message]
2025-09-21  7:12     ` Benno Lossin
2025-09-21  9:03       ` Benno Lossin
2025-09-22 10:29       ` Gary Guo
2025-09-22 11:25         ` Miguel Ojeda
2025-09-21  9:13     ` Miguel Ojeda
2025-09-22 19:01       ` Joel Fernandes
2025-09-21 10:46 ` Alice Ryhl
2025-09-22 19:15   ` Joel Fernandes
2025-09-21 20:56 ` kernel test robot

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=20250921004517.GA2101443@joelbox2 \
    --to=joelagnelf@nvidia.com \
    --cc=a.hindborg@kernel.org \
    --cc=acourbot@nvidia.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=apopple@nvidia.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dakr@kernel.org \
    --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 \
    --cc=ttabi@nvidia.com \
    /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).