Received-SPF: pass (google.com: domain of linux-kernel+bounces-213355-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Thu, 13 Jun 2024 14:44:32 +0100
From: Gary Guo <gary@garyguo.net>
To: Boqun Feng <boqun.feng@gmail.com>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
 linux-arch@vger.kernel.org, llvm@lists.linux.dev, Miguel Ojeda
 <ojeda@kernel.org>, Alex Gaynor <alex.gaynor@gmail.com>, Wedson Almeida
 Filho <wedsonaf@gmail.com>, =?UTF-8?B?QmrDtnJu?= Roy Baron
 <bjorn3_gh@protonmail.com>, Benno Lossin <benno.lossin@proton.me>, Andreas
 Hindborg <a.hindborg@samsung.com>, Alice Ryhl <aliceryhl@google.com>, Alan
 Stern <stern@rowland.harvard.edu>, Andrea Parri <parri.andrea@gmail.com>,
 Will Deacon <will@kernel.org>, Peter Zijlstra <peterz@infradead.org>,
 Nicholas Piggin <npiggin@gmail.com>, David Howells <dhowells@redhat.com>,
 Jade Alglave <j.alglave@ucl.ac.uk>, Luc Maranget <luc.maranget@inria.fr>,
 "Paul E. McKenney" <paulmck@kernel.org>, Akira Yokosawa <akiyks@gmail.com>,
 Daniel Lustig <dlustig@nvidia.com>, Joel Fernandes
 <joel@joelfernandes.org>, Nathan Chancellor <nathan@kernel.org>, Nick
 Desaulniers <ndesaulniers@google.com>, kent.overstreet@gmail.com, Greg
 Kroah-Hartman <gregkh@linuxfoundation.org>, elver@google.com, Mark Rutland
 <mark.rutland@arm.com>, Thomas Gleixner <tglx@linutronix.de>, Ingo Molnar
 <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>, Dave Hansen
 <dave.hansen@linux.intel.com>, x86@kernel.org, "H. Peter Anvin"
 <hpa@zytor.com>, Catalin Marinas <catalin.marinas@arm.com>,
 torvalds@linux-foundation.org, linux-arm-kernel@lists.infradead.org,
 linux-fsdevel@vger.kernel.org, Trevor Gross <tmgross@umich.edu>,
 dakr@redhat.com
Subject: Re: [RFC 2/2] rust: sync: Add atomic support
Message-ID: <20240613144432.77711a3a@eugeo>
In-Reply-To: <20240612223025.1158537-3-boqun.feng@gmail.com>
References: <20240612223025.1158537-1-boqun.feng@gmail.com>
	<20240612223025.1158537-3-boqun.feng@gmail.com>
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?W2nv7aUvoYk2wYvPPbHoEYe3q+sX9zaYY97BIWHE1svQF7rIuQYHK89RTSh6?=
 =?us-ascii?Q?orMGU7nggxGQrKfAswX+yABJezydEop8KvSv+s1q8m4HbaXiUFmbQ3Xd9bWU?=
 =?us-ascii?Q?VihoQimzREUs60GoWnKykIkRvkC8RECWA6b8sPL82fMWj7A3QdW3CuepcuyB?=
 =?us-ascii?Q?FC5IRRxw3JSdbwnySg08MPBVqJ5Lv0UCmBjjRX3454XSN8o6bZGWORlJgF74?=
 =?us-ascii?Q?QqPqnITFN20loe2shwOeOI1XiB6W9PX7JuUNHxZj16I6zAXZUhvztBTiPlKs?=
 =?us-ascii?Q?G/x/vEegltx8DRl/qC4Idw17iLWdjPCX2KkhEDRX1nhbm4guCb5lXz2IXCVA?=
 =?us-ascii?Q?Ca1Vr+fjjX51tKcW6aGCLVtu4Qyeb0flClWwD3CNV/o3lC82GxygoyjkdVJ8?=
 =?us-ascii?Q?EFkA/XTTgef8qcX9SnKLkf2S9hbKUm4aFJyMqJgKrmCRjtE3cvgmQR3NbiFP?=
 =?us-ascii?Q?baTt39B+bsfpJo31mWQ3Z8S3xYMqPCatNyWkYH6bMWrKvbvTkAEKD+0UxQs9?=
 =?us-ascii?Q?CvS0TLq0JJDmChMhN8Oy9LtvuknBC6KZEyMk+RZd8R95phzQWFriUe/Jx3j9?=
 =?us-ascii?Q?zwek0X/uwISwsbY1rUyt+0zpRi79fAYh2LT2VskIXTas3f2/CTZu7+fNT4pM?=
 =?us-ascii?Q?GaoRjgiw8T3xKpGL7pIy8yG45K04njccsGYkEEWX3/KCNalLVxzr4h38k4tm?=
 =?us-ascii?Q?sIYBf7nt/OtccJRA3413dXdw9G0ZxRkXF12tDZJXajmHAvy8wKDJTloFUsDy?=
 =?us-ascii?Q?oxCEfHuAhhxVFjLcusoudsB2eO4/m3dDo0Kq8WdTFd6oLlRtbmVZNwpt6C9J?=
 =?us-ascii?Q?uGWknpC1jJ+ZBKb5zY/dtevQxUrgao11Pn0JunJFRcYY4Z/3YircENJr9/OS?=
 =?us-ascii?Q?oK5/36uiHPXAuR88d8Lk11+kX+jtlUcfLTzLSB625XgiDCNpTRnjKCx5ObYz?=
 =?us-ascii?Q?0W9LwhDydYAHGETlYsDqbylrQmn/l8G+1UmOf/12LJJXIOp8LWKh6eiAgf8w?=
 =?us-ascii?Q?ulkp9vPqSQtBIR2RmCdZpw9u8SC59vCo5LvjbgiVkkGBF+j6spTRYHSZd9Nh?=
 =?us-ascii?Q?pZ1Ilv67u5S4+AbIk6n/ZxMehnTCwCfi15fDLYGZiqhubqb+dKtpkpJTrFEK?=
 =?us-ascii?Q?j/C0U/B4VJ23Es2i38CSTOCazKBEwYnCitwoMgTj851KXaFKGjA0YSPyYaHQ?=
 =?us-ascii?Q?fFpKR5pA49nFbYiSDkapuVnpP62CgXSKZ4Oc5E41W+57Hmo2LPJFl+WwxsmN?=
 =?us-ascii?Q?Clm5Aq5QT6f1W8vxR8f/wroLy7KA7+L4VanpjMfl3NTZJGILT+LEPw55DLWY?=
 =?us-ascii?Q?h+76aFjjyLWBm42RuFMQbkVuI8J98p9MJTJKASAdJKjPoh8RP8CYzysoO1ME?=
 =?us-ascii?Q?b7qU0l55BHOrGuBJ0epPOuvtrRKnaC1HcaUwhhW29L+snEAg1cyN3VAh7OTO?=
 =?us-ascii?Q?Y99IMNzcZeceYBg5fDYuuvbrYSTPQ4dVGTO5Hs7sraEKjtFuGYAt91+5iwGL?=
 =?us-ascii?Q?hXk9i6ImilJRoGbNVDbWe4aSFet77ESy8EYs7qZekvxkuyoo3363CPYRwJjL?=
 =?us-ascii?Q?NwGMHjUWIM7BcMDSv/jeAWhsitoZy6VZ5l/Yg+Tt?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 749f7318-25f2-4770-31a5-08dc8baef5af
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Jun 2024 13:44:34.3853
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bbc898ad-b10f-4e10-8552-d9377b823d45
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: lbdahDWPP3qHtcQpGPAQ2joj877QYx+Iu/OKw+x3JehnSiAhxKQIXyghzoFVaK+J5NbjvBSTxqNlxoe1O/FJSA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LO6P265MB6573

On Wed, 12 Jun 2024 15:30:25 -0700
Boqun Feng <boqun.feng@gmail.com> wrote:

> Provide two atomic types: AtomicI32 and AtomicI64 with the existing
> implemenation of C atomics. These atomics have the same semantics of the
> corresponding LKMM C atomics, and using one memory (ordering) model
> certainly reduces the reasoning difficulty and potential bugs from the
> interaction of two different memory models.
> 
> Also bump my role to the maintainer of ATOMIC INFRASTRUCTURE to reflect
> my responsiblity on these Rust APIs.
> 
> Note that `Atomic*::new()`s are implemented vi open coding on struct
> atomic*_t. This allows `new()` being a `const` function, so that it can
> be used in constant contexts.
> 
> Signed-off-by: Boqun Feng <boqun.feng@gmail.com>
> ---
>  MAINTAINERS                       |    4 +-
>  arch/arm64/kernel/cpufeature.c    |    2 +
>  rust/kernel/sync.rs               |    1 +
>  rust/kernel/sync/atomic.rs        |   63 ++
>  rust/kernel/sync/atomic/impl.rs   | 1375 +++++++++++++++++++++++++++++
>  scripts/atomic/gen-atomics.sh     |    1 +
>  scripts/atomic/gen-rust-atomic.sh |  136 +++
>  7 files changed, 1581 insertions(+), 1 deletion(-)
>  create mode 100644 rust/kernel/sync/atomic.rs
>  create mode 100644 rust/kernel/sync/atomic/impl.rs
>  create mode 100755 scripts/atomic/gen-rust-atomic.sh
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index d6c90161c7bf..a8528d27b260 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3458,7 +3458,7 @@ F:	drivers/input/touchscreen/atmel_mxt_ts.c
>  ATOMIC INFRASTRUCTURE
>  M:	Will Deacon <will@kernel.org>
>  M:	Peter Zijlstra <peterz@infradead.org>
> -R:	Boqun Feng <boqun.feng@gmail.com>
> +M:	Boqun Feng <boqun.feng@gmail.com>
>  R:	Mark Rutland <mark.rutland@arm.com>
>  L:	linux-kernel@vger.kernel.org
>  S:	Maintained
> @@ -3467,6 +3467,8 @@ F:	arch/*/include/asm/atomic*.h
>  F:	include/*/atomic*.h
>  F:	include/linux/refcount.h
>  F:	scripts/atomic/
> +F:	rust/kernel/sync/atomic.rs
> +F:	rust/kernel/sync/atomic/
>  
>  ATTO EXPRESSSAS SAS/SATA RAID SCSI DRIVER
>  M:	Bradley Grove <linuxdrivers@attotech.com>
> diff --git a/arch/arm64/kernel/cpufeature.c b/arch/arm64/kernel/cpufeature.c
> index 48e7029f1054..99e6e2b2867f 100644
> --- a/arch/arm64/kernel/cpufeature.c
> +++ b/arch/arm64/kernel/cpufeature.c
> @@ -1601,6 +1601,8 @@ static bool
>  has_cpuid_feature(const struct arm64_cpu_capabilities *entry, int scope)
>  {
>  	u64 val = read_scoped_sysreg(entry, scope);
> +	if (entry->capability == ARM64_HAS_LSE_ATOMICS)
> +		return false;
>  	return feature_matches(val, entry);
>  }
>  
> diff --git a/rust/kernel/sync.rs b/rust/kernel/sync.rs
> index 0ab20975a3b5..66ac3752ca71 100644
> --- a/rust/kernel/sync.rs
> +++ b/rust/kernel/sync.rs
> @@ -8,6 +8,7 @@
>  use crate::types::Opaque;
>  
>  mod arc;
> +pub mod atomic;
>  mod condvar;
>  pub mod lock;
>  mod locked_by;
> diff --git a/rust/kernel/sync/atomic.rs b/rust/kernel/sync/atomic.rs
> new file mode 100644
> index 000000000000..b0f852cf1741
> --- /dev/null
> +++ b/rust/kernel/sync/atomic.rs
> @@ -0,0 +1,63 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +//! Atomic primitives.
> +//!
> +//! These primitives have the same semantics as their C counterparts, for precise definitions of
> +//! the semantics, please refer to tools/memory-model. Note that Linux Kernel Memory (Consistency)
> +//! Model is the only model for Rust development in kernel right now, please avoid to use Rust's
> +//! own atomics.
> +
> +use crate::bindings::{atomic64_t, atomic_t};
> +use crate::types::Opaque;
> +
> +mod r#impl;
> +
> +/// Atomic 32bit signed integers.
> +pub struct AtomicI32(Opaque<atomic_t>);
> +
> +/// Atomic 64bit signed integers.
> +pub struct AtomicI64(Opaque<atomic64_t>);


Can we avoid two types and use a generic `Atomic<T>` and then implement
on `Atomic<i32>` and `Atomic<i64>` instead? Like the recent
generic NonZero in Rust standard library or the atomic crate
(https://docs.rs/atomic/).

I think this is better for ergonomics. The impl do need some extra
casting though.

Best,
Gary