Linux PCI subsystem development
 help / color / mirror / Atom feed
From: "Gary Guo" <gary@garyguo.net>
To: "Alexandre Courbot" <acourbot@nvidia.com>, "Gary Guo" <gary@garyguo.net>
Cc: "Alice Ryhl" <aliceryhl@google.com>,
	"Daniel Almeida" <daniel.almeida@collabora.com>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Boqun Feng" <boqun@kernel.org>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Tamir Duberstein" <tamird@kernel.org>,
	"Onur Özkan" <work@onurozkan.dev>,
	"Bjorn Helgaas" <bhelgaas@google.com>,
	"Krzysztof Wilczyński" <kwilczynski@kernel.org>,
	"Abdiel Janulgue" <abdiel.janulgue@gmail.com>,
	"Robin Murphy" <robin.murphy@arm.com>,
	"David Airlie" <airlied@gmail.com>,
	"Simona Vetter" <simona@ffwll.ch>,
	"Michal Wilczynski" <m.wilczynski@samsung.com>,
	"Uwe Kleine-König" <ukleinek@kernel.org>,
	"Danilo Krummrich" <dakr@kernel.org>,
	driver-core@lists.linux.dev, rust-for-linux@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-pci@vger.kernel.org,
	nova-gpu@lists.linux.dev, dri-devel@lists.freedesktop.org,
	linux-pwm@vger.kernel.org
Subject: Re: [PATCH v5 12/20] rust: io: move `Io` methods to extension trait
Date: Fri, 03 Jul 2026 13:43:06 +0100	[thread overview]
Message-ID: <DJOY0VTYTXGV.131A1QNJEAPLU@garyguo.net> (raw)
In-Reply-To: <DJOPUWC8C7GU.29L05GZVLOLO8@nvidia.com>

On Fri Jul 3, 2026 at 7:19 AM BST, Alexandre Courbot wrote:
> On Fri Jun 26, 2026 at 11:45 PM JST, Gary Guo wrote:
>> `Io` trait now has a single required methods with many more provided
>
> nit: s/methods/method
>
>> methods. Provided methods may want to rely on their implementations to not
>> be arbitrarily overridden by implementers for correctness or soundness.
>>
>> Thus, extract these methods to a new trait and provide a blanket
>> implementation. This pattern is used extensively in userspace Rust
>> libraries e.g. `tokio` where `AsyncRead` has minimum methods and
>> `AsyncReadExt` is what users mostly interact with.
>>
>> To avoid changing all user imports, the base trait is renamed to `IoBase`
>> and the newly added trait takes the existing `Io` name.
>>
>> A `size` method is added as an example of methods that users should not
>> override.
>
> WDYM by "an example"? There are already all the I/O accessors that we
> wish not to override; this looks more like a new method is just added.

It wouldn't be incorrect if I/O accessors are overriden, it's just that we don't
anticipate these being overriden. On the other hand, `size` method can be easily
relied upon by other methods (like patch 19 where you mentioned) and it can lead
to UB if it's overriden to something completely wrong. The `size` method is
actually what motivated making this extension trait in the first place.

Best,
Gary


>
> Besides, it is not used until patch 19, so how about introducing it
> there?
>
> <...>
>> @@ -326,6 +323,21 @@ pub trait Io<'a>: Copy {
>>  
>>      /// Return a view that covers the full region.
>>      fn as_view(self) -> <Self::Backend as IoBackend>::View<'a, Self::Target>;
>> +}
>> +
>> +/// Extension trait to provide I/O operation methods to types that implement [`IoBase`].
>> +///
>> +/// This trait provides:
>> +/// - Helper methods for offset validation and address calculation
>> +/// - Fallible (runtime checked) accessors for different data widths
>> +///
>> +/// Which I/O methods are available depends on the associated [`IoBackend`] implementation.
>> +pub trait Io<'a>: IoBase<'a> {
>> +    /// Returns the size of this I/O region.
>> +    #[inline]
>> +    fn size(self) -> usize {
>> +        KnownSize::size(Self::Backend::as_ptr(self.as_view()))
>
> nit: the documentation for `as_ptr` says that the pointer "should be
> used for projection only". Technically we are not projecting here; maybe
> the documentation should be updated to say the pointer must not be
> dereferenced instead.
>
> In any case,
>
> Reviewed-by: Alexandre Courbot <acourbot@nvidia.com>



  reply	other threads:[~2026-07-03 12:43 UTC|newest]

Thread overview: 67+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-26 14:45 [PATCH v5 00/20] rust: I/O type generalization and projection Gary Guo
2026-06-26 14:45 ` [PATCH v5 01/20] rust: io: add dynamically-sized `Region` type Gary Guo
2026-06-26 14:52   ` sashiko-bot
2026-07-03  3:16   ` Alexandre Courbot
2026-07-03 12:38     ` Gary Guo
2026-06-26 14:45 ` [PATCH v5 02/20] rust: io: add missing safety requirement in `IoCapable` methods Gary Guo
2026-06-26 15:00   ` sashiko-bot
2026-07-03  2:57   ` Alexandre Courbot
2026-07-03 12:35     ` Gary Guo
2026-07-03 13:09       ` Alexandre Courbot
2026-07-03 13:49         ` Gary Guo
2026-06-26 14:45 ` [PATCH v5 03/20] rust: io: restrict untyped IO access and `register!` to `Region` Gary Guo
2026-06-26 15:03   ` sashiko-bot
2026-06-26 14:45 ` [PATCH v5 04/20] rust: io: implement `Io` on reference types instead Gary Guo
2026-06-26 14:57   ` sashiko-bot
2026-06-26 14:45 ` [PATCH v5 05/20] rust: io: generalize `MmioRaw` to pointer to arbitrary type Gary Guo
2026-06-26 15:02   ` sashiko-bot
2026-06-26 14:45 ` [PATCH v5 06/20] rust: io: rename `Mmio` to `MmioOwned` Gary Guo
2026-06-26 14:56   ` sashiko-bot
2026-06-26 14:45 ` [PATCH v5 07/20] rust: io: implement `Mmio` as view type Gary Guo
2026-06-26 15:01   ` sashiko-bot
2026-07-03  3:30   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 08/20] rust: pci: io: make `ConfigSpace` a view Gary Guo
2026-06-26 14:53   ` sashiko-bot
2026-06-26 14:45 ` [PATCH v5 09/20] rust: io: use view types instead of addresses for `Io` Gary Guo
2026-06-26 14:55   ` sashiko-bot
2026-07-03  5:03   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 10/20] pwm: th1520: remove unnecessary `deref` Gary Guo
2026-06-26 14:52   ` sashiko-bot
2026-07-03  5:04   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 11/20] rust: io: remove `MmioOwned` Gary Guo
2026-06-26 14:53   ` sashiko-bot
2026-07-03  5:58   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 12/20] rust: io: move `Io` methods to extension trait Gary Guo
2026-06-26 14:56   ` sashiko-bot
2026-07-03  6:19   ` Alexandre Courbot
2026-07-03 12:43     ` Gary Guo [this message]
2026-06-26 14:45 ` [PATCH v5 13/20] rust: io: add projection macro and methods Gary Guo
2026-06-26 15:00   ` sashiko-bot
2026-07-03  6:39   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 14/20] rust: io: add I/O backend for system memory with volatile access Gary Guo
2026-06-26 14:57   ` sashiko-bot
2026-07-03 11:37   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 15/20] rust: io: implement a view type for `Coherent` Gary Guo
2026-06-26 15:05   ` sashiko-bot
2026-07-03 13:14   ` Alexandre Courbot
2026-07-03 13:50     ` Gary Guo
2026-07-03 14:39       ` Alexandre Courbot
2026-07-03 14:44         ` Gary Guo
2026-06-26 14:45 ` [PATCH v5 16/20] rust: io: add `read_val` and `write_val` functions on `Io` Gary Guo
2026-06-26 14:59   ` sashiko-bot
2026-07-03 14:43   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 17/20] gpu: nova-core: use I/O projection for cleaner encapsulation Gary Guo
2026-06-26 15:06   ` sashiko-bot
2026-07-03 14:46   ` Alexandre Courbot
2026-07-03 15:13     ` Gary Guo
2026-06-26 14:45 ` [PATCH v5 18/20] rust: dma: drop `dma_read!` and `dma_write!` API Gary Guo
2026-06-26 15:12   ` sashiko-bot
2026-07-03 14:47   ` Alexandre Courbot
2026-06-26 14:45 ` [PATCH v5 19/20] rust: io: add copying methods Gary Guo
2026-06-26 15:02   ` sashiko-bot
2026-06-26 14:45 ` [PATCH v5 20/20] rust: io: implement `IoSysMap` Gary Guo
2026-06-26 14:59   ` sashiko-bot
2026-06-28 23:37 ` [PATCH v5 00/20] rust: I/O type generalization and projection Danilo Krummrich
2026-06-29 14:15   ` Gary Guo
2026-06-30 13:02     ` Miguel Ojeda
2026-06-30 13:07       ` Gary Guo

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=DJOY0VTYTXGV.131A1QNJEAPLU@garyguo.net \
    --to=gary@garyguo.net \
    --cc=a.hindborg@kernel.org \
    --cc=abdiel.janulgue@gmail.com \
    --cc=acourbot@nvidia.com \
    --cc=airlied@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=bhelgaas@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun@kernel.org \
    --cc=dakr@kernel.org \
    --cc=daniel.almeida@collabora.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=driver-core@lists.linux.dev \
    --cc=gregkh@linuxfoundation.org \
    --cc=kwilczynski@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=linux-pwm@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=m.wilczynski@samsung.com \
    --cc=nova-gpu@lists.linux.dev \
    --cc=ojeda@kernel.org \
    --cc=rafael@kernel.org \
    --cc=robin.murphy@arm.com \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=simona@ffwll.ch \
    --cc=tamird@kernel.org \
    --cc=tmgross@umich.edu \
    --cc=ukleinek@kernel.org \
    --cc=work@onurozkan.dev \
    /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