Skip to content

Commit

Permalink
rust: sync: add Arc::{from_raw, into_raw}
Browse files Browse the repository at this point in the history
These methods can be used to turn an `Arc` into a raw pointer and back,
in a way that preserves the metadata for fat pointers.

This is done using the unstable ptr_metadata feature [1]. However, it
could also be done using the unstable pointer_byte_offsets feature [2],
which is likely to have a shorter path to stabilization than
ptr_metadata.

Link: rust-lang/rust#81513 [1]
Link: rust-lang/rust#96283 [2]
Signed-off-by: Wedson Almeida Filho <walmeida@microsoft.com>
Co-developed-by: Alice Ryhl <aliceryhl@google.com>
Signed-off-by: Alice Ryhl <aliceryhl@google.com>
Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
  • Loading branch information
wedsonaf authored and Darksonn committed May 23, 2023
1 parent 4abd8a4 commit 83756f0
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
1 change: 1 addition & 0 deletions rust/kernel/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
#![feature(generic_associated_types)]
#![feature(new_uninit)]
#![feature(pin_macro)]
#![feature(ptr_metadata)]
#![feature(receiver_trait)]
#![feature(unsize)]

Expand Down
44 changes: 44 additions & 0 deletions rust/kernel/sync/arc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,50 @@ impl<T: ?Sized> Arc<T> {
}
}

/// Convert the [`Arc`] into a raw pointer.
///
/// The raw pointer has ownership of the refcount that this Arc object owned.
pub fn into_raw(self) -> *const T {
let ptr = self.ptr.as_ptr();
core::mem::forget(self);
// SAFETY: The pointer is valid.
unsafe { core::ptr::addr_of!((*ptr).data) }
}

/// Recreates an [`Arc`] instance previously deconstructed via [`Arc::into_raw`].
///
/// This code relies on the `repr(C)` layout of structs as described in
/// <https://doc.rust-lang.org/reference/type-layout.html#reprc-structs>.
///
/// # Safety
///
/// `ptr` must have been returned by a previous call to [`Arc::into_raw`]. Additionally, it
/// can only be called once for each previous call to [`Arc::into_raw`].
pub unsafe fn from_raw(ptr: *const T) -> Self {
// SAFETY: The safety requirement ensures that the pointer is valid.
let val_align = core::mem::align_of_val(unsafe { &*ptr });
let refcount_size = core::mem::size_of::<Opaque<bindings::refcount_t>>();

// Use the `repr(C)` algorithm to compute the offset of `data` in `ArcInner`.
//
// Pseudo-code for the `#[repr(C)]` algorithm can be found here:
// <https://doc.rust-lang.org/reference/type-layout.html#reprc-structs>
let mut val_offset = refcount_size;
let val_misalign = val_offset % val_align;
if val_misalign > 0 {
val_offset += val_align - val_misalign;
}

// This preserves the metadata in the pointer, if any.
let metadata = core::ptr::metadata(ptr as *const ArcInner<T>);
let ptr = (ptr as *mut u8).wrapping_sub(val_offset) as *mut ();
let ptr = core::ptr::from_raw_parts_mut(ptr, metadata);

// SAFETY: By the safety requirements we know that `ptr` came from `Arc::into_raw`, so the
// reference count held then will be owned by the new `Arc` object.
unsafe { Self::from_inner(NonNull::new_unchecked(ptr)) }
}

/// Returns an [`ArcBorrow`] from the given [`Arc`].
///
/// This is useful when the argument of a function call is an [`ArcBorrow`] (e.g., in a method
Expand Down

0 comments on commit 83756f0

Please sign in to comment.