VMM: Removed virtio_types.h and includes for that file
[akaros.git] / user / vmm / include / vmm / virtio_ring.h
1 #pragma once
2 /* An interface for efficient virtio implementation, currently for use by KVM
3  * and lguest, but hopefully others soon.  Do NOT change this since it will
4  * break existing servers and clients.
5  *
6  * This header is BSD licensed so anyone can use the definitions to implement
7  * compatible drivers/servers.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of IBM nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * Copyright Rusty Russell IBM Corporation 2007. */
33
34
35 /* This marks a buffer as continuing via the next field. */
36 #define VRING_DESC_F_NEXT       1
37 /* This marks a buffer as write-only (otherwise read-only). */
38 #define VRING_DESC_F_WRITE      2
39 /* This means the buffer contains a list of buffer descriptors. */
40 #define VRING_DESC_F_INDIRECT   4
41
42 /* The Host uses this in used->flags to advise the Guest: don't kick me when
43  * you add a buffer.  It's unreliable, so it's simply an optimization.  Guest
44  * will still kick if it's out of buffers. */
45 #define VRING_USED_F_NO_NOTIFY  1
46 /* The Guest uses this in avail->flags to advise the Host: don't interrupt me
47  * when you consume a buffer.  It's unreliable, so it's simply an
48  * optimization.  */
49 #define VRING_AVAIL_F_NO_INTERRUPT      1
50
51 /* We support indirect buffer descriptors */
52 #define VIRTIO_RING_F_INDIRECT_DESC     28
53
54 /* The Guest publishes the used index for which it expects an interrupt
55  * at the end of the avail ring. Host should ignore the avail->flags field. */
56 /* The Host publishes the avail index for which it expects a kick
57  * at the end of the used ring. Guest should ignore the used->flags field. */
58 #define VIRTIO_RING_F_EVENT_IDX         29
59
60 /* Virtio ring descriptors: 16 bytes.  These can chain together via "next". */
61 struct vring_desc {
62         /* Address (guest-physical). */
63         __virtio64 addr;
64         /* Length. */
65         __virtio32 len;
66         /* The flags as indicated above. */
67         __virtio16 flags;
68         /* We chain unused descriptors via this, too */
69         __virtio16 next;
70 };
71
72 struct vring_avail {
73         __virtio16 flags;
74         __virtio16 idx;
75         __virtio16 ring[];
76 };
77
78 /* u32 is used here for ids for padding reasons. */
79 struct vring_used_elem {
80         /* Index of start of used descriptor chain. */
81         __virtio32 id;
82         /* Total length of the descriptor chain which was used (written to) */
83         __virtio32 len;
84 };
85
86 struct vring_used {
87         __virtio16 flags;
88         __virtio16 idx;
89         struct vring_used_elem ring[];
90 };
91
92 struct vring {
93         unsigned int num;
94
95         struct vring_desc *desc;
96
97         struct vring_avail *avail;
98
99         struct vring_used *used;
100 };
101
102 /* Alignment requirements for vring elements.
103  * When using pre-virtio 1.0 layout, these fall out naturally.
104  */
105 #define VRING_AVAIL_ALIGN_SIZE 2
106 #define VRING_USED_ALIGN_SIZE 4
107 #define VRING_DESC_ALIGN_SIZE 16
108
109 /* The standard layout for the ring is a continuous chunk of memory which looks
110  * like this.  We assume num is a power of 2.
111  *
112  * struct vring
113  * {
114  *      // The actual descriptors (16 bytes each)
115  *      struct vring_desc desc[num];
116  *
117  *      // A ring of available descriptor heads with free-running index.
118  *      __virtio16 avail_flags;
119  *      __virtio16 avail_idx;
120  *      __virtio16 available[num];
121  *      __virtio16 used_event_idx;
122  *
123  *      // Padding to the next align boundary.
124  *      char pad[];
125  *
126  *      // A ring of used descriptor heads with free-running index.
127  *      __virtio16 used_flags;
128  *      __virtio16 used_idx;
129  *      struct vring_used_elem used[num];
130  *      __virtio16 avail_event_idx;
131  * };
132  */
133 /* We publish the used event index at the end of the available ring, and vice
134  * versa. They are at the end for backwards compatibility. */
135 #define vring_used_event(vr) ((vr)->avail->ring[(vr)->num])
136 #define vring_avail_event(vr) (*(__virtio16 *)&(vr)->used->ring[(vr)->num])
137
138 static inline void vring_init(struct vring *vr, unsigned int num, void *p,
139                               unsigned long align)
140 {
141         vr->num = num;
142         vr->desc = p;
143         vr->avail = p + num*sizeof(struct vring_desc);
144         vr->used = (void *)(((uintptr_t)&vr->avail->ring[num] + sizeof(__virtio16)
145                 + align-1) & ~(align - 1));
146 }
147
148 static inline unsigned vring_size(unsigned int num, unsigned long align)
149 {
150         return ((sizeof(struct vring_desc) * num + sizeof(__virtio16) * (3 + num)
151                  + align - 1) & ~(align - 1))
152                 + sizeof(__virtio16) * 3 + sizeof(struct vring_used_elem) * num;
153 }
154
155 /* The following is used with USED_EVENT_IDX and AVAIL_EVENT_IDX */
156 /* Assuming a given event_idx value from the other side, if
157  * we have just incremented index from old to new_idx,
158  * should we trigger an event? */
159 static inline int vring_need_event(__u16 event_idx, __u16 new_idx, __u16 old)
160 {
161         /* Note: Xen has similar logic for notification hold-off
162          * in include/xen/interface/io/ring.h with req_event and req_prod
163          * corresponding to event_idx + 1 and new_idx respectively.
164          * Note also that req_event and req_prod in Xen start at 1,
165          * event indexes in virtio start at 0. */
166         return (__u16)(new_idx - event_idx - 1) < (__u16)(new_idx - old);
167 }
168
169