Received-SPF: pass (google.com: domain of linux-kernel+bounces-98574-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Precedence: bulk
MIME-Version: 1.0
References: <20240228-arc-for-list-v2-0-ae93201426b4@google.com>
 <20240228-arc-for-list-v2-2-ae93201426b4@google.com> <d52c5d95-99cd-4bd4-864f-b704299d3b1b@proton.me>
In-Reply-To: <d52c5d95-99cd-4bd4-864f-b704299d3b1b@proton.me>
From: Alice Ryhl <aliceryhl@google.com>
Date: Mon, 11 Mar 2024 10:03:54 +0100
Message-ID: <CAH5fLggrRANz1GrjEa671Vj0m9=UDeEcGV5vhOxq8XtR6EjUSg@mail.gmail.com>
Subject: Re: [PATCH v2 2/2] rust: sync: add `Arc::into_unique_or_drop`
To: Benno Lossin <benno.lossin@proton.me>
Cc: Miguel Ojeda <ojeda@kernel.org>, Alex Gaynor <alex.gaynor@gmail.com>, 
	Wedson Almeida Filho <wedsonaf@gmail.com>, Boqun Feng <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>, 
	=?UTF-8?Q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com>, 
	Andreas Hindborg <a.hindborg@samsung.com>, rust-for-linux@vger.kernel.org, 
	linux-kernel@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Sat, Mar 9, 2024 at 2:02=E2=80=AFPM Benno Lossin <benno.lossin@proton.me=
> wrote:
>
> On 2/28/24 14:00, Alice Ryhl wrote:
> > +        // SAFETY: If the refcount reaches a non-zero value, then we h=
ave destroyed this `Arc` and
> > +        // will return without further touching the `Arc`. If the refc=
ount reaches zero, then there
> > +        // are no other arcs, and we can create a `UniqueArc`.
>
> This comment is not explaining why it is safe to call
> `refcount_dec_and_test` on `refcount`.
> It dose however explain what you are going to do, so please keep it, but
> not as a SAFETY comment.

I'll reword.

> > +        let is_zero =3D unsafe { bindings::refcount_dec_and_test(refco=
unt) };
> > +        if is_zero {
> > +            // SAFETY: We have exclusive access to the arc, so we can =
perform unsynchronized
> > +            // accesses to the refcount.
> > +            unsafe { core::ptr::write(refcount, bindings::REFCOUNT_INI=
T(1)) };
> > +
> > +            // SAFETY: We own one refcount, so we can create a `Unique=
Arc`. It needs to be pinned,
> > +            // since an `Arc` is pinned.
>
> The `unsafe` block is only needed due to the `new_unchecked` call, which
> you could avoid by using `.into()`. The `SAFETY` should also be an
> `INVARIANT` comment instead.
>
> > +            unsafe {
> > +                Some(Pin::new_unchecked(UniqueArc {
> > +                    inner: Arc::from_inner(me.ptr),
> > +                }))
> > +            }

The from_inner method is also unsafe.

I think that using new_unchecked here makes more sense. That method is
usually used in the case where something is already pinned, whereas
into() is usually used to pin something that was not previously
pinned.

Alice