Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optimize all ZST allocations into one single allocation #41

Merged
merged 2 commits into from
Jul 1, 2016
Merged
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
4 changes: 2 additions & 2 deletions src/interpreter/terminator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -423,8 +423,8 @@ impl<'a, 'tcx> EvalContext<'a, 'tcx> {
"__rust_reallocate" => {
let ptr = self.memory.read_ptr(args[0])?;
let size = self.memory.read_usize(args[2])?;
self.memory.reallocate(ptr, size as usize)?;
self.memory.write_ptr(dest, ptr)?;
let new_ptr = self.memory.reallocate(ptr, size as usize)?;
self.memory.write_ptr(dest, new_ptr)?;
}

"memcmp" => {
Expand Down
44 changes: 39 additions & 5 deletions src/memory.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ impl Pointer {
pub fn offset(self, i: isize) -> Self {
Pointer { offset: (self.offset as isize + i) as usize, ..self }
}
pub fn points_to_zst(&self) -> bool {
self.alloc_id.0 == 0
}
fn zst_ptr() -> Self {
Pointer {
alloc_id: ZST_ALLOC_ID,
offset: 0,
}
}
}

#[derive(Debug, Copy, Clone, Hash, Eq, PartialEq)]
Expand All @@ -66,15 +75,29 @@ pub struct Memory<'a, 'tcx> {
pub layout: &'a TargetDataLayout,
}

const ZST_ALLOC_ID: AllocId = AllocId(0);

impl<'a, 'tcx> Memory<'a, 'tcx> {
pub fn new(layout: &'a TargetDataLayout) -> Self {
Memory {
let mut mem = Memory {
alloc_map: HashMap::new(),
functions: HashMap::new(),
function_alloc_cache: HashMap::new(),
next_id: AllocId(0),
next_id: AllocId(1),
layout: layout,
}
};
// alloc id 0 is reserved for ZSTs, this is an optimization to prevent ZST
// (e.g. function items, (), [], ...) from requiring memory
let alloc = Allocation {
bytes: Vec::new(),
relocations: BTreeMap::new(),
undef_mask: UndefMask::new(0),
};
mem.alloc_map.insert(ZST_ALLOC_ID, alloc);
// check that additional zst allocs work
debug_assert!(mem.allocate(0).points_to_zst());
debug_assert!(mem.get(ZST_ALLOC_ID).is_ok());
mem
}

pub fn allocations<'b>(&'b self) -> ::std::collections::hash_map::Iter<'b, AllocId, Allocation> {
Expand Down Expand Up @@ -105,6 +128,9 @@ impl<'a, 'tcx> Memory<'a, 'tcx> {
}

pub fn allocate(&mut self, size: usize) -> Pointer {
if size == 0 {
return Pointer::zst_ptr();
}
let alloc = Allocation {
bytes: vec![0; size],
relocations: BTreeMap::new(),
Expand All @@ -121,11 +147,14 @@ impl<'a, 'tcx> Memory<'a, 'tcx> {

// TODO(solson): Track which allocations were returned from __rust_allocate and report an error
// when reallocating/deallocating any others.
pub fn reallocate(&mut self, ptr: Pointer, new_size: usize) -> EvalResult<'tcx, ()> {
pub fn reallocate(&mut self, ptr: Pointer, new_size: usize) -> EvalResult<'tcx, Pointer> {
if ptr.offset != 0 {
// TODO(solson): Report error about non-__rust_allocate'd pointer.
return Err(EvalError::Unimplemented(format!("bad pointer offset: {}", ptr.offset)));
}
if ptr.points_to_zst() {
return Ok(self.allocate(new_size));
}

let size = self.get_mut(ptr.alloc_id)?.bytes.len();

Expand All @@ -141,21 +170,26 @@ impl<'a, 'tcx> Memory<'a, 'tcx> {
alloc.undef_mask.truncate(new_size);
}

Ok(())
Ok(ptr)
}

// TODO(solson): See comment on `reallocate`.
pub fn deallocate(&mut self, ptr: Pointer) -> EvalResult<'tcx, ()> {
if ptr.points_to_zst() {
return Ok(());
}
if ptr.offset != 0 {
// TODO(solson): Report error about non-__rust_allocate'd pointer.
return Err(EvalError::Unimplemented(format!("bad pointer offset: {}", ptr.offset)));
}

if self.alloc_map.remove(&ptr.alloc_id).is_none() {
debug!("deallocated a pointer twice: {}", ptr.alloc_id);
// TODO(solson): Report error about erroneous free. This is blocked on properly tracking
// already-dropped state since this if-statement is entered even in safe code without
// it.
}
debug!("deallocated : {}", ptr.alloc_id);

Ok(())
}
Expand Down
2 changes: 1 addition & 1 deletion tests/compile-fail/out_of_bounds_read.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
fn main() {
let v: Vec<u8> = vec![1, 2];
let x = unsafe { *v.get_unchecked(5) }; //~ ERROR: memory access of 5..6 outside bounds of allocation 31 which has size 2
let x = unsafe { *v.get_unchecked(5) }; //~ ERROR: which has size 2
panic!("this should never print: {}", x);
}
5 changes: 5 additions & 0 deletions tests/compile-fail/out_of_bounds_read2.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
fn main() {
let v: Vec<u8> = vec![1, 2];
let x = unsafe { *v.get_unchecked(5) }; //~ ERROR: memory access of 5..6 outside bounds of allocation
panic!("this should never print: {}", x);
}
8 changes: 8 additions & 0 deletions tests/run-pass/zst.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// the following flag prevents this test from running on the host machine
// this should only be run on miri, because rust doesn't (yet?) optimize ZSTs of different types
// into the same memory location
// ignore-test


#[derive(PartialEq, Debug)]
struct A;

Expand All @@ -13,4 +19,6 @@ fn use_zst() -> A {
fn main() {
assert_eq!(zst_ret(), A);
assert_eq!(use_zst(), A);
assert_eq!(&A as *const A as *const (), &() as *const _);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this line fails on rustc compiled code

assert_eq!(&A as *const A, &A as *const A);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this line works on both miri and rustc compiled code

}