[v2,5/8] rust: drm: add DRM driver registration

Commit Message

Danilo Krummrich June 18, 2024, 11:31 p.m. UTC

Implement the DRM driver `Registration`.

The `Registration` structure is responsible to register and unregister a
DRM driver. It makes use of the `Devres` container in order to allow the
`Registration` to be owned by devres, such that it is automatically
dropped (and the DRM driver unregistered) once the parent device is
unbound.

Co-developed-by: Asahi Lina <[e-mail]>
Signed-off-by: Asahi Lina <[e-mail]>
Signed-off-by: Danilo Krummrich <[e-mail]>
---
 rust/kernel/drm/drv.rs | 57 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

Comments

Lyude Paul July 2, 2024, 5:26 p.m. UTC | #1

Some comments down below:

On Wed, 2024-06-19 at 01:31 +0200, Danilo Krummrich wrote:
> Implement the DRM driver `Registration`.
> 
> The `Registration` structure is responsible to register and unregister a
> DRM driver. It makes use of the `Devres` container in order to allow the
> `Registration` to be owned by devres, such that it is automatically
> dropped (and the DRM driver unregistered) once the parent device is
> unbound.
> 
> Co-developed-by: Asahi Lina <[e-mail]>
> Signed-off-by: Asahi Lina <[e-mail]>
> Signed-off-by: Danilo Krummrich <[e-mail]>
> ---
>  rust/kernel/drm/drv.rs | 57 +++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 56 insertions(+), 1 deletion(-)
> 
> diff --git a/rust/kernel/drm/drv.rs b/rust/kernel/drm/drv.rs
> index cd594a32f9e4..ebb79a8c90ee 100644
> --- a/rust/kernel/drm/drv.rs
> +++ b/rust/kernel/drm/drv.rs
> @@ -4,7 +4,16 @@
>  //!
>  //! C header: [`include/linux/drm/drm_drv.h`](srctree/include/linux/drm/drm_drv.h)
>  
> -use crate::{bindings, drm, private::Sealed, str::CStr, types::ForeignOwnable};
> +use crate::{
> +    alloc::flags::*,
> +    bindings,
> +    devres::Devres,
> +    drm,
> +    error::{Error, Result},
> +    private::Sealed,
> +    str::CStr,
> +    types::{ARef, ForeignOwnable},
> +};
>  use macros::vtable;
>  
>  /// Driver use the GEM memory manager. This should be set for all modern drivers.
> @@ -139,3 +148,49 @@ pub trait Driver {
>      /// IOCTL list. See `kernel::drm::ioctl::declare_drm_ioctls!{}`.
>      const IOCTLS: &'static [drm::ioctl::DrmIoctlDescriptor];
>  }
> +
> +/// The registration type of a `drm::device::Device`.
> +///
> +/// Once the `Registration` structure is dropped, the device is unregistered.
> +pub struct Registration<T: Driver>(ARef<drm::device::Device<T>>);
> +
> +impl<T: Driver> Registration<T> {
> +    /// Creates a new [`Registration`] and registers it.
> +    pub fn new(drm: ARef<drm::device::Device<T>>, flags: usize) -> Result<Self> {
> +        // SAFETY: Safe by the invariants of `drm::device::Device`.
> +        let ret = unsafe { bindings::drm_dev_register(drm.as_raw(), flags as u64) };
> +        if ret < 0 {
> +            return Err(Error::from_errno(ret));
> +        }

There's a nicer way of handling this:

to_result(unsafe { bindings::drm_dev_register(drm.as_raw(), flags as u64) })?;

(Also I think I may have already mentioned this, but we can drop the
flags argument entirely. It's only used for the .load/.unload callbacks
in DRM, both of which are deprecated.

> +
> +        Ok(Self(drm))
> +    }
> +
> +    /// Same as [`Registration::new`}, but transfers ownership of the [`Registration`] to `Devres`.
> +    pub fn new_foreign_owned(drm: ARef<drm::device::Device<T>>, flags: usize) -> Result {
> +        let reg = Registration::<T>::new(drm.clone(), flags)?;
> +
> +        Devres::new_foreign_owned(drm.as_ref(), reg, GFP_KERNEL)
> +    }
> +
> +    /// Returns a reference to the `Device` instance for this registration.
> +    pub fn device(&self) -> &drm::device::Device<T> {
> +        &self.0
> +    }
> +}
> +
> +// SAFETY: `Registration` doesn't offer any methods or access to fields when shared between
> +// threads, hence it's safe to share it.
> +unsafe impl<T: Driver> Sync for Registration<T> {}
> +
> +// SAFETY: Registration with and unregistration from the DRM subsystem can happen from any thread.
> +unsafe impl<T: Driver> Send for Registration<T> {}
> +
> +impl<T: Driver> Drop for Registration<T> {
> +    /// Removes the registration from the kernel if it has completed successfully before.
> +    fn drop(&mut self) {
> +        // SAFETY: Safe by the invariant of `ARef<drm::device::Device<T>>`. The existance of this
> +        // `Registration` also guarantees the this `drm::device::Device` is actually registered.
> +        unsafe { bindings::drm_dev_unregister(self.0.as_raw()) };
> +    }
> +}

Patch

diff --git a/rust/kernel/drm/drv.rs b/rust/kernel/drm/drv.rs
index cd594a32f9e4..ebb79a8c90ee 100644
--- a/rust/kernel/drm/drv.rs
+++ b/rust/kernel/drm/drv.rs
@@ -4,7 +4,16 @@ 
 //!
 //! C header: [`include/linux/drm/drm_drv.h`](srctree/include/linux/drm/drm_drv.h)
 
-use crate::{bindings, drm, private::Sealed, str::CStr, types::ForeignOwnable};
+use crate::{
+    alloc::flags::*,
+    bindings,
+    devres::Devres,
+    drm,
+    error::{Error, Result},
+    private::Sealed,
+    str::CStr,
+    types::{ARef, ForeignOwnable},
+};
 use macros::vtable;
 
 /// Driver use the GEM memory manager. This should be set for all modern drivers.
@@ -139,3 +148,49 @@  pub trait Driver {
     /// IOCTL list. See `kernel::drm::ioctl::declare_drm_ioctls!{}`.
     const IOCTLS: &'static [drm::ioctl::DrmIoctlDescriptor];
 }
+
+/// The registration type of a `drm::device::Device`.
+///
+/// Once the `Registration` structure is dropped, the device is unregistered.
+pub struct Registration<T: Driver>(ARef<drm::device::Device<T>>);
+
+impl<T: Driver> Registration<T> {
+    /// Creates a new [`Registration`] and registers it.
+    pub fn new(drm: ARef<drm::device::Device<T>>, flags: usize) -> Result<Self> {
+        // SAFETY: Safe by the invariants of `drm::device::Device`.
+        let ret = unsafe { bindings::drm_dev_register(drm.as_raw(), flags as u64) };
+        if ret < 0 {
+            return Err(Error::from_errno(ret));
+        }
+
+        Ok(Self(drm))
+    }
+
+    /// Same as [`Registration::new`}, but transfers ownership of the [`Registration`] to `Devres`.
+    pub fn new_foreign_owned(drm: ARef<drm::device::Device<T>>, flags: usize) -> Result {
+        let reg = Registration::<T>::new(drm.clone(), flags)?;
+
+        Devres::new_foreign_owned(drm.as_ref(), reg, GFP_KERNEL)
+    }
+
+    /// Returns a reference to the `Device` instance for this registration.
+    pub fn device(&self) -> &drm::device::Device<T> {
+        &self.0
+    }
+}
+
+// SAFETY: `Registration` doesn't offer any methods or access to fields when shared between
+// threads, hence it's safe to share it.
+unsafe impl<T: Driver> Sync for Registration<T> {}
+
+// SAFETY: Registration with and unregistration from the DRM subsystem can happen from any thread.
+unsafe impl<T: Driver> Send for Registration<T> {}
+
+impl<T: Driver> Drop for Registration<T> {
+    /// Removes the registration from the kernel if it has completed successfully before.
+    fn drop(&mut self) {
+        // SAFETY: Safe by the invariant of `ARef<drm::device::Device<T>>`. The existance of this
+        // `Registration` also guarantees the this `drm::device::Device` is actually registered.
+        unsafe { bindings::drm_dev_unregister(self.0.as_raw()) };
+    }
+}