From patchwork Tue May 28 14:58:05 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13676940 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 A42DDC25B78 for ; Tue, 28 May 2024 14:58:31 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id DB86E6B00A2; Tue, 28 May 2024 10:58:29 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id D6A696B00A3; Tue, 28 May 2024 10:58:29 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id B94E56B00A4; Tue, 28 May 2024 10:58:29 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 98D526B00A2 for ; Tue, 28 May 2024 10:58:29 -0400 (EDT) Received: from smtpin16.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id 1E1E840601 for ; Tue, 28 May 2024 14:58:29 +0000 (UTC) X-FDA: 82168110738.16.E95E770 Received: from mail-lj1-f202.google.com (mail-lj1-f202.google.com [209.85.208.202]) by imf12.hostedemail.com (Postfix) with ESMTP id E46BB40023 for ; Tue, 28 May 2024 14:58:26 +0000 (UTC) Authentication-Results: imf12.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=uCjBrdVO; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf12.hostedemail.com: domain of 3EfFVZgkKCIQitqkmz6ptowwotm.kwutqv25-uus3iks.wzo@flex--aliceryhl.bounces.google.com designates 209.85.208.202 as permitted sender) smtp.mailfrom=3EfFVZgkKCIQitqkmz6ptowwotm.kwutqv25-uus3iks.wzo@flex--aliceryhl.bounces.google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1716908307; 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=eO05l42JzpfeTNPK2MRvp86M9FhFhNRtSy4S1tjVhus=; b=qhVsdEZA8e0IApbMKzBiY8W6ch3XNOghRtSNJAjXAFNr4ICx9HADkyWDL1MFCrZAeeem5E K6x8KSaxkU4AmZpAItulsgHcIDy9T44mie9kD2pbuRsQ1GjS4JDTj6psCwEQknIfUVHFnI aao9lDbNSYgWxAq0i2W5RUsdCy+wyys= ARC-Authentication-Results: i=1; imf12.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=uCjBrdVO; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf12.hostedemail.com: domain of 3EfFVZgkKCIQitqkmz6ptowwotm.kwutqv25-uus3iks.wzo@flex--aliceryhl.bounces.google.com designates 209.85.208.202 as permitted sender) smtp.mailfrom=3EfFVZgkKCIQitqkmz6ptowwotm.kwutqv25-uus3iks.wzo@flex--aliceryhl.bounces.google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1716908307; a=rsa-sha256; cv=none; b=qj4Bdiz0MCc4wzof7/5lplhqWz2Tk214jeS35NWPNX7dBix/l07717tUJI/XrjEPMaUOSJ HnAmq9W26xCeL6zG9O8FQyiFQ3ta5SD4rbA/liVs5lz38yrpRxOZJZ5upWvXiF0EvGHpEs oGBTr4arDmtk4pZnwBZ0DkLW+CJXstU= Received: by mail-lj1-f202.google.com with SMTP id 38308e7fff4ca-2e95a1e65c2so8975281fa.0 for ; Tue, 28 May 2024 07:58:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1716908305; x=1717513105; 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=eO05l42JzpfeTNPK2MRvp86M9FhFhNRtSy4S1tjVhus=; b=uCjBrdVO6HsQUsH5JMqUya3oWUIaP32ltr2sMX3Pwas7wKzcKt1fpXqPScpdBSleOy p7AnWe5CSYeW9BlYbewHwBOt18ANdN7/1NZ0HyZgtr6xd+jjuiRF7MYbivQ6c5DtljId RjpRB6PXq8rdAz5qiu864RjCHyLfhqdqAM9oIgJd605V8/R5uZ6yvlC3DFDWMC+weFge RJ6ph4xkcekHL2Ub/mRLOHAVm+xd2GhugRKH7x13suIbDWKfkH7eGImOMTOLM1q6XWdP /hTpp/GTPjJMfgleJYaILf8atYpWF1GP3MFdpk7R6v32UTyvOUehGstF5EtjXzxTpAlc WMLQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1716908305; x=1717513105; 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=eO05l42JzpfeTNPK2MRvp86M9FhFhNRtSy4S1tjVhus=; b=QP4P3N6nXI6sjwWm/SY/SaPV/OpLqxuWVzWlrJ+gtw4EhlTEN7Ymre47JLvEQh65nP eawNF8yXRgnLFjtP11AdU04dkILha+PHfeB3GObeiqm9zzhFTgEUpCIakAPtc1oGBflt bwBwmS2BE+UaP/SOD/LQPEiECmmHf6BWnpOhihNe4QsafR1DLv+v/1oGqCnEr5rpXW5h AcyXrHK77s0MjtKAZkwmZ4oPasWgByiquPvt9RjjO9NJITSmHdm5Q5sE4oihQgPSdQnU s9YjtNZl98hx/G2gqPSxxEJONXEJl2HXDQ5VSNpAzEkpdcdECE6968w90tA3/i9FedZg JUKg== X-Forwarded-Encrypted: i=1; AJvYcCW/HsecrevH+kGJGtRznPM6BhHAWxHX4Eugphzpb34ZcIaeyYoH6X6IFt5nL98pzCIfwSrd6+hjCvMscInLkK82qO0= X-Gm-Message-State: AOJu0YzO205NgSpiF8ucShB6jubuHlAYnXNJ/XyHkMCrvbJWSyzZxVs3 DrArr5sdFINl+J87hwheWyrEbGa2pXSFyOyZTxECe/k4QxMlgUfbp7exBws4FoUorrTFHktZR1K egYUnePmn3lxaSA== X-Google-Smtp-Source: AGHT+IEOF4n7i+XUKYEBH94ipp8W/G8bUc6RNmidal0r91mtpuFIe9xOXChYEoPu4AGoMAK43jNu8IHHgNDq/Yo= X-Received: from aliceryhl2.c.googlers.com ([fda3:e722:ac3:cc00:68:949d:c0a8:572]) (user=aliceryhl job=sendgmr) by 2002:a05:6512:32d3:b0:51d:5f9c:50ad with SMTP id 2adb3069b0e04-529666c4680mr10952e87.12.1716908305169; Tue, 28 May 2024 07:58:25 -0700 (PDT) Date: Tue, 28 May 2024 14:58:05 +0000 In-Reply-To: <20240528-alice-mm-v7-0-78222c31b8f4@google.com> Mime-Version: 1.0 References: <20240528-alice-mm-v7-0-78222c31b8f4@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=16077; i=aliceryhl@google.com; h=from:subject:message-id; bh=/HE8lkngIqgSFXOtkqfoTmQKkoPIxutv/DByz3hii1k=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBmVfECAVuTTj15038Ew2DTzS3KESwLDvumYApMa eZb1p+NiP+JAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZlXxAgAKCRAEWL7uWMY5 Rs9lD/wLFlIa+NMQSL+XMbCYpTDJQVbp+7DZpIvygiwW1JH34lbNywTpBNp3IjSEx7IgKIZUwoF kMBSbh+5TLnO+MIt7RBsY7Yn6V3Lvkhchd8wVGOtzIvmj1kpcvvqVCqvttpFMSR1QAeDnLfZjX/ uo07YYKK7D+J6grc/ZIv12/HP4CtFBTE0dPyW2h0FgbrVItek7+rZ8f7bB8HpKaF6+NEM+QP9JM qZjIl6j0deYWCQWDWo/wFsab9voyLxhzZ/E9YdE1tKjzw0/GSoaU/PmJ5a/eI8I1eCMmUMMCPFO CBTheF4vo8iwkb5e1YeCot0wTD+nGkmNaGx69RensXoGwEjKsfHa1lt3717UMZ44CWyeAWO5y52 8BWzcbqDjf93IDGHHUUVYNVzge4NJ1X2nPjtNwNniUow8yX6DmL3ZS9m46Pv+GWM9gzbZySJ82n umQAWuDZnhs0gmNxNfjb3v5Hu7KdbtbhBfBMFmMPtFnfhMLCcDptTiwbOLCWQ4E4km7PfVvvcB9 VDq5ao+YdwiAcPS0LZe7Pw56pHdFynJWMwXQ4/6xfy2JwbbKY38O21FOAQh52cVxRfgRd1woFBT pYGjdKWyrYxNnCZe1Gec4b2THgA6zK3Qd7kfvLGNaxMQxusI2VYvkn9dSmKF1Oa+fw+FAZ7mzJ0 Wqjz3DW/CXKlOJw== X-Mailer: b4 0.13-dev-26615 Message-ID: <20240528-alice-mm-v7-4-78222c31b8f4@google.com> Subject: [PATCH v7 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 , Trevor Gross , linux-mm@kvack.org, linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, Alice Ryhl , Christian Brauner X-Rspamd-Queue-Id: E46BB40023 X-Stat-Signature: w5bw7sn43hc59n514hj661yqhm45pt84 X-Rspam-User: X-Rspamd-Server: rspam11 X-HE-Tag: 1716908306-317734 X-HE-Meta: U2FsdGVkX1+fQXxWfa+5fTrmeb/dXpSEDruoYSpu0QjsvkS1a1w/RwBUILG/CkRRNFZEE5nAUYE2v/tGwsdYfscwqIz+5tu/WS69JGinMyBtlSqu1kvLGg+K1jMn/mFqcep4xMqqH0uW5YwgW6CCc6KbQtxJbGM3oIUPskgXMrf0I62ouwrgKyfhZSCgOQnfO0PBn+9gtHL3TEOT1c4iE84ORyz1YwCOM9IsoLSj4QGIb2PATXYVo58e/74Ifv5HNF7pRRTOR9+LnIRh76G+SOdqhJQN7Lo0w9JlAXxpzALj6EgmRUNq/FeCOQblus4b0wAu6iFlrwwZt6xgwIlMsIzwBaYHfGlvXqe5I5L6l9IWkJ8j/g+b5MK1D/QqdBbV5Zm4Of3KOJGyiBgCCvZIiklUm+756jGTCn3TCmEFv9k+kiOLtKMz9h8y00waNXaYloO9rgOzAUZ9PIC0gkhKFP8A0eTVGDosRqw/btPaz2SD2G7yW4Hibc7jyVNxAXHnan2rCDDMLuOb0HxETndvQk0v8Vyo6vmWZhvJLiTFToFXB4GMR3hNm63f2MUFCRipIAyQiVheNDSDTBLLRXMswBpQGDWARSklP8UUQKXMCmgyLv1kEe25wFSx2W/QqlWGlUSY4efCz0a7NoIDdYWTERBtgoJyZXpYLES6N58aUS+aiQUagyuPz2Kv+nwaEZszGpVQ9js7rI33Rodg5hQY0hUipLAqZubtkBSjqRjNPSXdDpSPXCTeKVcNKQdFFeKtc2cxEh1h8Vga2Lxx0Q1t4/jiKTGJwNbdc8V4O0myAv+7m0y6bweFmbicXYUbCrpfJRXOqJOuOlJ14Iw12/009MkPBZJMoDqvnSoG2Ti4dkl3wvaYyt7Knc83BCr6G2zmaULFF2vBkZcQ5ERW45wmPcsC56CRrc7bI6LgfLXP3aAOXxLA8R3wU2471cadqDkxdpWh7lYthuliUVIsDEH X2wkfEnA f9jKUhLu739+Orh/J0FFoihvYi3ZG9C6HzsSAEKS9OUHTC6gCpWSuuv+BY/yiQO9hvMPcocAPX6iqjS5PW3zQJaMhr9QpB0xOwePRHm2+maFsVFp+LIS/BAN+tcFtea66U/SqcK1ieDQBaSWGG3I316VhklSnX7t510Tyz1X7x34XWNsqYiohVKp+WFGSEVasvm+k+LhJj6j3NYM26hC1uyu81rsus0MgyEFzg02uoMlfLlK6OVHKpRJf1bqPH53VNy7dVJc8Ly4+235E/OfM8LERX+u9vTr0Eza8gVeZgOMW3cTZyIihni+8cBrseeWvnCum/FeJvhoQdYp/yuuatgxJ8RW5/RIUtSfjHPsMZP6QZmEHqHVeeBrOgjuD3pYBLiOCciM23I9Yu1oNVIB/96nxlPBUCZAcSBBKqvL+ip/G7rfLg1g0QK0AFqVuvsulL2ciEpQmkXmfQfT9ys7TQPywv9YSDGc8qGz2E1XwWJkb3QcPTAMjq3eZY8vOjuO73pJKENkbcVdzdXusRav2369OhkGkdXFhlMarq3DsOab5/igntble96dC6/8T8K9HQ8gGV0Ot5oU4unwI8y1rKpaRCQothh3tJfXweUmUgdYLajA8vWiqYCt9IDBR1YaSrAzyubwOJEMoX44b4zYvj5ULoq4iYK0UHsMW 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. 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 various other changes. Co-developed-by: Wedson Almeida Filho Signed-off-by: Wedson Almeida Filho Reviewed-by: Andreas Hindborg Reviewed-by: Trevor Gross Reviewed-by: Benno Lossin Reviewed-by: Boqun Feng Signed-off-by: Alice Ryhl --- rust/bindings/bindings_helper.h | 1 + rust/helpers.c | 20 ++++ rust/kernel/alloc.rs | 7 ++ rust/kernel/lib.rs | 1 + rust/kernel/page.rs | 250 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 279 insertions(+) diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h index ddb5644d4fd9..0862261cfbed 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -20,6 +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_ATOMIC = GFP_ATOMIC; const gfp_t RUST_CONST_HELPER_GFP_KERNEL = GFP_KERNEL; const gfp_t RUST_CONST_HELPER_GFP_KERNEL_ACCOUNT = GFP_KERNEL_ACCOUNT; diff --git a/rust/helpers.c b/rust/helpers.c index d6abe4bd45d9..305f0577fae9 100644 --- a/rust/helpers.c +++ b/rust/helpers.c @@ -25,6 +25,8 @@ #include #include #include +#include +#include #include #include #include @@ -94,6 +96,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/alloc.rs b/rust/kernel/alloc.rs index 531b5e471cb1..72f475e44144 100644 --- a/rust/kernel/alloc.rs +++ b/rust/kernel/alloc.rs @@ -20,6 +20,13 @@ #[derive(Clone, Copy)] pub struct Flags(u32); +impl Flags { + /// Get the raw representation of this flag. + pub(crate) fn as_raw(self) -> u32 { + self.0 + } +} + impl core::ops::BitOr for Flags { type Output = Self; fn bitor(self, rhs: Self) -> Self::Output { diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index 767026db068e..5d310e79485f 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -35,6 +35,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..121d20066645 --- /dev/null +++ b/rust/kernel/page.rs @@ -0,0 +1,250 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Kernel page allocation and management. + +use crate::{ + alloc::{AllocError, Flags}, + bindings, + error::code::*, + error::Result, + uaccess::UserSliceReader, +}; +use core::ptr::{self, NonNull}; + +/// A bitwise shift for the page size. +pub const PAGE_SHIFT: usize = bindings::PAGE_SHIFT as usize; + +/// The number of bytes in a page. +pub const PAGE_SIZE: usize = bindings::PAGE_SIZE; + +/// A bitmask that gives the page containing a given address. +pub const PAGE_MASK: usize = !(PAGE_SIZE - 1); + +/// 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. + /// + /// # Examples + /// + /// Allocate memory for a page. + /// + /// ``` + /// use kernel::page::Page; + /// + /// # fn dox() -> Result<(), kernel::alloc::AllocError> { + /// let page = Page::alloc_page(GFP_KERNEL)?; + /// # Ok(()) } + /// ``` + /// + /// Allocate memory for a page and zero its contents. + /// + /// ``` + /// use kernel::page::Page; + /// + /// # fn dox() -> Result<(), kernel::alloc::AllocError> { + /// let page = Page::alloc_page(GFP_KERNEL | __GFP_ZERO)?; + /// # Ok(()) } + /// ``` + pub fn alloc_page(flags: Flags) -> 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(flags.as_raw(), 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_raw(&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_raw( + &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) }; + } +}