692691b8972d4d1ad8120fe277b6770225e12e31
[dpdk.git] / lib / librte_vhost / vhost.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _VHOST_NET_CDEV_H_
35 #define _VHOST_NET_CDEV_H_
36 #include <stdint.h>
37 #include <stdio.h>
38 #include <sys/types.h>
39 #include <sys/queue.h>
40 #include <unistd.h>
41 #include <linux/vhost.h>
42
43 #include <rte_log.h>
44
45 #include "rte_virtio_net.h"
46
47 /* Used to indicate that the device is running on a data core */
48 #define VIRTIO_DEV_RUNNING 1
49 /* Used to indicate that the device is ready to operate */
50 #define VIRTIO_DEV_READY 2
51
52 /* Backend value set by guest. */
53 #define VIRTIO_DEV_STOPPED -1
54
55 #define BUF_VECTOR_MAX 256
56
57 /**
58  * Structure contains buffer address, length and descriptor index
59  * from vring to do scatter RX.
60  */
61 struct buf_vector {
62         uint64_t buf_addr;
63         uint32_t buf_len;
64         uint32_t desc_idx;
65 };
66
67 /*
68  * A structure to hold some fields needed in zero copy code path,
69  * mainly for associating an mbuf with the right desc_idx.
70  */
71 struct zcopy_mbuf {
72         struct rte_mbuf *mbuf;
73         uint32_t desc_idx;
74         uint16_t in_use;
75
76         TAILQ_ENTRY(zcopy_mbuf) next;
77 };
78 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
79
80 /**
81  * Structure contains variables relevant to RX/TX virtqueues.
82  */
83 struct vhost_virtqueue {
84         struct vring_desc       *desc;
85         struct vring_avail      *avail;
86         struct vring_used       *used;
87         uint32_t                size;
88
89         uint16_t                last_avail_idx;
90         uint16_t                last_used_idx;
91 #define VIRTIO_INVALID_EVENTFD          (-1)
92 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
93
94         /* Backend value to determine if device should started/stopped */
95         int                     backend;
96         /* Used to notify the guest (trigger interrupt) */
97         int                     callfd;
98         /* Currently unused as polling mode is enabled */
99         int                     kickfd;
100         int                     enabled;
101
102         /* Physical address of used ring, for logging */
103         uint64_t                log_guest_addr;
104
105         uint16_t                nr_zmbuf;
106         uint16_t                zmbuf_size;
107         uint16_t                last_zmbuf_idx;
108         struct zcopy_mbuf       *zmbufs;
109         struct zcopy_mbuf_list  zmbuf_list;
110
111         struct vring_used_elem  *shadow_used_ring;
112         uint16_t                shadow_used_idx;
113 } __rte_cache_aligned;
114
115 /* Old kernels have no such macros defined */
116 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
117  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
118 #endif
119
120 #ifndef VIRTIO_NET_F_MQ
121  #define VIRTIO_NET_F_MQ                22
122 #endif
123 #define VHOST_MAX_QUEUE_PAIRS           0x80
124
125 #ifndef VIRTIO_NET_F_MTU
126  #define VIRTIO_NET_F_MTU 3
127 #endif
128
129 /*
130  * Define virtio 1.0 for older kernels
131  */
132 #ifndef VIRTIO_F_VERSION_1
133  #define VIRTIO_F_VERSION_1 32
134 #endif
135
136 #define VHOST_USER_F_PROTOCOL_FEATURES  30
137
138 /* Features supported by this builtin vhost-user net driver. */
139 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
140                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
141                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
142                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
143                                 (1ULL << VIRTIO_NET_F_MQ)      | \
144                                 (1ULL << VIRTIO_F_VERSION_1)   | \
145                                 (1ULL << VHOST_F_LOG_ALL)      | \
146                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
147                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
148                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
149                                 (1ULL << VIRTIO_NET_F_CSUM)    | \
150                                 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
151                                 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
152                                 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
153                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
154                                 (1ULL << VIRTIO_NET_F_MTU))
155
156
157 struct guest_page {
158         uint64_t guest_phys_addr;
159         uint64_t host_phys_addr;
160         uint64_t size;
161 };
162
163 /**
164  * Device structure contains all configuration information relating
165  * to the device.
166  */
167 struct virtio_net {
168         /* Frontend (QEMU) memory and memory region information */
169         struct virtio_memory    *mem;
170         uint64_t                features;
171         uint64_t                protocol_features;
172         int                     vid;
173         uint32_t                flags;
174         uint16_t                vhost_hlen;
175         /* to tell if we need broadcast rarp packet */
176         rte_atomic16_t          broadcast_rarp;
177         uint32_t                virt_qp_nb;
178         int                     dequeue_zero_copy;
179         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
180 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
181         char                    ifname[IF_NAME_SZ];
182         uint64_t                log_size;
183         uint64_t                log_base;
184         uint64_t                log_addr;
185         struct ether_addr       mac;
186         uint16_t                mtu;
187
188         uint32_t                nr_guest_pages;
189         uint32_t                max_guest_pages;
190         struct guest_page       *guest_pages;
191 } __rte_cache_aligned;
192
193 /**
194  * Information relating to memory regions including offsets to
195  * addresses in QEMUs memory file.
196  */
197 struct virtio_memory_region {
198         uint64_t guest_phys_addr;
199         uint64_t guest_user_addr;
200         uint64_t host_user_addr;
201         uint64_t size;
202         void     *mmap_addr;
203         uint64_t mmap_size;
204         int fd;
205 };
206
207
208 /**
209  * Memory structure includes region and mapping information.
210  */
211 struct virtio_memory {
212         uint32_t nregions;
213         struct virtio_memory_region regions[0];
214 };
215
216
217 /* Macros for printing using RTE_LOG */
218 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
219 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
220
221 #ifdef RTE_LIBRTE_VHOST_DEBUG
222 #define VHOST_MAX_PRINT_BUFF 6072
223 #define LOG_LEVEL RTE_LOG_DEBUG
224 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
225 #define PRINT_PACKET(device, addr, size, header) do { \
226         char *pkt_addr = (char *)(addr); \
227         unsigned int index; \
228         char packet[VHOST_MAX_PRINT_BUFF]; \
229         \
230         if ((header)) \
231                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
232         else \
233                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
234         for (index = 0; index < (size); index++) { \
235                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
236                         "%02hhx ", pkt_addr[index]); \
237         } \
238         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
239         \
240         LOG_DEBUG(VHOST_DATA, "%s", packet); \
241 } while (0)
242 #else
243 #define LOG_LEVEL RTE_LOG_INFO
244 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
245 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
246 #endif
247
248 extern uint64_t VHOST_FEATURES;
249 #define MAX_VHOST_DEVICE        1024
250 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
251
252 /* Convert guest physical Address to host virtual address */
253 static inline uint64_t __attribute__((always_inline))
254 gpa_to_vva(struct virtio_net *dev, uint64_t gpa)
255 {
256         struct virtio_memory_region *reg;
257         uint32_t i;
258
259         for (i = 0; i < dev->mem->nregions; i++) {
260                 reg = &dev->mem->regions[i];
261                 if (gpa >= reg->guest_phys_addr &&
262                     gpa <  reg->guest_phys_addr + reg->size) {
263                         return gpa - reg->guest_phys_addr +
264                                reg->host_user_addr;
265                 }
266         }
267
268         return 0;
269 }
270
271 /* Convert guest physical address to host physical address */
272 static inline phys_addr_t __attribute__((always_inline))
273 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
274 {
275         uint32_t i;
276         struct guest_page *page;
277
278         for (i = 0; i < dev->nr_guest_pages; i++) {
279                 page = &dev->guest_pages[i];
280
281                 if (gpa >= page->guest_phys_addr &&
282                     gpa + size < page->guest_phys_addr + page->size) {
283                         return gpa - page->guest_phys_addr +
284                                page->host_phys_addr;
285                 }
286         }
287
288         return 0;
289 }
290
291 struct virtio_net_device_ops const *notify_ops;
292 struct virtio_net *get_device(int vid);
293
294 int vhost_new_device(void);
295 void cleanup_device(struct virtio_net *dev, int destroy);
296 void reset_device(struct virtio_net *dev);
297 void vhost_destroy_device(int);
298
299 int alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx);
300
301 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
302 void vhost_enable_dequeue_zero_copy(int vid);
303
304 /*
305  * Backend-specific cleanup.
306  *
307  * TODO: fix it; we have one backend now
308  */
309 void vhost_backend_cleanup(struct virtio_net *dev);
310
311 #endif /* _VHOST_NET_CDEV_H_ */