compio-driver 0.11.4

Low-level driver for compio
Documentation 
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

use std::{
    borrow::{Borrow, BorrowMut},
    fmt::{Debug, Formatter},
    ops::{Deref, DerefMut},
};

pub use fallback::BufferPool as FallbackBufferPool;
pub(crate) use fallback::OwnedBuffer;
pub use iour::BufferPool as IoUringBufferPool;

use super::{fallback, iour};

/// Buffer pool
///
/// A buffer pool to allow user no need to specify a specific buffer to do the
/// IO operation
pub struct BufferPool {
    inner: BufferPollInner,
}

impl Debug for BufferPool {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("BufferPool").finish_non_exhaustive()
    }
}

impl BufferPool {
    pub(crate) fn is_io_uring(&self) -> bool {
        matches!(&self.inner, BufferPollInner::IoUring(_))
    }

    pub(crate) fn new_io_uring(buffer_pool: iour::BufferPool) -> Self {
        Self {
            inner: BufferPollInner::IoUring(buffer_pool),
        }
    }

    pub(crate) fn as_io_uring(&self) -> &iour::BufferPool {
        match &self.inner {
            BufferPollInner::IoUring(inner) => inner,
            BufferPollInner::Poll(_) => panic!("BufferPool type is not poll type"),
        }
    }

    pub(crate) fn as_poll(&self) -> &fallback::BufferPool {
        match &self.inner {
            BufferPollInner::Poll(inner) => inner,
            BufferPollInner::IoUring(_) => panic!("BufferPool type is not io-uring type"),
        }
    }

    pub(crate) fn new_poll(buffer_pool: fallback::BufferPool) -> Self {
        Self {
            inner: BufferPollInner::Poll(buffer_pool),
        }
    }

    pub(crate) fn into_io_uring(self) -> iour::BufferPool {
        match self.inner {
            BufferPollInner::IoUring(inner) => inner,
            BufferPollInner::Poll(_) => panic!("BufferPool type is not poll type"),
        }
    }
}

enum BufferPollInner {
    IoUring(iour::BufferPool),
    Poll(fallback::BufferPool),
}

/// Buffer borrowed from buffer pool
///
/// When IO operation finish, user will obtain a `BorrowedBuffer` to access the
/// filled data
pub struct BorrowedBuffer<'a> {
    inner: BorrowedBufferInner<'a>,
}

impl<'a> BorrowedBuffer<'a> {
    pub(crate) fn new_io_uring(buffer: iour::BorrowedBuffer<'a>) -> Self {
        Self {
            inner: BorrowedBufferInner::IoUring(buffer),
        }
    }

    pub(crate) fn new_poll(buffer: fallback::BorrowedBuffer<'a>) -> Self {
        Self {
            inner: BorrowedBufferInner::Poll(buffer),
        }
    }
}

enum BorrowedBufferInner<'a> {
    IoUring(iour::BorrowedBuffer<'a>),
    Poll(fallback::BorrowedBuffer<'a>),
}

impl Debug for BorrowedBuffer<'_> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("BorrowedBuffer").finish_non_exhaustive()
    }
}

impl Deref for BorrowedBuffer<'_> {
    type Target = [u8];

    fn deref(&self) -> &Self::Target {
        match &self.inner {
            BorrowedBufferInner::IoUring(inner) => inner.deref(),
            BorrowedBufferInner::Poll(inner) => inner.deref(),
        }
    }
}

impl DerefMut for BorrowedBuffer<'_> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        match &mut self.inner {
            BorrowedBufferInner::IoUring(inner) => inner.deref_mut(),
            BorrowedBufferInner::Poll(inner) => inner.deref_mut(),
        }
    }
}

impl AsRef<[u8]> for BorrowedBuffer<'_> {
    fn as_ref(&self) -> &[u8] {
        self.deref()
    }
}

impl AsMut<[u8]> for BorrowedBuffer<'_> {
    fn as_mut(&mut self) -> &mut [u8] {
        self.deref_mut()
    }
}

impl Borrow<[u8]> for BorrowedBuffer<'_> {
    fn borrow(&self) -> &[u8] {
        self.deref()
    }
}

impl BorrowMut<[u8]> for BorrowedBuffer<'_> {
    fn borrow_mut(&mut self) -> &mut [u8] {
        self.deref_mut()
    }
}