vhost: shadow used ring update
[dpdk.git] / lib / librte_vhost / virtio_net.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2016 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 #include <stdint.h>
35 #include <stdbool.h>
36 #include <linux/virtio_net.h>
37
38 #include <rte_mbuf.h>
39 #include <rte_memcpy.h>
40 #include <rte_ether.h>
41 #include <rte_ip.h>
42 #include <rte_virtio_net.h>
43 #include <rte_tcp.h>
44 #include <rte_udp.h>
45 #include <rte_sctp.h>
46 #include <rte_arp.h>
47
48 #include "vhost.h"
49
50 #define MAX_PKT_BURST 32
51 #define VHOST_LOG_PAGE  4096
52
53 static inline void __attribute__((always_inline))
54 vhost_log_page(uint8_t *log_base, uint64_t page)
55 {
56         log_base[page / 8] |= 1 << (page % 8);
57 }
58
59 static inline void __attribute__((always_inline))
60 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
61 {
62         uint64_t page;
63
64         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
65                    !dev->log_base || !len))
66                 return;
67
68         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
69                 return;
70
71         /* To make sure guest memory updates are committed before logging */
72         rte_smp_wmb();
73
74         page = addr / VHOST_LOG_PAGE;
75         while (page * VHOST_LOG_PAGE < addr + len) {
76                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
77                 page += 1;
78         }
79 }
80
81 static inline void __attribute__((always_inline))
82 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
83                      uint64_t offset, uint64_t len)
84 {
85         vhost_log_write(dev, vq->log_guest_addr + offset, len);
86 }
87
88 static bool
89 is_valid_virt_queue_idx(uint32_t idx, int is_tx, uint32_t qp_nb)
90 {
91         return (is_tx ^ (idx & 1)) == 0 && idx < qp_nb * VIRTIO_QNUM;
92 }
93
94 static inline void __attribute__((always_inline))
95 do_flush_shadow_used_ring(struct virtio_net *dev, struct vhost_virtqueue *vq,
96                           uint16_t to, uint16_t from, uint16_t size)
97 {
98         rte_memcpy(&vq->used->ring[to],
99                         &vq->shadow_used_ring[from],
100                         size * sizeof(struct vring_used_elem));
101         vhost_log_used_vring(dev, vq,
102                         offsetof(struct vring_used, ring[to]),
103                         size * sizeof(struct vring_used_elem));
104 }
105
106 static inline void __attribute__((always_inline))
107 flush_shadow_used_ring(struct virtio_net *dev, struct vhost_virtqueue *vq)
108 {
109         uint16_t used_idx = vq->last_used_idx & (vq->size - 1);
110
111         if (used_idx + vq->shadow_used_idx <= vq->size) {
112                 do_flush_shadow_used_ring(dev, vq, used_idx, 0,
113                                           vq->shadow_used_idx);
114         } else {
115                 uint16_t size;
116
117                 /* update used ring interval [used_idx, vq->size] */
118                 size = vq->size - used_idx;
119                 do_flush_shadow_used_ring(dev, vq, used_idx, 0, size);
120
121                 /* update the left half used ring interval [0, left_size] */
122                 do_flush_shadow_used_ring(dev, vq, 0, size,
123                                           vq->shadow_used_idx - size);
124         }
125         vq->last_used_idx += vq->shadow_used_idx;
126
127         rte_smp_wmb();
128
129         *(volatile uint16_t *)&vq->used->idx += vq->shadow_used_idx;
130         vhost_log_used_vring(dev, vq, offsetof(struct vring_used, idx),
131                 sizeof(vq->used->idx));
132 }
133
134 static inline void __attribute__((always_inline))
135 update_shadow_used_ring(struct vhost_virtqueue *vq,
136                          uint16_t desc_idx, uint16_t len)
137 {
138         uint16_t i = vq->shadow_used_idx++;
139
140         vq->shadow_used_ring[i].id  = desc_idx;
141         vq->shadow_used_ring[i].len = len;
142 }
143
144 static void
145 virtio_enqueue_offload(struct rte_mbuf *m_buf, struct virtio_net_hdr *net_hdr)
146 {
147         if (m_buf->ol_flags & PKT_TX_L4_MASK) {
148                 net_hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
149                 net_hdr->csum_start = m_buf->l2_len + m_buf->l3_len;
150
151                 switch (m_buf->ol_flags & PKT_TX_L4_MASK) {
152                 case PKT_TX_TCP_CKSUM:
153                         net_hdr->csum_offset = (offsetof(struct tcp_hdr,
154                                                 cksum));
155                         break;
156                 case PKT_TX_UDP_CKSUM:
157                         net_hdr->csum_offset = (offsetof(struct udp_hdr,
158                                                 dgram_cksum));
159                         break;
160                 case PKT_TX_SCTP_CKSUM:
161                         net_hdr->csum_offset = (offsetof(struct sctp_hdr,
162                                                 cksum));
163                         break;
164                 }
165         }
166
167         if (m_buf->ol_flags & PKT_TX_TCP_SEG) {
168                 if (m_buf->ol_flags & PKT_TX_IPV4)
169                         net_hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
170                 else
171                         net_hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
172                 net_hdr->gso_size = m_buf->tso_segsz;
173                 net_hdr->hdr_len = m_buf->l2_len + m_buf->l3_len
174                                         + m_buf->l4_len;
175         }
176 }
177
178 static inline void
179 copy_virtio_net_hdr(struct virtio_net *dev, uint64_t desc_addr,
180                     struct virtio_net_hdr_mrg_rxbuf hdr)
181 {
182         if (dev->vhost_hlen == sizeof(struct virtio_net_hdr_mrg_rxbuf))
183                 *(struct virtio_net_hdr_mrg_rxbuf *)(uintptr_t)desc_addr = hdr;
184         else
185                 *(struct virtio_net_hdr *)(uintptr_t)desc_addr = hdr.hdr;
186 }
187
188 static inline int __attribute__((always_inline))
189 copy_mbuf_to_desc(struct virtio_net *dev, struct vhost_virtqueue *vq,
190                   struct rte_mbuf *m, uint16_t desc_idx)
191 {
192         uint32_t desc_avail, desc_offset;
193         uint32_t mbuf_avail, mbuf_offset;
194         uint32_t cpy_len;
195         struct vring_desc *desc;
196         uint64_t desc_addr;
197         struct virtio_net_hdr_mrg_rxbuf virtio_hdr = {{0, 0, 0, 0, 0, 0}, 0};
198
199         desc = &vq->desc[desc_idx];
200         desc_addr = gpa_to_vva(dev, desc->addr);
201         /*
202          * Checking of 'desc_addr' placed outside of 'unlikely' macro to avoid
203          * performance issue with some versions of gcc (4.8.4 and 5.3.0) which
204          * otherwise stores offset on the stack instead of in a register.
205          */
206         if (unlikely(desc->len < dev->vhost_hlen) || !desc_addr)
207                 return -1;
208
209         rte_prefetch0((void *)(uintptr_t)desc_addr);
210
211         virtio_enqueue_offload(m, &virtio_hdr.hdr);
212         copy_virtio_net_hdr(dev, desc_addr, virtio_hdr);
213         vhost_log_write(dev, desc->addr, dev->vhost_hlen);
214         PRINT_PACKET(dev, (uintptr_t)desc_addr, dev->vhost_hlen, 0);
215
216         desc_offset = dev->vhost_hlen;
217         desc_avail  = desc->len - dev->vhost_hlen;
218
219         mbuf_avail  = rte_pktmbuf_data_len(m);
220         mbuf_offset = 0;
221         while (mbuf_avail != 0 || m->next != NULL) {
222                 /* done with current mbuf, fetch next */
223                 if (mbuf_avail == 0) {
224                         m = m->next;
225
226                         mbuf_offset = 0;
227                         mbuf_avail  = rte_pktmbuf_data_len(m);
228                 }
229
230                 /* done with current desc buf, fetch next */
231                 if (desc_avail == 0) {
232                         if ((desc->flags & VRING_DESC_F_NEXT) == 0) {
233                                 /* Room in vring buffer is not enough */
234                                 return -1;
235                         }
236                         if (unlikely(desc->next >= vq->size))
237                                 return -1;
238
239                         desc = &vq->desc[desc->next];
240                         desc_addr = gpa_to_vva(dev, desc->addr);
241                         if (unlikely(!desc_addr))
242                                 return -1;
243
244                         desc_offset = 0;
245                         desc_avail  = desc->len;
246                 }
247
248                 cpy_len = RTE_MIN(desc_avail, mbuf_avail);
249                 rte_memcpy((void *)((uintptr_t)(desc_addr + desc_offset)),
250                         rte_pktmbuf_mtod_offset(m, void *, mbuf_offset),
251                         cpy_len);
252                 vhost_log_write(dev, desc->addr + desc_offset, cpy_len);
253                 PRINT_PACKET(dev, (uintptr_t)(desc_addr + desc_offset),
254                              cpy_len, 0);
255
256                 mbuf_avail  -= cpy_len;
257                 mbuf_offset += cpy_len;
258                 desc_avail  -= cpy_len;
259                 desc_offset += cpy_len;
260         }
261
262         return 0;
263 }
264
265 /**
266  * This function adds buffers to the virtio devices RX virtqueue. Buffers can
267  * be received from the physical port or from another virtio device. A packet
268  * count is returned to indicate the number of packets that are succesfully
269  * added to the RX queue. This function works when the mbuf is scattered, but
270  * it doesn't support the mergeable feature.
271  */
272 static inline uint32_t __attribute__((always_inline))
273 virtio_dev_rx(struct virtio_net *dev, uint16_t queue_id,
274               struct rte_mbuf **pkts, uint32_t count)
275 {
276         struct vhost_virtqueue *vq;
277         uint16_t avail_idx, free_entries, start_idx;
278         uint16_t desc_indexes[MAX_PKT_BURST];
279         uint16_t used_idx;
280         uint32_t i;
281
282         LOG_DEBUG(VHOST_DATA, "(%d) %s\n", dev->vid, __func__);
283         if (unlikely(!is_valid_virt_queue_idx(queue_id, 0, dev->virt_qp_nb))) {
284                 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
285                         dev->vid, __func__, queue_id);
286                 return 0;
287         }
288
289         vq = dev->virtqueue[queue_id];
290         if (unlikely(vq->enabled == 0))
291                 return 0;
292
293         avail_idx = *((volatile uint16_t *)&vq->avail->idx);
294         start_idx = vq->last_used_idx;
295         free_entries = avail_idx - start_idx;
296         count = RTE_MIN(count, free_entries);
297         count = RTE_MIN(count, (uint32_t)MAX_PKT_BURST);
298         if (count == 0)
299                 return 0;
300
301         LOG_DEBUG(VHOST_DATA, "(%d) start_idx %d | end_idx %d\n",
302                 dev->vid, start_idx, start_idx + count);
303
304         /* Retrieve all of the desc indexes first to avoid caching issues. */
305         rte_prefetch0(&vq->avail->ring[start_idx & (vq->size - 1)]);
306         for (i = 0; i < count; i++) {
307                 used_idx = (start_idx + i) & (vq->size - 1);
308                 desc_indexes[i] = vq->avail->ring[used_idx];
309                 vq->used->ring[used_idx].id = desc_indexes[i];
310                 vq->used->ring[used_idx].len = pkts[i]->pkt_len +
311                                                dev->vhost_hlen;
312                 vhost_log_used_vring(dev, vq,
313                         offsetof(struct vring_used, ring[used_idx]),
314                         sizeof(vq->used->ring[used_idx]));
315         }
316
317         rte_prefetch0(&vq->desc[desc_indexes[0]]);
318         for (i = 0; i < count; i++) {
319                 uint16_t desc_idx = desc_indexes[i];
320                 int err;
321
322                 err = copy_mbuf_to_desc(dev, vq, pkts[i], desc_idx);
323                 if (unlikely(err)) {
324                         used_idx = (start_idx + i) & (vq->size - 1);
325                         vq->used->ring[used_idx].len = dev->vhost_hlen;
326                         vhost_log_used_vring(dev, vq,
327                                 offsetof(struct vring_used, ring[used_idx]),
328                                 sizeof(vq->used->ring[used_idx]));
329                 }
330
331                 if (i + 1 < count)
332                         rte_prefetch0(&vq->desc[desc_indexes[i+1]]);
333         }
334
335         rte_smp_wmb();
336
337         *(volatile uint16_t *)&vq->used->idx += count;
338         vq->last_used_idx += count;
339         vhost_log_used_vring(dev, vq,
340                 offsetof(struct vring_used, idx),
341                 sizeof(vq->used->idx));
342
343         /* flush used->idx update before we read avail->flags. */
344         rte_mb();
345
346         /* Kick the guest if necessary. */
347         if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
348                         && (vq->callfd >= 0))
349                 eventfd_write(vq->callfd, (eventfd_t)1);
350         return count;
351 }
352
353 static inline int __attribute__((always_inline))
354 fill_vec_buf(struct vhost_virtqueue *vq, uint32_t avail_idx,
355              uint32_t *vec_idx, struct buf_vector *buf_vec,
356              uint16_t *desc_chain_head, uint16_t *desc_chain_len)
357 {
358         uint16_t idx = vq->avail->ring[avail_idx & (vq->size - 1)];
359         uint32_t vec_id = *vec_idx;
360         uint32_t len    = 0;
361
362         *desc_chain_head = idx;
363         while (1) {
364                 if (unlikely(vec_id >= BUF_VECTOR_MAX || idx >= vq->size))
365                         return -1;
366
367                 len += vq->desc[idx].len;
368                 buf_vec[vec_id].buf_addr = vq->desc[idx].addr;
369                 buf_vec[vec_id].buf_len  = vq->desc[idx].len;
370                 buf_vec[vec_id].desc_idx = idx;
371                 vec_id++;
372
373                 if ((vq->desc[idx].flags & VRING_DESC_F_NEXT) == 0)
374                         break;
375
376                 idx = vq->desc[idx].next;
377         }
378
379         *desc_chain_len = len;
380         *vec_idx = vec_id;
381
382         return 0;
383 }
384
385 /*
386  * Returns -1 on fail, 0 on success
387  */
388 static inline int
389 reserve_avail_buf_mergeable(struct vhost_virtqueue *vq, uint32_t size,
390                             struct buf_vector *buf_vec, uint16_t *num_buffers)
391 {
392         uint16_t cur_idx;
393         uint16_t avail_idx;
394         uint32_t vec_idx = 0;
395         uint16_t tries = 0;
396
397         uint16_t head_idx = 0;
398         uint16_t len = 0;
399
400         *num_buffers = 0;
401         cur_idx  = vq->last_avail_idx;
402
403         while (size > 0) {
404                 avail_idx = *((volatile uint16_t *)&vq->avail->idx);
405                 if (unlikely(cur_idx == avail_idx))
406                         return -1;
407
408                 if (unlikely(fill_vec_buf(vq, cur_idx, &vec_idx, buf_vec,
409                                           &head_idx, &len) < 0))
410                         return -1;
411                 len = RTE_MIN(len, size);
412                 update_shadow_used_ring(vq, head_idx, len);
413                 size -= len;
414
415                 cur_idx++;
416                 tries++;
417                 *num_buffers += 1;
418
419                 /*
420                  * if we tried all available ring items, and still
421                  * can't get enough buf, it means something abnormal
422                  * happened.
423                  */
424                 if (unlikely(tries >= vq->size))
425                         return -1;
426         }
427
428         return 0;
429 }
430
431 static inline int __attribute__((always_inline))
432 copy_mbuf_to_desc_mergeable(struct virtio_net *dev, struct rte_mbuf *m,
433                             struct buf_vector *buf_vec, uint16_t num_buffers)
434 {
435         struct virtio_net_hdr_mrg_rxbuf virtio_hdr = {{0, 0, 0, 0, 0, 0}, 0};
436         uint32_t vec_idx = 0;
437         uint64_t desc_addr;
438         uint32_t mbuf_offset, mbuf_avail;
439         uint32_t desc_offset, desc_avail;
440         uint32_t cpy_len;
441         uint64_t hdr_addr, hdr_phys_addr;
442         struct rte_mbuf *hdr_mbuf;
443
444         if (unlikely(m == NULL))
445                 return -1;
446
447         desc_addr = gpa_to_vva(dev, buf_vec[vec_idx].buf_addr);
448         if (buf_vec[vec_idx].buf_len < dev->vhost_hlen || !desc_addr)
449                 return -1;
450
451         hdr_mbuf = m;
452         hdr_addr = desc_addr;
453         hdr_phys_addr = buf_vec[vec_idx].buf_addr;
454         rte_prefetch0((void *)(uintptr_t)hdr_addr);
455
456         virtio_hdr.num_buffers = num_buffers;
457         LOG_DEBUG(VHOST_DATA, "(%d) RX: num merge buffers %d\n",
458                 dev->vid, num_buffers);
459
460         desc_avail  = buf_vec[vec_idx].buf_len - dev->vhost_hlen;
461         desc_offset = dev->vhost_hlen;
462
463         mbuf_avail  = rte_pktmbuf_data_len(m);
464         mbuf_offset = 0;
465         while (mbuf_avail != 0 || m->next != NULL) {
466                 /* done with current desc buf, get the next one */
467                 if (desc_avail == 0) {
468                         vec_idx++;
469                         desc_addr = gpa_to_vva(dev, buf_vec[vec_idx].buf_addr);
470                         if (unlikely(!desc_addr))
471                                 return -1;
472
473                         /* Prefetch buffer address. */
474                         rte_prefetch0((void *)(uintptr_t)desc_addr);
475                         desc_offset = 0;
476                         desc_avail  = buf_vec[vec_idx].buf_len;
477                 }
478
479                 /* done with current mbuf, get the next one */
480                 if (mbuf_avail == 0) {
481                         m = m->next;
482
483                         mbuf_offset = 0;
484                         mbuf_avail  = rte_pktmbuf_data_len(m);
485                 }
486
487                 if (hdr_addr) {
488                         virtio_enqueue_offload(hdr_mbuf, &virtio_hdr.hdr);
489                         copy_virtio_net_hdr(dev, hdr_addr, virtio_hdr);
490                         vhost_log_write(dev, hdr_phys_addr, dev->vhost_hlen);
491                         PRINT_PACKET(dev, (uintptr_t)hdr_addr,
492                                      dev->vhost_hlen, 0);
493
494                         hdr_addr = 0;
495                 }
496
497                 cpy_len = RTE_MIN(desc_avail, mbuf_avail);
498                 rte_memcpy((void *)((uintptr_t)(desc_addr + desc_offset)),
499                         rte_pktmbuf_mtod_offset(m, void *, mbuf_offset),
500                         cpy_len);
501                 vhost_log_write(dev, buf_vec[vec_idx].buf_addr + desc_offset,
502                         cpy_len);
503                 PRINT_PACKET(dev, (uintptr_t)(desc_addr + desc_offset),
504                         cpy_len, 0);
505
506                 mbuf_avail  -= cpy_len;
507                 mbuf_offset += cpy_len;
508                 desc_avail  -= cpy_len;
509                 desc_offset += cpy_len;
510         }
511
512         return 0;
513 }
514
515 static inline uint32_t __attribute__((always_inline))
516 virtio_dev_merge_rx(struct virtio_net *dev, uint16_t queue_id,
517         struct rte_mbuf **pkts, uint32_t count)
518 {
519         struct vhost_virtqueue *vq;
520         uint32_t pkt_idx = 0;
521         uint16_t num_buffers;
522         struct buf_vector buf_vec[BUF_VECTOR_MAX];
523
524         LOG_DEBUG(VHOST_DATA, "(%d) %s\n", dev->vid, __func__);
525         if (unlikely(!is_valid_virt_queue_idx(queue_id, 0, dev->virt_qp_nb))) {
526                 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
527                         dev->vid, __func__, queue_id);
528                 return 0;
529         }
530
531         vq = dev->virtqueue[queue_id];
532         if (unlikely(vq->enabled == 0))
533                 return 0;
534
535         count = RTE_MIN((uint32_t)MAX_PKT_BURST, count);
536         if (count == 0)
537                 return 0;
538
539         vq->shadow_used_idx = 0;
540         for (pkt_idx = 0; pkt_idx < count; pkt_idx++) {
541                 uint32_t pkt_len = pkts[pkt_idx]->pkt_len + dev->vhost_hlen;
542
543                 if (unlikely(reserve_avail_buf_mergeable(vq, pkt_len, buf_vec,
544                                                          &num_buffers) < 0)) {
545                         LOG_DEBUG(VHOST_DATA,
546                                 "(%d) failed to get enough desc from vring\n",
547                                 dev->vid);
548                         vq->shadow_used_idx -= num_buffers;
549                         break;
550                 }
551
552                 LOG_DEBUG(VHOST_DATA, "(%d) current index %d | end index %d\n",
553                         dev->vid, vq->last_avail_idx,
554                         vq->last_avail_idx + num_buffers);
555
556                 if (copy_mbuf_to_desc_mergeable(dev, pkts[pkt_idx],
557                                                 buf_vec, num_buffers) < 0) {
558                         vq->shadow_used_idx -= num_buffers;
559                         break;
560                 }
561
562                 vq->last_avail_idx += num_buffers;
563         }
564
565         if (likely(vq->shadow_used_idx)) {
566                 flush_shadow_used_ring(dev, vq);
567
568                 /* flush used->idx update before we read avail->flags. */
569                 rte_mb();
570
571                 /* Kick the guest if necessary. */
572                 if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
573                                 && (vq->callfd >= 0))
574                         eventfd_write(vq->callfd, (eventfd_t)1);
575         }
576
577         return pkt_idx;
578 }
579
580 uint16_t
581 rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
582         struct rte_mbuf **pkts, uint16_t count)
583 {
584         struct virtio_net *dev = get_device(vid);
585
586         if (!dev)
587                 return 0;
588
589         if (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF))
590                 return virtio_dev_merge_rx(dev, queue_id, pkts, count);
591         else
592                 return virtio_dev_rx(dev, queue_id, pkts, count);
593 }
594
595 static inline bool
596 virtio_net_with_host_offload(struct virtio_net *dev)
597 {
598         if (dev->features &
599                         (VIRTIO_NET_F_CSUM | VIRTIO_NET_F_HOST_ECN |
600                          VIRTIO_NET_F_HOST_TSO4 | VIRTIO_NET_F_HOST_TSO6 |
601                          VIRTIO_NET_F_HOST_UFO))
602                 return true;
603
604         return false;
605 }
606
607 static void
608 parse_ethernet(struct rte_mbuf *m, uint16_t *l4_proto, void **l4_hdr)
609 {
610         struct ipv4_hdr *ipv4_hdr;
611         struct ipv6_hdr *ipv6_hdr;
612         void *l3_hdr = NULL;
613         struct ether_hdr *eth_hdr;
614         uint16_t ethertype;
615
616         eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
617
618         m->l2_len = sizeof(struct ether_hdr);
619         ethertype = rte_be_to_cpu_16(eth_hdr->ether_type);
620
621         if (ethertype == ETHER_TYPE_VLAN) {
622                 struct vlan_hdr *vlan_hdr = (struct vlan_hdr *)(eth_hdr + 1);
623
624                 m->l2_len += sizeof(struct vlan_hdr);
625                 ethertype = rte_be_to_cpu_16(vlan_hdr->eth_proto);
626         }
627
628         l3_hdr = (char *)eth_hdr + m->l2_len;
629
630         switch (ethertype) {
631         case ETHER_TYPE_IPv4:
632                 ipv4_hdr = (struct ipv4_hdr *)l3_hdr;
633                 *l4_proto = ipv4_hdr->next_proto_id;
634                 m->l3_len = (ipv4_hdr->version_ihl & 0x0f) * 4;
635                 *l4_hdr = (char *)l3_hdr + m->l3_len;
636                 m->ol_flags |= PKT_TX_IPV4;
637                 break;
638         case ETHER_TYPE_IPv6:
639                 ipv6_hdr = (struct ipv6_hdr *)l3_hdr;
640                 *l4_proto = ipv6_hdr->proto;
641                 m->l3_len = sizeof(struct ipv6_hdr);
642                 *l4_hdr = (char *)l3_hdr + m->l3_len;
643                 m->ol_flags |= PKT_TX_IPV6;
644                 break;
645         default:
646                 m->l3_len = 0;
647                 *l4_proto = 0;
648                 break;
649         }
650 }
651
652 static inline void __attribute__((always_inline))
653 vhost_dequeue_offload(struct virtio_net_hdr *hdr, struct rte_mbuf *m)
654 {
655         uint16_t l4_proto = 0;
656         void *l4_hdr = NULL;
657         struct tcp_hdr *tcp_hdr = NULL;
658
659         if (hdr->flags == 0 && hdr->gso_type == VIRTIO_NET_HDR_GSO_NONE)
660                 return;
661
662         parse_ethernet(m, &l4_proto, &l4_hdr);
663         if (hdr->flags == VIRTIO_NET_HDR_F_NEEDS_CSUM) {
664                 if (hdr->csum_start == (m->l2_len + m->l3_len)) {
665                         switch (hdr->csum_offset) {
666                         case (offsetof(struct tcp_hdr, cksum)):
667                                 if (l4_proto == IPPROTO_TCP)
668                                         m->ol_flags |= PKT_TX_TCP_CKSUM;
669                                 break;
670                         case (offsetof(struct udp_hdr, dgram_cksum)):
671                                 if (l4_proto == IPPROTO_UDP)
672                                         m->ol_flags |= PKT_TX_UDP_CKSUM;
673                                 break;
674                         case (offsetof(struct sctp_hdr, cksum)):
675                                 if (l4_proto == IPPROTO_SCTP)
676                                         m->ol_flags |= PKT_TX_SCTP_CKSUM;
677                                 break;
678                         default:
679                                 break;
680                         }
681                 }
682         }
683
684         if (hdr->gso_type != VIRTIO_NET_HDR_GSO_NONE) {
685                 switch (hdr->gso_type & ~VIRTIO_NET_HDR_GSO_ECN) {
686                 case VIRTIO_NET_HDR_GSO_TCPV4:
687                 case VIRTIO_NET_HDR_GSO_TCPV6:
688                         tcp_hdr = (struct tcp_hdr *)l4_hdr;
689                         m->ol_flags |= PKT_TX_TCP_SEG;
690                         m->tso_segsz = hdr->gso_size;
691                         m->l4_len = (tcp_hdr->data_off & 0xf0) >> 2;
692                         break;
693                 default:
694                         RTE_LOG(WARNING, VHOST_DATA,
695                                 "unsupported gso type %u.\n", hdr->gso_type);
696                         break;
697                 }
698         }
699 }
700
701 #define RARP_PKT_SIZE   64
702
703 static int
704 make_rarp_packet(struct rte_mbuf *rarp_mbuf, const struct ether_addr *mac)
705 {
706         struct ether_hdr *eth_hdr;
707         struct arp_hdr  *rarp;
708
709         if (rarp_mbuf->buf_len < 64) {
710                 RTE_LOG(WARNING, VHOST_DATA,
711                         "failed to make RARP; mbuf size too small %u (< %d)\n",
712                         rarp_mbuf->buf_len, RARP_PKT_SIZE);
713                 return -1;
714         }
715
716         /* Ethernet header. */
717         eth_hdr = rte_pktmbuf_mtod_offset(rarp_mbuf, struct ether_hdr *, 0);
718         memset(eth_hdr->d_addr.addr_bytes, 0xff, ETHER_ADDR_LEN);
719         ether_addr_copy(mac, &eth_hdr->s_addr);
720         eth_hdr->ether_type = htons(ETHER_TYPE_RARP);
721
722         /* RARP header. */
723         rarp = (struct arp_hdr *)(eth_hdr + 1);
724         rarp->arp_hrd = htons(ARP_HRD_ETHER);
725         rarp->arp_pro = htons(ETHER_TYPE_IPv4);
726         rarp->arp_hln = ETHER_ADDR_LEN;
727         rarp->arp_pln = 4;
728         rarp->arp_op  = htons(ARP_OP_REVREQUEST);
729
730         ether_addr_copy(mac, &rarp->arp_data.arp_sha);
731         ether_addr_copy(mac, &rarp->arp_data.arp_tha);
732         memset(&rarp->arp_data.arp_sip, 0x00, 4);
733         memset(&rarp->arp_data.arp_tip, 0x00, 4);
734
735         rarp_mbuf->pkt_len  = rarp_mbuf->data_len = RARP_PKT_SIZE;
736
737         return 0;
738 }
739
740 static inline void __attribute__((always_inline))
741 put_zmbuf(struct zcopy_mbuf *zmbuf)
742 {
743         zmbuf->in_use = 0;
744 }
745
746 static inline int __attribute__((always_inline))
747 copy_desc_to_mbuf(struct virtio_net *dev, struct vring_desc *descs,
748                   uint16_t max_desc, struct rte_mbuf *m, uint16_t desc_idx,
749                   struct rte_mempool *mbuf_pool)
750 {
751         struct vring_desc *desc;
752         uint64_t desc_addr;
753         uint32_t desc_avail, desc_offset;
754         uint32_t mbuf_avail, mbuf_offset;
755         uint32_t cpy_len;
756         struct rte_mbuf *cur = m, *prev = m;
757         struct virtio_net_hdr *hdr = NULL;
758         /* A counter to avoid desc dead loop chain */
759         uint32_t nr_desc = 1;
760
761         desc = &descs[desc_idx];
762         if (unlikely((desc->len < dev->vhost_hlen)) ||
763                         (desc->flags & VRING_DESC_F_INDIRECT))
764                 return -1;
765
766         desc_addr = gpa_to_vva(dev, desc->addr);
767         if (unlikely(!desc_addr))
768                 return -1;
769
770         if (virtio_net_with_host_offload(dev)) {
771                 hdr = (struct virtio_net_hdr *)((uintptr_t)desc_addr);
772                 rte_prefetch0(hdr);
773         }
774
775         /*
776          * A virtio driver normally uses at least 2 desc buffers
777          * for Tx: the first for storing the header, and others
778          * for storing the data.
779          */
780         if (likely((desc->len == dev->vhost_hlen) &&
781                    (desc->flags & VRING_DESC_F_NEXT) != 0)) {
782                 desc = &descs[desc->next];
783                 if (unlikely(desc->flags & VRING_DESC_F_INDIRECT))
784                         return -1;
785
786                 desc_addr = gpa_to_vva(dev, desc->addr);
787                 if (unlikely(!desc_addr))
788                         return -1;
789
790                 desc_offset = 0;
791                 desc_avail  = desc->len;
792                 nr_desc    += 1;
793         } else {
794                 desc_avail  = desc->len - dev->vhost_hlen;
795                 desc_offset = dev->vhost_hlen;
796         }
797
798         rte_prefetch0((void *)(uintptr_t)(desc_addr + desc_offset));
799
800         PRINT_PACKET(dev, (uintptr_t)(desc_addr + desc_offset), desc_avail, 0);
801
802         mbuf_offset = 0;
803         mbuf_avail  = m->buf_len - RTE_PKTMBUF_HEADROOM;
804         while (1) {
805                 uint64_t hpa;
806
807                 cpy_len = RTE_MIN(desc_avail, mbuf_avail);
808
809                 /*
810                  * A desc buf might across two host physical pages that are
811                  * not continuous. In such case (gpa_to_hpa returns 0), data
812                  * will be copied even though zero copy is enabled.
813                  */
814                 if (unlikely(dev->dequeue_zero_copy && (hpa = gpa_to_hpa(dev,
815                                         desc->addr + desc_offset, cpy_len)))) {
816                         cur->data_len = cpy_len;
817                         cur->data_off = 0;
818                         cur->buf_addr = (void *)(uintptr_t)desc_addr;
819                         cur->buf_physaddr = hpa;
820
821                         /*
822                          * In zero copy mode, one mbuf can only reference data
823                          * for one or partial of one desc buff.
824                          */
825                         mbuf_avail = cpy_len;
826                 } else {
827                         rte_memcpy(rte_pktmbuf_mtod_offset(cur, void *,
828                                                            mbuf_offset),
829                                 (void *)((uintptr_t)(desc_addr + desc_offset)),
830                                 cpy_len);
831                 }
832
833                 mbuf_avail  -= cpy_len;
834                 mbuf_offset += cpy_len;
835                 desc_avail  -= cpy_len;
836                 desc_offset += cpy_len;
837
838                 /* This desc reaches to its end, get the next one */
839                 if (desc_avail == 0) {
840                         if ((desc->flags & VRING_DESC_F_NEXT) == 0)
841                                 break;
842
843                         if (unlikely(desc->next >= max_desc ||
844                                      ++nr_desc > max_desc))
845                                 return -1;
846                         desc = &descs[desc->next];
847                         if (unlikely(desc->flags & VRING_DESC_F_INDIRECT))
848                                 return -1;
849
850                         desc_addr = gpa_to_vva(dev, desc->addr);
851                         if (unlikely(!desc_addr))
852                                 return -1;
853
854                         rte_prefetch0((void *)(uintptr_t)desc_addr);
855
856                         desc_offset = 0;
857                         desc_avail  = desc->len;
858
859                         PRINT_PACKET(dev, (uintptr_t)desc_addr, desc->len, 0);
860                 }
861
862                 /*
863                  * This mbuf reaches to its end, get a new one
864                  * to hold more data.
865                  */
866                 if (mbuf_avail == 0) {
867                         cur = rte_pktmbuf_alloc(mbuf_pool);
868                         if (unlikely(cur == NULL)) {
869                                 RTE_LOG(ERR, VHOST_DATA, "Failed to "
870                                         "allocate memory for mbuf.\n");
871                                 return -1;
872                         }
873
874                         prev->next = cur;
875                         prev->data_len = mbuf_offset;
876                         m->nb_segs += 1;
877                         m->pkt_len += mbuf_offset;
878                         prev = cur;
879
880                         mbuf_offset = 0;
881                         mbuf_avail  = cur->buf_len - RTE_PKTMBUF_HEADROOM;
882                 }
883         }
884
885         prev->data_len = mbuf_offset;
886         m->pkt_len    += mbuf_offset;
887
888         if (hdr)
889                 vhost_dequeue_offload(hdr, m);
890
891         return 0;
892 }
893
894 static inline void __attribute__((always_inline))
895 update_used_ring(struct virtio_net *dev, struct vhost_virtqueue *vq,
896                  uint32_t used_idx, uint32_t desc_idx)
897 {
898         vq->used->ring[used_idx].id  = desc_idx;
899         vq->used->ring[used_idx].len = 0;
900         vhost_log_used_vring(dev, vq,
901                         offsetof(struct vring_used, ring[used_idx]),
902                         sizeof(vq->used->ring[used_idx]));
903 }
904
905 static inline void __attribute__((always_inline))
906 update_used_idx(struct virtio_net *dev, struct vhost_virtqueue *vq,
907                 uint32_t count)
908 {
909         if (unlikely(count == 0))
910                 return;
911
912         rte_smp_wmb();
913         rte_smp_rmb();
914
915         vq->used->idx += count;
916         vhost_log_used_vring(dev, vq, offsetof(struct vring_used, idx),
917                         sizeof(vq->used->idx));
918
919         /* Kick guest if required. */
920         if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
921                         && (vq->callfd >= 0))
922                 eventfd_write(vq->callfd, (eventfd_t)1);
923 }
924
925 static inline struct zcopy_mbuf *__attribute__((always_inline))
926 get_zmbuf(struct vhost_virtqueue *vq)
927 {
928         uint16_t i;
929         uint16_t last;
930         int tries = 0;
931
932         /* search [last_zmbuf_idx, zmbuf_size) */
933         i = vq->last_zmbuf_idx;
934         last = vq->zmbuf_size;
935
936 again:
937         for (; i < last; i++) {
938                 if (vq->zmbufs[i].in_use == 0) {
939                         vq->last_zmbuf_idx = i + 1;
940                         vq->zmbufs[i].in_use = 1;
941                         return &vq->zmbufs[i];
942                 }
943         }
944
945         tries++;
946         if (tries == 1) {
947                 /* search [0, last_zmbuf_idx) */
948                 i = 0;
949                 last = vq->last_zmbuf_idx;
950                 goto again;
951         }
952
953         return NULL;
954 }
955
956 static inline bool __attribute__((always_inline))
957 mbuf_is_consumed(struct rte_mbuf *m)
958 {
959         while (m) {
960                 if (rte_mbuf_refcnt_read(m) > 1)
961                         return false;
962                 m = m->next;
963         }
964
965         return true;
966 }
967
968 uint16_t
969 rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
970         struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count)
971 {
972         struct virtio_net *dev;
973         struct rte_mbuf *rarp_mbuf = NULL;
974         struct vhost_virtqueue *vq;
975         uint32_t desc_indexes[MAX_PKT_BURST];
976         uint32_t used_idx;
977         uint32_t i = 0;
978         uint16_t free_entries;
979         uint16_t avail_idx;
980
981         dev = get_device(vid);
982         if (!dev)
983                 return 0;
984
985         if (unlikely(!is_valid_virt_queue_idx(queue_id, 1, dev->virt_qp_nb))) {
986                 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
987                         dev->vid, __func__, queue_id);
988                 return 0;
989         }
990
991         vq = dev->virtqueue[queue_id];
992         if (unlikely(vq->enabled == 0))
993                 return 0;
994
995         if (unlikely(dev->dequeue_zero_copy)) {
996                 struct zcopy_mbuf *zmbuf, *next;
997                 int nr_updated = 0;
998
999                 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
1000                      zmbuf != NULL; zmbuf = next) {
1001                         next = TAILQ_NEXT(zmbuf, next);
1002
1003                         if (mbuf_is_consumed(zmbuf->mbuf)) {
1004                                 used_idx = vq->last_used_idx++ & (vq->size - 1);
1005                                 update_used_ring(dev, vq, used_idx,
1006                                                  zmbuf->desc_idx);
1007                                 nr_updated += 1;
1008
1009                                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
1010                                 rte_pktmbuf_free(zmbuf->mbuf);
1011                                 put_zmbuf(zmbuf);
1012                                 vq->nr_zmbuf -= 1;
1013                         }
1014                 }
1015
1016                 update_used_idx(dev, vq, nr_updated);
1017         }
1018
1019         /*
1020          * Construct a RARP broadcast packet, and inject it to the "pkts"
1021          * array, to looks like that guest actually send such packet.
1022          *
1023          * Check user_send_rarp() for more information.
1024          */
1025         if (unlikely(rte_atomic16_cmpset((volatile uint16_t *)
1026                                          &dev->broadcast_rarp.cnt, 1, 0))) {
1027                 rarp_mbuf = rte_pktmbuf_alloc(mbuf_pool);
1028                 if (rarp_mbuf == NULL) {
1029                         RTE_LOG(ERR, VHOST_DATA,
1030                                 "Failed to allocate memory for mbuf.\n");
1031                         return 0;
1032                 }
1033
1034                 if (make_rarp_packet(rarp_mbuf, &dev->mac)) {
1035                         rte_pktmbuf_free(rarp_mbuf);
1036                         rarp_mbuf = NULL;
1037                 } else {
1038                         count -= 1;
1039                 }
1040         }
1041
1042         free_entries = *((volatile uint16_t *)&vq->avail->idx) -
1043                         vq->last_avail_idx;
1044         if (free_entries == 0)
1045                 goto out;
1046
1047         LOG_DEBUG(VHOST_DATA, "(%d) %s\n", dev->vid, __func__);
1048
1049         /* Prefetch available and used ring */
1050         avail_idx = vq->last_avail_idx & (vq->size - 1);
1051         used_idx  = vq->last_used_idx  & (vq->size - 1);
1052         rte_prefetch0(&vq->avail->ring[avail_idx]);
1053         rte_prefetch0(&vq->used->ring[used_idx]);
1054
1055         count = RTE_MIN(count, MAX_PKT_BURST);
1056         count = RTE_MIN(count, free_entries);
1057         LOG_DEBUG(VHOST_DATA, "(%d) about to dequeue %u buffers\n",
1058                         dev->vid, count);
1059
1060         /* Retrieve all of the head indexes first to avoid caching issues. */
1061         for (i = 0; i < count; i++) {
1062                 avail_idx = (vq->last_avail_idx + i) & (vq->size - 1);
1063                 used_idx  = (vq->last_used_idx  + i) & (vq->size - 1);
1064                 desc_indexes[i] = vq->avail->ring[avail_idx];
1065
1066                 if (likely(dev->dequeue_zero_copy == 0))
1067                         update_used_ring(dev, vq, used_idx, desc_indexes[i]);
1068         }
1069
1070         /* Prefetch descriptor index. */
1071         rte_prefetch0(&vq->desc[desc_indexes[0]]);
1072         for (i = 0; i < count; i++) {
1073                 struct vring_desc *desc;
1074                 uint16_t sz, idx;
1075                 int err;
1076
1077                 if (likely(i + 1 < count))
1078                         rte_prefetch0(&vq->desc[desc_indexes[i + 1]]);
1079
1080                 if (vq->desc[desc_indexes[i]].flags & VRING_DESC_F_INDIRECT) {
1081                         desc = (struct vring_desc *)(uintptr_t)gpa_to_vva(dev,
1082                                         vq->desc[desc_indexes[i]].addr);
1083                         if (unlikely(!desc))
1084                                 break;
1085
1086                         rte_prefetch0(desc);
1087                         sz = vq->desc[desc_indexes[i]].len / sizeof(*desc);
1088                         idx = 0;
1089                 } else {
1090                         desc = vq->desc;
1091                         sz = vq->size;
1092                         idx = desc_indexes[i];
1093                 }
1094
1095                 pkts[i] = rte_pktmbuf_alloc(mbuf_pool);
1096                 if (unlikely(pkts[i] == NULL)) {
1097                         RTE_LOG(ERR, VHOST_DATA,
1098                                 "Failed to allocate memory for mbuf.\n");
1099                         break;
1100                 }
1101
1102                 err = copy_desc_to_mbuf(dev, desc, sz, pkts[i], idx, mbuf_pool);
1103                 if (unlikely(err)) {
1104                         rte_pktmbuf_free(pkts[i]);
1105                         break;
1106                 }
1107
1108                 if (unlikely(dev->dequeue_zero_copy)) {
1109                         struct zcopy_mbuf *zmbuf;
1110
1111                         zmbuf = get_zmbuf(vq);
1112                         if (!zmbuf) {
1113                                 rte_pktmbuf_free(pkts[i]);
1114                                 break;
1115                         }
1116                         zmbuf->mbuf = pkts[i];
1117                         zmbuf->desc_idx = desc_indexes[i];
1118
1119                         /*
1120                          * Pin lock the mbuf; we will check later to see
1121                          * whether the mbuf is freed (when we are the last
1122                          * user) or not. If that's the case, we then could
1123                          * update the used ring safely.
1124                          */
1125                         rte_mbuf_refcnt_update(pkts[i], 1);
1126
1127                         vq->nr_zmbuf += 1;
1128                         TAILQ_INSERT_TAIL(&vq->zmbuf_list, zmbuf, next);
1129                 }
1130         }
1131         vq->last_avail_idx += i;
1132
1133         if (likely(dev->dequeue_zero_copy == 0)) {
1134                 vq->last_used_idx += i;
1135                 update_used_idx(dev, vq, i);
1136         }
1137
1138 out:
1139         if (unlikely(rarp_mbuf != NULL)) {
1140                 /*
1141                  * Inject it to the head of "pkts" array, so that switch's mac
1142                  * learning table will get updated first.
1143                  */
1144                 memmove(&pkts[1], pkts, i * sizeof(struct rte_mbuf *));
1145                 pkts[0] = rarp_mbuf;
1146                 i += 1;
1147         }
1148
1149         return i;
1150 }