Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle::from_raw() and HandleAlloc::clone_handle()/consume_handle() are all unsafe. #2192

Merged
merged 1 commit into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion uniffi_core/src/ffi/ffiserialize.rs
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ mod test {
rust_buffer.len(),
rust_buffer.capacity(),
);
let handle = Handle::from_raw(101).unwrap();
let handle = unsafe { Handle::from_raw(101).unwrap() };
let rust_call_status = RustCallStatus::default();
let rust_call_status_error_buf = &rust_call_status.error_buf;
let orig_rust_call_status_buffer_data = (
Expand Down
4 changes: 3 additions & 1 deletion uniffi_core/src/ffi/handle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ impl Handle {
self.0 as *const T
}

pub fn from_raw(raw: u64) -> Option<Self> {
/// # Safety
/// The raw value must be a valid handle as described above.
pub unsafe fn from_raw(raw: u64) -> Option<Self> {
if raw == 0 {
None
} else {
Expand Down
38 changes: 20 additions & 18 deletions uniffi_core/src/ffi_converter_traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -449,18 +449,24 @@ pub unsafe trait HandleAlloc<UT>: Send + Sync {
/// This creates a new handle from an existing one.
/// It's used when the foreign code wants to pass back an owned handle and still keep a copy
/// for themselves.
fn clone_handle(handle: Handle) -> Handle;
/// # Safety
/// The handle must be valid.
unsafe fn clone_handle(handle: Handle) -> Handle;

/// Get a clone of the `Arc<>` using a "borrowed" handle.
///
/// Take care that the handle can not be destroyed between when it's passed and when
/// # Safety
/// The handle must be valid. Take care that the handle can
/// not be destroyed between when it's passed and when
/// `get_arc()` is called. #1797 is a cautionary tale.
fn get_arc(handle: Handle) -> Arc<Self> {
unsafe fn get_arc(handle: Handle) -> Arc<Self> {
Self::consume_handle(Self::clone_handle(handle))
}

/// Consume a handle, getting back the initial `Arc<>`
fn consume_handle(handle: Handle) -> Arc<Self>;
/// # Safety
/// The handle must be valid.
unsafe fn consume_handle(handle: Handle) -> Arc<Self>;
}

/// Derive FFI traits
Expand Down Expand Up @@ -596,19 +602,15 @@ macro_rules! derive_ffi_traits {
$crate::Handle::from_pointer(::std::sync::Arc::into_raw(::std::sync::Arc::new(value)))
}

fn clone_handle(handle: $crate::Handle) -> $crate::Handle {
unsafe {
::std::sync::Arc::<::std::sync::Arc<Self>>::increment_strong_count(handle.as_pointer::<::std::sync::Arc<Self>>());
}
unsafe fn clone_handle(handle: $crate::Handle) -> $crate::Handle {
::std::sync::Arc::<::std::sync::Arc<Self>>::increment_strong_count(handle.as_pointer::<::std::sync::Arc<Self>>());
handle
}

fn consume_handle(handle: $crate::Handle) -> ::std::sync::Arc<Self> {
unsafe {
::std::sync::Arc::<Self>::clone(
&std::sync::Arc::<::std::sync::Arc::<Self>>::from_raw(handle.as_pointer::<::std::sync::Arc<Self>>())
)
}
unsafe fn consume_handle(handle: $crate::Handle) -> ::std::sync::Arc<Self> {
::std::sync::Arc::<Self>::clone(
&std::sync::Arc::<::std::sync::Arc::<Self>>::from_raw(handle.as_pointer::<::std::sync::Arc<Self>>())
)
}
}
};
Expand All @@ -626,12 +628,12 @@ unsafe impl<T: Send + Sync, UT> HandleAlloc<UT> for T {
Handle::from_pointer(Arc::into_raw(value))
}

fn clone_handle(handle: Handle) -> Handle {
unsafe { Arc::increment_strong_count(handle.as_pointer::<T>()) };
unsafe fn clone_handle(handle: Handle) -> Handle {
Arc::increment_strong_count(handle.as_pointer::<T>());
handle
}

fn consume_handle(handle: Handle) -> Arc<Self> {
unsafe { Arc::from_raw(handle.as_pointer()) }
unsafe fn consume_handle(handle: Handle) -> Arc<Self> {
Arc::from_raw(handle.as_pointer())
}
}