From patchwork Wed Sep 11 22:52:36 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Danilo Krummrich X-Patchwork-Id: 13801173 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 F0445EE57DC for ; Wed, 11 Sep 2024 22:55:05 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 59F666B007B; Wed, 11 Sep 2024 18:55:05 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 54F6C6B0082; Wed, 11 Sep 2024 18:55:05 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3F0136B0083; Wed, 11 Sep 2024 18:55:05 -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 1DFF16B007B for ; Wed, 11 Sep 2024 18:55:05 -0400 (EDT) Received: from smtpin17.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id C5CD41A13F9 for ; Wed, 11 Sep 2024 22:55:04 +0000 (UTC) X-FDA: 82553964528.17.6B738A9 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf05.hostedemail.com (Postfix) with ESMTP id 3CCEC10000A for ; Wed, 11 Sep 2024 22:55:02 +0000 (UTC) Authentication-Results: imf05.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=FCH6sGkY; spf=pass (imf05.hostedemail.com: domain of dakr@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=dakr@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1726095250; 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:references:dkim-signature; bh=Aj3e7odRtjm44GIYHHqqvWxX+XbnLuQdxcxYDY5c5L4=; b=KDQlnrQbd97+v6pPpIwWQJhxfzbS3cx8d35uJg3/thzZRz6s0lXDuFSIQoHiSb5nMZaMY/ vUFk8cQdnpE6GYn0zcBhvdMfFFV5N4+F2YCwKZd9xte/L19GL2XhRN0hqVVlsi6IMZg+xq BaykeYujCGCu7ed6nMoD8d4xIzbvU04= ARC-Authentication-Results: i=1; imf05.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=FCH6sGkY; spf=pass (imf05.hostedemail.com: domain of dakr@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=dakr@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1726095250; a=rsa-sha256; cv=none; b=h5qU29LsmQhRghlUYINS59B+oys4i8vVwfYecCurOntKiAkIfnHOozKUPxjHMdk1DbGJVd zOG0qgzebBcawl2IYp7tQlsEPGh1tNkxY03r1EzUGL+Ft1LblvW5WltqtqozS3Cgm4/Pcc iJ5o2gg30StC7CluK5GoaPMI6mdyMxY= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id B013F5C0655; Wed, 11 Sep 2024 22:54:57 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 18C63C4CEC0; Wed, 11 Sep 2024 22:54:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1726095300; bh=1MiDAPOMXwvs7Mvjgi6FRoHdOy/J3VM4lhRV/Mn3oSo=; h=From:To:Cc:Subject:Date:From; b=FCH6sGkY1LWCBzWFA0W/I9khvzWDYRc3aT54WKIuP6UkpgbSQMlBj663MWqVrX13n AXce6vMX7WamI/3NBOJh6V9Oenx0P1Md/drRuvdsCrWYESiYd2YWaPFAQTChaLOPZL bYMImGzuKLFeaNPwuulGpUnkdEBRoq+W9QrlZHWYq42VYHOqvXntsTZt+Zqa+LPdBD FRehAzxEK0B5wWSI16xazbiNj4mbYwTlHpy/MvJRtvLHobu0+7hXw1j86YPwbUMXiJ wzkVnFUwEdd7BumDnbY6/sWiYedp4igPor9sB+rghKqmKe1psBHK4xV2SKOiaqNqWV poFQaGEUWP5Vg== 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 v7 00/26] Generic `Allocator` support for Rust Date: Thu, 12 Sep 2024 00:52:36 +0200 Message-ID: <20240911225449.152928-1-dakr@kernel.org> X-Mailer: git-send-email 2.46.0 MIME-Version: 1.0 X-Rspamd-Server: rspam03 X-Rspam-User: X-Rspamd-Queue-Id: 3CCEC10000A X-Stat-Signature: msgmxhzqd5wqrghxzzq8pa3pjiik54jj X-HE-Tag: 1726095302-528846 X-HE-Meta: U2FsdGVkX1+okYNTFO31HL2Z4cLyvzbJDuGCVSPeDiYBu+a9XeC6/vf5VNahQjNJRmhpgEuPBoBVJ681M/Gn7QGNpYVrFLakBE2Wemf/55hbhGqe6fn6B+kwJyV3V9XfUTqroF88e6nlfs4EN0Nc84qFeYQkl3mWzECRyz0Qay3OBGdOY1kmwMKAi8JGgbRQEZJZ4FDq0liS/0s4hCP3/SPUT6KmPv7Xcq38D4qvp1anihDpi5ETuVMe7gvluyHBLoqslypOcsf5SUqON3faI+qSzl+As1WsHA37SPt3Moohx8Yw7bUmrJ5j07pvmAJkA5rP5Yxzo2ZfCx4Sko/kYJMyiJ2W7ArtndqCiAjmRlxtkFcmxx0NwvvyAAUslPI88VECMovcoftjAzwYC2x6jd/f2IrPCXMcdj45rOHyyjc3NFQGNjh9emVHrS3pliyA+dr15MiFNzZjckzLOb9u91LdYpoLePXhVDP5yD2E7DNwDVtIcBHZXcJ50SfBOdPZDfYNP2d7kupXKd/hYetno41HPzSQ42UO4nATR2paJvuCkdnhUurfX73xyBf78KVydGEUNtv7cFwLeXJ+2I0svpH1aCZ5rFtzONG/egdwSLiislSDbYcG4WKOMGJdlD/skuBv4fAQL9Q7ANgGZaWsNMfSKdab2jw/BZ3pdzUPf54R+jYHLAaJkfMIdOJ04Q2LoCHxL1CstUGmvym+ZVBlsvO/5PCKQfgvL0Nvr+aTG6absQVaGQqEt22yjsZqeMXicqiPwKaUY/Kjc269f71Ijkk4Lkd1z7iYqFoim7nAHFlphr7mvirPaKYAqW8xAWX/ljlrf9IsnAmS/lFWVH/QIOFd2MRSRqUH7oFkJW2Wep00s6EALYQLmfAc+1nFPNj1CtpqMF2KtCOADWXEWAtFLK21C1ZuRYuq0sQc/IVrx0J0YpYSqx8NOi3Mrw90fhbFID0NFtjebLhML/XSd8C j+irou/n 948h+UVkNYW3xd0z6MU85C+GqNMTC86MC7MXDHiqxFyS2wuSmpTY0TYUR4uO4gPq3ZkJYEuw5BtdG6nbfyvOhMQj7ux4niMBxsDIomxnWfx1SNJpMKTxPbYO8K/masP2sJh56tls2zYBoVh2VIHoy/a+QVSLJVL5g8f5zM/EFdLQa45Kt3KmENs9Oa8xzWdmRhZ96XgmrnbtYVeO43leYklnD1paVwgq3SyRkOnpvhYfrVtjJwoGF3xexlMz1z0dgYzaXwDa1ced31nV0oM0CMG3SsTiTW/Cegfxzmp+JsGK4QERZlCyCJXTmNA== 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: Hi, This patch series adds generic kernel allocator support for Rust, which so far is limited to `kmalloc` allocations. In order to abstain from (re-)adding unstable Rust features to the kernel, this patch series does not extend the `Allocator` trait from Rust's `alloc` crate, nor does it extend the `BoxExt` and `VecExt` extensions. Instead, this series introduces a kernel specific `Allocator` trait, which is implemented by the `Kmalloc`, `Vmalloc` and `KVmalloc` allocators, also implemented in the context of this series. As a consequence we need our own kernel `Box` and `Vec` types. Additionally, this series adds the following type aliases: ``` pub type KBox = Box; pub type VBox = Box; pub type KVBox = Box; pub type KVec = Vec; pub type VVec = Vec; pub type KVVec = Vec; ``` With that, we can start using the kernel `Box` and `Vec` types throughout the tree and remove the now obolete extensions `BoxExt` and `VecExt`. For a final cleanup, this series removes the last minor dependencies to Rust's `alloc` crate and removes it from the entire kernel build. The series ensures not to break the `rusttest` make target by implementing the `allocator_test` module providing a stub implementation for all kernel `Allocator`s. This patch series passes all KUnit tests, including the ones added by this series. Additionally, the tests were run with `kmemleak` and `KASAN` enabled, without any issues. This series is based on [1], which hit -mm/mm-stable, and is also available in [2]. [1] https://git.kernel.org/pub/scm/linux/kernel/git/dakr/linux.git/log/?h=mm/krealloc [2] https://git.kernel.org/pub/scm/linux/kernel/git/dakr/linux.git/log/?h=rust/mm Changes in v7: - rebase onto rust-next resolving recent conflicts (93dc3be19450447a3a7090bd1dfb9f3daac3e8d2) - documentation / safety comment changes suggested by Benno and Boqun - rename `ptr` to `current` in `IntoIter::next` (Alice) - remove unnecessary braces in `kvec!` (Benno) - add `debug_assert!` in `Vec::set_len` (Benno) - remove unused args in `impl_slice_eq!` (Benno) - simplify `if` statement in `Cmalloc::realloc` (Benno) Changes in v6: - rebase onto rust-dev - keep compiler annotations for {k,v,kv}realloc() - documentation changes suggested by Alice, Benno - remove `Box::into_pin` - fix typo in `Send` and `Sync` for `Box` and `Vec` - `kvec!` changes suggested by Alice - free `src` after copy in `Cmalloc` - handle `n == 0` in `Vec::extend_with` Changes in v5: - (safety) comment / documentation fixes suggested by Alice, Benno and Gary - remove `Unique` and implement `Send` and `Sync` for `Box` and `Vec` - use `KMALLOC_MAX_SIZE` for `KVmalloc` test and add a `Kmalloc` test that expects to fail for `KMALLOC_MAX_SIZE` - create use constants `KREALLOC`, `VREALLOC` and `KVREALLOC` for `ReallocFuncs` - drop `Box::drop_contents` for now, will add it again, once I actually rebase on the original patch that introduces it - improve usage of `size_of_val` in `Box` - move `InPlaceInit` and `ForeignOwnable` impls into kbox.rs - fix missing `Box` conversions in rnull.rs - reworked `Cmalloc` to keep track of the size of memory allocations itself - remove `GlobalAlloc` together with the `alloc` crate to avoid a linker error - remove `alloc` from scripts/generate_rust_analyzer.py Changes in v4: - (safety) comment fixes suggested by Alice and Boqun - remove `Box::from_raw_alloc` and `Box::into_raw_alloc`, we don't need them - in `Box::drop` call `size_of_val` before `drop_in_place` - implement ForeignOwnable for Pin> as suggested by Alice - in `Vec::extend_with`, iterate over `n` instead of `spare.len()` - for `Vmalloc` and `KVmalloc` fail allocation for alignments larger than PAGE_SIZE for now (will add support for larger alignments in a separate series) - implement `Cmalloc` in `allocator_test` and type alias all kernel allocator types to it, such that we can use the kernel's `Box` and `Vec` types in userspace tests (rusttest) - this makes patch "rust: str: test: replace `alloc::format`" rather trivial Changes in v3: - Box: - minor documentation fixes - removed unnecessary imports in doc tests - dropeed `self` argument from some remaining `Box` methods - implement `InPlaceInit` for Box rather than specifically for `KBox` - Vec: - minor documentation fixes - removed useless `Vec::allocator` method - in `Vec::extend_with` use `Vec::spare_capacity_mut` instead of raw pointer operations - added a few missing safety comments - pass GFP flags to `Vec::collect` - fixed a rustdoc warning in alloc.rs - fixed the allocator_test module to implement the `Allocator` trait correctly - rebased to rust-next Changes in v2: - preserve `impl GlobalAlloc for Kmalloc` and remove it at the end (Benno) - remove `&self` parameter from all `Allocator` functions (Benno) - various documentation fixes for `Allocator` (Benno) - use `NonNull` for `Allocator::free` and `Option>` for `Allocator::realloc` (Benno) - fix leak of `IntoIter` in `Vec::collect` (Boqun) - always realloc (try to shrink) in `Vec::collect`, it's up the the `Allocator` to provide a heuristic whether it makes sense to actually shrink - rename `KBox` -> `Box` and `KVec` -> `Vec` and provide type aliases `KBox`, `VBox`, `KVBox`, etc. - This allows for much cleaner code and, in combination with removing `&self` parameters from `Allocator`s, gets us rid of the need for `Box::new` and `Box::new_alloc` and all other "_alloc" postfixed functions. - Before: `KBox::new_alloc(foo, Vmalloc)?` - After: `VBox::new(foo)?`, which resolves to `Box::::new(foo)?; Danilo Krummrich (26): rust: alloc: add `Allocator` trait rust: alloc: separate `aligned_size` from `krealloc_aligned` rust: alloc: rename `KernelAllocator` to `Kmalloc` rust: alloc: implement `Allocator` for `Kmalloc` rust: alloc: add module `allocator_test` rust: alloc: implement `Vmalloc` allocator rust: alloc: implement `KVmalloc` allocator rust: alloc: add __GFP_NOWARN to `Flags` rust: alloc: implement kernel `Box` rust: treewide: switch to our kernel `Box` type rust: alloc: remove extension of std's `Box` rust: alloc: add `Box` to prelude rust: alloc: implement kernel `Vec` type rust: alloc: implement `IntoIterator` for `Vec` rust: alloc: implement `collect` for `IntoIter` rust: treewide: switch to the kernel `Vec` type rust: alloc: remove `VecExt` extension rust: alloc: add `Vec` to prelude rust: error: use `core::alloc::LayoutError` rust: error: check for config `test` in `Error::name` rust: alloc: implement `contains` for `Flags` rust: alloc: implement `Cmalloc` in module allocator_test rust: str: test: replace `alloc::format` rust: alloc: update module comment of alloc.rs kbuild: rust: remove the `alloc` crate and `GlobalAlloc` MAINTAINERS: add entry for the Rust `alloc` module MAINTAINERS | 7 + drivers/block/rnull.rs | 4 +- rust/Makefile | 43 +- rust/bindings/bindings_helper.h | 1 + rust/exports.c | 1 - rust/helpers/helpers.c | 1 + rust/helpers/slab.c | 6 + rust/helpers/vmalloc.c | 9 + rust/kernel/alloc.rs | 152 ++++- rust/kernel/alloc/allocator.rs | 198 ++++-- rust/kernel/alloc/allocator_test.rs | 200 ++++++ rust/kernel/alloc/box_ext.rs | 87 --- rust/kernel/alloc/kbox.rs | 465 ++++++++++++++ rust/kernel/alloc/kvec.rs | 905 ++++++++++++++++++++++++++++ rust/kernel/alloc/vec_ext.rs | 185 ------ rust/kernel/error.rs | 6 +- rust/kernel/init.rs | 95 +-- rust/kernel/init/__internal.rs | 2 +- rust/kernel/lib.rs | 1 - rust/kernel/prelude.rs | 5 +- rust/kernel/rbtree.rs | 49 +- rust/kernel/str.rs | 35 +- rust/kernel/sync/arc.rs | 17 +- rust/kernel/sync/condvar.rs | 4 +- rust/kernel/sync/lock/mutex.rs | 2 +- rust/kernel/sync/lock/spinlock.rs | 2 +- rust/kernel/sync/locked_by.rs | 2 +- rust/kernel/types.rs | 52 +- rust/kernel/uaccess.rs | 17 +- rust/kernel/workqueue.rs | 20 +- rust/macros/lib.rs | 12 +- samples/rust/rust_minimal.rs | 4 +- scripts/Makefile.build | 7 +- scripts/generate_rust_analyzer.py | 11 +- 34 files changed, 2029 insertions(+), 578 deletions(-) create mode 100644 rust/helpers/vmalloc.c create mode 100644 rust/kernel/alloc/allocator_test.rs delete mode 100644 rust/kernel/alloc/box_ext.rs create mode 100644 rust/kernel/alloc/kbox.rs create mode 100644 rust/kernel/alloc/kvec.rs delete mode 100644 rust/kernel/alloc/vec_ext.rs base-commit: db8c7e4c95acc68f1e1cd51e0a7f1532c69a23c9