vhost: add pending IOTLB miss request list and helpers
[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 #include <linux/virtio_net.h>
43 #include <sys/socket.h>
44 #include <linux/if.h>
45
46 #include <rte_log.h>
47 #include <rte_ether.h>
48 #include <rte_rwlock.h>
49
50 #include "rte_vhost.h"
51
52 /* Used to indicate that the device is running on a data core */
53 #define VIRTIO_DEV_RUNNING 1
54 /* Used to indicate that the device is ready to operate */
55 #define VIRTIO_DEV_READY 2
56
57 /* Backend value set by guest. */
58 #define VIRTIO_DEV_STOPPED -1
59
60 #define BUF_VECTOR_MAX 256
61
62 /**
63  * Structure contains buffer address, length and descriptor index
64  * from vring to do scatter RX.
65  */
66 struct buf_vector {
67         uint64_t buf_addr;
68         uint32_t buf_len;
69         uint32_t desc_idx;
70 };
71
72 /*
73  * A structure to hold some fields needed in zero copy code path,
74  * mainly for associating an mbuf with the right desc_idx.
75  */
76 struct zcopy_mbuf {
77         struct rte_mbuf *mbuf;
78         uint32_t desc_idx;
79         uint16_t in_use;
80
81         TAILQ_ENTRY(zcopy_mbuf) next;
82 };
83 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
84
85 /*
86  * Structure contains the info for each batched memory copy.
87  */
88 struct batch_copy_elem {
89         void *dst;
90         void *src;
91         uint32_t len;
92         uint64_t log_addr;
93 };
94
95 /**
96  * Structure contains variables relevant to RX/TX virtqueues.
97  */
98 struct vhost_virtqueue {
99         struct vring_desc       *desc;
100         struct vring_avail      *avail;
101         struct vring_used       *used;
102         uint32_t                size;
103
104         uint16_t                last_avail_idx;
105         uint16_t                last_used_idx;
106 #define VIRTIO_INVALID_EVENTFD          (-1)
107 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
108
109         /* Backend value to determine if device should started/stopped */
110         int                     backend;
111         /* Used to notify the guest (trigger interrupt) */
112         int                     callfd;
113         /* Currently unused as polling mode is enabled */
114         int                     kickfd;
115         int                     enabled;
116
117         /* Physical address of used ring, for logging */
118         uint64_t                log_guest_addr;
119
120         uint16_t                nr_zmbuf;
121         uint16_t                zmbuf_size;
122         uint16_t                last_zmbuf_idx;
123         struct zcopy_mbuf       *zmbufs;
124         struct zcopy_mbuf_list  zmbuf_list;
125
126         struct vring_used_elem  *shadow_used_ring;
127         uint16_t                shadow_used_idx;
128
129         struct batch_copy_elem  *batch_copy_elems;
130         uint16_t                batch_copy_nb_elems;
131
132         rte_rwlock_t    iotlb_lock;
133         rte_rwlock_t    iotlb_pending_lock;
134         struct rte_mempool *iotlb_pool;
135         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_list;
136         int                             iotlb_cache_nr;
137         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_pending_list;
138 } __rte_cache_aligned;
139
140 /* Old kernels have no such macros defined */
141 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
142  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
143 #endif
144
145 #ifndef VIRTIO_NET_F_MQ
146  #define VIRTIO_NET_F_MQ                22
147 #endif
148
149 #define VHOST_MAX_VRING                 0x100
150 #define VHOST_MAX_QUEUE_PAIRS           0x80
151
152 #ifndef VIRTIO_NET_F_MTU
153  #define VIRTIO_NET_F_MTU 3
154 #endif
155
156 /* Declare IOMMU related bits for older kernels */
157 #ifndef VIRTIO_F_IOMMU_PLATFORM
158
159 #define VIRTIO_F_IOMMU_PLATFORM 33
160
161 struct vhost_iotlb_msg {
162         __u64 iova;
163         __u64 size;
164         __u64 uaddr;
165 #define VHOST_ACCESS_RO      0x1
166 #define VHOST_ACCESS_WO      0x2
167 #define VHOST_ACCESS_RW      0x3
168         __u8 perm;
169 #define VHOST_IOTLB_MISS           1
170 #define VHOST_IOTLB_UPDATE         2
171 #define VHOST_IOTLB_INVALIDATE     3
172 #define VHOST_IOTLB_ACCESS_FAIL    4
173         __u8 type;
174 };
175
176 #define VHOST_IOTLB_MSG 0x1
177
178 struct vhost_msg {
179         int type;
180         union {
181                 struct vhost_iotlb_msg iotlb;
182                 __u8 padding[64];
183         };
184 };
185 #endif
186
187 /*
188  * Define virtio 1.0 for older kernels
189  */
190 #ifndef VIRTIO_F_VERSION_1
191  #define VIRTIO_F_VERSION_1 32
192 #endif
193
194 #define VHOST_USER_F_PROTOCOL_FEATURES  30
195
196 /* Features supported by this builtin vhost-user net driver. */
197 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
198                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
199                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
200                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
201                                 (1ULL << VIRTIO_NET_F_MQ)      | \
202                                 (1ULL << VIRTIO_F_VERSION_1)   | \
203                                 (1ULL << VHOST_F_LOG_ALL)      | \
204                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
205                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
206                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
207                                 (1ULL << VIRTIO_NET_F_CSUM)    | \
208                                 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
209                                 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
210                                 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
211                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
212                                 (1ULL << VIRTIO_NET_F_MTU))
213
214
215 struct guest_page {
216         uint64_t guest_phys_addr;
217         uint64_t host_phys_addr;
218         uint64_t size;
219 };
220
221 /**
222  * Device structure contains all configuration information relating
223  * to the device.
224  */
225 struct virtio_net {
226         /* Frontend (QEMU) memory and memory region information */
227         struct rte_vhost_memory *mem;
228         uint64_t                features;
229         uint64_t                protocol_features;
230         int                     vid;
231         uint32_t                flags;
232         uint16_t                vhost_hlen;
233         /* to tell if we need broadcast rarp packet */
234         rte_atomic16_t          broadcast_rarp;
235         uint32_t                nr_vring;
236         int                     dequeue_zero_copy;
237         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
238 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
239         char                    ifname[IF_NAME_SZ];
240         uint64_t                log_size;
241         uint64_t                log_base;
242         uint64_t                log_addr;
243         struct ether_addr       mac;
244         uint16_t                mtu;
245
246         struct vhost_device_ops const *notify_ops;
247
248         uint32_t                nr_guest_pages;
249         uint32_t                max_guest_pages;
250         struct guest_page       *guest_pages;
251
252         int                     slave_req_fd;
253 } __rte_cache_aligned;
254
255
256 #define VHOST_LOG_PAGE  4096
257
258 /*
259  * Atomically set a bit in memory.
260  */
261 static __rte_always_inline void
262 vhost_set_bit(unsigned int nr, volatile uint8_t *addr)
263 {
264         __sync_fetch_and_or_8(addr, (1U << nr));
265 }
266
267 static __rte_always_inline void
268 vhost_log_page(uint8_t *log_base, uint64_t page)
269 {
270         vhost_set_bit(page % 8, &log_base[page / 8]);
271 }
272
273 static __rte_always_inline void
274 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
275 {
276         uint64_t page;
277
278         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
279                    !dev->log_base || !len))
280                 return;
281
282         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
283                 return;
284
285         /* To make sure guest memory updates are committed before logging */
286         rte_smp_wmb();
287
288         page = addr / VHOST_LOG_PAGE;
289         while (page * VHOST_LOG_PAGE < addr + len) {
290                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
291                 page += 1;
292         }
293 }
294
295 static __rte_always_inline void
296 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
297                      uint64_t offset, uint64_t len)
298 {
299         vhost_log_write(dev, vq->log_guest_addr + offset, len);
300 }
301
302 /* Macros for printing using RTE_LOG */
303 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
304 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
305
306 #ifdef RTE_LIBRTE_VHOST_DEBUG
307 #define VHOST_MAX_PRINT_BUFF 6072
308 #define LOG_LEVEL RTE_LOG_DEBUG
309 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
310 #define PRINT_PACKET(device, addr, size, header) do { \
311         char *pkt_addr = (char *)(addr); \
312         unsigned int index; \
313         char packet[VHOST_MAX_PRINT_BUFF]; \
314         \
315         if ((header)) \
316                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
317         else \
318                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
319         for (index = 0; index < (size); index++) { \
320                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
321                         "%02hhx ", pkt_addr[index]); \
322         } \
323         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
324         \
325         LOG_DEBUG(VHOST_DATA, "%s", packet); \
326 } while (0)
327 #else
328 #define LOG_LEVEL RTE_LOG_INFO
329 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
330 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
331 #endif
332
333 extern uint64_t VHOST_FEATURES;
334 #define MAX_VHOST_DEVICE        1024
335 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
336
337 /* Convert guest physical address to host physical address */
338 static __rte_always_inline phys_addr_t
339 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
340 {
341         uint32_t i;
342         struct guest_page *page;
343
344         for (i = 0; i < dev->nr_guest_pages; i++) {
345                 page = &dev->guest_pages[i];
346
347                 if (gpa >= page->guest_phys_addr &&
348                     gpa + size < page->guest_phys_addr + page->size) {
349                         return gpa - page->guest_phys_addr +
350                                page->host_phys_addr;
351                 }
352         }
353
354         return 0;
355 }
356
357 struct virtio_net *get_device(int vid);
358
359 int vhost_new_device(void);
360 void cleanup_device(struct virtio_net *dev, int destroy);
361 void reset_device(struct virtio_net *dev);
362 void vhost_destroy_device(int);
363
364 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
365
366 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
367 void vhost_enable_dequeue_zero_copy(int vid);
368
369 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
370
371 /*
372  * Backend-specific cleanup.
373  *
374  * TODO: fix it; we have one backend now
375  */
376 void vhost_backend_cleanup(struct virtio_net *dev);
377
378 #endif /* _VHOST_NET_CDEV_H_ */