Skip to content

Rust infrastructure for sg_table and scatterlist

Danilo Krummrich lkml rust-for-linux 4 versions – Applied

Status from this message: Applied to drm-rust-next, thanks!

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest5 patches 3 repliesApplied
  2. v35 patches 20 repliesSuperseded
  3. v25 patches 22 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v14 patches21 repliesSuperseded

Changes in v4 from the cover letter

- Replace "type state" leftovers.
- Add a brief explanation to RawSGTable.
- Mention "no interior mutability" in Sync safety comments.
- Add safety requirement to RawSGTable::new().
- Don't use pin-init for RawSGTable itself.

Patches in v4 Applied

#Subject and filesSizeRepliesApplied
1/5rust: dma: implement DataDirectionrust/bindings/bindings_helper.h rust/kernel/dma.rs+69 -00 replies
2/5rust: dma: add type alias for bindings::dma_addr_tdrivers/gpu/nova-core/falcon.rs rust/kernel/dma.rs+16 -60 replies
3/5rust: scatterlist: Add abstraction for sg_tablerust/helpers/helpers.c rust/helpers/scatterlist.c rust/kernel/lib.rs +1 more+517 -01 reply
4/5samples: rust: dma: add sample code for SGTablesamples/rust/rust_dma.rs+26 -91 reply
5/5MAINTAINERS: rust: dma: add scatterlist filesMAINTAINERS+3 -10 replies

Reviews trailers per patch

All 5 patches have a Reviewed-by or Acked-by.

PatchAlice RyhlAlexandre CourbotDaniel AlmeidaLyude PaulMiguel Ojeda
1/5R-b R-b R-b R-b
2/5R-b R-b R-b R-b
3/5R-b R-b T-b R-b R-b
4/5R-b R-b R-b R-b
5/5R-b A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 5 reviewers.

Read the v4 thread

Cover letter [PATCH v4 0/5] Rust infrastructure for sg_table and scatterlist

This patch series provides abstractions for struct sg_table and struct scatterlist.

Abdiel and me agreed for me to take over his previous iterations on this topic. I decided to send my patches as a new series rather than as a subsequent version of Abdiel's previous iterations, since the changes I made turned out to be much closer to a full rewrite.

The most notable differences in design are:

- SGTable utilizes BorrowedPage, AsPageIter and VmallocPageIter from my patch

    series in [1].

- SGTable is a transparent wrapper over either struct Owned<P> (where P is the provider of the backing pages) or struct Borrowed, which by itself is a transparent wrapper over Opaque<bindings::sg_table>, i.e. either SGTable<Owned<P>> or just SGTable (which is equivalent to SGTable<Borrowed>.

- SGTable<Owned<P>>: Represents a table whose resources are fully managed by Rust. It takes ownership of a page provider P, allocates the underlying struct sg_table, maps it for DMA, and handles all cleanup automatically upon drop. The DMA mapping's lifetime is tied to the associated device using Devres, ensuring it is correctly unmapped before the device is unbound.

- SGTable<Borrowed> (or just SGTable): A zero-cost representation of an externally managed struct sg_table. It is created from a raw pointer using SGTable::from_raw() and provides a lifetime-bound reference (&'a SGTable) for operations like iteration.

- As a consequence, a borrowed SG table can be created with SGTable::from_raw(), which returns a &'a SGTable, just like similar existing abstractions.

An owned SGTable is created with SGTable::new(), which returns an impl PinInit<SGTable<Owned<P>>, Error>, such that it can be initialized directly within existing private data memory allocations while providing the required pin guarantees.

- SGTable<Owned<P>> uses an inner type Devres<DmaMapSgt> to ensure that the DMA mapping can't out-live device unbind.

- SGTable<Owned<P>> uses pin-init for initialization.

This patch series depends on [1] (branch containing the patches in [2]). A branch containing this series (including dependencies) can be found in [3]; Abdiel's latest series can be found in [4].

[1] https://lore.kernel.org/rust-for-linux/[email protected]/
[2] https://git.kernel.org/pub/scm/linux/kernel/git/dakr/linux.git/log/?h=page-iter
[3] https://git.kernel.org/pub/scm/linux/kernel/git/dakr/linux.git/log/?h=scatterlist
[4] https://lore.kernel.org/lkml/[email protected]/

Changes in v4:
- Replace "type state" leftovers.
- Add a brief explanation to RawSGTable.
- Mention "no interior mutability" in Sync safety comments.
- Add safety requirement to RawSGTable::new().
- Don't use pin-init for RawSGTable itself.

Changes in v3:
- Beautify max_segment assignment code.
- Rename DmaMapSg to DmaMappedSg and improve documentation.
- Rename SGTable::as_iter() into SGTable::iter() and remove IntoIterator impl.
- Consider struct sg_table::nents in SGTable::iter() and SGTableIter<'_>.

Changes in v2:
- Switch to an enum impl for DmaDirection utilizing compile time boundary checks.
- Add missing Send/ Sync impls.
- Rename as_ref() to from_raw().
- Add a bunch of inline annotations.
- Add a patch to introduce a typedef for dma_addr_t.
- Let dma_len() return ResourceSize.
- Add addional invariant to DmaMapSgt.
- In RawSGTable::new(), pass pages as mutable slice reference.
- Avoid casts when deriving max_segment in Owned::new().

Danilo Krummrich (5):
rust: dma: implement DataDirection
rust: dma: add type alias for bindings::dma_addr_t
rust: scatterlist: Add abstraction for sg_table
samples: rust: dma: add sample code for SGTable
MAINTAINERS: rust: dma: add scatterlist files

 MAINTAINERS                     |   4 +-
 drivers/gpu/nova-core/falcon.rs |   4 +-
 rust/bindings/bindings_helper.h |   1 +
 rust/helpers/helpers.c          |   1 +
 rust/helpers/scatterlist.c      |  24 ++
 rust/kernel/dma.rs              |  86 +++++-
 rust/kernel/lib.rs              |   1 +
 rust/kernel/scatterlist.rs      | 491 ++++++++++++++++++++++++++++++++
 samples/rust/rust_dma.rs        |  35 ++-
 9 files changed, 631 insertions(+), 16 deletions(-)
 create mode 100644 rust/helpers/scatterlist.c
 create mode 100644 rust/kernel/scatterlist.rs

base-commit: 27941214d368f3c17ed26a72662fc453bcc81b9d

Signature · 1 line
2.51.0