The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Alice Ryhl <aliceryhl@google.com>
To: Danilo Krummrich <dakr@kernel.org>
Cc: Matthew Maurer <mmaurer@google.com>,
	rust-for-linux@vger.kernel.org,  linux-kernel@vger.kernel.org,
	Alice Ryhl <aliceryhl@google.com>,
	 Benno Lossin <benno.lossin@proton.me>
Subject: [PATCH v2 3/7] rust: alloc: add Vec::push_within_capacity
Date: Fri, 21 Mar 2025 12:09:58 +0000	[thread overview]
Message-ID: <20250321-vec-methods-v2-3-6d9c8a4634cb@google.com> (raw)
In-Reply-To: <20250321-vec-methods-v2-0-6d9c8a4634cb@google.com>

This introduces a new method called `push_within_capacity` for appending
to a vector without attempting to allocate if the capacity is full. Rust
Binder will use this in various places to safely push to a vector while
holding a spinlock.

The existing Vec::push method is reimplemented in terms of the new
method.

Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Signed-off-by: Alice Ryhl <aliceryhl@google.com>
---
 rust/kernel/alloc/kvec.rs | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/rust/kernel/alloc/kvec.rs b/rust/kernel/alloc/kvec.rs
index e42c5c40c992c796409505da70975f970524fc24..c9de619466eed1590fda039a291207100729a96a 100644
--- a/rust/kernel/alloc/kvec.rs
+++ b/rust/kernel/alloc/kvec.rs
@@ -284,6 +284,31 @@ pub fn spare_capacity_mut(&mut self) -> &mut [MaybeUninit<T>] {
     /// ```
     pub fn push(&mut self, v: T, flags: Flags) -> Result<(), AllocError> {
         self.reserve(1, flags)?;
+        let err = self.push_within_capacity(v);
+        // SAFETY: The call to `reserve` was successful, so `push_within_capacity` cannot fail.
+        unsafe { err.unwrap_unchecked() };
+        Ok(())
+    }
+
+    /// Appends an element to the back of the [`Vec`] instance.
+    ///
+    /// Fails if the vector does not have capacity for the new element.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// let mut v = KVec::with_capacity(10, GFP_KERNEL);
+    /// for i in 0..10 {
+    ///     v.push_within_capacity(i).unwrap();
+    /// }
+    ///
+    /// assert!(v.push_within_capacity(10).is_err());
+    /// # Ok::<(), Error>(())
+    /// ```
+    pub fn push_within_capacity(&mut self, v: T) -> Result<(), T> {
+        if self.len() >= self.capacity() {
+            return Err(v);
+        }
 
         // SAFETY:
         // - `self.len` is smaller than `self.capacity` and hence, the resulting pointer is

-- 
2.49.0.395.g12beb8f557-goog


  parent reply	other threads:[~2025-03-21 12:10 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-21 12:09 [PATCH v2 0/7] Additional methods for Vec Alice Ryhl
2025-03-21 12:09 ` [PATCH v2 1/7] rust: alloc: add Vec::clear Alice Ryhl
2025-03-21 12:09 ` [PATCH v2 2/7] rust: alloc: add Vec::pop Alice Ryhl
2025-03-21 12:09 ` Alice Ryhl [this message]
2025-03-21 12:09 ` [PATCH v2 4/7] rust: alloc: add Vec::drain_all Alice Ryhl
2025-03-21 12:10 ` [PATCH v2 5/7] rust: alloc: add Vec::retain Alice Ryhl
2025-03-21 12:10 ` [PATCH v2 6/7] rust: alloc: add Vec::remove Alice Ryhl
2025-03-21 12:10 ` [PATCH v2 7/7] rust: alloc: add Vec::insert_within_capacity Alice Ryhl
2025-03-21 12:25 ` [PATCH v2 0/7] Additional methods for Vec Danilo Krummrich
2025-03-21 13:10   ` Benno Lossin
2025-03-21 22:10     ` Danilo Krummrich
2025-03-21 12:28 ` Alice Ryhl
2025-03-21 15:47 ` Tamir Duberstein

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=20250321-vec-methods-v2-3-6d9c8a4634cb@google.com \
    --to=aliceryhl@google.com \
    --cc=benno.lossin@proton.me \
    --cc=dakr@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mmaurer@google.com \
    --cc=rust-for-linux@vger.kernel.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox