From nobody Thu Oct 9 06:10:04 2025 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 CAFFA238150 for ; Fri, 20 Jun 2025 08:30:09 +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=1750408212; cv=none; b=tRzmPhXmQzzqShncJ/L2YtPMb9/tiHL8hyGl2HoRVlFGPKe2jwAmTCwiSUQCwKwL/8mVAXptc/JqzAm9Rka38sxy2e0u/gtZLfpwWrFLcuUc7CtdKzdOh1VC5oZh4rLjRgoGq9+HkaCSz33E55ty1fFgmEiQa8R5mNImAzbVgCo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1750408212; c=relaxed/simple; bh=udgM+Sq56yMrzT/5owzskj9iU4Mb1OCgGN9LmDwwnEI=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=RqMT/vI0MP27AGYuPju5Z1q8aTO3nQpO7HTVND801ZzWUUx/V4jvg740jUX6sowSBX+VVg2P3H2xoSLYu0stbHWAEvBDNyhBW6y61LGey/9jtIycNRTIa7/3OAvqEDIBLzwTNtQx7PNANdpO20/ut6mMc6kuGcHsLQbXdJLRuqk= 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=wgjXndRU; 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="wgjXndRU" Received: by mail-wm1-f73.google.com with SMTP id 5b1f17b1804b1-4535ee06160so11631105e9.3 for ; Fri, 20 Jun 2025 01:30:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1750408208; x=1751013008; 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=HD6UnVkJEIqH9XvqrNSYE/LNdHPHv5R8hXW6Cr+NEcI=; b=wgjXndRULX1rRt/6Tzg5+4Qrg7cHEnePf1r66ZklHgzsD12NE76V5tr2wh/eLtmWp/ i9c0ySOu+MtwGSVFiKQ2KIIVbTsfYSYPmt7DcRFuuvRBLFSVgQryYEHI9TO1vCsGJZq5 FaN4qFWITy0JnGYDuutLZy2ozO1LiLv0NAYigrjk8iEXTaAMKtohUTtAoB2Trx4jcNkp CROAuWPdYkJltVUsIuJpYqtyLBeeZTWWNDrQz0giwPzkWmPz1fvJaYz+2/NHPY/Atg02 VD7+6GgvFWfHv4x6rx2C5Dn8avDsxWIYw+s4Twcc6fYVH/PbBuII1wCHLy7IB83KW8AW yD4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1750408208; x=1751013008; 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=HD6UnVkJEIqH9XvqrNSYE/LNdHPHv5R8hXW6Cr+NEcI=; b=oagRxo+bCxs8NLrA2z+SUbmfSrjxsSioKMO6VNMtJ6HLfcH+DKNIaCVOycTNtguvFR V1a8NauVr/0nd7ZMbMiA4qTmkdZLrZO+AoLhL6gaJjWcAcjKq4jfzSbjBs53r7dZbufU QCDGKHbrfsNEd2OYEzP5CfQob7TTau9j1Ik5U5O/nebT+2ooPtbeHl17K2MhwFg5MY/U EtMk38f4Y289CJvrh8DJWChe5nrQ7raRIlh84Ak+RrL2yUFMsadJnbMypJm3970zOmnB snXbngRD897/SsF/ildSb3t6ZxJ+43u0E3yGQiZXzpG/tga9OZJC+tozAo1t+cmzUkBY kpbg== X-Forwarded-Encrypted: i=1; AJvYcCVFF/KVerqMAp1ww17AcWQ5aSz6Dec56nw291/AcjEV+oM+eeqk9sWhPFh/TAJ8foOpsFfqfwoDomf473M=@vger.kernel.org X-Gm-Message-State: AOJu0Yw+d0yNNhQOxFYu2YXi43I7qSd8CyvaRfly/SRMtc9qEbe+nilh dFf+ELsRyoYd5NYrTR+IMFY6yuurNXXI0/J6ViZOfJzXVms37LopOCT0zQppaK0X2IsFLA== X-Google-Smtp-Source: AGHT+IEytus7gdwzUzFp8O4yml9IDUK85CsfOWidMCZ70ew//tOJacPUcXX+J7iQW0rz7U9O3HoogQs= X-Received: from wmbep25.prod.google.com ([2002:a05:600c:8419:b0:440:5d62:5112]) (user=bqe job=prod-delivery.src-stubby-dispatcher) by 2002:a05:600c:4e8a:b0:43d:1b74:e89a with SMTP id 5b1f17b1804b1-453659ca684mr17982585e9.9.1750408208195; Fri, 20 Jun 2025 01:30:08 -0700 (PDT) Date: Fri, 20 Jun 2025 08:29:49 +0000 In-Reply-To: <20250620082954.540955-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: <20250620082954.540955-1-bqe@google.com> X-Mailer: git-send-email 2.50.0.rc2.761.g2dc52ea45b-goog Message-ID: <20250620082954.540955-5-bqe@google.com> Subject: [PATCH v13 4/5] rust: add find_bit_benchmark_rust module. 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" , Carlos LLama , Pekka Ristola , 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" Microbenchmark protected by a config FIND_BIT_BENCHMARK_RUST, following `find_bit_benchmark.c` but testing the Rust Bitmap API. We add a fill_random() method protected by the config in order to maintain the abstraction. The sample output from the benchmark, both C and Rust version: find_bit_benchmark.c output: ``` Start testing find_bit() with random-filled bitmap [ 438.101937] find_next_bit: 860188 ns, 163419 iterations [ 438.109471] find_next_zero_bit: 912342 ns, 164262 iterations [ 438.116820] find_last_bit: 726003 ns, 163419 iterations [ 438.130509] find_nth_bit: 7056993 ns, 16269 iterations [ 438.139099] find_first_bit: 1963272 ns, 16270 iterations [ 438.173043] find_first_and_bit: 27314224 ns, 32654 iterations [ 438.180065] find_next_and_bit: 398752 ns, 73705 iterations [ 438.186689] Start testing find_bit() with sparse bitmap [ 438.193375] find_next_bit: 9675 ns, 656 iterations [ 438.201765] find_next_zero_bit: 1766136 ns, 327025 iterations [ 438.208429] find_last_bit: 9017 ns, 656 iterations [ 438.217816] find_nth_bit: 2749742 ns, 655 iterations [ 438.225168] find_first_bit: 721799 ns, 656 iterations [ 438.231797] find_first_and_bit: 2819 ns, 1 iterations [ 438.238441] find_next_and_bit: 3159 ns, 1 iterations ``` find_bit_benchmark_rust.rs output: ``` [ 451.182459] find_bit_benchmark_rust: [ 451.186688] Start testing find_bit() Rust with random-filled bitmap [ 451.194450] next_bit: 777950 ns, 163644 iterations [ 451.201997] next_zero_bit: 918889 ns, 164036 iterations [ 451.208642] Start testing find_bit() Rust with sparse bitmap [ 451.214300] next_bit: 9181 ns, 654 iterations [ 451.222806] next_zero_bit: 1855504 ns, 327026 iterations ``` Here are the results from 32 samples, with 95% confidence interval. The microbenchmark was built with RUST_BITMAP_HARDENED=3Dn and run on a machine that did not execute other processes. Random-filled bitmap: +-----------+-------+-----------+--------------+-----------+-----------+ | Benchmark | Lang | Mean (ms) | Std Dev (ms) | 95% CI Lo | 95% CI Hi | +-----------+-------+-----------+--------------+-----------+-----------+ | find_bit/ | C | 825.07 | 53.89 | 806.40 | 843.74 | | next_bit | Rust | 870.91 | 46.29 | 854.88 | 886.95 | +-----------+-------+-----------+--------------+-----------+-----------+ | find_zero/| C | 933.56 | 56.34 | 914.04 | 953.08 | | next_zero | Rust | 945.85 | 60.44 | 924.91 | 966.79 | +-----------+-------+-----------+--------------+-----------+-----------+ Rust appears 5.5% slower for next_bit, 1.3% slower for next_zero. Sparse bitmap: +-----------+-------+-----------+--------------+-----------+-----------+ | Benchmark | Lang | Mean (ms) | Std Dev (ms) | 95% CI Lo | 95% CI Hi | +-----------+-------+-----------+--------------+-----------+-----------+ | find_bit/ | C | 13.17 | 6.21 | 11.01 | 15.32 | | next_bit | Rust | 14.30 | 8.27 | 11.43 | 17.17 | +-----------+-------+-----------+--------------+-----------+-----------+ | find_zero/| C | 1859.31 | 82.30 | 1830.80 | 1887.83 | | next_zero | Rust | 1908.09 | 139.82 | 1859.65 | 1956.54 | +-----------+-------+-----------+--------------+-----------+-----------+ Rust appears 8.5% slower for next_bit, 2.6% slower for next_zero. In summary, taking the arithmetic mean of all slow-downs, we can say the Rust API has a 4.5% slowdown. Suggested-by: Alice Ryhl Suggested-by: Yury Norov [NVIDIA] Reviewed-by: Yury Norov [NVIDIA] Signed-off-by: Burak Emir --- MAINTAINERS | 1 + lib/Kconfig.debug | 13 ++++ lib/Makefile | 1 + lib/find_bit_benchmark_rust.rs | 103 ++++++++++++++++++++++++++++++++ rust/bindings/bindings_helper.h | 1 + rust/kernel/bitmap.rs | 15 +++++ 6 files changed, 134 insertions(+) create mode 100644 lib/find_bit_benchmark_rust.rs diff --git a/MAINTAINERS b/MAINTAINERS index b7944346afbf..92511c925db8 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4208,6 +4208,7 @@ M: Alice Ryhl M: Burak Emir R: Yury Norov S: Maintained +F: lib/find_bit_benchmark_rust.rs F: rust/kernel/bitmap.rs =20 BITOPS API diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index ebe33181b6e6..19e8275d3f29 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -2598,6 +2598,19 @@ config FIND_BIT_BENCHMARK =20 If unsure, say N. =20 +config FIND_BIT_BENCHMARK_RUST + tristate "Test find_bit functions in Rust" + depends on RUST + help + This builds the "find_bit_benchmark_rust" module. It is a micro + benchmark that measures the performance of Rust functions that + correspond to the find_*_bit() operations in C. It follows the + FIND_BIT_BENCHMARK closely but will in general not yield same + numbers due to extra bounds checks and overhead of foreign + function calls. + + If unsure, say N. + config TEST_FIRMWARE tristate "Test firmware loading via userspace interface" depends on FW_LOADER diff --git a/lib/Makefile b/lib/Makefile index c38582f187dd..d0cf5c1fedf1 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -62,6 +62,7 @@ obj-y +=3D hexdump.o obj-$(CONFIG_TEST_HEXDUMP) +=3D test_hexdump.o obj-y +=3D kstrtox.o obj-$(CONFIG_FIND_BIT_BENCHMARK) +=3D find_bit_benchmark.o +obj-$(CONFIG_FIND_BIT_BENCHMARK_RUST) +=3D find_bit_benchmark_rust.o obj-$(CONFIG_TEST_BPF) +=3D test_bpf.o test_dhry-objs :=3D dhry_1.o dhry_2.o dhry_run.o obj-$(CONFIG_TEST_DHRY) +=3D test_dhry.o diff --git a/lib/find_bit_benchmark_rust.rs b/lib/find_bit_benchmark_rust.rs new file mode 100644 index 000000000000..adcd14988383 --- /dev/null +++ b/lib/find_bit_benchmark_rust.rs @@ -0,0 +1,103 @@ +// SPDX-License-Identifier: GPL-2.0 +//! Benchmark for find_bit-like methods in Bitmap Rust API. + +use kernel::alloc::flags::GFP_KERNEL; +use kernel::bindings; +use kernel::bitmap::BitmapVec; +use kernel::error::{code, Result}; +use kernel::prelude::module; +use kernel::time::Ktime; +use kernel::ThisModule; +use kernel::{pr_cont, pr_err}; + +const BITMAP_LEN: usize =3D 4096 * 8 * 10; +// Reciprocal of the fraction of bits that are set in sparse bitmap. +const SPARSENESS: usize =3D 500; + +/// Test module that benchmarks performance of traversing bitmaps. +struct Benchmark(); + +fn test_next_bit(bitmap: &BitmapVec) { + let mut time =3D Ktime::ktime_get(); + let mut cnt =3D 0; + let mut i =3D 0; + + while let Some(index) =3D bitmap.next_bit(i) { + cnt +=3D 1; + i =3D index + 1; + // CONFIG_RUST_BITMAP_HARDENED enforces strict bounds. + if i =3D=3D BITMAP_LEN { + break; + } + } + + time =3D Ktime::ktime_get() - time; + pr_cont!( + "next_bit: {:18} ns, {:6} iterations\n", + time.to_ns(), + cnt + ); +} + +fn test_next_zero_bit(bitmap: &BitmapVec) { + let mut time =3D Ktime::ktime_get(); + let mut cnt =3D 0; + let mut i =3D 0; + + while let Some(index) =3D bitmap.next_zero_bit(i) { + cnt +=3D 1; + i =3D index + 1; + // CONFIG_RUST_BITMAP_HARDENED enforces strict bounds. + if i =3D=3D BITMAP_LEN { + break; + } + } + + time =3D Ktime::ktime_get() - time; + pr_cont!( + "next_zero_bit: {:18} ns, {:6} iterations\n", + time.to_ns(), + cnt + ); +} + +fn find_bit_test() { + pr_err!("\n"); + pr_cont!("Start testing find_bit() Rust with random-filled bitmap\n"); + + let mut bitmap =3D BitmapVec::new(BITMAP_LEN, GFP_KERNEL).expect("allo= c bitmap failed"); + bitmap.fill_random(); + + test_next_bit(&bitmap); + test_next_zero_bit(&bitmap); + + pr_cont!("Start testing find_bit() Rust with sparse bitmap\n"); + + let mut bitmap =3D BitmapVec::new(BITMAP_LEN, GFP_KERNEL).expect("allo= c sparse bitmap failed"); + let nbits =3D BITMAP_LEN / SPARSENESS; + for _i in 0..nbits { + // SAFETY: __get_random_u32_below is safe to call with any u32 arg= ument. + let bit: usize =3D + unsafe { bindings::__get_random_u32_below(BITMAP_LEN.try_into(= ).unwrap()) as _ }; + bitmap.set_bit(bit); + } + + test_next_bit(&bitmap); + test_next_zero_bit(&bitmap); +} + +impl kernel::Module for Benchmark { + fn init(_module: &'static ThisModule) -> Result { + find_bit_test(); + // Return error so test module can be inserted again without rmmod. + Err(code::EINVAL) + } +} + +module! { + type: Benchmark, + name: "find_bit_benchmark_rust", + authors: ["Burak Emir "], + description: "Module with benchmark for bitmap Rust API", + license: "GPL v2", +} diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helpe= r.h index cc2ae3b172da..b1334261be6e 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -65,6 +65,7 @@ #include #include #include +#include #include #include #include diff --git a/rust/kernel/bitmap.rs b/rust/kernel/bitmap.rs index a3cd0d4f6970..f1bb742e601b 100644 --- a/rust/kernel/bitmap.rs +++ b/rust/kernel/bitmap.rs @@ -252,6 +252,21 @@ pub fn new(nbits: usize, flags: Flags) -> Result { pub fn len(&self) -> usize { self.nbits } + + /// Fills this `Bitmap` with random bits. + #[cfg(CONFIG_FIND_BIT_BENCHMARK_RUST)] + pub fn fill_random(&mut self) { + // SAFETY: `self.as_mut_ptr` points to either an array of the + // appropriate length or one usize. + unsafe { + bindings::get_random_bytes( + self.as_mut_ptr() as *mut ffi::c_void, + usize::div_ceil(self.nbits, bindings::BITS_PER_LONG as usi= ze) + * bindings::BITS_PER_LONG as usize + / 8, + ); + } + } } =20 impl Bitmap { --=20 2.50.0.rc2.761.g2dc52ea45b-goog