From patchwork Mon Apr 15 07:13:53 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13629527 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id C28EBC00A94 for ; Mon, 15 Apr 2024 07:14:21 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 583D36B008C; Mon, 15 Apr 2024 03:14:21 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 50B5A6B0092; Mon, 15 Apr 2024 03:14:21 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3ACA46B0093; Mon, 15 Apr 2024 03:14:21 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 16E6F6B008C for ; Mon, 15 Apr 2024 03:14:21 -0400 (EDT) Received: from smtpin16.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id C6C3C140498 for ; Mon, 15 Apr 2024 07:14:20 +0000 (UTC) X-FDA: 82010902680.16.F4A52E0 Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) by imf21.hostedemail.com (Postfix) with ESMTP id 16FAC1C000C for ; Mon, 15 Apr 2024 07:14:18 +0000 (UTC) Authentication-Results: imf21.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=mDZ+B8Wr; spf=pass (imf21.hostedemail.com: domain of 3ytMcZgkKCB03EB57KRAE9HH9E7.5HFEBGNQ-FFDO35D.HK9@flex--aliceryhl.bounces.google.com designates 209.85.219.202 as permitted sender) smtp.mailfrom=3ytMcZgkKCB03EB57KRAE9HH9E7.5HFEBGNQ-FFDO35D.HK9@flex--aliceryhl.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1713165259; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=gPsi/82HDlElzGLDbKl3QsVxsZX8wiW1/rZTZrUN8mw=; b=Qymfh+Kn+m4Sd4JM3aCP1XHmOelTzfXtim3AGauFtejXSJjBn36BT3Yy+nlN9N+4BOQybl tShlObz6k9p8UuIfgMYKYLZ6oAFOLwN6wYJ1TYWgW4/GMsctZ+m0jrzMIZS4t5nQotCzq9 O3MqJca81WTXawuRfNpiJL2cbTNMCTM= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1713165259; a=rsa-sha256; cv=none; b=dqpWiypRrYgSjJ6naqdtb0dC165S7XAWzHcN6tCDt8rmzluCUZxdfDuetpI6mhc9ub7L2F TkpWZbaRbCVG+t4CSjZgc3miqbFEPDEDfUo0VVhz0x1i2fBa2lSHGBB948mMyBmsiE/MNd Ghgo3b66XvSNbxOkyKxWZwiWDeZ1nHE= ARC-Authentication-Results: i=1; imf21.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=mDZ+B8Wr; spf=pass (imf21.hostedemail.com: domain of 3ytMcZgkKCB03EB57KRAE9HH9E7.5HFEBGNQ-FFDO35D.HK9@flex--aliceryhl.bounces.google.com designates 209.85.219.202 as permitted sender) smtp.mailfrom=3ytMcZgkKCB03EB57KRAE9HH9E7.5HFEBGNQ-FFDO35D.HK9@flex--aliceryhl.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-dcbee93a3e1so4685658276.3 for ; Mon, 15 Apr 2024 00:14:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1713165258; x=1713770058; darn=kvack.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=gPsi/82HDlElzGLDbKl3QsVxsZX8wiW1/rZTZrUN8mw=; b=mDZ+B8Wr2OgNstHX9Wtl0PbuFgaYKM+40Fw+Ip0QlJi8hSnSPsMkt9pc+ZtUQ6ibsz JsKmoBl4OAiRrQzB9F2tDnDvzF7DJQJeA8u7/3kO7QZp22d0zsc7ikZVCudgPZtQ1ed3 lh94IJZ/jdZ/xUg7H/8A9j69lJB92IwUWyKX+/yZrsuagxq8NMs+kqmY9oHgr+lSN0Et oEIM5cIzBThptaQXov0w8VE7brzBQ6ENmz9d2vIq2UUWQjQ4Ap12pbw9mQofXIsB2LEX DLCR0lTnpdA019QVWwM6o18yGAtiOrA/ALv8JurUm23jp2v85o6Bp1+r2CMLLWmJvvYz pHQQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713165258; x=1713770058; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=gPsi/82HDlElzGLDbKl3QsVxsZX8wiW1/rZTZrUN8mw=; b=YYJTUsdYgnR/ba1PPJKjPnxP1DhXLPxpP59AvHVao0E0E/0wxRsBzXNlzE73KggyMR JUMo+3sx0Lgvlhhpr5walbDDX7BbPzLgdvD1ybRdwY9kXEbEcRZVgIP2xo795dLx3bQp mAuwQgMgaYHx//o87SYBTcwCrgqRiLuRPpiiyCEgoBX3b7tovw5Jon/casWLz/CXjHg9 Oi7wEPr1rygZJYehGpMYMYzuox2vbcQjDEiwXH1WP6WoHX6TGcYroI9cqO73okxZBgKG DTfvGrYt80J+PqHlLdi6oVEVukEnjSPsPcclQWjtEe06bW/ooagM729vb7M1N2xguEC6 qbVg== X-Forwarded-Encrypted: i=1; AJvYcCWFsHuEMY+j+/7sBbuvXDKRGqL/h2gjYupyb+4nUpHlZKlrHa6ja1EkBXQxg24qFYRvJCP7baSezSmiLHR9Cd9wIBs= X-Gm-Message-State: AOJu0Ywbkjw76cDse2I8C5dAhS4iRHoOLQXwm9W+XL/mz+3yx+fu4GFO fSpylcxp5ijkScVR3AQjzkE1T+0dPm0vtB0NWW4nfbZvsw3FVpaR3f6BBS3jP5eOBmkSVjdguYo Vt9Zlvw+/kAkhWQ== X-Google-Smtp-Source: AGHT+IHO1a/TIo+ODNueO5S/jTlindE5np/HbvfupAbQcKpEJq3V8CqBFgvXPRG//Zj7Vd3zjtFH6qla2qW3cT0= X-Received: from aliceryhl2.c.googlers.com ([fda3:e722:ac3:cc00:68:949d:c0a8:572]) (user=aliceryhl job=sendgmr) by 2002:a05:6902:10c2:b0:dbd:73bd:e55a with SMTP id w2-20020a05690210c200b00dbd73bde55amr1133317ybu.4.1713165258199; Mon, 15 Apr 2024 00:14:18 -0700 (PDT) Date: Mon, 15 Apr 2024 07:13:53 +0000 In-Reply-To: <20240415-alice-mm-v5-0-6f55e4d8ef51@google.com> Mime-Version: 1.0 References: <20240415-alice-mm-v5-0-6f55e4d8ef51@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=15177; i=aliceryhl@google.com; h=from:subject:message-id; bh=SoqPn2LPVb+BTP38IpB0LoymmpwLHXDbLBIRx2qwK8A=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBmHNPBHO7WqwzbeKC9Qz1KbtF1FhT8jL8Hmg2gQ n91Fr4IeoOJAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZhzTwQAKCRAEWL7uWMY5 RjWsEAC1nW29kfPewx8tCwQiy7+HkXLiviVtLhUxxUNufpUittkrOOP65Fra1jtpRO+yslVhCuk j7CsRdUQjzmLVscuHrIZybxw/MtKAKW5mTtE+olQID2W78hFeus0NNtAWvTszYMxX2rsCUY/EGH JcXLdfyxQYYPdqxpA9wbooEKhhwvD+THmC3otpEfAp8eWGmpXOVFh2C0HQnoBUQnCXW/K7J6G6K yTrEnoiJhsJsEEC7eB6W8+dSS7NldSM7z+AnY/TLie3FMxtTDhiAhMmjVRtu06kLzEugm2U3U0j UQ/HHYGrv/16pb9FZPgt/OwWSYXr3T3gR9bYBoR7pfpTk2bOYEotJeF1PrppuKpCZBAcYFkDrkW Nfnd8TUXgIt6SPq7PqGjVbKJ1Bd+Lg31/xp47ZcXDOl/VfUTdv/B0tt654Isn3NOIkjPrhFQEVX Ke47rtST9Hf7zpePx2p57C2IykFNfSllyjtGPA3cRDLH504dMI8rdioLue09U2mUdm0/kno87ss bJQv4218KT4oVFhxDvka6O+ItO1CzDtbgYVqKmijvH9AdVvHBJJQULal7rlA69iG/LGEuA5in/D QzZMxUgLiUJnHMNo9RJibboJ9siWBvzOKfzybv3VJ1YuQE0wVChFUQA1bycUfkSlmFfQMDoiJFA eWhuU2AKk4teOyw== X-Mailer: b4 0.13-dev-26615 Message-ID: <20240415-alice-mm-v5-1-6f55e4d8ef51@google.com> Subject: [PATCH v5 1/4] rust: uaccess: add userspace pointers From: Alice Ryhl To: Miguel Ojeda , Matthew Wilcox , Al Viro , Andrew Morton , Kees Cook Cc: Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Benno Lossin , Andreas Hindborg , Greg Kroah-Hartman , " =?utf-8?q?Arve_Hj=C3=B8?= =?utf-8?q?nnev=C3=A5g?= " , Todd Kjos , Martijn Coenen , Joel Fernandes , Carlos Llamas , Suren Baghdasaryan , Arnd Bergmann , linux-mm@kvack.org, linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, Alice Ryhl , Christian Brauner X-Rspamd-Queue-Id: 16FAC1C000C X-Rspam-User: X-Rspamd-Server: rspam11 X-Stat-Signature: pgqdz7nk954t3auidmgc1rkosoi5m76o X-HE-Tag: 1713165258-680976 X-HE-Meta: U2FsdGVkX1/Q+K6l1fEY5Awa9QIQjA5Ly4FjFUrjgQPsOlP9K1ULjIyaQ0Y9ELMuxpmNQTUaiTse9VQww31egH+NW2CzWbMcirY2Yex6Tf69mA+a0xe/EIqgcRc2/EuzdzzBG8zZgUxLijuyFCAn0VU54ZCgFaHlsN6Mk0bn0k7uCqq6Aiw5o2S8/9e7SeeCx39PCFGI3EphJ4FHIUBQd7HJU5OSFFFGPwCOHf0VJN9rUECi6sYPmGiQjhcFyoYpeZ7STK2HCOBYOcBuC1okS3hCsFZU8O5MVAyg+c5sKMVbnmXbZKqTB6aXbjXHymLO6+X6emVZjH2e1ysfk0esllNQqzQRDtR3p2PV/Fw4udftsd1ZXij/hNtwiwOg94DIfVEfvZyLYaq4Mp0KAnVm9by+rXEgSeClN1peqcsEipGpIuxud38nMlj+nnsItmTYAiUNnnf/ioN4Bn7oIu1IVAOAlk9DBZaTwqTNOQsynMNJq1TZrYmO3Bir92RM3ogIJ3WzW+f6irHpnOUwMxW33UKJCOU+4flsVw/3r4W9utJSAr/jUzm2SKklZbeczb1hX4ELY5cmbgqxFeC5FhCUpqQB9/ajV0qNN7urKOLagc2SEZXsE74cqaZNkujBqUwl7miuzq1pR8gsHCpo5c7Fli/4NCXTQg4NUWsIWGVuPEcA6262jemBlIJbRL1CCPnGBsQavY6TpKqZkBkyTFeR3eUlyxf2SXwDau9z1Zi6bWpXJfs2cRXgY6CyvAsdKbK6i55q/BJVpaLlR9Yf1I/rg+/qNQQb8RNHwZH3rpUaxUFL0f7kHKsvt9ynwwFA7FffJos9rcPcMKgldA85ZUFwwHU8CqPBEVxQF05lPk6VBaEietdhS9dhAuydRysLocEscNTX2z2iSZi1EUbBe7tekAWA1xfaqSmNK1EoZfc9Ch/zM8TgzRFCYbf81cWZtw3PTUoVljTBos2MrpI4iZ8 XSd/Aibu MpIdy8Pa2zTFri3QSgcJtz4cOUJxJYljyJe/KcOBuu6WUZKV+CCW/0gomuvSYdTm9KwT6H7Ps3KiZbZzNiJox+IpITHBR3JJBAQSTQJB9z7D39BbHCsrsHDCoV6Jjl0mA0eDTRZUdeWHbKKLOphgIiA/h8zB/2Yi2dwtJZ3LtFt7bGtQqQIHXeN0s3lJO24WU4wSMpkuS6b+Q/3ILwNilnmykk68Nn6aWNSGtxKc4KBNvLwe/yKx5z4pb8WUuzg4vtReWDwcGFn9Sbg63CYawJVREWQrXZ/nxecjWs8ScpNFmiHAZ1CAvaYjesi7FOb3Hb704A9uQr13jk9T2muEGZsCvn2rSYPYvJEhGmtM7EsiZF+bp/WxifRxeRFtbNJs/+j9Zalm3pRa17e80AmWuVTbyMPTlVhDmtB6G5H23wk06SlXtlHYH/3W1SGiOVQWKtiZm X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: From: Wedson Almeida Filho 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 on bad addresses (either out of the bound of the slice or unmapped addresses) 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 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 Co-developed-by: Alice Ryhl Signed-off-by: Alice Ryhl Reviewed-by: Benno Lossin Reviewed-by: Boqun Feng Reviewed-by: Trevor Gross --- rust/helpers.c | 14 +++ rust/kernel/lib.rs | 1 + rust/kernel/uaccess.rs | 304 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 319 insertions(+) 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..c97029cdeba1 --- /dev/null +++ b/rust/kernel/uaccess.rs @@ -0,0 +1,304 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! 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}; +use core::mem::MaybeUninit; + +/// 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 on bad addresses (either out of +/// the bound of the slice or unmapped addresses) 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; +/// +/// 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 { +/// 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. +/// fn get_bytes_if_valid(uptr: *mut c_void, len: usize) -> Result> { +/// 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 happens on a bad address. + pub fn read_all(self, buf: &mut Vec) -> 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 kernel buffer. + /// + /// After a successful call to this method, all bytes in `out` are initialized. + /// + /// Fails with `EFAULT` if the read happens on a bad address. + pub fn read_raw(&mut self, out: &mut [MaybeUninit]) -> Result { + let len = out.len(); + let out_ptr = out.as_mut_ptr().cast::(); + if len > self.length { + return Err(EFAULT); + } + let Ok(len_ulong) = c_ulong::try_from(len) else { + return Err(EFAULT); + }; + // SAFETY: `out_ptr` points into a mutable slice of length `len_ulong`, so we may write + // that many bytes to it. + let res = unsafe { bindings::copy_from_user(out_ptr, 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 raw data from the user slice into a kernel buffer. + /// + /// Fails with `EFAULT` if the read happens on a bad address. + pub fn read_slice(&mut self, out: &mut [u8]) -> Result { + // SAFETY: The types are compatible and `read_raw` doesn't write uninitialized bytes to + // `out`. + let out = unsafe { &mut *(out as *mut [u8] as *mut [MaybeUninit]) }; + self.read_raw(out) + } + + /// Reads the entirety of the user slice, appending it to the end of the provided buffer. + /// + /// Fails with `EFAULT` if the read happens on a bad address. + pub fn read_all(mut self, buf: &mut Vec) -> Result { + let len = self.length; + buf.try_reserve(len)?; + + // The call to `try_reserve` was successful, so the spare capacity is at least `len` bytes + // long. + self.read_raw(&mut buf.spare_capacity_mut()[..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 kernel buffer. + /// + /// Fails with `EFAULT` if the write happens on a bad address. + pub fn write_slice(&mut self, data: &[u8]) -> Result { + let len = data.len(); + let data_ptr = data.as_ptr().cast::(); + if len > self.length { + return Err(EFAULT); + } + let Ok(len_ulong) = c_ulong::try_from(len) else { + return Err(EFAULT); + }; + // SAFETY: `data_ptr` points into an immutable slice of length `len_ulong`, so we may read + // that many bytes from it. + let res = unsafe { bindings::copy_to_user(self.ptr, data_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(()) + } +}