From: Daniel Almeida <daniel.almeida@collabora.com>
To: Lyude Paul <lyude@redhat.com>
Cc: dri-devel@lists.freedesktop.org, rust-for-linux@vger.kernel.org,
"Alice Ryhl" <aliceryhl@google.com>,
"Danilo Krummrich" <dakr@kernel.org>,
linux-kernel@vger.kernel.org, "David Airlie" <airlied@gmail.com>,
"Simona Vetter" <simona@ffwll.ch>,
"Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Trevor Gross" <tmgross@umich.edu>,
"Asahi Lina" <lina+kernel@asahilina.net>
Subject: Re: [PATCH v5 6/8] rust: drm: gem: Introduce shmem::SGTable
Date: Mon, 24 Nov 2025 12:42:55 -0300 [thread overview]
Message-ID: <A2D03EE4-B93F-4C68-B3D0-35C77429E694@collabora.com> (raw)
In-Reply-To: <20251023212540.1141999-7-lyude@redhat.com>
> On 23 Oct 2025, at 18:22, Lyude Paul <lyude@redhat.com> wrote:
>
> 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
>
Same comment as last patch.
— Daniel
next prev parent reply other threads:[~2025-11-24 15:43 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
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-11-24 15:23 ` Daniel Almeida
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 ` [PATCH v5 3/8] rust: drm: gem: Add raw_dma_resv() function Lyude Paul
2025-10-23 21:22 ` [PATCH v5 4/8] rust: gem: Introduce DriverObject::Args Lyude Paul
2025-11-04 20:41 ` Deborah Brouwer
2025-11-24 15:25 ` Daniel Almeida
2025-10-23 21:22 ` [PATCH v5 5/8] rust: drm: gem: shmem: Add DRM shmem helper abstraction Lyude Paul
2025-11-24 15:41 ` Daniel Almeida
2025-12-02 22:01 ` Lyude Paul
2025-10-23 21:22 ` [PATCH v5 6/8] rust: drm: gem: Introduce shmem::SGTable Lyude Paul
2025-11-24 15:42 ` Daniel Almeida [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=A2D03EE4-B93F-4C68-B3D0-35C77429E694@collabora.com \
--to=daniel.almeida@collabora.com \
--cc=a.hindborg@kernel.org \
--cc=airlied@gmail.com \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=gary@garyguo.net \
--cc=lina+kernel@asahilina.net \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=lyude@redhat.com \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=simona@ffwll.ch \
--cc=tmgross@umich.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®