vhost: fix multiple queue not enabled for old kernels
[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
50 /* Backend value set by guest. */
51 #define VIRTIO_DEV_STOPPED -1
52
53 #define BUF_VECTOR_MAX 256
54
55 /**
56  * Structure contains buffer address, length and descriptor index
57  * from vring to do scatter RX.
58  */
59 struct buf_vector {
60         uint64_t buf_addr;
61         uint32_t buf_len;
62         uint32_t desc_idx;
63 };
64
65 /*
66  * A structure to hold some fields needed in zero copy code path,
67  * mainly for associating an mbuf with the right desc_idx.
68  */
69 struct zcopy_mbuf {
70         struct rte_mbuf *mbuf;
71         uint32_t desc_idx;
72         uint16_t in_use;
73
74         TAILQ_ENTRY(zcopy_mbuf) next;
75 };
76 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
77
78 /**
79  * Structure contains variables relevant to RX/TX virtqueues.
80  */
81 struct vhost_virtqueue {
82         struct vring_desc       *desc;
83         struct vring_avail      *avail;
84         struct vring_used       *used;
85         uint32_t                size;
86
87         uint16_t                last_avail_idx;
88         uint16_t                last_used_idx;
89 #define VIRTIO_INVALID_EVENTFD          (-1)
90 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
91
92         /* Backend value to determine if device should started/stopped */
93         int                     backend;
94         /* Used to notify the guest (trigger interrupt) */
95         int                     callfd;
96         /* Currently unused as polling mode is enabled */
97         int                     kickfd;
98         int                     enabled;
99
100         /* Physical address of used ring, for logging */
101         uint64_t                log_guest_addr;
102
103         uint16_t                nr_zmbuf;
104         uint16_t                zmbuf_size;
105         uint16_t                last_zmbuf_idx;
106         struct zcopy_mbuf       *zmbufs;
107         struct zcopy_mbuf_list  zmbuf_list;
108
109         struct vring_used_elem  *shadow_used_ring;
110         uint16_t                shadow_used_idx;
111 } __rte_cache_aligned;
112
113 /* Old kernels have no such macro defined */
114 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
115  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
116 #endif
117
118
119 /*
120  * Make an extra wrapper for VIRTIO_NET_F_MQ and
121  * VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX as they are
122  * introduced since kernel v3.8. This makes our
123  * code buildable for older kernel.
124  */
125 #ifdef VIRTIO_NET_F_MQ
126  #define VHOST_MAX_QUEUE_PAIRS          VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX
127 #else
128  #define VIRTIO_NET_F_MQ                22
129  #define VHOST_MAX_QUEUE_PAIRS          0x8000
130 #endif
131
132 /*
133  * Define virtio 1.0 for older kernels
134  */
135 #ifndef VIRTIO_F_VERSION_1
136  #define VIRTIO_F_VERSION_1 32
137 #endif
138
139 struct guest_page {
140         uint64_t guest_phys_addr;
141         uint64_t host_phys_addr;
142         uint64_t size;
143 };
144
145 /**
146  * Device structure contains all configuration information relating
147  * to the device.
148  */
149 struct virtio_net {
150         /* Frontend (QEMU) memory and memory region information */
151         struct virtio_memory    *mem;
152         uint64_t                features;
153         uint64_t                protocol_features;
154         int                     vid;
155         uint32_t                flags;
156         uint16_t                vhost_hlen;
157         /* to tell if we need broadcast rarp packet */
158         rte_atomic16_t          broadcast_rarp;
159         uint32_t                virt_qp_nb;
160         int                     dequeue_zero_copy;
161         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
162 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
163         char                    ifname[IF_NAME_SZ];
164         uint64_t                log_size;
165         uint64_t                log_base;
166         uint64_t                log_addr;
167         struct ether_addr       mac;
168
169         uint32_t                nr_guest_pages;
170         uint32_t                max_guest_pages;
171         struct guest_page       *guest_pages;
172 } __rte_cache_aligned;
173
174 /**
175  * Information relating to memory regions including offsets to
176  * addresses in QEMUs memory file.
177  */
178 struct virtio_memory_region {
179         uint64_t guest_phys_addr;
180         uint64_t guest_user_addr;
181         uint64_t host_user_addr;
182         uint64_t size;
183         void     *mmap_addr;
184         uint64_t mmap_size;
185         int fd;
186 };
187
188
189 /**
190  * Memory structure includes region and mapping information.
191  */
192 struct virtio_memory {
193         uint32_t nregions;
194         struct virtio_memory_region regions[0];
195 };
196
197
198 /* Macros for printing using RTE_LOG */
199 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
200 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
201
202 #ifdef RTE_LIBRTE_VHOST_DEBUG
203 #define VHOST_MAX_PRINT_BUFF 6072
204 #define LOG_LEVEL RTE_LOG_DEBUG
205 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
206 #define PRINT_PACKET(device, addr, size, header) do { \
207         char *pkt_addr = (char *)(addr); \
208         unsigned int index; \
209         char packet[VHOST_MAX_PRINT_BUFF]; \
210         \
211         if ((header)) \
212                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
213         else \
214                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
215         for (index = 0; index < (size); index++) { \
216                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
217                         "%02hhx ", pkt_addr[index]); \
218         } \
219         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
220         \
221         LOG_DEBUG(VHOST_DATA, "%s", packet); \
222 } while (0)
223 #else
224 #define LOG_LEVEL RTE_LOG_INFO
225 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
226 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
227 #endif
228
229 extern uint64_t VHOST_FEATURES;
230 #define MAX_VHOST_DEVICE        1024
231 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
232
233 /* Convert guest physical Address to host virtual address */
234 static inline uint64_t __attribute__((always_inline))
235 gpa_to_vva(struct virtio_net *dev, uint64_t gpa)
236 {
237         struct virtio_memory_region *reg;
238         uint32_t i;
239
240         for (i = 0; i < dev->mem->nregions; i++) {
241                 reg = &dev->mem->regions[i];
242                 if (gpa >= reg->guest_phys_addr &&
243                     gpa <  reg->guest_phys_addr + reg->size) {
244                         return gpa - reg->guest_phys_addr +
245                                reg->host_user_addr;
246                 }
247         }
248
249         return 0;
250 }
251
252 /* Convert guest physical address to host physical address */
253 static inline phys_addr_t __attribute__((always_inline))
254 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
255 {
256         uint32_t i;
257         struct guest_page *page;
258
259         for (i = 0; i < dev->nr_guest_pages; i++) {
260                 page = &dev->guest_pages[i];
261
262                 if (gpa >= page->guest_phys_addr &&
263                     gpa + size < page->guest_phys_addr + page->size) {
264                         return gpa - page->guest_phys_addr +
265                                page->host_phys_addr;
266                 }
267         }
268
269         return 0;
270 }
271
272 struct virtio_net_device_ops const *notify_ops;
273 struct virtio_net *get_device(int vid);
274
275 int vhost_new_device(void);
276 void cleanup_device(struct virtio_net *dev, int destroy);
277 void reset_device(struct virtio_net *dev);
278 void vhost_destroy_device(int);
279
280 int alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx);
281
282 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
283 void vhost_enable_dequeue_zero_copy(int vid);
284
285 /*
286  * Backend-specific cleanup.
287  *
288  * TODO: fix it; we have one backend now
289  */
290 void vhost_backend_cleanup(struct virtio_net *dev);
291
292 #endif /* _VHOST_NET_CDEV_H_ */