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
#[cfg(feature = "allocator_api")]
use std::alloc::Allocator;
use std::{
io::{IoSlice, IoSliceMut},
mem::MaybeUninit,
};
use crate::*;
/// A trait for buffers.
///
/// The `IoBuf` trait is implemented by buffer types that can be passed to
/// compio operations. Users will not need to use this trait directly.
///
/// # Safety
///
/// Buffers passed to compio operations must refer to a stable memory region.
/// While the runtime holds ownership to a buffer, the pointer returned
/// by `as_buf_ptr` must remain valid even if the `IoBuf` value is moved, i.e.,
/// the type implementing `IoBuf` should point to somewhere else.
pub unsafe trait IoBuf: Unpin + 'static {
/// Returns a raw pointer to the vector’s buffer.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// The implementation must ensure that, while the `compio` runtime
/// owns the value, the pointer returned **does not** change.
fn as_buf_ptr(&self) -> *const u8;
/// Number of initialized bytes.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// For [`Vec`], this is identical to `len()`.
fn buf_len(&self) -> usize;
/// Total size of the buffer, including uninitialized memory, if any.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// For [`Vec`], this is identical to `capacity()`.
fn buf_capacity(&self) -> usize;
/// Get the initialized part of the buffer.
fn as_slice(&self) -> &[u8] {
unsafe { std::slice::from_raw_parts(self.as_buf_ptr(), self.buf_len()) }
}
/// # Safety
///
/// The return slice will not live longer than self.
/// It is static to provide convenience from writing self-referenced
/// structure.
#[doc(hidden)]
unsafe fn as_io_slice(&self) -> IoSlice<'static> {
IoSlice::new(std::mem::transmute(self.as_slice()))
}
/// Returns a view of the buffer with the specified range.
///
/// This method is similar to Rust's slicing (`&buf[..]`), but takes
/// ownership of the buffer.
///
/// # Examples
///
/// ```
/// use compio_buf::IoBuf;
///
/// let buf = b"hello world";
/// assert_eq!(buf.slice(6..).as_slice(), b"world");
/// ```
fn slice(self, range: impl std::ops::RangeBounds<usize>) -> Slice<Self>
where
Self: Sized,
{
use std::ops::Bound;
let begin = match range.start_bound() {
Bound::Included(&n) => n,
Bound::Excluded(&n) => n + 1,
Bound::Unbounded => 0,
};
assert!(begin < self.buf_capacity());
let end = match range.end_bound() {
Bound::Included(&n) => n.checked_add(1).expect("out of range"),
Bound::Excluded(&n) => n,
Bound::Unbounded => self.buf_capacity(),
};
assert!(end <= self.buf_capacity());
assert!(begin <= self.buf_len());
Slice::new(self, begin, end)
}
}
unsafe impl<#[cfg(feature = "allocator_api")] A: Allocator + Unpin + 'static> IoBuf
for vec_alloc!(u8, A)
{
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
unsafe impl IoBuf for &'static mut [u8] {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
unsafe impl IoBuf for &'static [u8] {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
unsafe impl IoBuf for String {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
unsafe impl IoBuf for &'static mut str {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
unsafe impl IoBuf for &'static str {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
#[cfg(feature = "bytes")]
unsafe impl IoBuf for bytes::Bytes {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
#[cfg(feature = "bytes")]
unsafe impl IoBuf for bytes::BytesMut {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
#[cfg(feature = "read_buf")]
unsafe impl IoBuf for std::io::BorrowedBuf<'static> {
fn as_buf_ptr(&self) -> *const u8 {
self.filled().as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
#[cfg(feature = "arrayvec")]
unsafe impl<const N: usize> IoBuf for arrayvec::ArrayVec<u8, N> {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
/// A mutable compio compatible buffer.
///
/// The `IoBufMut` trait is implemented by buffer types that can be passed to
/// compio operations. Users will not need to use this trait directly.
///
/// # Safety
///
/// Buffers passed to compio operations must reference a stable memory
/// region. While the runtime holds ownership to a buffer, the pointer returned
/// by `as_buf_mut_ptr` must remain valid even if the `IoBufMut` value is moved.
pub unsafe trait IoBufMut: IoBuf + SetBufInit {
/// Returns a raw mutable pointer to the vector’s buffer.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// The implementation must ensure that, while the `compio` runtime
/// owns the value, the pointer returned **does not** change.
fn as_buf_mut_ptr(&mut self) -> *mut u8;
/// Get the uninitialized part of the buffer.
fn as_uninit_slice(&mut self) -> &mut [MaybeUninit<u8>] {
unsafe {
std::slice::from_raw_parts_mut(
self.as_buf_mut_ptr().add(self.buf_len()) as _,
self.buf_capacity() - self.buf_len(),
)
}
}
/// # Safety
///
/// The return slice will not live longer than self.
/// It is static to provide convenience from writing self-referenced
/// structure.
#[doc(hidden)]
unsafe fn as_io_slice_mut(&mut self) -> IoSliceMut<'static> {
IoSliceMut::new(std::mem::transmute(self.as_uninit_slice()))
}
}
unsafe impl<#[cfg(feature = "allocator_api")] A: Allocator + Unpin + 'static> IoBufMut
for vec_alloc!(u8, A)
{
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.as_mut_ptr()
}
}
#[cfg(feature = "bytes")]
unsafe impl IoBufMut for bytes::BytesMut {
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.as_mut_ptr()
}
}
#[cfg(feature = "read_buf")]
unsafe impl IoBufMut for std::io::BorrowedBuf<'static> {
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.filled().as_ptr() as _
}
}
#[cfg(feature = "arrayvec")]
unsafe impl<const N: usize> IoBufMut for arrayvec::ArrayVec<u8, N> {
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.as_mut_ptr()
}
}
/// A trait for vectored buffers.
///
/// # Safety
///
/// See [`IoBuf`].
pub unsafe trait IoVectoredBuf: Unpin + 'static {
/// The inner buffer type.
type Item: IoBuf;
/// The iterator type returned by [`IoVectoredBuf::buf_iter`].
type Iter<'a>: Iterator<Item = &'a Self::Item>;
/// # Safety
///
/// The return slice will not live longer than self.
/// It is static to provide convenience from writing self-referenced
/// structure.
#[doc(hidden)]
unsafe fn as_io_slices(&self) -> Vec<IoSlice<'static>>;
/// An iterator of the inner buffers.
fn buf_iter(&self) -> Self::Iter<'_>;
}
macro_rules! iivbfs {
($tn:ident) => {
type Item = $tn;
type Iter<'a> = std::slice::Iter<'a, Self::Item>;
unsafe fn as_io_slices(&self) -> Vec<IoSlice<'static>> {
self.buf_iter().map(|buf| buf.as_io_slice()).collect()
}
fn buf_iter(&self) -> Self::Iter<'_> {
self.iter()
}
};
}
unsafe impl<T: IoBuf, const N: usize> IoVectoredBuf for [T; N] {
iivbfs!(T);
}
unsafe impl<T: IoBuf, #[cfg(feature = "allocator_api")] A: Allocator + Unpin + 'static>
IoVectoredBuf for vec_alloc!(T, A)
{
iivbfs!(T);
}
#[cfg(feature = "arrayvec")]
unsafe impl<T: IoBuf, const N: usize> IoVectoredBuf for arrayvec::ArrayVec<T, N> {
iivbfs!(T);
}
/// A trait for mutable vectored buffers.
///
/// # Safety
///
/// See [`IoBufMut`].
pub unsafe trait IoVectoredBufMut: IoVectoredBuf + SetBufInit {
/// The iterator type returned by [`IoVectoredBufMut::buf_iter_mut`].
type IterMut<'a>: Iterator<Item = &'a mut Self::Item>;
/// # Safety
///
/// The return slice will not live longer than self.
/// It is static to provide convenience from writing self-referenced
/// structure.
#[doc(hidden)]
unsafe fn as_io_slices_mut(&mut self) -> Vec<IoSliceMut<'static>>;
/// A mutable iterator of the inner buffers.
fn buf_iter_mut(&mut self) -> Self::IterMut<'_>;
}
macro_rules! iivbfs_mut {
() => {
type IterMut<'a> = std::slice::IterMut<'a, Self::Item>;
unsafe fn as_io_slices_mut(&mut self) -> Vec<IoSliceMut<'static>> {
self.buf_iter_mut()
.map(|buf| buf.as_io_slice_mut())
.collect()
}
fn buf_iter_mut(&mut self) -> Self::IterMut<'_> {
self.iter_mut()
}
};
}
unsafe impl<T: IoBufMut, const N: usize> IoVectoredBufMut for [T; N] {
iivbfs_mut!();
}
unsafe impl<T: IoBufMut, #[cfg(feature = "allocator_api")] A: Allocator + Unpin + 'static>
IoVectoredBufMut for vec_alloc!(T, A)
{
iivbfs_mut!();
}
#[cfg(feature = "arrayvec")]
unsafe impl<T: IoBufMut, const N: usize> IoVectoredBufMut for arrayvec::ArrayVec<T, N> {
iivbfs_mut!();
}
/// A helper trait for `set_len` like methods.
pub trait SetBufInit {
/// Updates the number of initialized bytes.
///
/// # Safety
///
/// `len` should be less or equal than `buf_capacity() - buf_len()`.
unsafe fn set_buf_init(&mut self, len: usize);
}
impl<#[cfg(feature = "allocator_api")] A: Allocator + Unpin + 'static> SetBufInit
for vec_alloc!(u8, A)
{
unsafe fn set_buf_init(&mut self, len: usize) {
self.set_len(len + self.buf_len());
}
}
#[cfg(feature = "bytes")]
impl SetBufInit for bytes::BytesMut {
unsafe fn set_buf_init(&mut self, len: usize) {
self.set_len(len + self.buf_len());
}
}
#[cfg(feature = "read_buf")]
impl SetBufInit for std::io::BorrowedBuf<'static> {
unsafe fn set_buf_init(&mut self, len: usize) {
self.unfilled().advance(len);
}
}
#[cfg(feature = "arrayvec")]
impl<const N: usize> SetBufInit for arrayvec::ArrayVec<u8, N> {
unsafe fn set_buf_init(&mut self, len: usize) {
self.set_len(len + self.buf_len());
}
}
impl<T: IoVectoredBufMut> SetBufInit for T
where
T::Item: SetBufInit,
{
unsafe fn set_buf_init(&mut self, mut len: usize) {
for buf in self.buf_iter_mut() {
let capacity = buf.buf_capacity();
if len >= capacity {
buf.set_buf_init(capacity);
len -= capacity;
} else {
buf.set_buf_init(len);
len = 0;
}
}
}
}