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 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
|
/*
* Copyright (C) 2020-2023 Fanout, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::future::{AsyncWrite, AsyncWriteExt};
use std::cell::RefCell;
use std::cmp;
use std::io;
use std::io::{Read, Write};
use std::mem::{self, MaybeUninit};
use std::rc::Rc;
use std::slice;
pub const VECTORED_MAX: usize = 8;
pub fn trim_for_display(s: &str, max: usize) -> String {
// NOTE: O(n)
let char_len = s.chars().count();
if char_len > max && max >= 7 {
let dist = max / 2;
let mut left_end = 0;
let mut right_start = 0;
// NOTE: O(n)
for (i, (pos, _)) in s.char_indices().enumerate() {
// dist guaranteed to be < char_len
if i == dist {
left_end = pos;
}
// (char_len - dist + 3) guaranteed to be < char_len
if i == char_len - dist + 3 {
right_start = pos;
}
}
let left = &s[..left_end];
let right = &s[right_start..];
format!("{}...{}", left, right)
} else {
s.to_owned()
}
}
#[allow(clippy::len_without_is_empty)]
pub trait RefRead {
fn len(&self) -> usize;
fn get_ref(&self) -> &[u8];
fn get_mut(&mut self) -> &mut [u8];
fn consume(&mut self, amt: usize);
fn get_ref_vectored<'data, 'bufs>(
&'data self,
bufs: &'bufs mut [&'data [u8]],
) -> &'bufs mut [&'data [u8]] {
assert!(!bufs.is_empty());
bufs[0] = self.get_ref();
&mut bufs[..1]
}
fn get_mut_vectored<'data, 'bufs, const N: usize>(
&'data mut self,
bufs: &'bufs mut MaybeUninit<[&'data mut [u8]; N]>,
) -> &'bufs mut [&'data mut [u8]] {
let bufs = unsafe { bufs.assume_init_mut() };
bufs[0] = self.get_mut();
&mut bufs[..1]
}
}
impl RefRead for io::Cursor<&mut [u8]> {
fn len(&self) -> usize {
RefRead::get_ref(self).len()
}
fn get_ref(&self) -> &[u8] {
let pos = self.position() as usize;
&self.get_ref()[pos..]
}
fn get_mut(&mut self) -> &mut [u8] {
let pos = self.position() as usize;
&mut self.get_mut()[pos..]
}
fn consume(&mut self, amt: usize) {
let pos = self.position();
self.set_position(pos + (amt as u64));
}
}
pub fn write_vectored_offset<W: Write>(
writer: &mut W,
bufs: &[&[u8]],
offset: usize,
) -> Result<usize, io::Error> {
if bufs.is_empty() {
return Ok(0);
}
let mut offset = offset;
let mut start = 0;
while offset >= bufs[start].len() {
// on the last buf?
if start + 1 >= bufs.len() {
// exceeding the last buf is an error
if offset > bufs[start].len() {
return Err(io::Error::from(io::ErrorKind::InvalidInput));
}
return Ok(0);
}
offset -= bufs[start].len();
start += 1;
}
let mut arr = [io::IoSlice::new(&b""[..]); VECTORED_MAX];
let mut arr_len = 0;
for (index, &buf) in bufs.iter().enumerate().skip(start) {
let buf = if index == start { &buf[offset..] } else { buf };
arr[arr_len] = io::IoSlice::new(buf);
arr_len += 1;
}
writer.write_vectored(&arr[..arr_len])
}
pub async fn write_vectored_offset_async<W: AsyncWrite>(
writer: &mut W,
bufs: &[&[u8]],
offset: usize,
) -> Result<usize, io::Error> {
if bufs.is_empty() {
return Ok(0);
}
let mut offset = offset;
let mut start = 0;
while offset >= bufs[start].len() {
// on the last buf?
if start + 1 >= bufs.len() {
// exceeding the last buf is an error
if offset > bufs[start].len() {
return Err(io::Error::from(io::ErrorKind::InvalidInput));
}
return Ok(0);
}
offset -= bufs[start].len();
start += 1;
}
let mut arr = [io::IoSlice::new(&b""[..]); VECTORED_MAX];
let mut arr_len = 0;
for (index, &buf) in bufs.iter().enumerate().skip(start) {
let buf = if index == start { &buf[offset..] } else { buf };
arr[arr_len] = io::IoSlice::new(buf);
arr_len += 1;
}
writer.write_vectored(&arr[..arr_len]).await
}
struct LimitBufsRestore<T> {
index: usize,
ptr: T,
len: usize,
}
pub struct LimitBufsGuard<'a, 'b> {
bufs: &'b mut [&'a [u8]],
start: usize,
end: usize,
restore: Option<LimitBufsRestore<*const u8>>,
}
impl<'a: 'b, 'b> LimitBufsGuard<'a, 'b> {
pub fn as_slice(&self) -> &[&'a [u8]] {
&self.bufs[self.start..self.end]
}
}
impl<'a: 'b, 'b> Drop for LimitBufsGuard<'a, 'b> {
fn drop(&mut self) {
if let Some(restore) = self.restore.take() {
// SAFETY: ptr and len were collected earlier from the original
// memory referred to by the slice at this index and they are
// still valid. the only issue with reconstructing the slice is
// that we currently have a different slice using the same memory
// at this index. however, this is safe because we also replace
// the slice at this index and the two slices don't coexist
unsafe {
self.bufs[restore.index] = slice::from_raw_parts(restore.ptr, restore.len);
}
}
}
}
pub struct LimitBufsMutGuard<'a, 'b> {
bufs: &'b mut [&'a mut [u8]],
start: usize,
end: usize,
restore: Option<LimitBufsRestore<*mut u8>>,
}
impl<'a: 'b, 'b> LimitBufsMutGuard<'a, 'b> {
pub fn as_slice(&mut self) -> &mut [&'a mut [u8]] {
&mut self.bufs[self.start..self.end]
}
}
impl<'a: 'b, 'b> Drop for LimitBufsMutGuard<'a, 'b> {
fn drop(&mut self) {
if let Some(restore) = self.restore.take() {
// SAFETY: ptr and len were collected earlier from the original
// memory referred to by the slice at this index and they are
// still valid. the only issue with reconstructing the slice is
// that we currently have a different slice using the same memory
// at this index. however, this is safe because we also replace
// the slice at this index and the two slices don't coexist
unsafe {
self.bufs[restore.index] = slice::from_raw_parts_mut(restore.ptr, restore.len);
}
}
}
}
pub trait LimitBufs<'a, 'b> {
fn limit(&'b mut self, size: usize) -> LimitBufsGuard<'a, 'b>;
}
impl<'a: 'b, 'b> LimitBufs<'a, 'b> for [&'a [u8]] {
fn limit(&'b mut self, size: usize) -> LimitBufsGuard<'a, 'b> {
let mut end = self.len();
let mut restore = None;
let mut want = size;
for (index, item) in self.iter_mut().enumerate() {
let buf: &[u8] = item;
let buf_len = buf.len();
if buf_len >= want {
let len = buf.len();
let ptr = buf.as_ptr();
restore = Some(LimitBufsRestore { index, ptr, len });
// SAFETY: ptr and len were obtained above and are still
// valid. we just need to be careful about using them again
// later on from the restore field
unsafe {
*item = &slice::from_raw_parts(ptr, len)[..want];
}
end = index + 1;
break;
}
want -= buf_len;
}
LimitBufsGuard {
bufs: self,
start: 0,
end,
restore,
}
}
}
pub trait LimitBufsMut<'a: 'b, 'b> {
fn skip(&'b mut self, size: usize) -> LimitBufsMutGuard<'a, 'b>;
fn limit(&'b mut self, size: usize) -> LimitBufsMutGuard<'a, 'b>;
}
impl<'a: 'b, 'b> LimitBufsMut<'a, 'b> for [&'a mut [u8]] {
fn skip(&'b mut self, size: usize) -> LimitBufsMutGuard<'a, 'b> {
let mut start = 0;
let end = self.len();
let mut restore = None;
let mut skip = size;
for (index, item) in self.iter_mut().enumerate() {
let buf: &mut [u8] = item;
let buf_len = buf.len();
if buf_len >= skip {
let len = buf.len();
let ptr = buf.as_mut_ptr();
restore = Some(LimitBufsRestore { index, ptr, len });
// SAFETY: ptr and len were obtained above and are still
// valid. we just need to be careful about using them again
// later on from the restore field
unsafe {
*item = &mut slice::from_raw_parts_mut(ptr, len)[skip..];
}
start = index;
break;
}
skip -= buf_len;
}
LimitBufsMutGuard {
bufs: self,
start,
end,
restore,
}
}
fn limit(&'b mut self, size: usize) -> LimitBufsMutGuard<'a, 'b> {
let mut end = self.len();
let mut restore = None;
let mut want = size;
for (index, item) in self.iter_mut().enumerate() {
let buf: &mut [u8] = item;
let buf_len = buf.len();
if buf_len >= want {
let len = buf.len();
let ptr = buf.as_mut_ptr();
restore = Some(LimitBufsRestore { index, ptr, len });
// SAFETY: ptr and len were obtained above and are still
// valid. we just need to be careful about using them again
// later on from the restore field
unsafe {
*item = &mut slice::from_raw_parts_mut(ptr, len)[..want];
}
end = index + 1;
break;
}
want -= buf_len;
}
LimitBufsMutGuard {
bufs: self,
start: 0,
end,
restore,
}
}
}
pub struct Buffer {
buf: Vec<u8>,
start: usize,
end: usize,
}
impl Buffer {
pub fn new(size: usize) -> Buffer {
let buf = vec![0; size];
Buffer {
buf,
start: 0,
end: 0,
}
}
pub fn clear(&mut self) {
self.start = 0;
self.end = 0;
}
pub fn read_avail(&self) -> usize {
self.end - self.start
}
pub fn read_buf(&self) -> &[u8] {
&self.buf[self.start..self.end]
}
pub fn read_commit(&mut self, amount: usize) {
assert!(self.start + amount <= self.end);
self.start += amount;
}
pub fn write_avail(&self) -> usize {
self.buf.len() - self.end
}
pub fn write_buf(&mut self) -> &mut [u8] {
let len = self.buf.len();
&mut self.buf[self.end..len]
}
pub fn write_commit(&mut self, amount: usize) {
assert!(self.end + amount <= self.buf.len());
self.end += amount;
}
}
#[cfg(test)]
impl Read for Buffer {
fn read(&mut self, buf: &mut [u8]) -> Result<usize, io::Error> {
// fully qualified to work around future method warning
// https://github.com/rust-lang/rust/issues/48919
let src = Buffer::read_buf(self);
let size = cmp::min(src.len(), buf.len());
buf[..size].copy_from_slice(&src[..size]);
self.read_commit(size);
Ok(size)
}
}
impl Write for Buffer {
fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
if !buf.is_empty() && self.write_avail() == 0 {
return Err(io::Error::from(io::ErrorKind::WriteZero));
}
let dest = self.write_buf();
let size = cmp::min(dest.len(), buf.len());
dest[..size].copy_from_slice(&buf[..size]);
self.write_commit(size);
Ok(size)
}
fn flush(&mut self) -> Result<(), io::Error> {
Ok(())
}
}
pub struct TmpBuffer(RefCell<Vec<u8>>);
#[allow(clippy::len_without_is_empty)]
impl TmpBuffer {
pub fn new(size: usize) -> Self {
Self(RefCell::new(vec![0; size]))
}
pub fn len(&self) -> usize {
self.0.borrow().len()
}
}
// holds a Vec<u8> but only exposes the portion of it considered to be
// readable ("filled"). any remaining bytes may be zeroed or uninitialized
// and are not considered to be readable
pub struct FilledBuf {
data: Vec<u8>,
filled: usize,
}
impl FilledBuf {
// panics if filled is larger than data.len()
pub fn new(data: Vec<u8>, filled: usize) -> Self {
assert!(filled <= data.len());
Self { data, filled }
}
pub fn filled(&self) -> &[u8] {
&self.data[..self.filled]
}
pub fn filled_len(&self) -> usize {
self.filled
}
pub fn into_inner(self) -> Vec<u8> {
self.data
}
}
pub struct BaseRingBuffer<T> {
buf: T,
start: usize,
end: usize,
tmp: Rc<TmpBuffer>,
}
impl<T: AsRef<[u8]> + AsMut<[u8]>> BaseRingBuffer<T> {
pub fn capacity(&self) -> usize {
self.buf.as_ref().len()
}
pub fn clear(&mut self) {
self.start = 0;
self.end = 0;
}
pub fn write_from<R: Read>(&mut self, r: &mut R) -> Result<usize, io::Error> {
let size = match r.read(self.write_buf()) {
Ok(size) => size,
Err(e) => return Err(e),
};
self.write_commit(size);
Ok(size)
}
pub fn read_avail(&self) -> usize {
self.end - self.start
}
pub fn read_buf(&self) -> &[u8] {
let buf = self.buf.as_ref();
let end = cmp::min(self.end, buf.len());
&buf[self.start..end]
}
pub fn read_buf_mut(&mut self) -> &mut [u8] {
let buf = self.buf.as_mut();
let end = cmp::min(self.end, buf.len());
&mut buf[self.start..end]
}
pub fn read_commit(&mut self, amount: usize) {
assert!(self.start + amount <= self.end);
let buf = self.buf.as_ref();
self.start += amount;
if self.start == self.end {
self.start = 0;
self.end = 0;
} else if self.start >= buf.len() {
self.start -= buf.len();
self.end -= buf.len();
}
}
pub fn write_avail(&self) -> usize {
self.buf.as_ref().len() - (self.end - self.start)
}
pub fn write_buf(&mut self) -> &mut [u8] {
let buf = self.buf.as_mut();
let (start, end) = if self.end < buf.len() {
(self.end, buf.len())
} else {
(self.end - buf.len(), self.start)
};
&mut buf[start..end]
}
pub fn write_commit(&mut self, amount: usize) {
assert!((self.end - self.start) + amount <= self.buf.as_ref().len());
self.end += amount;
}
// return true if the readable bytes have not wrapped
pub fn is_readable_contiguous(&self) -> bool {
self.end <= self.buf.as_ref().len()
}
pub fn align(&mut self) -> usize {
if self.start == 0 {
return 0;
}
let buf = self.buf.as_mut();
let size = self.end - self.start;
if self.end <= buf.len() {
// if the buffer hasn't wrapped, simply copy down
buf.copy_within(self.start.., 0);
} else if size <= self.start {
// if the buffer has wrapped, but the wrapped part can be copied
// without overlapping, then copy the wrapped part followed by
// initial part
let left_size = self.end - buf.len();
let right_size = buf.len() - self.start;
buf.copy_within(..left_size, right_size);
buf.copy_within(self.start..(self.start + right_size), 0);
} else {
// if the buffer has wrapped and the wrapped part can't be copied
// without overlapping, then use a temporary buffer to
// facilitate. smaller part is copied to the temp buffer, then
// the larger and small parts (in that order) are copied into
// their intended locations. in the worst case, up to 50% of
// the buffer may be copied twice
let left_size = self.end - buf.len();
let right_size = buf.len() - self.start;
let (lsize, lsrc, ldest, hsize, hsrc, hdest);
if left_size < right_size {
lsize = left_size;
hsize = right_size;
lsrc = 0;
ldest = hsize;
hsrc = self.start;
hdest = 0;
} else {
lsize = right_size;
hsize = left_size;
lsrc = self.start;
ldest = 0;
hsrc = 0;
hdest = lsize;
}
let mut tmp = self.tmp.0.borrow_mut();
tmp[..lsize].copy_from_slice(&buf[lsrc..(lsrc + lsize)]);
buf.copy_within(hsrc..(hsrc + hsize), hdest);
buf[ldest..(ldest + lsize)].copy_from_slice(&tmp[..lsize]);
}
self.start = 0;
self.end = size;
size
}
pub fn get_tmp(&self) -> &Rc<TmpBuffer> {
&self.tmp
}
}
#[cfg(test)]
impl<T: AsRef<[u8]> + AsMut<[u8]>> Read for BaseRingBuffer<T> {
fn read(&mut self, buf: &mut [u8]) -> Result<usize, io::Error> {
let mut pos = 0;
while pos < buf.len() && self.read_avail() > 0 {
// fully qualified to work around future method warning
// https://github.com/rust-lang/rust/issues/48919
let src = Self::read_buf(self);
let size = cmp::min(src.len(), buf.len() - pos);
buf[pos..(pos + size)].copy_from_slice(&src[..size]);
self.read_commit(size);
pos += size;
}
Ok(pos)
}
}
impl<T: AsRef<[u8]> + AsMut<[u8]>> Write for BaseRingBuffer<T> {
fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
if !buf.is_empty() && self.write_avail() == 0 {
return Err(io::Error::from(io::ErrorKind::WriteZero));
}
let mut pos = 0;
while pos < buf.len() && self.write_avail() > 0 {
let dest = self.write_buf();
let size = cmp::min(dest.len(), buf.len() - pos);
dest[..size].copy_from_slice(&buf[pos..(pos + size)]);
self.write_commit(size);
pos += size;
}
Ok(pos)
}
fn flush(&mut self) -> Result<(), io::Error> {
Ok(())
}
}
impl<T: AsRef<[u8]> + AsMut<[u8]>> RefRead for BaseRingBuffer<T> {
fn len(&self) -> usize {
self.read_avail()
}
fn get_ref(&self) -> &[u8] {
self.read_buf()
}
fn get_mut(&mut self) -> &mut [u8] {
self.read_buf_mut()
}
fn consume(&mut self, amt: usize) {
self.read_commit(amt);
}
fn get_ref_vectored<'data, 'bufs>(
&'data self,
bufs: &'bufs mut [&'data [u8]],
) -> &'bufs mut [&'data [u8]] {
assert!(!bufs.is_empty());
let buf = self.buf.as_ref();
let buf_len = buf.len();
if self.end > buf_len && bufs.len() >= 2 {
let (part1, part2) = buf.split_at(self.start);
bufs[0] = part2;
bufs[1] = &part1[..(self.end - buf_len)];
&mut bufs[..2]
} else {
bufs[0] = &buf[self.start..self.end];
&mut bufs[..1]
}
}
fn get_mut_vectored<'data, 'bufs, const N: usize>(
&'data mut self,
bufs: &'bufs mut MaybeUninit<[&'data mut [u8]; N]>,
) -> &'bufs mut [&'data mut [u8]] {
let bufs = unsafe { bufs.assume_init_mut() };
let buf = self.buf.as_mut();
let buf_len = buf.len();
if self.end > buf_len && bufs.len() >= 2 {
let (part1, part2) = buf.split_at_mut(self.start);
bufs[0] = part2;
bufs[1] = &mut part1[..(self.end - buf_len)];
&mut bufs[..2]
} else {
bufs[0] = &mut buf[self.start..self.end];
&mut bufs[..1]
}
}
}
impl BaseRingBuffer<Vec<u8>> {
pub fn new(size: usize, tmp: &Rc<TmpBuffer>) -> Self {
assert!(size <= tmp.len());
let buf = vec![0; size];
BaseRingBuffer {
buf,
start: 0,
end: 0,
tmp: Rc::clone(tmp),
}
}
// extract inner buffer, aligning it first if necessary, and replace it
// with an empty buffer. this should be cheap if the inner buffer is
// already aligned. afterwards, the ringbuffer will have a capacity of
// zero and will be essentially unusable until set_inner is called with a
// non-empty buffer
pub fn take_inner(&mut self) -> FilledBuf {
self.align();
let data = mem::take(&mut self.buf);
let filled = self.end;
self.end = 0;
FilledBuf::new(data, filled)
}
// replace the inner buffer. this should be cheap if the original inner
// buffer is empty, which is the case if take_inner was called earlier.
// panics if the new buffer is larger than the tmp buffer
pub fn set_inner(&mut self, buf: FilledBuf) {
let filled = buf.filled_len();
let data = buf.into_inner();
assert!(data.len() <= self.tmp.len());
self.buf = data;
self.start = 0;
self.end = filled;
}
pub fn swap_inner(&mut self, other: &mut Self) {
let buf = self.take_inner();
self.set_inner(other.take_inner());
other.set_inner(buf);
}
}
impl<'a> BaseRingBuffer<&'a mut [u8]> {
pub fn new(buf: &'a mut [u8], tmp: &Rc<TmpBuffer>) -> Self {
assert!(buf.len() <= tmp.len());
BaseRingBuffer {
buf,
start: 0,
end: 0,
tmp: Rc::clone(tmp),
}
}
}
pub type RingBuffer = BaseRingBuffer<Vec<u8>>;
pub type SliceRingBuffer<'a> = BaseRingBuffer<&'a mut [u8]>;
#[cfg(test)]
mod tests {
use super::*;
use std::io::{Read, Write};
#[test]
fn test_write_vectored_offset() {
struct MyWriter {
bufs: Vec<String>,
}
impl MyWriter {
fn new() -> Self {
Self { bufs: Vec::new() }
}
}
impl Write for MyWriter {
fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
self.bufs.push(String::from_utf8(buf.to_vec()).unwrap());
Ok(buf.len())
}
fn write_vectored(&mut self, bufs: &[io::IoSlice]) -> Result<usize, io::Error> {
let mut total = 0;
for buf in bufs {
total += buf.len();
self.bufs.push(String::from_utf8(buf.to_vec()).unwrap());
}
Ok(total)
}
fn flush(&mut self) -> Result<(), io::Error> {
Ok(())
}
}
// empty
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[], 0);
assert_eq!(r.unwrap(), 0);
// offset too large
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple"], 6);
assert!(r.is_err());
// offset too large
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple", b"banana"], 12);
assert!(r.is_err());
// nothing to write
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple"], 5);
assert_eq!(r.unwrap(), 0);
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple"], 0);
assert_eq!(r.unwrap(), 5);
assert_eq!(w.bufs.len(), 1);
assert_eq!(w.bufs[0], "apple");
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple"], 3);
assert_eq!(r.unwrap(), 2);
assert_eq!(w.bufs.len(), 1);
assert_eq!(w.bufs[0], "le");
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple", b"banana"], 3);
assert_eq!(r.unwrap(), 8);
assert_eq!(w.bufs.len(), 2);
assert_eq!(w.bufs[0], "le");
assert_eq!(w.bufs[1], "banana");
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple", b"banana"], 5);
assert_eq!(r.unwrap(), 6);
assert_eq!(w.bufs.len(), 1);
assert_eq!(w.bufs[0], "banana");
let mut w = MyWriter::new();
let r = write_vectored_offset(&mut w, &[b"apple", b"banana"], 6);
assert_eq!(r.unwrap(), 5);
assert_eq!(w.bufs.len(), 1);
assert_eq!(w.bufs[0], "anana");
}
#[test]
fn test_buffer() {
let mut b = Buffer::new(8);
assert_eq!(b.read_avail(), 0);
assert_eq!(b.write_avail(), 8);
let size = b.write(b"hello").unwrap();
assert_eq!(size, 5);
assert_eq!(b.read_avail(), 5);
assert_eq!(b.write_avail(), 3);
let size = b.write(b"world").unwrap();
assert_eq!(size, 3);
assert_eq!(b.read_avail(), 8);
assert_eq!(b.write_avail(), 0);
let mut tmp = [0; 16];
let size = b.read(&mut tmp).unwrap();
assert_eq!(&tmp[..size], b"hellowor");
b.clear();
assert_eq!(b.read_avail(), 0);
assert_eq!(b.write_avail(), 8);
}
#[test]
fn test_ringbuffer() {
let mut buf = [0u8; 8];
let tmp = Rc::new(TmpBuffer::new(8));
let mut r = RingBuffer::new(8, &tmp);
assert_eq!(r.read_avail(), 0);
assert_eq!(r.write_avail(), 8);
r.write(b"12345").unwrap();
assert_eq!(r.read_avail(), 5);
assert_eq!(r.write_avail(), 3);
r.write(b"678").unwrap();
let mut bufs_arr = [&b""[..]; VECTORED_MAX];
let bufs = r.get_ref_vectored(&mut bufs_arr);
assert_eq!(r.read_avail(), 8);
assert_eq!(r.write_avail(), 0);
assert_eq!(r.read_buf(), b"12345678");
assert_eq!(bufs.len(), 1);
assert_eq!(bufs[0], b"12345678");
r.read(&mut buf[..5]).unwrap();
assert_eq!(r.read_avail(), 3);
assert_eq!(r.write_avail(), 5);
assert_eq!(r.write_buf().len(), 5);
r.write(b"9abcd").unwrap();
assert_eq!(r.read_avail(), 8);
assert_eq!(r.write_avail(), 0);
r.read(&mut buf[5..]).unwrap();
assert_eq!(r.read_avail(), 5);
assert_eq!(r.write_avail(), 3);
r.read(&mut buf[..5]).unwrap();
assert_eq!(r.read_avail(), 0);
assert_eq!(r.write_avail(), 8);
assert_eq!(&buf, b"9abcd678");
r.write(b"12345").unwrap();
r.read(&mut buf[..2]).unwrap();
let mut bufs_arr = [&b""[..]; VECTORED_MAX];
let bufs = r.get_ref_vectored(&mut bufs_arr);
assert_eq!(r.read_avail(), 3);
assert_eq!(r.read_buf(), b"345");
assert_eq!(bufs.len(), 1);
assert_eq!(bufs[0], b"345");
assert_eq!(r.write_avail(), 5);
assert_eq!(r.write_buf().len(), 3);
r.align();
assert_eq!(r.read_avail(), 3);
assert_eq!(r.read_buf(), b"345");
assert_eq!(r.write_avail(), 5);
assert_eq!(r.write_buf().len(), 5);
r.write(b"6789a").unwrap();
r.read(&mut buf[..2]).unwrap();
r.write(b"bc").unwrap();
let mut bufs_arr = [&b""[..]; VECTORED_MAX];
let bufs = r.get_ref_vectored(&mut bufs_arr);
assert_eq!(r.read_avail(), 8);
assert_eq!(r.read_buf(), b"56789a");
assert_eq!(bufs.len(), 2);
assert_eq!(bufs[0], b"56789a");
assert_eq!(bufs[1], b"bc");
assert_eq!(r.write_avail(), 0);
r.align();
assert_eq!(r.read_avail(), 8);
assert_eq!(r.read_buf(), b"56789abc");
assert_eq!(r.write_avail(), 0);
r.read(&mut buf[..6]).unwrap();
r.write(b"def123").unwrap();
let mut bufs_arr = [&b""[..]; VECTORED_MAX];
let bufs = r.get_ref_vectored(&mut bufs_arr);
assert_eq!(r.read_avail(), 8);
assert_eq!(r.read_buf(), b"bc");
assert_eq!(bufs.len(), 2);
assert_eq!(bufs[0], b"bc");
assert_eq!(bufs[1], b"def123");
assert_eq!(r.write_avail(), 0);
r.align();
let mut bufs_arr = [&b""[..]; VECTORED_MAX];
let bufs = r.get_ref_vectored(&mut bufs_arr);
assert_eq!(r.read_avail(), 8);
assert_eq!(r.read_buf(), b"bcdef123");
assert_eq!(bufs.len(), 1);
assert_eq!(bufs[0], b"bcdef123");
assert_eq!(r.write_avail(), 0);
r.clear();
r.write(b"12345678").unwrap();
r.read(&mut buf[..6]).unwrap();
r.write(b"9abc").unwrap();
assert_eq!(r.read_avail(), 6);
assert_eq!(r.read_buf().len(), 2);
r.align();
assert_eq!(r.read_avail(), 6);
assert_eq!(r.read_buf().len(), 6);
}
#[test]
fn test_slice_ringbuffer() {
let mut buf = [0; 8];
let mut backing_buf = [0; 8];
let tmp = Rc::new(TmpBuffer::new(8));
let mut r = SliceRingBuffer::new(&mut backing_buf, &tmp);
r.write(b"12345678").unwrap();
let size = r.read(&mut buf[..4]).unwrap();
assert_eq!(&buf[..size], b"1234");
r.write(b"90ab").unwrap();
let size = r.read(&mut buf).unwrap();
assert_eq!(&buf[..size], b"567890ab");
}
#[test]
fn test_limitbufs() {
let mut buf1 = [b'1', b'2', b'3', b'4'];
let mut buf2 = [b'5', b'6', b'7', b'8'];
let mut buf3 = [b'9', b'0', b'a', b'b'];
let mut bufs = [buf1.as_slice(), buf2.as_slice(), buf3.as_slice()];
{
let limited = bufs.limit(7);
let limited = limited.as_slice();
assert_eq!(limited.len(), 2);
assert_eq!(&limited[0], b"1234");
assert_eq!(&limited[1], b"567");
}
assert_eq!(bufs.len(), 3);
assert_eq!(&bufs[0], b"1234");
assert_eq!(&bufs[1], b"5678");
assert_eq!(&bufs[2], b"90ab");
let mut bufs = [
buf1.as_mut_slice(),
buf2.as_mut_slice(),
buf3.as_mut_slice(),
];
{
let mut limited = bufs.limit(7);
let limited = limited.as_slice();
assert_eq!(limited.len(), 2);
assert_eq!(&limited[0], b"1234");
assert_eq!(&limited[1], b"567");
}
{
let mut limited = bufs.skip(7);
let limited = limited.as_slice();
assert_eq!(limited.len(), 2);
assert_eq!(&limited[0], b"8");
assert_eq!(&limited[1], b"90ab");
}
assert_eq!(bufs.len(), 3);
assert_eq!(&bufs[0], b"1234");
assert_eq!(&bufs[1], b"5678");
assert_eq!(&bufs[2], b"90ab");
}
}
|