linux-modules.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Benno Lossin" <lossin@kernel.org>
To: "Andreas Hindborg" <a.hindborg@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>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Masahiro Yamada" <masahiroy@kernel.org>,
	"Nathan Chancellor" <nathan@kernel.org>,
	"Luis Chamberlain" <mcgrof@kernel.org>,
	"Danilo Krummrich" <dakr@kernel.org>,
	"Nicolas Schier" <nicolas.schier@linux.dev>
Cc: "Trevor Gross" <tmgross@umich.edu>,
	"Adam Bratschi-Kaye" <ark.email@gmail.com>,
	<rust-for-linux@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<linux-kbuild@vger.kernel.org>,
	"Petr Pavlu" <petr.pavlu@suse.com>,
	"Sami Tolvanen" <samitolvanen@google.com>,
	"Daniel Gomez" <da.gomez@samsung.com>,
	"Simona Vetter" <simona.vetter@ffwll.ch>,
	"Greg KH" <gregkh@linuxfoundation.org>,
	"Fiona Behrens" <me@kloenk.dev>,
	"Daniel Almeida" <daniel.almeida@collabora.com>,
	<linux-modules@vger.kernel.org>
Subject: Re: [PATCH v13 1/6] rust: str: add radix prefixed integer parsing functions
Date: Wed, 18 Jun 2025 22:38:00 +0200	[thread overview]
Message-ID: <DAPY5HF9HGXC.FCEKAMLPFY1H@kernel.org> (raw)
In-Reply-To: <20250612-module-params-v3-v13-1-bc219cd1a3f8@kernel.org>

On Thu Jun 12, 2025 at 3:40 PM CEST, Andreas Hindborg wrote:
> +pub trait ParseInt: private::FromStrRadix + TryFrom<u64> {
> +    /// Parse a string according to the description in [`Self`].
> +    fn from_str(src: &BStr) -> Result<Self> {
> +        match src.deref() {
> +            [b'-', rest @ ..] => {
> +                let (radix, digits) = strip_radix(rest.as_ref());
> +                // 2's complement values range from -2^(b-1) to 2^(b-1)-1.
> +                // So if we want to parse negative numbers as positive and
> +                // later multiply by -1, we have to parse into a larger
> +                // integer. We choose `u64` as sufficiently large.
> +                //
> +                // NOTE: 128 bit integers are not available on all
> +                // platforms, hence the choice of 64 bits.
> +                let val =
> +                    u64::from_str_radix(core::str::from_utf8(digits).map_err(|_| EINVAL)?, radix)
> +                        .map_err(|_| EINVAL)?;
> +
> +                if val > Self::abs_min() {
> +                    return Err(EINVAL);
> +                }
> +
> +                if val == Self::abs_min() {
> +                    return Ok(Self::MIN);
> +                }
> +
> +                // SAFETY: We checked that `val` will fit in `Self` above.

Sorry that it took me this long to realize, but this seems pretty weird.
I guess this is why the `FromStrRadix` is `unsafe`.

Can we just move this part of the code to `FromStrRadix` and make that
trait safe?

So essentially have:

    fn from_u64(value: u64) -> Result<Self>;

in `FromStrRadix` and remove `MIN`, `abs_min` and `complement`. Then
implement it like this in the macro below:

    const ABS_MIN = /* existing abs_min impl */;
    if value > ABS_MIN {
        return Err(EINVAL);
    }
    if val == ABS_MIN {
        return Ok(<$ty>::MIN);
    }
    // SAFETY: We checked that `val` will fit in `Self` above.
    let val: $ty = unsafe { val.try_into().unwrap_unchecked() };
    (!val).wrapping_add(1)

The reason that this is fine and the above is "weird" is the following:
The current version only has `Self: FromStrRadix` which gives it access
to the following guarantee from the `unsafe` trait:

    /// The member functions of this trait must be implemented according to
    /// their documentation.
    ///
    /// [`&BStr`]: kernel::str::BStr

This doesn't mention `TryFrom<u64>` and thus the comment "We checked
that `val` will fit in `Self` above" doesn't really apply: how does
checking with the bounds given in `FromStrRadix` make `TryFrom` return
`Ok`?

If we move this code into the implementation of `FromStrRadix`, then we
are locally in a context where we *know* the concrete type of `Self` and
can thus rely on "checking" being the correct thing for `TryFrom`.

With this adjustment, I can give my RB, but please let me take a look
before you send it again :)

---
Cheers,
Benno

> +                let val: Self = unsafe { val.try_into().unwrap_unchecked() };
> +
> +                Ok(val.complement())
> +            }
> +            _ => {
> +                let (radix, digits) = strip_radix(src);
> +                Self::from_str_radix(digits, radix).map_err(|_| EINVAL)
> +            }
> +        }
> +    }
> +}

  reply	other threads:[~2025-06-18 20:38 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-12 13:40 [PATCH v13 0/6] rust: extend `module!` macro with integer parameter support Andreas Hindborg
2025-06-12 13:40 ` [PATCH v13 1/6] rust: str: add radix prefixed integer parsing functions Andreas Hindborg
2025-06-18 20:38   ` Benno Lossin [this message]
2025-06-19 11:12     ` Andreas Hindborg
2025-06-19 12:17       ` Benno Lossin
2025-06-19 12:41         ` Andreas Hindborg
2025-06-12 13:40 ` [PATCH v13 2/6] rust: introduce module_param module Andreas Hindborg
2025-06-18 20:59   ` Benno Lossin
2025-06-19 12:20     ` Andreas Hindborg
2025-06-19 12:55       ` Benno Lossin
2025-06-20 10:31         ` Andreas Hindborg
2025-06-19 13:15   ` Benno Lossin
2025-06-20 11:29     ` Andreas Hindborg
2025-06-20 11:52       ` Andreas Hindborg
2025-06-20 12:28       ` Benno Lossin
2025-06-23  9:44         ` Andreas Hindborg
2025-06-23 11:48           ` Benno Lossin
2025-06-23 12:37             ` Miguel Ojeda
2025-06-23 13:55               ` Benno Lossin
2025-06-23 14:31             ` Andreas Hindborg
2025-06-23 15:20               ` Benno Lossin
2025-06-24 11:57                 ` Andreas Hindborg
2025-06-27  7:57                   ` Andreas Hindborg
2025-06-27  8:23                     ` Benno Lossin
2025-06-30 11:18                       ` Andreas Hindborg
2025-06-30 12:27                         ` Benno Lossin
2025-06-30 13:15                           ` Andreas Hindborg
2025-06-30 19:02                             ` Benno Lossin
2025-07-01  8:43                               ` Andreas Hindborg
2025-07-01  9:05                                 ` Benno Lossin
2025-07-01 14:14                                   ` Andreas Hindborg
2025-07-01 15:43                                     ` Benno Lossin
2025-07-01 16:27                                       ` Miguel Ojeda
2025-07-01 16:54                                         ` Benno Lossin
2025-07-02  8:30                                           ` Andreas Hindborg
2025-07-02  8:26                                         ` Andreas Hindborg
2025-07-02 10:01                                           ` Benno Lossin
2025-07-02  7:56                                       ` Andreas Hindborg
2025-06-23  9:47         ` Andreas Hindborg
2025-06-12 13:40 ` [PATCH v13 3/6] rust: module: use a reference in macros::module::module Andreas Hindborg
2025-06-18 20:07   ` Benno Lossin
2025-06-12 13:40 ` [PATCH v13 4/6] rust: module: update the module macro with module parameter support Andreas Hindborg
2025-06-18 21:07   ` Benno Lossin
2025-06-19 12:31     ` Andreas Hindborg
2025-06-12 13:40 ` [PATCH v13 5/6] rust: samples: add a module parameter to the rust_minimal sample Andreas Hindborg
2025-06-18 19:48   ` Benno Lossin
2025-06-30 11:30   ` Danilo Krummrich
2025-06-30 12:12     ` Andreas Hindborg
2025-06-30 12:18       ` Danilo Krummrich
2025-06-30 12:23         ` Danilo Krummrich
2025-06-30 12:31           ` Benno Lossin
2025-06-12 13:40 ` [PATCH v13 6/6] modules: add rust modules files to MAINTAINERS Andreas Hindborg

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=DAPY5HF9HGXC.FCEKAMLPFY1H@kernel.org \
    --to=lossin@kernel.org \
    --cc=a.hindborg@kernel.org \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=ark.email@gmail.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=da.gomez@samsung.com \
    --cc=dakr@kernel.org \
    --cc=daniel.almeida@collabora.com \
    --cc=gary@garyguo.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kbuild@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-modules@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=mcgrof@kernel.org \
    --cc=me@kloenk.dev \
    --cc=nathan@kernel.org \
    --cc=nicolas.schier@linux.dev \
    --cc=ojeda@kernel.org \
    --cc=petr.pavlu@suse.com \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=samitolvanen@google.com \
    --cc=simona.vetter@ffwll.ch \
    --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).