From patchwork Thu Apr 4 12:31:42 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13617775 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 BA143CD1284 for ; Thu, 4 Apr 2024 12:32:18 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id E09916B009C; Thu, 4 Apr 2024 08:32:16 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id DB8396B009E; Thu, 4 Apr 2024 08:32:16 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id B947F6B009F; Thu, 4 Apr 2024 08:32:16 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id 8F6EE6B009C for ; Thu, 4 Apr 2024 08:32:16 -0400 (EDT) Received: from smtpin24.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 5475F1C1176 for ; Thu, 4 Apr 2024 12:32:16 +0000 (UTC) X-FDA: 81971787072.24.8DABB6C Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) by imf12.hostedemail.com (Postfix) with ESMTP id 5905240003 for ; Thu, 4 Apr 2024 12:32:14 +0000 (UTC) Authentication-Results: imf12.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=nefkCrHA; spf=pass (imf12.hostedemail.com: domain of 3zZ0OZgkKCHoYjgacpwfjemmejc.amkjglsv-kkitYai.mpe@flex--aliceryhl.bounces.google.com designates 209.85.128.201 as permitted sender) smtp.mailfrom=3zZ0OZgkKCHoYjgacpwfjemmejc.amkjglsv-kkitYai.mpe@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=1712233934; 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=upT25yzbahblDd5bFzHBxFzV9brjNUZc4+hrC3EotZA=; b=jHnGpWv8o6NrYSkI8jrbHs9c0FLt2FeRZUsdSViDebGJAY/ffC2sufIRsRlqs4PyEkDv7S qqek3MiKECFrh6wAf5FEMV3h2PoZg5mY2c9p8qf22qdAO+lmj24LgGOWuC8Qk1t6V8u7Fd duE7Q7ip6Nn6DyGTwOU3bVJgh1XyYeQ= ARC-Authentication-Results: i=1; imf12.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=nefkCrHA; spf=pass (imf12.hostedemail.com: domain of 3zZ0OZgkKCHoYjgacpwfjemmejc.amkjglsv-kkitYai.mpe@flex--aliceryhl.bounces.google.com designates 209.85.128.201 as permitted sender) smtp.mailfrom=3zZ0OZgkKCHoYjgacpwfjemmejc.amkjglsv-kkitYai.mpe@flex--aliceryhl.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1712233934; a=rsa-sha256; cv=none; b=3g21qpC+5fhIJkdc+keUawYnozjzRyQ9hVN7gBmYoYFLzit9K9m7IpWEi6Ck8pewvu365C eg/cPdXpcfawYNi3OzdoEGc7JCj0WxYq6kr2K/K/wZlIx1h0ZJ7PYx2gI4AxrhFBslrBpL nAdu+dToA2qgC5wS5BNh2rvqWQESTsI= Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-615032a8ce5so16676067b3.3 for ; Thu, 04 Apr 2024 05:32:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1712233933; x=1712838733; 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=upT25yzbahblDd5bFzHBxFzV9brjNUZc4+hrC3EotZA=; b=nefkCrHA7IPkdN5V5gFevA8Y9nHNxVxi0VJ7g7c4BR/FK9Vry+6LUJsAGnbP3IaKCn /VZ2cG3XYVdqk9iBGInUvEJh/Gy+/M4KEmHPyMS72cECaotRyeZnxA49G41ZefXosrJc 0T3yv7fgANJjg5eFiPEsSIhONu+6ogNCctUlaiYMu5J2eo8ilonzm1ctsIZpzx7KyLqX OxSV3/FA6i8th3waWec3K67khU+Iip4SjwGqEpr9m0ZAMTc5YKqa0eg7r3A3Xh1lPf2Z lTXVITCF2ssqAU0Ki31je35kqlk0aJgvHCfC1IPNHtkaQnyKlVBHMVohpza0xl2GJTZZ GRHw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1712233933; x=1712838733; 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=upT25yzbahblDd5bFzHBxFzV9brjNUZc4+hrC3EotZA=; b=siHeiEVQTp3hLgDbGwlKYXy8oGKLLRGRUsDVN8SozDGij1yqwMuFIRAaId7fcUHwpe 6NWLE/Z+vo2zubhoGc80bOO7R9q/FTgKRLoHniOx+nFqVBUDQ3EuTncb2xX2jF1dV5Ui Ge/Mu0cHduoYOJfoCxLuds3ktdlI0uD/yYnNr8v1a0rr2R32gZcTXIyIoOAkgTjBpr6U mZ6B6rrtf4CofdLzHED3qmjDR28NR/gJeNJtwb7iamt2tDD4nOhVreKcx3XbuK4rA8o4 fhhXL6gIkXqYgDflxttzJ+yNULNh7WjN0ejdq545QRPMU4+GLRGhBkgcNDbO/2TuwGUC nY2A== X-Forwarded-Encrypted: i=1; AJvYcCVHDUcPalq1oTj4hm13fqd+R/GMtZqrg4OjEugZrD8tu8ND6ajZKsgca7A/GT2ip25LKLxyxyN+2u6oV3/Fa1WRs4I= X-Gm-Message-State: AOJu0YyhsPjsurvfGQIYOTiz8QQG4ENowOXdeAwJT16txbywSKVDlhJo PHUxyidnbVsti7qfLX6D8BrrORRDyB2uBCqouCIAZjoYMN9AO1eNhNQUqMv7Os0SiLWlVeIfsbi ksadR6Z49knBlpg== X-Google-Smtp-Source: AGHT+IGmCdSsDsX60IrhBcrsWkYfjETKHqOUwZqc/QWEbCWW/bS5bF3ZT3NOSDpSvaF+vXmL7+qspwRE95eAVCA= X-Received: from aliceryhl2.c.googlers.com ([fda3:e722:ac3:cc00:68:949d:c0a8:572]) (user=aliceryhl job=sendgmr) by 2002:a05:690c:6812:b0:615:1471:19bb with SMTP id id18-20020a05690c681200b00615147119bbmr665073ywb.2.1712233933464; Thu, 04 Apr 2024 05:32:13 -0700 (PDT) Date: Thu, 04 Apr 2024 12:31:42 +0000 In-Reply-To: <20240404-alice-mm-v4-0-49a84242cf02@google.com> Mime-Version: 1.0 References: <20240404-alice-mm-v4-0-49a84242cf02@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=15829; i=aliceryhl@google.com; h=from:subject:message-id; bh=DIHPCmsYsAEVmOzNFnwpXPapPHFZB1wBN8+xcv/OdvM=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBmDp2/hsWUpMiZeeco043Qxmtop18YTPBPcVh9U CxK+y2Do5OJAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZg6dvwAKCRAEWL7uWMY5 RifMEACyrHbIuGxt75YdUBSQvrkN8yXNTT7lnKivUKsR0r6DrW6Tl08hjHyhClDbusEsDriRzI+ d324J7f699OcOryWCiUFzitCbxEvZ6pFGTHyFRHGFaniXWzXygA/Jd75BmmmH7+SOa/9jc2+32m Oj3A/TRdA5yJVFNdMxwB7oNqLEJOfXjZICWKnneD4jhAuQxSUmF1LM9IgUTrKvsMAsXURvV04zW IrLuIJTDHXOl+CSAoEC/EolKvtEnXRKoxfXLWeIPYjAOsPsSGgShwxZiKs6HOhQiEZTQ9YAgTzm YVH4p20Gr/0FsrggBPA3Rd+j+Ii2jWz0brK3m09kK/+AdQGFLXNFV6sSSZx650VCzDRpyZA3KEs cfBDFU84W9fdsooddDPPaqBN624FJgo9TXNkpqdDB+m4Tr+gHhddRYZvhbKvsythoLHCq7R9RSD td3ieUcYDmXGEe6/gQ2w1z79VQEOUem0Db25rekEf1MaRqO+wOh/+ADbJQJ5uQWL8L4OCdNjuvW M1JODMrwUHwltFxDvUvrkqSXQdNdHOrxWlD/0sRfKVj5IKuRSRunY4g4eQqe42BEVf1jbdeY5+K j4zmVuRIc/8/lRm9QYi68TIdXE7xYPQUOFoYNb9Aid5Kg8GMXVxFEFyx10CX1Fyxp8hnVrSKjNn mM1hxc6os3+IeGg== X-Mailer: b4 0.13-dev-26615 Message-ID: <20240404-alice-mm-v4-4-49a84242cf02@google.com> Subject: [PATCH v4 4/4] rust: add abstraction for `struct page` 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: 5905240003 X-Rspam-User: X-Stat-Signature: xipg4iz9qqmrne5qt7qng75658jfzpsd X-Rspamd-Server: rspam01 X-HE-Tag: 1712233934-205383 X-HE-Meta: U2FsdGVkX1+11oNTzoxAUtydzGy8Qp4hQUSykmKlMBwmrd0oXYkbbP+SCNEMpatO/86gd+8vHhbLifECSrdB3O1fMeFvI6+v8A59Kweue2lWpM9WbC4tbFMNfm+driNOCy7FE4K5m7QA+8KfFUrMnvdCuf28D2Qj3TUjKRx4X3cmgT8VQP2AerbK9tLu/tRrkGawCtIlTEdKC3k37ps97OXpoB1HFxOmnZUff3GDUSCT1XvGGwGXyf8DzSQEQM59Q4VxCTwmseNYVzHwkaz0s2gxTTsFfU4Ednw2XFjZG4ge/CRqihmh6CfANXaerLpdIweRXflwr6Jp+UL8420RT2XUO8ZcjVEYSRGLVzlcGMyqpLArZqdPR97kG/uA8u24X6a8hhU9rjVpgPbK58Qii85T49+rinECUwlnDN4Oc2mJMQdTJJo8GcgCMD1bF1RwWx2vfB7heWRlWFYCWObNQD4Ai1s+v+J5SvIT2FhnIRUdpkMG6o4gwEdr2xYzsIRWJnsEwJQtfTJ96ZRbcf4lOb8cHyr4EDmH+Dzgfq9PdwbSm1SzXhPNfODriTEurLWqq136TiBghgQiAVkzhRIn/7poOhBJjuphG0kytJDBudXg5BeKnKnNTJHhColXHDoGv9A0jLtzS+RgK2yA9RCSlFb3FJx+V8IexYrErDmW46zSEItY4xgk49ae04eMwpJDTRHVAdP088d5Psg2Mx7+B6+ds+ovoGbGsNtipuZW3tvHUG8x8bdDOgMAkJsbap6AmyJk3xr/D7oq3fnfV2CMEY7cNjA1I47uDVUn+BXN/Gwj7TFN+JN69mDJ+edB0Ak/vnfpOth7Rk2Qj05NtXbqbkz2UnsUXKUjagfUrB8yVl7yqKTNNFJIKChZKq8OMuZ1lCqZofOkh1AeRtJSoyPFh1BPMpxFkRv0RrA8Q3rOtZqI+jz6EXFm50XGuTFpSC+JIDJGy/L3EdORiuAAlTv yLG0wE3S aVFreicC6dTSrhSkam/GZi1Bar791cb3/1UmBnRJcRvsPN0okdJ6sKlPJ0KPbtLmSqEY+palBab2Io1forkfMJRUWTzqlPjZak9AwG+3glmAeG0C4tptPod2ln1SLwdeRer+rButkAp+o4cjXaulcMyOqEz5cwdFoxaUeiksSgU277qIVzIQgbh6b/XCEYv3wPlSYdxmbTHT/bsh/JKNpkOA/hsW2MokuuX63WV4QtswIgpLF6AG28ZV+jguX7eGDv/UkzV0vh9r9HfBQOBaobVflFtZEA6SjOOsyvKvJR1Hjd9GT2DQ1/fJ0y4e/WTijU6C9r6fXQhidgNZ0Gh71/fRA2v7Z3+4vz5+4ONjrGBzf7LcjLqzJgxX6+K5tygJMehlQ353dKL9R+6BZ8JsCdLaFBlOqs6O+R85zgpl1v8x2AN8Ez/1kbGQa5wD+VQSdH6ICz/hw6S4jIrncTdxIoVgyK1FJtkqiA1/UgpPNl1fYxfwE3zfziKvcOlTV7SCgZ5+zA2FkrRtX/hVGVJg9g7htMYLFQjPQzI5WaiwaBJ4Vqki82Y9GDdP5i37bYwendsKjBMnkIBcc4XbD84KiiRVg/ZzvBzSGpVYb7yffInC5goe2OFhj43fJViYe4UrBDQG7yXXpnz96gXrxGVx2TZ/v/+n43yvHxlU+hSv5bJAAt8nzQcvWYYPShU97iJR8AaLsJsrdBb3gcYUST1Xtmpcvs9P7nRk35M4F 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: Adds a new struct called `Page` that wraps a pointer to `struct page`. This struct is assumed to hold ownership over the page, so that Rust code can allocate and manage pages directly. The page type has various methods for reading and writing into the page. These methods will temporarily map the page to allow the operation. All of these methods use a helper that takes an offset and length, performs bounds checks, and returns a pointer to the given offset in the page. This patch only adds support for pages of order zero, as that is all Rust Binder needs. However, it is written to make it easy to add support for higher-order pages in the future. To do that, you would add a const generic parameter to `Page` that specifies the order. Most of the methods do not need to be adjusted, as the logic for dealing with mapping multiple pages at once can be isolated to just the `with_pointer_into_page` method. Finally, the struct can be renamed to `Pages`, and the type alias `Page = Pages<0>` can be introduced. Rust Binder needs to manage pages directly as that is how transactions are delivered: Each process has an mmap'd region for incoming transactions. When an incoming transaction arrives, the Binder driver will choose a region in the mmap, allocate and map the relevant pages manually, and copy the incoming transaction directly into the page. This architecture allows the driver to copy transactions directly from the address space of one process to another, without an intermediate copy to a kernel buffer. This code is based on Wedson's page abstractions from the old rust branch, but it has been modified by Alice by removing the incomplete support for higher-order pages, by introducing the `with_*` helpers to consolidate the bounds checking logic into a single place, and by introducing gfp flags. Co-developed-by: Wedson Almeida Filho Signed-off-by: Wedson Almeida Filho Signed-off-by: Alice Ryhl --- rust/bindings/bindings_helper.h | 2 + rust/helpers.c | 20 ++++ rust/kernel/lib.rs | 1 + rust/kernel/page.rs | 259 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 282 insertions(+) diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h index 65b98831b975..da1e97871419 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -20,5 +20,7 @@ /* `bindgen` gets confused at certain things. */ const size_t RUST_CONST_HELPER_ARCH_SLAB_MINALIGN = ARCH_SLAB_MINALIGN; +const size_t RUST_CONST_HELPER_PAGE_SIZE = PAGE_SIZE; const gfp_t RUST_CONST_HELPER_GFP_KERNEL = GFP_KERNEL; const gfp_t RUST_CONST_HELPER___GFP_ZERO = __GFP_ZERO; +const gfp_t RUST_CONST_HELPER___GFP_HIGHMEM = ___GFP_HIGHMEM; diff --git a/rust/helpers.c b/rust/helpers.c index 312b6fcb49d5..72361003ba91 100644 --- a/rust/helpers.c +++ b/rust/helpers.c @@ -25,6 +25,8 @@ #include #include #include +#include +#include #include #include #include @@ -93,6 +95,24 @@ int rust_helper_signal_pending(struct task_struct *t) } EXPORT_SYMBOL_GPL(rust_helper_signal_pending); +struct page *rust_helper_alloc_pages(gfp_t gfp_mask, unsigned int order) +{ + return alloc_pages(gfp_mask, order); +} +EXPORT_SYMBOL_GPL(rust_helper_alloc_pages); + +void *rust_helper_kmap_local_page(struct page *page) +{ + return kmap_local_page(page); +} +EXPORT_SYMBOL_GPL(rust_helper_kmap_local_page); + +void rust_helper_kunmap_local(const void *addr) +{ + kunmap_local(addr); +} +EXPORT_SYMBOL_GPL(rust_helper_kunmap_local); + refcount_t rust_helper_REFCOUNT_INIT(int n) { return (refcount_t)REFCOUNT_INIT(n); diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index 37f84223b83f..667fc67fa24f 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -39,6 +39,7 @@ pub mod kunit; #[cfg(CONFIG_NET)] pub mod net; +pub mod page; pub mod prelude; pub mod print; mod static_assert; diff --git a/rust/kernel/page.rs b/rust/kernel/page.rs new file mode 100644 index 000000000000..5aba0261242d --- /dev/null +++ b/rust/kernel/page.rs @@ -0,0 +1,259 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Kernel page allocation and management. + +use crate::{bindings, error::code::*, error::Result, uaccess::UserSliceReader}; +use core::{ + alloc::AllocError, + ptr::{self, NonNull}, +}; + +/// A bitwise shift for the page size. +#[allow(clippy::unnecessary_cast)] +pub const PAGE_SHIFT: usize = bindings::PAGE_SHIFT as usize; + +/// The number of bytes in a page. +#[allow(clippy::unnecessary_cast)] +pub const PAGE_SIZE: usize = bindings::PAGE_SIZE as usize; + +/// A bitmask that gives the page containing a given address. +pub const PAGE_MASK: usize = !(PAGE_SIZE-1); + +/// Flags for the "get free page" function that underlies all memory allocations. +pub mod flags { + /// gfp flags. + #[allow(non_camel_case_types)] + pub type gfp_t = bindings::gfp_t; + + /// `GFP_KERNEL` is typical for kernel-internal allocations. The caller requires `ZONE_NORMAL` + /// or a lower zone for direct access but can direct reclaim. + pub const GFP_KERNEL: gfp_t = bindings::GFP_KERNEL; + /// `GFP_ZERO` returns a zeroed page on success. + pub const __GFP_ZERO: gfp_t = bindings::__GFP_ZERO; + /// `GFP_HIGHMEM` indicates that the allocated memory may be located in high memory. + pub const __GFP_HIGHMEM: gfp_t = bindings::__GFP_HIGHMEM; +} + +/// A pointer to a page that owns the page allocation. +/// +/// # Invariants +/// +/// The pointer is valid, and has ownership over the page. +pub struct Page { + page: NonNull, +} + +// SAFETY: Pages have no logic that relies on them staying on a given thread, so +// moving them across threads is safe. +unsafe impl Send for Page {} + +// SAFETY: Pages have no logic that relies on them not being accessed +// concurrently, so accessing them concurrently is safe. +unsafe impl Sync for Page {} + +impl Page { + /// Allocates a new page. + pub fn alloc_page(gfp_flags: flags::gfp_t) -> Result { + // SAFETY: Depending on the value of `gfp_flags`, this call may sleep. + // Other than that, it is always safe to call this method. + let page = unsafe { bindings::alloc_pages(gfp_flags, 0) }; + let page = NonNull::new(page).ok_or(AllocError)?; + // INVARIANT: We just successfully allocated a page, so we now have + // ownership of the newly allocated page. We transfer that ownership to + // the new `Page` object. + Ok(Self { page }) + } + + /// Returns a raw pointer to the page. + pub fn as_ptr(&self) -> *mut bindings::page { + self.page.as_ptr() + } + + /// Runs a piece of code with this page mapped to an address. + /// + /// The page is unmapped when this call returns. + /// + /// # Using the raw pointer + /// + /// It is up to the caller to use the provided raw pointer correctly. The + /// pointer is valid for `PAGE_SIZE` bytes and for the duration in which the + /// closure is called. The pointer might only be mapped on the current + /// thread, and when that is the case, dereferencing it on other threads is + /// UB. Other than that, the usual rules for dereferencing a raw pointer + /// apply: don't cause data races, the memory may be uninitialized, and so + /// on. + /// + /// If multiple threads map the same page at the same time, then they may + /// reference with different addresses. However, even if the addresses are + /// different, the underlying memory is still the same for these purposes + /// (e.g., it's still a data race if they both write to the same underlying + /// byte at the same time). + fn with_page_mapped(&self, f: impl FnOnce(*mut u8) -> T) -> T { + // SAFETY: `page` is valid due to the type invariants on `Page`. + let mapped_addr = unsafe { bindings::kmap_local_page(self.as_ptr()) }; + + let res = f(mapped_addr.cast()); + + // This unmaps the page mapped above. + // + // SAFETY: Since this API takes the user code as a closure, it can only + // be used in a manner where the pages are unmapped in reverse order. + // This is as required by `kunmap_local`. + // + // In other words, if this call to `kunmap_local` happens when a + // different page should be unmapped first, then there must necessarily + // be a call to `kmap_local_page` other than the call just above in + // `with_page_mapped` that made that possible. In this case, it is the + // unsafe block that wraps that other call that is incorrect. + unsafe { bindings::kunmap_local(mapped_addr) }; + + res + } + + /// Runs a piece of code with a raw pointer to a slice of this page, with + /// bounds checking. + /// + /// If `f` is called, then it will be called with a pointer that points at + /// `off` bytes into the page, and the pointer will be valid for at least + /// `len` bytes. The pointer is only valid on this task, as this method uses + /// a local mapping. + /// + /// If `off` and `len` refers to a region outside of this page, then this + /// method returns `EINVAL` and does not call `f`. + /// + /// # Using the raw pointer + /// + /// It is up to the caller to use the provided raw pointer correctly. The + /// pointer is valid for `len` bytes and for the duration in which the + /// closure is called. The pointer might only be mapped on the current + /// thread, and when that is the case, dereferencing it on other threads is + /// UB. Other than that, the usual rules for dereferencing a raw pointer + /// apply: don't cause data races, the memory may be uninitialized, and so + /// on. + /// + /// If multiple threads map the same page at the same time, then they may + /// reference with different addresses. However, even if the addresses are + /// different, the underlying memory is still the same for these purposes + /// (e.g., it's still a data race if they both write to the same underlying + /// byte at the same time). + fn with_pointer_into_page( + &self, + off: usize, + len: usize, + f: impl FnOnce(*mut u8) -> Result, + ) -> Result { + let bounds_ok = off <= PAGE_SIZE && len <= PAGE_SIZE && (off + len) <= PAGE_SIZE; + + if bounds_ok { + self.with_page_mapped(move |page_addr| { + // SAFETY: The `off` integer is at most `PAGE_SIZE`, so this + // pointer offset will result in a pointer that is in bounds or + // one off the end of the page. + f(unsafe { page_addr.add(off) }) + }) + } else { + Err(EINVAL) + } + } + + /// 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` bytes. + /// * Callers must ensure that this call does not race with a write to the + /// same page that overlaps with this read. + pub unsafe fn read_raw(&self, dst: *mut u8, offset: usize, len: usize) -> Result { + self.with_pointer_into_page(offset, len, move |src| { + // SAFETY: If `with_pointer_into_page` calls into this closure, then + // it has performed a bounds check and guarantees that `src` is + // valid for `len` bytes. + // + // There caller guarantees that there is no data race. + unsafe { ptr::copy_nonoverlapping(src, dst, len) }; + Ok(()) + }) + } + + /// Maps the page and writes into it from 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 `src` is valid for reading `len` bytes. + /// * Callers must ensure that this call does not race with a read or write + /// to the same page that overlaps with this write. + pub unsafe fn write_raw(&self, src: *const u8, offset: usize, len: usize) -> Result { + self.with_pointer_into_page(offset, len, move |dst| { + // SAFETY: If `with_pointer_into_page` calls into this closure, then + // it has performed a bounds check and guarantees that `dst` is + // valid for `len` bytes. + // + // There caller guarantees that there is no data race. + unsafe { ptr::copy_nonoverlapping(src, dst, len) }; + Ok(()) + }) + } + + /// Maps the page and zeroes the given slice. + /// + /// 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 this call does not race with a read or write to + /// the same page that overlaps with this write. + pub unsafe fn fill_zero(&self, offset: usize, len: usize) -> Result { + self.with_pointer_into_page(offset, len, move |dst| { + // SAFETY: If `with_pointer_into_page` calls into this closure, then + // it has performed a bounds check and guarantees that `dst` is + // valid for `len` bytes. + // + // There caller guarantees that there is no data race. + unsafe { ptr::write_bytes(dst, 0u8, len) }; + Ok(()) + }) + } + + /// Copies data from userspace into this page. + /// + /// This method will perform bounds checks on the page offset. If `offset .. + /// offset+len` goes outside ot the page, then this call returns `EINVAL`. + /// + /// Like the other `UserSliceReader` methods, data races are allowed on the + /// userspace address. However, they are not allowed on the page you are + /// copying into. + /// + /// # Safety + /// + /// Callers must ensure that this call does not race with a read or write to + /// the same page that overlaps with this write. + pub unsafe fn copy_from_user_slice( + &self, + reader: &mut UserSliceReader, + offset: usize, + len: usize, + ) -> Result { + self.with_pointer_into_page(offset, len, move |dst| { + // SAFETY: If `with_pointer_into_page` calls into this closure, then + // it has performed a bounds check and guarantees that `dst` is + // valid for `len` bytes. Furthermore, we have exclusive access to + // the slice since the caller guarantees that there are no races. + reader.read_raw(unsafe { core::slice::from_raw_parts_mut(dst.cast(), len) }) + }) + } +} + +impl Drop for Page { + fn drop(&mut self) { + // SAFETY: By the type invariants, we have ownership of the page and can + // free it. + unsafe { bindings::__free_pages(self.page.as_ptr(), 0) }; + } +}