* [PATCH v5 1/8] rust/drm: Add gem::impl_aref_for_gem_obj!
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
2025-10-23 21:22 ` [PATCH v5 2/8] rust: helpers: Add bindings/wrappers for dma_resv_lock Lyude Paul
` (6 subsequent siblings)
7 siblings, 0 replies; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: David Airlie, Simona Vetter, Miguel Ojeda, Alex Gaynor,
Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Trevor Gross, Asahi Lina, Shankari Anand
In the future we're going to be introducing more GEM object types in rust
then just gem::Object<T>. Since all types of GEM objects have refcounting,
let's introduce a macro that we can use in the gem crate in order to copy
this boilerplate implementation for each type: impl_aref_for_gem_obj!().
Signed-off-by: Lyude Paul <lyude@redhat.com>
---
V5:
* Move .as_raw() call to `let obj` in dec_ref, to ensure that the reference
to object is not live by the time that we call drm_gem_object_put().
* Add missing #[macro_export] annotation
rust/kernel/drm/gem/mod.rs | 54 +++++++++++++++++++++++++++-----------
1 file changed, 39 insertions(+), 15 deletions(-)
diff --git a/rust/kernel/drm/gem/mod.rs b/rust/kernel/drm/gem/mod.rs
index 20c2769a8c9d6..32bff2e8463f4 100644
--- a/rust/kernel/drm/gem/mod.rs
+++ b/rust/kernel/drm/gem/mod.rs
@@ -15,6 +15,44 @@
};
use core::{ops::Deref, ptr::NonNull};
+/// A macro for implementing [`AlwaysRefCounted`] for any GEM object type.
+///
+/// Since all GEM objects use the same refcounting scheme.
+#[macro_export]
+macro_rules! impl_aref_for_gem_obj {
+ (
+ impl $( <$( $tparam_id:ident ),+> )? for $type:ty
+ $(
+ where
+ $( $bind_param:path : $bind_trait:path ),+
+ )?
+ ) => {
+ // SAFETY: All gem objects are refcounted
+ unsafe impl $( <$( $tparam_id ),+> )? $crate::types::AlwaysRefCounted for $type
+ $(
+ where
+ $( $bind_param : $bind_trait ),+
+ )?
+ {
+ fn inc_ref(&self) {
+ // SAFETY: The existence of a shared reference guarantees that the refcount is
+ // non-zero.
+ unsafe { bindings::drm_gem_object_get(self.as_raw()) };
+ }
+
+ unsafe fn dec_ref(obj: core::ptr::NonNull<Self>) {
+ // SAFETY: `obj` is a valid pointer to an `Object<T>`.
+ let obj = unsafe { obj.as_ref() }.as_raw();
+
+ // SAFETY: The safety requirements guarantee that the refcount is non-zero.
+ unsafe { bindings::drm_gem_object_put(obj) };
+ }
+ }
+ };
+}
+
+pub(crate) use impl_aref_for_gem_obj;
+
/// A type alias for retrieving a [`Driver`]s [`DriverFile`] implementation from its
/// [`DriverObject`] implementation.
///
@@ -253,21 +291,7 @@ extern "C" fn free_callback(obj: *mut bindings::drm_gem_object) {
}
}
-// SAFETY: Instances of `Object<T>` are always reference-counted.
-unsafe impl<T: DriverObject> crate::types::AlwaysRefCounted for Object<T> {
- fn inc_ref(&self) {
- // SAFETY: The existence of a shared reference guarantees that the refcount is non-zero.
- unsafe { bindings::drm_gem_object_get(self.as_raw()) };
- }
-
- unsafe fn dec_ref(obj: NonNull<Self>) {
- // SAFETY: `obj` is a valid pointer to an `Object<T>`.
- let obj = unsafe { obj.as_ref() };
-
- // SAFETY: The safety requirements guarantee that the refcount is non-zero.
- unsafe { bindings::drm_gem_object_put(obj.as_raw()) }
- }
-}
+impl_aref_for_gem_obj!(impl<T> for Object<T> where T: DriverObject);
impl<T: DriverObject> super::private::Sealed for Object<T> {}
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* [PATCH v5 2/8] rust: helpers: Add bindings/wrappers for dma_resv_lock
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
2025-10-23 21:22 ` [PATCH v5 1/8] rust/drm: Add gem::impl_aref_for_gem_obj! Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
2025-10-23 21:22 ` [PATCH v5 3/8] rust: drm: gem: Add raw_dma_resv() function Lyude Paul
` (5 subsequent siblings)
7 siblings, 0 replies; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: Asahi Lina, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg,
Trevor Gross, Sumit Semwal, Christian König,
Greg Kroah-Hartman, Asahi Lina, Viresh Kumar, FUJITA Tomonori,
Krishna Ketan Rai,
open list:DMA BUFFER SHARING FRAMEWORK:Keyword:bdma_(?:buf|fence|resv)b,
moderated list:DMA BUFFER SHARING FRAMEWORK:Keyword:bdma_(?:buf|fence|resv)b
From: Asahi Lina <lina@asahilina.net>
This is just for basic usage in the DRM shmem abstractions for implied
locking, not intended as a full DMA Reservation abstraction yet.
Signed-off-by: Asahi Lina <lina@asahilina.net>
Signed-off-by: Daniel Almeida <daniel.almeida@collabora.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Signed-off-by: Lyude Paul <lyude@redhat.com>
---
rust/bindings/bindings_helper.h | 1 +
rust/helpers/dma-resv.c | 13 +++++++++++++
rust/helpers/helpers.c | 1 +
3 files changed, 15 insertions(+)
create mode 100644 rust/helpers/dma-resv.c
diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h
index 2e43c66635a2c..07f79e125c329 100644
--- a/rust/bindings/bindings_helper.h
+++ b/rust/bindings/bindings_helper.h
@@ -48,6 +48,7 @@
#include <linux/cpumask.h>
#include <linux/cred.h>
#include <linux/debugfs.h>
+#include <linux/dma-resv.h>
#include <linux/device/faux.h>
#include <linux/dma-direction.h>
#include <linux/dma-mapping.h>
diff --git a/rust/helpers/dma-resv.c b/rust/helpers/dma-resv.c
new file mode 100644
index 0000000000000..05501cb814513
--- /dev/null
+++ b/rust/helpers/dma-resv.c
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#include <linux/dma-resv.h>
+
+int rust_helper_dma_resv_lock(struct dma_resv *obj, struct ww_acquire_ctx *ctx)
+{
+ return dma_resv_lock(obj, ctx);
+}
+
+void rust_helper_dma_resv_unlock(struct dma_resv *obj)
+{
+ dma_resv_unlock(obj);
+}
diff --git a/rust/helpers/helpers.c b/rust/helpers/helpers.c
index 551da6c9b5064..36d40f911345c 100644
--- a/rust/helpers/helpers.c
+++ b/rust/helpers/helpers.c
@@ -25,6 +25,7 @@
#include "cred.c"
#include "device.c"
#include "dma.c"
+#include "dma-resv.c"
#include "drm.c"
#include "err.c"
#include "irq.c"
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* [PATCH v5 3/8] rust: drm: gem: Add raw_dma_resv() function
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
2025-10-23 21:22 ` [PATCH v5 1/8] rust/drm: Add gem::impl_aref_for_gem_obj! Lyude Paul
2025-10-23 21:22 ` [PATCH v5 2/8] rust: helpers: Add bindings/wrappers for dma_resv_lock Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
2025-10-23 21:22 ` [PATCH v5 4/8] rust: gem: Introduce DriverObject::Args Lyude Paul
` (4 subsequent siblings)
7 siblings, 0 replies; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: David Airlie, Simona Vetter, Miguel Ojeda, Alex Gaynor,
Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Trevor Gross, Sumit Semwal,
Christian König, Asahi Lina, Shankari Anand,
open list:DMA BUFFER SHARING FRAMEWORK:Keyword:bdma_(?:buf|fence|resv)b,
moderated list:DMA BUFFER SHARING FRAMEWORK:Keyword:bdma_(?:buf|fence|resv)b
For retrieving a pointer to the struct dma_resv for a given GEM object. We
also introduce it in a new trait, BaseObjectPrivate, which we automatically
implement for all gem objects and don't expose to users outside of the
crate.
Signed-off-by: Lyude Paul <lyude@redhat.com>
---
rust/kernel/drm/gem/mod.rs | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/rust/kernel/drm/gem/mod.rs b/rust/kernel/drm/gem/mod.rs
index 32bff2e8463f4..67813cfb0db42 100644
--- a/rust/kernel/drm/gem/mod.rs
+++ b/rust/kernel/drm/gem/mod.rs
@@ -200,6 +200,18 @@ fn create_mmap_offset(&self) -> Result<u64> {
impl<T: IntoGEMObject> BaseObject for T {}
+/// Crate-private base operations shared by all GEM object classes.
+#[expect(unused)]
+pub(crate) trait BaseObjectPrivate: IntoGEMObject {
+ /// Return a pointer to this object's dma_resv.
+ fn raw_dma_resv(&self) -> *mut bindings::dma_resv {
+ // SAFETY: `as_gem_obj()` always returns a valid pointer to the base DRM gem object
+ unsafe { (*self.as_raw()).resv }
+ }
+}
+
+impl<T: IntoGEMObject> BaseObjectPrivate for T {}
+
/// A base GEM object.
///
/// Invariants
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* [PATCH v5 4/8] rust: gem: Introduce DriverObject::Args
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
` (2 preceding siblings ...)
2025-10-23 21:22 ` [PATCH v5 3/8] rust: drm: gem: Add raw_dma_resv() function Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
2025-11-04 20:41 ` Deborah Brouwer
2025-10-23 21:22 ` [PATCH v5 5/8] rust: drm: gem: shmem: Add DRM shmem helper abstraction Lyude Paul
` (3 subsequent siblings)
7 siblings, 1 reply; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: David Airlie, Simona Vetter, Miguel Ojeda, Alex Gaynor,
Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Trevor Gross, Asahi Lina, Shankari Anand,
open list:DRM DRIVER FOR NVIDIA GPUS [RUST]
This is an associated type that may be used in order to specify a data-type
to pass to gem objects when construction them, allowing for drivers to more
easily initialize their private-data for gem objects.
Signed-off-by: Lyude Paul <lyude@redhat.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
---
V3:
* s/BaseDriverObject/DriverObject/
V4:
* Fix leftover reference to BaseObjectDriver in rustdoc for
DriverObject::Args
drivers/gpu/drm/nova/gem.rs | 5 +++--
rust/kernel/drm/gem/mod.rs | 13 ++++++++++---
2 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/drivers/gpu/drm/nova/gem.rs b/drivers/gpu/drm/nova/gem.rs
index 2760ba4f3450b..173077eeb2def 100644
--- a/drivers/gpu/drm/nova/gem.rs
+++ b/drivers/gpu/drm/nova/gem.rs
@@ -18,8 +18,9 @@ pub(crate) struct NovaObject {}
impl gem::DriverObject for NovaObject {
type Driver = NovaDriver;
+ type Args = ();
- fn new(_dev: &NovaDevice, _size: usize) -> impl PinInit<Self, Error> {
+ fn new(_dev: &NovaDevice, _size: usize, _args: Self::Args) -> impl PinInit<Self, Error> {
try_pin_init!(NovaObject {})
}
}
@@ -33,7 +34,7 @@ pub(crate) fn new(dev: &NovaDevice, size: usize) -> Result<ARef<gem::Object<Self
return Err(EINVAL);
}
- gem::Object::new(dev, aligned_size)
+ gem::Object::new(dev, aligned_size, ())
}
/// Look up a GEM object handle for a `File` and return an `ObjectRef` for it.
diff --git a/rust/kernel/drm/gem/mod.rs b/rust/kernel/drm/gem/mod.rs
index 67813cfb0db42..d448c65fe5e13 100644
--- a/rust/kernel/drm/gem/mod.rs
+++ b/rust/kernel/drm/gem/mod.rs
@@ -65,8 +65,15 @@ pub trait DriverObject: Sync + Send + Sized {
/// Parent `Driver` for this object.
type Driver: drm::Driver;
+ /// The data type to use for passing arguments to [`DriverObject::new`].
+ type Args;
+
/// 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>;
+ fn new(
+ dev: &drm::Device<Self::Driver>,
+ size: usize,
+ args: Self::Args,
+ ) -> 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 {
@@ -247,11 +254,11 @@ impl<T: DriverObject> Object<T> {
};
/// Create a new GEM object.
- pub fn new(dev: &drm::Device<T::Driver>, size: usize) -> Result<ARef<Self>> {
+ pub fn new(dev: &drm::Device<T::Driver>, size: usize, args: T::Args) -> Result<ARef<Self>> {
let obj: Pin<KBox<Self>> = KBox::pin_init(
try_pin_init!(Self {
obj: Opaque::new(bindings::drm_gem_object::default()),
- data <- T::new(dev, size),
+ data <- T::new(dev, size, args),
// INVARIANT: The drm subsystem guarantees that the `struct drm_device` will live
// as long as the GEM object lives.
dev: dev.into(),
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH v5 4/8] rust: gem: Introduce DriverObject::Args
2025-10-23 21:22 ` [PATCH v5 4/8] rust: gem: Introduce DriverObject::Args Lyude Paul
@ 2025-11-04 20:41 ` Deborah Brouwer
0 siblings, 0 replies; 10+ messages in thread
From: Deborah Brouwer @ 2025-11-04 20:41 UTC (permalink / raw)
To: Lyude Paul
Cc: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel, David Airlie, Simona Vetter,
Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg,
Trevor Gross, Asahi Lina, Shankari Anand,
open list:DRM DRIVER FOR NVIDIA GPUS [RUST]
On Thu, Oct 23, 2025 at 05:22:06PM -0400, Lyude Paul wrote:
> This is an associated type that may be used in order to specify a data-type
> to pass to gem objects when construction them, allowing for drivers to more
> easily initialize their private-data for gem objects.
>
> Signed-off-by: Lyude Paul <lyude@redhat.com>
> Reviewed-by: Alice Ryhl <aliceryhl@google.com>
>
> ---
> V3:
> * s/BaseDriverObject/DriverObject/
> V4:
> * Fix leftover reference to BaseObjectDriver in rustdoc for
> DriverObject::Args
>
> drivers/gpu/drm/nova/gem.rs | 5 +++--
> rust/kernel/drm/gem/mod.rs | 13 ++++++++++---
> 2 files changed, 13 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/gpu/drm/nova/gem.rs b/drivers/gpu/drm/nova/gem.rs
> index 2760ba4f3450b..173077eeb2def 100644
> --- a/drivers/gpu/drm/nova/gem.rs
> +++ b/drivers/gpu/drm/nova/gem.rs
> @@ -18,8 +18,9 @@ pub(crate) struct NovaObject {}
>
> impl gem::DriverObject for NovaObject {
> type Driver = NovaDriver;
> + type Args = ();
>
> - fn new(_dev: &NovaDevice, _size: usize) -> impl PinInit<Self, Error> {
> + fn new(_dev: &NovaDevice, _size: usize, _args: Self::Args) -> impl PinInit<Self, Error> {
> try_pin_init!(NovaObject {})
> }
> }
Hi Lyude - could you please add the same changes for Tyr so it will
compile too
> @@ -33,7 +34,7 @@ pub(crate) fn new(dev: &NovaDevice, size: usize) -> Result<ARef<gem::Object<Self
> return Err(EINVAL);
> }
>
> - gem::Object::new(dev, aligned_size)
> + gem::Object::new(dev, aligned_size, ())
> }
>
> /// Look up a GEM object handle for a `File` and return an `ObjectRef` for it.
> diff --git a/rust/kernel/drm/gem/mod.rs b/rust/kernel/drm/gem/mod.rs
> index 67813cfb0db42..d448c65fe5e13 100644
> --- a/rust/kernel/drm/gem/mod.rs
> +++ b/rust/kernel/drm/gem/mod.rs
> @@ -65,8 +65,15 @@ pub trait DriverObject: Sync + Send + Sized {
> /// Parent `Driver` for this object.
> type Driver: drm::Driver;
>
> + /// The data type to use for passing arguments to [`DriverObject::new`].
> + type Args;
> +
> /// 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>;
> + fn new(
> + dev: &drm::Device<Self::Driver>,
> + size: usize,
> + args: Self::Args,
> + ) -> 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 {
> @@ -247,11 +254,11 @@ impl<T: DriverObject> Object<T> {
> };
>
> /// Create a new GEM object.
> - pub fn new(dev: &drm::Device<T::Driver>, size: usize) -> Result<ARef<Self>> {
> + pub fn new(dev: &drm::Device<T::Driver>, size: usize, args: T::Args) -> Result<ARef<Self>> {
> let obj: Pin<KBox<Self>> = KBox::pin_init(
> try_pin_init!(Self {
> obj: Opaque::new(bindings::drm_gem_object::default()),
> - data <- T::new(dev, size),
> + data <- T::new(dev, size, args),
> // INVARIANT: The drm subsystem guarantees that the `struct drm_device` will live
> // as long as the GEM object lives.
> dev: dev.into(),
> --
> 2.51.0
>
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH v5 5/8] rust: drm: gem: shmem: Add DRM shmem helper abstraction
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
` (3 preceding siblings ...)
2025-10-23 21:22 ` [PATCH v5 4/8] rust: gem: Introduce DriverObject::Args Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
2025-10-23 21:22 ` [PATCH v5 6/8] rust: drm: gem: Introduce shmem::SGTable Lyude Paul
` (2 subsequent siblings)
7 siblings, 0 replies; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: Asahi Lina, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg,
Trevor Gross, David Airlie, Simona Vetter, Greg Kroah-Hartman,
Asahi Lina, Viresh Kumar, Tamir Duberstein, Shankari Anand
From: Asahi Lina <lina@asahilina.net>
The DRM shmem helper includes common code useful for drivers which
allocate GEM objects as anonymous shmem. Add a Rust abstraction for
this. Drivers can choose the raw GEM implementation or the shmem layer,
depending on their needs.
Signed-off-by: Asahi Lina <lina@asahilina.net>
Signed-off-by: Daniel Almeida <daniel.almeida@collabora.com>
Signed-off-by: Lyude Paul <lyude@redhat.com>
---
V2:
* Use the drm_gem_shmem_init() and drm_gem_shmem_release() that I extracted
so we can handle memory allocation in rust, which means we no longer have
to handle freeing rust members of the struct by hand and have a closer
implementation to the main gem object
(this also gets rid of gem_create_object)
* Get rid of GemObjectRef and UniqueGemObjectRef, we have ARef<T> at home.
* Use Device<T::Driver> in Object<T>
* Cleanup Object::<T>::new() a bit:
* Cleanup safety comment
* Use cast_mut()
* Just import container_of!(), we use it all over anyhow
* mut_shmem() -> as_shmem(), make it safe (there's no reason for being unsafe)
* Remove any *const and *muts in structs, just use NonNull
* Get rid of the previously hand-rolled sg_table bindings in shmem, use the
bindings from Abdiel's sg_table patch series
* Add a TODO at the top about DMA reservation APIs and a desire for WwMutex
* Get rid of map_wc() and replace it with a new ObjectConfig struct. While
it currently only specifies the map_wc flag, the idea here is that
settings like map_wc() and parent_resv_obj() shouldn't be exposed as
normal functions since the only place where it's safe to set them is
when we're still guaranteed unique access to the GEM object, e.g. before
returning it to the caller. Using a struct instead of individual
arguments here is mainly because we'll be adding at least one more
argument, and there's enough other gem shmem settings that trying to add
all of them as individual function arguments in the future would be a bit
messy.
* Get rid of vm_numa_fields!, Lina didn't like this macro much either and I
think that it's fine for us to just specify the #[cfg(…)] attributes by
hand since we only need to do it twice.
* Set drm_gem_object_funcs.vm_ops directly to drm_gem_shmem_vm_ops, don't
export the various shmem funcs. I'm not sure why this wasn't possible
before but it seems to work fine now.
V4:
* Switch from OpaqueObject to a normal Object<T> now that we've removed it
* Remove `dev` from Object, it's redundant as drm_gem_object already has a
device pointer we can use.
* Use &raw instead of addr_of!()
V5:
* Fix typo in shmem::Object::as_raw()
* Add type invariant around `obj` always being a valid
`drm_gem_shmem_object` for the duration of the lifetime of `Object`.
* Use Opaque::cast_from() instead of unrestricted casts
rust/bindings/bindings_helper.h | 2 +
rust/helpers/drm.c | 48 ++++++-
rust/kernel/drm/gem/mod.rs | 3 +-
rust/kernel/drm/gem/shmem.rs | 225 ++++++++++++++++++++++++++++++++
4 files changed, 276 insertions(+), 2 deletions(-)
create mode 100644 rust/kernel/drm/gem/shmem.rs
diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h
index 07f79e125c329..ad644f3d62cc3 100644
--- a/rust/bindings/bindings_helper.h
+++ b/rust/bindings/bindings_helper.h
@@ -33,6 +33,7 @@
#include <drm/drm_drv.h>
#include <drm/drm_file.h>
#include <drm/drm_gem.h>
+#include <drm/drm_gem_shmem_helper.h>
#include <drm/drm_ioctl.h>
#include <kunit/test.h>
#include <linux/auxiliary_bus.h>
@@ -60,6 +61,7 @@
#include <linux/interrupt.h>
#include <linux/fs.h>
#include <linux/ioport.h>
+#include <linux/iosys-map.h>
#include <linux/jiffies.h>
#include <linux/jump_label.h>
#include <linux/mdio.h>
diff --git a/rust/helpers/drm.c b/rust/helpers/drm.c
index 450b406c6f273..a4e997d0b4732 100644
--- a/rust/helpers/drm.c
+++ b/rust/helpers/drm.c
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: GPL-2.0
#include <drm/drm_gem.h>
+#include <drm/drm_gem_shmem_helper.h>
#include <drm/drm_vma_manager.h>
#ifdef CONFIG_DRM
@@ -20,4 +21,49 @@ __u64 rust_helper_drm_vma_node_offset_addr(struct drm_vma_offset_node *node)
return drm_vma_node_offset_addr(node);
}
-#endif
+#ifdef CONFIG_DRM_GEM_SHMEM_HELPER
+void rust_helper_drm_gem_shmem_object_free(struct drm_gem_object *obj)
+{
+ return drm_gem_shmem_object_free(obj);
+}
+
+void rust_helper_drm_gem_shmem_object_print_info(struct drm_printer *p, unsigned int indent,
+ const struct drm_gem_object *obj)
+{
+ drm_gem_shmem_object_print_info(p, indent, obj);
+}
+
+int rust_helper_drm_gem_shmem_object_pin(struct drm_gem_object *obj)
+{
+ return drm_gem_shmem_object_pin(obj);
+}
+
+void rust_helper_drm_gem_shmem_object_unpin(struct drm_gem_object *obj)
+{
+ drm_gem_shmem_object_unpin(obj);
+}
+
+struct sg_table *rust_helper_drm_gem_shmem_object_get_sg_table(struct drm_gem_object *obj)
+{
+ return drm_gem_shmem_object_get_sg_table(obj);
+}
+
+int rust_helper_drm_gem_shmem_object_vmap(struct drm_gem_object *obj,
+ struct iosys_map *map)
+{
+ return drm_gem_shmem_object_vmap(obj, map);
+}
+
+void rust_helper_drm_gem_shmem_object_vunmap(struct drm_gem_object *obj,
+ struct iosys_map *map)
+{
+ drm_gem_shmem_object_vunmap(obj, map);
+}
+
+int rust_helper_drm_gem_shmem_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
+{
+ return drm_gem_shmem_object_mmap(obj, vma);
+}
+
+#endif /* CONFIG_DRM_GEM_SHMEM_HELPER */
+#endif /* CONFIG_DRM */
diff --git a/rust/kernel/drm/gem/mod.rs b/rust/kernel/drm/gem/mod.rs
index d448c65fe5e13..2985dfa144027 100644
--- a/rust/kernel/drm/gem/mod.rs
+++ b/rust/kernel/drm/gem/mod.rs
@@ -3,6 +3,8 @@
//! DRM GEM API
//!
//! C header: [`include/drm/drm_gem.h`](srctree/include/drm/drm_gem.h)
+#[cfg(CONFIG_DRM_GEM_SHMEM_HELPER = "y")]
+pub mod shmem;
use crate::{
alloc::flags::*,
@@ -208,7 +210,6 @@ fn create_mmap_offset(&self) -> Result<u64> {
impl<T: IntoGEMObject> BaseObject for T {}
/// Crate-private base operations shared by all GEM object classes.
-#[expect(unused)]
pub(crate) trait BaseObjectPrivate: IntoGEMObject {
/// Return a pointer to this object's dma_resv.
fn raw_dma_resv(&self) -> *mut bindings::dma_resv {
diff --git a/rust/kernel/drm/gem/shmem.rs b/rust/kernel/drm/gem/shmem.rs
new file mode 100644
index 0000000000000..45b95d60a3ec7
--- /dev/null
+++ b/rust/kernel/drm/gem/shmem.rs
@@ -0,0 +1,225 @@
+// SPDX-License-Identifier: GPL-2.0
+
+//! DRM GEM shmem helper objects
+//!
+//! C header: [`include/linux/drm/drm_gem_shmem_helper.h`](srctree/include/linux/drm/drm_gem_shmem_helper.h)
+
+// TODO:
+// - There are a number of spots here that manually acquire/release the DMA reservation lock using
+// dma_resv_(un)lock(). In the future we should add support for ww mutex, expose a method to
+// acquire a reference to the WwMutex, and then use that directly instead of the C functions here.
+
+use crate::{
+ container_of,
+ drm::{device, driver, gem, private::Sealed},
+ error::{from_err_ptr, to_result},
+ prelude::*,
+ scatterlist,
+ types::{ARef, Opaque},
+};
+use core::{
+ ops::{Deref, DerefMut},
+ ptr::NonNull,
+};
+use gem::{BaseObjectPrivate, DriverObject, IntoGEMObject};
+
+/// A struct for controlling the creation of shmem-backed GEM objects.
+///
+/// This is used with [`Object::new()`] to control various properties that can only be set when
+/// initially creating a shmem-backed GEM object.
+#[derive(Default)]
+pub struct ObjectConfig<'a, T: DriverObject> {
+ /// Whether to set the write-combine map flag.
+ pub map_wc: bool,
+
+ /// Reuse the DMA reservation from another GEM object.
+ ///
+ /// The newly created [`Object`] will hold an owned refcount to `parent_resv_obj` if specified.
+ pub parent_resv_obj: Option<&'a Object<T>>,
+}
+
+/// A shmem-backed GEM object.
+///
+/// # Invariants
+///
+/// `obj` contains a valid initialized `struct drm_gem_shmem_object` for the lifetime of this
+/// object.
+#[repr(C)]
+#[pin_data]
+pub struct Object<T: DriverObject> {
+ #[pin]
+ obj: Opaque<bindings::drm_gem_shmem_object>,
+ // Parent object that owns this object's DMA reservation object
+ parent_resv_obj: Option<ARef<Object<T>>>,
+ #[pin]
+ inner: T,
+}
+
+super::impl_aref_for_gem_obj!(impl<T> for Object<T> where T: DriverObject);
+
+impl<T: DriverObject> Object<T> {
+ /// `drm_gem_object_funcs` vtable suitable for GEM shmem objects.
+ const VTABLE: bindings::drm_gem_object_funcs = bindings::drm_gem_object_funcs {
+ free: Some(Self::free_callback),
+ open: Some(super::open_callback::<T>),
+ close: Some(super::close_callback::<T>),
+ print_info: Some(bindings::drm_gem_shmem_object_print_info),
+ export: None,
+ pin: Some(bindings::drm_gem_shmem_object_pin),
+ unpin: Some(bindings::drm_gem_shmem_object_unpin),
+ get_sg_table: Some(bindings::drm_gem_shmem_object_get_sg_table),
+ vmap: Some(bindings::drm_gem_shmem_object_vmap),
+ vunmap: Some(bindings::drm_gem_shmem_object_vunmap),
+ mmap: Some(bindings::drm_gem_shmem_object_mmap),
+ status: None,
+ rss: None,
+ // SAFETY: `drm_gem_shmem_vm_ops` is static const on the C side, so immutable references are
+ // safe here and such references shall be valid forever
+ vm_ops: unsafe { &bindings::drm_gem_shmem_vm_ops },
+ evict: None,
+ };
+
+ /// Return a raw pointer to the embedded drm_gem_shmem_object.
+ fn as_shmem(&self) -> *mut bindings::drm_gem_shmem_object {
+ self.obj.get()
+ }
+
+ /// Create a new shmem-backed DRM object of the given size.
+ ///
+ /// Additional config options can be specified using `config`.
+ pub fn new(
+ dev: &device::Device<T::Driver>,
+ size: usize,
+ config: ObjectConfig<'_, T>,
+ args: T::Args,
+ ) -> Result<ARef<Self>> {
+ let new: Pin<KBox<Self>> = KBox::try_pin_init(
+ try_pin_init!(Self {
+ obj <- Opaque::init_zeroed(),
+ parent_resv_obj: config.parent_resv_obj.map(|p| p.into()),
+ inner <- T::new(dev, size, args),
+ }),
+ GFP_KERNEL,
+ )?;
+
+ // SAFETY: `obj.as_raw()` is guaranteed to be valid by the initialization above.
+ unsafe { (*new.as_raw()).funcs = &Self::VTABLE };
+
+ // SAFETY: The arguments are all valid via the type invariants.
+ to_result(unsafe { bindings::drm_gem_shmem_init(dev.as_raw(), new.as_shmem(), size) })?;
+
+ // SAFETY: We never move out of `self`.
+ let new = KBox::into_raw(unsafe { Pin::into_inner_unchecked(new) });
+
+ // SAFETY: We're taking over the owned refcount from `drm_gem_shmem_init`.
+ let obj = unsafe { ARef::from_raw(NonNull::new_unchecked(new)) };
+
+ // Start filling out values from `config`
+ if let Some(parent_resv) = config.parent_resv_obj {
+ // SAFETY: We have yet to expose the new gem object outside of this function, so it is
+ // safe to modify this field.
+ unsafe { (*obj.obj.get()).base.resv = parent_resv.raw_dma_resv() };
+ }
+
+ // SAFETY: We have yet to expose this object outside of this function, so we're guaranteed
+ // to have exclusive access - thus making this safe to hold a mutable reference to.
+ let shmem = unsafe { &mut *obj.as_shmem() };
+ shmem.set_map_wc(config.map_wc);
+
+ Ok(obj)
+ }
+
+ /// Returns the `Device` that owns this GEM object.
+ pub fn dev(&self) -> &device::Device<T::Driver> {
+ // SAFETY: `dev` will have been initialized in `Self::new()` by `drm_gem_shmem_init()`.
+ unsafe { device::Device::from_raw((*self.as_raw()).dev) }
+ }
+
+ extern "C" fn free_callback(obj: *mut bindings::drm_gem_object) {
+ // SAFETY:
+ // - DRM always passes a valid gem object here
+ // - We used drm_gem_shmem_create() in our create_gem_object callback, so we know that
+ // `obj` is contained within a drm_gem_shmem_object
+ let this = unsafe { container_of!(obj, bindings::drm_gem_shmem_object, base) };
+
+ // SAFETY:
+ // - We're in free_callback - so this function is safe to call.
+ // - We won't be using the gem resources on `this` after this call.
+ unsafe { bindings::drm_gem_shmem_release(this) };
+
+ // SAFETY:
+ // - We verified above that `obj` is valid, which makes `this` valid
+ // - This function is set in AllocOps, so we know that `this` is contained within a
+ // `Object<T>`
+ let this = unsafe { container_of!(Opaque::cast_from(this), Self, obj) }.cast_mut();
+
+ // SAFETY: We're recovering the Kbox<> we created in gem_create_object()
+ let _ = unsafe { KBox::from_raw(this) };
+ }
+
+ /// Creates (if necessary) and returns an immutable reference to a scatter-gather table of DMA
+ /// pages for this object.
+ ///
+ /// This will pin the object in memory.
+ #[inline]
+ pub fn sg_table(&self) -> Result<&scatterlist::SGTable> {
+ // SAFETY:
+ // - drm_gem_shmem_get_pages_sgt is thread-safe.
+ // - drm_gem_shmem_get_pages_sgt returns either a valid pointer to a scatterlist, or an
+ // error pointer.
+ let sgt = from_err_ptr(unsafe { bindings::drm_gem_shmem_get_pages_sgt(self.as_shmem()) })?;
+
+ // SAFETY: We checked above that `sgt` is not an error pointer, so it must be a valid
+ // pointer to a scatterlist
+ Ok(unsafe { scatterlist::SGTable::from_raw(sgt) })
+ }
+}
+
+impl<T: DriverObject> Deref for Object<T> {
+ type Target = T;
+
+ fn deref(&self) -> &Self::Target {
+ &self.inner
+ }
+}
+
+impl<T: DriverObject> DerefMut for Object<T> {
+ fn deref_mut(&mut self) -> &mut Self::Target {
+ &mut self.inner
+ }
+}
+
+impl<T: DriverObject> Sealed for Object<T> {}
+
+impl<T: DriverObject> gem::IntoGEMObject for Object<T> {
+ fn as_raw(&self) -> *mut bindings::drm_gem_object {
+ // SAFETY:
+ // - Our immutable reference is proof that this is safe to dereference.
+ // - `obj` is always a valid drm_gem_shmem_object via our type invariants.
+ unsafe { &raw mut (*self.obj.get()).base }
+ }
+
+ unsafe fn from_raw<'a>(obj: *mut bindings::drm_gem_object) -> &'a Object<T> {
+ // SAFETY: The safety contract of from_gem_obj() guarantees that `obj` is contained within
+ // `Self`
+ unsafe {
+ let obj = Opaque::cast_from(container_of!(obj, bindings::drm_gem_shmem_object, base));
+
+ &*container_of!(obj, Object<T>, obj)
+ }
+ }
+}
+
+impl<T: DriverObject> driver::AllocImpl for Object<T> {
+ type Driver = T::Driver;
+
+ const ALLOC_OPS: driver::AllocOps = driver::AllocOps {
+ gem_create_object: None,
+ prime_handle_to_fd: None,
+ prime_fd_to_handle: None,
+ gem_prime_import: None,
+ gem_prime_import_sg_table: Some(bindings::drm_gem_shmem_prime_import_sg_table),
+ dumb_create: Some(bindings::drm_gem_shmem_dumb_create),
+ dumb_map_offset: None,
+ };
+}
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* [PATCH v5 6/8] rust: drm: gem: Introduce shmem::SGTable
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
` (4 preceding siblings ...)
2025-10-23 21:22 ` [PATCH v5 5/8] rust: drm: gem: shmem: Add DRM shmem helper abstraction Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
2025-10-23 21:22 ` [PATCH v5 7/8] rust: Introduce iosys_map bindings Lyude Paul
2025-10-23 21:22 ` [PATCH v5 8/8] rust: drm/gem: Add vmap functions to shmem bindings Lyude Paul
7 siblings, 0 replies; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: David Airlie, Simona Vetter, Miguel Ojeda, Alex Gaynor,
Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Trevor Gross, Asahi Lina
Currently we expose the ability to retrieve an SGTable for an shmem gem
object using gem::shmem::Object::<T>::sg_table(). However, this only gives
us a borrowed reference. This being said - retrieving an SGTable is a
fallible operation, and as such it's reasonable that a driver may want to
hold onto an SGTable for longer then a reference would allow in order to
avoid having to deal with fallibility every time they want to access the
SGTable. One such driver with this usecase is the Asahi driver.
So to support this, let's introduce shmem::SGTable - which both holds a
pointer to the SGTable and a reference to its respective GEM object in
order to keep the GEM object alive for as long as the shmem::SGTable. The
type can be used identically to a normal SGTable.
Signed-off-by: Lyude Paul <lyude@redhat.com>
---
V3:
* Rename OwnedSGTable to shmem::SGTable. Since the current version of the
SGTable abstractions now has a `Owned` and `Borrowed` variant, I think
renaming this to shmem::SGTable makes things less confusing.
We do however, keep the name of owned_sg_table() as-is.
V4:
* Clarify safety comments for SGTable to explain why the object is
thread-safe.
* Rename from SGTableRef to SGTable
rust/kernel/drm/gem/shmem.rs | 50 ++++++++++++++++++++++++++++++++++++
1 file changed, 50 insertions(+)
diff --git a/rust/kernel/drm/gem/shmem.rs b/rust/kernel/drm/gem/shmem.rs
index 45b95d60a3ec7..21ccb6c1824be 100644
--- a/rust/kernel/drm/gem/shmem.rs
+++ b/rust/kernel/drm/gem/shmem.rs
@@ -173,6 +173,25 @@ pub fn sg_table(&self) -> Result<&scatterlist::SGTable> {
// pointer to a scatterlist
Ok(unsafe { scatterlist::SGTable::from_raw(sgt) })
}
+
+ /// Creates (if necessary) and returns an owned reference to a scatter-gather table of DMA pages
+ /// for this object.
+ ///
+ /// This is the same as [`sg_table`](Self::sg_table), except that it instead returns an
+ /// [`shmem::SGTable`] which holds a reference to the associated gem object, instead of a
+ /// reference to an [`scatterlist::SGTable`].
+ ///
+ /// This will pin the object in memory.
+ ///
+ /// [`shmem::SGTable`]: SGTable
+ pub fn owned_sg_table(&self) -> Result<SGTable<T>> {
+ Ok(SGTable {
+ sgt: self.sg_table()?.into(),
+ // INVARIANT: We take an owned refcount to `self` here, ensuring that `sgt` remains
+ // valid for as long as this `SGTable`.
+ _owner: self.into(),
+ })
+ }
}
impl<T: DriverObject> Deref for Object<T> {
@@ -223,3 +242,34 @@ impl<T: DriverObject> driver::AllocImpl for Object<T> {
dumb_map_offset: None,
};
}
+
+/// An owned reference to a scatter-gather table of DMA address spans for a GEM shmem object.
+///
+/// This object holds an owned reference to the underlying GEM shmem object, ensuring that the
+/// [`scatterlist::SGTable`] referenced by this type remains valid for the lifetime of this object.
+///
+/// # Invariants
+///
+/// - `sgt` is kept alive by `_owner`, ensuring it remains valid for as long as `Self`.
+/// - `sgt` corresponds to the owned object in `_owner`.
+/// - This object is only exposed in situations where we know the underlying `SGTable` will not be
+/// modified for the lifetime of this object. Thus, it is safe to send/access this type across
+/// threads.
+pub struct SGTable<T: DriverObject> {
+ sgt: NonNull<scatterlist::SGTable>,
+ _owner: ARef<Object<T>>,
+}
+
+// SAFETY: This object is thread-safe via our type invariants.
+unsafe impl<T: DriverObject> Send for SGTable<T> {}
+// SAFETY: This object is thread-safe via our type invariants.
+unsafe impl<T: DriverObject> Sync for SGTable<T> {}
+
+impl<T: DriverObject> Deref for SGTable<T> {
+ type Target = scatterlist::SGTable;
+
+ fn deref(&self) -> &Self::Target {
+ // SAFETY: Creating an immutable reference to this is safe via our type invariants.
+ unsafe { self.sgt.as_ref() }
+ }
+}
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* [PATCH v5 7/8] rust: Introduce iosys_map bindings
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
` (5 preceding siblings ...)
2025-10-23 21:22 ` [PATCH v5 6/8] rust: drm: gem: Introduce shmem::SGTable Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
2025-10-23 21:22 ` [PATCH v5 8/8] rust: drm/gem: Add vmap functions to shmem bindings Lyude Paul
7 siblings, 0 replies; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg,
Trevor Gross, Greg Kroah-Hartman, Viresh Kumar, FUJITA Tomonori,
Krishna Ketan Rai, Wedson Almeida Filho, Tamir Duberstein
This introduces a set of bindings for working with iosys_map in rust code.
The design of this is heavily based off the design for both the io and
dma_map bindings for Rust.
Signed-off-by: Lyude Paul <lyude@redhat.com>
---
V5:
- Fix incorrect field size being passed to iosys_map_memcpy_to()
- Add an additional unit test, basic_macro(), which can successfully catch
the above issue so it doesn't happen again in the future.
rust/helpers/helpers.c | 1 +
rust/helpers/iosys_map.c | 15 +
rust/kernel/iosys_map.rs | 705 +++++++++++++++++++++++++++++++++++++++
rust/kernel/lib.rs | 1 +
4 files changed, 722 insertions(+)
create mode 100644 rust/helpers/iosys_map.c
create mode 100644 rust/kernel/iosys_map.rs
diff --git a/rust/helpers/helpers.c b/rust/helpers/helpers.c
index 36d40f911345c..d549af697bd60 100644
--- a/rust/helpers/helpers.c
+++ b/rust/helpers/helpers.c
@@ -31,6 +31,7 @@
#include "irq.c"
#include "fs.c"
#include "io.c"
+#include "iosys_map.c"
#include "jump_label.c"
#include "kunit.c"
#include "maple_tree.c"
diff --git a/rust/helpers/iosys_map.c b/rust/helpers/iosys_map.c
new file mode 100644
index 0000000000000..b105261c3cf8a
--- /dev/null
+++ b/rust/helpers/iosys_map.c
@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#include <linux/iosys-map.h>
+
+void rust_helper_iosys_map_memcpy_to(struct iosys_map *dst, size_t dst_offset,
+ const void *src, size_t len)
+{
+ iosys_map_memcpy_to(dst, dst_offset, src, len);
+}
+
+void rust_helper_iosys_map_memcpy_from(void *dst, const struct iosys_map *src,
+ size_t src_offset, size_t len)
+{
+ iosys_map_memcpy_from(dst, src, src_offset, len);
+}
diff --git a/rust/kernel/iosys_map.rs b/rust/kernel/iosys_map.rs
new file mode 100644
index 0000000000000..4da0ab57cf35c
--- /dev/null
+++ b/rust/kernel/iosys_map.rs
@@ -0,0 +1,705 @@
+// SPDX-License-Identifier: GPL-2.0
+
+//! IO-agnostic memory mapping interfaces.
+//!
+//! This crate provides bindings for the `struct iosys_map` type, which provides a common interface
+//! for memory mappings which can reside within coherent memory, or within IO memory.
+//!
+//! C header: [`include/linux/iosys-map.h`](srctree/include/linux/pci.h)
+
+use crate::{
+ prelude::*,
+ transmute::{AsBytes, FromBytes},
+};
+use bindings;
+use core::{
+ marker::PhantomData,
+ mem::{self, MaybeUninit},
+ ops::{Deref, DerefMut, Range},
+ slice,
+};
+
+/// Raw unsized representation of a `struct iosys_map`.
+///
+/// This struct is a transparent wrapper around `struct iosys_map`. The C API does not provide the
+/// size of the mapping by default, and thus this type also does not include the size of the
+/// mapping. As such, it cannot be used for actually accessing the underlying data pointed to by the
+/// mapping.
+///
+/// With the exception of kernel crates which may provide their own wrappers around `RawIoSysMap`,
+/// users will typically not interact with this type directly.
+pub struct RawIoSysMap<T: AsBytes + FromBytes>(bindings::iosys_map, PhantomData<T>);
+
+impl<T: AsBytes + FromBytes> RawIoSysMap<T> {
+ /// Convert from a raw `bindings::iosys_map`.
+ #[expect(unused)]
+ #[inline]
+ pub(crate) fn from_raw(val: bindings::iosys_map) -> Self {
+ Self(val, PhantomData)
+ }
+
+ /// Convert from a `RawIoSysMap<T>` to a raw `bindings::iosys_map` ref.
+ #[inline]
+ pub(crate) fn as_raw(&self) -> &bindings::iosys_map {
+ &self.0
+ }
+
+ /// Convert from a `RawIoSysMap<T>` to a raw mutable `bindings::iosys_map` ref.
+ #[inline]
+ pub(crate) fn as_raw_mut(&mut self) -> &mut bindings::iosys_map {
+ &mut self.0
+ }
+
+ /// Returns whether the mapping is within IO memory space or not.
+ #[inline]
+ pub fn is_iomem(&self) -> bool {
+ self.0.is_iomem
+ }
+
+ /// Returns the size of a single item in this mapping.
+ pub const fn item_size(&self) -> usize {
+ mem::size_of::<T>()
+ }
+
+ /// Returns a mutable address to the memory pointed to by this iosys map.
+ ///
+ /// Note that this address is not guaranteed to reside in system memory, and may reside in IO
+ /// memory.
+ #[inline]
+ pub fn as_mut_ptr(&self) -> *mut T {
+ if self.is_iomem() {
+ // SAFETY: We confirmed above that this iosys map is contained within iomem, so it's
+ // safe to read vaddr_iomem
+ unsafe { self.0.__bindgen_anon_1.vaddr_iomem }
+ } else {
+ // SAFETY: We confirmed above that this iosys map is not contaned within iomem, so it's
+ // safe to read vaddr.
+ unsafe { self.0.__bindgen_anon_1.vaddr }
+ }
+ .cast()
+ }
+
+ /// Returns an immutable address to the memory pointed to by this iosys map.
+ ///
+ /// Note that this address is not guaranteed to reside in system memory, and may reside in IO
+ /// memory.
+ #[inline]
+ pub fn as_ptr(&self) -> *const T {
+ self.as_mut_ptr().cast_const()
+ }
+}
+
+// SAFETY: As we make no guarantees about the validity of the mapping, there's no issue with sending
+// this type between threads.
+unsafe impl<T: AsBytes + FromBytes> Send for RawIoSysMap<T> {}
+
+impl<T: AsBytes + FromBytes> Clone for RawIoSysMap<T> {
+ fn clone(&self) -> Self {
+ Self(self.0, PhantomData)
+ }
+}
+
+/// A sized version of a [`RawIoSysMap`].
+///
+/// Since this type includes the size of the [`RawIoSysMap`], it can be used for accessing the
+/// underlying data pointed to by it.
+///
+/// # Invariants
+///
+/// - The iosys mapping referenced by this type is guaranteed to be of at least `size` bytes in
+/// size
+/// - The iosys mapping referenced by this type is valid for the lifetime `'a`.
+#[derive(Clone)]
+pub struct IoSysMapRef<'a, T: AsBytes + FromBytes> {
+ map: RawIoSysMap<T>,
+ size: usize,
+ _p: PhantomData<&'a T>,
+}
+
+impl<'a, T: AsBytes + FromBytes> IoSysMapRef<'a, T> {
+ /// Create a new [`IoSysMapRef`] from a [`RawIoSysMap`].
+ ///
+ /// # Safety
+ ///
+ /// - The caller guarantees that the mapping referenced by `map` is of at least `size` bytes in
+ /// size.
+ /// - The caller guarantees that the mapping referenced by `map` remains valid for the lifetime
+ /// of `'a`.
+ #[allow(unused)]
+ pub(crate) unsafe fn new(map: RawIoSysMap<T>, size: usize) -> IoSysMapRef<'a, T> {
+ // INVARIANT: Our safety contract fulfills the type invariants of `IoSysMapRef`.
+ IoSysMapRef {
+ map,
+ size,
+ _p: PhantomData,
+ }
+ }
+
+ /// Return the size of the `IoSysMapRef`.
+ #[inline]
+ pub fn size(&self) -> usize {
+ self.size
+ }
+
+ /// Returns an immutable reference slice to data from the region starting from `offset`.
+ ///
+ /// `offset` and `count` are in units of `T`. Note that this function requires that the
+ /// underlying iosys mapping does not reside within iomem.
+ ///
+ /// This function can return the following errors:
+ ///
+ /// * [`ENOTSUPP`] if the memory region resides in iomem.
+ /// * [`EOVERFLOW`] if calculating the length of the slice results in an overflow.
+ /// * [`EINVAL`] if the slice would go out of bounds of the memory region.
+ ///
+ /// # Safety
+ ///
+ /// * The caller promises that the memory pointed to by for this `IoSysMapRef` is not written to
+ /// while the returned slice is live.
+ /// * Callers must ensure that this call does not race with a write to the same region while the
+ /// returned slice is alive.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use kernel::iosys_map::*;
+ ///
+ /// # fn test() -> Result {
+ /// # let map = tests::VecIoSysMap::new(&[1, 2, 3])?;
+ /// # let map = map.get();
+ /// // SAFETY: We are the only ones with access to `map`.
+ /// let slice = unsafe { map.as_slice(0, 3)? };
+ /// assert_eq!(*slice, [1, 2, 3]);
+ ///
+ /// let slice = unsafe { map.as_slice(1, 2)? };
+ /// assert_eq!(*slice, [2, 3]);
+ /// # Ok::<(), Error>(()) }
+ /// # assert!(test().is_ok());
+ /// ```
+ pub unsafe fn as_slice(&self, offset: usize, count: usize) -> Result<&[T]> {
+ if self.is_iomem() {
+ return Err(ENOTSUPP);
+ }
+
+ let range = self.validate_range(offset, count)?;
+
+ // SAFETY:
+ // * `self.validate_range()` is guaranteed to return a range within this memory allocation
+ // that is contained within the iosys_map and is properly aligned to the size of
+ // `T`.
+ // * We checked above that the memory pointed to by this iosys map doesn't reside in iomem,
+ // so it must reside in system memory - ensuring that `self.addr_mut()` returns a valid
+ // virtual memory address.
+ Ok(unsafe { slice::from_raw_parts(self.as_ptr().byte_add(range.start), count) })
+ }
+
+ /// Returns a mutable reference slice to data from the region starting from `offset`.
+ ///
+ /// `offset` and `count` are in units of `T`. Note that this function requires that the
+ /// underlying iosys mapping does not reside within iomem.
+ ///
+ /// For a list of errors this function can return, see [`as_slice`](Self::as_slice).
+ ///
+ /// # Safety
+ ///
+ /// The caller promises that the memory region pointed to by this `IoSysMapRef` is not written
+ /// to or read from while the returned slice is live.
+ pub unsafe fn as_mut_slice(&mut self, offset: usize, count: usize) -> Result<&mut [T]> {
+ if self.is_iomem() {
+ return Err(ENOTSUPP);
+ }
+
+ let range = self.validate_range(offset, count)?;
+
+ // SAFETY:
+ // * `self.validate_range()` is guaranteed to return a range within this memory allocation
+ // that is contained within the iosys_map and is properly aligned to the size of
+ // `T`.
+ // * We checked above that the memory pointed to by this iosys map doesn't reside in iomem,
+ // so it must reside in system memory - ensuring that `self.addr_mut()` returns a valid
+ // virtual memory address.
+ Ok(unsafe { slice::from_raw_parts_mut(self.as_mut_ptr().byte_add(range.start), count) })
+ }
+
+ /// Writes `src` to the region starting from `offset`.
+ ///
+ /// `offset` is in units of `T`, not the number of bytes.
+ ///
+ /// This function can return the following errors:
+ ///
+ /// * [`EOVERFLOW`] if calculating the length of the slice results in an overflow.
+ /// * [`EINVAL`] if the slice would go out of bounds of the memory region.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use kernel::iosys_map::*;
+ ///
+ /// # fn test() -> Result {
+ /// # let map = tests::VecIoSysMap::new(&[0; 3])?;
+ /// # let mut map = map.get();
+ /// map.write(&[1, 2, 3], 0)?; // (now [1, 2, 3])
+ /// map.write(&[4], 2)?; // (now [1, 2, 4])
+ ///
+ /// // SAFETY: We are the only ones with access to `map`
+ /// let slice = unsafe { map.as_slice(0, 3)? };
+ /// assert_eq!(slice, [1, 2, 4]);
+ ///
+ /// # Ok::<(), Error>(()) }
+ /// # assert!(test().is_ok());
+ /// ```
+ pub fn write(&mut self, src: &[T], offset: usize) -> Result {
+ let range = self.validate_range(offset, src.len())?;
+
+ // SAFETY:
+ // - The address pointed to by this iosys_map is guaranteed to be valid via IoSysMapRef's
+ // type invariants.
+ // - `self.validate_range()` always returns a valid range of memory within said memory.
+ unsafe {
+ bindings::iosys_map_memcpy_to(
+ self.as_raw_mut(),
+ range.start,
+ src.as_ptr().cast(),
+ range.len(),
+ )
+ };
+
+ Ok(())
+ }
+
+ /// Attempt to compute the offset of an item within the iosys map using its index.
+ ///
+ /// Returns an error if an overflow occurs.
+ ///
+ /// # Safety
+ ///
+ /// This function checks for overflows, but it explicitly does not check if the offset goes out
+ /// of bounds. It is the caller's responsibility to check for this before using the returned
+ /// offset with the iosys_map API.
+ unsafe fn item_from_index(&self, idx: usize) -> Result<usize> {
+ self.item_size().checked_mul(idx).ok_or(EOVERFLOW)
+ }
+
+ /// Common helper to compute and validate a range for a specific data type applied from
+ /// within the allocated region of the iosys mapping.
+ ///
+ /// This function returns the computed range if it doesn't overflow, and the range is valid
+ /// within the allocated region of the iosys mapping. This is so that the computation may
+ /// be reused.
+ ///
+ /// On success, the range returned by this function is guaranteed:
+ ///
+ /// * To be a valid range of memory within the virtual mapping for this gem object.
+ /// * To be properly aligned to [`RawIoSysMap::item_size()`].
+ fn validate_range(&self, offset: usize, count: usize) -> Result<Range<usize>> {
+ // SAFETY: If the offset is out of bounds, we'll catch this via overflow checks or when
+ // checking range_end.
+ let offset = unsafe { self.item_from_index(offset)? };
+ let range_size = count.checked_mul(self.item_size()).ok_or(EOVERFLOW)?;
+ let range_end = offset.checked_add(range_size).ok_or(EOVERFLOW)?;
+
+ if range_end > self.size() {
+ return Err(EINVAL);
+ }
+
+ // INVARIANT: Since `offset` and `count` are both in units of `T`, we're guaranteed that the
+ // range returned here is properly aligned to `T`.
+ Ok(offset..range_end)
+ }
+
+ /// Common helper to compute the memory address of an item within the iosys mapping.
+ ///
+ /// Public but hidden, since it should only be used from [`iosys_map_read`] and
+ /// [`iosys_map_write`].
+ #[doc(hidden)]
+ pub fn ptr_from_index(&self, offset: usize) -> Result<*mut T> {
+ // SAFETY: We check if the resulting offset goes out of bounds below.
+ let offset = unsafe { self.item_from_index(offset)? };
+
+ if offset.checked_add(self.item_size()).ok_or(EOVERFLOW)? > self.size() {
+ return Err(EINVAL);
+ }
+
+ // SAFETY: We confirmed that `offset` + the item size does not go out of bounds above.
+ Ok(unsafe { self.as_mut_ptr().byte_add(offset) })
+ }
+
+ // TODO:
+ // This function is currently needed for making the iosys_map_read!() and iosys_map_write!()
+ // macros work due to a combination of a few limitations:
+ //
+ // * The current C API for iosys_map requires that we use offsets for reading/writing
+ // iosys_maps.
+ // * Calculating the offset of a field within a struct requires that we either:
+ // * Use field projection for calculating the offset of the field. We don't have this yet.
+ // * Explicitly specify the type of the struct, which would be cumbersome to require in the
+ // read/write macros.
+ // * Provide a typed pointer (or other reference) to the struct in question, allowing the
+ // use of &raw const and &raw mut.
+ // * Keep in mind: we can't simply cast the offset of an item in the iosys map into a typed
+ // pointer to fulfill the third option. While having invalid memory addresses as pointers
+ // is ok, adding an offset to a pointer in rust requires that the resulting memory address
+ // is within the same allocation. Since an invalid pointer has no allocation, we can't
+ // make that guarantee.
+ //
+ // So, until we have field projection the way we workaround this:
+ //
+ // * Calculate the offset (self.item_from_index()) of the struct within the iosys map
+ // * Calculate the memory address of the struct using the offset from the last step
+ // (self.ptr_from_index()).
+ // * Use that memory address with &raw const/&raw mut in order to calculate the memory address
+ // of the desired field, ensuring it remains in the same allocation (happens within the
+ // macros).
+ // * Convert the address from the last step back into an offset within the iosys map
+ // (offset_from_ptr()).
+ //
+ // Once we do get field projection, this silly code should be removed.
+ //
+ /// Convert a pointer to an item within the iosys map back into an offset.
+ ///
+ /// # Safety
+ ///
+ /// `ptr` must be a valid pointer to data within the iosys map.
+ unsafe fn offset_from_ptr<F>(&self, ptr: *const F) -> usize {
+ // SAFETY: `ptr` always points to data within the memory pointed to by the iosys map,
+ // meaning it is within the same memory allocation.
+ //
+ // Additionally, since `ptr` is within the iosys mapping, the offset here will always be
+ // positive and safe to cast to a usize.
+ // (TODO: replace this with byte_offset_from_unsigned once it's available in the kernel)
+ unsafe { ptr.byte_offset_from(self.as_ptr()) as usize }
+ }
+
+ /// Reads the value of `field` and ensures that its type is [`FromBytes`].
+ ///
+ /// # Safety
+ ///
+ /// This must be called from the [`iosys_map_read`] macro which ensures that the `field`
+ /// pointer is validated beforehand.
+ ///
+ /// Public but hidden since it should only be used from the [`iosys_map_read`] macro.
+ #[doc(hidden)]
+ pub unsafe fn field_read<F: FromBytes>(&self, field: *const F) -> F {
+ let mut field_val = MaybeUninit::<F>::uninit();
+
+ // SAFETY: `field` is guaranteed valid via our safety contract.
+ let offset = unsafe { self.offset_from_ptr(field) };
+
+ // SAFETY: Since we verified `field` is valid above, `offset_from_ptr` will always return a
+ // valid offset within the iosys map.
+ unsafe {
+ bindings::iosys_map_memcpy_from(
+ field_val.as_mut_ptr().cast(),
+ self.as_raw(),
+ offset,
+ mem::size_of::<F>(),
+ )
+ }
+
+ // SAFETY: We just initialized `field_val` above.
+ unsafe { field_val.assume_init() }
+ }
+
+ /// Writes the value of `field` and ensures that its type is [`AsBytes`].
+ ///
+ /// # Safety
+ ///
+ /// This must be called from the [`iosys_map_write`] macro which ensures that the `field`
+ /// pointers validated beforehand.
+ ///
+ /// Public but hidden since it should only be used from the [`iosys_map_write`] macro.
+ #[doc(hidden)]
+ pub unsafe fn field_write<F: AsBytes>(&mut self, field: *mut F, val: F) {
+ // SAFETY: `field` is guaranteed valid via our safety contract.
+ let offset = unsafe { self.offset_from_ptr(field) };
+
+ // SAFETY: `offset_from_ptr` always returns a valid offset within the iosys map.
+ unsafe {
+ bindings::iosys_map_memcpy_to(
+ self.as_raw_mut(),
+ offset,
+ core::ptr::from_ref(&val).cast(),
+ mem::size_of::<F>(),
+ )
+ }
+ }
+}
+
+impl<'a, T: AsBytes + FromBytes> Deref for IoSysMapRef<'a, T> {
+ type Target = RawIoSysMap<T>;
+
+ fn deref(&self) -> &Self::Target {
+ &self.map
+ }
+}
+
+impl<'a, T: AsBytes + FromBytes> DerefMut for IoSysMapRef<'a, T> {
+ fn deref_mut(&mut self) -> &mut Self::Target {
+ &mut self.map
+ }
+}
+
+/// Reads from a field of an item from an iosys map ref.
+///
+/// # Examples
+///
+/// ```
+/// use kernel::{iosys_map::*, transmute::*};
+///
+/// #[derive(Copy, Clone, Debug, PartialEq, Eq)]
+/// struct MyStruct { a: u32, b: u16 }
+///
+/// // SAFETY: All bit patterns are acceptable values for `MyStruct`.
+/// unsafe impl FromBytes for MyStruct {};
+/// // SAFETY: Instances of `MyStruct` have no uninitialized portions.
+/// unsafe impl AsBytes for MyStruct {};
+///
+/// # fn test() -> Result {
+/// # let map = tests::VecIoSysMap::new(&[MyStruct { a: 42, b: 2 }; 3])?;
+/// # let map = map.get();
+/// let whole = kernel::iosys_map_read!(map[2])?;
+/// assert_eq!(whole, MyStruct { a: 42, b: 2 });
+///
+/// let field = kernel::iosys_map_read!(map[1].b)?;
+/// assert_eq!(field, 2);
+/// # Ok::<(), Error>(()) }
+/// # assert!(test().is_ok());
+/// ```
+#[macro_export]
+macro_rules! iosys_map_read {
+ ($map:expr, $idx:expr, $($field:tt)*) => {{
+ (|| -> ::core::result::Result<_, $crate::error::Error> {
+ let map = &$map;
+ let item = $crate::iosys_map::IoSysMapRef::ptr_from_index(map, $idx)?;
+
+ // SAFETY: `ptr_from_index()` ensures that `item` is always a valid (although
+ // potentially not dereferenceable, which is fine here) pointer to within the iosys
+ // mapping.
+ unsafe {
+ let ptr_field = &raw const (*item) $($field)*;
+ ::core::result::Result::Ok(
+ $crate::iosys_map::IoSysMapRef::field_read(map, ptr_field)
+ )
+ }
+ })()
+ }};
+ ($map:ident [ $idx: expr ] $($field:tt)* ) => {
+ $crate::iosys_map_read!($map, $idx, $($field)*)
+ };
+ ($($map:ident).* [ $idx:expr ] $($field:tt)* ) => {
+ $crate::iosys_map_read!($($map).*, $idx, $($field)*)
+ };
+}
+
+/// Writes to a field of an item from an iosys map ref.
+///
+/// # Examples
+///
+/// ```
+/// use kernel::{iosys_map::*, transmute::*};
+///
+/// #[derive(Copy, Clone, Debug, PartialEq, Eq)]
+/// struct MyStruct { a: u32, b: u16 };
+///
+/// // SAFETY: All bit patterns are acceptable values for `MyStruct`.
+/// unsafe impl FromBytes for MyStruct {};
+/// // SAFETY: Instances of `MyStruct` have no uninitialized portions.
+/// unsafe impl AsBytes for MyStruct {};
+///
+/// # fn test() -> Result {
+/// # let map = tests::VecIoSysMap::new(&[MyStruct { a: 42, b: 2 }; 3])?;
+/// # let mut map = map.get();
+/// kernel::iosys_map_write!(map[2].b = 1337)?;
+/// # assert_eq!(kernel::iosys_map_read!(map[2].b)?, 1337);
+///
+/// kernel::iosys_map_write!(map[1] = MyStruct { a: 10, b: 20 })?;
+/// # assert_eq!(kernel::iosys_map_read!(map[1])?, MyStruct { a: 10, b: 20 });
+/// # Ok::<(), Error>(()) }
+/// # assert!(test().is_ok());
+/// ```
+#[macro_export]
+macro_rules! iosys_map_write {
+ ($map:ident [ $idx:expr ] $($field:tt)*) => {{
+ $crate::iosys_map_write!($map, $idx, $($field)*)
+ }};
+ ($($map:ident).* [ $idx:expr ] $($field:tt)* ) => {{
+ $crate::iosys_map_write!($($map).*, $idx, $($field)*)
+ }};
+ ($map:expr, $idx:expr, = $val:expr) => {
+ (|| -> ::core::result::Result<_, $crate::error::Error> {
+ // (expand these outside of the unsafe block (clippy::macro-metavars-in-unsafe)
+ let map = &mut $map;
+ let val = $val;
+
+ let item = $crate::iosys_map::IoSysMapRef::ptr_from_index(map, $idx)?;
+ // SAFETY: `item_from_index` ensures that `item` is always a valid item.
+ unsafe { $crate::iosys_map::IoSysMapRef::field_write(map, item, val) };
+ ::core::result::Result::Ok(())
+ })()
+ };
+ ($map:expr, $idx:expr, $(.$field:ident)* = $val:expr) => {
+ (|| -> ::core::result::Result<_, $crate::error::Error> {
+ // (expand these outside of the unsafe block (clippy::macro-metavars-in-unsafe)
+ let map = &mut $map;
+ let val = $val;
+
+ let item = $crate::iosys_map::IoSysMapRef::ptr_from_index(map, $idx)?;
+
+ // SAFETY: `ptr_from_index()` ensures that `item` is always a valid (although
+ // potentially not dereferenceable, which is fine here) pointer to within the iosys
+ // mapping.
+ unsafe {
+ let ptr_field = &raw mut (*item) $(.$field)*;
+ $crate::iosys_map::IoSysMapRef::field_write(map, ptr_field, val)
+ };
+ ::core::result::Result::Ok(())
+ })()
+ };
+}
+
+#[doc(hidden)]
+#[kunit_tests(rust_iosys_map)]
+pub mod tests {
+ use super::*;
+
+ /// A helper struct for managed IoSysMapRef structs which point to a [`Vec`].
+ pub struct VecIoSysMap<T: AsBytes + FromBytes + Clone> {
+ map: RawIoSysMap<T>,
+ vec: KVec<T>,
+ }
+
+ impl<T: AsBytes + FromBytes + Clone> VecIoSysMap<T> {
+ pub fn new(src: &[T]) -> Result<Self> {
+ let mut vec = KVec::<T>::new();
+
+ vec.extend_from_slice(src, GFP_KERNEL)?;
+
+ let map = RawIoSysMap(
+ bindings::iosys_map {
+ is_iomem: false,
+ __bindgen_anon_1: bindings::iosys_map__bindgen_ty_1 {
+ vaddr: vec.as_mut_ptr().cast(),
+ },
+ },
+ PhantomData,
+ );
+
+ Ok(Self { map, vec })
+ }
+
+ pub fn get(&self) -> IoSysMapRef<'_, T> {
+ // SAFETY: `map` points to `vec`, so the size of `map` is the size of the `vec`.
+ unsafe { IoSysMapRef::new(self.map.clone(), self.vec.len() * self.map.item_size()) }
+ }
+ }
+
+ #[test]
+ fn basic() -> Result {
+ let map = VecIoSysMap::new(&[0; 3])?;
+ let mut map = map.get();
+
+ map.write(&[1, 2, 3], 0)?;
+
+ // SAFETY: We are the only ones with access to map.
+ assert_eq!(unsafe { map.as_slice(0, 3)? }, [1, 2, 3]);
+
+ map.write(&[42], 1)?;
+
+ // SAFETY: We are the only ones with access to the map.
+ assert_eq!(unsafe { map.as_slice(0, 3)? }, [1, 42, 3]);
+
+ // SAFETY: We are the only ones with access to the map.
+ assert_eq!(unsafe { map.as_slice(1, 1)? }, [42]);
+
+ Ok(())
+ }
+
+ #[test]
+ fn oob_accesses() -> Result {
+ let map = VecIoSysMap::new(&[0; 3])?;
+ let mut map = map.get();
+
+ // SAFETY: We are the only ones with access to map.
+ assert!(unsafe { map.as_slice(0, 4) }.is_err());
+
+ // SAFETY: We are the only ones with access to map.
+ assert!(unsafe { map.as_slice(1, 3) }.is_err());
+
+ assert!(map.write(&[1, 2, 3, 69], 0).is_err());
+ assert!(map.write(&[1, 2, 3], 69).is_err());
+
+ Ok(())
+ }
+
+ #[test]
+ fn overflows() -> Result {
+ let map = VecIoSysMap::new(&[0; 3])?;
+ let mut map = map.get();
+
+ // SAFETY: We are the only ones with access to map.
+ assert!(unsafe { map.as_slice(usize::MAX, 3) }.is_err());
+
+ // SAFETY: We are the only ones with access to map.
+ assert!(unsafe { map.as_slice(0, usize::MAX) }.is_err());
+
+ assert!(map.write(&[1, 2, 3], usize::MAX).is_err());
+
+ Ok(())
+ }
+
+ #[derive(Copy, Clone, Debug, PartialEq, Eq)]
+ struct TestStruct {
+ a: u32,
+ b: u64,
+ }
+
+ // SAFETY: All bit patterns are acceptable values for `TestStruct`.
+ unsafe impl FromBytes for TestStruct {}
+ // SAFETY: Instances of `TestStruct` have no uninitialized portions.
+ unsafe impl AsBytes for TestStruct {}
+
+ #[test]
+ fn basic_macro() -> Result {
+ let mut expected = [TestStruct { a: 1, b: 2 }; 5];
+ let map = VecIoSysMap::new(&expected)?;
+ let mut map = map.get();
+
+ iosys_map_write!(map[3].a = u32::MAX)?;
+ expected[3].a = u32::MAX;
+
+ assert_eq!(iosys_map_read!(map[3].a)?, u32::MAX);
+ assert_eq!(iosys_map_read!(map[3])?, TestStruct { a: u32::MAX, b: 2 });
+
+ // Compare the entire array, so that we catch any mis-sized writes.
+ // SAFETY: We are the only ones with access to map.
+ assert_eq!(expected, unsafe { map.as_slice(0, 5)? });
+
+ Ok(())
+ }
+
+ #[test]
+ fn macro_oob_accesses() -> Result {
+ let map = VecIoSysMap::new(&[TestStruct { a: 1, b: 2 }; 3])?;
+ let mut map = map.get();
+
+ assert!(iosys_map_read!(map[5].b).is_err());
+ assert!(iosys_map_read!(map[1000]).is_err());
+ assert!(iosys_map_write!(map[6969].a = 999).is_err());
+ assert!(iosys_map_write!(map[243] = TestStruct { a: 99, b: 22 }).is_err());
+
+ Ok(())
+ }
+
+ #[test]
+ fn macro_overflows() -> Result {
+ let map = VecIoSysMap::new(&[TestStruct { a: 1, b: 2 }; 3])?;
+ let mut map = map.get();
+
+ assert!(iosys_map_read!(map[usize::MAX]).is_err());
+ assert!(iosys_map_read!(map[usize::MAX].b).is_err());
+ assert!(iosys_map_write!(map[usize::MAX] = TestStruct { a: 1, b: 1 }).is_err());
+ assert!(iosys_map_write!(map[usize::MAX].b = 1).is_err());
+
+ Ok(())
+ }
+}
diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs
index 3dd7bebe78882..a10d50076c872 100644
--- a/rust/kernel/lib.rs
+++ b/rust/kernel/lib.rs
@@ -98,6 +98,7 @@
pub mod init;
pub mod io;
pub mod ioctl;
+pub mod iosys_map;
pub mod iov;
pub mod irq;
pub mod jump_label;
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* [PATCH v5 8/8] rust: drm/gem: Add vmap functions to shmem bindings
2025-10-23 21:22 [PATCH v5 0/8] Rust bindings for gem shmem + iosys_map Lyude Paul
` (6 preceding siblings ...)
2025-10-23 21:22 ` [PATCH v5 7/8] rust: Introduce iosys_map bindings Lyude Paul
@ 2025-10-23 21:22 ` Lyude Paul
7 siblings, 0 replies; 10+ messages in thread
From: Lyude Paul @ 2025-10-23 21:22 UTC (permalink / raw)
To: dri-devel, rust-for-linux, Alice Ryhl, Daniel Almeida,
Danilo Krummrich, linux-kernel
Cc: David Airlie, Simona Vetter, Miguel Ojeda, Alex Gaynor,
Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Trevor Gross, Asahi Lina
One of the more obvious use cases for gem shmem objects is the ability to
create mappings into their contents, specifically iosys mappings. Now that
we've added iosys_map rust bindings to the kernel, let's hook these up in
gem shmem.
Similar to how we handle SGTables, we make sure there's two different types
of mappings: owned mappings (kernel::drm::gem::shmem::VMap) and borrowed
mappings (kernel::drm::gem::shmem::VMapRef).
One last note: we change the #[expect(unused)] for RawIoSysMap::from_raw()
to an #[allow(unused)]. Normally we would simply remove the lint assertion,
however - since shmem is conditionally built, we need allow to avoid
hitting warnings in certain kernel configurations.
Signed-off-by: Lyude Paul <lyude@redhat.com>
---
rust/kernel/drm/gem/shmem.rs | 160 ++++++++++++++++++++++++++++++++++-
rust/kernel/iosys_map.rs | 2 +-
2 files changed, 160 insertions(+), 2 deletions(-)
diff --git a/rust/kernel/drm/gem/shmem.rs b/rust/kernel/drm/gem/shmem.rs
index 21ccb6c1824be..62a2c12b9fe2a 100644
--- a/rust/kernel/drm/gem/shmem.rs
+++ b/rust/kernel/drm/gem/shmem.rs
@@ -13,15 +13,18 @@
container_of,
drm::{device, driver, gem, private::Sealed},
error::{from_err_ptr, to_result},
+ iosys_map::*,
prelude::*,
scatterlist,
+ transmute::*,
types::{ARef, Opaque},
};
use core::{
+ mem::{self, MaybeUninit},
ops::{Deref, DerefMut},
ptr::NonNull,
};
-use gem::{BaseObjectPrivate, DriverObject, IntoGEMObject};
+use gem::{BaseObject, BaseObjectPrivate, DriverObject, IntoGEMObject};
/// A struct for controlling the creation of shmem-backed GEM objects.
///
@@ -192,6 +195,72 @@ pub fn owned_sg_table(&self) -> Result<SGTable<T>> {
_owner: self.into(),
})
}
+
+ /// Attempt to create a [`RawIoSysMap`] from the gem object.
+ fn raw_vmap<U: AsBytes + FromBytes>(&self) -> Result<RawIoSysMap<U>> {
+ build_assert!(
+ mem::size_of::<U>() > 0,
+ "It doesn't make sense for the mapping type to be a ZST"
+ );
+
+ let mut map: MaybeUninit<bindings::iosys_map> = MaybeUninit::uninit();
+
+ // SAFETY: drm_gem_shmem_vmap can be called with the DMA reservation lock held
+ to_result(unsafe {
+ // TODO: see top of file
+ bindings::dma_resv_lock(self.raw_dma_resv(), core::ptr::null_mut());
+ let ret = bindings::drm_gem_shmem_vmap_locked(self.as_shmem(), map.as_mut_ptr());
+ bindings::dma_resv_unlock(self.raw_dma_resv());
+ ret
+ })?;
+
+ // SAFETY: if drm_gem_shmem_vmap did not fail, map is initialized now
+ Ok(unsafe { RawIoSysMap::from_raw(map.assume_init()) })
+ }
+
+ /// Unmap a [`RawIoSysMap`] from the gem object.
+ ///
+ /// # Safety
+ ///
+ /// - The caller promises that `map` came from a prior call to [`Self::raw_vmap`] on this gem
+ /// object.
+ /// - The caller promises that the memory pointed to by `map` will no longer be accesed through
+ /// this instance.
+ unsafe fn raw_vunmap<U: AsBytes + FromBytes>(&self, map: &mut RawIoSysMap<U>) {
+ let resv = self.raw_dma_resv();
+
+ // SAFETY:
+ // - This function is safe to call with the DMA reservation lock held
+ // - Our `ARef` is proof that the underlying gem object here is initialized and thus safe to
+ // dereference.
+ unsafe {
+ // TODO: see top of file
+ bindings::dma_resv_lock(resv, core::ptr::null_mut());
+ bindings::drm_gem_shmem_vunmap_locked(self.as_shmem(), map.as_raw_mut());
+ bindings::dma_resv_unlock(resv);
+ }
+ }
+
+ /// Creates and returns a virtual kernel memory mapping for this object.
+ pub fn vmap<U: AsBytes + FromBytes>(&self) -> Result<VMapRef<'_, T, U>> {
+ let map = self.raw_vmap()?;
+
+ Ok(VMapRef {
+ // SAFETY:
+ // - The size of the vmap is the same as the size of the gem
+ // - The vmap will remain alive until this object is dropped.
+ map: unsafe { IoSysMapRef::new(map, self.size()) },
+ owner: self,
+ })
+ }
+
+ /// Creates and returns an owned reference to a virtual kernel memory mapping for this object.
+ pub fn owned_vmap<U: AsBytes + FromBytes>(&self) -> Result<VMap<T, U>> {
+ Ok(VMap {
+ map: self.raw_vmap()?,
+ owner: self.into(),
+ })
+ }
}
impl<T: DriverObject> Deref for Object<T> {
@@ -243,6 +312,95 @@ impl<T: DriverObject> driver::AllocImpl for Object<T> {
};
}
+/// A borrowed reference to a virtual mapping for a shmem-based GEM object in kernel address space.
+pub struct VMapRef<'a, D: DriverObject, T: AsBytes + FromBytes> {
+ map: IoSysMapRef<'a, T>,
+ owner: &'a Object<D>,
+}
+
+impl<'a, D: DriverObject, T: AsBytes + FromBytes> Clone for VMapRef<'a, D, T> {
+ fn clone(&self) -> Self {
+ // SAFETY: We have a successful vmap already, so this can't fail
+ unsafe { self.owner.vmap().unwrap_unchecked() }
+ }
+}
+
+impl<'a, D: DriverObject, T: AsBytes + FromBytes> Deref for VMapRef<'a, D, T> {
+ type Target = IoSysMapRef<'a, T>;
+
+ fn deref(&self) -> &Self::Target {
+ &self.map
+ }
+}
+
+impl<'a, D: DriverObject, T: AsBytes + FromBytes> DerefMut for VMapRef<'a, D, T> {
+ fn deref_mut(&mut self) -> &mut Self::Target {
+ &mut self.map
+ }
+}
+
+impl<'a, D: DriverObject, T: AsBytes + FromBytes> Drop for VMapRef<'a, D, T> {
+ fn drop(&mut self) {
+ // SAFETY: Our existence is proof that this map was previously created using self.owner.
+ unsafe { self.owner.raw_vunmap(&mut self.map) };
+ }
+}
+
+/// An owned reference to a virtual mapping for a shmem-based GEM object in kernel address space.
+///
+/// # Invariants
+///
+/// - The memory pointed to by `map` is at least as large as `T`.
+/// - The memory pointed to by `map` remains valid at least until this object is dropped.
+pub struct VMap<D: DriverObject, T: AsBytes + FromBytes> {
+ map: RawIoSysMap<T>,
+ owner: ARef<Object<D>>,
+}
+
+impl<D: DriverObject, T: AsBytes + FromBytes> Clone for VMap<D, T> {
+ fn clone(&self) -> Self {
+ // SAFETY: We have a successful vmap already, so this can't fail
+ unsafe { self.owner.owned_vmap().unwrap_unchecked() }
+ }
+}
+
+impl<'a, D: DriverObject, T: AsBytes + FromBytes> From<VMapRef<'a, D, T>> for VMap<D, T> {
+ fn from(value: VMapRef<'a, D, T>) -> Self {
+ let this = Self {
+ map: value.map.clone(),
+ owner: value.owner.into(),
+ };
+
+ mem::forget(value);
+ this
+ }
+}
+
+impl<D: DriverObject, T: AsBytes + FromBytes> VMap<D, T> {
+ /// Return a reference to the iosys map for this `VMap`.
+ pub fn get(&self) -> IoSysMapRef<'_, T> {
+ // SAFETY: The size of the iosys_map is equivalent to the size of the gem object.
+ unsafe { IoSysMapRef::new(self.map.clone(), self.owner.size()) }
+ }
+
+ /// Borrows a reference to the object that owns this virtual mapping.
+ pub fn owner(&self) -> &Object<D> {
+ &self.owner
+ }
+}
+
+impl<D: DriverObject, T: AsBytes + FromBytes> Drop for VMap<D, T> {
+ fn drop(&mut self) {
+ // SAFETY: Our existence is proof that this map was previously created using self.owner
+ unsafe { self.owner.raw_vunmap(&mut self.map) };
+ }
+}
+
+/// SAFETY: `iosys_map` objects are safe to send across threads.
+unsafe impl<D: DriverObject, T: AsBytes + FromBytes> Send for VMap<D, T> {}
+/// SAFETY: `iosys_map` objects are safe to send across threads.
+unsafe impl<D: DriverObject, T: AsBytes + FromBytes> Sync for VMap<D, T> {}
+
/// An owned reference to a scatter-gather table of DMA address spans for a GEM shmem object.
///
/// This object holds an owned reference to the underlying GEM shmem object, ensuring that the
diff --git a/rust/kernel/iosys_map.rs b/rust/kernel/iosys_map.rs
index 4da0ab57cf35c..e7540139ada01 100644
--- a/rust/kernel/iosys_map.rs
+++ b/rust/kernel/iosys_map.rs
@@ -32,7 +32,7 @@
impl<T: AsBytes + FromBytes> RawIoSysMap<T> {
/// Convert from a raw `bindings::iosys_map`.
- #[expect(unused)]
+ #[allow(unused)]
#[inline]
pub(crate) fn from_raw(val: bindings::iosys_map) -> Self {
Self(val, PhantomData)
--
2.51.0
^ permalink raw reply related [flat|nested] 10+ messages in thread