mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-12-28 07:54:36 -05:00
rust: drm: gem: Refactor IntoGEMObject::from_gem_obj() to as_ref()
There's a few issues with this function, mainly: * This function -probably- should have been unsafe from the start. Pointers are not always necessarily valid, but you want a function that does field-projection for a pointer that can travel outside of the original struct to be unsafe, at least if I understand properly. * *mut Self is not terribly useful in this context, the majority of uses of from_gem_obj() grab a *mut Self and then immediately convert it into a &'a Self. It also goes against the ffi conventions we've set in the rest of the kernel thus far. * from_gem_obj() also doesn't follow the naming conventions in the rest of the DRM bindings at the moment, as_ref() would be a better name. So, let's: * Make from_gem_obj() unsafe * Convert it to return &'a Self * Rename it to as_ref() * Update all call locations Signed-off-by: Lyude Paul <lyude@redhat.com> Reviewed-by: Daniel Almeida <daniel.almeida@collabora.com> Link: https://lore.kernel.org/r/20250513221046.903358-3-lyude@redhat.com Signed-off-by: Danilo Krummrich <dakr@kernel.org>
This commit is contained in:
committed by
Danilo Krummrich
parent
6ee48aee8c
commit
36b1ccbfa0
@@ -45,8 +45,14 @@ pub trait IntoGEMObject: Sized + super::private::Sealed {
|
||||
#[allow(clippy::wrong_self_convention)]
|
||||
fn into_gem_obj(&self) -> &Opaque<bindings::drm_gem_object>;
|
||||
|
||||
/// Converts a pointer to a `struct drm_gem_object` into a pointer to `Self`.
|
||||
fn from_gem_obj(obj: *mut bindings::drm_gem_object) -> *mut Self;
|
||||
/// Converts a pointer to a `struct drm_gem_object` into a reference to `Self`.
|
||||
///
|
||||
/// # Safety
|
||||
///
|
||||
/// - `self_ptr` must be a valid pointer to `Self`.
|
||||
/// - The caller promises that holding the immutable reference returned by this function does
|
||||
/// not violate rust's data aliasing rules and remains valid throughout the lifetime of `'a`.
|
||||
unsafe fn as_ref<'a>(self_ptr: *mut bindings::drm_gem_object) -> &'a Self;
|
||||
}
|
||||
|
||||
/// Trait which must be implemented by drivers using base GEM objects.
|
||||
@@ -63,14 +69,13 @@ extern "C" fn open_callback<T: BaseDriverObject<U>, U: BaseObject>(
|
||||
let file = unsafe {
|
||||
drm::File::<<<U as IntoGEMObject>::Driver as drm::Driver>::File>::as_ref(raw_file)
|
||||
};
|
||||
let obj =
|
||||
<<<U as IntoGEMObject>::Driver as drm::Driver>::Object as IntoGEMObject>::from_gem_obj(
|
||||
raw_obj,
|
||||
);
|
||||
// SAFETY: `open_callback` is specified in the AllocOps structure for `Object<T>`, ensuring that
|
||||
// `raw_obj` is indeed contained within a `Object<T>`.
|
||||
let obj = unsafe {
|
||||
<<<U as IntoGEMObject>::Driver as drm::Driver>::Object as IntoGEMObject>::as_ref(raw_obj)
|
||||
};
|
||||
|
||||
// SAFETY: `from_gem_obj()` returns a valid pointer as long as the type is correct and the
|
||||
// `raw_obj` we got is valid.
|
||||
match T::open(unsafe { &*obj }, file) {
|
||||
match T::open(obj, file) {
|
||||
Err(e) => e.to_errno(),
|
||||
Ok(()) => 0,
|
||||
}
|
||||
@@ -84,14 +89,13 @@ extern "C" fn close_callback<T: BaseDriverObject<U>, U: BaseObject>(
|
||||
let file = unsafe {
|
||||
drm::File::<<<U as IntoGEMObject>::Driver as drm::Driver>::File>::as_ref(raw_file)
|
||||
};
|
||||
let obj =
|
||||
<<<U as IntoGEMObject>::Driver as drm::Driver>::Object as IntoGEMObject>::from_gem_obj(
|
||||
raw_obj,
|
||||
);
|
||||
// SAFETY: `close_callback` is specified in the AllocOps structure for `Object<T>`, ensuring
|
||||
// that `raw_obj` is indeed contained within a `Object<T>`.
|
||||
let obj = unsafe {
|
||||
<<<U as IntoGEMObject>::Driver as drm::Driver>::Object as IntoGEMObject>::as_ref(raw_obj)
|
||||
};
|
||||
|
||||
// SAFETY: `from_gem_obj()` returns a valid pointer as long as the type is correct and the
|
||||
// `raw_obj` we got is valid.
|
||||
T::close(unsafe { &*obj }, file);
|
||||
T::close(obj, file);
|
||||
}
|
||||
|
||||
impl<T: DriverObject> IntoGEMObject for Object<T> {
|
||||
@@ -101,9 +105,10 @@ fn into_gem_obj(&self) -> &Opaque<bindings::drm_gem_object> {
|
||||
&self.obj
|
||||
}
|
||||
|
||||
fn from_gem_obj(obj: *mut bindings::drm_gem_object) -> *mut Self {
|
||||
// SAFETY: All of our objects are Object<T>.
|
||||
unsafe { crate::container_of!(obj, Object<T>, obj).cast_mut() }
|
||||
unsafe fn as_ref<'a>(self_ptr: *mut bindings::drm_gem_object) -> &'a Self {
|
||||
// SAFETY: `obj` is guaranteed to be in an `Object<T>` via the safety contract of this
|
||||
// function
|
||||
unsafe { &*crate::container_of!(self_ptr, Object<T>, obj) }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -144,11 +149,23 @@ fn lookup_handle(
|
||||
) -> Result<ARef<Self>> {
|
||||
// SAFETY: The arguments are all valid per the type invariants.
|
||||
let ptr = unsafe { bindings::drm_gem_object_lookup(file.as_raw().cast(), handle) };
|
||||
let ptr = <Self as IntoGEMObject>::from_gem_obj(ptr);
|
||||
let ptr = NonNull::new(ptr).ok_or(ENOENT)?;
|
||||
if ptr.is_null() {
|
||||
return Err(ENOENT);
|
||||
}
|
||||
|
||||
// SAFETY: We take ownership of the reference of `drm_gem_object_lookup()`.
|
||||
Ok(unsafe { ARef::from_raw(ptr) })
|
||||
// SAFETY:
|
||||
// - A `drm::Driver` can only have a single `File` implementation.
|
||||
// - `file` uses the same `drm::Driver` as `Self`.
|
||||
// - Therefore, we're guaranteed that `ptr` must be a gem object embedded within `Self`.
|
||||
// - And we check if the pointer is null befoe calling as_ref(), ensuring that `ptr` is a
|
||||
// valid pointer to an initialized `Self`.
|
||||
let obj = unsafe { Self::as_ref(ptr) };
|
||||
|
||||
// SAFETY:
|
||||
// - We take ownership of the reference of `drm_gem_object_lookup()`.
|
||||
// - Our `NonNull` comes from an immutable reference, thus ensuring it is a valid pointer to
|
||||
// `Self`.
|
||||
Ok(unsafe { ARef::from_raw(obj.into()) })
|
||||
}
|
||||
|
||||
/// Creates an mmap offset to map the object from userspace.
|
||||
|
||||
Reference in New Issue
Block a user