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 04/23] rust: alloc: implement `Allocator` for `Kmalloc`
Date: Tue, 23 Jul 2024 20:09:53 +0200	[thread overview]
Message-ID: <20240723181024.21168-5-dakr@kernel.org> (raw)
In-Reply-To: <20240723181024.21168-1-dakr@kernel.org>

Implement `Allocator` for `Kmalloc`, the kernel's default allocator,
typically used for objects smaller than page size.

All memory allocations made with `Kmalloc` end up in `krealloc()`.

It serves as allocator for the subsequently introduced types `KBox` and
`KVec`.

Signed-off-by: Danilo Krummrich <dakr@kernel.org>
---
 rust/kernel/alloc.rs           |  2 +-
 rust/kernel/alloc/allocator.rs | 66 ++++++++++++++++++++++++++++++++--
 2 files changed, 65 insertions(+), 3 deletions(-)

diff --git a/rust/kernel/alloc.rs b/rust/kernel/alloc.rs
index 11d12264c194..bf739ce65387 100644
--- a/rust/kernel/alloc.rs
+++ b/rust/kernel/alloc.rs
@@ -4,7 +4,7 @@
 
 #[cfg(not(test))]
 #[cfg(not(testlib))]
-mod allocator;
+pub mod allocator;
 pub mod box_ext;
 pub mod vec_ext;
 
diff --git a/rust/kernel/alloc/allocator.rs b/rust/kernel/alloc/allocator.rs
index 10774c51ae26..397ae5bcc043 100644
--- a/rust/kernel/alloc/allocator.rs
+++ b/rust/kernel/alloc/allocator.rs
@@ -5,9 +5,18 @@
 use super::{flags::*, Flags};
 use core::alloc::{GlobalAlloc, Layout};
 use core::ptr;
+use core::ptr::NonNull;
 
-struct Kmalloc;
+use crate::alloc::{AllocError, Allocator};
+use crate::bindings;
 
+/// The contiguous kernel allocator.
+///
+/// The contiguous kernel allocator only ever allocates physically contiguous memory through
+/// `bindings::krealloc`.
+pub struct Kmalloc;
+
+/// Returns a proper size to alloc a new object aligned to `new_layout`'s alignment.
 fn aligned_size(new_layout: Layout) -> usize {
     // Customized layouts from `Layout::from_size_align()` can have size < align, so pad first.
     let layout = new_layout.pad_to_align();
@@ -18,7 +27,7 @@ fn aligned_size(new_layout: Layout) -> usize {
     layout.size()
 }
 
-/// Calls `krealloc` with a proper size to alloc a new object aligned to `new_layout`'s alignment.
+/// Calls `krealloc` with a proper size to alloc a new object.
 ///
 /// # Safety
 ///
@@ -39,6 +48,59 @@ pub(crate) unsafe fn krealloc_aligned(ptr: *mut u8, new_layout: Layout, flags: F
     }
 }
 
+struct ReallocFunc(
+    // INVARIANT: One of the following `krealloc`, `vrealloc`, `kvrealloc`.
+    unsafe extern "C" fn(*const core::ffi::c_void, usize, u32) -> *mut core::ffi::c_void,
+);
+
+impl ReallocFunc {
+    fn krealloc() -> Self {
+        Self(bindings::krealloc)
+    }
+
+    // SAFETY: `call` has the exact same safety requirements as `Allocator::realloc`.
+    unsafe fn call(
+        &self,
+        ptr: Option<NonNull<u8>>,
+        layout: Layout,
+        flags: Flags,
+    ) -> Result<NonNull<[u8]>, AllocError> {
+        let size = aligned_size(layout);
+        let ptr = match ptr {
+            Some(ptr) => ptr.as_ptr(),
+            None => ptr::null(),
+        };
+
+        // SAFETY: `ptr` is valid by the safety requirements of this function.
+        let raw_ptr = unsafe {
+            // If `size == 0` and `ptr != NULL` the memory behind the pointer is freed.
+            self.0(ptr.cast(), size, flags.0).cast()
+        };
+
+        let ptr = if size == 0 {
+            NonNull::dangling()
+        } else {
+            NonNull::new(raw_ptr).ok_or(AllocError)?
+        };
+
+        Ok(NonNull::slice_from_raw_parts(ptr, size))
+    }
+}
+
+unsafe impl Allocator for Kmalloc {
+    unsafe fn realloc(
+        ptr: Option<NonNull<u8>>,
+        layout: Layout,
+        flags: Flags,
+    ) -> Result<NonNull<[u8]>, AllocError> {
+        let realloc = ReallocFunc::krealloc();
+
+        // SAFETY: If not `None`, `ptr` is guaranteed to point to valid memory, which was previously
+        // allocated with this `Allocator`.
+        unsafe { realloc.call(ptr, layout, flags) }
+    }
+}
+
 unsafe impl GlobalAlloc for Kmalloc {
     unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
         // SAFETY: `ptr::null_mut()` is null and `layout` has a non-zero size by the function safety
-- 
2.45.2


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

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-23 18:09 [PATCH v2 00/23] Generic `Allocator` support for Rust Danilo Krummrich
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 ` Danilo Krummrich [this message]
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-5-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.