public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Alice Ryhl <aliceryhl@google.com>
To: Andreas Hindborg <a.hindborg@kernel.org>
Cc: "Will Deacon" <will@kernel.org>,
	"Peter Zijlstra" <peterz@infradead.org>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Mark Rutland" <mark.rutland@arm.com>,
	"Gary Guo" <gary@garyguo.net>, "Miguel Ojeda" <ojeda@kernel.org>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>,
	linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org
Subject: Re: [PATCH v3 3/3] rust: atomic: update a safety comment in impl of `fetch_add`
Date: Fri, 20 Feb 2026 10:20:25 +0000	[thread overview]
Message-ID: <aZg1aSHfrvZPaao0@google.com> (raw)
In-Reply-To: <20260220-atomic-sub-v3-3-e63cbed1d2aa@kernel.org>

On Fri, Feb 20, 2026 at 09:06:22AM +0100, Andreas Hindborg wrote:
> The safety comment used in the implementation of `fetch_add` could be read
> as just saying something it is true without justifying it. Update the
> safety comment to include justification.
> 
> Signed-off-by: Andreas Hindborg <a.hindborg@kernel.org>

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

>  rust/kernel/sync/atomic/internal.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/rust/kernel/sync/atomic/internal.rs b/rust/kernel/sync/atomic/internal.rs
> index a094f704be0ce..67745c44e710b 100644
> --- a/rust/kernel/sync/atomic/internal.rs
> +++ b/rust/kernel/sync/atomic/internal.rs
> @@ -258,7 +258,7 @@ fn add[](a: &AtomicRepr<Self>, v: Self::Delta) {
>          /// Atomically updates `*a` to `(*a).wrapping_add(v)`, and returns the value of `*a`
>          /// before the update.
>          fn fetch_add[acquire, release, relaxed](a: &AtomicRepr<Self>, v: Self::Delta) -> Self {
> -            // SAFETY: `a.as_ptr()` is valid and properly aligned.
> +            // SAFETY: `a.as_ptr()` guarantees the returned pointer is valid and properly aligned.

Perhaps more natural wording is:

	SAFETY: `a.as_ptr()` always returns a pointer that is valid and properly aligned.

Because I doubt `as_ptr()` documents these things explicitly. (To be
clear, I don't think as_ptr() needs to do so - that'd be really
verbose.)

Anyway, it's fine like this too.

Alice

  reply	other threads:[~2026-02-20 10:20 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-20  8:06 [PATCH v3 0/3] rust: atomic: add `fetch_sub` and update docs Andreas Hindborg
2026-02-20  8:06 ` [PATCH v3 1/3] rust: atomic: add fetch_sub Andreas Hindborg
2026-02-20  8:06 ` [PATCH v3 2/3] rust: atomic: update documentation for `fetch_add` Andreas Hindborg
2026-02-20  8:06 ` [PATCH v3 3/3] rust: atomic: update a safety comment in impl of `fetch_add` Andreas Hindborg
2026-02-20 10:20   ` Alice Ryhl [this message]
2026-02-20 18:51     ` Miguel Ojeda
2026-02-21  8:47       ` Alice Ryhl
2026-02-23 18:04 ` [PATCH v3 0/3] rust: atomic: add `fetch_sub` and update docs Boqun Feng
2026-02-24 11:34   ` Andreas Hindborg
2026-02-24 18:53   ` Miguel Ojeda

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=aZg1aSHfrvZPaao0@google.com \
    --to=aliceryhl@google.com \
    --cc=a.hindborg@kernel.org \
    --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=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