From: Sagar Taunk <sagartaunk2@gmail.com>
To: ojeda@kernel.org
Cc: boqun@kernel.org, lossin@kernel.org, tmgross@umich.edu,
dakr@kernel.org, aliceryhl@google.com, bjorn3_gh@protonmail.com,
gary@garyguo.net, a.hindborg@kernel.org,
rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
Sagar Taunk <sagartaunk2@gmail.com>
Subject: [PATCH v2] rust: sync: atomic: clarify AtomicAdd safety comment
Date: Tue, 28 Apr 2026 09:09:35 +0530 [thread overview]
Message-ID: <20260428033935.16875-1-sagartaunk2@gmail.com> (raw)
In-Reply-To: <20260427203258.22148-1-sagartaunk2@gmail.com>
The previous safety comment for AtomicAdd was marked with a TODO
and contained a grammatically broken sentence that was difficult to
parse. Rewrite the comment to fix the grammar and clearly define the
safety contract, including what `wrapping_add` means in the context
and why `Self::Repr::Delta` may differ from `Self::Repr`.
Signed-off-by: Sagar Taunk <sagartaunk2@gmail.com>
---
rust/kernel/sync/atomic.rs | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/rust/kernel/sync/atomic.rs b/rust/kernel/sync/atomic.rs
index 9cd009d57e35..4000fff16e69 100644
--- a/rust/kernel/sync/atomic.rs
+++ b/rust/kernel/sync/atomic.rs
@@ -127,10 +127,14 @@ pub unsafe trait AtomicType: Sized + Copy {
///
/// # Safety
///
-// TODO: Properly defines `wrapping_add` in the following comment.
-/// `wrapping_add` any value of type `Self::Repr::Delta` obtained by [`Self::rhs_into_delta()`] to
-/// any value of type `Self::Repr` obtained through transmuting a value of type `Self` to must
-/// yield a value with a bit pattern also valid for `Self`.
+/// `Self::Repr::Delta` is the type of value being added in the underlying
+/// C atomic operation, and may differ from `Self::Repr` (e.g., `i32` for 32-bit
+/// integer atomics or `isize` rather than the pointer value `*const c_void` for pointer atomics,
+/// where the C function expects a byte offset rather than the pointer itself).
+/// Thus, for any `Self::Repr` obtained by transmuting a valid `Self`,
+/// adding any `Self::Repr::Delta` value produced by `Self::rhs_into_delta()` using
+/// `wrapping_add`, where `wrapping_add` denotes addition that wraps on overflow
+/// rather than causing undefined behavior, must yield a bit pattern that is valid for `Self`.
pub unsafe trait AtomicAdd<Rhs = Self>: AtomicType {
/// Converts `Rhs` into the `Delta` type of the atomic implementation.
fn rhs_into_delta(rhs: Rhs) -> <Self::Repr as AtomicImpl>::Delta;
--
2.54.0
prev parent reply other threads:[~2026-04-28 3:40 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-04-27 20:32 [PATCH 2/2] rust: sync: atomic: clarify AtomicAdd safety comment Sagar Taunk
2026-04-27 23:04 ` Gary Guo
2026-04-28 3:39 ` Sagar Taunk [this message]
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=20260428033935.16875-1-sagartaunk2@gmail.com \
--to=sagartaunk2@gmail.com \
--cc=a.hindborg@kernel.org \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun@kernel.org \
--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 \
/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