From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pg1-f178.google.com (mail-pg1-f178.google.com [209.85.215.178]) (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 EAA203B47E5 for ; Sat, 29 Aug 2026 15:34:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.178 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1788017690; cv=none; b=UfxxYP57Uvw9Cd8X4A4QCFGKqvUJxCv/reoCQxcT4J/fNIcB1WBqEjKyOsTJaCYA2BxE3bcpOooNCKdaDChscHjB4v2qNUhqNaqcfcL4iTpvuXBPNhAd2rLijBMra/f29YGWEWenNfL5/nSyft8g6cj/GDyQS3ZUz5BQT8MD/Xw= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1788017690; c=relaxed/simple; bh=dQpS8bcH8CRgltsTPv9YRYGMfmW0Rpoj3u9jqx8e+y4=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=gc+qAhjUFZQUJoVbE2xEX8fCb5M8ksuZliAJFjl+LcLw7J7N37tb9Q9ZkrrVj72/4/JO85ooQQsoaHviZBeXcKTISNC745TsHCumYyzFe0r7r2J2U/btvxKo81b5R3ZLvmwobF78/NDhmn6qZu139OtKTf2fLW5jCgr4bWXHoy4= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=oG4VbsvF; arc=none smtp.client-ip=209.85.215.178 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="oG4VbsvF" Received: by mail-pg1-f178.google.com with SMTP id 41be03b00d2f7-ca12086c06eso1551400a12.0 for ; Sat, 29 Aug 2026 08:34:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1788017688; x=1788622488; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to:content-type; bh=HHs8vnCpPDwNyoRpbGWeEHXuEK7fQBuD11JiWHnaukw=; b=oG4VbsvFLzvpYlgJZLrPSK4KQxoTkqcIboM63iY/NojCoLVM8lhX2kg0TtSZoOPDNm +P5Gl3HOl8SlJS/ZAyCPrCOWQpBes1K6Wlohp/AbEwIjtvx8ZlJqUI16N5Yv2ast6Y3N 8nD7sOQzhYNJVUnyl5a8XodUFYcKPX+low2Ov8kUgnJPwr/tNyGGVsXCQkJLe1Pzuj4v qpEW7ksWRGQ3fSAmuJAkOmaMyB/c+dQgZdmqm8+YUjavL1yFDCYkaiT///mvK9if9Eno k+AS2NBOgUYGtt0YKOYbgbQ4ynLXpHakDCo13tj0pySYCppbcli8+Rf9VDPugtzW+7na OQtQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1788017688; x=1788622488; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to:content-type; bh=HHs8vnCpPDwNyoRpbGWeEHXuEK7fQBuD11JiWHnaukw=; b=cBAlTvULnCHUj+A4owbrlrfSWmwQbCIEjfNC3oUtGCxrplwG8Kt4gex3QX9tRc4F7e XgNhI/ihAtNw+7UWcdVSKec11/uPZ55fO1OrOIYEx9iWun/1L4FfY1jNJ8zIPXeDkktK tlmCAzmZg5MbSseqXx8tPJHGZQb03xXyE2CHys6bzY3Ozi310I3SXbuvSClazfGaV7HI SPTQtw1ugbVkQCtV6ox89APr/MTUGJkHjw7vya+LUYvwc1aJB9JvdkRwVZSGUiT/QvDF NcYUIzVsCp3DGcNc+qp45aDjdeMFg15ByS2VNXAMiCrqYDesK/kUXR1Je+uG2RR2A0yW wlJA== X-Forwarded-Encrypted: i=1; AKwUvBxVD7MFRDG80ahdHbGpJiFTfDUdMRpsw8mp8zeEEVq1TvLHvkzOrDl8pwzPja/g1kFbPvAVgbg2VXZwIreSNw==@vger.kernel.org X-Gm-Message-State: AFuF++nUNpb8+ZE0Odnc/iFx4f87A9eOKdICBu+qBl+tRyGdZxYITV6k 71XaoJcftLPf6CYS5o3Ylgyp661l6BgXqQKsCWUrspGjbqa8LqwVwwAf X-Gm-Gg: AYBFou1cyU08EfZ3veaODcEDCO5Uvsv0hYYlP9ew4UvAYDxJXumZmIFQsxXsGc54QLb oNH2ktXPi3VczmGEu4z8Wni0zmHP4GnyFiRMJJdACf9TSaO6+JYez6OmTmIARC3170TNRU/qmpO bpxv/HJ9LQFxuVhQUmwJm39kLLms9j5+E2BBUAcFReqJJJq0MKIH/ozU+kEM5Cri84a5Vgz79C0 j/VJ2+bzcYNfUeoZf3pWm1MaPcfvbfF2xT+/MZp6JWxM81jkH+6r71PCF4nCsuQT8d3WMyhXgEd gGfEBKyafpsvjt2O4he7DafUz5brmC4wwnGG6Neh5z7/lB9ACWOhUZflg8oGaup85XkDuZD/Znv 7HTwAR1iPLZoT/Aw+6YMzPmdev+AU/D3YaVRSzWISRXogA4zDfl4nT6w2hEqeydfjgbLlEZ28wW 6rODvYFQoac5x0meLw/6Ta8m9zxaseONYUOPe8Xkf0JHJIM2L7pIvKJddu3os= X-Received: by 2002:a17:90b:1d05:b0:396:65dd:4093 with SMTP id 98e67ed59e1d1-396d0ff519cmr25415299a91.14.1788017688155; Sat, 29 Aug 2026 08:34:48 -0700 (PDT) Received: from tofu.. ([128.210.0.165]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-142e41837c6sm13145472c88.11.2026.08.29.08.34.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 29 Aug 2026 08:34:47 -0700 (PDT) From: Georgios Androutsopoulos To: Alice Ryhl , Burak Emir , Miguel Ojeda , Yury Norov Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Trevor Gross , Danilo Krummrich , Daniel Almeida , Tamir Duberstein , Alexandre Courbot , =?UTF-8?q?Onur=20=C3=96zkan?= , Eliot Courtney , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Georgios Androutsopoulos Subject: [PATCH] rust: id_pool: document panics in `find_unused_id` and `release_id` Date: Sat, 29 Aug 2026 11:34:42 -0400 Message-ID: <20260829153442.20799-1-georgeandrout13@gmail.com> X-Mailer: git-send-email 2.47.3 Precedence: bulk X-Mailing-List: rust-for-linux@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit `find_unused_id()` calls `Bitmap::next_zero_bit()` and `release_id()` calls `Bitmap::clear_bit()`, both of which panic when `CONFIG_RUST_BITMAP_HARDENED` is enabled and the index is out of bounds. Neither `IdPool` method documents this. Add the missing `# Panics` sections and state the bounds requirement on `offset` and `id`. Signed-off-by: Georgios Androutsopoulos --- rust/kernel/id_pool.rs | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/rust/kernel/id_pool.rs b/rust/kernel/id_pool.rs index 384753fe0..ae6960d7f 100644 --- a/rust/kernel/id_pool.rs +++ b/rust/kernel/id_pool.rs @@ -224,7 +224,13 @@ pub fn grow(&mut self, mut resizer: PoolResizer) { /// Finds an unused ID in the bitmap. /// /// Upon success, returns its index. Otherwise, returns [`None`] - /// to indicate that a [`Self::grow_request`] is needed. + /// to indicate that a [`Self::grow_request`] is needed. `offset` must be + /// in bounds. + /// + /// # Panics + /// + /// Panics if `CONFIG_RUST_BITMAP_HARDENED` is enabled and `offset` is out + /// of bounds. #[inline] #[must_use] pub fn find_unused_id(&mut self, offset: usize) -> Option> { @@ -236,6 +242,13 @@ pub fn find_unused_id(&mut self, offset: usize) -> Option> { } /// Releases an ID. + /// + /// The `id` must be in bounds. + /// + /// # Panics + /// + /// Panics if `CONFIG_RUST_BITMAP_HARDENED` is enabled and `id` is out of + /// bounds. #[inline] pub fn release_id(&mut self, id: usize) { self.map.clear_bit(id); base-commit: 73e3f0710014fe6d4ed98cfc02292f6121db7558 -- 2.47.3