3b3265c4b63e98232f3b9658a24a4c13fce56826
[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 #include <rte_malloc.h>
22
23 #include "rte_vhost.h"
24 #include "rte_vdpa.h"
25
26 /* Used to indicate that the device is running on a data core */
27 #define VIRTIO_DEV_RUNNING 1
28 /* Used to indicate that the device is ready to operate */
29 #define VIRTIO_DEV_READY 2
30 /* Used to indicate that the built-in vhost net device backend is enabled */
31 #define VIRTIO_DEV_BUILTIN_VIRTIO_NET 4
32 /* Used to indicate that the device has its own data path and configured */
33 #define VIRTIO_DEV_VDPA_CONFIGURED 8
34
35 /* Backend value set by guest. */
36 #define VIRTIO_DEV_STOPPED -1
37
38 #define BUF_VECTOR_MAX 256
39
40 #define VHOST_LOG_CACHE_NR 32
41
42 /**
43  * Structure contains buffer address, length and descriptor index
44  * from vring to do scatter RX.
45  */
46 struct buf_vector {
47         uint64_t buf_iova;
48         uint64_t buf_addr;
49         uint32_t buf_len;
50         uint32_t desc_idx;
51 };
52
53 /*
54  * A structure to hold some fields needed in zero copy code path,
55  * mainly for associating an mbuf with the right desc_idx.
56  */
57 struct zcopy_mbuf {
58         struct rte_mbuf *mbuf;
59         uint32_t desc_idx;
60         uint16_t desc_count;
61         uint16_t in_use;
62
63         TAILQ_ENTRY(zcopy_mbuf) next;
64 };
65 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
66
67 /*
68  * Structure contains the info for each batched memory copy.
69  */
70 struct batch_copy_elem {
71         void *dst;
72         void *src;
73         uint32_t len;
74         uint64_t log_addr;
75 };
76
77 /*
78  * Structure that contains the info for batched dirty logging.
79  */
80 struct log_cache_entry {
81         uint32_t offset;
82         unsigned long val;
83 };
84
85 struct vring_used_elem_packed {
86         uint16_t id;
87         uint32_t len;
88         uint32_t count;
89 };
90
91 /**
92  * Structure contains variables relevant to RX/TX virtqueues.
93  */
94 struct vhost_virtqueue {
95         union {
96                 struct vring_desc       *desc;
97                 struct vring_packed_desc   *desc_packed;
98         };
99         union {
100                 struct vring_avail      *avail;
101                 struct vring_packed_desc_event *driver_event;
102         };
103         union {
104                 struct vring_used       *used;
105                 struct vring_packed_desc_event *device_event;
106         };
107         uint32_t                size;
108
109         uint16_t                last_avail_idx;
110         uint16_t                last_used_idx;
111         /* Last used index we notify to front end. */
112         uint16_t                signalled_used;
113         bool                    signalled_used_valid;
114 #define VIRTIO_INVALID_EVENTFD          (-1)
115 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
116
117         /* Backend value to determine if device should started/stopped */
118         int                     backend;
119         int                     enabled;
120         int                     access_ok;
121         rte_spinlock_t          access_lock;
122
123         /* Used to notify the guest (trigger interrupt) */
124         int                     callfd;
125         /* Currently unused as polling mode is enabled */
126         int                     kickfd;
127
128         /* Physical address of used ring, for logging */
129         uint64_t                log_guest_addr;
130
131         uint16_t                nr_zmbuf;
132         uint16_t                zmbuf_size;
133         uint16_t                last_zmbuf_idx;
134         struct zcopy_mbuf       *zmbufs;
135         struct zcopy_mbuf_list  zmbuf_list;
136
137         union {
138                 struct vring_used_elem  *shadow_used_split;
139                 struct vring_used_elem_packed *shadow_used_packed;
140         };
141         uint16_t                shadow_used_idx;
142         struct vhost_vring_addr ring_addrs;
143
144         struct batch_copy_elem  *batch_copy_elems;
145         uint16_t                batch_copy_nb_elems;
146         bool                    used_wrap_counter;
147         bool                    avail_wrap_counter;
148
149         struct log_cache_entry log_cache[VHOST_LOG_CACHE_NR];
150         uint16_t log_cache_nb_elem;
151
152         rte_rwlock_t    iotlb_lock;
153         rte_rwlock_t    iotlb_pending_lock;
154         struct rte_mempool *iotlb_pool;
155         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_list;
156         int                             iotlb_cache_nr;
157         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_pending_list;
158 } __rte_cache_aligned;
159
160 /* Old kernels have no such macros defined */
161 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
162  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
163 #endif
164
165 #ifndef VIRTIO_NET_F_MQ
166  #define VIRTIO_NET_F_MQ                22
167 #endif
168
169 #define VHOST_MAX_VRING                 0x100
170 #define VHOST_MAX_QUEUE_PAIRS           0x80
171
172 #ifndef VIRTIO_NET_F_MTU
173  #define VIRTIO_NET_F_MTU 3
174 #endif
175
176 #ifndef VIRTIO_F_ANY_LAYOUT
177  #define VIRTIO_F_ANY_LAYOUT            27
178 #endif
179
180 /* Declare IOMMU related bits for older kernels */
181 #ifndef VIRTIO_F_IOMMU_PLATFORM
182
183 #define VIRTIO_F_IOMMU_PLATFORM 33
184
185 struct vhost_iotlb_msg {
186         __u64 iova;
187         __u64 size;
188         __u64 uaddr;
189 #define VHOST_ACCESS_RO      0x1
190 #define VHOST_ACCESS_WO      0x2
191 #define VHOST_ACCESS_RW      0x3
192         __u8 perm;
193 #define VHOST_IOTLB_MISS           1
194 #define VHOST_IOTLB_UPDATE         2
195 #define VHOST_IOTLB_INVALIDATE     3
196 #define VHOST_IOTLB_ACCESS_FAIL    4
197         __u8 type;
198 };
199
200 #define VHOST_IOTLB_MSG 0x1
201
202 struct vhost_msg {
203         int type;
204         union {
205                 struct vhost_iotlb_msg iotlb;
206                 __u8 padding[64];
207         };
208 };
209 #endif
210
211 /*
212  * Define virtio 1.0 for older kernels
213  */
214 #ifndef VIRTIO_F_VERSION_1
215  #define VIRTIO_F_VERSION_1 32
216 #endif
217
218 /* Declare packed ring related bits for older kernels */
219 #ifndef VIRTIO_F_RING_PACKED
220
221 #define VIRTIO_F_RING_PACKED 34
222
223 struct vring_packed_desc {
224         uint64_t addr;
225         uint32_t len;
226         uint16_t id;
227         uint16_t flags;
228 };
229
230 struct vring_packed_desc_event {
231         uint16_t off_wrap;
232         uint16_t flags;
233 };
234 #endif
235
236 /*
237  * Declare below packed ring defines unconditionally
238  * as Kernel header might use different names.
239  */
240 #define VRING_DESC_F_AVAIL      (1ULL << 7)
241 #define VRING_DESC_F_USED       (1ULL << 15)
242
243 #define VRING_EVENT_F_ENABLE 0x0
244 #define VRING_EVENT_F_DISABLE 0x1
245 #define VRING_EVENT_F_DESC 0x2
246
247 /*
248  * Available and used descs are in same order
249  */
250 #ifndef VIRTIO_F_IN_ORDER
251 #define VIRTIO_F_IN_ORDER      35
252 #endif
253
254 /* Features supported by this builtin vhost-user net driver. */
255 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
256                                 (1ULL << VIRTIO_F_ANY_LAYOUT) | \
257                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
258                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
259                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
260                                 (1ULL << VIRTIO_NET_F_MQ)      | \
261                                 (1ULL << VIRTIO_F_VERSION_1)   | \
262                                 (1ULL << VHOST_F_LOG_ALL)      | \
263                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
264                                 (1ULL << VIRTIO_NET_F_GSO) | \
265                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
266                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
267                                 (1ULL << VIRTIO_NET_F_HOST_UFO) | \
268                                 (1ULL << VIRTIO_NET_F_HOST_ECN) | \
269                                 (1ULL << VIRTIO_NET_F_CSUM)    | \
270                                 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
271                                 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
272                                 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
273                                 (1ULL << VIRTIO_NET_F_GUEST_UFO) | \
274                                 (1ULL << VIRTIO_NET_F_GUEST_ECN) | \
275                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
276                                 (1ULL << VIRTIO_RING_F_EVENT_IDX) | \
277                                 (1ULL << VIRTIO_NET_F_MTU)  | \
278                                 (1ULL << VIRTIO_F_IN_ORDER) | \
279                                 (1ULL << VIRTIO_F_IOMMU_PLATFORM) | \
280                                 (1ULL << VIRTIO_F_RING_PACKED))
281
282
283 struct guest_page {
284         uint64_t guest_phys_addr;
285         uint64_t host_phys_addr;
286         uint64_t size;
287 };
288
289 /* The possible results of a message handling function */
290 enum vh_result {
291         /* Message handling failed */
292         VH_RESULT_ERR   = -1,
293         /* Message handling successful */
294         VH_RESULT_OK    =  0,
295         /* Message handling successful and reply prepared */
296         VH_RESULT_REPLY =  1,
297 };
298
299 /**
300  * function prototype for the vhost backend to handler specific vhost user
301  * messages prior to the master message handling
302  *
303  * @param vid
304  *  vhost device id
305  * @param msg
306  *  Message pointer.
307  * @param skip_master
308  *  If the handler requires skipping the master message handling, this variable
309  *  shall be written 1, otherwise 0.
310  * @return
311  *  VH_RESULT_OK on success, VH_RESULT_REPLY on success with reply,
312  *  VH_RESULT_ERR on failure
313  */
314 typedef enum vh_result (*vhost_msg_pre_handle)(int vid, void *msg,
315                 uint32_t *skip_master);
316
317 /**
318  * function prototype for the vhost backend to handler specific vhost user
319  * messages after the master message handling is done
320  *
321  * @param vid
322  *  vhost device id
323  * @param msg
324  *  Message pointer.
325  * @return
326  *  VH_RESULT_OK on success, VH_RESULT_REPLY on success with reply,
327  *  VH_RESULT_ERR on failure
328  */
329 typedef enum vh_result (*vhost_msg_post_handle)(int vid, void *msg);
330
331 /**
332  * pre and post vhost user message handlers
333  */
334 struct vhost_user_extern_ops {
335         vhost_msg_pre_handle pre_msg_handle;
336         vhost_msg_post_handle post_msg_handle;
337 };
338
339 /**
340  * Device structure contains all configuration information relating
341  * to the device.
342  */
343 struct virtio_net {
344         /* Frontend (QEMU) memory and memory region information */
345         struct rte_vhost_memory *mem;
346         uint64_t                features;
347         uint64_t                protocol_features;
348         int                     vid;
349         uint32_t                flags;
350         uint16_t                vhost_hlen;
351         /* to tell if we need broadcast rarp packet */
352         rte_atomic16_t          broadcast_rarp;
353         uint32_t                nr_vring;
354         int                     dequeue_zero_copy;
355         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
356 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
357         char                    ifname[IF_NAME_SZ];
358         uint64_t                log_size;
359         uint64_t                log_base;
360         uint64_t                log_addr;
361         struct ether_addr       mac;
362         uint16_t                mtu;
363
364         struct vhost_device_ops const *notify_ops;
365
366         uint32_t                nr_guest_pages;
367         uint32_t                max_guest_pages;
368         struct guest_page       *guest_pages;
369
370         int                     slave_req_fd;
371         rte_spinlock_t          slave_req_lock;
372
373         int                     postcopy_ufd;
374         int                     postcopy_listening;
375
376         /*
377          * Device id to identify a specific backend device.
378          * It's set to -1 for the default software implementation.
379          */
380         int                     vdpa_dev_id;
381
382         /* private data for virtio device */
383         void                    *extern_data;
384         /* pre and post vhost user message handlers for the device */
385         struct vhost_user_extern_ops extern_ops;
386 } __rte_cache_aligned;
387
388 static __rte_always_inline bool
389 vq_is_packed(struct virtio_net *dev)
390 {
391         return dev->features & (1ull << VIRTIO_F_RING_PACKED);
392 }
393
394 static inline bool
395 desc_is_avail(struct vring_packed_desc *desc, bool wrap_counter)
396 {
397         uint16_t flags = *((volatile uint16_t *) &desc->flags);
398
399         return wrap_counter == !!(flags & VRING_DESC_F_AVAIL) &&
400                 wrap_counter != !!(flags & VRING_DESC_F_USED);
401 }
402
403 #define VHOST_LOG_PAGE  4096
404
405 /*
406  * Atomically set a bit in memory.
407  */
408 static __rte_always_inline void
409 vhost_set_bit(unsigned int nr, volatile uint8_t *addr)
410 {
411 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
412         /*
413          * __sync_ built-ins are deprecated, but __atomic_ ones
414          * are sub-optimized in older GCC versions.
415          */
416         __sync_fetch_and_or_1(addr, (1U << nr));
417 #else
418         __atomic_fetch_or(addr, (1U << nr), __ATOMIC_RELAXED);
419 #endif
420 }
421
422 static __rte_always_inline void
423 vhost_log_page(uint8_t *log_base, uint64_t page)
424 {
425         vhost_set_bit(page % 8, &log_base[page / 8]);
426 }
427
428 static __rte_always_inline void
429 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
430 {
431         uint64_t page;
432
433         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
434                    !dev->log_base || !len))
435                 return;
436
437         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
438                 return;
439
440         /* To make sure guest memory updates are committed before logging */
441         rte_smp_wmb();
442
443         page = addr / VHOST_LOG_PAGE;
444         while (page * VHOST_LOG_PAGE < addr + len) {
445                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
446                 page += 1;
447         }
448 }
449
450 static __rte_always_inline void
451 vhost_log_cache_sync(struct virtio_net *dev, struct vhost_virtqueue *vq)
452 {
453         unsigned long *log_base;
454         int i;
455
456         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
457                    !dev->log_base))
458                 return;
459
460         log_base = (unsigned long *)(uintptr_t)dev->log_base;
461
462         /*
463          * It is expected a write memory barrier has been issued
464          * before this function is called.
465          */
466
467         for (i = 0; i < vq->log_cache_nb_elem; i++) {
468                 struct log_cache_entry *elem = vq->log_cache + i;
469
470 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
471                 /*
472                  * '__sync' builtins are deprecated, but '__atomic' ones
473                  * are sub-optimized in older GCC versions.
474                  */
475                 __sync_fetch_and_or(log_base + elem->offset, elem->val);
476 #else
477                 __atomic_fetch_or(log_base + elem->offset, elem->val,
478                                 __ATOMIC_RELAXED);
479 #endif
480         }
481
482         rte_smp_wmb();
483
484         vq->log_cache_nb_elem = 0;
485 }
486
487 static __rte_always_inline void
488 vhost_log_cache_page(struct virtio_net *dev, struct vhost_virtqueue *vq,
489                         uint64_t page)
490 {
491         uint32_t bit_nr = page % (sizeof(unsigned long) << 3);
492         uint32_t offset = page / (sizeof(unsigned long) << 3);
493         int i;
494
495         for (i = 0; i < vq->log_cache_nb_elem; i++) {
496                 struct log_cache_entry *elem = vq->log_cache + i;
497
498                 if (elem->offset == offset) {
499                         elem->val |= (1UL << bit_nr);
500                         return;
501                 }
502         }
503
504         if (unlikely(i >= VHOST_LOG_CACHE_NR)) {
505                 /*
506                  * No more room for a new log cache entry,
507                  * so write the dirty log map directly.
508                  */
509                 rte_smp_wmb();
510                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
511
512                 return;
513         }
514
515         vq->log_cache[i].offset = offset;
516         vq->log_cache[i].val = (1UL << bit_nr);
517         vq->log_cache_nb_elem++;
518 }
519
520 static __rte_always_inline void
521 vhost_log_cache_write(struct virtio_net *dev, struct vhost_virtqueue *vq,
522                         uint64_t addr, uint64_t len)
523 {
524         uint64_t page;
525
526         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
527                    !dev->log_base || !len))
528                 return;
529
530         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
531                 return;
532
533         page = addr / VHOST_LOG_PAGE;
534         while (page * VHOST_LOG_PAGE < addr + len) {
535                 vhost_log_cache_page(dev, vq, page);
536                 page += 1;
537         }
538 }
539
540 static __rte_always_inline void
541 vhost_log_cache_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
542                         uint64_t offset, uint64_t len)
543 {
544         vhost_log_cache_write(dev, vq, vq->log_guest_addr + offset, len);
545 }
546
547 static __rte_always_inline void
548 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
549                      uint64_t offset, uint64_t len)
550 {
551         vhost_log_write(dev, vq->log_guest_addr + offset, len);
552 }
553
554 /* Macros for printing using RTE_LOG */
555 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
556 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
557
558 #ifdef RTE_LIBRTE_VHOST_DEBUG
559 #define VHOST_MAX_PRINT_BUFF 6072
560 #define VHOST_LOG_DEBUG(log_type, fmt, args...) \
561         RTE_LOG(DEBUG, log_type, fmt, ##args)
562 #define PRINT_PACKET(device, addr, size, header) do { \
563         char *pkt_addr = (char *)(addr); \
564         unsigned int index; \
565         char packet[VHOST_MAX_PRINT_BUFF]; \
566         \
567         if ((header)) \
568                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
569         else \
570                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
571         for (index = 0; index < (size); index++) { \
572                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
573                         "%02hhx ", pkt_addr[index]); \
574         } \
575         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
576         \
577         VHOST_LOG_DEBUG(VHOST_DATA, "%s", packet); \
578 } while (0)
579 #else
580 #define VHOST_LOG_DEBUG(log_type, fmt, args...) do {} while (0)
581 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
582 #endif
583
584 extern uint64_t VHOST_FEATURES;
585 #define MAX_VHOST_DEVICE        1024
586 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
587
588 /* Convert guest physical address to host physical address */
589 static __rte_always_inline rte_iova_t
590 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
591 {
592         uint32_t i;
593         struct guest_page *page;
594
595         for (i = 0; i < dev->nr_guest_pages; i++) {
596                 page = &dev->guest_pages[i];
597
598                 if (gpa >= page->guest_phys_addr &&
599                     gpa + size < page->guest_phys_addr + page->size) {
600                         return gpa - page->guest_phys_addr +
601                                page->host_phys_addr;
602                 }
603         }
604
605         return 0;
606 }
607
608 static __rte_always_inline struct virtio_net *
609 get_device(int vid)
610 {
611         struct virtio_net *dev = vhost_devices[vid];
612
613         if (unlikely(!dev)) {
614                 RTE_LOG(ERR, VHOST_CONFIG,
615                         "(%d) device not found.\n", vid);
616         }
617
618         return dev;
619 }
620
621 int vhost_new_device(void);
622 void cleanup_device(struct virtio_net *dev, int destroy);
623 void reset_device(struct virtio_net *dev);
624 void vhost_destroy_device(int);
625 void vhost_destroy_device_notify(struct virtio_net *dev);
626
627 void cleanup_vq(struct vhost_virtqueue *vq, int destroy);
628 void free_vq(struct virtio_net *dev, struct vhost_virtqueue *vq);
629
630 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
631
632 void vhost_attach_vdpa_device(int vid, int did);
633
634 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
635 void vhost_enable_dequeue_zero_copy(int vid);
636 void vhost_set_builtin_virtio_net(int vid, bool enable);
637
638 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
639
640 /*
641  * Backend-specific cleanup.
642  *
643  * TODO: fix it; we have one backend now
644  */
645 void vhost_backend_cleanup(struct virtio_net *dev);
646
647 uint64_t __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
648                         uint64_t iova, uint64_t *len, uint8_t perm);
649 int vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq);
650 void vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq);
651
652 static __rte_always_inline uint64_t
653 vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
654                         uint64_t iova, uint64_t *len, uint8_t perm)
655 {
656         if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
657                 return rte_vhost_va_from_guest_pa(dev->mem, iova, len);
658
659         return __vhost_iova_to_vva(dev, vq, iova, len, perm);
660 }
661
662 #define vhost_avail_event(vr) \
663         (*(volatile uint16_t*)&(vr)->used->ring[(vr)->size])
664 #define vhost_used_event(vr) \
665         (*(volatile uint16_t*)&(vr)->avail->ring[(vr)->size])
666
667 /*
668  * The following is used with VIRTIO_RING_F_EVENT_IDX.
669  * Assuming a given event_idx value from the other size, if we have
670  * just incremented index from old to new_idx, should we trigger an
671  * event?
672  */
673 static __rte_always_inline int
674 vhost_need_event(uint16_t event_idx, uint16_t new_idx, uint16_t old)
675 {
676         return (uint16_t)(new_idx - event_idx - 1) < (uint16_t)(new_idx - old);
677 }
678
679 static __rte_always_inline void
680 vhost_vring_call_split(struct virtio_net *dev, struct vhost_virtqueue *vq)
681 {
682         /* Flush used->idx update before we read avail->flags. */
683         rte_smp_mb();
684
685         /* Don't kick guest if we don't reach index specified by guest. */
686         if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX)) {
687                 uint16_t old = vq->signalled_used;
688                 uint16_t new = vq->last_used_idx;
689
690                 VHOST_LOG_DEBUG(VHOST_DATA, "%s: used_event_idx=%d, old=%d, new=%d\n",
691                         __func__,
692                         vhost_used_event(vq),
693                         old, new);
694                 if (vhost_need_event(vhost_used_event(vq), new, old)
695                         && (vq->callfd >= 0)) {
696                         vq->signalled_used = vq->last_used_idx;
697                         eventfd_write(vq->callfd, (eventfd_t) 1);
698                 }
699         } else {
700                 /* Kick the guest if necessary. */
701                 if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
702                                 && (vq->callfd >= 0))
703                         eventfd_write(vq->callfd, (eventfd_t)1);
704         }
705 }
706
707 static __rte_always_inline void
708 vhost_vring_call_packed(struct virtio_net *dev, struct vhost_virtqueue *vq)
709 {
710         uint16_t old, new, off, off_wrap;
711         bool signalled_used_valid, kick = false;
712
713         /* Flush used desc update. */
714         rte_smp_mb();
715
716         if (!(dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX))) {
717                 if (vq->driver_event->flags !=
718                                 VRING_EVENT_F_DISABLE)
719                         kick = true;
720                 goto kick;
721         }
722
723         old = vq->signalled_used;
724         new = vq->last_used_idx;
725         vq->signalled_used = new;
726         signalled_used_valid = vq->signalled_used_valid;
727         vq->signalled_used_valid = true;
728
729         if (vq->driver_event->flags != VRING_EVENT_F_DESC) {
730                 if (vq->driver_event->flags != VRING_EVENT_F_DISABLE)
731                         kick = true;
732                 goto kick;
733         }
734
735         if (unlikely(!signalled_used_valid)) {
736                 kick = true;
737                 goto kick;
738         }
739
740         rte_smp_rmb();
741
742         off_wrap = vq->driver_event->off_wrap;
743         off = off_wrap & ~(1 << 15);
744
745         if (new <= old)
746                 old -= vq->size;
747
748         if (vq->used_wrap_counter != off_wrap >> 15)
749                 off -= vq->size;
750
751         if (vhost_need_event(off, new, old))
752                 kick = true;
753 kick:
754         if (kick)
755                 eventfd_write(vq->callfd, (eventfd_t)1);
756 }
757
758 static __rte_always_inline void *
759 alloc_copy_ind_table(struct virtio_net *dev, struct vhost_virtqueue *vq,
760                 uint64_t desc_addr, uint64_t desc_len)
761 {
762         void *idesc;
763         uint64_t src, dst;
764         uint64_t len, remain = desc_len;
765
766         idesc = rte_malloc(__func__, desc_len, 0);
767         if (unlikely(!idesc))
768                 return 0;
769
770         dst = (uint64_t)(uintptr_t)idesc;
771
772         while (remain) {
773                 len = remain;
774                 src = vhost_iova_to_vva(dev, vq, desc_addr, &len,
775                                 VHOST_ACCESS_RO);
776                 if (unlikely(!src || !len)) {
777                         rte_free(idesc);
778                         return 0;
779                 }
780
781                 rte_memcpy((void *)(uintptr_t)dst, (void *)(uintptr_t)src, len);
782
783                 remain -= len;
784                 dst += len;
785                 desc_addr += len;
786         }
787
788         return idesc;
789 }
790
791 static __rte_always_inline void
792 free_ind_table(void *idesc)
793 {
794         rte_free(idesc);
795 }
796
797 #endif /* _VHOST_NET_CDEV_H_ */