Skip to content

Commit b41ece9

Browse files
committed
Make bridge::Buffer generic again.
It was made non-generic in #97004, but that (surprisingly) caused a mild performance regression.
1 parent bef2b7c commit b41ece9

File tree

5 files changed

+46
-44
lines changed

5 files changed

+46
-44
lines changed

library/proc_macro/src/bridge/buffer.rs

+26-24
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,40 @@ use std::mem;
55
use std::ops::{Deref, DerefMut};
66
use std::slice;
77

8+
// `T` is always `u8` in practice. Attempts to remove `T` caused mild
9+
// performance regressions, surprisingly enough.
810
#[repr(C)]
9-
pub struct Buffer {
10-
data: *mut u8,
11+
pub struct Buffer<T: Copy> {
12+
data: *mut T,
1113
len: usize,
1214
capacity: usize,
13-
reserve: extern "C" fn(Buffer, usize) -> Buffer,
14-
drop: extern "C" fn(Buffer),
15+
reserve: extern "C" fn(Buffer<T>, usize) -> Buffer<T>,
16+
drop: extern "C" fn(Buffer<T>),
1517
}
1618

17-
unsafe impl Sync for Buffer {}
18-
unsafe impl Send for Buffer {}
19+
unsafe impl<T: Copy + Sync> Sync for Buffer<T> {}
20+
unsafe impl<T: Copy + Send> Send for Buffer<T> {}
1921

20-
impl Default for Buffer {
22+
impl<T: Copy> Default for Buffer<T> {
2123
fn default() -> Self {
2224
Self::from(vec![])
2325
}
2426
}
2527

26-
impl Deref for Buffer {
27-
type Target = [u8];
28-
fn deref(&self) -> &[u8] {
29-
unsafe { slice::from_raw_parts(self.data as *const u8, self.len) }
28+
impl<T: Copy> Deref for Buffer<T> {
29+
type Target = [T];
30+
fn deref(&self) -> &[T] {
31+
unsafe { slice::from_raw_parts(self.data as *const T, self.len) }
3032
}
3133
}
3234

33-
impl DerefMut for Buffer {
34-
fn deref_mut(&mut self) -> &mut [u8] {
35+
impl<T: Copy> DerefMut for Buffer<T> {
36+
fn deref_mut(&mut self) -> &mut [T] {
3537
unsafe { slice::from_raw_parts_mut(self.data, self.len) }
3638
}
3739
}
3840

39-
impl Buffer {
41+
impl<T: Copy> Buffer<T> {
4042
pub(super) fn new() -> Self {
4143
Self::default()
4244
}
@@ -53,7 +55,7 @@ impl Buffer {
5355
// because in the case of small arrays, codegen can be more efficient
5456
// (avoiding a memmove call). With extend_from_slice, LLVM at least
5557
// currently is not able to make that optimization.
56-
pub(super) fn extend_from_array<const N: usize>(&mut self, xs: &[u8; N]) {
58+
pub(super) fn extend_from_array<const N: usize>(&mut self, xs: &[T; N]) {
5759
if xs.len() > (self.capacity - self.len) {
5860
let b = self.take();
5961
*self = (b.reserve)(b, xs.len());
@@ -64,7 +66,7 @@ impl Buffer {
6466
}
6567
}
6668

67-
pub(super) fn extend_from_slice(&mut self, xs: &[u8]) {
69+
pub(super) fn extend_from_slice(&mut self, xs: &[T]) {
6870
if xs.len() > (self.capacity - self.len) {
6971
let b = self.take();
7072
*self = (b.reserve)(b, xs.len());
@@ -75,7 +77,7 @@ impl Buffer {
7577
}
7678
}
7779

78-
pub(super) fn push(&mut self, v: u8) {
80+
pub(super) fn push(&mut self, v: T) {
7981
// The code here is taken from Vec::push, and we know that reserve()
8082
// will panic if we're exceeding isize::MAX bytes and so there's no need
8183
// to check for overflow.
@@ -90,7 +92,7 @@ impl Buffer {
9092
}
9193
}
9294

93-
impl Write for Buffer {
95+
impl Write for Buffer<u8> {
9496
fn write(&mut self, xs: &[u8]) -> io::Result<usize> {
9597
self.extend_from_slice(xs);
9698
Ok(xs.len())
@@ -106,35 +108,35 @@ impl Write for Buffer {
106108
}
107109
}
108110

109-
impl Drop for Buffer {
111+
impl<T: Copy> Drop for Buffer<T> {
110112
fn drop(&mut self) {
111113
let b = self.take();
112114
(b.drop)(b);
113115
}
114116
}
115117

116-
impl From<Vec<u8>> for Buffer {
117-
fn from(mut v: Vec<u8>) -> Self {
118+
impl<T: Copy> From<Vec<T>> for Buffer<T> {
119+
fn from(mut v: Vec<T>) -> Self {
118120
let (data, len, capacity) = (v.as_mut_ptr(), v.len(), v.capacity());
119121
mem::forget(v);
120122

121123
// This utility function is nested in here because it can *only*
122124
// be safely called on `Buffer`s created by *this* `proc_macro`.
123-
fn to_vec(b: Buffer) -> Vec<u8> {
125+
fn to_vec<T: Copy>(b: Buffer<T>) -> Vec<T> {
124126
unsafe {
125127
let Buffer { data, len, capacity, .. } = b;
126128
mem::forget(b);
127129
Vec::from_raw_parts(data, len, capacity)
128130
}
129131
}
130132

131-
extern "C" fn reserve(b: Buffer, additional: usize) -> Buffer {
133+
extern "C" fn reserve<T: Copy>(b: Buffer<T>, additional: usize) -> Buffer<T> {
132134
let mut v = to_vec(b);
133135
v.reserve(additional);
134136
Buffer::from(v)
135137
}
136138

137-
extern "C" fn drop(b: Buffer) {
139+
extern "C" fn drop<T: Copy>(b: Buffer<T>) {
138140
mem::drop(to_vec(b));
139141
}
140142

library/proc_macro/src/bridge/client.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ pub struct Client<I, O> {
374374
// a wrapper `fn` pointer, once `const fn` can reference `static`s.
375375
pub(super) get_handle_counters: extern "C" fn() -> &'static HandleCounters,
376376

377-
pub(super) run: extern "C" fn(Bridge<'_>) -> Buffer,
377+
pub(super) run: extern "C" fn(Bridge<'_>) -> Buffer<u8>,
378378

379379
pub(super) _marker: PhantomData<fn(I) -> O>,
380380
}
@@ -392,7 +392,7 @@ impl<I, O> Clone for Client<I, O> {
392392
fn run_client<A: for<'a, 's> DecodeMut<'a, 's, ()>, R: Encode<()>>(
393393
mut bridge: Bridge<'_>,
394394
f: impl FnOnce(A) -> R,
395-
) -> Buffer {
395+
) -> Buffer<u8> {
396396
// The initial `cached_buffer` contains the input.
397397
let mut buf = bridge.cached_buffer.take();
398398

library/proc_macro/src/bridge/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,10 @@ use rpc::{Decode, DecodeMut, Encode, Reader, Writer};
226226
pub struct Bridge<'a> {
227227
/// Reusable buffer (only `clear`-ed, never shrunk), primarily
228228
/// used for making requests, but also for passing input to client.
229-
cached_buffer: Buffer,
229+
cached_buffer: Buffer<u8>,
230230

231231
/// Server-side function that the client uses to make requests.
232-
dispatch: closure::Closure<'a, Buffer, Buffer>,
232+
dispatch: closure::Closure<'a, Buffer<u8>, Buffer<u8>>,
233233

234234
/// If 'true', always invoke the default panic hook
235235
force_show_panics: bool,

library/proc_macro/src/bridge/rpc.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use std::num::NonZeroU32;
77
use std::ops::Bound;
88
use std::str;
99

10-
pub(super) type Writer = super::buffer::Buffer;
10+
pub(super) type Writer = super::buffer::Buffer<u8>;
1111

1212
pub(super) trait Encode<S>: Sized {
1313
fn encode(self, w: &mut Writer, s: &mut S);

library/proc_macro/src/bridge/server.rs

+15-15
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ macro_rules! define_dispatcher_impl {
7878
pub trait DispatcherTrait {
7979
// HACK(eddyb) these are here to allow `Self::$name` to work below.
8080
$(type $name;)*
81-
fn dispatch(&mut self, buf: Buffer) -> Buffer;
81+
fn dispatch(&mut self, buf: Buffer<u8>) -> Buffer<u8>;
8282
}
8383

8484
impl<S: Server> DispatcherTrait for Dispatcher<MarkedTypes<S>> {
8585
$(type $name = <MarkedTypes<S> as Types>::$name;)*
86-
fn dispatch(&mut self, mut buf: Buffer) -> Buffer {
86+
fn dispatch(&mut self, mut buf: Buffer<u8>) -> Buffer<u8> {
8787
let Dispatcher { handle_store, server } = self;
8888

8989
let mut reader = &buf[..];
@@ -121,10 +121,10 @@ pub trait ExecutionStrategy {
121121
fn run_bridge_and_client(
122122
&self,
123123
dispatcher: &mut impl DispatcherTrait,
124-
input: Buffer,
125-
run_client: extern "C" fn(Bridge<'_>) -> Buffer,
124+
input: Buffer<u8>,
125+
run_client: extern "C" fn(Bridge<'_>) -> Buffer<u8>,
126126
force_show_panics: bool,
127-
) -> Buffer;
127+
) -> Buffer<u8>;
128128
}
129129

130130
pub struct SameThread;
@@ -133,10 +133,10 @@ impl ExecutionStrategy for SameThread {
133133
fn run_bridge_and_client(
134134
&self,
135135
dispatcher: &mut impl DispatcherTrait,
136-
input: Buffer,
137-
run_client: extern "C" fn(Bridge<'_>) -> Buffer,
136+
input: Buffer<u8>,
137+
run_client: extern "C" fn(Bridge<'_>) -> Buffer<u8>,
138138
force_show_panics: bool,
139-
) -> Buffer {
139+
) -> Buffer<u8> {
140140
let mut dispatch = |buf| dispatcher.dispatch(buf);
141141

142142
run_client(Bridge {
@@ -157,10 +157,10 @@ impl ExecutionStrategy for CrossThread1 {
157157
fn run_bridge_and_client(
158158
&self,
159159
dispatcher: &mut impl DispatcherTrait,
160-
input: Buffer,
161-
run_client: extern "C" fn(Bridge<'_>) -> Buffer,
160+
input: Buffer<u8>,
161+
run_client: extern "C" fn(Bridge<'_>) -> Buffer<u8>,
162162
force_show_panics: bool,
163-
) -> Buffer {
163+
) -> Buffer<u8> {
164164
use std::sync::mpsc::channel;
165165

166166
let (req_tx, req_rx) = channel();
@@ -194,10 +194,10 @@ impl ExecutionStrategy for CrossThread2 {
194194
fn run_bridge_and_client(
195195
&self,
196196
dispatcher: &mut impl DispatcherTrait,
197-
input: Buffer,
198-
run_client: extern "C" fn(Bridge<'_>) -> Buffer,
197+
input: Buffer<u8>,
198+
run_client: extern "C" fn(Bridge<'_>) -> Buffer<u8>,
199199
force_show_panics: bool,
200-
) -> Buffer {
200+
) -> Buffer<u8> {
201201
use std::sync::{Arc, Mutex};
202202

203203
enum State<T> {
@@ -260,7 +260,7 @@ fn run_server<
260260
handle_counters: &'static client::HandleCounters,
261261
server: S,
262262
input: I,
263-
run_client: extern "C" fn(Bridge<'_>) -> Buffer,
263+
run_client: extern "C" fn(Bridge<'_>) -> Buffer<u8>,
264264
force_show_panics: bool,
265265
) -> Result<O, PanicMessage> {
266266
let mut dispatcher =

0 commit comments

Comments
 (0)