Received-SPF: pass (google.com: domain of linux-kernel+bounces-61251-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Precedence: bulk
MIME-Version: 1.0
References: <20240208-alice-mm-v2-0-d821250204a6@google.com>
 <20240208-alice-mm-v2-4-d821250204a6@google.com> <d35a656b-b802-4f1e-90d6-7320d61ed818@gmail.com>
In-Reply-To: <d35a656b-b802-4f1e-90d6-7320d61ed818@gmail.com>
From: Alice Ryhl <aliceryhl@google.com>
Date: Mon, 12 Feb 2024 10:36:48 +0100
Message-ID: <CAH5fLghM2thHeQifehUDT1b64okVn3sh6Eg_oPxqoK2zU-EJGw@mail.gmail.com>
Subject: Re: [PATCH v2 4/4] rust: add abstraction for `struct page`
To: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Cc: Miguel Ojeda <ojeda@kernel.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>, 
	Kees Cook <keescook@chromium.org>, Al Viro <viro@zeniv.linux.org.uk>, 
	Andrew Morton <akpm@linux-foundation.org>, 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 Sat, Feb 10, 2024 at 5:23=E2=80=AFAM Martin Rodriguez Reboredo
<yakoyoku@gmail.com> wrote:
>
> On 2/8/24 12:47, Alice Ryhl wrote:
> > [...]
> > +    /// Maps the page and reads from it into the given buffer.
> > +    ///
> > +    /// This method will perform bounds checks on the page offset. If =
`offset ..
> > +    /// offset+len` goes outside ot the page, then this call returns `=
EINVAL`.
> > +    ///
> > +    /// # Safety
> > +    ///
> > +    /// * Callers must ensure that `dst` is valid for writing `len` by=
tes.
> > +    /// * Callers must ensure that this call does not race with a writ=
e to the
> > +    ///   same page that overlaps with this read.
>
> This safety section says that a call mustn't race with a page that
> overlaps this read, hmmmmm.

Is there a question here?

> > +    pub unsafe fn read_raw(&self, dst: *mut u8, offset: usize, len: us=
ize) -> Result {
> > +        self.with_pointer_into_page(offset, len, move |src| {
> > +            // SAFETY: If `with_pointer_into_page` calls into this clo=
sure, then
> > +            // it has performed a bounds check and guarantees that `sr=
c` is
> > +            // valid for `len` bytes.
> > +            //
> > +            // There caller guarantees that there is no data race.
> > +            unsafe { ptr::copy(src, dst, len) };
>
> If `src` and `dst` overlap then wouldn't that be a bad idea? If so then
> how about mentioning that callers have to ensure that `dst` does not
> overlap with the page that's being read and use
> `core::ptr::copy_nonoverlapping` instead, otherwise the doc comment
> could mention that `dst` can overlap.

I'll use copy_nonoverlapping. Thanks for the suggestion.

Alice