From patchwork Thu Feb 8 15:47:54 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13549984 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 17F4AC4828F for ; Thu, 8 Feb 2024 15:48:55 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 9B4A86B0087; Thu, 8 Feb 2024 10:48:54 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 967126B0088; Thu, 8 Feb 2024 10:48:54 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 7DEB76B0089; Thu, 8 Feb 2024 10:48:54 -0500 (EST) 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 6899C6B0087 for ; Thu, 8 Feb 2024 10:48:54 -0500 (EST) Received: from smtpin19.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 3C68EA25FE for ; Thu, 8 Feb 2024 15:48:54 +0000 (UTC) X-FDA: 81769069788.19.3350185 Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) by imf08.hostedemail.com (Postfix) with ESMTP id 5C54E160006 for ; Thu, 8 Feb 2024 15:48:52 +0000 (UTC) Authentication-Results: imf08.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=Bvya9TdZ; spf=pass (imf08.hostedemail.com: domain of 34_fEZQkKCBw2DA46JQ9D8GG8D6.4GEDAFMP-EECN24C.GJ8@flex--aliceryhl.bounces.google.com designates 209.85.219.202 as permitted sender) smtp.mailfrom=34_fEZQkKCBw2DA46JQ9D8GG8D6.4GEDAFMP-EECN24C.GJ8@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=1707407332; 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=GkurjLr2KJ06Z3QEBJTajcXp1Fe9o6FdUY3dEd+eNLc=; b=qDbdLjSgG8OQXHIyw9mgXJMuuG06Y/MAxwNZyIESvMzwe6aD228l2KEzImMclKjgK47BU7 sD0SPSbT5XE64JjSkyD2drEu6EPrwJ17jZRltLtlmVDQgXX/xZYmIwd12TOmveeMwkL+hX /KNomZ7myGvcoP5EOdavCnzCTtdkouo= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1707407332; a=rsa-sha256; cv=none; b=TVubYKzgc7nkOD3dR6dpq991dq7VU+gbZc/R/HmCX9R8KBMvURWQFxpwAy6DPgxqfNPLDv Argxoy1JxY+6oziHQpyL6dsHyjZmMt5haDAFgAbNiBr/vGDY2iW98SW2u/G2SB/BJ/7TOm YmyIq/bsTTCJHrwQxpjk0N1kF2ueRvU= ARC-Authentication-Results: i=1; imf08.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=Bvya9TdZ; spf=pass (imf08.hostedemail.com: domain of 34_fEZQkKCBw2DA46JQ9D8GG8D6.4GEDAFMP-EECN24C.GJ8@flex--aliceryhl.bounces.google.com designates 209.85.219.202 as permitted sender) smtp.mailfrom=34_fEZQkKCBw2DA46JQ9D8GG8D6.4GEDAFMP-EECN24C.GJ8@flex--aliceryhl.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-dc6b5d1899eso1327579276.0 for ; Thu, 08 Feb 2024 07:48:52 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1707407331; x=1708012131; 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=GkurjLr2KJ06Z3QEBJTajcXp1Fe9o6FdUY3dEd+eNLc=; b=Bvya9TdZCxSC3rYQQS9KisnzGOuersLXOvcGVpGK5l/PwSDbNi5Je2YYp4xy/KTZen N/8BmqMJuyJPdC4kWFQo0y7Jj16MGJhzubAZKO0YM8EgdnBaBW7xuV6Rdva2RscqHZ+v t2fTLuMVz4TDrv+3rBDQyCxf8xDbtdPQvR8h/w6NNkUeZDROO9ZQYICxZQudsvsZv0W9 W0WOt7UJj+whrXe/5d/es/pitzTV/wwd/hffFcOb9JyAewjMebtNsnfUWqLSaD3+VnNq RQfDivffVGbKyR6Qc6wZ7aqWcUsAewXJDH3yFkDaYnHYXK9iGZniCDUXPWN/EdHXLWwy NbUQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707407331; x=1708012131; 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=GkurjLr2KJ06Z3QEBJTajcXp1Fe9o6FdUY3dEd+eNLc=; b=Pt7E36152MUvPSHLLy80fl7ZylDh1ANwdgq8pjhqmWgIDQdKIpMWDNBV9QZlD/cJxQ Je8NAThcDNF/cl+EiUztuUp9hqiMzRe3tn+IhYdrFChqsfFY8LQupz+6h6WDMbX7DMhl TKuFk5UZE8dGoJ1810uHX9sebef5t1b6Q9SdcBd2CJ9LH9+DJuMcgE/sGigaL6tRJJZ9 8BLhXu8bQFUW9cIcyhXKTQurXqgkgchrnI29h32qasIl3qBScE+yIAEeuTCrKSME9kZ9 +HzW0OdoHv46EIyAzvZ+vc158DGYY/y1ekyD3vfwjf3GqUpu1kvEmWADxgl1v57LBHVo 6rFw== X-Forwarded-Encrypted: i=1; AJvYcCWWY2zohkls/k1qB0KaE8DBu9fl+p+YeTQP0nkoFCC+nvPJlMgwMWWIPR+8S2ELfMcXLLfr2G1frnXt5LiRVVDyAEg= X-Gm-Message-State: AOJu0YzYSHAp7Z2YOgEYpeqONKoVzN98DNwXlyC1RgItMsGEvH2CWs1z E6KUJxelRdIRjV7A02zr0byByUBfpdkyVnmDKBD+Xuz4vS4d52IPQQNogto3shfCXMPU92o/A9V y1TM9Re6zy2zLIQ== X-Google-Smtp-Source: AGHT+IHZ8Dbrlx4mYSSqSheMjR9uVubqsUmkFF4PLNwGiatZwaa03r5iM1Rw5TJUkiKh9weUpG7CJqzo/gNibUU= X-Received: from aliceryhl2.c.googlers.com ([fda3:e722:ac3:cc00:68:949d:c0a8:572]) (user=aliceryhl job=sendgmr) by 2002:a05:6902:100b:b0:dc6:e884:2342 with SMTP id w11-20020a056902100b00b00dc6e8842342mr764942ybt.5.1707407331450; Thu, 08 Feb 2024 07:48:51 -0800 (PST) Date: Thu, 08 Feb 2024 15:47:54 +0000 In-Reply-To: <20240208-alice-mm-v2-0-d821250204a6@google.com> Mime-Version: 1.0 References: <20240208-alice-mm-v2-0-d821250204a6@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=12755; i=aliceryhl@google.com; h=from:subject:message-id; bh=5kbsE/b/eSnVbSFqPFnEYkacZIQs8b+yemi8lEykeZw=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBlxPfU67tCAf96rUhr77wodzJbxjoBZvA+pKp54 TdgXCe6UwyJAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZcT31AAKCRAEWL7uWMY5 RgZ3EACMa2s3PKNHIdyO26oX3t0dPYuDrEmv0G8WCEpnJsXaaYMUb7IEmcf8cM74d1xUs/tQWRI GDHB+GiwnDcEIkB+itkR2/WdykfPSUwtijCjJ7IVuaeYKTXe5y4S4bzUslEOUwxJGScFo+CpHBM XcLgq9ilImTzGR29npE+iqbTwErklrUA9JOn7yvI2l7Qq8zJ5wZ+8NGwHKYLfegy5lIvsajIqnL J1claGaD8NF+HlnSg+/Vw6rIndTyvNaOnI5eVGgPgOfpzi3tmer0/gopsjWSpLYksDsrwM5DgOd KZFb6ob+vBpSlbr0Wg5NEl9s+TLBj8mJlgAt5wFUg08GbKIy+oFsvAZwNGSuglAHu7FEN22u2uv ZWsSLCee6/Zvh8jHTh6KZHJLsCajnYSnc5BRW/iSkuH7dp5hF8ooBca9PoZVFW4Lnvy9DX++95h IH4z1nWm/dIqVGhZf3semETumlANLlHPnp/Eos2URF0jnhtI6ct4VH3kCZ82FeH9Ia320wfSKd5 kNxx0BMOURevsseZTCpziAeiiSYh19gQFlT/JvkDsVR/mTzIEegLfpMdYvfipw+DuCseg86j3bM cBhoKYkgeqatoOGFECGxHZcXOKZDrefX5jylDTCJd844FstI3U8aCbLGToKO03HpbkiuSCTMROc qU/XnZ0uYKaEJng== X-Mailer: b4 0.13-dev-26615 Message-ID: <20240208-alice-mm-v2-4-d821250204a6@google.com> Subject: [PATCH v2 4/4] rust: add abstraction for `struct page` From: Alice Ryhl To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Benno Lossin , Andreas Hindborg , Kees Cook , Al Viro , Andrew Morton Cc: Greg Kroah-Hartman , " =?utf-8?q?Arve_Hj?= =?utf-8?q?=C3=B8nnev=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-Stat-Signature: 8n1zeeoymaengbs4ofc8udkjfhsqnjgg X-Rspamd-Server: rspam10 X-Rspamd-Queue-Id: 5C54E160006 X-Rspam-User: X-HE-Tag: 1707407332-789036 X-HE-Meta: U2FsdGVkX19rgk7+EAgEyf3zqT4xjz9maMAvjpNquIa2VsyZrf9nTulzh8mE6foDMoKPM/eA8WzQ+wzYxwUFLT8YOsx4PRAeCDClMCssGKgbkaK/ztrgdqkRfjTin2iCt3hqYLy+Ca3VSIgxLvwzeLWTwjJhXcCxxTmUUD31YrxnvHMhjUTLstshrCWI4TFbQS7ueQs8DXqf8SNZcX6sDXnW/npTGiVuG5Fm5bIcmn1KWqjPe5OsoBo/hGp+HLX7b08/E8J09HLtISwpVu3JFNwLhePsDcNufgeLkk8z29HOeV8nvv++H8trya6voc6WfqYSc0CqRWc8R0ooELBGUHgNKTTIAuNw5KBwmig1ykFVdoIdDQqNXNuxuqvc0uzQbEAlUspmgyJep2+yKP53nsosuBcjUZPgI8ol2lEPyTKvFqtxv71t8Ga53Q5MgOAyA1c/VvNMgXDRtkV4aR58+kUQigsrLLrhDW0lzXZ6i9njdFvMFujodvpo3ExVeMnYynphTvUnur1WdPpCpu5DOWHY6mzlwVxm9xEfTy2uY/wJrqI7CHse7bWe3reoGVpDsZLwKZV1xChfnhHV7kOsidtT97QrXeC/YLrm9c4OIggZt8PpJl00gt1O8fqjzkKG+ePjVcZRVHU9T/SQ2npEJEh3ejj+LVU9fM7FxhBSkO5mvuodr/SZ56A8Ot6Sx990MJvVKYHRobOorRQd34eytdKP5v1Uch9zjb45shXL5Esg/9Cpl0OOZKo42YqOgQGiug3LdagtAMzRT1GKwpQMuNyAdVlq5tstwFQqCr3fOGcwGgC/kc5R9PYabekFNHcWmIeIvKYXO7kN00IDqZD/G2P/U6HnrxqwCpua/zGaptg3xSG7ipbVXyegElaEVBdLLM9y/xNap63s0YXCgLMDpUpRYHTXS3/ChrzVEB4NKdeyoxoRAcDvkJV6jdYct6k+rumAlh9PNagghmVc5xq 7Kx5ERlz QWNNGd0XQX2RRUUy9bB2xadU2hM80bp4UFsgbkQdQOdcJi1OZMzk6CNCrRtvZ7zoN5/oqieQRTiO/VPwG5xdN5UplF9hrd+TXw7UTszLVqK0i7Qit8aG7aqgloYVmheFjgYmu+GzIqdFi8+dfe1XSYsxK0PKvNwdbx9wkvQ2BmOmfB/NHw3nRevbNsarWUNu872mqi0rZiihxv4OmD2/+GaUx3Z5+ScTIgfkUIcDIvJzHovWkbE/8xV/PPvQQ7j8EaOM8QjGyg/zFl463ghFqhBm9X4nM5lt22Z/l81+ma0S3D9Wh6a4NyyBT4/hbTnan2t9tPkQmC39tzO/h7nthC5uVURLBdtr5DIsML2Gye2CUT83ycMIIYXD1H78xh0x4sfhOVNsdiBxhszuRC7m79Rmn3Zt2N/sdpZZ4kMSvvr6b4H8czwAVhbnkKHDAnWEqFBZShu3+h80HpLxZcf9+fcocFfm9GcrCJ+5dx/ofGrBLccXRNzElhD/eMWCer0WqIy35Krp3VwiYzyOF6nnTwPmCdcZ836T6SaS/2m4ioc65B3B6Fd20dYq0hT0ImdBCT9rgffrmWLoIGUnOfNFkSEQj6UroR83s/0aHTQuq6stGREAgt6H0S77JiLu6LcdZXUdGoJRAG6zmplf2uCsbtvbz/VVa2u+th/JAbAn2PT8aNMZ72pxxJMKXsPcic5BAzlOA3MQ3f8as/3XxNlw5mP/4NUEYDwTOBpDJ 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, and by introducing the `with_*` helpers to consolidate the bounds checking logic into a single place. Co-developed-by: Wedson Almeida Filho Signed-off-by: Wedson Almeida Filho Signed-off-by: Alice Ryhl --- rust/bindings/bindings_helper.h | 1 + rust/helpers.c | 20 ++++ rust/kernel/lib.rs | 1 + rust/kernel/page.rs | 209 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 231 insertions(+) diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h index 936651110c39..b5b7fa7bd456 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -22,3 +22,4 @@ const size_t RUST_CONST_HELPER_ARCH_SLAB_MINALIGN = ARCH_SLAB_MINALIGN; 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..298d2ee16e61 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 5a03aafcbb69..59ee6dd6f7c6 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -40,6 +40,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..ac253744f94b --- /dev/null +++ b/rust/kernel/page.rs @@ -0,0 +1,209 @@ +// 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. +pub const PAGE_SHIFT: usize = bindings::PAGE_SHIFT as usize; +/// The number of bytes in a page. +pub const PAGE_SIZE: usize = 1 << PAGE_SHIFT; + +/// A pointer to a page that owns the page allocation. +/// +/// # Invariants +/// +/// The pointer points at a page, and has ownership over the page. +pub struct Page { + page: NonNull, +} + +// SAFETY: It is safe to transfer page allocations between threads. +unsafe impl Send for Page {} + +// SAFETY: As long as the safety requirements for `&self` methods on this type +// are followed, there is no problem with calling them in parallel. +unsafe impl Sync for Page {} + +impl Page { + /// Allocates a new page. + pub fn new() -> Result { + // SAFETY: These are the correct arguments to allocate a single page. + let page = unsafe { + bindings::alloc_pages( + bindings::GFP_KERNEL | bindings::__GFP_ZERO | bindings::__GFP_HIGHMEM, + 0, + ) + }; + + let page = NonNull::new(page).ok_or(AllocError)?; + // INVARIANT: We checked that the allocation succeeded. + 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. + /// + /// It is up to the caller to use the provided raw pointer correctly. + pub 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()); + + // SAFETY: This unmaps the page mapped above. + // + // 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`. + /// + /// It is up to the caller to use the provided raw pointer correctly. + pub 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(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(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`. + /// + /// # 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. + // + // There caller guarantees that there is no data race when writing + // to `dst`. + unsafe { reader.read_raw(dst, 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) }; + } +}