rust: drm: gem: More (and final) cleanup
Subsystems (4)
v3 cover rust: drm: gem: More (and final) cleanup
Look mom, no generic soup!
Anyway - this is just the last of the cleanup stuff I ended up while working on cleaning up the gem shmem patch series. It simplifies the use of generics and also adds a type alias for some very long types currently in use. Also, drop one unused constant I noticed.
Applies on top of nova/nova-next:
https://gitlab.freedesktop.org/drm/nova/-/tree/nova-next
Lyude Paul (4):
rust: drm: gem: Simplify use of generics
rust: drm: gem: Add DriverFile type alias
rust: drm: gem: Drop Object::SIZE
rust: drm: Use gem::BaseDriverObject in driver::Driver
drivers/gpu/drm/nova/driver.rs | 4 +- drivers/gpu/drm/nova/gem.rs | 9 ++- rust/kernel/drm/device.rs | 17 +++--- rust/kernel/drm/driver.rs | 5 +- rust/kernel/drm/gem/mod.rs | 108 +++++++++++++++------------------ 5 files changed, 70 insertions(+), 73 deletions(-)
base-commit: 276c53c66e032c8e7cc0da63555f2742eb1afd69
Signature · 1 line
2.49.0
PATCH v3 1/4 rust: drm: gem: Simplify use of generics
Now that my rust skills have been honed, I noticed that there's a lot of generics in our gem bindings that don't actually need to be here. Currently the hierarchy of traits in our gem bindings looks like this:
* Drivers implement:
* BaseDriverObject<T: DriverObject> (has the callbacks)
* DriverObject (has the drm::Driver type)
* Crate implements:
* IntoGEMObject for Object<T> where T: DriverObject Handles conversion to/from raw object pointers
* BaseObject for T where T: IntoGEMObject Provides methods common to all gem interfaces
Also of note, this leaves us with two different drm::Driver associated types:
* DriverObject::Driver
* IntoGEMObject::Driver
I'm not entirely sure of the original intent here unfortunately (if anyone is, please let me know!), but my guess is that the idea would be that some objects can implement IntoGEMObject using a different ::Driver than DriverObject - presumably to enable the usage of gem objects from different drivers. A reasonable usecase of course.
However - if I'm not mistaken, I don't think that this is actually how things would go in practice. Driver implementations are of course implemented by their associated drivers, and generally drivers are not linked to each-other when building the kernel. Which is to say that even in a situation where we would theoretically deal with gem objects from another driver, we still wouldn't have access to its drm::driver::Driver implementation. It's more likely we would simply want a variant of gem objects in such a situation that have no association with a drm::driver::Driver type.
Taking that into consideration, we can assume the following:
* Anything that implements BaseDriverObject will implement DriverObject In other words, all BaseDriverObjects indirectly have an associated ::Driver type - so the two traits can be combined into one with no generics.
* Not everything that implements IntoGEMObject will have an associated ::Driver, and that's OK.
And with this, we now can do quite a bit of cleanup with the use of generics here. As such, this commit:
* Removes the generics on BaseDriverObject
* Moves DriverObject::Driver into BaseDriverObject
* Removes DriverObject
* Removes IntoGEMObject::Driver
* Add AllocImpl::Driver, which we can use as a binding to figure out the correct File type for BaseObject
Leaving us with a simpler trait hierarchy that now looks like this:
* Drivers implement: BaseDriverObject
* Crate implements:
* IntoGEMObject for Object<T> where T: DriverObject
* BaseObject for T where T: IntoGEMObject
Which makes the code a lot easier to understand and build on :).
---
V2:
* Don't refer to Object<T> in callbacks, as this would result in drivers getting the wrong gem object type for shmem gem objects once we add support for those. Instead, we'll just add a type alias to clean this part up.
V3:
* Fix nova compilation
* Also, add an associated driver type to AllocImpl - as we still need the current driver accessible from BaseObject so that we can use the driver's various associated types, like File
--- drivers/gpu/drm/nova/gem.rs | 8 ++-- rust/kernel/drm/driver.rs | 3 ++ rust/kernel/drm/gem/mod.rs | 89 +++++++++++++++++-------------------- 3 files changed, 46 insertions(+), 54 deletions(-)
drivers/gpu/drm/nova/gem.rs +3 -5
@@ -16,16 +16,14 @@#[pin_data] pub (crate )struct NovaObject {} -impl gem::BaseDriverObject <gem::Object <NovaObject >>for NovaObject { +impl gem::BaseDriverObject for NovaObject { +type Driver =NovaDriver ; +fn new (_dev: &NovaDevice , _size:usize ) ->impl PinInit <Self ,Error > {try_pin_init! (NovaObject {}) } } -impl gem::DriverObject for NovaObject { -type Driver =NovaDriver ; -} -impl NovaObject {/// Create a new DRM GEM object. pub (crate )fn new (dev: &NovaDevice , size:usize ) ->Result <ARef <gem::Object <Self >>> {
rust/kernel/drm/driver.rs +3 -0
@@ -89,6 +89,9 @@ pub struct AllocOps {/// Trait for memory manager implementations. Implemented internally. pub trait AllocImpl :super ::private::Sealed + drm::gem::IntoGEMObject { +/// The [`Driver`] implementation for this [`AllocImpl`]. +type Driver : drm::Driver ; +/// The C callback operations for this memory manager. const ALLOC_OPS :AllocOps ; }
rust/kernel/drm/gem/mod.rs +40 -49
179 lines not on this page · raw message
Signature · 1 line
2.49.0
PATCH v3 2/4 rust: drm: gem: Add DriverFile type alias
In reply to Lyude PaulJust to reduce the clutter with the File<…> types in gem.rs.
---
V3:
* Rename ObjectFile to DriverFile
--- rust/kernel/drm/gem/mod.rs | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
rust/kernel/drm/gem/mod.rs +12 -11
@@ -14,6 +14,13 @@ };use core::{mem, ops::Deref , ptr::NonNull }; +/// A type alias for retrieving a [`Driver`]s [`DriverFile`] implementation from its +/// [`DriverObject`] implementation. +/// +/// [`Driver`]: drm::Driver +/// [`DriverFile`]: drm::file::DriverFile +pub type DriverFile <T > = drm::File <<<T as BaseDriverObject >::Driver as drm::Driver >::File >; +/// GEM object functions, which must be implemented by drivers. pub trait BaseDriverObject :Sync +Send +Sized {/// Parent `Driver` for this object.
@@ -23,19 +30,12 @@ pub trait BaseDriverObject: Sync + Send + Sized {fn new (dev: &drm::Device <Self ::Driver >, size:usize ) ->impl PinInit <Self ,Error >;/// Open a new handle to an existing object, associated with a File. -fn open ( - _obj: &<Self ::Driver as drm::Driver >::Object , - _file: &drm::File <<Self ::Driver as drm::Driver >::File >, - ) ->Result { +fn open (_obj: &<Self ::Driver as drm::Driver >::Object , _file: &DriverFile <Self >) ->Result {Ok (()) }/// Close a handle to an existing object, associated with a File. -fn close ( - _obj: &<Self ::Driver as drm::Driver >::Object , - _file: &drm::File <<Self ::Driver as drm::Driver >::File >, - ) { - } +fn close (_obj: &<Self ::Driver as drm::Driver >::Object , _file: &DriverFile <Self >) {} }/// Trait that represents a GEM object subtype
@@ -79,7 +79,8 @@ extern "C" fn open_callback<T: BaseDriverObject>( raw_file: *mut bindings::drm_file, ) -> core::ffi::c_int {// SAFETY: `open_callback` is only ever called with a valid pointer to a `struct drm_file`. -let file =unsafe { drm::File ::<<T ::Driver as drm::Driver >::File >::as_ref (raw_file) }; +let file =unsafe {DriverFile ::<T >::as_ref (raw_file) }; +// SAFETY: `open_callback` is specified in the AllocOps structure for `DriverObject<T>`, // ensuring that `raw_obj` is contained within a `DriverObject<T>` let obj =unsafe { <<T ::Driver as drm::Driver >::Object as IntoGEMObject >::as_ref (raw_obj) };
@@ -95,7 +96,7 @@ extern "C" fn close_callback<T: BaseDriverObject>( raw_file: *mut bindings::drm_file, ) {// SAFETY: `open_callback` is only ever called with a valid pointer to a `struct drm_file`. -let file =unsafe { drm::File ::<<T ::Driver as drm::Driver >::File >::as_ref (raw_file) }; +let file =unsafe {DriverFile ::<T >::as_ref (raw_file) };// SAFETY: `close_callback` is specified in the AllocOps structure for `Object<T>`, ensuring // that `raw_obj` is indeed contained within a `Object<T>`.
Signature · 1 line
2.49.0
PATCH v3 3/4 rust: drm: gem: Drop Object::SIZE
In reply to Lyude PaulDrive-by fix, it doesn't seem like anything actually uses this constant anymore.
--- rust/kernel/drm/gem/mod.rs | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-)
rust/kernel/drm/gem/mod.rs +1 -4
@@ -12,7 +12,7 @@ prelude::*, types::{ARef, AlwaysRefCounted, Opaque}, }; -use core::{mem, ops::Deref , ptr::NonNull }; +use core::{ops::Deref , ptr::NonNull };/// A type alias for retrieving a [`Driver`]s [`DriverFile`] implementation from its /// [`DriverObject`] implementation.
@@ -197,9 +197,6 @@ pub struct Object<T: BaseDriverObject + Send + Sync> { }impl <T :BaseDriverObject >Object <T > { -/// The size of this object's structure. -pub const SIZE :usize = mem::size_of ::<Self >(); -const OBJECT_FUNCS : bindings::drm_gem_object_funcs = bindings::drm_gem_object_funcs { free:Some (Self ::free_callback), open:Some (open_callback ::<T >),
Signature · 1 line
2.49.0
PATCH v3 4/4 rust: drm: Use gem::BaseDriverObject in driver::Driver
In reply to Lyude PaulOne of the original intents with the gem bindings was that drivers could specify additional gem implementations, in order to enable for driver private gem objects. This wasn't really possible however, as up until now our GEM bindings have always assumed that the only GEM object we would run into was driver::Driver::Object - meaning that implementing another GEM object type would result in all of the BaseDriverObject callbacks assuming the wrong type.
This is a pretty easy fix though, all we need to do is specify a BaseDriverObject in driver::Driver instead of an AllocImpl, and then add an associated type for AllocImpl in BaseDriverObject. That way each BaseDriverObject has its own AllocImpl allowing it to know which type to provide in BaseDriverObject callbacks, and driver::Driver can simply go through the BaseDriverObject to its AllocImpl type in order to get access to ALLOC_OPS.
So, let's do this and update Nova for these changes.
--- drivers/gpu/drm/nova/driver.rs | 4 ++-- drivers/gpu/drm/nova/gem.rs | 1 + rust/kernel/drm/device.rs | 17 ++++++++++------- rust/kernel/drm/driver.rs | 2 +- rust/kernel/drm/gem/mod.rs | 11 +++++++---- 5 files changed, 21 insertions(+), 14 deletions(-)
drivers/gpu/drm/nova/driver.rs +2 -2
@@ -1,6 +1,6 @@// SPDX-License-Identifier: GPL-2.0 -use kernel::{auxiliary, c_str, device::Core , drm, drm::gem, drm::ioctl, prelude::*, types::ARef }; +use kernel::{auxiliary, c_str, device::Core , drm, drm::ioctl, prelude::*, types::ARef };use crate ::file::File ;use crate ::gem::NovaObject ;
@@ -57,7 +57,7 @@ fn probe(adev: &auxiliary::Device<Core>, _info: &Self::IdInfo) -> Result<Pin<KBoimpl drm::Driver for NovaDriver {type Data =NovaData ;type File =File ; -type Object = gem::Object <NovaObject >; +type Object =NovaObject ;const INFO : drm::DriverInfo =INFO ;
drivers/gpu/drm/nova/gem.rs +1 -0
@@ -18,6 +18,7 @@ pub(crate) struct NovaObject {}impl gem::BaseDriverObject for NovaObject {type Driver =NovaDriver ; +type Object = gem::Object <Self >;fn new (_dev: &NovaDevice , _size:usize ) ->impl PinInit <Self ,Error > {try_pin_init! (NovaObject {})
rust/kernel/drm/device.rs +10 -7
@@ -60,6 +60,9 @@ pub struct Device<T: drm::Driver> { data: T::Data, } +/// A type alias for referring to the [`AllocImpl`] implementation for a DRM driver. +type DriverAllocImpl <T > = <<T as drm::Driver >::Object as drm::gem::BaseDriverObject >::Object ; +impl <T : drm::Driver >Device <T > {const VTABLE : bindings::drm_driver =drm_legacy_fields! { load:None ,
@@ -70,13 +73,13 @@ impl<T: drm::Driver> Device<T> { master_set: None, master_drop: None, debugfs_init: None, - gem_create_object: T::Object::ALLOC_OPS.gem_create_object, - prime_handle_to_fd: T::Object::ALLOC_OPS.prime_handle_to_fd, - prime_fd_to_handle: T::Object::ALLOC_OPS.prime_fd_to_handle, - gem_prime_import: T::Object::ALLOC_OPS.gem_prime_import, - gem_prime_import_sg_table: T::Object::ALLOC_OPS.gem_prime_import_sg_table, - dumb_create: T::Object::ALLOC_OPS.dumb_create, - dumb_map_offset: T::Object::ALLOC_OPS.dumb_map_offset, + gem_create_object: DriverAllocImpl::<T>::ALLOC_OPS.gem_create_object, + prime_handle_to_fd: DriverAllocImpl::<T>::ALLOC_OPS.prime_handle_to_fd, + prime_fd_to_handle: DriverAllocImpl::<T>::ALLOC_OPS.prime_fd_to_handle, + gem_prime_import: DriverAllocImpl::<T>::ALLOC_OPS.gem_prime_import, + gem_prime_import_sg_table: DriverAllocImpl::<T>::ALLOC_OPS.gem_prime_import_sg_table, + dumb_create: DriverAllocImpl::<T>::ALLOC_OPS.dumb_create, + dumb_map_offset: DriverAllocImpl::<T>::ALLOC_OPS.dumb_map_offset, show_fdinfo: None, fbdev_probe: None,
rust/kernel/drm/driver.rs +1 -1
@@ -106,7 +106,7 @@ pub trait Driver {type Data :Sync +Send ;/// The type used to manage memory for this driver. -type Object :AllocImpl ; +type Object : drm::gem::BaseDriverObject ;/// The type used to represent a DRM File (client) type File : drm::file::DriverFile ;
rust/kernel/drm/gem/mod.rs +7 -4
@@ -26,16 +26,19 @@ pub trait BaseDriverObject: Sync + Send + Sized {/// Parent `Driver` for this object. type Driver : drm::Driver ; +/// The GEM object type that will be passed to various callbacks. +type Object :AllocImpl ; +/// Create a new driver data object for a GEM object of a given size. fn new (dev: &drm::Device <Self ::Driver >, size:usize ) ->impl PinInit <Self ,Error >;/// Open a new handle to an existing object, associated with a File. -fn open (_obj: &<Self ::Driver as drm::Driver >::Object , _file: &DriverFile <Self >) ->Result { +fn open (_obj: &Self ::Object , _file: &DriverFile <Self >) ->Result {Ok (()) }/// Close a handle to an existing object, associated with a File. -fn close (_obj: &<Self ::Driver as drm::Driver >::Object , _file: &DriverFile <Self >) {} +fn close (_obj: &Self ::Object , _file: &DriverFile <Self >) {} }/// Trait that represents a GEM object subtype
@@ -83,7 +86,7 @@ extern "C" fn open_callback<T: BaseDriverObject>(// SAFETY: `open_callback` is specified in the AllocOps structure for `DriverObject<T>`, // ensuring that `raw_obj` is contained within a `DriverObject<T>` -let obj =unsafe { <<T ::Driver as drm::Driver >::Object as IntoGEMObject >::as_ref (raw_obj) }; +let obj =unsafe {T ::Object ::as_ref (raw_obj) };match T ::open (obj, file) {Err (e) => e.to_errno (),
@@ -100,7 +103,7 @@ extern "C" fn close_callback<T: BaseDriverObject>(// 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 { <<T ::Driver as drm::Driver >::Object as IntoGEMObject >::as_ref (raw_obj) }; +let obj =unsafe {T ::Object ::as_ref (raw_obj) };T ::close (obj, file); }
Signature · 1 line
2.49.0