Re: [PATCH v2 2/2] rust: sync: add `Arc::into_unique_or_drop`

From: Alice Ryhl
Date: Mon Mar 11 2024 - 05:04:18 EST


On Sat, Mar 9, 2024 at 2:02 PM Benno Lossin <benno.lossin@xxxxxxxxx> wrote:
>
> On 2/28/24 14:00, Alice Ryhl wrote:
> > + // SAFETY: If the refcount reaches a non-zero value, then we have destroyed this `Arc` and
> > + // will return without further touching the `Arc`. If the refcount 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 = unsafe { bindings::refcount_dec_and_test(refcount) };
> > + 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_INIT(1)) };
> > +
> > + // SAFETY: We own one refcount, so we can create a `UniqueArc`. 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