vhost: invalidate vring in case of matching IOTLB invalidate
[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         int                     access_ok;
117
118         /* Physical address of used ring, for logging */
119         uint64_t                log_guest_addr;
120
121         uint16_t                nr_zmbuf;
122         uint16_t                zmbuf_size;
123         uint16_t                last_zmbuf_idx;
124         struct zcopy_mbuf       *zmbufs;
125         struct zcopy_mbuf_list  zmbuf_list;
126
127         struct vring_used_elem  *shadow_used_ring;
128         uint16_t                shadow_used_idx;
129         struct vhost_vring_addr ring_addrs;
130
131         struct batch_copy_elem  *batch_copy_elems;
132         uint16_t                batch_copy_nb_elems;
133
134         rte_rwlock_t    iotlb_lock;
135         rte_rwlock_t    iotlb_pending_lock;
136         struct rte_mempool *iotlb_pool;
137         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_list;
138         int                             iotlb_cache_nr;
139         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_pending_list;
140 } __rte_cache_aligned;
141
142 /* Old kernels have no such macros defined */
143 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
144  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
145 #endif
146
147 #ifndef VIRTIO_NET_F_MQ
148  #define VIRTIO_NET_F_MQ                22
149 #endif
150
151 #define VHOST_MAX_VRING                 0x100
152 #define VHOST_MAX_QUEUE_PAIRS           0x80
153
154 #ifndef VIRTIO_NET_F_MTU
155  #define VIRTIO_NET_F_MTU 3
156 #endif
157
158 /* Declare IOMMU related bits for older kernels */
159 #ifndef VIRTIO_F_IOMMU_PLATFORM
160
161 #define VIRTIO_F_IOMMU_PLATFORM 33
162
163 struct vhost_iotlb_msg {
164         __u64 iova;
165         __u64 size;
166         __u64 uaddr;
167 #define VHOST_ACCESS_RO      0x1
168 #define VHOST_ACCESS_WO      0x2
169 #define VHOST_ACCESS_RW      0x3
170         __u8 perm;
171 #define VHOST_IOTLB_MISS           1
172 #define VHOST_IOTLB_UPDATE         2
173 #define VHOST_IOTLB_INVALIDATE     3
174 #define VHOST_IOTLB_ACCESS_FAIL    4
175         __u8 type;
176 };
177
178 #define VHOST_IOTLB_MSG 0x1
179
180 struct vhost_msg {
181         int type;
182         union {
183                 struct vhost_iotlb_msg iotlb;
184                 __u8 padding[64];
185         };
186 };
187 #endif
188
189 /*
190  * Define virtio 1.0 for older kernels
191  */
192 #ifndef VIRTIO_F_VERSION_1
193  #define VIRTIO_F_VERSION_1 32
194 #endif
195
196 #define VHOST_USER_F_PROTOCOL_FEATURES  30
197
198 /* Features supported by this builtin vhost-user net driver. */
199 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
200                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
201                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
202                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
203                                 (1ULL << VIRTIO_NET_F_MQ)      | \
204                                 (1ULL << VIRTIO_F_VERSION_1)   | \
205                                 (1ULL << VHOST_F_LOG_ALL)      | \
206                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
207                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
208                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
209                                 (1ULL << VIRTIO_NET_F_CSUM)    | \
210                                 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
211                                 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
212                                 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
213                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
214                                 (1ULL << VIRTIO_NET_F_MTU))
215
216
217 struct guest_page {
218         uint64_t guest_phys_addr;
219         uint64_t host_phys_addr;
220         uint64_t size;
221 };
222
223 /**
224  * Device structure contains all configuration information relating
225  * to the device.
226  */
227 struct virtio_net {
228         /* Frontend (QEMU) memory and memory region information */
229         struct rte_vhost_memory *mem;
230         uint64_t                features;
231         uint64_t                protocol_features;
232         int                     vid;
233         uint32_t                flags;
234         uint16_t                vhost_hlen;
235         /* to tell if we need broadcast rarp packet */
236         rte_atomic16_t          broadcast_rarp;
237         uint32_t                nr_vring;
238         int                     dequeue_zero_copy;
239         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
240 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
241         char                    ifname[IF_NAME_SZ];
242         uint64_t                log_size;
243         uint64_t                log_base;
244         uint64_t                log_addr;
245         struct ether_addr       mac;
246         uint16_t                mtu;
247
248         struct vhost_device_ops const *notify_ops;
249
250         uint32_t                nr_guest_pages;
251         uint32_t                max_guest_pages;
252         struct guest_page       *guest_pages;
253
254         int                     slave_req_fd;
255 } __rte_cache_aligned;
256
257
258 #define VHOST_LOG_PAGE  4096
259
260 /*
261  * Atomically set a bit in memory.
262  */
263 static __rte_always_inline void
264 vhost_set_bit(unsigned int nr, volatile uint8_t *addr)
265 {
266         __sync_fetch_and_or_8(addr, (1U << nr));
267 }
268
269 static __rte_always_inline void
270 vhost_log_page(uint8_t *log_base, uint64_t page)
271 {
272         vhost_set_bit(page % 8, &log_base[page / 8]);
273 }
274
275 static __rte_always_inline void
276 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
277 {
278         uint64_t page;
279
280         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
281                    !dev->log_base || !len))
282                 return;
283
284         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
285                 return;
286
287         /* To make sure guest memory updates are committed before logging */
288         rte_smp_wmb();
289
290         page = addr / VHOST_LOG_PAGE;
291         while (page * VHOST_LOG_PAGE < addr + len) {
292                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
293                 page += 1;
294         }
295 }
296
297 static __rte_always_inline void
298 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
299                      uint64_t offset, uint64_t len)
300 {
301         vhost_log_write(dev, vq->log_guest_addr + offset, len);
302 }
303
304 /* Macros for printing using RTE_LOG */
305 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
306 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
307
308 #ifdef RTE_LIBRTE_VHOST_DEBUG
309 #define VHOST_MAX_PRINT_BUFF 6072
310 #define LOG_LEVEL RTE_LOG_DEBUG
311 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
312 #define PRINT_PACKET(device, addr, size, header) do { \
313         char *pkt_addr = (char *)(addr); \
314         unsigned int index; \
315         char packet[VHOST_MAX_PRINT_BUFF]; \
316         \
317         if ((header)) \
318                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
319         else \
320                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
321         for (index = 0; index < (size); index++) { \
322                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
323                         "%02hhx ", pkt_addr[index]); \
324         } \
325         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
326         \
327         LOG_DEBUG(VHOST_DATA, "%s", packet); \
328 } while (0)
329 #else
330 #define LOG_LEVEL RTE_LOG_INFO
331 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
332 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
333 #endif
334
335 extern uint64_t VHOST_FEATURES;
336 #define MAX_VHOST_DEVICE        1024
337 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
338
339 /* Convert guest physical address to host physical address */
340 static __rte_always_inline phys_addr_t
341 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
342 {
343         uint32_t i;
344         struct guest_page *page;
345
346         for (i = 0; i < dev->nr_guest_pages; i++) {
347                 page = &dev->guest_pages[i];
348
349                 if (gpa >= page->guest_phys_addr &&
350                     gpa + size < page->guest_phys_addr + page->size) {
351                         return gpa - page->guest_phys_addr +
352                                page->host_phys_addr;
353                 }
354         }
355
356         return 0;
357 }
358
359 struct virtio_net *get_device(int vid);
360
361 int vhost_new_device(void);
362 void cleanup_device(struct virtio_net *dev, int destroy);
363 void reset_device(struct virtio_net *dev);
364 void vhost_destroy_device(int);
365
366 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
367
368 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
369 void vhost_enable_dequeue_zero_copy(int vid);
370
371 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
372
373 /*
374  * Backend-specific cleanup.
375  *
376  * TODO: fix it; we have one backend now
377  */
378 void vhost_backend_cleanup(struct virtio_net *dev);
379
380 uint64_t __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
381                         uint64_t iova, uint64_t size, uint8_t perm);
382 int vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq);
383 void vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq);
384
385 static __rte_always_inline uint64_t
386 vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
387                         uint64_t iova, uint64_t size, uint8_t perm)
388 {
389         if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
390                 return rte_vhost_gpa_to_vva(dev->mem, iova);
391
392         return __vhost_iova_to_vva(dev, vq, iova, size, perm);
393 }
394
395 #endif /* _VHOST_NET_CDEV_H_ */