vhost: retrieve available head once
[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                             uint16_t avail_head)
392 {
393         uint16_t cur_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                 if (unlikely(cur_idx == avail_head))
405                         return -1;
406
407                 if (unlikely(fill_vec_buf(vq, cur_idx, &vec_idx, buf_vec,
408                                           &head_idx, &len) < 0))
409                         return -1;
410                 len = RTE_MIN(len, size);
411                 update_shadow_used_ring(vq, head_idx, len);
412                 size -= len;
413
414                 cur_idx++;
415                 tries++;
416                 *num_buffers += 1;
417
418                 /*
419                  * if we tried all available ring items, and still
420                  * can't get enough buf, it means something abnormal
421                  * happened.
422                  */
423                 if (unlikely(tries >= vq->size))
424                         return -1;
425         }
426
427         return 0;
428 }
429
430 static inline int __attribute__((always_inline))
431 copy_mbuf_to_desc_mergeable(struct virtio_net *dev, struct rte_mbuf *m,
432                             struct buf_vector *buf_vec, uint16_t num_buffers)
433 {
434         struct virtio_net_hdr_mrg_rxbuf virtio_hdr = {{0, 0, 0, 0, 0, 0}, 0};
435         uint32_t vec_idx = 0;
436         uint64_t desc_addr;
437         uint32_t mbuf_offset, mbuf_avail;
438         uint32_t desc_offset, desc_avail;
439         uint32_t cpy_len;
440         uint64_t hdr_addr, hdr_phys_addr;
441         struct rte_mbuf *hdr_mbuf;
442
443         if (unlikely(m == NULL))
444                 return -1;
445
446         desc_addr = gpa_to_vva(dev, buf_vec[vec_idx].buf_addr);
447         if (buf_vec[vec_idx].buf_len < dev->vhost_hlen || !desc_addr)
448                 return -1;
449
450         hdr_mbuf = m;
451         hdr_addr = desc_addr;
452         hdr_phys_addr = buf_vec[vec_idx].buf_addr;
453         rte_prefetch0((void *)(uintptr_t)hdr_addr);
454
455         virtio_hdr.num_buffers = num_buffers;
456         LOG_DEBUG(VHOST_DATA, "(%d) RX: num merge buffers %d\n",
457                 dev->vid, num_buffers);
458
459         desc_avail  = buf_vec[vec_idx].buf_len - dev->vhost_hlen;
460         desc_offset = dev->vhost_hlen;
461
462         mbuf_avail  = rte_pktmbuf_data_len(m);
463         mbuf_offset = 0;
464         while (mbuf_avail != 0 || m->next != NULL) {
465                 /* done with current desc buf, get the next one */
466                 if (desc_avail == 0) {
467                         vec_idx++;
468                         desc_addr = gpa_to_vva(dev, buf_vec[vec_idx].buf_addr);
469                         if (unlikely(!desc_addr))
470                                 return -1;
471
472                         /* Prefetch buffer address. */
473                         rte_prefetch0((void *)(uintptr_t)desc_addr);
474                         desc_offset = 0;
475                         desc_avail  = buf_vec[vec_idx].buf_len;
476                 }
477
478                 /* done with current mbuf, get the next one */
479                 if (mbuf_avail == 0) {
480                         m = m->next;
481
482                         mbuf_offset = 0;
483                         mbuf_avail  = rte_pktmbuf_data_len(m);
484                 }
485
486                 if (hdr_addr) {
487                         virtio_enqueue_offload(hdr_mbuf, &virtio_hdr.hdr);
488                         copy_virtio_net_hdr(dev, hdr_addr, virtio_hdr);
489                         vhost_log_write(dev, hdr_phys_addr, dev->vhost_hlen);
490                         PRINT_PACKET(dev, (uintptr_t)hdr_addr,
491                                      dev->vhost_hlen, 0);
492
493                         hdr_addr = 0;
494                 }
495
496                 cpy_len = RTE_MIN(desc_avail, mbuf_avail);
497                 rte_memcpy((void *)((uintptr_t)(desc_addr + desc_offset)),
498                         rte_pktmbuf_mtod_offset(m, void *, mbuf_offset),
499                         cpy_len);
500                 vhost_log_write(dev, buf_vec[vec_idx].buf_addr + desc_offset,
501                         cpy_len);
502                 PRINT_PACKET(dev, (uintptr_t)(desc_addr + desc_offset),
503                         cpy_len, 0);
504
505                 mbuf_avail  -= cpy_len;
506                 mbuf_offset += cpy_len;
507                 desc_avail  -= cpy_len;
508                 desc_offset += cpy_len;
509         }
510
511         return 0;
512 }
513
514 static inline uint32_t __attribute__((always_inline))
515 virtio_dev_merge_rx(struct virtio_net *dev, uint16_t queue_id,
516         struct rte_mbuf **pkts, uint32_t count)
517 {
518         struct vhost_virtqueue *vq;
519         uint32_t pkt_idx = 0;
520         uint16_t num_buffers;
521         struct buf_vector buf_vec[BUF_VECTOR_MAX];
522         uint16_t avail_head;
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         rte_prefetch0(&vq->avail->ring[vq->last_avail_idx & (vq->size - 1)]);
540
541         vq->shadow_used_idx = 0;
542         avail_head = *((volatile uint16_t *)&vq->avail->idx);
543         for (pkt_idx = 0; pkt_idx < count; pkt_idx++) {
544                 uint32_t pkt_len = pkts[pkt_idx]->pkt_len + dev->vhost_hlen;
545
546                 if (unlikely(reserve_avail_buf_mergeable(vq, pkt_len, buf_vec,
547                                         &num_buffers, avail_head) < 0)) {
548                         LOG_DEBUG(VHOST_DATA,
549                                 "(%d) failed to get enough desc from vring\n",
550                                 dev->vid);
551                         vq->shadow_used_idx -= num_buffers;
552                         break;
553                 }
554
555                 LOG_DEBUG(VHOST_DATA, "(%d) current index %d | end index %d\n",
556                         dev->vid, vq->last_avail_idx,
557                         vq->last_avail_idx + num_buffers);
558
559                 if (copy_mbuf_to_desc_mergeable(dev, pkts[pkt_idx],
560                                                 buf_vec, num_buffers) < 0) {
561                         vq->shadow_used_idx -= num_buffers;
562                         break;
563                 }
564
565                 vq->last_avail_idx += num_buffers;
566         }
567
568         if (likely(vq->shadow_used_idx)) {
569                 flush_shadow_used_ring(dev, vq);
570
571                 /* flush used->idx update before we read avail->flags. */
572                 rte_mb();
573
574                 /* Kick the guest if necessary. */
575                 if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
576                                 && (vq->callfd >= 0))
577                         eventfd_write(vq->callfd, (eventfd_t)1);
578         }
579
580         return pkt_idx;
581 }
582
583 uint16_t
584 rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
585         struct rte_mbuf **pkts, uint16_t count)
586 {
587         struct virtio_net *dev = get_device(vid);
588
589         if (!dev)
590                 return 0;
591
592         if (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF))
593                 return virtio_dev_merge_rx(dev, queue_id, pkts, count);
594         else
595                 return virtio_dev_rx(dev, queue_id, pkts, count);
596 }
597
598 static inline bool
599 virtio_net_with_host_offload(struct virtio_net *dev)
600 {
601         if (dev->features &
602                         (VIRTIO_NET_F_CSUM | VIRTIO_NET_F_HOST_ECN |
603                          VIRTIO_NET_F_HOST_TSO4 | VIRTIO_NET_F_HOST_TSO6 |
604                          VIRTIO_NET_F_HOST_UFO))
605                 return true;
606
607         return false;
608 }
609
610 static void
611 parse_ethernet(struct rte_mbuf *m, uint16_t *l4_proto, void **l4_hdr)
612 {
613         struct ipv4_hdr *ipv4_hdr;
614         struct ipv6_hdr *ipv6_hdr;
615         void *l3_hdr = NULL;
616         struct ether_hdr *eth_hdr;
617         uint16_t ethertype;
618
619         eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
620
621         m->l2_len = sizeof(struct ether_hdr);
622         ethertype = rte_be_to_cpu_16(eth_hdr->ether_type);
623
624         if (ethertype == ETHER_TYPE_VLAN) {
625                 struct vlan_hdr *vlan_hdr = (struct vlan_hdr *)(eth_hdr + 1);
626
627                 m->l2_len += sizeof(struct vlan_hdr);
628                 ethertype = rte_be_to_cpu_16(vlan_hdr->eth_proto);
629         }
630
631         l3_hdr = (char *)eth_hdr + m->l2_len;
632
633         switch (ethertype) {
634         case ETHER_TYPE_IPv4:
635                 ipv4_hdr = (struct ipv4_hdr *)l3_hdr;
636                 *l4_proto = ipv4_hdr->next_proto_id;
637                 m->l3_len = (ipv4_hdr->version_ihl & 0x0f) * 4;
638                 *l4_hdr = (char *)l3_hdr + m->l3_len;
639                 m->ol_flags |= PKT_TX_IPV4;
640                 break;
641         case ETHER_TYPE_IPv6:
642                 ipv6_hdr = (struct ipv6_hdr *)l3_hdr;
643                 *l4_proto = ipv6_hdr->proto;
644                 m->l3_len = sizeof(struct ipv6_hdr);
645                 *l4_hdr = (char *)l3_hdr + m->l3_len;
646                 m->ol_flags |= PKT_TX_IPV6;
647                 break;
648         default:
649                 m->l3_len = 0;
650                 *l4_proto = 0;
651                 break;
652         }
653 }
654
655 static inline void __attribute__((always_inline))
656 vhost_dequeue_offload(struct virtio_net_hdr *hdr, struct rte_mbuf *m)
657 {
658         uint16_t l4_proto = 0;
659         void *l4_hdr = NULL;
660         struct tcp_hdr *tcp_hdr = NULL;
661
662         if (hdr->flags == 0 && hdr->gso_type == VIRTIO_NET_HDR_GSO_NONE)
663                 return;
664
665         parse_ethernet(m, &l4_proto, &l4_hdr);
666         if (hdr->flags == VIRTIO_NET_HDR_F_NEEDS_CSUM) {
667                 if (hdr->csum_start == (m->l2_len + m->l3_len)) {
668                         switch (hdr->csum_offset) {
669                         case (offsetof(struct tcp_hdr, cksum)):
670                                 if (l4_proto == IPPROTO_TCP)
671                                         m->ol_flags |= PKT_TX_TCP_CKSUM;
672                                 break;
673                         case (offsetof(struct udp_hdr, dgram_cksum)):
674                                 if (l4_proto == IPPROTO_UDP)
675                                         m->ol_flags |= PKT_TX_UDP_CKSUM;
676                                 break;
677                         case (offsetof(struct sctp_hdr, cksum)):
678                                 if (l4_proto == IPPROTO_SCTP)
679                                         m->ol_flags |= PKT_TX_SCTP_CKSUM;
680                                 break;
681                         default:
682                                 break;
683                         }
684                 }
685         }
686
687         if (hdr->gso_type != VIRTIO_NET_HDR_GSO_NONE) {
688                 switch (hdr->gso_type & ~VIRTIO_NET_HDR_GSO_ECN) {
689                 case VIRTIO_NET_HDR_GSO_TCPV4:
690                 case VIRTIO_NET_HDR_GSO_TCPV6:
691                         tcp_hdr = (struct tcp_hdr *)l4_hdr;
692                         m->ol_flags |= PKT_TX_TCP_SEG;
693                         m->tso_segsz = hdr->gso_size;
694                         m->l4_len = (tcp_hdr->data_off & 0xf0) >> 2;
695                         break;
696                 default:
697                         RTE_LOG(WARNING, VHOST_DATA,
698                                 "unsupported gso type %u.\n", hdr->gso_type);
699                         break;
700                 }
701         }
702 }
703
704 #define RARP_PKT_SIZE   64
705
706 static int
707 make_rarp_packet(struct rte_mbuf *rarp_mbuf, const struct ether_addr *mac)
708 {
709         struct ether_hdr *eth_hdr;
710         struct arp_hdr  *rarp;
711
712         if (rarp_mbuf->buf_len < 64) {
713                 RTE_LOG(WARNING, VHOST_DATA,
714                         "failed to make RARP; mbuf size too small %u (< %d)\n",
715                         rarp_mbuf->buf_len, RARP_PKT_SIZE);
716                 return -1;
717         }
718
719         /* Ethernet header. */
720         eth_hdr = rte_pktmbuf_mtod_offset(rarp_mbuf, struct ether_hdr *, 0);
721         memset(eth_hdr->d_addr.addr_bytes, 0xff, ETHER_ADDR_LEN);
722         ether_addr_copy(mac, &eth_hdr->s_addr);
723         eth_hdr->ether_type = htons(ETHER_TYPE_RARP);
724
725         /* RARP header. */
726         rarp = (struct arp_hdr *)(eth_hdr + 1);
727         rarp->arp_hrd = htons(ARP_HRD_ETHER);
728         rarp->arp_pro = htons(ETHER_TYPE_IPv4);
729         rarp->arp_hln = ETHER_ADDR_LEN;
730         rarp->arp_pln = 4;
731         rarp->arp_op  = htons(ARP_OP_REVREQUEST);
732
733         ether_addr_copy(mac, &rarp->arp_data.arp_sha);
734         ether_addr_copy(mac, &rarp->arp_data.arp_tha);
735         memset(&rarp->arp_data.arp_sip, 0x00, 4);
736         memset(&rarp->arp_data.arp_tip, 0x00, 4);
737
738         rarp_mbuf->pkt_len  = rarp_mbuf->data_len = RARP_PKT_SIZE;
739
740         return 0;
741 }
742
743 static inline void __attribute__((always_inline))
744 put_zmbuf(struct zcopy_mbuf *zmbuf)
745 {
746         zmbuf->in_use = 0;
747 }
748
749 static inline int __attribute__((always_inline))
750 copy_desc_to_mbuf(struct virtio_net *dev, struct vring_desc *descs,
751                   uint16_t max_desc, struct rte_mbuf *m, uint16_t desc_idx,
752                   struct rte_mempool *mbuf_pool)
753 {
754         struct vring_desc *desc;
755         uint64_t desc_addr;
756         uint32_t desc_avail, desc_offset;
757         uint32_t mbuf_avail, mbuf_offset;
758         uint32_t cpy_len;
759         struct rte_mbuf *cur = m, *prev = m;
760         struct virtio_net_hdr *hdr = NULL;
761         /* A counter to avoid desc dead loop chain */
762         uint32_t nr_desc = 1;
763
764         desc = &descs[desc_idx];
765         if (unlikely((desc->len < dev->vhost_hlen)) ||
766                         (desc->flags & VRING_DESC_F_INDIRECT))
767                 return -1;
768
769         desc_addr = gpa_to_vva(dev, desc->addr);
770         if (unlikely(!desc_addr))
771                 return -1;
772
773         if (virtio_net_with_host_offload(dev)) {
774                 hdr = (struct virtio_net_hdr *)((uintptr_t)desc_addr);
775                 rte_prefetch0(hdr);
776         }
777
778         /*
779          * A virtio driver normally uses at least 2 desc buffers
780          * for Tx: the first for storing the header, and others
781          * for storing the data.
782          */
783         if (likely((desc->len == dev->vhost_hlen) &&
784                    (desc->flags & VRING_DESC_F_NEXT) != 0)) {
785                 desc = &descs[desc->next];
786                 if (unlikely(desc->flags & VRING_DESC_F_INDIRECT))
787                         return -1;
788
789                 desc_addr = gpa_to_vva(dev, desc->addr);
790                 if (unlikely(!desc_addr))
791                         return -1;
792
793                 desc_offset = 0;
794                 desc_avail  = desc->len;
795                 nr_desc    += 1;
796         } else {
797                 desc_avail  = desc->len - dev->vhost_hlen;
798                 desc_offset = dev->vhost_hlen;
799         }
800
801         rte_prefetch0((void *)(uintptr_t)(desc_addr + desc_offset));
802
803         PRINT_PACKET(dev, (uintptr_t)(desc_addr + desc_offset), desc_avail, 0);
804
805         mbuf_offset = 0;
806         mbuf_avail  = m->buf_len - RTE_PKTMBUF_HEADROOM;
807         while (1) {
808                 uint64_t hpa;
809
810                 cpy_len = RTE_MIN(desc_avail, mbuf_avail);
811
812                 /*
813                  * A desc buf might across two host physical pages that are
814                  * not continuous. In such case (gpa_to_hpa returns 0), data
815                  * will be copied even though zero copy is enabled.
816                  */
817                 if (unlikely(dev->dequeue_zero_copy && (hpa = gpa_to_hpa(dev,
818                                         desc->addr + desc_offset, cpy_len)))) {
819                         cur->data_len = cpy_len;
820                         cur->data_off = 0;
821                         cur->buf_addr = (void *)(uintptr_t)desc_addr;
822                         cur->buf_physaddr = hpa;
823
824                         /*
825                          * In zero copy mode, one mbuf can only reference data
826                          * for one or partial of one desc buff.
827                          */
828                         mbuf_avail = cpy_len;
829                 } else {
830                         rte_memcpy(rte_pktmbuf_mtod_offset(cur, void *,
831                                                            mbuf_offset),
832                                 (void *)((uintptr_t)(desc_addr + desc_offset)),
833                                 cpy_len);
834                 }
835
836                 mbuf_avail  -= cpy_len;
837                 mbuf_offset += cpy_len;
838                 desc_avail  -= cpy_len;
839                 desc_offset += cpy_len;
840
841                 /* This desc reaches to its end, get the next one */
842                 if (desc_avail == 0) {
843                         if ((desc->flags & VRING_DESC_F_NEXT) == 0)
844                                 break;
845
846                         if (unlikely(desc->next >= max_desc ||
847                                      ++nr_desc > max_desc))
848                                 return -1;
849                         desc = &descs[desc->next];
850                         if (unlikely(desc->flags & VRING_DESC_F_INDIRECT))
851                                 return -1;
852
853                         desc_addr = gpa_to_vva(dev, desc->addr);
854                         if (unlikely(!desc_addr))
855                                 return -1;
856
857                         rte_prefetch0((void *)(uintptr_t)desc_addr);
858
859                         desc_offset = 0;
860                         desc_avail  = desc->len;
861
862                         PRINT_PACKET(dev, (uintptr_t)desc_addr, desc->len, 0);
863                 }
864
865                 /*
866                  * This mbuf reaches to its end, get a new one
867                  * to hold more data.
868                  */
869                 if (mbuf_avail == 0) {
870                         cur = rte_pktmbuf_alloc(mbuf_pool);
871                         if (unlikely(cur == NULL)) {
872                                 RTE_LOG(ERR, VHOST_DATA, "Failed to "
873                                         "allocate memory for mbuf.\n");
874                                 return -1;
875                         }
876
877                         prev->next = cur;
878                         prev->data_len = mbuf_offset;
879                         m->nb_segs += 1;
880                         m->pkt_len += mbuf_offset;
881                         prev = cur;
882
883                         mbuf_offset = 0;
884                         mbuf_avail  = cur->buf_len - RTE_PKTMBUF_HEADROOM;
885                 }
886         }
887
888         prev->data_len = mbuf_offset;
889         m->pkt_len    += mbuf_offset;
890
891         if (hdr)
892                 vhost_dequeue_offload(hdr, m);
893
894         return 0;
895 }
896
897 static inline void __attribute__((always_inline))
898 update_used_ring(struct virtio_net *dev, struct vhost_virtqueue *vq,
899                  uint32_t used_idx, uint32_t desc_idx)
900 {
901         vq->used->ring[used_idx].id  = desc_idx;
902         vq->used->ring[used_idx].len = 0;
903         vhost_log_used_vring(dev, vq,
904                         offsetof(struct vring_used, ring[used_idx]),
905                         sizeof(vq->used->ring[used_idx]));
906 }
907
908 static inline void __attribute__((always_inline))
909 update_used_idx(struct virtio_net *dev, struct vhost_virtqueue *vq,
910                 uint32_t count)
911 {
912         if (unlikely(count == 0))
913                 return;
914
915         rte_smp_wmb();
916         rte_smp_rmb();
917
918         vq->used->idx += count;
919         vhost_log_used_vring(dev, vq, offsetof(struct vring_used, idx),
920                         sizeof(vq->used->idx));
921
922         /* Kick guest if required. */
923         if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
924                         && (vq->callfd >= 0))
925                 eventfd_write(vq->callfd, (eventfd_t)1);
926 }
927
928 static inline struct zcopy_mbuf *__attribute__((always_inline))
929 get_zmbuf(struct vhost_virtqueue *vq)
930 {
931         uint16_t i;
932         uint16_t last;
933         int tries = 0;
934
935         /* search [last_zmbuf_idx, zmbuf_size) */
936         i = vq->last_zmbuf_idx;
937         last = vq->zmbuf_size;
938
939 again:
940         for (; i < last; i++) {
941                 if (vq->zmbufs[i].in_use == 0) {
942                         vq->last_zmbuf_idx = i + 1;
943                         vq->zmbufs[i].in_use = 1;
944                         return &vq->zmbufs[i];
945                 }
946         }
947
948         tries++;
949         if (tries == 1) {
950                 /* search [0, last_zmbuf_idx) */
951                 i = 0;
952                 last = vq->last_zmbuf_idx;
953                 goto again;
954         }
955
956         return NULL;
957 }
958
959 static inline bool __attribute__((always_inline))
960 mbuf_is_consumed(struct rte_mbuf *m)
961 {
962         while (m) {
963                 if (rte_mbuf_refcnt_read(m) > 1)
964                         return false;
965                 m = m->next;
966         }
967
968         return true;
969 }
970
971 uint16_t
972 rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
973         struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count)
974 {
975         struct virtio_net *dev;
976         struct rte_mbuf *rarp_mbuf = NULL;
977         struct vhost_virtqueue *vq;
978         uint32_t desc_indexes[MAX_PKT_BURST];
979         uint32_t used_idx;
980         uint32_t i = 0;
981         uint16_t free_entries;
982         uint16_t avail_idx;
983
984         dev = get_device(vid);
985         if (!dev)
986                 return 0;
987
988         if (unlikely(!is_valid_virt_queue_idx(queue_id, 1, dev->virt_qp_nb))) {
989                 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
990                         dev->vid, __func__, queue_id);
991                 return 0;
992         }
993
994         vq = dev->virtqueue[queue_id];
995         if (unlikely(vq->enabled == 0))
996                 return 0;
997
998         if (unlikely(dev->dequeue_zero_copy)) {
999                 struct zcopy_mbuf *zmbuf, *next;
1000                 int nr_updated = 0;
1001
1002                 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
1003                      zmbuf != NULL; zmbuf = next) {
1004                         next = TAILQ_NEXT(zmbuf, next);
1005
1006                         if (mbuf_is_consumed(zmbuf->mbuf)) {
1007                                 used_idx = vq->last_used_idx++ & (vq->size - 1);
1008                                 update_used_ring(dev, vq, used_idx,
1009                                                  zmbuf->desc_idx);
1010                                 nr_updated += 1;
1011
1012                                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
1013                                 rte_pktmbuf_free(zmbuf->mbuf);
1014                                 put_zmbuf(zmbuf);
1015                                 vq->nr_zmbuf -= 1;
1016                         }
1017                 }
1018
1019                 update_used_idx(dev, vq, nr_updated);
1020         }
1021
1022         /*
1023          * Construct a RARP broadcast packet, and inject it to the "pkts"
1024          * array, to looks like that guest actually send such packet.
1025          *
1026          * Check user_send_rarp() for more information.
1027          */
1028         if (unlikely(rte_atomic16_cmpset((volatile uint16_t *)
1029                                          &dev->broadcast_rarp.cnt, 1, 0))) {
1030                 rarp_mbuf = rte_pktmbuf_alloc(mbuf_pool);
1031                 if (rarp_mbuf == NULL) {
1032                         RTE_LOG(ERR, VHOST_DATA,
1033                                 "Failed to allocate memory for mbuf.\n");
1034                         return 0;
1035                 }
1036
1037                 if (make_rarp_packet(rarp_mbuf, &dev->mac)) {
1038                         rte_pktmbuf_free(rarp_mbuf);
1039                         rarp_mbuf = NULL;
1040                 } else {
1041                         count -= 1;
1042                 }
1043         }
1044
1045         free_entries = *((volatile uint16_t *)&vq->avail->idx) -
1046                         vq->last_avail_idx;
1047         if (free_entries == 0)
1048                 goto out;
1049
1050         LOG_DEBUG(VHOST_DATA, "(%d) %s\n", dev->vid, __func__);
1051
1052         /* Prefetch available and used ring */
1053         avail_idx = vq->last_avail_idx & (vq->size - 1);
1054         used_idx  = vq->last_used_idx  & (vq->size - 1);
1055         rte_prefetch0(&vq->avail->ring[avail_idx]);
1056         rte_prefetch0(&vq->used->ring[used_idx]);
1057
1058         count = RTE_MIN(count, MAX_PKT_BURST);
1059         count = RTE_MIN(count, free_entries);
1060         LOG_DEBUG(VHOST_DATA, "(%d) about to dequeue %u buffers\n",
1061                         dev->vid, count);
1062
1063         /* Retrieve all of the head indexes first to avoid caching issues. */
1064         for (i = 0; i < count; i++) {
1065                 avail_idx = (vq->last_avail_idx + i) & (vq->size - 1);
1066                 used_idx  = (vq->last_used_idx  + i) & (vq->size - 1);
1067                 desc_indexes[i] = vq->avail->ring[avail_idx];
1068
1069                 if (likely(dev->dequeue_zero_copy == 0))
1070                         update_used_ring(dev, vq, used_idx, desc_indexes[i]);
1071         }
1072
1073         /* Prefetch descriptor index. */
1074         rte_prefetch0(&vq->desc[desc_indexes[0]]);
1075         for (i = 0; i < count; i++) {
1076                 struct vring_desc *desc;
1077                 uint16_t sz, idx;
1078                 int err;
1079
1080                 if (likely(i + 1 < count))
1081                         rte_prefetch0(&vq->desc[desc_indexes[i + 1]]);
1082
1083                 if (vq->desc[desc_indexes[i]].flags & VRING_DESC_F_INDIRECT) {
1084                         desc = (struct vring_desc *)(uintptr_t)gpa_to_vva(dev,
1085                                         vq->desc[desc_indexes[i]].addr);
1086                         if (unlikely(!desc))
1087                                 break;
1088
1089                         rte_prefetch0(desc);
1090                         sz = vq->desc[desc_indexes[i]].len / sizeof(*desc);
1091                         idx = 0;
1092                 } else {
1093                         desc = vq->desc;
1094                         sz = vq->size;
1095                         idx = desc_indexes[i];
1096                 }
1097
1098                 pkts[i] = rte_pktmbuf_alloc(mbuf_pool);
1099                 if (unlikely(pkts[i] == NULL)) {
1100                         RTE_LOG(ERR, VHOST_DATA,
1101                                 "Failed to allocate memory for mbuf.\n");
1102                         break;
1103                 }
1104
1105                 err = copy_desc_to_mbuf(dev, desc, sz, pkts[i], idx, mbuf_pool);
1106                 if (unlikely(err)) {
1107                         rte_pktmbuf_free(pkts[i]);
1108                         break;
1109                 }
1110
1111                 if (unlikely(dev->dequeue_zero_copy)) {
1112                         struct zcopy_mbuf *zmbuf;
1113
1114                         zmbuf = get_zmbuf(vq);
1115                         if (!zmbuf) {
1116                                 rte_pktmbuf_free(pkts[i]);
1117                                 break;
1118                         }
1119                         zmbuf->mbuf = pkts[i];
1120                         zmbuf->desc_idx = desc_indexes[i];
1121
1122                         /*
1123                          * Pin lock the mbuf; we will check later to see
1124                          * whether the mbuf is freed (when we are the last
1125                          * user) or not. If that's the case, we then could
1126                          * update the used ring safely.
1127                          */
1128                         rte_mbuf_refcnt_update(pkts[i], 1);
1129
1130                         vq->nr_zmbuf += 1;
1131                         TAILQ_INSERT_TAIL(&vq->zmbuf_list, zmbuf, next);
1132                 }
1133         }
1134         vq->last_avail_idx += i;
1135
1136         if (likely(dev->dequeue_zero_copy == 0)) {
1137                 vq->last_used_idx += i;
1138                 update_used_idx(dev, vq, i);
1139         }
1140
1141 out:
1142         if (unlikely(rarp_mbuf != NULL)) {
1143                 /*
1144                  * Inject it to the head of "pkts" array, so that switch's mac
1145                  * learning table will get updated first.
1146                  */
1147                 memmove(&pkts[1], pkts, i * sizeof(struct rte_mbuf *));
1148                 pkts[0] = rarp_mbuf;
1149                 i += 1;
1150         }
1151
1152         return i;
1153 }