| Message ID | 20240311-alice-mm-v3-1-cdf7b3a2049c@google.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Memory management patches needed by Rust Binder | expand |
On 3/11/24 11:47, Alice Ryhl wrote: > From: Wedson Almeida Filho <wedsonaf@gmail.com> > > A pointer to an area in userspace memory, which can be either read-only > or read-write. > > All methods on this struct are safe: invalid pointers return `EFAULT`. > Concurrent access, *including data races to/from userspace memory*, is > permitted, because fundamentally another userspace thread/process could > always be modifying memory at the same time (in the same way that > userspace Rust's `std::io` permits data races with the contents of > files on disk). In the presence of a race, the exact byte values > read/written are unspecified but the operation is well-defined. > Kernelspace code should validate its copy of data after completing a > read, and not expect that multiple reads of the same address will return > the same value. > > These APIs are designed to make it difficult to accidentally write > TOCTOU bugs. Every time you read from a memory location, the pointer is > advanced by the length so that you cannot use that reader to read the > same memory location twice. Preventing double-fetches avoids TOCTOU > bugs. This is accomplished by taking `self` by value to prevent > obtaining multiple readers on a given `UserSlicePtr`, and the readers > only permitting forward reads. If double-fetching a memory location is > necessary for some reason, then that is done by creating multiple > readers to the same memory location. > > Constructing a `UserSlicePtr` performs no checks on the provided > address and length, it can safely be constructed inside a kernel thread > with no current userspace process. Reads and writes wrap the kernel APIs > `copy_from_user` and `copy_to_user`, which check the memory map of the > current process and enforce that the address range is within the user > range (no additional calls to `access_ok` are needed). > > This code is based on something that was originally written by Wedson on > the old rust branch. It was modified by Alice by removing the > `IoBufferReader` and `IoBufferWriter` traits, and various other changes. > > Signed-off-by: Wedson Almeida Filho <wedsonaf@gmail.com> > Co-developed-by: Alice Ryhl <aliceryhl@google.com> > Signed-off-by: Alice Ryhl <aliceryhl@google.com> Reviewed-by: Benno Lossin <benno.lossin@proton.me>
On Mon, Mar 11, 2024 at 10:47:13AM +0000, Alice Ryhl wrote: > From: Wedson Almeida Filho <wedsonaf@gmail.com> > [...] > + > +/// A reader for [`UserSlice`]. > +/// > +/// Used to incrementally read from the user slice. > +pub struct UserSliceReader { > + ptr: *mut c_void, > + length: usize, > +} > + > +impl UserSliceReader { [...] > + > + /// Reads raw data from the user slice into a raw kernel buffer. > + /// > + /// Fails with `EFAULT` if the read encounters a page fault. > + /// > + /// # Safety > + /// > + /// The `out` pointer must be valid for writing `len` bytes. > + pub unsafe fn read_raw(&mut self, out: *mut u8, len: usize) -> Result { I don't think we want to promote the pub usage of this unsafe function, right? We can provide a safe version: pub fn read_slice(&mut self, to: &[u8]) -> Result and all users can just use the safe version (with the help of slice::from_raw_parts_mut() if necessary). > + if len > self.length { > + return Err(EFAULT); > + } > + let Ok(len_ulong) = c_ulong::try_from(len) else { > + return Err(EFAULT); > + }; > + // SAFETY: The caller promises that `out` is valid for writing `len` bytes. > + let res = unsafe { bindings::copy_from_user(out.cast::<c_void>(), self.ptr, len_ulong) }; > + if res != 0 { > + return Err(EFAULT); > + } > + // Userspace pointers are not directly dereferencable by the kernel, so > + // we cannot use `add`, which has C-style rules for defined behavior. > + self.ptr = self.ptr.wrapping_byte_add(len); > + self.length -= len; > + Ok(()) > + } > + > + /// Reads the entirety of the user slice, appending it to the end of the > + /// provided buffer. > + /// > + /// Fails with `EFAULT` if the read encounters a page fault. > + pub fn read_all(mut self, buf: &mut Vec<u8>) -> Result { > + let len = self.length; > + buf.try_reserve(len)?; > + > + // SAFETY: The call to `try_reserve` was successful, so the spare > + // capacity is at least `len` bytes long. > + unsafe { self.read_raw(buf.spare_capacity_mut().as_mut_ptr().cast(), len)? }; > + > + // SAFETY: Since the call to `read_raw` was successful, so the next > + // `len` bytes of the vector have been initialized. > + unsafe { buf.set_len(buf.len() + len) }; > + Ok(()) > + } > +} > + > +/// A writer for [`UserSlice`]. > +/// > +/// Used to incrementally write into the user slice. > +pub struct UserSliceWriter { > + ptr: *mut c_void, > + length: usize, > +} > + > +impl UserSliceWriter { > + /// Returns the amount of space remaining in this buffer. > + /// > + /// Note that even writing less than this number of bytes may fail. > + pub fn len(&self) -> usize { > + self.length > + } > + > + /// Returns `true` if no more data can be written to this buffer. > + pub fn is_empty(&self) -> bool { > + self.length == 0 > + } > + > + /// Writes raw data to this user pointer from a raw kernel buffer. > + /// > + /// Fails with `EFAULT` if the write encounters a page fault. > + /// > + /// # Safety > + /// > + /// The `data` pointer must be valid for reading `len` bytes. > + pub unsafe fn write_raw(&mut self, data: *const u8, len: usize) -> Result { Same here, just remove the `pub`, and users should use write_slice() (with the help of slice::from_raw_parts() if necessary). Regards, Boqun > + if len > self.length { > + return Err(EFAULT); > + } > + let Ok(len_ulong) = c_ulong::try_from(len) else { > + return Err(EFAULT); > + }; > + let res = unsafe { bindings::copy_to_user(self.ptr, data.cast::<c_void>(), len_ulong) }; > + if res != 0 { > + return Err(EFAULT); > + } > + // Userspace pointers are not directly dereferencable by the kernel, so > + // we cannot use `add`, which has C-style rules for defined behavior. > + self.ptr = self.ptr.wrapping_byte_add(len); > + self.length -= len; > + Ok(()) > + } > + > + /// Writes the provided slice to this user pointer. > + /// > + /// Fails with `EFAULT` if the write encounters a page fault. > + pub fn write_slice(&mut self, data: &[u8]) -> Result { > + let len = data.len(); > + let ptr = data.as_ptr(); > + // SAFETY: The pointer originates from a reference to a slice of length > + // `len`, so the pointer is valid for reading `len` bytes. > + unsafe { self.write_raw(ptr, len) } > + } > +} > > -- > 2.44.0.278.ge034bb2e1d-goog >
On Mon, Mar 18, 2024 at 7:59 PM Boqun Feng <boqun.feng@gmail.com> wrote: > > On Mon, Mar 11, 2024 at 10:47:13AM +0000, Alice Ryhl wrote: > > + > > + /// Reads raw data from the user slice into a raw kernel buffer. > > + /// > > + /// Fails with `EFAULT` if the read encounters a page fault. > > + /// > > + /// # Safety > > + /// > > + /// The `out` pointer must be valid for writing `len` bytes. > > + pub unsafe fn read_raw(&mut self, out: *mut u8, len: usize) -> Result { > > I don't think we want to promote the pub usage of this unsafe function, > right? We can provide a safe version: > > pub fn read_slice(&mut self, to: &[u8]) -> Result > > and all users can just use the safe version (with the help of > slice::from_raw_parts_mut() if necessary). Personally, I think having the function be unsafe is plenty discouragement. Also, this method would need an &mut [u8], which opens the can of worms related to uninitialized memory. The _raw version of this method is strictly more powerful. I don't think I actually use it directly in Binder, so I can make it private if you think that's important. It needs to be pub(crate), though, since it is used in `Page`. Alice
On Mon, Mar 18, 2024 at 08:12:27PM +0100, Alice Ryhl wrote: > On Mon, Mar 18, 2024 at 7:59 PM Boqun Feng <boqun.feng@gmail.com> wrote: > > > > On Mon, Mar 11, 2024 at 10:47:13AM +0000, Alice Ryhl wrote: > > > + > > > + /// Reads raw data from the user slice into a raw kernel buffer. > > > + /// > > > + /// Fails with `EFAULT` if the read encounters a page fault. > > > + /// > > > + /// # Safety > > > + /// > > > + /// The `out` pointer must be valid for writing `len` bytes. > > > + pub unsafe fn read_raw(&mut self, out: *mut u8, len: usize) -> Result { > > > > I don't think we want to promote the pub usage of this unsafe function, > > right? We can provide a safe version: > > > > pub fn read_slice(&mut self, to: &[u8]) -> Result > > > > and all users can just use the safe version (with the help of > > slice::from_raw_parts_mut() if necessary). > > Personally, I think having the function be unsafe is plenty discouragement. > > Also, this method would need an &mut [u8], which opens the can of > worms related to uninitialized memory. The _raw version of this method make it a `&mut [MayUninit<u8>]` then? If that works, then _raw version is not more powerful therefore no need to pub it. > is strictly more powerful. > > I don't think I actually use it directly in Binder, so I can make it > private if you think that's important. It needs to be pub(crate), I might be too picky, but avoiding pub unsafe functions if not necessary could help us reduce unnecessary unsafe code ;-) Regards, Boqun > though, since it is used in `Page`. > > Alice
On Mon, Mar 18, 2024 at 8:33 PM Boqun Feng <boqun.feng@gmail.com> wrote: > > On Mon, Mar 18, 2024 at 08:12:27PM +0100, Alice Ryhl wrote: > > On Mon, Mar 18, 2024 at 7:59 PM Boqun Feng <boqun.feng@gmail.com> wrote: > > > > > > On Mon, Mar 11, 2024 at 10:47:13AM +0000, Alice Ryhl wrote: > > > > + > > > > + /// Reads raw data from the user slice into a raw kernel buffer. > > > > + /// > > > > + /// Fails with `EFAULT` if the read encounters a page fault. > > > > + /// > > > > + /// # Safety > > > > + /// > > > > + /// The `out` pointer must be valid for writing `len` bytes. > > > > + pub unsafe fn read_raw(&mut self, out: *mut u8, len: usize) -> Result { > > > > > > I don't think we want to promote the pub usage of this unsafe function, > > > right? We can provide a safe version: > > > > > > pub fn read_slice(&mut self, to: &[u8]) -> Result > > > > > > and all users can just use the safe version (with the help of > > > slice::from_raw_parts_mut() if necessary). > > > > Personally, I think having the function be unsafe is plenty discouragement. > > > > Also, this method would need an &mut [u8], which opens the can of > > worms related to uninitialized memory. The _raw version of this method > > make it a `&mut [MayUninit<u8>]` then? If that works, then _raw version > is not more powerful therefore no need to pub it. Nobody actually has a need for that. Also, it doesn't even remove the need for unsafe code in the caller, since the caller still needs to assert that the call has initialized the memory. > > is strictly more powerful. > > > > I don't think I actually use it directly in Binder, so I can make it > > private if you think that's important. It needs to be pub(crate), > > I might be too picky, but avoiding pub unsafe functions if not necessary > could help us reduce unnecessary unsafe code ;-) > > Regards, > Boqun > > > though, since it is used in `Page`. > > > > Alice
On Mon, Mar 18, 2024 at 09:10:07PM +0100, Alice Ryhl wrote: > On Mon, Mar 18, 2024 at 8:33 PM Boqun Feng <boqun.feng@gmail.com> wrote: > > > > On Mon, Mar 18, 2024 at 08:12:27PM +0100, Alice Ryhl wrote: > > > On Mon, Mar 18, 2024 at 7:59 PM Boqun Feng <boqun.feng@gmail.com> wrote: > > > > > > > > On Mon, Mar 11, 2024 at 10:47:13AM +0000, Alice Ryhl wrote: > > > > > + > > > > > + /// Reads raw data from the user slice into a raw kernel buffer. > > > > > + /// > > > > > + /// Fails with `EFAULT` if the read encounters a page fault. > > > > > + /// > > > > > + /// # Safety > > > > > + /// > > > > > + /// The `out` pointer must be valid for writing `len` bytes. > > > > > + pub unsafe fn read_raw(&mut self, out: *mut u8, len: usize) -> Result { > > > > > > > > I don't think we want to promote the pub usage of this unsafe function, > > > > right? We can provide a safe version: > > > > > > > > pub fn read_slice(&mut self, to: &[u8]) -> Result > > > > > > > > and all users can just use the safe version (with the help of > > > > slice::from_raw_parts_mut() if necessary). > > > > > > Personally, I think having the function be unsafe is plenty discouragement. > > > > > > Also, this method would need an &mut [u8], which opens the can of > > > worms related to uninitialized memory. The _raw version of this method > > > > make it a `&mut [MayUninit<u8>]` then? If that works, then _raw version > > is not more powerful therefore no need to pub it. > > Nobody actually has a need for that. Also, it doesn't even remove the I want to use read_slice() to replace read_raw(), and avoid even pub(crate) for read_raw(). > need for unsafe code in the caller, since the caller still needs to > assert that the call has initialized the memory. > If we have the read_slice(): pub fn read_slice(&mut self, to: &mut [MayUninit<u8>]) -> Result then the read_all() function can be implemented as: pub fn read_all(mut self, buf: &mut Vec<u8>) -> Result { let len = self.length; buf.try_reserve(len)?; // Append `len` bytes in the `buf`. self.read_slice(&mut buf.spare_capacity_mut()[0..len])?; // SAFETY: Since the call to `read_slice` was successful, so the // next `len` bytes of the vector have been initialized. unsafe { buf.set_len(buf.len() + len) }; Ok(()) } one unsafe block has been removed, and yes, you're right, there is still need of unsafe here, since the caller still needs to assert the memory has been initialized. However, to me, it's still an improvement, since one unsafe block gets removed because we get away from reasoning based on raw pointers and length. And yes, for the worst case, we still have the same amount of unsafe code. For example in `Page::copy_from_user_slice`, if read_slice() is used, we still need to: let mut s = unsafe { slice::from_raw_part_mut(dst.cast::<MayUninit<u8>>(), len) }; reader.read_slice(&mut s); i.e. move the unsafe part from `reader` to the construction of a "writable slice". However, it's still better, since contructing a slice is quite common in Rust so it's easy to check the safety requirement. I generally think replacing a pointer+length pair with a slice is better. Regards, Boqun > > > is strictly more powerful. > > > > > > I don't think I actually use it directly in Binder, so I can make it > > > private if you think that's important. It needs to be pub(crate), > > > > I might be too picky, but avoiding pub unsafe functions if not necessary > > could help us reduce unnecessary unsafe code ;-) > > > > Regards, > > Boqun > > > > > though, since it is used in `Page`. > > > > > > Alice
Hi Alice, I was trying to work on a patch for UserSlice::read_slice(), and I found a few place that may need some documentation improvements. Please see below: On Mon, Mar 11, 2024 at 10:47:13AM +0000, Alice Ryhl wrote: [...] > diff --git a/rust/kernel/uaccess.rs b/rust/kernel/uaccess.rs > new file mode 100644 > index 000000000000..020f3847683f > --- /dev/null > +++ b/rust/kernel/uaccess.rs > @@ -0,0 +1,315 @@ > +// SPDX-License-Identifier: GPL-2.0 > + > +//! User pointers. Since the type is renamed as UserSlice, maybe: //! Slices to user space memory regions. ? > +//! > +//! C header: [`include/linux/uaccess.h`](srctree/include/linux/uaccess.h) > + > +use crate::{bindings, error::code::*, error::Result}; > +use alloc::vec::Vec; > +use core::ffi::{c_ulong, c_void}; > + > +/// A pointer to an area in userspace memory, which can be either read-only or > +/// read-write. > +/// > +/// All methods on this struct are safe: attempting to read or write invalid > +/// pointers will return `EFAULT`. Concurrent access, *including data races Probably reword this a little bit: "All methods on this struct are safe: attempting to read or write on bad addresses (either out of the bound of the slice or unmapped addresses) will return `EFAULT`." , please see below for the reason. > +/// to/from userspace memory*, is permitted, because fundamentally another > +/// userspace thread/process could always be modifying memory at the same time > +/// (in the same way that userspace Rust's [`std::io`] permits data races with > +/// the contents of files on disk). In the presence of a race, the exact byte > +/// values read/written are unspecified but the operation is well-defined. > +/// Kernelspace code should validate its copy of data after completing a read, > +/// and not expect that multiple reads of the same address will return the same > +/// value. > +/// > +/// These APIs are designed to make it difficult to accidentally write TOCTOU > +/// (time-of-check to time-of-use) bugs. Every time a memory location is read, > +/// the reader's position is advanced by the read length and the next read will > +/// start from there. This helps prevent accidentally reading the same location > +/// twice and causing a TOCTOU bug. > +/// > +/// Creating a [`UserSliceReader`] and/or [`UserSliceWriter`] consumes the > +/// `UserSlice`, helping ensure that there aren't multiple readers or writers to > +/// the same location. > +/// > +/// If double-fetching a memory location is necessary for some reason, then that > +/// is done by creating multiple readers to the same memory location, e.g. using > +/// [`clone_reader`]. > +/// [...] > + /// Reads raw data from the user slice into a raw kernel buffer. > + /// > + /// Fails with `EFAULT` if the read encounters a page fault. Technically, this is not correct, since normal page faults can happen during copy_from_user() (for example, userspace memory gets swapped). So returning `EFAULT` really means the read happens on a bad address, which also matches `EFAULT`'s definition: EFAULT Bad address (POSIX.1-2001). so maybe reword this and the similar ones below into something like: /// Fails with `EFAULT` if the read happens on a bad address. Otherwise, people may think that this function just abort whenever there is a page fault. Thoughts? Regards, Boqun > + /// > + /// # Safety > + /// > + /// The `out` pointer must be valid for writing `len` bytes. > + pub unsafe fn read_raw(&mut self, out: *mut u8, len: usize) -> Result { > + if len > self.length { > + return Err(EFAULT); > + } > + let Ok(len_ulong) = c_ulong::try_from(len) else { > + return Err(EFAULT); > + }; > + // SAFETY: The caller promises that `out` is valid for writing `len` bytes. > + let res = unsafe { bindings::copy_from_user(out.cast::<c_void>(), self.ptr, len_ulong) }; > + if res != 0 { > + return Err(EFAULT); > + } > + // Userspace pointers are not directly dereferencable by the kernel, so > + // we cannot use `add`, which has C-style rules for defined behavior. > + self.ptr = self.ptr.wrapping_byte_add(len); > + self.length -= len; > + Ok(()) > + } > + [...]
On Mon, Mar 11, 2024 at 10:47:13AM +0000, Alice Ryhl wrote: > From: Wedson Almeida Filho <wedsonaf@gmail.com> > [...] > +/// # Examples > +/// > +/// Takes a region of userspace memory from the current process, and modify it > +/// by adding one to every byte in the region. > +/// > +/// ```no_run > +/// use alloc::vec::Vec; > +/// use core::ffi::c_void; > +/// use kernel::error::Result; > +/// use kernel::uaccess::UserSlice; > +/// > +/// pub fn bytes_add_one(uptr: *mut c_void, len: usize) -> Result<()> { I hit the following compile error when trying to run kunit test: ERROR:root:error: unreachable `pub` item --> rust/doctests_kernel_generated.rs:4167:1 | 4167 | pub fn bytes_add_one(uptr: *mut c_void, len: usize) -> Result<()> { | ---^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | | | help: consider restricting its visibility: `pub(crate)` | = help: or consider exporting it for use by other crates = note: requested on the command line with `-D unreachable-pub` error: unreachable `pub` item --> rust/doctests_kernel_generated.rs:4243:1 | 4243 | pub fn get_bytes_if_valid(uptr: *mut c_void, len: usize) -> Result<Vec<u8>> { | ---^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | | | help: consider restricting its visibility: `pub(crate)` | = help: or consider exporting it for use by other crates error: aborting due to 2 previous errors , which should be fixed if we make the function in the example not `pub`. > +/// let (read, mut write) = UserSlice::new(uptr, len).reader_writer(); > +/// > +/// let mut buf = Vec::new(); > +/// read.read_all(&mut buf)?; > +/// > +/// for b in &mut buf { > +/// *b = b.wrapping_add(1); > +/// } > +/// > +/// write.write_slice(&buf)?; > +/// Ok(()) > +/// } > +/// ``` > +/// > +/// Example illustrating a TOCTOU (time-of-check to time-of-use) bug. > +/// > +/// ```no_run > +/// use alloc::vec::Vec; > +/// use core::ffi::c_void; > +/// use kernel::error::{code::EINVAL, Result}; > +/// use kernel::uaccess::UserSlice; > +/// > +/// /// Returns whether the data in this region is valid. > +/// fn is_valid(uptr: *mut c_void, len: usize) -> Result<bool> { > +/// let read = UserSlice::new(uptr, len).reader(); > +/// > +/// let mut buf = Vec::new(); > +/// read.read_all(&mut buf)?; > +/// > +/// todo!() > +/// } > +/// > +/// /// Returns the bytes behind this user pointer if they are valid. > +/// pub fn get_bytes_if_valid(uptr: *mut c_void, len: usize) -> Result<Vec<u8>> { Ditto here. > +/// if !is_valid(uptr, len)? { > +/// return Err(EINVAL); > +/// } > +/// > +/// let read = UserSlice::new(uptr, len).reader(); > +/// > +/// let mut buf = Vec::new(); > +/// read.read_all(&mut buf)?; > +/// > +/// // THIS IS A BUG! The bytes could have changed since we checked them. > +/// // > +/// // To avoid this kind of bug, don't call `UserSlice::new` multiple > +/// // times with the same address. > +/// Ok(buf) > +/// } > +/// ``` > +/// > +/// [`std::io`]: https://doc.rust-lang.org/std/io/index.html > +/// [`clone_reader`]: UserSliceReader::clone_reader > +pub struct UserSlice { > + ptr: *mut c_void, > + length: usize, > +} > + Regards, Boqun [...]
diff --git a/rust/helpers.c b/rust/helpers.c index 70e59efd92bc..312b6fcb49d5 100644 --- a/rust/helpers.c +++ b/rust/helpers.c @@ -38,6 +38,20 @@ __noreturn void rust_helper_BUG(void) } EXPORT_SYMBOL_GPL(rust_helper_BUG); +unsigned long rust_helper_copy_from_user(void *to, const void __user *from, + unsigned long n) +{ + return copy_from_user(to, from, n); +} +EXPORT_SYMBOL_GPL(rust_helper_copy_from_user); + +unsigned long rust_helper_copy_to_user(void __user *to, const void *from, + unsigned long n) +{ + return copy_to_user(to, from, n); +} +EXPORT_SYMBOL_GPL(rust_helper_copy_to_user); + void rust_helper_mutex_lock(struct mutex *lock) { mutex_lock(lock); diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index be68d5e567b1..37f84223b83f 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -49,6 +49,7 @@ pub mod task; pub mod time; pub mod types; +pub mod uaccess; pub mod workqueue; #[doc(hidden)] diff --git a/rust/kernel/uaccess.rs b/rust/kernel/uaccess.rs new file mode 100644 index 000000000000..020f3847683f --- /dev/null +++ b/rust/kernel/uaccess.rs @@ -0,0 +1,315 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! User pointers. +//! +//! C header: [`include/linux/uaccess.h`](srctree/include/linux/uaccess.h) + +use crate::{bindings, error::code::*, error::Result}; +use alloc::vec::Vec; +use core::ffi::{c_ulong, c_void}; + +/// A pointer to an area in userspace memory, which can be either read-only or +/// read-write. +/// +/// All methods on this struct are safe: attempting to read or write invalid +/// pointers will return `EFAULT`. Concurrent access, *including data races +/// to/from userspace memory*, is permitted, because fundamentally another +/// userspace thread/process could always be modifying memory at the same time +/// (in the same way that userspace Rust's [`std::io`] permits data races with +/// the contents of files on disk). In the presence of a race, the exact byte +/// values read/written are unspecified but the operation is well-defined. +/// Kernelspace code should validate its copy of data after completing a read, +/// and not expect that multiple reads of the same address will return the same +/// value. +/// +/// These APIs are designed to make it difficult to accidentally write TOCTOU +/// (time-of-check to time-of-use) bugs. Every time a memory location is read, +/// the reader's position is advanced by the read length and the next read will +/// start from there. This helps prevent accidentally reading the same location +/// twice and causing a TOCTOU bug. +/// +/// Creating a [`UserSliceReader`] and/or [`UserSliceWriter`] consumes the +/// `UserSlice`, helping ensure that there aren't multiple readers or writers to +/// the same location. +/// +/// If double-fetching a memory location is necessary for some reason, then that +/// is done by creating multiple readers to the same memory location, e.g. using +/// [`clone_reader`]. +/// +/// # Examples +/// +/// Takes a region of userspace memory from the current process, and modify it +/// by adding one to every byte in the region. +/// +/// ```no_run +/// use alloc::vec::Vec; +/// use core::ffi::c_void; +/// use kernel::error::Result; +/// use kernel::uaccess::UserSlice; +/// +/// pub fn bytes_add_one(uptr: *mut c_void, len: usize) -> Result<()> { +/// let (read, mut write) = UserSlice::new(uptr, len).reader_writer(); +/// +/// let mut buf = Vec::new(); +/// read.read_all(&mut buf)?; +/// +/// for b in &mut buf { +/// *b = b.wrapping_add(1); +/// } +/// +/// write.write_slice(&buf)?; +/// Ok(()) +/// } +/// ``` +/// +/// Example illustrating a TOCTOU (time-of-check to time-of-use) bug. +/// +/// ```no_run +/// use alloc::vec::Vec; +/// use core::ffi::c_void; +/// use kernel::error::{code::EINVAL, Result}; +/// use kernel::uaccess::UserSlice; +/// +/// /// Returns whether the data in this region is valid. +/// fn is_valid(uptr: *mut c_void, len: usize) -> Result<bool> { +/// let read = UserSlice::new(uptr, len).reader(); +/// +/// let mut buf = Vec::new(); +/// read.read_all(&mut buf)?; +/// +/// todo!() +/// } +/// +/// /// Returns the bytes behind this user pointer if they are valid. +/// pub fn get_bytes_if_valid(uptr: *mut c_void, len: usize) -> Result<Vec<u8>> { +/// if !is_valid(uptr, len)? { +/// return Err(EINVAL); +/// } +/// +/// let read = UserSlice::new(uptr, len).reader(); +/// +/// let mut buf = Vec::new(); +/// read.read_all(&mut buf)?; +/// +/// // THIS IS A BUG! The bytes could have changed since we checked them. +/// // +/// // To avoid this kind of bug, don't call `UserSlice::new` multiple +/// // times with the same address. +/// Ok(buf) +/// } +/// ``` +/// +/// [`std::io`]: https://doc.rust-lang.org/std/io/index.html +/// [`clone_reader`]: UserSliceReader::clone_reader +pub struct UserSlice { + ptr: *mut c_void, + length: usize, +} + +impl UserSlice { + /// Constructs a user slice from a raw pointer and a length in bytes. + /// + /// Constructing a [`UserSlice`] performs no checks on the provided address + /// and length, it can safely be constructed inside a kernel thread with no + /// current userspace process. Reads and writes wrap the kernel APIs + /// `copy_from_user` and `copy_to_user`, which check the memory map of the + /// current process and enforce that the address range is within the user + /// range (no additional calls to `access_ok` are needed). + /// + /// Callers must be careful to avoid time-of-check-time-of-use + /// (TOCTOU) issues. The simplest way is to create a single instance of + /// [`UserSlice`] per user memory block as it reads each byte at + /// most once. + pub fn new(ptr: *mut c_void, length: usize) -> Self { + UserSlice { ptr, length } + } + + /// Reads the entirety of the user slice, appending it to the end of the + /// provided buffer. + /// + /// Fails with `EFAULT` if the read encounters a page fault. + pub fn read_all(self, buf: &mut Vec<u8>) -> Result { + self.reader().read_all(buf) + } + + /// Constructs a [`UserSliceReader`]. + pub fn reader(self) -> UserSliceReader { + UserSliceReader { + ptr: self.ptr, + length: self.length, + } + } + + /// Constructs a [`UserSliceWriter`]. + pub fn writer(self) -> UserSliceWriter { + UserSliceWriter { + ptr: self.ptr, + length: self.length, + } + } + + /// Constructs both a [`UserSliceReader`] and a [`UserSliceWriter`]. + /// + /// Usually when this is used, you will first read the data, and then + /// overwrite it afterwards. + pub fn reader_writer(self) -> (UserSliceReader, UserSliceWriter) { + ( + UserSliceReader { + ptr: self.ptr, + length: self.length, + }, + UserSliceWriter { + ptr: self.ptr, + length: self.length, + }, + ) + } +} + +/// A reader for [`UserSlice`]. +/// +/// Used to incrementally read from the user slice. +pub struct UserSliceReader { + ptr: *mut c_void, + length: usize, +} + +impl UserSliceReader { + /// Skip the provided number of bytes. + /// + /// Returns an error if skipping more than the length of the buffer. + pub fn skip(&mut self, num_skip: usize) -> Result { + // Update `self.length` first since that's the fallible part of this + // operation. + self.length = self.length.checked_sub(num_skip).ok_or(EFAULT)?; + self.ptr = self.ptr.wrapping_byte_add(num_skip); + Ok(()) + } + + /// Create a reader that can access the same range of data. + /// + /// Reading from the clone does not advance the current reader. + /// + /// The caller should take care to not introduce TOCTOU issues, as described + /// in the documentation for [`UserSlice`]. + pub fn clone_reader(&self) -> UserSliceReader { + UserSliceReader { + ptr: self.ptr, + length: self.length, + } + } + + /// Returns the number of bytes left to be read from this reader. + /// + /// Note that even reading less than this number of bytes may fail. + pub fn len(&self) -> usize { + self.length + } + + /// Returns `true` if no data is available in the io buffer. + pub fn is_empty(&self) -> bool { + self.length == 0 + } + + /// Reads raw data from the user slice into a raw kernel buffer. + /// + /// Fails with `EFAULT` if the read encounters a page fault. + /// + /// # Safety + /// + /// The `out` pointer must be valid for writing `len` bytes. + pub unsafe fn read_raw(&mut self, out: *mut u8, len: usize) -> Result { + if len > self.length { + return Err(EFAULT); + } + let Ok(len_ulong) = c_ulong::try_from(len) else { + return Err(EFAULT); + }; + // SAFETY: The caller promises that `out` is valid for writing `len` bytes. + let res = unsafe { bindings::copy_from_user(out.cast::<c_void>(), self.ptr, len_ulong) }; + if res != 0 { + return Err(EFAULT); + } + // Userspace pointers are not directly dereferencable by the kernel, so + // we cannot use `add`, which has C-style rules for defined behavior. + self.ptr = self.ptr.wrapping_byte_add(len); + self.length -= len; + Ok(()) + } + + /// Reads the entirety of the user slice, appending it to the end of the + /// provided buffer. + /// + /// Fails with `EFAULT` if the read encounters a page fault. + pub fn read_all(mut self, buf: &mut Vec<u8>) -> Result { + let len = self.length; + buf.try_reserve(len)?; + + // SAFETY: The call to `try_reserve` was successful, so the spare + // capacity is at least `len` bytes long. + unsafe { self.read_raw(buf.spare_capacity_mut().as_mut_ptr().cast(), len)? }; + + // SAFETY: Since the call to `read_raw` was successful, so the next + // `len` bytes of the vector have been initialized. + unsafe { buf.set_len(buf.len() + len) }; + Ok(()) + } +} + +/// A writer for [`UserSlice`]. +/// +/// Used to incrementally write into the user slice. +pub struct UserSliceWriter { + ptr: *mut c_void, + length: usize, +} + +impl UserSliceWriter { + /// Returns the amount of space remaining in this buffer. + /// + /// Note that even writing less than this number of bytes may fail. + pub fn len(&self) -> usize { + self.length + } + + /// Returns `true` if no more data can be written to this buffer. + pub fn is_empty(&self) -> bool { + self.length == 0 + } + + /// Writes raw data to this user pointer from a raw kernel buffer. + /// + /// Fails with `EFAULT` if the write encounters a page fault. + /// + /// # Safety + /// + /// The `data` pointer must be valid for reading `len` bytes. + pub unsafe fn write_raw(&mut self, data: *const u8, len: usize) -> Result { + if len > self.length { + return Err(EFAULT); + } + let Ok(len_ulong) = c_ulong::try_from(len) else { + return Err(EFAULT); + }; + let res = unsafe { bindings::copy_to_user(self.ptr, data.cast::<c_void>(), len_ulong) }; + if res != 0 { + return Err(EFAULT); + } + // Userspace pointers are not directly dereferencable by the kernel, so + // we cannot use `add`, which has C-style rules for defined behavior. + self.ptr = self.ptr.wrapping_byte_add(len); + self.length -= len; + Ok(()) + } + + /// Writes the provided slice to this user pointer. + /// + /// Fails with `EFAULT` if the write encounters a page fault. + pub fn write_slice(&mut self, data: &[u8]) -> Result { + let len = data.len(); + let ptr = data.as_ptr(); + // SAFETY: The pointer originates from a reference to a slice of length + // `len`, so the pointer is valid for reading `len` bytes. + unsafe { self.write_raw(ptr, len) } + } +}