VMM: Converted headers to use pragma once
[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 #ifndef __KERNEL__
34 #include <stdint.h>
35 #endif
36 #include <linux/types.h>
37 #include <linux/virtio_types.h>
38
39 /* This marks a buffer as continuing via the next field. */
40 #define VRING_DESC_F_NEXT       1
41 /* This marks a buffer as write-only (otherwise read-only). */
42 #define VRING_DESC_F_WRITE      2
43 /* This means the buffer contains a list of buffer descriptors. */
44 #define VRING_DESC_F_INDIRECT   4
45
46 /* The Host uses this in used->flags to advise the Guest: don't kick me when
47  * you add a buffer.  It's unreliable, so it's simply an optimization.  Guest
48  * will still kick if it's out of buffers. */
49 #define VRING_USED_F_NO_NOTIFY  1
50 /* The Guest uses this in avail->flags to advise the Host: don't interrupt me
51  * when you consume a buffer.  It's unreliable, so it's simply an
52  * optimization.  */
53 #define VRING_AVAIL_F_NO_INTERRUPT      1
54
55 /* We support indirect buffer descriptors */
56 #define VIRTIO_RING_F_INDIRECT_DESC     28
57
58 /* The Guest publishes the used index for which it expects an interrupt
59  * at the end of the avail ring. Host should ignore the avail->flags field. */
60 /* The Host publishes the avail index for which it expects a kick
61  * at the end of the used ring. Guest should ignore the used->flags field. */
62 #define VIRTIO_RING_F_EVENT_IDX         29
63
64 /* Virtio ring descriptors: 16 bytes.  These can chain together via "next". */
65 struct vring_desc {
66         /* Address (guest-physical). */
67         __virtio64 addr;
68         /* Length. */
69         __virtio32 len;
70         /* The flags as indicated above. */
71         __virtio16 flags;
72         /* We chain unused descriptors via this, too */
73         __virtio16 next;
74 };
75
76 struct vring_avail {
77         __virtio16 flags;
78         __virtio16 idx;
79         __virtio16 ring[];
80 };
81
82 /* u32 is used here for ids for padding reasons. */
83 struct vring_used_elem {
84         /* Index of start of used descriptor chain. */
85         __virtio32 id;
86         /* Total length of the descriptor chain which was used (written to) */
87         __virtio32 len;
88 };
89
90 struct vring_used {
91         __virtio16 flags;
92         __virtio16 idx;
93         struct vring_used_elem ring[];
94 };
95
96 struct vring {
97         unsigned int num;
98
99         struct vring_desc *desc;
100
101         struct vring_avail *avail;
102
103         struct vring_used *used;
104 };
105
106 /* Alignment requirements for vring elements.
107  * When using pre-virtio 1.0 layout, these fall out naturally.
108  */
109 #define VRING_AVAIL_ALIGN_SIZE 2
110 #define VRING_USED_ALIGN_SIZE 4
111 #define VRING_DESC_ALIGN_SIZE 16
112
113 /* The standard layout for the ring is a continuous chunk of memory which looks
114  * like this.  We assume num is a power of 2.
115  *
116  * struct vring
117  * {
118  *      // The actual descriptors (16 bytes each)
119  *      struct vring_desc desc[num];
120  *
121  *      // A ring of available descriptor heads with free-running index.
122  *      __virtio16 avail_flags;
123  *      __virtio16 avail_idx;
124  *      __virtio16 available[num];
125  *      __virtio16 used_event_idx;
126  *
127  *      // Padding to the next align boundary.
128  *      char pad[];
129  *
130  *      // A ring of used descriptor heads with free-running index.
131  *      __virtio16 used_flags;
132  *      __virtio16 used_idx;
133  *      struct vring_used_elem used[num];
134  *      __virtio16 avail_event_idx;
135  * };
136  */
137 /* We publish the used event index at the end of the available ring, and vice
138  * versa. They are at the end for backwards compatibility. */
139 #define vring_used_event(vr) ((vr)->avail->ring[(vr)->num])
140 #define vring_avail_event(vr) (*(__virtio16 *)&(vr)->used->ring[(vr)->num])
141
142 static inline void vring_init(struct vring *vr, unsigned int num, void *p,
143                               unsigned long align)
144 {
145         vr->num = num;
146         vr->desc = p;
147         vr->avail = p + num*sizeof(struct vring_desc);
148         vr->used = (void *)(((uintptr_t)&vr->avail->ring[num] + sizeof(__virtio16)
149                 + align-1) & ~(align - 1));
150 }
151
152 static inline unsigned vring_size(unsigned int num, unsigned long align)
153 {
154         return ((sizeof(struct vring_desc) * num + sizeof(__virtio16) * (3 + num)
155                  + align - 1) & ~(align - 1))
156                 + sizeof(__virtio16) * 3 + sizeof(struct vring_used_elem) * num;
157 }
158
159 /* The following is used with USED_EVENT_IDX and AVAIL_EVENT_IDX */
160 /* Assuming a given event_idx value from the other side, if
161  * we have just incremented index from old to new_idx,
162  * should we trigger an event? */
163 static inline int vring_need_event(__u16 event_idx, __u16 new_idx, __u16 old)
164 {
165         /* Note: Xen has similar logic for notification hold-off
166          * in include/xen/interface/io/ring.h with req_event and req_prod
167          * corresponding to event_idx + 1 and new_idx respectively.
168          * Note also that req_event and req_prod in Xen start at 1,
169          * event indexes in virtio start at 0. */
170         return (__u16)(new_idx - event_idx - 1) < (__u16)(new_idx - old);
171 }
172
173