linux-kernel - Re: [PATCH] rust: io: rename `io::Io` accessors

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <Z7O4VHWZPk1yNwC7@pollux>
Date: Mon, 17 Feb 2025 23:29:40 +0100
From: Danilo Krummrich <dakr@...nel.org>
To: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
Cc: Daniel Almeida <daniel.almeida@...labora.com>,
	Fiona Behrens <me@...enk.dev>, Miguel Ojeda <ojeda@...nel.org>,
	Alex Gaynor <alex.gaynor@...il.com>,
	Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	Benno Lossin <benno.lossin@...ton.me>,
	Andreas Hindborg <a.hindborg@...nel.org>,
	Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>,
	Bjorn Helgaas <bhelgaas@...gle.com>,
	Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
	rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org,
	linux-pci@...r.kernel.org
Subject: Re: [PATCH] rust: io: rename `io::Io` accessors

On Mon, Feb 17, 2025 at 10:59:58PM +0100, Miguel Ojeda wrote:
> On Mon, Feb 17, 2025 at 10:37 PM Daniel Almeida
> <daniel.almeida@...labora.com> wrote:
> >
> > IMHO, the `writel` and `readl` nomenclature is extremely widespread, so it’s a bit confusing to see this renamed.
> 
> We could generate `#[doc(alias = "...")]`s if that helps -- it would
> appear if you type `writel` in the search, for instance.

This is a good idea, I think.

> 
> (I guess the rename could be justified (just a bit) by the fact that
> in Rust we are using fixed-width integers and so on more...)

This is a good reason too. My main reason for proposing this was that if we back
the trait with both MMIO and PIO `writel` and `readl` nomenclature might falsely
be read as if it is limited to MMIO.