mirror of
https://github.com/torvalds/linux.git
synced 2025-10-31 08:38:45 +02:00
b6cda913bb
Fixes multiple trivial typos in documentation and comments of the kernel crate. allocator: - Fix a trivial list item alignment issue in the last SAFETY comment of `krealloc_aligned`. init: - Replace 'type' with 'trait' in the doc comments of the `PinInit` and `Init` traits. - Add colons before starting lists. - Add spaces between the type and equal sign to respect the code formatting rules in example code. - End a sentence with a full stop instead of a colon. ioctl: - Replace 'an' with 'a' where appropriate. str: - Replace 'Return' with 'Returns' in the doc comment of `bytes_written` as the text describes what the function does. sync/lock: - Fix a trivial list item alignment issue in the Safety section of the `Backend` trait's description. sync/lock/spinlock: - The code in this module operates on spinlocks, not mutexes. Thus, replace 'mutex' with 'spinlock' in the SAFETY comment of `unlock`. workqueue: - Replace "wont" with "won't" in the doc comment of `__enqueue`. Signed-off-by: Valentin Obst <kernel@valentinobst.de> Reviewed-by: Trevor Gross <tmgross@umich.edu> Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Link: https://lore.kernel.org/r/20240131-doc-fixes-v3-v3-1-0c8af94ed7de@valentinobst.de Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
88 lines
3.4 KiB
Rust
88 lines
3.4 KiB
Rust
// SPDX-License-Identifier: GPL-2.0
|
|
|
|
//! Allocator support.
|
|
|
|
use core::alloc::{GlobalAlloc, Layout};
|
|
use core::ptr;
|
|
|
|
use crate::bindings;
|
|
|
|
struct KernelAllocator;
|
|
|
|
/// Calls `krealloc` with a proper size to alloc a new object aligned to `new_layout`'s alignment.
|
|
///
|
|
/// # Safety
|
|
///
|
|
/// - `ptr` can be either null or a pointer which has been allocated by this allocator.
|
|
/// - `new_layout` must have a non-zero size.
|
|
unsafe fn krealloc_aligned(ptr: *mut u8, new_layout: Layout, flags: bindings::gfp_t) -> *mut u8 {
|
|
// Customized layouts from `Layout::from_size_align()` can have size < align, so pad first.
|
|
let layout = new_layout.pad_to_align();
|
|
|
|
let mut size = layout.size();
|
|
|
|
if layout.align() > bindings::ARCH_SLAB_MINALIGN {
|
|
// The alignment requirement exceeds the slab guarantee, thus try to enlarge the size
|
|
// to use the "power-of-two" size/alignment guarantee (see comments in `kmalloc()` for
|
|
// more information).
|
|
//
|
|
// Note that `layout.size()` (after padding) is guaranteed to be a multiple of
|
|
// `layout.align()`, so `next_power_of_two` gives enough alignment guarantee.
|
|
size = size.next_power_of_two();
|
|
}
|
|
|
|
// SAFETY:
|
|
// - `ptr` is either null or a pointer returned from a previous `k{re}alloc()` by the
|
|
// function safety requirement.
|
|
// - `size` is greater than 0 since it's either a `layout.size()` (which cannot be zero
|
|
// according to the function safety requirement) or a result from `next_power_of_two()`.
|
|
unsafe { bindings::krealloc(ptr as *const core::ffi::c_void, size, flags) as *mut u8 }
|
|
}
|
|
|
|
unsafe impl GlobalAlloc for KernelAllocator {
|
|
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
|
|
// requirement.
|
|
unsafe { krealloc_aligned(ptr::null_mut(), layout, bindings::GFP_KERNEL) }
|
|
}
|
|
|
|
unsafe fn dealloc(&self, ptr: *mut u8, _layout: Layout) {
|
|
unsafe {
|
|
bindings::kfree(ptr as *const core::ffi::c_void);
|
|
}
|
|
}
|
|
|
|
unsafe fn realloc(&self, ptr: *mut u8, layout: Layout, new_size: usize) -> *mut u8 {
|
|
// SAFETY:
|
|
// - `new_size`, when rounded up to the nearest multiple of `layout.align()`, will not
|
|
// overflow `isize` by the function safety requirement.
|
|
// - `layout.align()` is a proper alignment (i.e. not zero and must be a power of two).
|
|
let layout = unsafe { Layout::from_size_align_unchecked(new_size, layout.align()) };
|
|
|
|
// SAFETY:
|
|
// - `ptr` is either null or a pointer allocated by this allocator by the function safety
|
|
// requirement.
|
|
// - the size of `layout` is not zero because `new_size` is not zero by the function safety
|
|
// requirement.
|
|
unsafe { krealloc_aligned(ptr, layout, bindings::GFP_KERNEL) }
|
|
}
|
|
|
|
unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8 {
|
|
// SAFETY: `ptr::null_mut()` is null and `layout` has a non-zero size by the function safety
|
|
// requirement.
|
|
unsafe {
|
|
krealloc_aligned(
|
|
ptr::null_mut(),
|
|
layout,
|
|
bindings::GFP_KERNEL | bindings::__GFP_ZERO,
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[global_allocator]
|
|
static ALLOCATOR: KernelAllocator = KernelAllocator;
|
|
|
|
// See <https://github.com/rust-lang/rust/pull/86844>.
|
|
#[no_mangle]
|
|
static __rust_no_alloc_shim_is_unstable: u8 = 0;
|