From patchwork Tue Oct 1 14:59:54 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Danilo Krummrich X-Patchwork-Id: 13818238 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 DE344CEACDC for ; Tue, 1 Oct 2024 15:02:06 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 6F55F680016; Tue, 1 Oct 2024 11:02:06 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 6A5EB280068; Tue, 1 Oct 2024 11:02:06 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 54621680016; Tue, 1 Oct 2024 11:02:06 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 2443A280068 for ; Tue, 1 Oct 2024 11:02:06 -0400 (EDT) Received: from smtpin21.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id D5BDBACC2D for ; Tue, 1 Oct 2024 15:02:04 +0000 (UTC) X-FDA: 82625348568.21.B1649CC Received: from nyc.source.kernel.org (nyc.source.kernel.org [147.75.193.91]) by imf14.hostedemail.com (Postfix) with ESMTP id AFC97100009 for ; Tue, 1 Oct 2024 15:02:00 +0000 (UTC) Authentication-Results: imf14.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=q5ac0Azm; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf14.hostedemail.com: domain of dakr@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=dakr@kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1727794881; a=rsa-sha256; cv=none; b=X3qQl4xj8z6FNCOCKLpwd91RWWkq/v367u4jgeJUlN5scg3jNl6Zd84T6Y6MV0rF6k+gWa d/dLYAtW2EUHxZfewPOV18n1HqOpmRZHBryiZUw44oHqV+1QOggUbfvdNNtqK9dK/vgcfj fYXxxyKAnrNoegML8Ks41Qj2zvTkapQ= ARC-Authentication-Results: i=1; imf14.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=q5ac0Azm; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf14.hostedemail.com: domain of dakr@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=dakr@kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1727794881; 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-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=UGyZDjyZxhnG6gqrWWDgaefQfQjFJVOj0k4IjyFvnpQ=; b=Q8shB+iJwSmkTQzbMXMiPdNhQebe3VmtLGAry9ACRNfVkmJBIo32my4WTC8Fg7A9c00ga1 rFu11glaGSr7DIpGnZOGs7/dHuWcVPrIMZTIkLz/Cu5PQm7Ll+VuKLipgbs9W9bMXq6RYK fHV9zaQj/s11VD1OEesPxQQShdqpa1I= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by nyc.source.kernel.org (Postfix) with ESMTP id 843B3A40279; Tue, 1 Oct 2024 15:01:51 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 95C29C4CECF; Tue, 1 Oct 2024 15:01:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1727794919; bh=L+/LMFOMtE864WvCn41tWWSUMQocDvmfmSNi2WDyR5M=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=q5ac0AzmGV2ElLdhlD4+yTKtDEpfPVAhJdXEM9yuVluSA7ZN4jRVDGY1YCM/imngE laj9dhlSw8k73BtPsXFQEf8MINHpP7+qSMO67XNPHZEv+ugT7IDpeZ0kRb0/DZa1NM j9evXryTLEGDekebVTAcTHDEdfpduYwURpHjQKQCrHT47q/QX0C8B0OfCgi8JtDWbl KrIzUEkBHU7KAg32b1JWyrf6EY6Yw17urRFjHRXgvIWDEWRzdGQ4kqxR9k9TMDDLyt i9kUccDMuGH8Crmzs+G7AVlSu6MlWJ8FZJgFixA6w0wVCD+fFtMk7y0IQxgnqnFQBB mh1RonLnRjoRQ== From: Danilo Krummrich To: ojeda@kernel.org, alex.gaynor@gmail.com, wedsonaf@gmail.com, boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com, benno.lossin@proton.me, a.hindborg@samsung.com, aliceryhl@google.com, akpm@linux-foundation.org Cc: daniel.almeida@collabora.com, faith.ekstrand@collabora.com, boris.brezillon@collabora.com, lina@asahilina.net, mcanal@igalia.com, zhiw@nvidia.com, cjia@nvidia.com, jhubbard@nvidia.com, airlied@redhat.com, ajanulgu@redhat.com, lyude@redhat.com, linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-mm@kvack.org, Danilo Krummrich Subject: [PATCH v8 19/29] rust: treewide: switch to the kernel `Vec` type Date: Tue, 1 Oct 2024 16:59:54 +0200 Message-ID: <20241001150008.183102-20-dakr@kernel.org> X-Mailer: git-send-email 2.46.1 In-Reply-To: <20241001150008.183102-1-dakr@kernel.org> References: <20241001150008.183102-1-dakr@kernel.org> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Queue-Id: AFC97100009 X-Rspamd-Server: rspam01 X-Stat-Signature: ze3ugar7xi6q669c6wco6db8bhx8rpcm X-HE-Tag: 1727794920-683103 X-HE-Meta: U2FsdGVkX1/jLdhER83pGMzO9EWxDTNrK531ZbWU+ILd4XyicWO9r8dgl605AenDeYDukHDyhRGIwuwVIe9Au9cy4Tn6PxMpcn9xe9gUslNRH9s5uzzri/2aXKts4UVCLkoisTqG+9OaS2Qa0/zR4p2+fvTiESrH1t2IgrHcMTghJ9iSAddk7QBjRAh+luwHqG4xrt87KWefP5Qxe3rthN9qsWTvRRbr3CMgabc9Lwm+ea2HowaYp67N/K+ieFs1cdGTT3Bg1wtmHvbGyvlqwGKuVP1f93WPhwR2LaGxrl7UrWvOA6A7vSGSlmzS9x/ob8oX0z4bASMMzlcpGmH6QNpCi9OicScmbWibER0aL/eYpmre/WQwoFXBAHZOwFj1ZHFWDR7nH45tePqpB0bTDiNeXMXkgXCt/Intx/JTUuaCHVhk2fAk6hOdY1BnhWmCAnzhrnqITES2Gfsg6kAw4eN6oOGQnR6QP+/8sLlIyaPh5pmSmuJtUu7oRdPetqB8Kjx3y8TMkQZKvPQG+AsIFny+xZVtrjZsszgvh5z9EWcmFcNqRO2KY5kWKQbkZkxbY1AyDahxRv2HDLFKZr++KX4JUWDr8+sYz+nc4w2o9jZYs1az7IK4waX455ckAXIAzP/tEA/kGIBdKFyzHtFSaKyxTgtp6axRpgyH+HiSm6aCI9VsfbCmlwwburqkj5UrCSKUL9TfDOWdts9B3XW6clyhUNBhIYpz5y0m1JhLtx3+FfE2ho9ivkpD3rR02Cb7J+QzSRbiGOQjN0B4+wGezRhQYeiEgQ+kt6t764I3jNfgpWcsDpTFanqIIMdA6rAAWOwXpr1X/Z30tKMQesM0UsHK8h6JUhuI4D8jnGUSljHhThBngPcz85m/Qqh/et/ps/yJU/44PKjlmFnBC7wt+Q5vD6sri8wJ6Fbvr8jZEXReYtnxs9RtDupcW/wKrsFmYH0QZoFLHsQ9DhugTOr awnqO6oF 5CtnHbw8gRjNGYTeKzsu2yWEDbVcahOypzjUB3aHsr/4zYOCdIFkIQ7IUYdF8TAPaNaJ1TRAMQfq/Q4nAkZLOTdfQwJXS9CTHrE0aoTDJFHlnbI9Rrw3v6QRga1sJhc+gl3Qwg6N5ELNmlhIhasRACQVFf+pDHpjeq9n5/7PyoKlzIzc0BMU1whu9SmTc64EaBbYs1rN40ZiM6rxV4OncUZ4Nf0/A5ZZGOyLh28QIct4pZ8quOmRHvBD486zMmOo7mlNFvjbwSzWRVES3nto5tZ7Ykjc+koS+lIRsO1ef29I+BgoSfwVCsZ/Aw10o9gIm+DogEUv9dohOCt6z5TTxhEnFe8GWOhsLvt4qVJR/wxtsuSFViyXuQ6flHUobSY7WNmtS 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: Now that we got the kernel `Vec` in place, convert all existing `Vec` users to make use of it. Reviewed-by: Alice Ryhl Reviewed-by: Benno Lossin Reviewed-by: Gary Guo Signed-off-by: Danilo Krummrich --- rust/kernel/str.rs | 12 +++++------- rust/kernel/sync/locked_by.rs | 2 +- rust/kernel/types.rs | 2 +- rust/kernel/uaccess.rs | 17 +++++++---------- rust/macros/lib.rs | 6 +++--- samples/rust/rust_minimal.rs | 4 ++-- 6 files changed, 19 insertions(+), 24 deletions(-) diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs index bb8d4f41475b..209ad1bb1a49 100644 --- a/rust/kernel/str.rs +++ b/rust/kernel/str.rs @@ -2,8 +2,7 @@ //! String representations. -use crate::alloc::{flags::*, vec_ext::VecExt, AllocError}; -use alloc::vec::Vec; +use crate::alloc::{flags::*, AllocError, KVec}; use core::fmt::{self, Write}; use core::ops::{self, Deref, DerefMut, Index}; @@ -790,7 +789,7 @@ fn write_str(&mut self, s: &str) -> fmt::Result { /// assert_eq!(s.is_ok(), false); /// ``` pub struct CString { - buf: Vec, + buf: KVec, } impl CString { @@ -803,7 +802,7 @@ pub fn try_from_fmt(args: fmt::Arguments<'_>) -> Result { let size = f.bytes_written(); // Allocate a vector with the required number of bytes, and write to it. - let mut buf = as VecExt<_>>::with_capacity(size, GFP_KERNEL)?; + let mut buf = KVec::with_capacity(size, GFP_KERNEL)?; // SAFETY: The buffer stored in `buf` is at least of size `size` and is valid for writes. let mut f = unsafe { Formatter::from_buffer(buf.as_mut_ptr(), size) }; f.write_fmt(args)?; @@ -850,10 +849,9 @@ impl<'a> TryFrom<&'a CStr> for CString { type Error = AllocError; fn try_from(cstr: &'a CStr) -> Result { - let mut buf = Vec::new(); + let mut buf = KVec::new(); - as VecExt<_>>::extend_from_slice(&mut buf, cstr.as_bytes_with_nul(), GFP_KERNEL) - .map_err(|_| AllocError)?; + buf.extend_from_slice(cstr.as_bytes_with_nul(), GFP_KERNEL)?; // INVARIANT: The `CStr` and `CString` types have the same invariants for // the string data, and we copied it over without changes. diff --git a/rust/kernel/sync/locked_by.rs b/rust/kernel/sync/locked_by.rs index babc731bd5f6..b94517231fcc 100644 --- a/rust/kernel/sync/locked_by.rs +++ b/rust/kernel/sync/locked_by.rs @@ -43,7 +43,7 @@ /// struct InnerDirectory { /// /// The sum of the bytes used by all files. /// bytes_used: u64, -/// _files: Vec, +/// _files: KVec, /// } /// /// struct Directory { diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs index 53d3ddc0b98c..bf1a96d5e1f8 100644 --- a/rust/kernel/types.rs +++ b/rust/kernel/types.rs @@ -135,7 +135,7 @@ unsafe fn from_foreign(_: *const core::ffi::c_void) -> Self {} /// # use kernel::types::ScopeGuard; /// fn example3(arg: bool) -> Result { /// let mut vec = -/// ScopeGuard::new_with_data(Vec::new(), |v| pr_info!("vec had {} elements\n", v.len())); +/// ScopeGuard::new_with_data(KVec::new(), |v| pr_info!("vec had {} elements\n", v.len())); /// /// vec.push(10u8, GFP_KERNEL)?; /// if arg { diff --git a/rust/kernel/uaccess.rs b/rust/kernel/uaccess.rs index e9347cff99ab..bc011061de45 100644 --- a/rust/kernel/uaccess.rs +++ b/rust/kernel/uaccess.rs @@ -11,7 +11,6 @@ prelude::*, types::{AsBytes, FromBytes}, }; -use alloc::vec::Vec; use core::ffi::{c_ulong, c_void}; use core::mem::{size_of, MaybeUninit}; @@ -46,7 +45,6 @@ /// every byte in the region. /// /// ```no_run -/// use alloc::vec::Vec; /// use core::ffi::c_void; /// use kernel::error::Result; /// use kernel::uaccess::{UserPtr, UserSlice}; @@ -54,7 +52,7 @@ /// fn bytes_add_one(uptr: UserPtr, len: usize) -> Result<()> { /// let (read, mut write) = UserSlice::new(uptr, len).reader_writer(); /// -/// let mut buf = Vec::new(); +/// let mut buf = KVec::new(); /// read.read_all(&mut buf, GFP_KERNEL)?; /// /// for b in &mut buf { @@ -69,7 +67,6 @@ /// 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::{UserPtr, UserSlice}; @@ -78,21 +75,21 @@ /// fn is_valid(uptr: UserPtr, len: usize) -> Result { /// let read = UserSlice::new(uptr, len).reader(); /// -/// let mut buf = Vec::new(); +/// let mut buf = KVec::new(); /// read.read_all(&mut buf, GFP_KERNEL)?; /// /// todo!() /// } /// /// /// Returns the bytes behind this user pointer if they are valid. -/// fn get_bytes_if_valid(uptr: UserPtr, len: usize) -> Result> { +/// fn get_bytes_if_valid(uptr: UserPtr, len: usize) -> Result> { /// if !is_valid(uptr, len)? { /// return Err(EINVAL); /// } /// /// let read = UserSlice::new(uptr, len).reader(); /// -/// let mut buf = Vec::new(); +/// let mut buf = KVec::new(); /// read.read_all(&mut buf, GFP_KERNEL)?; /// /// // THIS IS A BUG! The bytes could have changed since we checked them. @@ -130,7 +127,7 @@ pub fn new(ptr: UserPtr, length: usize) -> Self { /// 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, flags: Flags) -> Result { + pub fn read_all(self, buf: &mut KVec, flags: Flags) -> Result { self.reader().read_all(buf, flags) } @@ -291,9 +288,9 @@ pub fn read(&mut self) -> Result { /// 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, flags: Flags) -> Result { + pub fn read_all(mut self, buf: &mut KVec, flags: Flags) -> Result { let len = self.length; - VecExt::::reserve(buf, len, flags)?; + buf.reserve(len, flags)?; // The call to `try_reserve` was successful, so the spare capacity is at least `len` bytes // long. diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index ab93111a048c..8d4ac914b48b 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -242,7 +242,7 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream { /// #[pin_data] /// struct DriverData { /// #[pin] -/// queue: Mutex>, +/// queue: Mutex>, /// buf: KBox<[u8; 1024 * 1024]>, /// } /// ``` @@ -251,7 +251,7 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream { /// #[pin_data(PinnedDrop)] /// struct DriverData { /// #[pin] -/// queue: Mutex>, +/// queue: Mutex>, /// buf: KBox<[u8; 1024 * 1024]>, /// raw_info: *mut Info, /// } @@ -281,7 +281,7 @@ pub fn pin_data(inner: TokenStream, item: TokenStream) -> TokenStream { /// #[pin_data(PinnedDrop)] /// struct DriverData { /// #[pin] -/// queue: Mutex>, +/// queue: Mutex>, /// buf: KBox<[u8; 1024 * 1024]>, /// raw_info: *mut Info, /// } diff --git a/samples/rust/rust_minimal.rs b/samples/rust/rust_minimal.rs index 2a9eaab62d1c..4aaf117bf8e3 100644 --- a/samples/rust/rust_minimal.rs +++ b/samples/rust/rust_minimal.rs @@ -13,7 +13,7 @@ } struct RustMinimal { - numbers: Vec, + numbers: KVec, } impl kernel::Module for RustMinimal { @@ -21,7 +21,7 @@ fn init(_module: &'static ThisModule) -> Result { pr_info!("Rust minimal sample (init)\n"); pr_info!("Am I built-in? {}\n", !cfg!(MODULE)); - let mut numbers = Vec::new(); + let mut numbers = KVec::new(); numbers.push(72, GFP_KERNEL)?; numbers.push(108, GFP_KERNEL)?; numbers.push(200, GFP_KERNEL)?;