vhost-device-vsock 0.3.0

A virtio-vsock device using the vhost-user protocol.
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

// SPDX-License-Identifier: Apache-2.0 or BSD-3-Clause

use crate::rxops::RxOps;

#[derive(Debug, Eq, PartialEq)]
pub(crate) struct RxQueue {
    /// Bitmap of rx operations.
    queue: u8,
}

impl RxQueue {
    /// New instance of RxQueue.
    pub fn new() -> Self {
        RxQueue { queue: 0_u8 }
    }

    /// Enqueue a new rx operation into the queue.
    pub fn enqueue(&mut self, op: RxOps) {
        self.queue |= op.bitmask();
    }

    /// Dequeue an rx operation from the queue.
    pub fn dequeue(&mut self) -> Option<RxOps> {
        match self.peek() {
            Some(req) => {
                self.queue &= !req.bitmask();
                Some(req)
            }
            None => None,
        }
    }

    /// Peek into the queue to check if it contains an rx operation.
    pub fn peek(&self) -> Option<RxOps> {
        if self.contains(RxOps::Request.bitmask()) {
            return Some(RxOps::Request);
        }
        if self.contains(RxOps::Rw.bitmask()) {
            return Some(RxOps::Rw);
        }
        if self.contains(RxOps::Response.bitmask()) {
            return Some(RxOps::Response);
        }
        if self.contains(RxOps::CreditUpdate.bitmask()) {
            return Some(RxOps::CreditUpdate);
        }
        if self.contains(RxOps::Reset.bitmask()) {
            Some(RxOps::Reset)
        } else {
            None
        }
    }

    /// Check if the queue contains a particular rx operation.
    pub fn contains(&self, op: u8) -> bool {
        (self.queue & op) != 0
    }

    /// Check if there are any pending rx operations in the queue.
    pub fn pending_rx(&self) -> bool {
        self.queue != 0
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_contains() {
        let mut rxqueue = RxQueue::new();
        rxqueue.queue = 31;

        assert!(rxqueue.contains(RxOps::Request.bitmask()));
        assert!(rxqueue.contains(RxOps::Rw.bitmask()));
        assert!(rxqueue.contains(RxOps::Response.bitmask()));
        assert!(rxqueue.contains(RxOps::CreditUpdate.bitmask()));
        assert!(rxqueue.contains(RxOps::Reset.bitmask()));

        rxqueue.queue = 0;
        assert!(!rxqueue.contains(RxOps::Request.bitmask()));
        assert!(!rxqueue.contains(RxOps::Rw.bitmask()));
        assert!(!rxqueue.contains(RxOps::Response.bitmask()));
        assert!(!rxqueue.contains(RxOps::CreditUpdate.bitmask()));
        assert!(!rxqueue.contains(RxOps::Reset.bitmask()));
    }

    #[test]
    fn test_enqueue() {
        let mut rxqueue = RxQueue::new();

        rxqueue.enqueue(RxOps::Request);
        assert!(rxqueue.contains(RxOps::Request.bitmask()));

        rxqueue.enqueue(RxOps::Rw);
        assert!(rxqueue.contains(RxOps::Rw.bitmask()));

        rxqueue.enqueue(RxOps::Response);
        assert!(rxqueue.contains(RxOps::Response.bitmask()));

        rxqueue.enqueue(RxOps::CreditUpdate);
        assert!(rxqueue.contains(RxOps::CreditUpdate.bitmask()));

        rxqueue.enqueue(RxOps::Reset);
        assert!(rxqueue.contains(RxOps::Reset.bitmask()));
    }

    #[test]
    fn test_peek() {
        let mut rxqueue = RxQueue::new();

        rxqueue.queue = 31;
        assert_eq!(rxqueue.peek(), Some(RxOps::Request));

        rxqueue.queue = 30;
        assert_eq!(rxqueue.peek(), Some(RxOps::Rw));

        rxqueue.queue = 28;
        assert_eq!(rxqueue.peek(), Some(RxOps::Response));

        rxqueue.queue = 24;
        assert_eq!(rxqueue.peek(), Some(RxOps::CreditUpdate));

        rxqueue.queue = 16;
        assert_eq!(rxqueue.peek(), Some(RxOps::Reset));
    }

    #[test]
    fn test_dequeue() {
        let mut rxqueue = RxQueue::new();
        rxqueue.queue = 31;

        assert_eq!(rxqueue.dequeue(), Some(RxOps::Request));
        assert!(!rxqueue.contains(RxOps::Request.bitmask()));

        assert_eq!(rxqueue.dequeue(), Some(RxOps::Rw));
        assert!(!rxqueue.contains(RxOps::Rw.bitmask()));

        assert_eq!(rxqueue.dequeue(), Some(RxOps::Response));
        assert!(!rxqueue.contains(RxOps::Response.bitmask()));

        assert_eq!(rxqueue.dequeue(), Some(RxOps::CreditUpdate));
        assert!(!rxqueue.contains(RxOps::CreditUpdate.bitmask()));

        assert_eq!(rxqueue.dequeue(), Some(RxOps::Reset));
        assert!(!rxqueue.contains(RxOps::Reset.bitmask()));
    }

    #[test]
    fn test_pending_rx() {
        let mut rxqueue = RxQueue::new();
        assert!(!rxqueue.pending_rx());

        rxqueue.queue = 1;
        assert!(rxqueue.pending_rx());
    }

    #[test]
    fn test_debug() {
        let rxqueue = RxQueue::new();

        assert_eq!(format!("{rxqueue:?}"), "RxQueue { queue: 0 }");
    }
}