xref: /wasmtime-44.0.1/crates/wasmtime/src/runtime/vm/send_sync_ptr.rs (revision 35786823)

use core::fmt;
use core::hash::{Hash, Hasher};
use core::ptr::{self, NonNull};

/// A helper type in Wasmtime to store a raw pointer to `T` while automatically
/// inferring the `Send` and `Sync` traits for the container based on the
/// properties of `T`.
#[repr(transparent)]
pub struct SendSyncPtr<T: ?Sized>(NonNull<T>);

unsafe impl<T: Send + ?Sized> Send for SendSyncPtr<T> {}
unsafe impl<T: Sync + ?Sized> Sync for SendSyncPtr<T> {}

impl<T: ?Sized> SendSyncPtr<T> {
    /// Creates a new pointer wrapping the non-nullable pointer provided.
    #[inline]
    pub fn new(ptr: NonNull<T>) -> SendSyncPtr<T> {
        SendSyncPtr(ptr)
    }

    /// Returns the underlying raw pointer.
    #[inline]
    pub fn as_ptr(&self) -> *mut T {
        self.0.as_ptr()
    }

    /// Unsafely assert that this is a pointer to valid contents and it's also
    /// valid to get a shared reference to it at this time.
    #[inline]
    pub unsafe fn as_ref<'a>(&self) -> &'a T {
        unsafe { self.0.as_ref() }
    }

    /// Unsafely assert that this is a pointer to valid contents and it's also
    /// valid to get a mutable reference to it at this time.
    #[inline]
    pub unsafe fn as_mut<'a>(&mut self) -> &'a mut T {
        unsafe { self.0.as_mut() }
    }

    /// Returns the underlying `NonNull<T>` wrapper.
    #[inline]
    pub fn as_non_null(&self) -> NonNull<T> {
        self.0
    }

    /// Cast this to a pointer to a `U`.
    #[inline]
    pub fn cast<U>(&self) -> SendSyncPtr<U> {
        SendSyncPtr(self.0.cast::<U>())
    }
}

impl<T> SendSyncPtr<[T]> {
    /// Returns the slice's length component of the pointer.
    #[inline]
    pub fn len(&self) -> usize {
        self.0.len()
    }
}

impl<T: ?Sized, U> From<U> for SendSyncPtr<T>
where
    U: Into<NonNull<T>>,
{
    #[inline]
    fn from(ptr: U) -> SendSyncPtr<T> {
        SendSyncPtr::new(ptr.into())
    }
}

impl<T: ?Sized> fmt::Debug for SendSyncPtr<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ptr().fmt(f)
    }
}

impl<T: ?Sized> fmt::Pointer for SendSyncPtr<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.as_ptr().fmt(f)
    }
}

impl<T: ?Sized> Clone for SendSyncPtr<T> {
    #[inline]
    fn clone(&self) -> Self {
        *self
    }
}

impl<T: ?Sized> Copy for SendSyncPtr<T> {}

impl<T: ?Sized> PartialEq for SendSyncPtr<T> {
    #[inline]
    fn eq(&self, other: &SendSyncPtr<T>) -> bool {
        ptr::eq(self.0.as_ptr(), other.0.as_ptr())
    }
}

impl<T: ?Sized> Eq for SendSyncPtr<T> {}

impl<T: ?Sized> Hash for SendSyncPtr<T> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.as_ptr().hash(state);
    }
}