Skip to content

Commit

Permalink
rust: alloc: introduce the VecExt trait
Browse files Browse the repository at this point in the history
Make `try_with_capacity`, `try_push`, and `try_extend_from_slice`
methods available in `Vec` even though it doesn't implement them. It is
implemented with `try_reserve` and `push_within_capacity`.

This is in preparation for switching to the upstream `alloc` crate.

Reviewed-by: Benno Lossin <[email protected]>
Suggested-by: Gary Guo <[email protected]>
Signed-off-by: Wedson Almeida Filho <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Miguel Ojeda <[email protected]>
  • Loading branch information
wedsonaf authored and ojeda committed Apr 16, 2024
1 parent 31d94d8 commit 0398977
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 0 deletions.
1 change: 1 addition & 0 deletions rust/kernel/alloc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
#[cfg(not(test))]
#[cfg(not(testlib))]
mod allocator;
pub mod vec_ext;
48 changes: 48 additions & 0 deletions rust/kernel/alloc/vec_ext.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// SPDX-License-Identifier: GPL-2.0

//! Extensions to [`Vec`] for fallible allocations.

use alloc::{collections::TryReserveError, vec::Vec};
use core::result::Result;

/// Extensions to [`Vec`].
pub trait VecExt<T>: Sized {
/// Creates a new [`Vec`] instance with at least the given capacity.
fn try_with_capacity(capacity: usize) -> Result<Self, TryReserveError>;

/// Appends an element to the back of the [`Vec`] instance.
fn try_push(&mut self, v: T) -> Result<(), TryReserveError>;

/// Pushes clones of the elements of slice into the [`Vec`] instance.
fn try_extend_from_slice(&mut self, other: &[T]) -> Result<(), TryReserveError>
where
T: Clone;
}

impl<T> VecExt<T> for Vec<T> {
fn try_with_capacity(capacity: usize) -> Result<Self, TryReserveError> {
let mut v = Vec::new();
v.try_reserve(capacity)?;
Ok(v)
}

fn try_push(&mut self, v: T) -> Result<(), TryReserveError> {
if let Err(retry) = self.push_within_capacity(v) {
self.try_reserve(1)?;
let _ = self.push_within_capacity(retry);
}
Ok(())
}

fn try_extend_from_slice(&mut self, other: &[T]) -> Result<(), TryReserveError>
where
T: Clone,
{
self.try_reserve(other.len())?;
for item in other {
self.try_push(item.clone())?;
}

Ok(())
}
}
1 change: 1 addition & 0 deletions rust/kernel/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#![feature(new_uninit)]
#![feature(receiver_trait)]
#![feature(unsize)]
#![feature(vec_push_within_capacity)]

// Ensure conditional compilation based on the kernel configuration works;
// otherwise we may silently break things like initcall handling.
Expand Down
2 changes: 2 additions & 0 deletions rust/kernel/prelude.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
#[doc(no_inline)]
pub use core::pin::Pin;

pub use crate::alloc::vec_ext::VecExt;

#[doc(no_inline)]
pub use alloc::{boxed::Box, vec::Vec};

Expand Down

0 comments on commit 0398977

Please sign in to comment.