All of lore.kernel.org
 help / color / mirror / Atom feed
From: Danilo Krummrich <dakr@kernel.org>
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, acurrid@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 <dakr@kernel.org>
Subject: [PATCH v2 00/23] Generic `Allocator` support for Rust
Date: Tue, 23 Jul 2024 20:09:49 +0200	[thread overview]
Message-ID: <20240723181024.21168-1-dakr@kernel.org> (raw)

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<T, A>` and `Vec<T, A>` types.
Additionally, this series adds the following type aliases:

```
pub type KBox<T> = Box<T, Kmalloc>;
pub type VBox<T> = Box<T, Vmalloc>;
pub type KVBox<T> = Box<T, KVmalloc>;


pub type KVec<T> = Vec<T, Kmalloc>;
pub type VVec<T> = Vec<T, Vmalloc>;
pub type KVVec<T> = Vec<T, KVmalloc>;
```

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 in [1], which just hit -mm/mm-unstable, 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 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<u8>` for `Allocator::free` and `Option<NonNull<u8>>` 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<T, A>` -> `Box<T, A>` and `KVec<T, A>` -> `Vec<T, A>` and
    provide type aliases `KBox<T>`, `VBox<T>`, `KVBox<T>`, 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::<Foo,  Vmalloc>::new(foo)?;

Danilo Krummrich (23):
  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: types: implement `Unique<T>`
  rust: alloc: implement kernel `Box`
  rust: treewide: switch to our kernel `Box` type
  rust: alloc: remove `BoxExt` extension
  rust: alloc: add `Box` to prelude
  rust: alloc: import kernel `Box` type in types.rs
  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: alloc: remove `GlobalAlloc` and `krealloc_aligned`
  rust: error: use `core::alloc::LayoutError`
  rust: str: test: replace `alloc::format`
  kbuild: rust: remove the `alloc` crate

 rust/Makefile                       |  44 +-
 rust/exports.c                      |   1 -
 rust/helpers.c                      |  15 +
 rust/kernel/alloc.rs                |  99 +++-
 rust/kernel/alloc/allocator.rs      | 147 +++--
 rust/kernel/alloc/allocator_test.rs |  23 +
 rust/kernel/alloc/box_ext.rs        |  56 --
 rust/kernel/alloc/kbox.rs           | 344 ++++++++++++
 rust/kernel/alloc/kvec.rs           | 831 ++++++++++++++++++++++++++++
 rust/kernel/alloc/vec_ext.rs        | 185 -------
 rust/kernel/error.rs                |   2 +-
 rust/kernel/init.rs                 |  49 +-
 rust/kernel/init/__internal.rs      |   2 +-
 rust/kernel/lib.rs                  |   1 -
 rust/kernel/prelude.rs              |   5 +-
 rust/kernel/str.rs                  |  78 ++-
 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                | 192 ++++++-
 rust/kernel/workqueue.rs            |  20 +-
 samples/rust/rust_minimal.rs        |   4 +-
 scripts/Makefile.build              |   7 +-
 25 files changed, 1713 insertions(+), 419 deletions(-)
 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: d270beaca6818349b2aed7e6034b800a777087cc
-- 
2.45.2


             reply	other threads:[~2024-07-23 18:10 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-23 18:09 Danilo Krummrich [this message]
2024-07-23 18:09 ` [PATCH v2 01/23] rust: alloc: add `Allocator` trait Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 02/23] rust: alloc: separate `aligned_size` from `krealloc_aligned` Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 03/23] rust: alloc: rename `KernelAllocator` to `Kmalloc` Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 04/23] rust: alloc: implement `Allocator` for `Kmalloc` Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 05/23] rust: alloc: add module `allocator_test` Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 06/23] rust: alloc: implement `Vmalloc` allocator Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 07/23] rust: alloc: implement `KVmalloc` allocator Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 08/23] rust: types: implement `Unique<T>` Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 09/23] rust: alloc: implement kernel `Box` Danilo Krummrich
2024-07-23 18:09 ` [PATCH v2 10/23] rust: treewide: switch to our kernel `Box` type Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 11/23] rust: alloc: remove `BoxExt` extension Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 12/23] rust: alloc: add `Box` to prelude Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 13/23] rust: alloc: import kernel `Box` type in types.rs Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 14/23] rust: alloc: implement kernel `Vec` type Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 15/23] rust: alloc: implement `IntoIterator` for `Vec` Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 16/23] rust: alloc: implement `collect` for `IntoIter` Danilo Krummrich
2024-07-24 14:35   ` Heghedus Razvan
2024-07-24 20:32     ` Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 17/23] rust: treewide: switch to the kernel `Vec` type Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 18/23] rust: alloc: remove `VecExt` extension Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 19/23] rust: alloc: add `Vec` to prelude Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 20/23] rust: alloc: remove `GlobalAlloc` and `krealloc_aligned` Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 21/23] rust: error: use `core::alloc::LayoutError` Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 22/23] rust: str: test: replace `alloc::format` Danilo Krummrich
2024-07-23 18:10 ` [PATCH v2 23/23] kbuild: rust: remove the `alloc` crate Danilo Krummrich

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240723181024.21168-1-dakr@kernel.org \
    --to=dakr@kernel.org \
    --cc=a.hindborg@samsung.com \
    --cc=acurrid@nvidia.com \
    --cc=airlied@redhat.com \
    --cc=ajanulgu@redhat.com \
    --cc=akpm@linux-foundation.org \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=benno.lossin@proton.me \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=boris.brezillon@collabora.com \
    --cc=cjia@nvidia.com \
    --cc=daniel.almeida@collabora.com \
    --cc=faith.ekstrand@collabora.com \
    --cc=gary@garyguo.net \
    --cc=jhubbard@nvidia.com \
    --cc=lina@asahilina.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=lyude@redhat.com \
    --cc=mcanal@igalia.com \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=wedsonaf@gmail.com \
    --cc=zhiw@nvidia.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.