From nobody Wed Jun 17 05:11:44 2026 Received: from mail-pf1-f182.google.com (mail-pf1-f182.google.com [209.85.210.182]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8E448175A66 for ; Tue, 28 Apr 2026 03:40:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.182 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1777347610; cv=none; b=bvsL+kRkgxsXgp4KQwcfB+mlu25Wh3I+L3oDJJYk5h2qLUYR0sz1Im+ywkf9pd3qxz2BTMuZWPNDWLJATxjF/7z1SJp2zuXBmHICo9xQoulzZ4dgBNLnHVpwMEV5Qo1o9WhUbgXOht6VTpweAI5N9+4oTKw+G16Za6X0z70lvuA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1777347610; c=relaxed/simple; bh=z/QuKhDtzwSqtzrCrW2uib+i/bVCUPOrOORc5YiUnPI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=tiDoNumqtJy2KYNpBkiQSo3dp30o1puObsM4cn49F2Wgu2JgSJuFf/TBuoJ+WPwvyDdlfIJ0vAbzLjK31Xj6FAWzQLyqDHbYEpnBmJkM1IhMXqg9g/QDM1EnDiWJAlFJNpl0VdAC6b35OF33Vi7Z1ihatdtG475e8XAFwX2YJKU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=hCk10brD; arc=none smtp.client-ip=209.85.210.182 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="hCk10brD" Received: by mail-pf1-f182.google.com with SMTP id d2e1a72fcca58-82fb2d0c5d1so5392969b3a.0 for ; Mon, 27 Apr 2026 20:40:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1777347607; x=1777952407; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=X0uLVlaUufS4l5Hicmv3ZtS9sDE03PgYMV+ICnQGzQ4=; b=hCk10brDBE6MeaTNrq3HErCoqfy+UCopEGtBzj/u/OfxQs6rgG5/suq2O5NN3aZgqd v1kN0AnSFx13rLZwEPY4jmXEvTEXvTajAyik3tar2YAnWD5UoodML+81iCC1xQyvzzf2 b3oWyhlQhFE9RJB3iL8cdolWXSFcxhBF8cnzFbF9eA4ynmHYsxswfWAL7+EoPT5ZH5xv c5APDrAM2J/W8yqo4g/BaOltr79vtFHsYVOdUdW29gpWs/GqNB0oSIDJLSdN9lYgGvv9 wBAS27S3ItrBmlBPon4f5vAXSkEvzqxIj0PnhqzWDoq3EetRps3KrebHy1bNTjoDgm98 Szgw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1777347607; x=1777952407; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=X0uLVlaUufS4l5Hicmv3ZtS9sDE03PgYMV+ICnQGzQ4=; b=Aut95uY6S1WCTmhGkYzyATPanAAF3PjvHOkSEImIKo6JRK0twRRD2VEmu0zP/eld8v bOh53pZYuXWC5y+uCObJK9DZ727T1GocJsb23Y2hXaQaZO+Xr+vlThNXZVvvHYinsW+m qbqg+UZk4f8I/l7rZpvGa+L6vpQGgyh2M7RbiHHrhUdvNp6j2gUvLD7j0LJ9u88LsriR P7YxUU8FfwY3QG39ANNbc0T3vruLxvB4vRH17wAKCuK+PyOK4HlZZy09i9KddHphowyZ FJdE+WMNaktEtWn/NlCaBLLsk+i9FCftOTirSFx4RlGo2cXLxG+kOK3HBnZ9hbZegO+y VTqw== X-Forwarded-Encrypted: i=1; AFNElJ9NE3XGCLjId/piteyusQ/0WlBrWn9UYEbkqOZWaShQKe2ln0dHPVhYn6xsoDqiH0fj/Q3D4w3lZ9dkbbA=@vger.kernel.org X-Gm-Message-State: AOJu0YwY/IDmzYLmzCaf95Sas1QEKb0ESQfhu9UmYwFXlYmwzbM/Qvi/ bY+dsiKn6M/y+DpDLweVjzFVjC4f6EFrYyTHNxLWujWfT3O3EcTxXbXK X-Gm-Gg: AeBDievqxeDGCGnRXcLTly24v04v9fX2USS33tLCmUQuq3OwZAAly28Uu9nMnWGFpVd MtB0OL9JAFWGJoiqEk0jV4pj85ct4RHG65LXeQwaNdzTCp8SxhTRugOI0qRJJdvtF6/u8GJfIZV CrsEIXdw/0z76kUcdPFcOuzgES8y7hfy4Gvyr3sGx7+xn4KmZiJ0b8r1q/lpmOY1A+p7XYipgJN 0aCdWVpH54nS0JsZ1BulVUMjNs+PRF3/0CxFrz25/NoLPQ9rRButW8DF55kmbFJ4M/C1hfdDBe1 UfylCioIYn1xpuLHgJK7tFibusZ1Y6KE395a7kh0LsSTNQfTMgx/rmszaFRZUkf0GzKt3PYE7UD BrhVYCea4Pey/AZgIgirBgWtfKQzfdhhhCgUBueoTBysfIiOgXWXNVJZ9ypsZF7L+r1Y/+0kv9z 1BPet7HCytxCkTQxNqxrjV/d6fwEm4C7qBqIJIg3l3Ofn8z3uCX/8= X-Received: by 2002:a05:6a20:6a0f:b0:3a2:ebfc:6bfc with SMTP id adf61e73a8af0-3a39c5b7baamr1298066637.17.1777347606902; Mon, 27 Apr 2026 20:40:06 -0700 (PDT) Received: from Nighthawk.localdomain ([223.178.220.204]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-c7fc29b1c29sm768998a12.8.2026.04.27.20.40.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 27 Apr 2026 20:40:06 -0700 (PDT) From: Sagar Taunk 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 Subject: [PATCH v2] rust: sync: atomic: clarify AtomicAdd safety comment Date: Tue, 28 Apr 2026 09:09:35 +0530 Message-ID: <20260428033935.16875-1-sagartaunk2@gmail.com> X-Mailer: git-send-email 2.54.0 In-Reply-To: <20260427203258.22148-1-sagartaunk2@gmail.com> References: <20260427203258.22148-1-sagartaunk2@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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 --- 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 [`Sel= f::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_voi= d` for pointer atomics, +/// where the C function expects a byte offset rather than the pointer its= elf). +/// 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 ov= erflow +/// rather than causing undefined behavior, must yield a bit pattern that = is valid for `Self`. pub unsafe trait AtomicAdd: AtomicType { /// Converts `Rhs` into the `Delta` type of the atomic implementation. fn rhs_into_delta(rhs: Rhs) -> ::Delta; --=20 2.54.0