786a74f649959a16383849d0529d3223d0936abb
[dpdk.git] / lib / librte_vhost / vhost.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2018 Intel Corporation
3  */
4
5 #ifndef _VHOST_NET_CDEV_H_
6 #define _VHOST_NET_CDEV_H_
7 #include <stdint.h>
8 #include <stdio.h>
9 #include <stdbool.h>
10 #include <sys/types.h>
11 #include <sys/queue.h>
12 #include <unistd.h>
13 #include <linux/vhost.h>
14 #include <linux/virtio_net.h>
15 #include <sys/socket.h>
16 #include <linux/if.h>
17
18 #include <rte_log.h>
19 #include <rte_ether.h>
20 #include <rte_rwlock.h>
21
22 #include "rte_vhost.h"
23 #include "rte_vdpa.h"
24
25 /* Used to indicate that the device is running on a data core */
26 #define VIRTIO_DEV_RUNNING 1
27 /* Used to indicate that the device is ready to operate */
28 #define VIRTIO_DEV_READY 2
29 /* Used to indicate that the built-in vhost net device backend is enabled */
30 #define VIRTIO_DEV_BUILTIN_VIRTIO_NET 4
31 /* Used to indicate that the device has its own data path and configured */
32 #define VIRTIO_DEV_VDPA_CONFIGURED 8
33
34 /* Backend value set by guest. */
35 #define VIRTIO_DEV_STOPPED -1
36
37 #define BUF_VECTOR_MAX 256
38
39 #define VHOST_LOG_CACHE_NR 32
40
41 /**
42  * Structure contains buffer address, length and descriptor index
43  * from vring to do scatter RX.
44  */
45 struct buf_vector {
46         uint64_t buf_addr;
47         uint32_t buf_len;
48         uint32_t desc_idx;
49 };
50
51 /*
52  * A structure to hold some fields needed in zero copy code path,
53  * mainly for associating an mbuf with the right desc_idx.
54  */
55 struct zcopy_mbuf {
56         struct rte_mbuf *mbuf;
57         uint32_t desc_idx;
58         uint16_t in_use;
59
60         TAILQ_ENTRY(zcopy_mbuf) next;
61 };
62 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
63
64 /*
65  * Structure contains the info for each batched memory copy.
66  */
67 struct batch_copy_elem {
68         void *dst;
69         void *src;
70         uint32_t len;
71         uint64_t log_addr;
72 };
73
74 /*
75  * Structure that contains the info for batched dirty logging.
76  */
77 struct log_cache_entry {
78         uint32_t offset;
79         unsigned long val;
80 };
81
82 /**
83  * Structure contains variables relevant to RX/TX virtqueues.
84  */
85 struct vhost_virtqueue {
86         struct vring_desc       *desc;
87         struct vring_avail      *avail;
88         struct vring_used       *used;
89         uint32_t                size;
90
91         uint16_t                last_avail_idx;
92         uint16_t                last_used_idx;
93         /* Last used index we notify to front end. */
94         uint16_t                signalled_used;
95 #define VIRTIO_INVALID_EVENTFD          (-1)
96 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
97
98         /* Backend value to determine if device should started/stopped */
99         int                     backend;
100         int                     enabled;
101         int                     access_ok;
102         rte_spinlock_t          access_lock;
103
104         /* Used to notify the guest (trigger interrupt) */
105         int                     callfd;
106         /* Currently unused as polling mode is enabled */
107         int                     kickfd;
108
109         /* Physical address of used ring, for logging */
110         uint64_t                log_guest_addr;
111
112         uint16_t                nr_zmbuf;
113         uint16_t                zmbuf_size;
114         uint16_t                last_zmbuf_idx;
115         struct zcopy_mbuf       *zmbufs;
116         struct zcopy_mbuf_list  zmbuf_list;
117
118         struct vring_used_elem  *shadow_used_ring;
119         uint16_t                shadow_used_idx;
120         struct vhost_vring_addr ring_addrs;
121
122         struct batch_copy_elem  *batch_copy_elems;
123         uint16_t                batch_copy_nb_elems;
124
125         struct log_cache_entry log_cache[VHOST_LOG_CACHE_NR];
126         uint16_t log_cache_nb_elem;
127
128         rte_rwlock_t    iotlb_lock;
129         rte_rwlock_t    iotlb_pending_lock;
130         struct rte_mempool *iotlb_pool;
131         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_list;
132         int                             iotlb_cache_nr;
133         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_pending_list;
134 } __rte_cache_aligned;
135
136 /* Old kernels have no such macros defined */
137 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
138  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
139 #endif
140
141 #ifndef VIRTIO_NET_F_MQ
142  #define VIRTIO_NET_F_MQ                22
143 #endif
144
145 #define VHOST_MAX_VRING                 0x100
146 #define VHOST_MAX_QUEUE_PAIRS           0x80
147
148 #ifndef VIRTIO_NET_F_MTU
149  #define VIRTIO_NET_F_MTU 3
150 #endif
151
152 #ifndef VIRTIO_F_ANY_LAYOUT
153  #define VIRTIO_F_ANY_LAYOUT            27
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 /* Features supported by this builtin vhost-user net driver. */
195 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
196                                 (1ULL << VIRTIO_F_ANY_LAYOUT) | \
197                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
198                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
199                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
200                                 (1ULL << VIRTIO_NET_F_MQ)      | \
201                                 (1ULL << VIRTIO_F_VERSION_1)   | \
202                                 (1ULL << VHOST_F_LOG_ALL)      | \
203                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
204                                 (1ULL << VIRTIO_NET_F_GSO) | \
205                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
206                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
207                                 (1ULL << VIRTIO_NET_F_HOST_UFO) | \
208                                 (1ULL << VIRTIO_NET_F_HOST_ECN) | \
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_NET_F_GUEST_UFO) | \
214                                 (1ULL << VIRTIO_NET_F_GUEST_ECN) | \
215                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
216                                 (1ULL << VIRTIO_RING_F_EVENT_IDX) | \
217                                 (1ULL << VIRTIO_NET_F_MTU) | \
218                                 (1ULL << VIRTIO_F_IOMMU_PLATFORM))
219
220
221 struct guest_page {
222         uint64_t guest_phys_addr;
223         uint64_t host_phys_addr;
224         uint64_t size;
225 };
226
227 /**
228  * function prototype for the vhost backend to handler specific vhost user
229  * messages prior to the master message handling
230  *
231  * @param vid
232  *  vhost device id
233  * @param msg
234  *  Message pointer.
235  * @param require_reply
236  *  If the handler requires sending a reply, this varaible shall be written 1,
237  *  otherwise 0.
238  * @param skip_master
239  *  If the handler requires skipping the master message handling, this variable
240  *  shall be written 1, otherwise 0.
241  * @return
242  *  0 on success, -1 on failure
243  */
244 typedef int (*vhost_msg_pre_handle)(int vid, void *msg,
245                 uint32_t *require_reply, uint32_t *skip_master);
246
247 /**
248  * function prototype for the vhost backend to handler specific vhost user
249  * messages after the master message handling is done
250  *
251  * @param vid
252  *  vhost device id
253  * @param msg
254  *  Message pointer.
255  * @param require_reply
256  *  If the handler requires sending a reply, this varaible shall be written 1,
257  *  otherwise 0.
258  * @return
259  *  0 on success, -1 on failure
260  */
261 typedef int (*vhost_msg_post_handle)(int vid, void *msg,
262                 uint32_t *require_reply);
263
264 /**
265  * pre and post vhost user message handlers
266  */
267 struct vhost_user_extern_ops {
268         vhost_msg_pre_handle pre_msg_handle;
269         vhost_msg_post_handle post_msg_handle;
270 };
271
272 /**
273  * Device structure contains all configuration information relating
274  * to the device.
275  */
276 struct virtio_net {
277         /* Frontend (QEMU) memory and memory region information */
278         struct rte_vhost_memory *mem;
279         uint64_t                features;
280         uint64_t                protocol_features;
281         int                     vid;
282         uint32_t                flags;
283         uint16_t                vhost_hlen;
284         /* to tell if we need broadcast rarp packet */
285         rte_atomic16_t          broadcast_rarp;
286         uint32_t                nr_vring;
287         int                     dequeue_zero_copy;
288         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
289 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
290         char                    ifname[IF_NAME_SZ];
291         uint64_t                log_size;
292         uint64_t                log_base;
293         uint64_t                log_addr;
294         struct ether_addr       mac;
295         uint16_t                mtu;
296
297         struct vhost_device_ops const *notify_ops;
298
299         uint32_t                nr_guest_pages;
300         uint32_t                max_guest_pages;
301         struct guest_page       *guest_pages;
302
303         int                     slave_req_fd;
304         rte_spinlock_t          slave_req_lock;
305
306         /*
307          * Device id to identify a specific backend device.
308          * It's set to -1 for the default software implementation.
309          */
310         int                     vdpa_dev_id;
311
312         /* private data for virtio device */
313         void                    *extern_data;
314         /* pre and post vhost user message handlers for the device */
315         struct vhost_user_extern_ops extern_ops;
316 } __rte_cache_aligned;
317
318 #define VHOST_LOG_PAGE  4096
319
320 /*
321  * Atomically set a bit in memory.
322  */
323 static __rte_always_inline void
324 vhost_set_bit(unsigned int nr, volatile uint8_t *addr)
325 {
326 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
327         /*
328          * __sync_ built-ins are deprecated, but __atomic_ ones
329          * are sub-optimized in older GCC versions.
330          */
331         __sync_fetch_and_or_1(addr, (1U << nr));
332 #else
333         __atomic_fetch_or(addr, (1U << nr), __ATOMIC_RELAXED);
334 #endif
335 }
336
337 static __rte_always_inline void
338 vhost_log_page(uint8_t *log_base, uint64_t page)
339 {
340         vhost_set_bit(page % 8, &log_base[page / 8]);
341 }
342
343 static __rte_always_inline void
344 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
345 {
346         uint64_t page;
347
348         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
349                    !dev->log_base || !len))
350                 return;
351
352         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
353                 return;
354
355         /* To make sure guest memory updates are committed before logging */
356         rte_smp_wmb();
357
358         page = addr / VHOST_LOG_PAGE;
359         while (page * VHOST_LOG_PAGE < addr + len) {
360                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
361                 page += 1;
362         }
363 }
364
365 static __rte_always_inline void
366 vhost_log_cache_sync(struct virtio_net *dev, struct vhost_virtqueue *vq)
367 {
368         unsigned long *log_base;
369         int i;
370
371         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
372                    !dev->log_base))
373                 return;
374
375         log_base = (unsigned long *)(uintptr_t)dev->log_base;
376
377         /*
378          * It is expected a write memory barrier has been issued
379          * before this function is called.
380          */
381
382         for (i = 0; i < vq->log_cache_nb_elem; i++) {
383                 struct log_cache_entry *elem = vq->log_cache + i;
384
385 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
386                 /*
387                  * '__sync' builtins are deprecated, but '__atomic' ones
388                  * are sub-optimized in older GCC versions.
389                  */
390                 __sync_fetch_and_or(log_base + elem->offset, elem->val);
391 #else
392                 __atomic_fetch_or(log_base + elem->offset, elem->val,
393                                 __ATOMIC_RELAXED);
394 #endif
395         }
396
397         rte_smp_wmb();
398
399         vq->log_cache_nb_elem = 0;
400 }
401
402 static __rte_always_inline void
403 vhost_log_cache_page(struct virtio_net *dev, struct vhost_virtqueue *vq,
404                         uint64_t page)
405 {
406         uint32_t bit_nr = page % (sizeof(unsigned long) << 3);
407         uint32_t offset = page / (sizeof(unsigned long) << 3);
408         int i;
409
410         for (i = 0; i < vq->log_cache_nb_elem; i++) {
411                 struct log_cache_entry *elem = vq->log_cache + i;
412
413                 if (elem->offset == offset) {
414                         elem->val |= (1UL << bit_nr);
415                         return;
416                 }
417         }
418
419         if (unlikely(i >= VHOST_LOG_CACHE_NR)) {
420                 /*
421                  * No more room for a new log cache entry,
422                  * so write the dirty log map directly.
423                  */
424                 rte_smp_wmb();
425                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
426
427                 return;
428         }
429
430         vq->log_cache[i].offset = offset;
431         vq->log_cache[i].val = (1UL << bit_nr);
432         vq->log_cache_nb_elem++;
433 }
434
435 static __rte_always_inline void
436 vhost_log_cache_write(struct virtio_net *dev, struct vhost_virtqueue *vq,
437                         uint64_t addr, uint64_t len)
438 {
439         uint64_t page;
440
441         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
442                    !dev->log_base || !len))
443                 return;
444
445         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
446                 return;
447
448         page = addr / VHOST_LOG_PAGE;
449         while (page * VHOST_LOG_PAGE < addr + len) {
450                 vhost_log_cache_page(dev, vq, page);
451                 page += 1;
452         }
453 }
454
455 static __rte_always_inline void
456 vhost_log_cache_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
457                         uint64_t offset, uint64_t len)
458 {
459         vhost_log_cache_write(dev, vq, vq->log_guest_addr + offset, len);
460 }
461
462 static __rte_always_inline void
463 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
464                      uint64_t offset, uint64_t len)
465 {
466         vhost_log_write(dev, vq->log_guest_addr + offset, len);
467 }
468
469 /* Macros for printing using RTE_LOG */
470 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
471 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
472
473 #ifdef RTE_LIBRTE_VHOST_DEBUG
474 #define VHOST_MAX_PRINT_BUFF 6072
475 #define VHOST_LOG_DEBUG(log_type, fmt, args...) \
476         RTE_LOG(DEBUG, log_type, fmt, ##args)
477 #define PRINT_PACKET(device, addr, size, header) do { \
478         char *pkt_addr = (char *)(addr); \
479         unsigned int index; \
480         char packet[VHOST_MAX_PRINT_BUFF]; \
481         \
482         if ((header)) \
483                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
484         else \
485                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
486         for (index = 0; index < (size); index++) { \
487                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
488                         "%02hhx ", pkt_addr[index]); \
489         } \
490         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
491         \
492         VHOST_LOG_DEBUG(VHOST_DATA, "%s", packet); \
493 } while (0)
494 #else
495 #define VHOST_LOG_DEBUG(log_type, fmt, args...) do {} while (0)
496 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
497 #endif
498
499 extern uint64_t VHOST_FEATURES;
500 #define MAX_VHOST_DEVICE        1024
501 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
502
503 /* Convert guest physical address to host physical address */
504 static __rte_always_inline rte_iova_t
505 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
506 {
507         uint32_t i;
508         struct guest_page *page;
509
510         for (i = 0; i < dev->nr_guest_pages; i++) {
511                 page = &dev->guest_pages[i];
512
513                 if (gpa >= page->guest_phys_addr &&
514                     gpa + size < page->guest_phys_addr + page->size) {
515                         return gpa - page->guest_phys_addr +
516                                page->host_phys_addr;
517                 }
518         }
519
520         return 0;
521 }
522
523 static __rte_always_inline struct virtio_net *
524 get_device(int vid)
525 {
526         struct virtio_net *dev = vhost_devices[vid];
527
528         if (unlikely(!dev)) {
529                 RTE_LOG(ERR, VHOST_CONFIG,
530                         "(%d) device not found.\n", vid);
531         }
532
533         return dev;
534 }
535
536 int vhost_new_device(void);
537 void cleanup_device(struct virtio_net *dev, int destroy);
538 void reset_device(struct virtio_net *dev);
539 void vhost_destroy_device(int);
540 void vhost_destroy_device_notify(struct virtio_net *dev);
541
542 void cleanup_vq(struct vhost_virtqueue *vq, int destroy);
543 void free_vq(struct vhost_virtqueue *vq);
544
545 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
546
547 void vhost_attach_vdpa_device(int vid, int did);
548 void vhost_detach_vdpa_device(int vid);
549
550 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
551 void vhost_enable_dequeue_zero_copy(int vid);
552 void vhost_set_builtin_virtio_net(int vid, bool enable);
553
554 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
555
556 /*
557  * Backend-specific cleanup.
558  *
559  * TODO: fix it; we have one backend now
560  */
561 void vhost_backend_cleanup(struct virtio_net *dev);
562
563 uint64_t __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
564                         uint64_t iova, uint64_t *len, uint8_t perm);
565 int vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq);
566 void vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq);
567
568 static __rte_always_inline uint64_t
569 vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
570                         uint64_t iova, uint64_t *len, uint8_t perm)
571 {
572         if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
573                 return rte_vhost_va_from_guest_pa(dev->mem, iova, len);
574
575         return __vhost_iova_to_vva(dev, vq, iova, len, perm);
576 }
577
578 #define vhost_used_event(vr) \
579         (*(volatile uint16_t*)&(vr)->avail->ring[(vr)->size])
580
581 /*
582  * The following is used with VIRTIO_RING_F_EVENT_IDX.
583  * Assuming a given event_idx value from the other size, if we have
584  * just incremented index from old to new_idx, should we trigger an
585  * event?
586  */
587 static __rte_always_inline int
588 vhost_need_event(uint16_t event_idx, uint16_t new_idx, uint16_t old)
589 {
590         return (uint16_t)(new_idx - event_idx - 1) < (uint16_t)(new_idx - old);
591 }
592
593 static __rte_always_inline void
594 vhost_vring_call(struct virtio_net *dev, struct vhost_virtqueue *vq)
595 {
596         /* Flush used->idx update before we read avail->flags. */
597         rte_smp_mb();
598
599         /* Don't kick guest if we don't reach index specified by guest. */
600         if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX)) {
601                 uint16_t old = vq->signalled_used;
602                 uint16_t new = vq->last_used_idx;
603
604                 VHOST_LOG_DEBUG(VHOST_DATA, "%s: used_event_idx=%d, old=%d, new=%d\n",
605                         __func__,
606                         vhost_used_event(vq),
607                         old, new);
608                 if (vhost_need_event(vhost_used_event(vq), new, old)
609                         && (vq->callfd >= 0)) {
610                         vq->signalled_used = vq->last_used_idx;
611                         eventfd_write(vq->callfd, (eventfd_t) 1);
612                 }
613         } else {
614                 /* Kick the guest if necessary. */
615                 if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
616                                 && (vq->callfd >= 0))
617                         eventfd_write(vq->callfd, (eventfd_t)1);
618         }
619 }
620
621 #endif /* _VHOST_NET_CDEV_H_ */