Introduce DeviceContext
Subsystems (6)
v6 cover Introduce DeviceContext
Previous version of this patch series:
https://patchwork.freedesktop.org/series/160217/#rev5
One of the unsolved issues we still have with the rust DRM bindings is the ability to limit certain Device operations to contexts where we can guarantee that a Device has been fully initialized and registered with userspace, or vice-versa (e.g. must be unregistered).
While the previous solution for this that I had was simply not exposing drm::Device at all until the device has been registered with userspace, unfortunately this isn't enough since:
* As we found out with Tyr, drivers occasionally need to be able to create GEM objects before device registration
* We would still need to be able to handle KMS callbacks which could be invoked after KMS init but before userspace registration (not handled in this series specifically, but DeviceContext will be required for handling this).
This patch series provides a pretty nice solution to this, by implementing a very similar solution to kernel::device::DeviceContext:
introducing our own DeviceContext type state.
Series-wide changes
V2:
* s/DeviceCtx/DeviceContext/ for consistency
* Move private driver-data availability to the Registration DeviceContext
* s/AnyCtx/Init/
V4:
* Split out DriverAllocImpl into it's own patch V6:
* Rebase
More changes described in each patch description.
Lyude Paul (3):
rust/drm: Introduce DeviceContext rust/drm/gem: Add DriverAllocImpl type alias rust/drm/gem: Use DeviceContext with GEM objects
drivers/gpu/drm/nova/driver.rs | 10 +- drivers/gpu/drm/nova/gem.rs | 15 ++- drivers/gpu/drm/tyr/driver.rs | 12 +- drivers/gpu/drm/tyr/gem.rs | 11 +- rust/kernel/drm/device.rs | 240 +++++++++++++++++++++++++-------- rust/kernel/drm/driver.rs | 37 +++-- rust/kernel/drm/gem/mod.rs | 72 +++++++--- rust/kernel/drm/gem/shmem.rs | 57 ++++---- rust/kernel/drm/mod.rs | 4 + 9 files changed, 333 insertions(+), 125 deletions(-)
base-commit: 37f748ed0c19e007e7c5677f5d605d6b93841792
Signature · 1 line
2.54.0
PATCH v6 1/3 rust/drm: Introduce DeviceContext
One of the tricky things about DRM bindings in Rust is the fact that initialization of a DRM device is a multi-step process. It's quite normal for a device driver to start making use of its DRM device for tasks like creating GEM objects before userspace registration happens. This is an issue in rust though, since prior to userspace registration the device is only partly initialized. This means there's a plethora of DRM device operations we can't yet expose without opening up the door to UB if the DRM device in question isn't yet registered.
Additionally, this isn't something we can reliably check at runtime. And even if we could, performing an operation which requires the device be registered when the device isn't actually registered is a programmer bug, meaning there's no real way to gracefully handle such a mistake at runtime. And even if that wasn't the case, it would be horrendously annoying and noisy to have to check if a device is registered constantly throughout a driver.
In order to solve this, we first take inspiration from kernel::device::DeviceContext and introduce kernel::drm::DeviceContext. This provides us with a ZST type that we can generalize over to represent contexts where a device is known to have been registered with userspace at some point in time (Registered), along with contexts where we can't make such a guarantee (Uninit).
It's important to note we intentionally do not provide a DeviceContext which represents an unregistered device. This is because there's no reasonable way to guarantee that a device with long-living references to itself will not be registered eventually with userspace. Instead, we provide a new-type for this: UnregisteredDevice which can provide a guarantee that the Device has never been registered with userspace. To ensure this, we modify Registration so that creating a new Registration requires passing ownership of an UnregisteredDevice.
---
V2:
* Make sure that UnregisteredDevice is not thread-safe (since DRM device initialization is also not thread-safe)
* Rename from AnyCtx to Uninit, I think this name actually makes a bit more sense.
* Change assume_registered() to assume_ctx()
Since it looks like in some situations, we'll want to update the DeviceContext of a object to the latest DeviceContext we know the Device to be in.
* Rename Init to Uninit
When we eventually add KMS support, we're going to have 3 different DeviceContexts - Uninit, Init, Registered. Additionally, aside from not being registered there are a number of portions of the rest of the Device which also aren't usable before at least the Init context - so the naming of Uninit makes this a little clearer.
* s/DeviceContext/DeviceContext/
For consistency with the rest of the kernel
* Drop as_ref::<Device<T, Uninit>>() for now since I don't actually think we need this quite yet
V3:
* Get rid of drm_dev_ctx!, as we don't actually need to implement Send or Sync ourselves
* Remove mention of C function in drm::device::Registration rustdoc
* Add more documentation to the DeviceContext trait, go into detail about the various setup phases and such.
* Add missing period to comment in UnregisteredDevice::new(). V4:
* Address some comments from Danilo I missed last round:
* Remove leftover rebase detritus from new_foreign_owned() (the seemingly useless cast)
* Remove no-op mention in Registered device context
V5:
* Fix incorrect size on Kmalloc (Deborah)
V6:
* Rebase
drivers/gpu/drm/nova/driver.rs | 8 +- drivers/gpu/drm/tyr/driver.rs | 10 +- rust/kernel/drm/device.rs | 222 +++++++++++++++++++++++++-------- rust/kernel/drm/driver.rs | 35 ++++-- rust/kernel/drm/mod.rs | 4 + 5 files changed, 214 insertions(+), 65 deletions(-)
drivers/gpu/drm/nova/driver.rs +4 -4
@@ -21,7 +21,7 @@ pub(crate) struct NovaDriver { }/// Convienence type alias for the DRM device type for this driver -pub (crate )type NovaDevice = drm::Device <NovaDriver >; +pub (crate )type NovaDevice <Ctx = drm::Registered > = drm::Device <NovaDriver ,Ctx >;#[pin_data] pub (crate )struct NovaData {
@@ -56,10 +56,10 @@ impl auxiliary::Driver for NovaDriver {fn probe (adev: &auxiliary::Device <Core >, _info: &Self ::IdInfo ) ->impl PinInit <Self ,Error > {let data =try_pin_init! (NovaData { adev: adev.into () }); -let drm = drm::Device ::<Self >::new (adev.as_ref (), data)?; - drm::Registration ::new_foreign_owned (&drm, adev.as_ref (),0 )?; +let drm = drm::UnregisteredDevice ::<Self >::new (adev.as_ref (), data)?; +let drm = drm::Registration ::new_foreign_owned (drm, adev.as_ref (),0 )?; -Ok (Self { drm }) +Ok (Self { drm: drm.into () }) } }
drivers/gpu/drm/tyr/driver.rs +6 -4
@@ -49,7 +49,7 @@pub (crate )struct TyrDrmDriver ;/// Convenience type alias for the DRM device type for this driver. -pub (crate )type TyrDrmDevice = drm::Device <TyrDrmDriver >; +pub (crate )type TyrDrmDevice <Ctx = drm::Registered > = drm::Device <TyrDrmDriver ,Ctx >;#[pin_data( PinnedDrop )] pub (crate )struct TyrPlatformDriverData {
@@ -152,10 +152,12 @@ fn probe( gpu_info, }); -let ddev:ARef <TyrDrmDevice > = drm::Device ::new (pdev.as_ref (), data)?; - drm::driver::Registration ::new_foreign_owned (&ddev, pdev.as_ref (),0 )?; +let tdev = drm::UnregisteredDevice ::<TyrDrmDriver >::new (pdev.as_ref (), data)?; +let tdev = drm::driver::Registration ::new_foreign_owned (tdev, pdev.as_ref (),0 )?; -let driver =TyrPlatformDriverData { _device: ddev }; +let driver =TyrPlatformDriverData { + _device: tdev.into (), + };// We need this to be dev_info!() because dev_dbg!() does not work at // all in Rust for now, and we need to see whether probe succeeded.
rust/kernel/drm/device.rs +173 -49
359 lines not on this page · raw message
rust/kernel/drm/driver.rs +27 -8
@@ -13,6 +13,10 @@ prelude::*, sync::aref::ARef, // }; +use core::{ + mem, + ptr::NonNull ,// +};/// Driver use the GEM memory manager. This should be set for all modern drivers. pub (crate )const FEAT_GEM :u32 = bindings::drm_driver_feature_DRIVER_GEM;
@@ -123,21 +127,31 @@ pub trait Driver {pub struct Registration <T :Driver >(ARef <drm::Device <T >>);impl <T :Driver >Registration <T > { -fn new (drm: &drm::Device <T >, flags:usize ) ->Result <Self > { +fn new (drm: drm::UnregisteredDevice <T >, flags:usize ) ->Result <Self > {// SAFETY: `drm.as_raw()` is valid by the invariants of `drm::Device`. to_result (unsafe { bindings::drm_dev_register (drm.as_raw (), flags) })?; -Ok (Self (drm.into ())) +// SAFETY: We just called `drm_dev_register` above +let new =NonNull ::from (unsafe { drm.assume_ctx () }); + +// Leak the ARef from UnregisteredDevice in preparation for transferring its ownership. + mem::forget (drm); + +// SAFETY: `drm`'s `Drop` constructor was never called, ensuring that there remains at least +// one reference to the device - which we take ownership over here. +let new =unsafe {ARef ::from_raw (new) }; + +Ok (Self (new)) } -/// Registers a new [`Device`](drm::Device) with userspace. +/// Registers a new [`UnregisteredDevice`](drm::UnregisteredDevice) with userspace. /// /// Ownership of the [`Registration`] object is passed to [`devres::register`]. -pub fn new_foreign_owned ( - drm: &drm::Device <T >, - dev: &device::Device <device::Bound >, +pub fn new_foreign_owned <'a>( + drm: drm::UnregisteredDevice <T >, + dev: &'a device::Device <device::Bound >, flags:usize , - ) ->Result + ) ->Result <&'a drm::Device <T >>where T : 'static, {
@@ -146,8 +160,13 @@ pub fn new_foreign_owned( }let reg =Registration ::<T >::new (drm, flags)?; +let drm =NonNull ::from (reg.device ()); + + devres::register (dev, reg,GFP_KERNEL )?; - devres::register (dev, reg,GFP_KERNEL ) +// SAFETY: Since `reg` was passed to devres::register(), the device now owns the lifetime +// of the DRM registration - ensuring that this references lives for at least as long as 'a. +Ok (unsafe { drm.as_ref () }) }/// Returns a reference to the `Device` instance for this registration.
rust/kernel/drm/mod.rs +4 -0
@@ -10,6 +10,10 @@pub mod ioctl;pub use self::device::Device ; +pub use self::device::DeviceContext ; +pub use self::device::Registered ; +pub use self::device::Uninit ; +pub use self::device::UnregisteredDevice ;pub use self::driver::Driver ;pub use self::driver::DriverInfo ;pub use self::driver::Registration ;
Signature · 1 line
2.54.0
PATCH v6 2/3 rust/drm/gem: Add DriverAllocImpl type alias
In reply to Lyude PaulThis is just a type alias that resolves into the AllocImpl for a given
T: drm::gem::DriverObject
--- rust/kernel/drm/gem/mod.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)
rust/kernel/drm/gem/mod.rs +7 -2
@@ -73,6 +73,11 @@ unsafe fn dec_ref(obj: core::ptr::NonNull<Self>) {/// [`DriverFile`]: drm::file::DriverFile pub type DriverFile <T > = drm::File <<<T as DriverObject >::Driver as drm::Driver >::File >; +/// A type alias for retrieving the current [`AllocImpl`] for a given [`DriverObject`]. +/// +/// [`Driver`]: drm::Driver +pub type DriverAllocImpl <T > = <<T as DriverObject >::Driver as drm::Driver >::Object ; +/// GEM object functions, which must be implemented by drivers. pub trait DriverObject :Sync +Send +Sized {/// Parent `Driver` for this object.
@@ -89,12 +94,12 @@ fn new( ) -> 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: &DriverAllocImpl <Self >, _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: &DriverAllocImpl <Self >, _file: &DriverFile <Self >) {} }/// Trait that represents a GEM object subtype
Signature · 1 line
2.54.0
PATCH v6 3/3 rust/drm/gem: Use DeviceContext with GEM objects
In reply to Lyude PaulNow that we have the ability to represent the context in which a DRM device is in at compile-time, we can start carrying around this context with GEM object types in order to allow a driver to safely create GEM objects before a DRM device has registered with userspace.
---
V4:
* Add a comment to explain the Uninit DeviceContext usage in the GEM object vtable (tl;dr: the DeviceContext is meaningless here)
V5:
* Improve invariant comment above drm_gem_object_init()
V6:
* Rebase
drivers/gpu/drm/nova/driver.rs | 2 +- drivers/gpu/drm/nova/gem.rs | 15 +++++--- drivers/gpu/drm/tyr/driver.rs | 2 +- drivers/gpu/drm/tyr/gem.rs | 11 ++++-- rust/kernel/drm/device.rs | 18 ++++++---- rust/kernel/drm/driver.rs | 2 +- rust/kernel/drm/gem/mod.rs | 65 +++++++++++++++++++++++----------- rust/kernel/drm/gem/shmem.rs | 57 +++++++++++++++++------------ 8 files changed, 113 insertions(+), 59 deletions(-)
drivers/gpu/drm/nova/driver.rs +1 -1
@@ -67,7 +67,7 @@ fn probe(adev: &auxiliary::Device<Core>, _info: &Self::IdInfo) -> impl PinInit<Simpl drm::Driver for NovaDriver {type Data =NovaData ;type File =File ; -type Object = gem::Object <NovaObject >; +type Object <Ctx : drm::DeviceContext > = gem::Object <NovaObject ,Ctx >;const INFO : drm::DriverInfo =INFO ;
drivers/gpu/drm/nova/gem.rs +11 -4
@@ -2,7 +2,7 @@use kernel::{ drm, - drm::{gem, gem::BaseObject }, + drm::{gem, gem::BaseObject ,DeviceContext }, page, prelude::*, sync::aref::ARef ,
@@ -21,20 +21,27 @@ impl gem::DriverObject for NovaObject {type Driver =NovaDriver ;type Args = (); -fn new (_dev: &NovaDevice , _size:usize , _args:Self ::Args ) ->impl PinInit <Self ,Error > { +fn new <Ctx :DeviceContext >( + _dev: &NovaDevice <Ctx >, + _size:usize , + _args:Self ::Args , + ) ->impl PinInit <Self ,Error > {try_pin_init! (NovaObject {}) } }impl NovaObject {/// Create a new DRM GEM object. -pub (crate )fn new (dev: &NovaDevice , size:usize ) ->Result <ARef <gem::Object <Self >>> { +pub (crate )fn new <Ctx :DeviceContext >( + dev: &NovaDevice <Ctx >, + size:usize , + ) ->Result <ARef <gem::Object <Self ,Ctx >>> {if size ==0 {return Err (EINVAL ); }let aligned_size = page::page_align (size).ok_or (EINVAL )?; - gem::Object ::new (dev, aligned_size, ()) + gem::Object ::<Self ,Ctx >::new (dev, aligned_size, ()) }/// Look up a GEM object handle for a `File` and return an `ObjectRef` for it.
drivers/gpu/drm/tyr/driver.rs +1 -1
@@ -185,7 +185,7 @@ fn drop(self: Pin<&mut Self>) {}impl drm::Driver for TyrDrmDriver {type Data =TyrDrmDeviceData ;type File =TyrDrmFileData ; -type Object = drm::gem::shmem::Object <BoData >; +type Object <R : drm::DeviceContext > = drm::gem::shmem::Object <BoData ,R >;const INFO : drm::DriverInfo =INFO ;
drivers/gpu/drm/tyr/gem.rs +9 -2
@@ -5,7 +5,10 @@//! DRM's GEM subsystem with shmem backing. use kernel::{ - drm::gem, + drm::{ + gem, +DeviceContext ,// + }, prelude::*,// };
@@ -30,7 +33,11 @@ impl gem::DriverObject for BoData {type Driver =TyrDrmDriver ;type Args =BoCreateArgs ; -fn new (_dev: &TyrDrmDevice , _size:usize , args:BoCreateArgs ) ->impl PinInit <Self ,Error > { +fn new <Ctx :DeviceContext >( + _dev: &TyrDrmDevice <Ctx >, + _size:usize , + args:BoCreateArgs , + ) ->impl PinInit <Self ,Error > {try_pin_init! (Self { flags: args.flags }) } }
rust/kernel/drm/device.rs +11 -7
@@ -167,13 +167,17 @@ impl<T: drm::Driver> UnregisteredDevice<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, + +// Ignore the Uninit DeviceContext below. It is only provided because it is required by the +// compiler, and it is not actually used by these functions. + gem_create_object: T::Object::<Uninit>::ALLOC_OPS.gem_create_object, + prime_handle_to_fd: T::Object::<Uninit>::ALLOC_OPS.prime_handle_to_fd, + prime_fd_to_handle: T::Object::<Uninit>::ALLOC_OPS.prime_fd_to_handle, + gem_prime_import: T::Object::<Uninit>::ALLOC_OPS.gem_prime_import, + gem_prime_import_sg_table: T::Object::<Uninit>::ALLOC_OPS.gem_prime_import_sg_table, + dumb_create: T::Object::<Uninit>::ALLOC_OPS.dumb_create, + dumb_map_offset: T::Object::<Uninit>::ALLOC_OPS.dumb_map_offset, + show_fdinfo: None, fbdev_probe: None,
rust/kernel/drm/driver.rs +1 -1
@@ -109,7 +109,7 @@ pub trait Driver {type Data :Sync +Send ;/// The type used to manage memory for this driver. -type Object :AllocImpl ; +type Object <Ctx : drm::DeviceContext >:AllocImpl ;/// The type used to represent a DRM File (client) type File : drm::file::DriverFile ;
rust/kernel/drm/gem/mod.rs +45 -20
178 lines not on this page · raw message
rust/kernel/drm/gem/shmem.rs +34 -23
163 lines not on this page · raw message
Signature · 1 line
2.54.0
Quoted 1 line · Lyude Paul
[PATCH v6 0/3] Introduce DeviceContext
Applied, thanks!
Branch: drm-rust-next
Tree: https://gitlab.freedesktop.org/drm/rust/kernel.git
[1/3] rust/drm: Introduce DeviceContext
commit: 571d4242c466
[2/3] rust/drm/gem: Add DriverAllocImpl type alias
commit: 43a5d04a743b
[3/3] rust/drm/gem: Use DeviceContext with GEM objects
commit: 0023a1e8d01aThe patches will appear in the next linux-next integration (typically within 24 hours on weekdays).
The patches are queued up for the upcoming merge window for the next major kernel release.