【源码阅读】Rust bytes库源码阅读笔记

源码结构

│  bytes.rs
│  bytes_mut.rs
│  lib.rs
│  loom.rs
│  serde.rs
│
├─buf
│      buf_impl.rs
│      buf_mut.rs
│      chain.rs
│      iter.rs
│      limit.rs
│      mod.rs
│      reader.rs
│      take.rs
│      uninit_slice.rs
│      vec_deque.rs
│      writer.rs
│
└─fmt
        debug.rs
        hex.rs
        mod.rs

Trait

1. Buf

必须实现的方法

fn remaining(&self) -> usize

fn chunk(&self) -> &[u8]

fn advance(&mut self, cnt: usize)

另一些实现了该trait的结构体

• &[u8]
• &mut T
• Box
• Cursor
• VecDeque

2. BufMut (unsafe)

必须实现的方法

unsafe fn advance_mut(&mut self, cnt: usize)

fn chunk_mut(&mut self) -> &mut UninitSlice

fn remaining_mut(&self) -> usize

Structs

Bytes

结构

/// ```text
///
///    Arc ptrs                   +---------+
///    ________________________ / | Bytes 2 |
///   /                           +---------+
///  /          +-----------+     |         |
/// |_________/ |  Bytes 1  |     |         |
/// |           +-----------+     |         |
/// |           |           | ___/ data     | tail
/// |      data |      tail |/              |
/// v           v           v               v
/// +-----+---------------------------------+-----+
/// | Arc |     |           |               |     |
/// +-----+---------------------------------+-----+
/// ```
pub struct Bytes {
    ptr: *const u8,
    len: usize,
    // inlined "trait object"
    data: AtomicPtr<()>,
    vtable: &'static Vtable,
}

pub(crate) struct Vtable {
    /// fn(data, ptr, len)
    pub clone: unsafe fn(&AtomicPtr<()>, *const u8, usize) -> Bytes,
    /// fn(data, ptr, len)
    pub drop: unsafe fn(&mut AtomicPtr<()>, *const u8, usize),
}

• ptr ： 指针
• len ： 长度

以上两个参数模拟了一个切片，指向内存中的一片连续地址。

• 使用AtomicPtr和自定义的Vtable模拟trait object的行为。
• Vtable给Bytes提供动态clone()和drop()

实现trait

1. 自定义trait
   1. Buf
2. 标准trait
   1. AsRef
   2. Borrow
   3. Clone
   4. Debug
   5. Default
   6. Deref
   7. Drop
   8. Eq
   9. From
   10. FromIterator
   11. Hash
   12. IntoIterator
   13. LowerHex
   14. Ord
   15. PartialEq
   16. PartialOrd
   17. Send
   18. Sync
   19. UpperHex

重点场景源码学习

Bytes的Drop和Clone实现

源代码

impl Drop for Bytes {
    #[inline]
    fn drop(&mut self) {
        unsafe { (self.vtable.drop)(&mut self.data, self.ptr, self.len) }
    }
}

impl Clone for Bytes {
    #[inline]
    fn clone(&self) -> Bytes {
        unsafe { (self.vtable.clone)(&self.data, self.ptr, self.len) }
    }
}

可见Bytes的Drop和Clone都是由vtable的实现执行的。

VTable实现

Bytes实现了4种VTable

1. STATIC_VTABLE
2. PROMOTABLE_EVEN_VTABLE
3. PROMOTABLE_ODD_VTABLE
4. SHARED_VTABLE

实现Clone和Drop的思路