Add `Vec::try_push_init` for fallible initializers (`impl Init<T, E>`) and a new sum error type `PushInitError<I, E>` that it returns. If allocation fails, it hands back the original initializer. A From impl for `Error` lets callers decay the `PushInitError<I, E>` to a regular Error if they want.
Signed-off-by: Eliot Courtney <[email protected]> --- rust/kernel/alloc/kvec.rs | 56 ++++++++++++++++++++++++++++++++++++++-- rust/kernel/alloc/kvec/errors.rs | 30 +++++++++++++++++++++ 2 files changed, 84 insertions(+), 2 deletions(-) diff --git a/rust/kernel/alloc/kvec.rs b/rust/kernel/alloc/kvec.rs index c7546b9da4fa..fe86530624c1 100644 --- a/rust/kernel/alloc/kvec.rs +++ b/rust/kernel/alloc/kvec.rs @@ -52,10 +52,18 @@ }, // }; -use pin_init::Zeroable; +use pin_init::{ + Init, + Zeroable, // +}; mod errors; -pub use self::errors::{InsertError, PushError, RemoveError}; +pub use self::errors::{ + InsertError, + PushError, + PushInitError, + RemoveError, // +}; /// Create a [`KVec`] containing the arguments. /// @@ -359,6 +367,49 @@ pub fn push(&mut self, v: T, flags: Flags) -> Result<(), AllocError> { Ok(()) } + /// Appends an element to the back of the [`Vec`] instance by initializing it in place. + /// + /// Unlike [`Vec::push`], the initializer may be fallible. If the allocation fails, the + /// original initializer `init` is handed back in [`PushInitError::AllocError`]. If the + /// initializer itself fails, its error is returned in [`PushInitError::InitError`]. + /// + /// # Examples + /// + /// ``` + /// struct Element { + /// buf: KVec<u8>, + /// } + /// + /// impl Element { + /// fn new() -> impl Init<Self, Error> { + /// try_init!(Element { + /// buf: KVec::with_capacity(16, GFP_KERNEL)?, + /// }? Error) + /// } + /// } + /// + /// let mut v: KVec<Element> = KVec::new(); + /// v.try_push_init(Element::new(), GFP_KERNEL)?; + /// assert!(v[0].buf.is_empty()); + /// # Ok::<(), Error>(()) + /// ``` + pub fn try_push_init<I, E>(&mut self, init: I, flags: Flags) -> Result<(), PushInitError<I, E>> + where + I: Init<T, E>, + { + if self.reserve(1, flags).is_err() { + return Err(PushInitError::AllocError(init)); + } + // SAFETY: The call to `reserve` was successful, so there is at least one spare slot. + unsafe { init.__init(self.spare_capacity_mut().as_mut_ptr().cast::<T>()) } + .map_err(PushInitError::InitError)?; + // SAFETY: The call to `__init` returned `Ok`, so the first spare slot now holds an + // initialized `T`. The new length does not exceed the capacity because `reserve` ensured + // the capacity is greater than the length by at least one. + unsafe { self.inc_len(1) }; + Ok(()) + } + /// Appends an element to the back of the [`Vec`] instance without reallocating. /// /// Fails if the vector does not have capacity for the new element. @@ -1174,6 +1225,7 @@ fn eq(&self, other: &$rhs) -> bool { self[..] == other[..] } )* } } +pub(super) use impl_slice_eq; impl_slice_eq! { [A1: Allocator, A2: Allocator] Vec<T, A1>, Vec<U, A2>, diff --git a/rust/kernel/alloc/kvec/errors.rs b/rust/kernel/alloc/kvec/errors.rs index aaca6446516a..4e4be9a46d83 100644 --- a/rust/kernel/alloc/kvec/errors.rs +++ b/rust/kernel/alloc/kvec/errors.rs @@ -25,6 +25,36 @@ fn from(_: PushError<T>) -> Error { } } +/// Error type for [`Vec::try_push_init`]. +pub enum PushInitError<I, E> { + /// The allocation failed. Hand the initializer back. + AllocError(I), + /// The initializer failed. + InitError(E), +} + +impl<I, E> fmt::Debug for PushInitError<I, E> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + PushInitError::AllocError(_) => write!(f, "Failed to allocate"), + PushInitError::InitError(_) => write!(f, "Initializer failed"), + } + } +} + +impl<I, E> From<PushInitError<I, E>> for Error +where + Error: From<E>, +{ + #[inline] + fn from(e: PushInitError<I, E>) -> Error { + match e { + PushInitError::AllocError(_) => ENOMEM, + PushInitError::InitError(e) => Error::from(e), + } + } +} + /// Error type for [`Vec::remove`]. pub struct RemoveError; -- 2.55.0
