diff options
Diffstat (limited to 'third_party/rust/copyless/src')
-rw-r--r-- | third_party/rust/copyless/src/boxed.rs | 62 | ||||
-rw-r--r-- | third_party/rust/copyless/src/lib.rs | 11 | ||||
-rw-r--r-- | third_party/rust/copyless/src/vec.rs | 75 |
3 files changed, 148 insertions, 0 deletions
diff --git a/third_party/rust/copyless/src/boxed.rs b/third_party/rust/copyless/src/boxed.rs new file mode 100644 index 0000000000..e3f3daaa9c --- /dev/null +++ b/third_party/rust/copyless/src/boxed.rs @@ -0,0 +1,62 @@ +use std::{ + alloc, mem, + ptr::{self, NonNull}, +}; + +/// A typesafe helper that stores the allocated pointer without the data initialized. +pub struct BoxAllocation<T>( + // ptr cannot be null since it would mean the allocation failed. + // Note: covariance is acceptable since this eventually becomes a `Box<T>`, + // which is covariant too. + NonNull<T>, +); + +impl<T> BoxAllocation<T> { + /// Consumes self and writes the given value into the allocation. + #[inline(always)] // if this does not get inlined then copying happens + pub fn init(self, value: T) -> Box<T> { + if mem::size_of::<T>() == 0 { + return Box::new(value); + } + + unsafe { + let ptr = self.0.as_ptr(); + mem::forget(self); + ptr::write(ptr, value); + Box::from_raw(ptr) + } + } +} + +impl<T> Drop for BoxAllocation<T> { + fn drop(&mut self) { + if mem::size_of::<T>() == 0 { + return; + } + + let layout = alloc::Layout::new::<T>(); + unsafe { + alloc::dealloc(self.0.as_ptr() as *mut u8, layout); + } + } +} + +/// Helper trait for a `Box` type that allocates up-front. +pub trait BoxHelper<T> { + /// Allocates the storage without providing any data. + fn alloc() -> BoxAllocation<T>; +} + +impl<T> BoxHelper<T> for Box<T> { + fn alloc() -> BoxAllocation<T> { + if mem::size_of::<T>() == 0 { + return BoxAllocation(NonNull::dangling()); + } + + let layout = alloc::Layout::new::<T>(); + BoxAllocation( + NonNull::new(unsafe { alloc::alloc(layout) as *mut T }) + .unwrap_or_else(|| alloc::handle_alloc_error(layout)), // oom + ) + } +} diff --git a/third_party/rust/copyless/src/lib.rs b/third_party/rust/copyless/src/lib.rs new file mode 100644 index 0000000000..e06bec0f83 --- /dev/null +++ b/third_party/rust/copyless/src/lib.rs @@ -0,0 +1,11 @@ +#![warn(missing_docs)] + +//! Helper extensions of standard containers that allow memcopy-less operation. + +pub use self::{ + boxed::{BoxAllocation, BoxHelper}, + vec::{VecAllocation, VecEntry, VecHelper}, +}; + +mod boxed; +mod vec; diff --git a/third_party/rust/copyless/src/vec.rs b/third_party/rust/copyless/src/vec.rs new file mode 100644 index 0000000000..f901dc98e5 --- /dev/null +++ b/third_party/rust/copyless/src/vec.rs @@ -0,0 +1,75 @@ +use std::ptr; + +/// A typesafe helper that separates new value construction from +/// vector growing, allowing LLVM to ideally construct the element in place. +pub struct VecAllocation<'a, T: 'a> { + vec: &'a mut Vec<T>, + index: usize, +} + +impl<'a, T> VecAllocation<'a, T> { + /// Consumes self and writes the given value into the allocation. + // writing is safe because alloc() ensured enough capacity + // and `Allocation` holds a mutable borrow to prevent anyone else + // from breaking this invariant. + #[inline(always)] + pub fn init(self, value: T) -> usize { + unsafe { + ptr::write(self.vec.as_mut_ptr().add(self.index), value); + self.vec.set_len(self.index + 1); + } + self.index + } +} + +/// An entry into a vector, similar to `std::collections::hash_map::Entry`. +pub enum VecEntry<'a, T: 'a> { + /// Entry has just been freshly allocated. + Vacant(VecAllocation<'a, T>), + /// Existing entry. + Occupied(&'a mut T), +} + +impl<'a, T> VecEntry<'a, T> { + /// Sets the value for this entry. + #[inline(always)] + pub fn set(self, value: T) { + match self { + VecEntry::Vacant(alloc) => { alloc.init(value); } + VecEntry::Occupied(slot) => { *slot = value; } + } + } +} + +/// Helper trait for a `Vec` type that allocates up-front. +pub trait VecHelper<T> { + /// Grows the vector by a single entry, returning the allocation. + fn alloc(&mut self) -> VecAllocation<T>; + /// Either returns an existing element, or grows the vector by one. + /// Doesn't expect indices to be higher than the current length. + fn entry(&mut self, index: usize) -> VecEntry<T>; +} + +impl<T> VecHelper<T> for Vec<T> { + fn alloc(&mut self) -> VecAllocation<T> { + let index = self.len(); + if self.capacity() == index { + self.reserve(1); + } + VecAllocation { + vec: self, + index, + } + } + + fn entry(&mut self, index: usize) -> VecEntry<T> { + if index < self.len() { + VecEntry::Occupied(unsafe { + self.get_unchecked_mut(index) + }) + } else { + assert_eq!(index, self.len()); + VecEntry::Vacant(self.alloc()) + } + } +} |