Rust for Linux List
 help / color / mirror / Atom feed
From: Boqun Feng <boqun.feng@gmail.com>
To: FUJITA Tomonori <fujita.tomonori@gmail.com>
Cc: ojeda@kernel.org, peterz@infradead.org, will@kernel.org,
	a.hindborg@kernel.org, aliceryhl@google.com,
	bjorn3_gh@protonmail.com, dakr@kernel.org, gary@garyguo.net,
	lossin@kernel.org, mark.rutland@arm.com, tmgross@umich.edu,
	rust-for-linux@vger.kernel.org
Subject: Re: [PATCH v4 1/2] rust: sync: atomic: Add performance-optimal-integer-backed Flag for atomic booleans
Date: Tue, 20 Jan 2026 10:56:09 +0800	[thread overview]
Message-ID: <aW7uybpl1rIYRffg@tardis-2.local> (raw)
In-Reply-To: <20260120.080851.1721614339637284826.fujita.tomonori@gmail.com>

On Tue, Jan 20, 2026 at 08:08:51AM +0900, FUJITA Tomonori wrote:
> On Mon, 19 Jan 2026 12:10:25 +0900 (JST)
> FUJITA Tomonori <fujita.tomonori@gmail.com> wrote:
> 
> > On Mon, 19 Jan 2026 09:22:10 +0800
> > Boqun Feng <boqun.feng@gmail.com> wrote:
> > 
> >> On Thu, Jan 15, 2026 at 11:12:29AM +0900, FUJITA Tomonori wrote:
> >>> Add a new Flag enum (Clear/Set) and implement AtomicType for it, so
> >>> users can use Atomic<Flag> for boolean flags.
> >>> 
> >>> The backing integer type is an implementation detail; it may vary by
> >>> architecture and change in the future.
> >>> 
> >>> Document when Atomic<Flag> is generally preferable to Atomic<bool>: in
> >>> particular, when RMW operations such as xchg()/cmpxchg() may be used
> >>> and minimizing memory usage is not the top priority. On some
> >>> architectures without byte-sized RMW instructions, Atomic<bool> can be
> >>> slower for RMW operations.
> >>> 
> >>> Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
> >>> ---
> >>>  rust/kernel/sync/atomic.rs | 71 ++++++++++++++++++++++++++++++++++++++
> >>>  1 file changed, 71 insertions(+)
> >>> 
> >>> diff --git a/rust/kernel/sync/atomic.rs b/rust/kernel/sync/atomic.rs
> >>> index ca9cab77abf0..58f57903460f 100644
> >>> --- a/rust/kernel/sync/atomic.rs
> >>> +++ b/rust/kernel/sync/atomic.rs
> >> 
> >> I prefer we can move `Flag` into atomic/predefine.rs, I queued in
> >> rust-sync with the following version, please let me know whether it
> >> works, thank you all!
> > 
> > Works for me, thanks!
> 
> If we like to keep the intra-doc-links, a workaround like the
> followings seems to be necessary.
> 
> diff --git a/rust/kernel/sync/atomic/predefine.rs b/rust/kernel/sync/atomic/predefine.rs
> index f6c7538cb47b..92e312c06595 100644
> --- a/rust/kernel/sync/atomic/predefine.rs
> +++ b/rust/kernel/sync/atomic/predefine.rs
> @@ -156,6 +156,13 @@ fn rhs_into_delta(rhs: usize) -> isize_atomic_repr {
>  /// flag.store(Flag::Set, Relaxed);
>  /// assert_eq!(Flag::Set, flag.load(Relaxed));
>  /// ```
> +///
> +/// [`Atomic<Flag>`]: kernel::sync::atomic::Atomic
> +/// [`Atomic<bool>`]: kernel::sync::atomic::Atomic
> +/// [`Atomic::xchg()`]: kernel::sync::atomic::Atomic::xchg
> +/// [`Atomic::cmpxchg()`]: kernel::sync::atomic::Atomic::cmpxchg
> +/// [`Atomic::load()`]: kernel::sync::atomic::Atomic::load
> +/// [`Atomic::store()`]: kernel::sync::atomic::Atomic::store
>  #[derive(Clone, Copy, PartialEq, Eq)]
>  #[cfg_attr(any(CONFIG_X86_64, CONFIG_UML, CONFIG_ARM, CONFIG_ARM64), repr(i8))]
>  #[cfg_attr(
> 


Good point! I was missing that, however I think we could use `super`
instead of `kernel::sync::atomic` in this case. Already pushed to
rust-sync with the following changes, thanks!

Regards,
Boqun

------------->8
diff --git a/rust/kernel/sync/atomic/predefine.rs b/rust/kernel/sync/atomic/predefine.rs
index f6c7538cb47b..5faa2fe2f4b6 100644
--- a/rust/kernel/sync/atomic/predefine.rs
+++ b/rust/kernel/sync/atomic/predefine.rs
@@ -156,6 +156,13 @@ fn rhs_into_delta(rhs: usize) -> isize_atomic_repr {
 /// flag.store(Flag::Set, Relaxed);
 /// assert_eq!(Flag::Set, flag.load(Relaxed));
 /// ```
+///
+/// [`Atomic<Flag>`]: super::Atomic
+/// [`Atomic<bool>`]: super::Atomic
+/// [`Atomic::xchg()`]: super::Atomic::xchg
+/// [`Atomic::cmpxchg()`]: super::Atomic::cmpxchg
+/// [`Atomic::load()`]: super::Atomic::load
+/// [`Atomic::store()`]: super::Atomic::store
 #[derive(Clone, Copy, PartialEq, Eq)]
 #[cfg_attr(any(CONFIG_X86_64, CONFIG_UML, CONFIG_ARM, CONFIG_ARM64), repr(i8))]
 #[cfg_attr(

  reply	other threads:[~2026-01-20  2:56 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-15  2:12 [PATCH v4 0/2] rust: sync: atomic flag helpers FUJITA Tomonori
2026-01-15  2:12 ` [PATCH v4 1/2] rust: sync: atomic: Add performance-optimal-integer-backed Flag for atomic booleans FUJITA Tomonori
2026-01-15 13:22   ` Gary Guo
2026-01-19  1:22   ` Boqun Feng
2026-01-19  3:10     ` FUJITA Tomonori
2026-01-19 23:08       ` FUJITA Tomonori
2026-01-20  2:56         ` Boqun Feng [this message]
2026-01-15  2:12 ` [PATCH v4 2/2] rust: sync: atomic: Add AtomicFlag bool wrapper for easier use FUJITA Tomonori
2026-01-15 13:22   ` Gary Guo
2026-01-15  6:41 ` [PATCH v4 0/2] rust: sync: atomic flag helpers Alice Ryhl
2026-01-15  8:59   ` FUJITA Tomonori

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=aW7uybpl1rIYRffg@tardis-2.local \
    --to=boqun.feng@gmail.com \
    --cc=a.hindborg@kernel.org \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=dakr@kernel.org \
    --cc=fujita.tomonori@gmail.com \
    --cc=gary@garyguo.net \
    --cc=lossin@kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=ojeda@kernel.org \
    --cc=peterz@infradead.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    --cc=will@kernel.org \
    /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