virtio-spec 0.3.2

Definitions from the Virtual I/O Device (VIRTIO) specification.
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
147
148
149
150

//! Socket Device

use endian_num::{le16, le32};
use num_enum::{IntoPrimitive, TryFromPrimitive, UnsafeFromPrimitive};
use volatile_macro::VolatileFieldAccess;

pub use super::features::vsock::F;
use crate::le64;

/// Socket Device Configuration Layout
///
/// Use [`ConfigVolatileFieldAccess`] to work with this struct.
#[doc(alias = "virtio_vsock_config")]
#[cfg_attr(
    feature = "zerocopy",
    derive(
        zerocopy_derive::KnownLayout,
        zerocopy_derive::Immutable,
        zerocopy_derive::FromBytes,
    )
)]
#[derive(VolatileFieldAccess)]
#[repr(C)]
pub struct Config {
    guest_cid: le64,
}

/// Socket Device Header
#[doc(alias = "virtio_vsock_hdr")]
#[cfg_attr(
    feature = "zerocopy",
    derive(
        zerocopy_derive::KnownLayout,
        zerocopy_derive::Immutable,
        zerocopy_derive::FromBytes,
        zerocopy_derive::IntoBytes,
    )
)]
#[derive(Default, Clone, Copy, Debug)]
#[repr(C, packed)]
pub struct Hdr {
    pub src_cid: le64,
    pub dst_cid: le64,
    pub src_port: le32,
    pub dst_port: le32,
    pub len: le32,
    pub type_: le16,
    pub op: le16,
    pub flags: le32,
    pub buf_alloc: le32,
    pub fwd_cnt: le32,
}

#[doc(alias = "VIRTIO_VSOCK_OP")]
#[derive(
    IntoPrimitive, TryFromPrimitive, UnsafeFromPrimitive, PartialEq, Eq, Clone, Copy, Debug,
)]
#[non_exhaustive]
#[repr(u16)]
pub enum Op {
    #[doc(alias = "VIRTIO_VSOCK_OP_INVALID")]
    Invalid = 0,

    #[doc(alias = "VIRTIO_VSOCK_OP_REQUEST")]
    Request = 1,

    #[doc(alias = "VIRTIO_VSOCK_OP_RESPONSE")]
    Response = 2,

    #[doc(alias = "VIRTIO_VSOCK_OP_RST")]
    Rst = 3,

    #[doc(alias = "VIRTIO_VSOCK_OP_SHUTDOWN")]
    Shutdown = 4,

    #[doc(alias = "VIRTIO_VSOCK_OP_RW")]
    Rw = 5,

    #[doc(alias = "VIRTIO_VSOCK_OP_CREDIT_UPDATE")]
    CreditUpdate = 6,

    #[doc(alias = "VIRTIO_VSOCK_OP_CREDIT_REQUEST")]
    CreditRequest = 7,
}

#[doc(alias = "VIRTIO_VSOCK_TYPE")]
#[derive(
    IntoPrimitive, TryFromPrimitive, UnsafeFromPrimitive, PartialEq, Eq, Clone, Copy, Debug,
)]
#[non_exhaustive]
#[repr(u16)]
pub enum Type {
    #[doc(alias = "VIRTIO_VSOCK_TYPE_STREAM")]
    Stream = 1,

    #[doc(alias = "VIRTIO_VSOCK_TYPE_SEQPACKET")]
    Seqpacket = 2,
}

endian_bitflags! {
    /// Socket Device Shutdown Flags
    #[doc(alias = "VIRTIO_VSOCK_SHUTDOWN_F")]
    pub struct ShutdownF: le32 {
        #[doc(alias = "VIRTIO_VSOCK_SHUTDOWN_F_RECEIVE")]
        const RECEIVE = 1 << 0;

        #[doc(alias = "VIRTIO_VSOCK_SHUTDOWN_F_SEND")]
        const SEND = 1 << 1;
    }
}

endian_bitflags! {
    /// Socket Device Sequence Flags
    #[doc(alias = "VIRTIO_VSOCK_SEQ")]
    pub struct Seq: le32 {
        #[doc(alias = "VIRTIO_VSOCK_SEQ_EOM")]
        const EOM = 1 << 0;

        #[doc(alias = "VIRTIO_VSOCK_SEQ_EOR")]
        const EOR = 1 << 1;
    }
}

#[doc(alias = "VIRTIO_VSOCK_EVENT")]
#[derive(
    IntoPrimitive, TryFromPrimitive, UnsafeFromPrimitive, PartialEq, Eq, Clone, Copy, Debug,
)]
#[non_exhaustive]
#[repr(u32)]
pub enum EventId {
    #[doc(alias = "VIRTIO_VSOCK_EVENT_TRANSPORT_RESET")]
    TransportReset = 0,
}

/// Socket Device Event
#[doc(alias = "virtio_vsock_event")]
#[cfg_attr(
    feature = "zerocopy",
    derive(
        zerocopy_derive::KnownLayout,
        zerocopy_derive::Immutable,
        zerocopy_derive::FromBytes,
        zerocopy_derive::IntoBytes,
    )
)]
#[derive(Default, Clone, Copy, Debug)]
#[repr(C)]
pub struct Event {
    id: le32,
}