From nobody Sat Feb 7 06:38:30 2026 Received: from mail-wm1-f73.google.com (mail-wm1-f73.google.com [209.85.128.73]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 83FE42144DD for ; Mon, 26 May 2025 15:01:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748271715; cv=none; b=T+7gRYddkvS/vfT/dT4zHyhQUrdpYxGES76Su5SFuDhAj4DOKrpSg6d0DA2/HptNqAp3ABHvFHCjkIPjWM/mitc1+4N696vw8VHreWRMwkelVgR/5p9frEus8B156MtudYCX8HSLtwRRD2JdcxrMnsAJB6tcsnTulBeY9eqoyhA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748271715; c=relaxed/simple; bh=PKsjk27z4abQDNpJJfmLI6eiiaH9g2ZMd7BW7glP2vI=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=lEcKKRSAIyf+WPvPDd7SqIsoyHi5yxjOaWYmPNvHZ3Vv7IiVSPSmoz015lmIC4qfFnO9fpbT2gu5WyNdOA9X7fCjRklSxmxuEA5S8I0kbI30fVJE+iVVR6CZ1J0BSl1OD/sNdEstAagCVPFh5ADw0HZF9MV8hQ+QXfmxxcvv3is= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--bqe.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=yhj/c/hX; arc=none smtp.client-ip=209.85.128.73 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--bqe.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="yhj/c/hX" Received: by mail-wm1-f73.google.com with SMTP id 5b1f17b1804b1-445135eb689so15408555e9.2 for ; Mon, 26 May 2025 08:01:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1748271711; x=1748876511; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=1/PTjKCdteP0OqZ3DGTwyCRcaawNKa8OcZ7BGqbI7xw=; b=yhj/c/hXAXDXNpUkukfvJq4zlAw6FBTnxo13cCfCQletJy6HolpQw4L4IK0Liv17/N cyIy5t8wAhx+vnGOpI9UqMqDPFG5Z9ssyeThdzYKLAkEzPxswiOej9IEd8CfI4qCM5yQ nqPlntlL/I89FTopnr09jHE2e0h997VJPi/naA3kEQ0ear3pAM9CCmccUSFPFh9Pc/Ao dzf+GfFp75pzN6DZI1O+HVCmcHW4CCe7fdyXiuz6Hf9pF2SKtN/OB07InMNtauOcH8Sg Qa1NdvxYfkQIEYT4ToVIMV3Q7oFkuRUSlecKAF4rCDMV6Y32Um90dTLHTqHcwxvElISS X1Rg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1748271711; x=1748876511; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=1/PTjKCdteP0OqZ3DGTwyCRcaawNKa8OcZ7BGqbI7xw=; b=TfdQGvZImlDTNFffWoi98KyH4WgOuuDieFdMMLVBeAEOcg3+pxh7YGmFJft9fd8vST +8uPGDixIMQHRoMP1Ldi/jvA5uO22mLZI9Km71asqg6jhfN+lRPnN1JlVNTxH4RjOlKX j55UJg/12E7aeMCQ/YzECxittouqhDFnDqPPP5rca9DvU9K2LC09tsReHVePSV2evDbC 6Ve9Cbfv2B05xhohIok1UAjHw01xhSHPROZgMuVTAAY9PcUbMfM6NQ9Lwk9gTvXz1Dca A/nDxQmoedZtuVW3Fga+QYQTLoFkvhGUxjbojU1HGfUdjJGNpb6T0YtmBNP5VkN5GuMP v/Vw== X-Forwarded-Encrypted: i=1; AJvYcCX381h0jCuwejyWCYymgS0Ll0dnBXqy9mGIm6DBFs4+lBJ26B1uznWJM1ppfSASLRAJm/m8wequbJ0T8Xc=@vger.kernel.org X-Gm-Message-State: AOJu0Yy3XPPSKBJVwEi5lMIV/X3nXgq4JM9NIATCh61Zx3wU6U4ZK0RG Ry+0xjsOczIgW2IknxqSrnvhI4LT1E4xdtocawYD3nWETXRfWAq6TDcoL0S9w5bxj882rQ== X-Google-Smtp-Source: AGHT+IGGuKNPwwb2aDQQ5UOLvSXsXlob1l+Tjy5F5tyMEDq9rwIreqcQT+oqsUK6OZ8BDUCtV6Flewc= X-Received: from wmrm3.prod.google.com ([2002:a05:600c:37c3:b0:442:cab2:15c3]) (user=bqe job=prod-delivery.src-stubby-dispatcher) by 2002:a05:600c:26d1:b0:43b:cb12:ba6d with SMTP id 5b1f17b1804b1-44c9465aff1mr70984135e9.3.1748271711196; Mon, 26 May 2025 08:01:51 -0700 (PDT) Date: Mon, 26 May 2025 15:01:32 +0000 In-Reply-To: <20250526150141.3407433-1-bqe@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250526150141.3407433-1-bqe@google.com> X-Mailer: git-send-email 2.49.0.1151.ga128411c76-goog Message-ID: <20250526150141.3407433-4-bqe@google.com> Subject: [PATCH v9 3/5] rust: add bitmap API. From: Burak Emir To: Yury Norov , Kees Cook Cc: Burak Emir , Rasmus Villemoes , Viresh Kumar , Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , "=?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?=" , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross , "Gustavo A . R . Silva" , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, linux-hardening@vger.kernel.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Provides an abstraction for C bitmap API and bitops operations. This commit enables a Rust implementation of an Android Binder data structure from commit 15d9da3f818c ("binder: use bitmap for faster descriptor lookup"), which can be found in drivers/android/dbitmap.h. It is a step towards upstreaming the Rust port of Android Binder driver. We follow the C Bitmap API closely in naming and semantics, with a few differences that take advantage of Rust language facilities and idioms: * We leverage Rust type system guarantees as follows: * all (non-atomic) mutating operations require a &mut reference which amounts to exclusive access. * the Bitmap type implements Send. This enables transferring ownership between threads and is needed for Binder. * the Bitmap type implements Sync, which enables passing shared references &Bitmap between threads. Atomic operations can be used to safely modify from multiple threads (interior mutability), though without ordering guarantees. * The Rust API uses `{set,clear}_bit` vs `{set,clear}_bit_atomic` as names, which differs from the C naming convention which uses set_bit for atomic vs __set_bit for non-atomic. * we include enough operations for the API to be useful, but not all operations are exposed yet in order to avoid dead code. The missing ones can be added later. * We follow the C API closely with a fine-grained approach to safety: * Low-level bit-ops get a safe API with bounds checks. Calling with an out-of-bounds arguments to {set,clear}_bit becomes a no-op and get logged as errors. * We introduce a RUST_BITMAP_HARDENED config, which causes invocations with out-of-bounds arguments to panic. * methods correspond to find_* C methods tolerate out-of-bounds since the C implementation does. Also here, we log out-of-bounds arguments as errors and panic in RUST_BITMAP_HARDENED mode. * We add a way to "borrow" bitmaps from C in Rust, to make C bitmaps that were allocated in C directly usable in Rust code (`CBitmap`). * the Rust API is optimized to represent the bitmap inline if it would fit into a pointer. This saves allocations which is relevant in the Binder use case. The underlying C bitmap is *not* exposed, and must never be exposed (except in tests). Exposing the representation of the owned bitmap would lose static guarantees. An alternative route of vendoring an existing Rust bitmap package was considered but suboptimal overall. Reusing the C implementation is preferable for a basic data structure like bitmaps. It enables Rust code to be a lot more similar and predictable with respect to C code that uses the same data structures and enables the use of code that has been tried-and-tested in the kernel, with the same performance characteristics whenever possible. We use the `usize` type for sizes and indices into the bitmap, because Rust generally always uses that type for indices and lengths and it will be more convenient if the API accepts that type. This means that we need to perform some casts to/from u32 and usize, since the C headers use unsigned int instead of size_t/unsigned long for these numbers in some places. Adds new MAINTAINERS section BITMAP API [RUST]. Suggested-by: Alice Ryhl Suggested-by: Yury Norov Signed-off-by: Burak Emir --- MAINTAINERS | 7 + rust/kernel/bitmap.rs | 554 +++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + security/Kconfig.hardening | 10 + 4 files changed, 572 insertions(+) create mode 100644 rust/kernel/bitmap.rs diff --git a/MAINTAINERS b/MAINTAINERS index 04d6727e944c..565eaa015d9e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4127,6 +4127,13 @@ S: Maintained F: rust/helpers/bitmap.c F: rust/helpers/cpumask.c =20 +BITMAP API [RUST] +M: Alice Ryhl +M: Burak Emir +R: Yury Norov +S: Maintained +F: rust/kernel/bitmap.rs + BITOPS API M: Yury Norov R: Rasmus Villemoes diff --git a/rust/kernel/bitmap.rs b/rust/kernel/bitmap.rs new file mode 100644 index 000000000000..a6edd4889518 --- /dev/null +++ b/rust/kernel/bitmap.rs @@ -0,0 +1,554 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2025 Google LLC. + +//! Rust API for bitmap. +//! +//! C headers: [`include/linux/bitmap.h`](srctree/include/linux/bitmap.h). + +use crate::alloc::{AllocError, Flags}; +use crate::bindings; +use crate::pr_err; +use core::ptr::NonNull; + +/// Represents a C bitmap. Wraps underlying C bitmap API. +/// +/// # Invariants +/// +/// Must reference a `[c_ulong]` long enough to fit `data.len()` bits. +pub struct CBitmap { + _align: [usize; 0], + data: [()], +} + +impl CBitmap { + /// Borrows a C bitmap. + /// + /// # Safety + /// + /// * `ptr` holds a non-null address of an initialized array of `unsig= ned long` + /// that is large enough to hold `nbits` bits. + /// * the array must not be freed for the lifetime of this [`CBitmap`] + /// * concurrent access only happens through atomic operations + pub unsafe fn from_raw<'a>(ptr: *const usize, nbits: usize) -> &'a CBi= tmap { + let data: *const [()] =3D core::ptr::slice_from_raw_parts(ptr.cast= (), nbits); + unsafe { &*(data as *const CBitmap) } + } + + /// Borrows a C bitmap exclusively. + /// + /// # Safety + /// + /// * `ptr` holds a non-null address of an initialized array of `unsig= ned long` + /// that is large enough to hold `nbits` bits. + /// * the array must not be freed for the lifetime of this [`CBitmap`] + /// * no concurrent access may happen. + pub unsafe fn from_raw_mut<'a>(ptr: *mut usize, nbits: usize) -> &'a m= ut CBitmap { + let data: *mut [()] =3D core::ptr::slice_from_raw_parts_mut(ptr.ca= st(), nbits); + unsafe { &mut *(data as *mut CBitmap) } + } + + /// Returns a raw pointer to the backing [`Bitmap`]. + pub fn as_ptr(&self) -> *const usize { + self as *const CBitmap as *const usize + } + + /// Returns a mutable raw pointer to the backing [`Bitmap`]. + pub fn as_mut_ptr(&mut self) -> *mut usize { + self as *mut CBitmap as *mut usize + } + + /// Returns length of this [`CBitmap`]. + pub fn len(&self) -> usize { + self.data.len() + } +} + +/// Holds either a pointer to array of `unsigned long` or a small bitmap. +#[repr(C)] +union BitmapRepr { + bitmap: usize, + ptr: NonNull, +} + +macro_rules! bitmap_assert { + ($cond:expr, $($arg:tt)+) =3D> { + #[cfg(RUST_BITMAP_HARDENED)] + assert!($e, $($arg)*); + } +} + +macro_rules! bitmap_assert_return { + ($cond:expr, $($arg:tt)+) =3D> { + #[cfg(RUST_BITMAP_HARDENED)] + assert!($e, $($arg)*); + + #[cfg(not(RUST_BITMAP_HARDENED))] + if !($cond) { + pr_err!($($arg)*); + return + } + } +} + +/// Represents an owned bitmap. +/// +/// Wraps underlying C bitmap API. See [`CBitmap`] for available +/// methods. +/// +/// # Examples +/// +/// Basic usage +/// +/// ``` +/// use kernel::alloc::flags::GFP_KERNEL; +/// use kernel::bitmap::Bitmap; +/// +/// let mut b =3D Bitmap::new(16, GFP_KERNEL)?; +/// +/// assert_eq!(16, b.len()); +/// for i in 0..16 { +/// if i % 4 =3D=3D 0 { +/// b.set_bit(i); +/// } +/// } +/// assert_eq!(Some(0), b.next_bit(0)); +/// assert_eq!(Some(1), b.next_zero_bit(0)); +/// assert_eq!(Some(4), b.next_bit(1)); +/// assert_eq!(Some(5), b.next_zero_bit(4)); +/// assert_eq!(Some(12), b.last_bit()); +/// # Ok::<(), Error>(()) +/// ``` +/// +/// # Invariants +/// +/// * `inner.nbits` is `<=3D i32::MAX` and never changes. +/// * if `inner.nbits <=3D bindings::BITS_PER_LONG`, then `inner.repr` is +/// a `usize`. +/// * otherwise, `inner.repr` holds a non-null pointer to an initialized +/// array of `unsigned long` that is large enough to hold `nbits` bits. +pub struct Bitmap { + /// Representation of bitmap. + repr: BitmapRepr, + /// Length of this bitmap. Must be `<=3D i32::MAX`. + nbits: usize, +} + +impl core::ops::Deref for Bitmap { + type Target =3D CBitmap; + + fn deref(&self) -> &CBitmap { + let ptr =3D if self.nbits <=3D bindings::BITS_PER_LONG as _ { + // SAFETY: Bitmap is represented inline. + unsafe { core::ptr::addr_of!(self.repr.bitmap) } + } else { + // SAFETY: Bitmap is represented as array of `unsigned long`. + unsafe { self.repr.ptr.as_ptr() } + }; + + // SAFETY: We got the right pointer and invariants of [`Bitmap`] h= old. + // An inline bitmap is treated like an array with single element. + unsafe { CBitmap::from_raw(ptr, self.nbits) } + } +} + +impl core::ops::DerefMut for Bitmap { + fn deref_mut(&mut self) -> &mut CBitmap { + let ptr =3D if self.nbits <=3D bindings::BITS_PER_LONG as _ { + // SAFETY: Bitmap is represented inline. + unsafe { core::ptr::addr_of_mut!(self.repr.bitmap) } + } else { + // SAFETY: Bitmap is represented as array of `unsigned long`. + unsafe { self.repr.ptr.as_mut() } + }; + + // SAFETY: We got the right pointer and invariants of [`Bitmap`] h= old. + // An inline bitmap is treated like an array with single element. + unsafe { CBitmap::from_raw_mut(ptr, self.nbits) } + } +} + +/// Enable ownership transfer to other threads. +/// +/// # Safety +/// +/// We own the underlying bitmap representation. +unsafe impl Send for Bitmap {} + +/// Enable unsynchronized concurrent access to [`Bitmap`] through shared r= eferences. +/// +/// # Safety +/// +/// * When no thread performs any mutations, concurrent access is safe. +/// * Mutations are permitted through atomic operations and interior mutab= ility. +/// All such methods are marked unsafe, to account for the lack of order= ing +/// guarantees. Callers must acknowledge that updates may be observed in= any +/// order. +unsafe impl Sync for Bitmap {} + +impl Drop for Bitmap { + fn drop(&mut self) { + if self.nbits <=3D bindings::BITS_PER_LONG as _ { + return; + } + // SAFETY: `self.ptr` was returned by the C `bitmap_zalloc`. + // + // INVARIANT: there is no other use of the `self.ptr` after this + // call and the value is being dropped so the broken invariant is + // not observable on function exit. + unsafe { bindings::bitmap_free(self.repr.ptr.as_ptr()) }; + } +} + +impl Bitmap { + /// Constructs a new [`Bitmap`]. + /// + /// Fails with [`AllocError`] when the [`Bitmap`] could not be allocat= ed. This + /// includes the case when `nbits` is greater than `i32::MAX`. + #[inline] + pub fn new(nbits: usize, flags: Flags) -> Result { + if nbits <=3D bindings::BITS_PER_LONG as _ { + return Ok(Bitmap { + repr: BitmapRepr { bitmap: 0 }, + nbits, + }); + } + if nbits > i32::MAX.try_into().unwrap() { + return Err(AllocError); + } + let nbits_u32 =3D u32::try_from(nbits).unwrap(); + // SAFETY: `bindings::BITS_PER_LONG < nbits` and `nbits <=3D i32::= MAX`. + let ptr =3D unsafe { bindings::bitmap_zalloc(nbits_u32, flags.as_r= aw()) }; + let ptr =3D NonNull::new(ptr).ok_or(AllocError)?; + // INVARIANT: `ptr` returned by C `bitmap_zalloc` and `nbits` chec= ked. + return Ok(Bitmap { + repr: BitmapRepr { ptr }, + nbits, + }); + } + + /// Returns length of this [`CBitmap`]. + #[inline] + pub fn len(&self) -> usize { + self.nbits + } +} + +impl CBitmap { + /// Set bit with index `index`. + /// + /// ATTENTION: `set_bit` is non-atomic, which differs from the naming + /// convention in C code. The corresponding C function is `__set_bit`. + /// + /// If RUST_BITMAP_HARDENED is not enabled and `index` is greater than + /// or equal to `self.nbits`, does nothing. + /// + /// # Panics + /// + /// Panics if RUST_BITMAP_HARDENED is enabled and `index` is greater t= han + /// or equal to `self.nbits`. + #[inline] + pub fn set_bit(&mut self, index: usize) { + bitmap_assert_return!( + index < self.len(), + "Bit `index` must be < {}, was {}", + self.len(), + index + ); + // SAFETY: Bit `index` is within bounds. + unsafe { bindings::__set_bit(index as u32, self.as_mut_ptr()) }; + } + + /// Set bit with index `index`, atomically. + /// + /// This is a relaxed atomic operation (no implied memory barriers). + /// + /// ATTENTION: The naming convention differs from C, where the corresp= onding + /// function is called `set_bit`. + /// + /// If RUST_BITMAP_HARDENED is not enabled and `index` is greater than + /// or equal to `self.len()`, does nothing. + /// + /// # Panics + /// + /// Panics if RUST_BITMAP_HARDENED is enabled and `index` is greater t= han + /// or equal to `self.len()`. + #[inline] + pub fn set_bit_atomic(&self, index: usize) { + bitmap_assert_return!( + index < self.len(), + "Bit `index` must be < {}, was {}", + self.len(), + index + ); + // SAFETY: `index` is within bounds and the caller has ensured that + // there is no mix of non-atomic and atomic operations. + unsafe { bindings::set_bit(index as u32, self.as_ptr() as *mut usi= ze) }; + } + + /// Clear `index` bit. + /// + /// ATTENTION: `clear_bit` is non-atomic, which differs from the naming + /// convention in C code. The corresponding C function is `__clear_bit= `. + /// + /// If RUST_BITMAP_HARDENED is not enabled and `index` is greater than + /// or equal to `self.len()`, does nothing. + /// + /// # Panics + /// + /// Panics if RUST_BITMAP_HARDENED is enabled and `index` is greater t= han + /// or equal to `self.len()`. + #[inline] + pub fn clear_bit(&mut self, index: usize) { + bitmap_assert_return!( + index < self.len(), + "Bit `index` must be < {}, was {}", + self.len(), + index + ); + // SAFETY: `index` is within bounds. + unsafe { bindings::__clear_bit(index as u32, self.as_mut_ptr()) }; + } + + /// Clear `index` bit, atomically. + /// + /// This is a relaxed atomic operation (no implied memory barriers). + /// + /// ATTENTION: The naming convention differs from C, where the corresp= onding + /// function is called `clear_bit`. + /// + /// If RUST_BITMAP_HARDENED is not enabled and `index` is greater than + /// or equal to `self.len()`, does nothing. + /// + /// # Panics + /// + /// Panics if RUST_BITMAP_HARDENED is enabled and `index` is greater t= han + /// or equal to `self.len()`. + #[inline] + pub fn clear_bit_atomic(&self, index: usize) { + bitmap_assert_return!( + index < self.len(), + "Bit `index` must be < {}, was {}", + self.len(), + index + ); + // SAFETY: `index` is within bounds and the caller has ensured that + // there is no mix of non-atomic and atomic operations. + unsafe { bindings::clear_bit(index as u32, self.as_ptr() as *mut u= size) }; + } + + /// Copy `src` into this [`Bitmap`] and set any remaining bits to zero. + /// + /// # Examples + /// + /// ``` + /// use kernel::alloc::{AllocError, flags::GFP_KERNEL}; + /// use kernel::bitmap::Bitmap; + /// + /// let mut long_bitmap =3D Bitmap::new(256, GFP_KERNEL)?; + // + /// assert_eq!(None, long_bitmap.last_bit()); + // + /// let mut short_bitmap =3D Bitmap::new(16, GFP_KERNEL)?; + // + /// short_bitmap.set_bit(7); + /// long_bitmap.copy_and_extend(&short_bitmap); + /// assert_eq!(Some(7), long_bitmap.last_bit()); + /// + /// # Ok::<(), AllocError>(()) + /// ``` + #[inline] + pub fn copy_and_extend(&mut self, src: &Bitmap) { + let len =3D core::cmp::min(src.nbits, self.len()); + // SAFETY: access to `self` and `src` is within bounds. + unsafe { + bindings::bitmap_copy_and_extend( + self.as_mut_ptr(), + src.as_ptr(), + len as u32, + self.len() as u32, + ) + }; + } + + /// Finds last set bit. + /// + /// # Examples + /// + /// ``` + /// use kernel::alloc::{AllocError, flags::GFP_KERNEL}; + /// use kernel::bitmap::Bitmap; + /// + /// let bitmap =3D Bitmap::new(64, GFP_KERNEL)?; + /// + /// match bitmap.last_bit() { + /// Some(idx) =3D> { + /// pr_info!("The last bit has index {idx}.\n"); + /// } + /// None =3D> { + /// pr_info!("All bits in this bitmap are 0.\n"); + /// } + /// } + /// # Ok::<(), AllocError>(()) + /// ``` + #[inline] + pub fn last_bit(&self) -> Option { + // SAFETY: `_find_next_bit` access is within bounds due to invaria= nt. + let index =3D unsafe { bindings::_find_last_bit(self.as_ptr(), sel= f.len()) }; + if index >=3D self.len() { + None + } else { + Some(index) + } + } + + /// Finds next set bit, starting from `start`. + /// Returns `None` if `start` is greater of equal than `self.nbits`. + #[inline] + pub fn next_bit(&self, start: usize) -> Option { + bitmap_assert!( + start < self.len(), + "`start` must be < {} was {}", + self.len(), + start + ); + // SAFETY: `_find_next_bit` tolerates out-of-bounds arguments and = returns a + // value larger than or equal to `self.len()` in that case. + let index =3D unsafe { bindings::_find_next_bit(self.as_ptr(), sel= f.len(), start) }; + if index >=3D self.len() { + None + } else { + Some(index) + } + } + + /// Finds next zero bit, starting from `start`. + /// Returns `None` if `start` is greater than or equal to `self.len()`. + #[inline] + pub fn next_zero_bit(&self, start: usize) -> Option { + bitmap_assert!( + start < self.len(), + "`start` must be < {} was {}", + self.len(), + start + ); + // SAFETY: `_find_next_zero_bit` tolerates out-of-bounds arguments= and returns a + // value larger than or equal to `self.len()` in that case. + let index =3D unsafe { bindings::_find_next_zero_bit(self.as_ptr()= , self.len(), start) }; + if index >=3D self.len() { + None + } else { + Some(index) + } + } +} + +use macros::kunit_tests; + +#[kunit_tests(rust_kernel_bitmap)] +mod tests { + use super::*; + use kernel::alloc::flags::GFP_KERNEL; + + #[test] + fn cbitmap_borrow() { + let fake_c_bitmap: [usize; 2] =3D [0, 0]; + // SAFETY: `fake_c_bitmap` is an array of expected length. + let b =3D unsafe { + CBitmap::from_raw( + core::ptr::addr_of!(fake_c_bitmap) as *const usize, + 2 * bindings::BITS_PER_LONG as usize, + ) + }; + assert_eq!(2 * bindings::BITS_PER_LONG as usize, b.len()); + assert_eq!(None, b.next_bit(0)); + } + + #[test] + fn cbitmap_copy() { + let fake_c_bitmap: usize =3D 0xFF; + // SAFETY: `fake_c_bitmap` can be used as one-element array of exp= ected length. + let b =3D unsafe { CBitmap::from_raw(core::ptr::addr_of!(fake_c_bi= tmap), 8) }; + assert_eq!(8, b.len()); + assert_eq!(None, b.next_zero_bit(0)); + } + + #[test] + fn bitmap_new() { + let b =3D Bitmap::new(0, GFP_KERNEL).unwrap(); + assert_eq!(0, b.len()); + + let b =3D Bitmap::new(3, GFP_KERNEL).unwrap(); + assert_eq!(3, b.len()); + + let b =3D Bitmap::new(1024, GFP_KERNEL).unwrap(); + assert_eq!(1024, b.len()); + + // Requesting too large values results in [`AllocError`]. + let b =3D Bitmap::new(1 << 31, GFP_KERNEL); + assert!(b.is_err()); + } + + #[test] + fn bitmap_set_clear_find() { + let mut b =3D Bitmap::new(128, GFP_KERNEL).unwrap(); + + // Zero-initialized + assert_eq!(None, b.next_bit(0)); + assert_eq!(Some(0), b.next_zero_bit(0)); + assert_eq!(None, b.last_bit()); + + b.set_bit(17); + + assert_eq!(Some(17), b.next_bit(0)); + assert_eq!(Some(17), b.next_bit(17)); + assert_eq!(None, b.next_bit(18)); + assert_eq!(Some(17), b.last_bit()); + + b.set_bit(107); + + assert_eq!(Some(17), b.next_bit(0)); + assert_eq!(Some(17), b.next_bit(17)); + assert_eq!(Some(107), b.next_bit(18)); + assert_eq!(Some(107), b.last_bit()); + + b.clear_bit(17); + + assert_eq!(Some(107), b.next_bit(0)); + assert_eq!(Some(107), b.last_bit()); + } + + #[cfg(not(RUST_BITMAP_HARDENED))] + #[test] + fn bitmap_out_of_bounds() { + let mut b =3D Bitmap::new(128, GFP_KERNEL).unwrap(); + + b.set_bit(2048); + b.set_bit_atomic(2048); + b.clear_bit(2048); + b.clear_bit_atomic(2048); + assert_eq!(None, b.next_bit(2048)); + assert_eq!(None, b.next_zero_bit(2048)); + assert_eq!(None, b.last_bit()); + } + + // TODO: add test RUST_BITMAP_HARDENED when KUnit supports this type o= f config. + + #[test] + fn bitmap_copy_and_extend() { + let mut long_bitmap =3D Bitmap::new(256, GFP_KERNEL).unwrap(); + + long_bitmap.set_bit(3); + long_bitmap.set_bit(200); + + let mut short_bitmap =3D Bitmap::new(32, GFP_KERNEL).unwrap(); + + short_bitmap.set_bit(17); + + long_bitmap.copy_and_extend(&short_bitmap); + + // Previous bits have been cleared. + assert_eq!(Some(17), long_bitmap.next_bit(0)); + assert_eq!(Some(17), long_bitmap.last_bit()); + } +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index de07aadd1ff5..8c4161cd82ac 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -38,6 +38,7 @@ pub use ffi; =20 pub mod alloc; +pub mod bitmap; #[cfg(CONFIG_BLOCK)] pub mod block; #[doc(hidden)] diff --git a/security/Kconfig.hardening b/security/Kconfig.hardening index 3fe9d7b945c4..3ca3c7dc4381 100644 --- a/security/Kconfig.hardening +++ b/security/Kconfig.hardening @@ -324,6 +324,16 @@ config LIST_HARDENED =20 If unsure, say N. =20 +config RUST_BITMAP_HARDENED + bool "Check integrity of linked list manipulation" + depends on CONFIG_RUST + help + Enables additional assertions in the Rust Bitmap API to catch + arguments that are not guaranteed to result in an immediate access + fault. + + If unsure, say N. + config BUG_ON_DATA_CORRUPTION bool "Trigger a BUG when data corruption is detected" select LIST_HARDENED --=20 2.49.0.1151.ga128411c76-goog