mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-08-05 16:54:27 +00:00
rust: types: rename Opaque::raw_get to cast_into
In the previous patch we added Opaque::cast_from() that performs the opposite operation to Opaque::raw_get(). For consistency with this naming, rename raw_get() to cast_from(). There are a few other options such as calling cast_from() something closer to raw_get() rather than renaming this method. However, I could not find a great naming scheme that works with raw_get(). The previous version of this patch used from_raw(), but functions of that name typically have a different signature, so that's not a great option. Suggested-by: Danilo Krummrich <dakr@kernel.org> Signed-off-by: Alice Ryhl <aliceryhl@google.com> Acked-by: Benno Lossin <lossin@kernel.org> Acked-by: Andreas Hindborg <a.hindborg@kernel.org> Acked-by: Boqun Feng <boqun.feng@gmail.com> Reviewed-by: Danilo Krummrich <dakr@kernel.org> Acked-by: Danilo Krummrich <dakr@kernel.org> Link: https://lore.kernel.org/r/20250624-opaque-from-raw-v2-2-e4da40bdc59c@google.com [ Removed `HrTimer::raw_get` change. - Miguel ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
This commit is contained in:
parent
8802e16843
commit
64fb810bce
8 changed files with 15 additions and 15 deletions
|
@ -279,7 +279,7 @@ impl<Data> Group<Data> {
|
||||||
// within the `group` field.
|
// within the `group` field.
|
||||||
unsafe impl<Data> HasGroup<Data> for Group<Data> {
|
unsafe impl<Data> HasGroup<Data> for Group<Data> {
|
||||||
unsafe fn group(this: *const Self) -> *const bindings::config_group {
|
unsafe fn group(this: *const Self) -> *const bindings::config_group {
|
||||||
Opaque::raw_get(
|
Opaque::cast_into(
|
||||||
// SAFETY: By impl and function safety requirements this field
|
// SAFETY: By impl and function safety requirements this field
|
||||||
// projection is within bounds of the allocation.
|
// projection is within bounds of the allocation.
|
||||||
unsafe { &raw const (*this).group },
|
unsafe { &raw const (*this).group },
|
||||||
|
|
|
@ -100,13 +100,13 @@
|
||||||
//! let foo = addr_of_mut!((*slot).foo);
|
//! let foo = addr_of_mut!((*slot).foo);
|
||||||
//!
|
//!
|
||||||
//! // Initialize the `foo`
|
//! // Initialize the `foo`
|
||||||
//! bindings::init_foo(Opaque::raw_get(foo));
|
//! bindings::init_foo(Opaque::cast_into(foo));
|
||||||
//!
|
//!
|
||||||
//! // Try to enable it.
|
//! // Try to enable it.
|
||||||
//! let err = bindings::enable_foo(Opaque::raw_get(foo), flags);
|
//! let err = bindings::enable_foo(Opaque::cast_into(foo), flags);
|
||||||
//! if err != 0 {
|
//! if err != 0 {
|
||||||
//! // Enabling has failed, first clean up the foo and then return the error.
|
//! // Enabling has failed, first clean up the foo and then return the error.
|
||||||
//! bindings::destroy_foo(Opaque::raw_get(foo));
|
//! bindings::destroy_foo(Opaque::cast_into(foo));
|
||||||
//! return Err(Error::from_errno(err));
|
//! return Err(Error::from_errno(err));
|
||||||
//! }
|
//! }
|
||||||
//!
|
//!
|
||||||
|
|
|
@ -204,11 +204,11 @@ fn panic(info: &core::panic::PanicInfo<'_>) -> ! {
|
||||||
|
|
||||||
/// Produces a pointer to an object from a pointer to one of its fields.
|
/// Produces a pointer to an object from a pointer to one of its fields.
|
||||||
///
|
///
|
||||||
/// If you encounter a type mismatch due to the [`Opaque`] type, then use [`Opaque::raw_get`] or
|
/// If you encounter a type mismatch due to the [`Opaque`] type, then use [`Opaque::cast_into`] or
|
||||||
/// [`Opaque::cast_from`] to resolve the mismatch.
|
/// [`Opaque::cast_from`] to resolve the mismatch.
|
||||||
///
|
///
|
||||||
/// [`Opaque`]: crate::types::Opaque
|
/// [`Opaque`]: crate::types::Opaque
|
||||||
/// [`Opaque::raw_get`]: crate::types::Opaque::raw_get
|
/// [`Opaque::cast_into`]: crate::types::Opaque::cast_into
|
||||||
/// [`Opaque::cast_from`]: crate::types::Opaque::cast_from
|
/// [`Opaque::cast_from`]: crate::types::Opaque::cast_from
|
||||||
///
|
///
|
||||||
/// # Safety
|
/// # Safety
|
||||||
|
|
|
@ -284,7 +284,7 @@ impl<const ID: u64> ListLinks<ID> {
|
||||||
#[inline]
|
#[inline]
|
||||||
unsafe fn fields(me: *mut Self) -> *mut ListLinksFields {
|
unsafe fn fields(me: *mut Self) -> *mut ListLinksFields {
|
||||||
// SAFETY: The caller promises that the pointer is valid.
|
// SAFETY: The caller promises that the pointer is valid.
|
||||||
unsafe { Opaque::raw_get(ptr::addr_of!((*me).inner)) }
|
unsafe { Opaque::cast_into(ptr::addr_of!((*me).inner)) }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// # Safety
|
/// # Safety
|
||||||
|
|
|
@ -209,7 +209,7 @@ macro_rules! impl_list_item {
|
||||||
// the pointer stays in bounds of the allocation.
|
// the pointer stays in bounds of the allocation.
|
||||||
let self_ptr = unsafe { (links_field as *const u8).add(spoff) }
|
let self_ptr = unsafe { (links_field as *const u8).add(spoff) }
|
||||||
as *const $crate::types::Opaque<*const Self>;
|
as *const $crate::types::Opaque<*const Self>;
|
||||||
let cell_inner = $crate::types::Opaque::raw_get(self_ptr);
|
let cell_inner = $crate::types::Opaque::cast_into(self_ptr);
|
||||||
|
|
||||||
// SAFETY: This value is not accessed in any other places than `prepare_to_insert`,
|
// SAFETY: This value is not accessed in any other places than `prepare_to_insert`,
|
||||||
// `post_remove`, or `view_value`. By the safety requirements of those methods,
|
// `post_remove`, or `view_value`. By the safety requirements of those methods,
|
||||||
|
@ -252,7 +252,7 @@ macro_rules! impl_list_item {
|
||||||
// the pointer stays in bounds of the allocation.
|
// the pointer stays in bounds of the allocation.
|
||||||
let self_ptr = unsafe { (links_field as *const u8).add(spoff) }
|
let self_ptr = unsafe { (links_field as *const u8).add(spoff) }
|
||||||
as *const ::core::cell::UnsafeCell<*const Self>;
|
as *const ::core::cell::UnsafeCell<*const Self>;
|
||||||
let cell_inner = ::core::cell::UnsafeCell::raw_get(self_ptr);
|
let cell_inner = ::core::cell::UnsafeCell::cast_into(self_ptr);
|
||||||
// SAFETY: This is not a data race, because the only function that writes to this
|
// SAFETY: This is not a data race, because the only function that writes to this
|
||||||
// value is `prepare_to_insert`, but by the safety requirements the
|
// value is `prepare_to_insert`, but by the safety requirements the
|
||||||
// `prepare_to_insert` method may not be called in parallel with `view_value` or
|
// `prepare_to_insert` method may not be called in parallel with `view_value` or
|
||||||
|
|
|
@ -148,7 +148,7 @@ impl<T> HrTimer<T> {
|
||||||
// SAFETY: The field projection to `timer` does not go out of bounds,
|
// SAFETY: The field projection to `timer` does not go out of bounds,
|
||||||
// because the caller of this function promises that `this` points to an
|
// because the caller of this function promises that `this` points to an
|
||||||
// allocation of at least the size of `Self`.
|
// allocation of at least the size of `Self`.
|
||||||
unsafe { Opaque::raw_get(core::ptr::addr_of!((*this).timer)) }
|
unsafe { Opaque::cast_into(core::ptr::addr_of!((*this).timer)) }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Cancel an initialized and potentially running timer.
|
/// Cancel an initialized and potentially running timer.
|
||||||
|
|
|
@ -377,7 +377,7 @@ impl<T> Opaque<T> {
|
||||||
// initialize the `T`.
|
// initialize the `T`.
|
||||||
unsafe {
|
unsafe {
|
||||||
pin_init::pin_init_from_closure::<_, ::core::convert::Infallible>(move |slot| {
|
pin_init::pin_init_from_closure::<_, ::core::convert::Infallible>(move |slot| {
|
||||||
init_func(Self::raw_get(slot));
|
init_func(Self::cast_into(slot));
|
||||||
Ok(())
|
Ok(())
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -397,7 +397,7 @@ impl<T> Opaque<T> {
|
||||||
// SAFETY: We contain a `MaybeUninit`, so it is OK for the `init_func` to not fully
|
// SAFETY: We contain a `MaybeUninit`, so it is OK for the `init_func` to not fully
|
||||||
// initialize the `T`.
|
// initialize the `T`.
|
||||||
unsafe {
|
unsafe {
|
||||||
pin_init::pin_init_from_closure::<_, E>(move |slot| init_func(Self::raw_get(slot)))
|
pin_init::pin_init_from_closure::<_, E>(move |slot| init_func(Self::cast_into(slot)))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -410,11 +410,11 @@ impl<T> Opaque<T> {
|
||||||
///
|
///
|
||||||
/// This function is useful to get access to the value without creating intermediate
|
/// This function is useful to get access to the value without creating intermediate
|
||||||
/// references.
|
/// references.
|
||||||
pub const fn raw_get(this: *const Self) -> *mut T {
|
pub const fn cast_into(this: *const Self) -> *mut T {
|
||||||
UnsafeCell::raw_get(this.cast::<UnsafeCell<MaybeUninit<T>>>()).cast::<T>()
|
UnsafeCell::raw_get(this.cast::<UnsafeCell<MaybeUninit<T>>>()).cast::<T>()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The opposite operation of [`Opaque::raw_get`].
|
/// The opposite operation of [`Opaque::cast_into`].
|
||||||
pub const fn cast_from(this: *const T) -> *const Self {
|
pub const fn cast_from(this: *const T) -> *const Self {
|
||||||
this.cast()
|
this.cast()
|
||||||
}
|
}
|
||||||
|
|
|
@ -403,7 +403,7 @@ impl<T: ?Sized, const ID: u64> Work<T, ID> {
|
||||||
//
|
//
|
||||||
// A pointer cast would also be ok due to `#[repr(transparent)]`. We use `addr_of!` so that
|
// A pointer cast would also be ok due to `#[repr(transparent)]`. We use `addr_of!` so that
|
||||||
// the compiler does not complain that the `work` field is unused.
|
// the compiler does not complain that the `work` field is unused.
|
||||||
unsafe { Opaque::raw_get(core::ptr::addr_of!((*ptr).work)) }
|
unsafe { Opaque::cast_into(core::ptr::addr_of!((*ptr).work)) }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue