[PATCH v4 0/2] rust: transmute: add `as_bytes(_mut)` methods for `AsBytes` trait

[PATCH v4 0/2] rust: transmute: add `as_bytes(_mut)` methods for `AsBytes` trait

[Alexandre Courbot]

This is the sister patch of [1], providing an `as_bytes` method for
`AsBytes`, and an `as_bytes_mut` accessor for types also implementing
`FromBytes`.

It is going to be used in Nova, but should also be universally useful -
if anything, it felt a bit strange that `AsBytes` did not provide this
so far.

[1] https://lore.kernel.org/rust-for-linux/20250624042802.105623-1-christiansantoslima21@gmail.com/

Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
---
Changes in v4:
- Add the `as_bytes_mut` method for types also implementing `FromBytes`.
  (thanks Alice!)
- Link to v3: https://lore.kernel.org/r/20250726-as_bytes-v3-1-eb7514faab28@nvidia.com

Changes in v3:
- Use `ptr::from_ref` instead of `as *const T`.
- Link to v2: https://lore.kernel.org/r/20250725-as_bytes-v2-1-c6584c211a6c@nvidia.com

Changes in v2:
- Use `size_of_val` to provide a default implementation for both `Sized`
  and non-`Sized` types, and remove `AsBytesSized`. (thanks Alice!)
- Link to v1: https://lore.kernel.org/r/20250725-as_bytes-v1-1-6f06a3744f69@nvidia.com

---
Alexandre Courbot (2):
      rust: transmute: add `as_bytes` method for `AsBytes` trait
      rust: transmute: add `as_bytes_mut` method to `AsBytes` trait

 rust/kernel/transmute.rs | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)
---
base-commit: 14ae91a81ec8fa0bc23170d4aa16dd2a20d54105
change-id: 20250725-as_bytes-6cbc11f2e8c3

Best regards,
-- 
Alexandre Courbot <acourbot@nvidia.com>

[PATCH v4 1/2] rust: transmute: add `as_bytes` method for `AsBytes` trait

[Alexandre Courbot]

Every type that implements `AsBytes` should be able to provide its byte
representation. Introduce the `as_bytes` method that returns the
implementer as a stream of bytes, and provide a default implementation
that should be suitable for any type that satisfies `AsBytes`'s safety
requirements.

Reviewed-by: Danilo Krummrich <dakr@kernel.org>
Reviewed-by: Benno Lossin <lossin@kernel.org>
Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
---
 rust/kernel/transmute.rs | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/rust/kernel/transmute.rs b/rust/kernel/transmute.rs
index 1c7d43771a37b90150de86699f114a2ffb84db91..d541c9960904d8c7f755351f22d06e4e8dbd546a 100644
--- a/rust/kernel/transmute.rs
+++ b/rust/kernel/transmute.rs
@@ -47,7 +47,16 @@ macro_rules! impl_frombytes {
 ///
 /// Values of this type may not contain any uninitialized bytes. This type must not have interior
 /// mutability.
-pub unsafe trait AsBytes {}
+pub unsafe trait AsBytes {
+    /// Returns `self` as a slice of bytes.
+    fn as_bytes(&self) -> &[u8] {
+        let data = core::ptr::from_ref(self).cast::<u8>();
+        let len = size_of_val(self);
+
+        // SAFETY: `data` is non-null and valid for reads over `len * sizeof::<u8>()` bytes.
+        unsafe { core::slice::from_raw_parts(data, len) }
+    }
+}
 
 macro_rules! impl_asbytes {
     ($($({$($generics:tt)*})? $t:ty, )*) => {

-- 
2.50.1

[PATCH v4 2/2] rust: transmute: add `as_bytes_mut` method to `AsBytes` trait

[Alexandre Courbot]

Types that implement both `AsBytes` and `FromBytes` can be safely
modified as a slice of bytes. Add a `as_bytes_mut` method for that
purpose.

Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
---
 rust/kernel/transmute.rs | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/rust/kernel/transmute.rs b/rust/kernel/transmute.rs
index d541c9960904d8c7f755351f22d06e4e8dbd546a..000fda2a78f8e6e8378bbe93cddd8a5008db20cc 100644
--- a/rust/kernel/transmute.rs
+++ b/rust/kernel/transmute.rs
@@ -56,6 +56,19 @@ fn as_bytes(&self) -> &[u8] {
         // SAFETY: `data` is non-null and valid for reads over `len * sizeof::<u8>()` bytes.
         unsafe { core::slice::from_raw_parts(data, len) }
     }
+
+    /// Returns `self` as a mutable slice of bytes.
+    fn as_bytes_mut(&mut self) -> &mut [u8]
+    where
+        Self: FromBytes,
+    {
+        let data = core::ptr::from_mut(self).cast::<u8>();
+        let len = size_of_val(self);
+
+        // SAFETY: `data` is non-null and valid for read and writes over `len * sizeof::<u8>()`
+        // bytes. Since `Self` implements `FromBytes` it can be represented by any value.
+        unsafe { core::slice::from_raw_parts_mut(data, len) }
+    }
 }
 
 macro_rules! impl_asbytes {

-- 
2.50.1

Re: [PATCH v4 0/2] rust: transmute: add `as_bytes(_mut)` methods for `AsBytes` trait

[Alice Ryhl]

On Mon, Jul 28, 2025 at 09:47:50PM +0900, Alexandre Courbot wrote:
> This is the sister patch of [1], providing an `as_bytes` method for
> `AsBytes`, and an `as_bytes_mut` accessor for types also implementing
> `FromBytes`.
> 
> It is going to be used in Nova, but should also be universally useful -
> if anything, it felt a bit strange that `AsBytes` did not provide this
> so far.
> 
> [1] https://lore.kernel.org/rust-for-linux/20250624042802.105623-1-christiansantoslima21@gmail.com/
> 
> Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
> ---
> Changes in v4:
> - Add the `as_bytes_mut` method for types also implementing `FromBytes`.
>   (thanks Alice!)
> - Link to v3: https://lore.kernel.org/r/20250726-as_bytes-v3-1-eb7514faab28@nvidia.com
> 
> Changes in v3:
> - Use `ptr::from_ref` instead of `as *const T`.
> - Link to v2: https://lore.kernel.org/r/20250725-as_bytes-v2-1-c6584c211a6c@nvidia.com
> 
> Changes in v2:
> - Use `size_of_val` to provide a default implementation for both `Sized`
>   and non-`Sized` types, and remove `AsBytesSized`. (thanks Alice!)
> - Link to v1: https://lore.kernel.org/r/20250725-as_bytes-v1-1-6f06a3744f69@nvidia.com
> 
> ---
> Alexandre Courbot (2):
>       rust: transmute: add `as_bytes` method for `AsBytes` trait
>       rust: transmute: add `as_bytes_mut` method to `AsBytes` trait

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

Re: [PATCH v4 2/2] rust: transmute: add `as_bytes_mut` method to `AsBytes` trait

[Danilo Krummrich]

On 7/28/25 2:47 PM, Alexandre Courbot wrote:
> Types that implement both `AsBytes` and `FromBytes` can be safely
> modified as a slice of bytes. Add a `as_bytes_mut` method for that
> purpose.
> 
> Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>

Reviewed-by: Danilo Krummrich <dakr@kernel.org>

Re: [PATCH v4 0/2] rust: transmute: add `as_bytes(_mut)` methods for `AsBytes` trait

[Gary Guo]

On Mon, 28 Jul 2025 21:47:50 +0900
Alexandre Courbot <acourbot@nvidia.com> wrote:

> This is the sister patch of [1], providing an `as_bytes` method for
> `AsBytes`, and an `as_bytes_mut` accessor for types also implementing
> `FromBytes`.
> 
> It is going to be used in Nova, but should also be universally useful -
> if anything, it felt a bit strange that `AsBytes` did not provide this
> so far.
> 
> [1] https://lore.kernel.org/rust-for-linux/20250624042802.105623-1-christiansantoslima21@gmail.com/
> 
> Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
> ---
> Changes in v4:
> - Add the `as_bytes_mut` method for types also implementing `FromBytes`.
>   (thanks Alice!)
> - Link to v3: https://lore.kernel.org/r/20250726-as_bytes-v3-1-eb7514faab28@nvidia.com
> 
> Changes in v3:
> - Use `ptr::from_ref` instead of `as *const T`.
> - Link to v2: https://lore.kernel.org/r/20250725-as_bytes-v2-1-c6584c211a6c@nvidia.com
> 
> Changes in v2:
> - Use `size_of_val` to provide a default implementation for both `Sized`
>   and non-`Sized` types, and remove `AsBytesSized`. (thanks Alice!)
> - Link to v1: https://lore.kernel.org/r/20250725-as_bytes-v1-1-6f06a3744f69@nvidia.com
> 
> ---
> Alexandre Courbot (2):
>       rust: transmute: add `as_bytes` method for `AsBytes` trait
>       rust: transmute: add `as_bytes_mut` method to `AsBytes` trait
> 
>  rust/kernel/transmute.rs | 24 +++++++++++++++++++++++-
>  1 file changed, 23 insertions(+), 1 deletion(-)
> ---
> base-commit: 14ae91a81ec8fa0bc23170d4aa16dd2a20d54105
> change-id: 20250725-as_bytes-6cbc11f2e8c3
> 
> Best regards,

Reviewed-by: Gary Guo <gary@garyguo.net>

Re: [PATCH v4 1/2] rust: transmute: add `as_bytes` method for `AsBytes` trait

[Benno Lossin]

On Mon Jul 28, 2025 at 2:47 PM CEST, Alexandre Courbot wrote:
> diff --git a/rust/kernel/transmute.rs b/rust/kernel/transmute.rs
> index 1c7d43771a37b90150de86699f114a2ffb84db91..d541c9960904d8c7f755351f22d06e4e8dbd546a 100644
> --- a/rust/kernel/transmute.rs
> +++ b/rust/kernel/transmute.rs
> @@ -47,7 +47,16 @@ macro_rules! impl_frombytes {
>  ///
>  /// Values of this type may not contain any uninitialized bytes. This type must not have interior
>  /// mutability.
> -pub unsafe trait AsBytes {}
> +pub unsafe trait AsBytes {
> +    /// Returns `self` as a slice of bytes.
> +    fn as_bytes(&self) -> &[u8] {
> +        let data = core::ptr::from_ref(self).cast::<u8>();

Let's add a `CAST` comment above this that says:

    // CAST: `Self` implements `AsBytes` thus all bytes of `self` are initialized.

> +        let len = size_of_val(self);
> +
> +        // SAFETY: `data` is non-null and valid for reads over `len * sizeof::<u8>()` bytes.

s/over/of/

---
Cheers,
Benno

> +        unsafe { core::slice::from_raw_parts(data, len) }
> +    }
> +}
>  
>  macro_rules! impl_asbytes {
>      ($($({$($generics:tt)*})? $t:ty, )*) => {

Re: [PATCH v4 2/2] rust: transmute: add `as_bytes_mut` method to `AsBytes` trait

[Benno Lossin]

On Mon Jul 28, 2025 at 2:47 PM CEST, Alexandre Courbot wrote:
> diff --git a/rust/kernel/transmute.rs b/rust/kernel/transmute.rs
> index d541c9960904d8c7f755351f22d06e4e8dbd546a..000fda2a78f8e6e8378bbe93cddd8a5008db20cc 100644
> --- a/rust/kernel/transmute.rs
> +++ b/rust/kernel/transmute.rs
> @@ -56,6 +56,19 @@ fn as_bytes(&self) -> &[u8] {
>          // SAFETY: `data` is non-null and valid for reads over `len * sizeof::<u8>()` bytes.
>          unsafe { core::slice::from_raw_parts(data, len) }
>      }
> +
> +    /// Returns `self` as a mutable slice of bytes.
> +    fn as_bytes_mut(&mut self) -> &mut [u8]
> +    where
> +        Self: FromBytes,
> +    {
> +        let data = core::ptr::from_mut(self).cast::<u8>();

Also add a `CAST` comment above this line:

    // CAST: `Self` implements both `AsBytes` and `FromBytes` thus making `Self` bi-directionally
    // transmutable to `[u8; size_of_val(self)]`.

On that note, `FromBytes` probably entails `Sized`, or does someone have
a use-case in mind? (because then we could replace the
`size_of_val(self)` above with `size_of::<Self>()` which I think makes
it simpler to understand)

> +        let len = size_of_val(self);
> +
> +        // SAFETY: `data` is non-null and valid for read and writes over `len * sizeof::<u8>()`

s/over/of/

> +        // bytes. Since `Self` implements `FromBytes` it can be represented by any value.

Don't need the second sentence due to the `CAST` comment above.

---
Cheers,
Benno

> +        unsafe { core::slice::from_raw_parts_mut(data, len) }
> +    }
>  }
>  
>  macro_rules! impl_asbytes {

Re: [PATCH v4 2/2] rust: transmute: add `as_bytes_mut` method to `AsBytes` trait

[Boqun Feng]

On Mon, Jul 28, 2025 at 04:53:31PM +0200, Benno Lossin wrote:
> On Mon Jul 28, 2025 at 2:47 PM CEST, Alexandre Courbot wrote:
> > diff --git a/rust/kernel/transmute.rs b/rust/kernel/transmute.rs
> > index d541c9960904d8c7f755351f22d06e4e8dbd546a..000fda2a78f8e6e8378bbe93cddd8a5008db20cc 100644
> > --- a/rust/kernel/transmute.rs
> > +++ b/rust/kernel/transmute.rs
> > @@ -56,6 +56,19 @@ fn as_bytes(&self) -> &[u8] {
> >          // SAFETY: `data` is non-null and valid for reads over `len * sizeof::<u8>()` bytes.
> >          unsafe { core::slice::from_raw_parts(data, len) }
> >      }
> > +
> > +    /// Returns `self` as a mutable slice of bytes.
> > +    fn as_bytes_mut(&mut self) -> &mut [u8]
> > +    where
> > +        Self: FromBytes,
> > +    {
> > +        let data = core::ptr::from_mut(self).cast::<u8>();
> 
> Also add a `CAST` comment above this line:
> 
>     // CAST: `Self` implements both `AsBytes` and `FromBytes` thus making `Self` bi-directionally
>     // transmutable to `[u8; size_of_val(self)]`.
> 
> On that note, `FromBytes` probably entails `Sized`, or does someone have
> a use-case in mind? (because then we could replace the

Because if `T` is `FromBytes` then we want `[T]` is `FromBytes` too?
Also it would be weird if `[u8]` itself doesn't implement `FromBytes`.

Regards,
Boqun

> `size_of_val(self)` above with `size_of::<Self>()` which I think makes
> it simpler to understand)
> 
[...]

Re: [PATCH v4 2/2] rust: transmute: add `as_bytes_mut` method to `AsBytes` trait

[Benno Lossin]

On Mon Jul 28, 2025 at 4:59 PM CEST, Boqun Feng wrote:
> On Mon, Jul 28, 2025 at 04:53:31PM +0200, Benno Lossin wrote:
>> On Mon Jul 28, 2025 at 2:47 PM CEST, Alexandre Courbot wrote:
>> > diff --git a/rust/kernel/transmute.rs b/rust/kernel/transmute.rs
>> > index d541c9960904d8c7f755351f22d06e4e8dbd546a..000fda2a78f8e6e8378bbe93cddd8a5008db20cc 100644
>> > --- a/rust/kernel/transmute.rs
>> > +++ b/rust/kernel/transmute.rs
>> > @@ -56,6 +56,19 @@ fn as_bytes(&self) -> &[u8] {
>> >          // SAFETY: `data` is non-null and valid for reads over `len * sizeof::<u8>()` bytes.
>> >          unsafe { core::slice::from_raw_parts(data, len) }
>> >      }
>> > +
>> > +    /// Returns `self` as a mutable slice of bytes.
>> > +    fn as_bytes_mut(&mut self) -> &mut [u8]
>> > +    where
>> > +        Self: FromBytes,
>> > +    {
>> > +        let data = core::ptr::from_mut(self).cast::<u8>();
>> 
>> Also add a `CAST` comment above this line:
>> 
>>     // CAST: `Self` implements both `AsBytes` and `FromBytes` thus making `Self` bi-directionally
>>     // transmutable to `[u8; size_of_val(self)]`.
>> 
>> On that note, `FromBytes` probably entails `Sized`, or does someone have
>> a use-case in mind? (because then we could replace the
>
> Because if `T` is `FromBytes` then we want `[T]` is `FromBytes` too?
> Also it would be weird if `[u8]` itself doesn't implement `FromBytes`.

Oh yeah that's true.

---
Cheers,
Benno