1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
use std::alloc::{alloc, dealloc, handle_alloc_error, realloc, Layout};
use std::fmt;
use std::mem::{align_of, ManuallyDrop};
use std::ops::{Add, AddAssign};
use std::ptr;
pub struct Buffer {
data: *mut u8,
len: usize,
capacity: usize,
}
impl Buffer {
#[inline]
pub const fn new() -> Buffer {
Self {
data: align_of::<u8>() as *mut u8, len: 0,
capacity: 0,
}
}
#[inline]
pub fn with_capacity(n: usize) -> Buffer {
if unlikely!(n == 0) {
Self::new()
} else {
Self {
data: safe_alloc(n),
len: 0,
capacity: n,
}
}
}
#[inline]
pub fn as_str(&self) -> &str {
unsafe {
let bytes = std::slice::from_raw_parts(self.data, self.len);
std::str::from_utf8_unchecked(bytes)
}
}
#[inline]
pub fn as_mut_ptr(&self) -> *mut u8 {
self.data
}
#[inline]
pub fn len(&self) -> usize {
self.len
}
#[inline]
pub fn capacity(&self) -> usize {
self.capacity
}
#[inline]
#[doc(hidden)]
pub unsafe fn _set_len(&mut self, new_len: usize) {
debug_assert!(new_len <= self.capacity);
self.len = new_len;
}
#[inline]
pub unsafe fn advance(&mut self, additional: usize) {
self.len += additional;
}
#[inline]
pub fn is_empty(&self) -> bool {
self.len == 0
}
#[inline]
pub fn reserve(&mut self, size: usize) {
if likely!(size <= self.capacity - self.len) {
return;
}
self.reserve_internal(size);
}
#[inline]
pub(crate) unsafe fn reserve_small(&mut self, size: usize) {
debug_assert!(size <= std::isize::MAX as usize);
if likely!(self.len + size <= self.capacity) {
return;
}
self.reserve_internal(size);
}
#[inline]
#[doc(hidden)]
pub fn clear(&mut self) {
self.len = 0;
}
#[inline]
pub fn into_string(self) -> String {
debug_assert!(self.len <= self.capacity);
let buf = ManuallyDrop::new(self);
unsafe { String::from_raw_parts(buf.data, buf.len, buf.capacity) }
}
#[inline]
pub fn push_str(&mut self, data: &str) {
let size = data.len();
unsafe {
self.reserve_small(size);
let p = self.data.add(self.len);
std::ptr::copy_nonoverlapping(data.as_ptr(), p, size);
self.len += size;
}
debug_assert!(self.len <= self.capacity);
}
#[inline]
pub fn push(&mut self, data: char) {
unsafe {
self.reserve_small(4);
let bp = self.data.add(self.len) as *mut [u8; 4];
let result = data.encode_utf8(&mut *bp);
self.len += result.len();
}
}
#[cfg_attr(feature = "perf-inline", inline)]
fn reserve_internal(&mut self, size: usize) {
debug_assert!(size <= std::isize::MAX as usize);
let new_capacity = std::cmp::max(self.capacity * 2, self.capacity + size);
debug_assert!(new_capacity > self.capacity);
self.data = unsafe { safe_realloc(self.data, self.capacity, new_capacity) };
self.capacity = new_capacity;
debug_assert!(!self.data.is_null());
debug_assert!(self.len <= self.capacity);
}
}
#[inline(never)]
fn safe_alloc(capacity: usize) -> *mut u8 {
assert!(capacity > 0);
assert!(
capacity <= std::isize::MAX as usize,
"capacity is too large"
);
unsafe {
let layout = Layout::from_size_align_unchecked(capacity, 1);
let data = alloc(layout);
if data.is_null() {
handle_alloc_error(layout);
}
data
}
}
#[cold]
#[inline(never)]
unsafe fn safe_realloc(ptr: *mut u8, capacity: usize, new_capacity: usize) -> *mut u8 {
assert!(new_capacity > 0);
assert!(
new_capacity <= std::isize::MAX as usize,
"capacity is too large"
);
let data = if unlikely!(capacity == 0) {
let new_layout = Layout::from_size_align_unchecked(new_capacity, 1);
alloc(new_layout)
} else {
let old_layout = Layout::from_size_align_unchecked(capacity, 1);
realloc(ptr, old_layout, new_capacity)
};
if data.is_null() {
handle_alloc_error(Layout::from_size_align_unchecked(new_capacity, 1));
}
data
}
impl Clone for Buffer {
fn clone(&self) -> Self {
unsafe {
if self.is_empty() {
Self::new()
} else {
let buf = Self {
data: safe_alloc(self.len),
len: self.len,
capacity: self.len,
};
ptr::copy_nonoverlapping(self.data, buf.data, self.len);
buf
}
}
}
}
impl fmt::Debug for Buffer {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
self.as_str().fmt(f)
}
}
impl Drop for Buffer {
fn drop(&mut self) {
if self.capacity != 0 {
unsafe {
let layout = Layout::from_size_align_unchecked(self.capacity, 1);
dealloc(self.data, layout);
}
}
}
}
impl fmt::Write for Buffer {
#[inline]
fn write_str(&mut self, s: &str) -> fmt::Result {
Buffer::push_str(self, s);
Ok(())
}
}
impl From<String> for Buffer {
#[inline]
fn from(other: String) -> Buffer {
let bs = other.into_boxed_str();
let data = Box::leak(bs);
Buffer {
data: data.as_mut_ptr(),
len: data.len(),
capacity: data.len(),
}
}
}
impl From<&str> for Buffer {
#[inline]
fn from(other: &str) -> Buffer {
let mut buf = Buffer::with_capacity(other.len());
if !other.is_empty() {
unsafe {
ptr::copy_nonoverlapping(other.as_ptr(), buf.as_mut_ptr(), other.len());
buf.advance(other.len());
}
}
buf
}
}
impl Add<&str> for Buffer {
type Output = Buffer;
#[inline]
fn add(mut self, other: &str) -> Buffer {
self.push_str(other);
self
}
}
impl AddAssign<&str> for Buffer {
#[inline]
fn add_assign(&mut self, other: &str) {
self.push_str(other)
}
}
impl Default for Buffer {
#[inline]
fn default() -> Buffer {
Buffer::new()
}
}
unsafe impl Send for Buffer {}
unsafe impl Sync for Buffer {}
#[cfg(test)]
mod tests {
use super::*;
use std::sync::{Arc, Barrier, Mutex};
use std::thread;
#[test]
fn push_str() {
let mut buffer = Buffer::new();
assert_eq!(buffer.len(), 0);
assert_eq!(buffer.capacity(), 0);
buffer.push_str("apple");
assert_eq!(buffer.len(), 5);
assert_eq!(buffer.capacity(), 5);
buffer.push_str("pie");
assert_eq!(buffer.len(), 8);
assert_eq!(buffer.capacity(), 10);
for _ in 0..16 {
buffer.push_str("zomg");
}
assert_eq!(buffer.len(), 72);
assert_eq!(buffer.capacity(), 80);
}
#[test]
fn with_capacity() {
let buffer = Buffer::with_capacity(1);
assert!(buffer.is_empty());
assert_eq!(buffer.len(), 0);
assert!(buffer.capacity() >= 1);
}
#[test]
fn string_conversion() {
let s = String::with_capacity(2);
assert!(s.capacity() >= 2);
let mut buf = Buffer::from(s);
assert_eq!(buf.as_str(), "");
assert_eq!(buf.capacity(), 0);
buf.push_str("abc");
assert_eq!(buf.as_str(), "abc");
let mut s = buf.into_string();
assert_eq!(s, "abc");
s += "defghijklmn";
assert_eq!(s, "abcdefghijklmn");
let mut buf = Buffer::from(s);
assert_eq!(buf.as_str(), "abcdefghijklmn");
buf.clear();
assert_eq!(buf.as_str(), "");
let buf = Buffer::default();
let mut s = buf.into_string();
assert_eq!(s, "");
s.push_str("apple");
assert_eq!(s, "apple");
}
#[test]
fn from_str() {
let buf = Buffer::from("abcdefgh");
assert_eq!(buf.as_str(), "abcdefgh");
}
#[test]
fn clone() {
use std::fmt::Write;
let mut s1 = Buffer::with_capacity(0);
let mut s2 = s1.clone();
s1.push('a');
s2.push_str("b");
assert_eq!(s1.as_str(), "a");
assert_eq!(s2.as_str(), "b");
let mut s1 = Buffer::from("foo");
let mut s2 = s1.clone();
s1 = s1 + "bar";
write!(s2, "baz").unwrap();
assert_eq!(s1.as_str(), "foobar");
assert_eq!(s2.as_str(), "foobaz");
s2.clear();
let _ = s2.clone();
}
#[test]
fn push() {
for initial_capacity in &[0, 4, 16] {
let mut s = Buffer::with_capacity(*initial_capacity);
s.push('a');
s.push('é');
s.push('A');
s.push('🄫');
assert_eq!(s.as_str(), "aéA🄫");
}
}
#[test]
fn multi_thread() {
const THREADS: usize = 8;
const ITERS: usize = 100;
let barrier = Arc::new(Barrier::new(THREADS));
let buffer = Arc::new(Mutex::new(Buffer::new()));
let mut handles = Vec::with_capacity(THREADS);
for _ in 0..THREADS {
let barrier = barrier.clone();
let buffer = buffer.clone();
handles.push(thread::spawn(move || {
barrier.wait();
for _ in 0..ITERS {
buffer.lock().unwrap().push_str("a");
}
}));
}
for handle in handles {
handle.join().unwrap();
}
assert_eq!(buffer.lock().unwrap().as_str(), "a".repeat(ITERS * THREADS));
}
#[test]
#[should_panic]
fn reserve_overflow() {
let mut buf = Buffer::new();
buf.reserve(std::isize::MAX as usize + 1);
}
#[test]
#[should_panic]
fn empty_alloc() {
safe_alloc(0);
}
}