All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alice Ryhl <aliceryhl@google.com>
To: Alexandre Courbot <acourbot@nvidia.com>
Cc: "Danilo Krummrich" <dakr@kernel.org>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Joel Fernandes" <joelagnelf@nvidia.com>,
	"Yury Norov" <yury.norov@gmail.com>,
	"Jesung Yang" <y.j3ms.n@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>,
	linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org
Subject: Re: [PATCH v3 2/4] rust: num: add Bounded integer wrapping type
Date: Thu, 6 Nov 2025 09:53:10 +0000	[thread overview]
Message-ID: <aQxwBn6wOarZ5ApN@google.com> (raw)
In-Reply-To: <20251106-bounded_ints-v3-2-47104986a5c3@nvidia.com>

On Thu, Nov 06, 2025 at 04:07:14PM +0900, Alexandre Courbot wrote:
> Add the `Bounded` integer wrapper type, which restricts the number of
> bits allowed to represent of value.
> 
> This is useful to e.g. enforce guarantees when working with bitfields
> that have an arbitrary number of bits.
> 
> Alongside this type, provide many `From` and `TryFrom` implementations
> are to reduce friction when using with regular integer types. Proxy
> implementations of common integer operations are also provided.
> 
> Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
> ---
>  rust/kernel/num.rs         |    3 +
>  rust/kernel/num/bounded.rs | 1045 ++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 1048 insertions(+)
> 
> diff --git a/rust/kernel/num.rs b/rust/kernel/num.rs
> index 3f85e50b8632..bc9abcc3a317 100644
> --- a/rust/kernel/num.rs
> +++ b/rust/kernel/num.rs
> @@ -4,6 +4,9 @@
>  
>  use core::ops;
>  
> +pub mod bounded;
> +pub use bounded::*;
> +
>  /// Designates unsigned primitive types.
>  pub struct Unsigned(());
>  
> diff --git a/rust/kernel/num/bounded.rs b/rust/kernel/num/bounded.rs
> new file mode 100644
> index 000000000000..2e4bc4ce9af5
> --- /dev/null
> +++ b/rust/kernel/num/bounded.rs
> @@ -0,0 +1,1045 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +//! Implementation of [`Bounded`], a wrapper around integer types limiting the number of bits
> +//! usable for value representation.
> +
> +use core::{
> +    cmp,
> +    fmt,
> +    ops::{
> +        self,
> +        Deref, //
> +    }, //,
> +};
> +
> +use kernel::{
> +    num::Integer,
> +    prelude::*, //
> +};
> +
> +/// Evaluates to `true` if `$value` can be represented using at most `$n` bits in a `$type`.
> +///
> +/// Can be used in const context.
> +macro_rules! fits_within {
> +    ($value:expr, $type:ty, $n:expr) => {{
> +        let shift: u32 = <$type>::BITS - $n;
> +
> +        // `value` fits within `$n` bits if shifting it left by the number of unused bits, then
> +        // right by the same number, doesn't change it.
> +        //
> +        // This method has the benefit of working for both unsigned and signed values.
> +        ($value << shift) >> shift == $value

I'm still confused about whether this works or not for signed values.

I guess for a signed 4-bit int, the range of values is -8 to 7, so those
are the values that this shift should preserve the values of. Is that
what it does?

Alice

  reply	other threads:[~2025-11-06  9:53 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-06  7:07 [PATCH v3 0/4] rust: add Bounded integer type Alexandre Courbot
2025-11-06  7:07 ` [PATCH v3 1/4] rust: add num module and Integer trait Alexandre Courbot
2025-11-06  9:46   ` Alice Ryhl
2025-11-06 11:05     ` Alexandre Courbot
2025-11-06  7:07 ` [PATCH v3 2/4] rust: num: add Bounded integer wrapping type Alexandre Courbot
2025-11-06  9:53   ` Alice Ryhl [this message]
2025-11-06 11:45     ` Alexandre Courbot
2025-11-06  7:07 ` [PATCH v3 3/4] MAINTAINERS: add entry for the Rust `num` module Alexandre Courbot
2025-11-06  7:07 ` [PATCH FOR REFERENCE v3 4/4] gpu: nova-core: use BitInt for bitfields 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=aQxwBn6wOarZ5ApN@google.com \
    --to=aliceryhl@google.com \
    --cc=a.hindborg@kernel.org \
    --cc=acourbot@nvidia.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dakr@kernel.org \
    --cc=gary@garyguo.net \
    --cc=joelagnelf@nvidia.com \
    --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=y.j3ms.n@gmail.com \
    --cc=yury.norov@gmail.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.