From: Alice Ryhl <aliceryhl@google.com>
To: Gary Guo <gary@garyguo.net>
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>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@samsung.com>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Arve Hjønnevåg" <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>,
"Trevor Gross" <tmgross@umich.edu>,
linux-mm@kvack.org, linux-kernel@vger.kernel.org,
rust-for-linux@vger.kernel.org,
"Christian Brauner" <brauner@kernel.org>
Subject: Re: [PATCH v6 3/4] rust: uaccess: add typed accessors for userspace pointers
Date: Fri, 26 Apr 2024 09:13:18 +0200 [thread overview]
Message-ID: <CAH5fLgjHALMTsWNj_rRBZTgKPTPzWBEo=5VVahS_Vxag-nizPA@mail.gmail.com> (raw)
In-Reply-To: <20240425171358.54dc96e4@eugeo>
On Thu, Apr 25, 2024 at 6:14 PM Gary Guo <gary@garyguo.net> wrote:
>
> On Thu, 18 Apr 2024 08:59:19 +0000
> Alice Ryhl <aliceryhl@google.com> wrote:
>
> > 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>
> > Reviewed-by: Trevor Gross <tmgross@umich.edu>
> > Signed-off-by: Alice Ryhl <aliceryhl@google.com>
>
> Reviewed-by: Gary Guo <gary@garyguo.net>
>
> > ---
> > rust/kernel/types.rs | 64 ++++++++++++++++++++++++++++++++++++++++
> > rust/kernel/uaccess.rs | 79 ++++++++++++++++++++++++++++++++++++++++++++++++--
> > 2 files changed, 141 insertions(+), 2 deletions(-)
> >
> > diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs
> > index 8fad61268465..9c57c6c75553 100644
> > --- a/rust/kernel/types.rs
> > +++ b/rust/kernel/types.rs
> >
> > +/// 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-for-byte to userspace. This
> > +/// means that it should not have any padding, as padding bytes are uninitialized. Reading
> > +/// uninitialized memory is not just undefined behavior, it may even lead to leaking sensitive
> > +/// information on the stack to userspace.
> > +///
> > +/// The struct should also not hold kernel pointers, as kernel pointer addresses are also considered
> > +/// sensitive. However, leaking kernel pointers is not considered undefined behavior by Rust, so
> > +/// this is a correctness requirement, but not a safety requirement.
> > +///
> > +/// # Safety
> > +///
> > +/// Values of this type may not contain any uninitialized bytes. This type must not have interior
> > +/// mutability.
> > +pub unsafe trait AsBytes {}
> > +
> > +// SAFETY: Instances of the following types have no uninitialized portions.
> > +unsafe impl AsBytes for u8 {}
> > +unsafe impl AsBytes for u16 {}
> > +unsafe impl AsBytes for u32 {}
> > +unsafe impl AsBytes for u64 {}
> > +unsafe impl AsBytes for usize {}
> > +unsafe impl AsBytes for i8 {}
> > +unsafe impl AsBytes for i16 {}
> > +unsafe impl AsBytes for i32 {}
> > +unsafe impl AsBytes for i64 {}
> > +unsafe impl AsBytes for isize {}
> > +unsafe impl AsBytes for bool {}
> > +unsafe impl AsBytes for char {}
> > +unsafe impl AsBytes for str {}
> > +// SAFETY: If individual values in an array have no uninitialized portions, then the array itself
> > +// does not have any uninitialized portions either.
> > +unsafe impl<T: AsBytes> AsBytes for [T] {}
>
> nit: I would move `str` to here, since `str` is essentially `[u8]` with
> UTF-8 guarantee.
>
> > +unsafe impl<T: AsBytes, const N: usize> AsBytes for [T; N] {}
Yes ... but the safety comment here talks about arrays and their
individual values. I don't think it transfers cleanly to str, and that
the other safety comment fits str better.
Alice
next prev parent reply other threads:[~2024-04-26 7:13 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-18 8:59 [PATCH v6 0/4] Memory management patches needed by Rust Binder Alice Ryhl
2024-04-18 8:59 ` [PATCH v6 1/4] rust: uaccess: add userspace pointers Alice Ryhl
2024-04-19 17:11 ` Boqun Feng
2024-04-19 18:12 ` Alice Ryhl
2024-04-18 8:59 ` [PATCH v6 2/4] uaccess: always export _copy_[from|to]_user with CONFIG_RUST Alice Ryhl
2024-05-14 17:27 ` Andrew Morton
2024-05-15 7:34 ` Arnd Bergmann
2024-04-18 8:59 ` [PATCH v6 3/4] rust: uaccess: add typed accessors for userspace pointers Alice Ryhl
2024-04-18 13:01 ` Benno Lossin
2024-04-18 13:17 ` Alice Ryhl
2024-04-18 16:23 ` Benno Lossin
2024-04-18 17:19 ` Boqun Feng
2024-04-18 19:35 ` Alice Ryhl
2024-04-18 20:01 ` Boqun Feng
2024-04-18 17:52 ` Trevor Gross
2024-04-25 16:13 ` Gary Guo
2024-04-26 7:13 ` Alice Ryhl [this message]
2024-04-18 8:59 ` [PATCH v6 4/4] rust: add abstraction for `struct page` Alice Ryhl
2024-04-18 18:52 ` Boqun Feng
2024-04-18 22:08 ` Benno Lossin
2024-04-18 22:56 ` Boqun Feng
2024-04-18 23:04 ` Boqun Feng
2024-04-19 8:36 ` Benno Lossin
2024-04-19 17:23 ` Boqun Feng
2024-04-19 19:24 ` Benno Lossin
2024-04-19 19:35 ` Boqun Feng
2024-04-25 16:20 ` 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='CAH5fLgjHALMTsWNj_rRBZTgKPTPzWBEo=5VVahS_Vxag-nizPA@mail.gmail.com' \
--to=aliceryhl@google.com \
--cc=a.hindborg@samsung.com \
--cc=akpm@linux-foundation.org \
--cc=alex.gaynor@gmail.com \
--cc=arnd@arndb.de \
--cc=arve@android.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=brauner@kernel.org \
--cc=cmllamas@google.com \
--cc=gary@garyguo.net \
--cc=gregkh@linuxfoundation.org \
--cc=joel@joelfernandes.org \
--cc=keescook@chromium.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=maco@android.com \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=surenb@google.com \
--cc=tkjos@android.com \
--cc=tmgross@umich.edu \
--cc=viro@zeniv.linux.org.uk \
--cc=wedsonaf@gmail.com \
--cc=willy@infradead.org \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).