Re: [PATCH 1/2] rust: scatterlist: tie owned tables to the device's bound lifetime
From: Alexandre Courbot
Date: Sun Nov 15 2026 - 23:03:16 EST
On Sun Nov 15, 2026 at 8:42 AM JST, Danilo Krummrich wrote:
<...>
> diff --git a/drivers/gpu/nova-core/firmware/radix3.rs b/drivers/gpu/nova-core/firmware/radix3.rs
> index 94235bd1209d..a3e43fc8ec86 100644
> --- a/drivers/gpu/nova-core/firmware/radix3.rs
> +++ b/drivers/gpu/nova-core/firmware/radix3.rs
> @@ -35,14 +35,11 @@
> #[pin_data]
> pub(crate) struct Radix3<'a> {
> /// The mapped data.
> - #[pin]
> - data: SGTable<Owned<VVec<u8>>>,
> + data: SGTable<Owned<'a, VVec<u8>>>,
> /// Level 2: one entry per page of `data`.
> - #[pin]
> - level2: SGTable<Owned<VVec<u8>>>,
> + level2: SGTable<Owned<'a, VVec<u8>>>,
> /// Level 1: one entry per page of `level2`.
> - #[pin]
> - level1: SGTable<Owned<VVec<u8>>>,
> + level1: SGTable<Owned<'a, VVec<u8>>>,
> /// Level 0: one page, whose single entry is the DMA address of the first `level1` page.
> level0: Coherent<'a, [u64]>,
> /// Length of `data`, in bytes.
> @@ -59,14 +56,14 @@ pub(crate) fn new(
>
> pin_init::pin_init_scope(move || {
> Ok(try_pin_init!(Self {
> - data <- SGTable::new(dev, data, DataDirection::ToDevice, GFP_KERNEL),
> - level2 <- {
> - build_lvl(&data)
> - .map(|l2| SGTable::new(dev, l2, DataDirection::ToDevice, GFP_KERNEL))?
> + data: SGTable::new(dev, data, DataDirection::ToDevice, GFP_KERNEL)?,
> + level2: {
> + let l2 = build_lvl(data)?;
> + SGTable::new(dev, l2, DataDirection::ToDevice, GFP_KERNEL)?
> },
> - level1 <- {
> - build_lvl(&level2)
> - .map(|l1| SGTable::new(dev, l1, DataDirection::ToDevice, GFP_KERNEL))?
> + level1: {
> + let l1 = build_lvl(level2)?;
> + SGTable::new(dev, l1, DataDirection::ToDevice, GFP_KERNEL)?
> },
> level0: {
> // Allocate the level 0 page table as a device-visible DMA object, and map the
> @@ -81,7 +78,7 @@ pub(crate) fn new(
> let mut level0 = CoherentBox::<'_, [u64]>::zeroed_slice(
> dev,
> GSP_PAGE_SIZE / size_of::<u64>(),
> - GFP_KERNEL
> + GFP_KERNEL,
Stray hunk? Maybe we can move it to patch 2 since it reformats that part
anyway.
> )?;
> level0[0] = level1_entry_addr.to_le();
>
> @@ -105,7 +102,7 @@ pub(crate) fn size(&self) -> usize {
>
> /// Returns the size of the level that maps `sg_table`: one `u64` entry per [`GSP_PAGE_SIZE`]
> /// page of each DMA-mapped region, rounded up to whole pages.
> -fn lvl_size(sg_table: &SGTable<Owned<VVec<u8>>>) -> usize {
> +fn lvl_size(sg_table: &SGTable<Owned<'_, VVec<u8>>>) -> usize {
> let entries: usize = sg_table
> .iter()
> .map(|sg_entry| usize::from_safe_cast(sg_entry.dma_len()).div_ceil(GSP_PAGE_SIZE))
> @@ -122,7 +119,7 @@ fn lvl_size(sg_table: &SGTable<Owned<VVec<u8>>>) -> usize {
> ///
> /// - `ENOMEM` if the level cannot be allocated.
> /// - `EINVAL` if `sg_table` yields more entries than [`lvl_size`] sized the level for.
> -fn build_lvl(sg_table: &SGTable<Owned<VVec<u8>>>) -> Result<VVec<u8>> {
> +fn build_lvl(sg_table: &SGTable<Owned<'_, VVec<u8>>>) -> Result<VVec<u8>> {
> let mut dst = VVec::<u8>::zeroed(lvl_size(sg_table), GFP_KERNEL).map_err(|_| ENOMEM)?;
> let mut entries = dst.chunks_exact_mut(size_of::<u64>());
>
> diff --git a/rust/kernel/scatterlist.rs b/rust/kernel/scatterlist.rs
> index 6379a8748117..93f431d7f548 100644
> --- a/rust/kernel/scatterlist.rs
> +++ b/rust/kernel/scatterlist.rs
> @@ -19,7 +19,8 @@
> //! The main entry point is the [`SGTable`] type, which represents a complete scatter-gather table.
> //! It can be either:
> //!
> -//! - An owned table ([`SGTable<Owned<P>>`]), created from a Rust memory buffer (e.g., [`VVec`]).
> +//! - An owned table ([`SGTable<Owned<'a, P>>`]), created from a Rust memory buffer (e.g.,
> +//! [`VVec`]) and tied to the [`Device<Bound>`] lifetime.
> //! This type manages the allocation of the `struct sg_table`, the DMA mapping of the buffer, and
> //! the automatic cleanup of all resources.
> //! - A borrowed reference (&[`SGTable`]), which provides safe, read-only access to a table that was
> @@ -33,15 +34,13 @@
> alloc::allocator::VmallocPageIter,
> bindings,
> device::{Bound, Device},
> - devres::Devres,
> dma,
> error,
> page,
> prelude::*,
> - sync::aref::ARef,
> types::Opaque, //
> };
> -use core::{ops::Deref, ptr::NonNull};
> +use core::ops::Deref;
>
> /// A single entry in a scatter-gather list.
> ///
> @@ -123,9 +122,7 @@ unsafe impl Sync for Borrowed {}
> ///
> /// All [`SGTable`] variants can be iterated over the individual [`SGEntry`]s.
> #[repr(transparent)]
> -#[pin_data]
> pub struct SGTable<T: private::Sealed = Borrowed> {
> - #[pin]
> inner: T,
> }
>
> @@ -177,63 +174,41 @@ pub fn iter(&self) -> SGTableIter<'_> {
> ///
> /// # Invariants
> ///
> -/// - `sgt` is a valid pointer to a `struct sg_table` for the entire lifetime of the
> -/// [`DmaMappedSgt`].
> /// - `sgt` is always DMA mapped.
> -struct DmaMappedSgt {
> - sgt: NonNull<bindings::sg_table>,
> - dev: ARef<Device>,
> +struct DmaMappedSgt<'a> {
> + dev: &'a Device<Bound>,
> + sgt: RawSGTable,
The `RawSGTable` documentation still mentions `Owned`. We could adapt it
or (maybe better) just drop that sentence.
> dir: dma::DataDirection,
> }
>
> -// SAFETY: `DmaMappedSgt` can be sent to any task.
> -unsafe impl Send for DmaMappedSgt {}
> -
> -// SAFETY: `DmaMappedSgt` has no interior mutability and can be accessed concurrently.
> -unsafe impl Sync for DmaMappedSgt {}
> -
> -impl DmaMappedSgt {
> - /// # Safety
> - ///
> - /// - `sgt` must be a valid pointer to a `struct sg_table` for the entire lifetime of the
> - /// returned [`DmaMappedSgt`].
> - /// - The caller must guarantee that `sgt` remains DMA mapped for the entire lifetime of
> - /// [`DmaMappedSgt`].
> - unsafe fn new(
> - sgt: NonNull<bindings::sg_table>,
> - dev: &Device<Bound>,
> - dir: dma::DataDirection,
> - ) -> Result<Self> {
> +impl<'a> DmaMappedSgt<'a> {
> + /// Takes ownership of `sgt` and maps it for DMA.
> + fn new(dev: &'a Device<Bound>, sgt: RawSGTable, dir: dma::DataDirection) -> Result<Self> {
> // SAFETY:
> // - `dev.as_raw()` is a valid pointer to a `struct device`, which is guaranteed to be
> // bound to a driver for the duration of this call.
> - // - `sgt` is a valid pointer to a `struct sg_table`.
> + // - `sgt.as_raw()` is a valid pointer to a `struct sg_table`.
> error::to_result(unsafe {
> - bindings::dma_map_sgtable(dev.as_raw(), sgt.as_ptr(), dir.into(), 0)
> + bindings::dma_map_sgtable(dev.as_raw(), sgt.as_raw(), dir.into(), 0)
> })?;
>
> - // INVARIANT: By the safety requirements of this function it is guaranteed that `sgt` is
> - // valid for the entire lifetime of this object instance.
> - Ok(Self {
> - sgt,
> - dev: dev.into(),
> - dir,
> - })
> + // INVARIANT: `sgt` was successfully DMA mapped and is owned by this object until drop.
> + Ok(Self { dev, sgt, dir })
> }
> }
>
> -impl Drop for DmaMappedSgt {
> +impl Drop for DmaMappedSgt<'_> {
> #[inline]
> fn drop(&mut self) {
> // SAFETY:
> // - `self.dev.as_raw()` is a pointer to a valid `struct device`.
> // - `self.dev` is the same device the mapping has been created for in `Self::new()`.
> - // - `self.sgt.as_ptr()` is a valid pointer to a `struct sg_table` by the type invariants
> - // of `Self`.
> + // - `self.sgt.as_raw()` is a valid pointer to a `struct sg_table` for the lifetime of
> + // `self`.
> // - `self.dir` is the same `dma::DataDirection` the mapping has been created with in
> // `Self::new()`.
> unsafe {
> - bindings::dma_unmap_sgtable(self.dev.as_raw(), self.sgt.as_ptr(), self.dir.into(), 0)
> + bindings::dma_unmap_sgtable(self.dev.as_raw(), self.sgt.as_raw(), self.dir.into(), 0)
> };
> }
> }
> @@ -308,38 +283,27 @@ fn drop(&mut self) {
> ///
> /// - The backing memory pages.
> /// - The `struct sg_table` allocation (`sgt`).
`sgt` is removed by this patch.
<...>
> diff --git a/samples/rust/rust_dma.rs b/samples/rust/rust_dma.rs
> index ffb693544673..844e137cddc8 100644
> --- a/samples/rust/rust_dma.rs
> +++ b/samples/rust/rust_dma.rs
> @@ -35,8 +35,7 @@
> struct DmaSampleData<'bound> {
> pdev: &'bound pci::Device<Bound>,
> ca: Coherent<'bound, [MyStruct]>,
> - #[pin]
> - sgt: SGTable<Owned<VVec<u8>>>,
> + sgt: SGTable<Owned<'bound, VVec<u8>>>,
Since there is no more `pin` in `DmaSampleData`, can we also remove its
`pinned_drop` attribute?