Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions common/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ pub mod linked_list;
pub mod lock;
pub mod rc;
pub mod refcount;
pub mod safe_alloc;
pub mod static_cell;
pub mod str;

Expand Down
194 changes: 194 additions & 0 deletions common/src/safe_alloc.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
use std::ptr;

pub use std::collections::TryReserveError;
pub type TryReserveResult<T> = Result<T, TryReserveError>;

pub trait VecExt: Sized {
type T;
fn try_with_capacity(n: usize) -> TryReserveResult<Self>;
fn try_push(&mut self, x: Self::T) -> TryReserveResult<()>;
fn try_extend_from_slice_copy(&mut self, other: &[Self::T]) -> TryReserveResult<()>
where
Self::T: Copy;
fn try_extend_from_slice_clone(&mut self, other: &[Self::T]) -> TryReserveResult<()>
where
Self::T: Clone;
fn try_append(&mut self, other: &mut Self) -> TryReserveResult<()>;
}

impl<T> VecExt for Vec<T> {
type T = T;
fn try_with_capacity(n: usize) -> TryReserveResult<Self> {
let mut v = Vec::new();
v.try_reserve_exact(n)?;
Ok(v)
}
fn try_push(&mut self, value: Self::T) -> TryReserveResult<()> {
let len = self.len();
if len == self.capacity() {
self.try_reserve(1)?;
}
unsafe {
let end = self.as_mut_ptr().add(len);
ptr::write(end, value);
self.set_len(len + 1);
}
Ok(())
}
fn try_extend_from_slice_copy(&mut self, other: &[T]) -> TryReserveResult<()>
where
T: Copy,
{
self.try_reserve(other.len())?;
unsafe { unchecked_append(self, other) };
Ok(())
}
fn try_extend_from_slice_clone(&mut self, other: &[Self::T]) -> TryReserveResult<()>
where
Self::T: Clone,
{
self.try_reserve(other.len())?;
let len = self.len();
unsafe {
let mut local_len = SetLenOnDrop::new(self);
let mut ptr = local_len.vec.as_mut_ptr().add(len);
for element in other {
ptr::write(ptr, element.clone());
ptr = ptr.offset(1);
local_len.increment_len(1);
}
}
Ok(())
}
fn try_append(&mut self, other: &mut Self) -> TryReserveResult<()> {
let other_len = other.len();
self.try_reserve(other_len)?;
unsafe {
other.set_len(0);
unchecked_append(self, std::slice::from_raw_parts(other.as_ptr(), other_len));
}
Ok(())
}
}

struct SetLenOnDrop<'a, T> {
vec: &'a mut Vec<T>,
local_len: usize,
}

impl<'a, T> SetLenOnDrop<'a, T> {
#[inline]
fn new(vec: &'a mut Vec<T>) -> Self {
SetLenOnDrop {
local_len: vec.len(),
vec,
}
}

#[inline]
fn increment_len(&mut self, increment: usize) {
self.local_len += increment;
}
}
Comment on lines +74 to +92

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This idea looks good. I think it can have similar interface like MaybeUninit because they have similar concept.

struct VecBuilder {
    vec: Vec<T>,
    len: usize,
}

impl VecUninit {
    fn try_with_len(len: usize) -> TryReserveResult {
        Self::try_with_capacity(len, len)
    }
    /// SAFETY: len <= capacity
    unsafe fn try_with_capacity(capacity: usize, len: usize) -> TryReserveResult {
        debug_assert!(len <= capacity);
        Self {
            vec: Vec::try_with_capacity(...)
            len,
        }
    }
    unsafe fn assume_init(self) -> Vec {
        self.vec.set_len(self.len);
        self.vec
    }
}

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh.. this is just copied from the standard library. I should add a comment.


impl<T> Drop for SetLenOnDrop<'_, T> {
#[inline]
fn drop(&mut self) {
unsafe { self.vec.set_len(self.local_len) };
}
}

unsafe fn unchecked_append<T>(v: &mut Vec<T>, other: &[T]) {
// modified from Vec::append_elements
let count = other.len();
let len = v.len();
ptr::copy_nonoverlapping(other.as_ptr(), v.as_mut_ptr().add(len), count);
v.set_len(len + count);
}

pub trait SliceExt {
type Container;
fn try_repeat(&self, n: usize) -> TryReserveResult<Self::Container>;
}

impl<T: Copy> SliceExt for [T] {
type Container = Vec<T>;
fn try_repeat(&self, n: usize) -> TryReserveResult<Self::Container> {
// implementation modified from <[T]>::repeat

if n == 0 {
return Ok(Vec::new());
}

// If `n` is larger than zero, it can be split as
// `n = 2^expn + rem (2^expn > rem, expn >= 0, rem >= 0)`.
// `2^expn` is the number represented by the leftmost '1' bit of `n`,
// and `rem` is the remaining part of `n`.

// Using `Vec` to access `set_len()`.
let capacity = self.len().checked_mul(n).ok_or_else(capacity_overflow)?;
let mut buf = Vec::try_with_capacity(capacity)?;

// `2^expn` repetition is done by doubling `buf` `expn`-times.
unsafe { unchecked_append(&mut buf, self) };
{
let mut m = n >> 1;
// If `m > 0`, there are remaining bits up to the leftmost '1'.
while m > 0 {
// `buf.extend(buf)`:
unsafe {
ptr::copy_nonoverlapping(
buf.as_ptr(),
(buf.as_mut_ptr() as *mut T).add(buf.len()),
buf.len(),
);
// `buf` has capacity of `self.len() * n`.
let buf_len = buf.len();
buf.set_len(buf_len * 2);
}

m >>= 1;
}
}

// `rem` (`= n - 2^expn`) repetition is done by copying
// first `rem` repetitions from `buf` itself.
let rem_len = capacity - buf.len(); // `self.len() * rem`
if rem_len > 0 {
// `buf.extend(buf[0 .. rem_len])`:
unsafe {
// This is non-overlapping since `2^expn > rem`.
ptr::copy_nonoverlapping(
buf.as_ptr(),
(buf.as_mut_ptr() as *mut T).add(buf.len()),
rem_len,
);
// `buf.len() + rem_len` equals to `buf.capacity()` (`= self.len() * n`).
buf.set_len(capacity);
}
}
Ok(buf)
}
}

impl SliceExt for str {
type Container = String;
fn try_repeat(&self, n: usize) -> TryReserveResult<Self::Container> {
self.as_bytes()
.try_repeat(n)
.map(|v| unsafe { String::from_utf8_unchecked(v) })
}
}

// a function to produce a capacity overflow error, even though creating a TryReserveError
// isn't stable. it optimizes to a no-op:
// rustpython_common::safe_alloc::capacity_overflow:
// xor edx, edx
// ret
#[inline]
fn capacity_overflow() -> TryReserveError {
let mut v = Vec::<()>::new();
// equivalent to v.set_len(usize::MAX)
v.extend(std::iter::repeat(()).take(usize::MAX));
v.try_reserve_exact(usize::MAX).unwrap_err()
}
12 changes: 6 additions & 6 deletions stdlib/src/array.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ mod array {
},
class_or_notimplemented,
function::{
ArgBytesLike, ArgIntoFloat, ArgIterable, IntoPyObject, IntoPyResult, OptionalArg,
ArgBytesLike, ArgIntoFloat, ArgIterable, IntoPyObject, OptionalArg, TryIntoPyObject,
},
protocol::{
BufferDescriptor, BufferMethods, BufferResizeGuard, PyBuffer, PyIterReturn,
Expand Down Expand Up @@ -114,7 +114,7 @@ mod array {
let i = v.wrap_index(i).ok_or_else(|| {
vm.new_index_error("pop index out of range".to_owned())
})?;
v.remove(i).into_pyresult(vm)
v.remove(i).try_into_pyobject(vm)
})*
}
}
Expand Down Expand Up @@ -255,7 +255,7 @@ mod array {
) -> PyResult<Option<PyObjectRef>> {
match self {
$(ArrayContentType::$n(v) => {
v.get(i).map(|x| x.into_pyresult(vm)).transpose()
v.get(i).map(|x| x.try_into_pyobject(vm)).transpose()
})*
}
}
Expand All @@ -272,7 +272,7 @@ mod array {
let pos_index = v.wrap_index(i).ok_or_else(|| {
vm.new_index_error("array index out of range".to_owned())
})?;
v.get(pos_index).unwrap().into_pyresult(vm)
v.get(pos_index).unwrap().try_into_pyobject(vm)
}
SequenceIndex::Slice(slice) => {
// TODO: Use interface similar to set/del item. This can
Expand Down Expand Up @@ -585,8 +585,8 @@ mod array {
}
}

impl IntoPyResult for WideChar {
fn into_pyresult(self, vm: &VirtualMachine) -> PyResult {
impl TryIntoPyObject for WideChar {
fn try_into_pyobject(self, vm: &VirtualMachine) -> PyResult {
Ok(
String::from(char::try_from(self).map_err(|e| vm.new_unicode_encode_error(e))?)
.into_pyobject(vm),
Expand Down
4 changes: 2 additions & 2 deletions stdlib/src/posixsubprocess.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pub(crate) use _posixsubprocess::make_module;
#[pymodule]
mod _posixsubprocess {
use super::{exec, CStrPathLike, ForkExecArgs, ProcArgs};
use crate::vm::{function::IntoPyException, PyResult, VirtualMachine};
use crate::vm::{function::PyErrResultExt, PyResult, VirtualMachine};

#[pyfunction]
fn fork_exec(args: ForkExecArgs, vm: &VirtualMachine) -> PyResult<libc::pid_t> {
Expand All @@ -36,7 +36,7 @@ mod _posixsubprocess {
let argv = &argv;
let envp = args.env_list.as_ref().map(|s| cstrs_to_ptrs(s.as_slice()));
let envp = envp.as_deref();
match unsafe { nix::unistd::fork() }.map_err(|err| err.into_pyexception(vm))? {
match unsafe { nix::unistd::fork() }.map_pyerr(vm)? {
nix::unistd::ForkResult::Child => exec(&args, ProcArgs { argv, envp }),
nix::unistd::ForkResult::Parent { child } => Ok(child.as_raw()),
}
Expand Down
Loading