Received-SPF: pass (google.com: domain of linux-kernel+bounces-146290-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Precedence: bulk
MIME-Version: 1.0
References: <20240415-alice-mm-v5-0-6f55e4d8ef51@google.com> <20240415-alice-mm-v5-3-6f55e4d8ef51@google.com>
In-Reply-To: <20240415-alice-mm-v5-3-6f55e4d8ef51@google.com>
From: Trevor Gross <tmgross@umich.edu>
Date: Tue, 16 Apr 2024 01:53:21 -0400
Message-ID: <CALNs47vkeAeU5jGk2AV_w0oRfPCiXzcWTGO_bauCnSsqQTX-iA@mail.gmail.com>
Subject: Re: [PATCH v5 3/4] rust: uaccess: add typed accessors for userspace pointers
To: Alice Ryhl <aliceryhl@google.com>
Cc: Miguel Ojeda <ojeda@kernel.org>, Matthew Wilcox <willy@infradead.org>, 
	Al Viro <viro@zeniv.linux.org.uk>, Andrew Morton <akpm@linux-foundation.org>, 
	Kees Cook <keescook@chromium.org>, Alex Gaynor <alex.gaynor@gmail.com>, 
	Wedson Almeida Filho <wedsonaf@gmail.com>, Boqun Feng <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>, 
	=?UTF-8?Q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com>, 
	Benno Lossin <benno.lossin@proton.me>, Andreas Hindborg <a.hindborg@samsung.com>, 
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>, =?UTF-8?B?QXJ2ZSBIasO4bm5ldsOlZw==?= <arve@android.com>, 
	Todd Kjos <tkjos@android.com>, Martijn Coenen <maco@android.com>, 
	Joel Fernandes <joel@joelfernandes.org>, Carlos Llamas <cmllamas@google.com>, 
	Suren Baghdasaryan <surenb@google.com>, Arnd Bergmann <arnd@arndb.de>, linux-mm@kvack.org, 
	linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, 
	Christian Brauner <brauner@kernel.org>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Mon, Apr 15, 2024 at 3:15=E2=80=AFAM Alice Ryhl <aliceryhl@google.com> w=
rote:
>
> Add safe methods for reading and writing Rust values to and from
> userspace pointers.
>
> The C methods for copying to/from userspace use a function called
> `check_object_size` to verify that the kernel pointer is not dangling.
> However, this check is skipped when the length is a compile-time
> constant, with the assumption that such cases trivially have a correct
> kernel pointer.
>
> In this patch, we apply the same optimization to the typed accessors.
> For both methods, the size of the operation is known at compile time to
> be size_of of the type being read or written. Since the C side doesn't
> provide a variant that skips only this check, we create custom helpers
> for this purpose.
>
> The majority of reads and writes to userspace pointers in the Rust
> Binder driver uses these accessor methods. Benchmarking has found that
> skipping the `check_object_size` check makes a big difference for the
> cases being skipped here. (And that the check doesn't make a difference
> for the cases that use the raw read/write methods.)
>
> This code is based on something that was originally written by Wedson on
> the old rust branch. It was modified by Alice to skip the
> `check_object_size` check, and to update various comments, including the
> notes about kernel pointers in `WritableToBytes`.
>
> Co-developed-by: Wedson Almeida Filho <wedsonaf@gmail.com>
> Signed-off-by: Wedson Almeida Filho <wedsonaf@gmail.com>
> Reviewed-by: Benno Lossin <benno.lossin@proton.me>
> Reviewed-by: Boqun Feng <boqun.feng@gmail.com>
> Signed-off-by: Alice Ryhl <aliceryhl@google.com>

Couple of docs nits but this looks good to me.

Reviewed-by: Trevor Gross <tmgross@umich.edu>

> +/// Types for which any bit pattern is valid.
> +///
> +/// Not all types are valid for all values. For example, a `bool` must b=
e either zero or one, so
> +/// reading arbitrary bytes into something that contains a `bool` is not=
 okay.
> +///
> +/// It's okay for the type to have padding, as initializing those bytes =
has no effect.
> +///
> +/// # Safety
> +///
> +/// All bit-patterns must be valid for this type.
> +pub unsafe trait FromBytes {}

No `UnsafeCell` is also a requirement in zerocopy/bytemuck

> +/// Types that can be viewed as an immutable slice of initialized bytes.
> +///
> +/// If a struct implements this trait, then it is okay to copy it byte-f=
or-byte to userspace. This
> +/// means that it should not have any padding, as padding bytes are unin=
itialized. Reading
> +/// uninitialized memory is not just undefined behavior, it may even lea=
d to leaking sensitive
> +/// information on the stack to userspace.
> +///
> +/// The struct should also not hold kernel pointers, as kernel pointer a=
ddresses are also considered
> +/// sensitive. However, leaking kernel pointers is not considered undefi=
ned behavior by Rust, so
> +/// this is a correctness requirement, but not a safety requirement.

I don't think mentions of userspace are relevant here since the trait
is more general. Maybe a `# Interfacing with userspace` section if
there is enough relevant information.

> +/// # Safety
> +///
> +/// Values of this type may not contain any uninitialized bytes.

No UnsafeCell

> +pub unsafe trait AsBytes {}

> diff --git a/rust/kernel/uaccess.rs b/rust/kernel/uaccess.rs
> index c97029cdeba1..e3953eec61a3 100644
> --- a/rust/kernel/uaccess.rs
> +++ b/rust/kernel/uaccess.rs
> @@ -4,10 +4,15 @@
>  //!
>  //! C header: [`include/linux/uaccess.h`](srctree/include/linux/uaccess.=
h)
>
> -use crate::{bindings, error::code::*, error::Result};
> +use crate::{
> +    bindings,
> +    error::code::*,
> +    error::Result,
> +    types::{AsBytes, FromBytes},
> +};
>  use alloc::vec::Vec;
>  use core::ffi::{c_ulong, c_void};
> -use core::mem::MaybeUninit;
> +use core::mem::{size_of, MaybeUninit};
>
>  /// A pointer to an area in userspace memory, which can be either read-o=
nly or read-write.
>  ///
> @@ -238,6 +243,38 @@ pub fn read_slice(&mut self, out: &mut [u8]) -> Resu=
lt {
>          self.read_raw(out)
>      }
>
> +    /// Reads a value of the specified type.
> +    ///
> +    /// Fails with `EFAULT` if the read encounters a page fault.
> +    pub fn read<T: FromBytes>(&mut self) -> Result<T> {
> [...]
> +    /// Writes the provided Rust value to this userspace pointer.
> +    ///
> +    /// Fails with `EFAULT` if the write encounters a page fault.
> +    pub fn write<T: AsBytes>(&mut self, value: &T) -> Result {

Read & write could use an example if you are up for it