Skip to content

Commit

Permalink
Rollup merge of rust-lang#123089 - Philippe-Cholet:vecdeque_pop_assum…
Browse files Browse the repository at this point in the history
…e_cap, r=Nilstrieb

Add invariant to VecDeque::pop_* that len < cap if pop successful

Similar to rust-lang#114370 for VecDeque instead of Vec.

I initially come from rust-itertools/itertools#899 where we noticed that `pop_front;push_back;` was slower than expected so `@scottmcm` suggested I file an issue which lead to https://internals.rust-lang.org/t/vecdeque-pop-front-push-back/20483 where **kornel** mentionned rust-lang#114334 (fixed by rust-lang#114370).

This is my first time with codegen tests, I based the test on what was done for Vec.
  • Loading branch information
matthiaskrgr authored Apr 8, 2024
2 parents 98fbf86 + 7a2678d commit 17c94b5
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 2 deletions.
10 changes: 8 additions & 2 deletions library/alloc/src/collections/vec_deque/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1614,7 +1614,10 @@ impl<T, A: Allocator> VecDeque<T, A> {
let old_head = self.head;
self.head = self.to_physical_idx(1);
self.len -= 1;
Some(unsafe { self.buffer_read(old_head) })
unsafe {
core::hint::assert_unchecked(self.len < self.capacity());
Some(self.buffer_read(old_head))
}
}
}

Expand All @@ -1638,7 +1641,10 @@ impl<T, A: Allocator> VecDeque<T, A> {
None
} else {
self.len -= 1;
Some(unsafe { self.buffer_read(self.to_physical_idx(self.len)) })
unsafe {
core::hint::assert_unchecked(self.len < self.capacity());
Some(self.buffer_read(self.to_physical_idx(self.len)))
}
}
}

Expand Down
67 changes: 67 additions & 0 deletions tests/codegen/vecdeque_pop_push.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
//@ compile-flags: -O

#![crate_type = "lib"]

use std::collections::VecDeque;

#[no_mangle]
// CHECK-LABEL: @noop_back(
pub fn noop_back(v: &mut VecDeque<u8>) {
// CHECK-NOT: grow
// CHECK: tail call void @llvm.assume
// CHECK-NOT: grow
// CHECK: ret
if let Some(x) = v.pop_back() {
v.push_back(x);
}
}

#[no_mangle]
// CHECK-LABEL: @noop_front(
pub fn noop_front(v: &mut VecDeque<u8>) {
// CHECK-NOT: grow
// CHECK: tail call void @llvm.assume
// CHECK-NOT: grow
// CHECK: ret
if let Some(x) = v.pop_front() {
v.push_front(x);
}
}

#[no_mangle]
// CHECK-LABEL: @move_byte_front_to_back(
pub fn move_byte_front_to_back(v: &mut VecDeque<u8>) {
// CHECK-NOT: grow
// CHECK: tail call void @llvm.assume
// CHECK-NOT: grow
// CHECK: ret
if let Some(x) = v.pop_front() {
v.push_back(x);
}
}

#[no_mangle]
// CHECK-LABEL: @move_byte_back_to_front(
pub fn move_byte_back_to_front(v: &mut VecDeque<u8>) {
// CHECK-NOT: grow
// CHECK: tail call void @llvm.assume
// CHECK-NOT: grow
// CHECK: ret
if let Some(x) = v.pop_back() {
v.push_front(x);
}
}

#[no_mangle]
// CHECK-LABEL: @push_back_byte(
pub fn push_back_byte(v: &mut VecDeque<u8>) {
// CHECK: call {{.*}}grow
v.push_back(3);
}

#[no_mangle]
// CHECK-LABEL: @push_front_byte(
pub fn push_front_byte(v: &mut VecDeque<u8>) {
// CHECK: call {{.*}}grow
v.push_front(3);
}

0 comments on commit 17c94b5

Please sign in to comment.