vhost: enable rings at the right time
[dpdk.git] / lib / librte_vhost / vhost_user.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 <stdio.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <unistd.h>
39 #include <sys/mman.h>
40 #include <sys/types.h>
41 #include <sys/stat.h>
42 #include <assert.h>
43 #ifdef RTE_LIBRTE_VHOST_NUMA
44 #include <numaif.h>
45 #endif
46
47 #include <rte_common.h>
48 #include <rte_malloc.h>
49 #include <rte_log.h>
50
51 #include "iotlb.h"
52 #include "vhost.h"
53 #include "vhost_user.h"
54
55 #define VIRTIO_MIN_MTU 68
56 #define VIRTIO_MAX_MTU 65535
57
58 static const char *vhost_message_str[VHOST_USER_MAX] = {
59         [VHOST_USER_NONE] = "VHOST_USER_NONE",
60         [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
61         [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
62         [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
63         [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
64         [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
65         [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
66         [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
67         [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
68         [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
69         [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
70         [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
71         [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
72         [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
73         [VHOST_USER_SET_VRING_ERR]  = "VHOST_USER_SET_VRING_ERR",
74         [VHOST_USER_GET_PROTOCOL_FEATURES]  = "VHOST_USER_GET_PROTOCOL_FEATURES",
75         [VHOST_USER_SET_PROTOCOL_FEATURES]  = "VHOST_USER_SET_PROTOCOL_FEATURES",
76         [VHOST_USER_GET_QUEUE_NUM]  = "VHOST_USER_GET_QUEUE_NUM",
77         [VHOST_USER_SET_VRING_ENABLE]  = "VHOST_USER_SET_VRING_ENABLE",
78         [VHOST_USER_SEND_RARP]  = "VHOST_USER_SEND_RARP",
79         [VHOST_USER_NET_SET_MTU]  = "VHOST_USER_NET_SET_MTU",
80         [VHOST_USER_SET_SLAVE_REQ_FD]  = "VHOST_USER_SET_SLAVE_REQ_FD",
81         [VHOST_USER_IOTLB_MSG]  = "VHOST_USER_IOTLB_MSG",
82 };
83
84 static uint64_t
85 get_blk_size(int fd)
86 {
87         struct stat stat;
88         int ret;
89
90         ret = fstat(fd, &stat);
91         return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
92 }
93
94 static void
95 free_mem_region(struct virtio_net *dev)
96 {
97         uint32_t i;
98         struct rte_vhost_mem_region *reg;
99
100         if (!dev || !dev->mem)
101                 return;
102
103         for (i = 0; i < dev->mem->nregions; i++) {
104                 reg = &dev->mem->regions[i];
105                 if (reg->host_user_addr) {
106                         munmap(reg->mmap_addr, reg->mmap_size);
107                         close(reg->fd);
108                 }
109         }
110 }
111
112 void
113 vhost_backend_cleanup(struct virtio_net *dev)
114 {
115         if (dev->mem) {
116                 free_mem_region(dev);
117                 rte_free(dev->mem);
118                 dev->mem = NULL;
119         }
120
121         free(dev->guest_pages);
122         dev->guest_pages = NULL;
123
124         if (dev->log_addr) {
125                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
126                 dev->log_addr = 0;
127         }
128
129         if (dev->slave_req_fd >= 0) {
130                 close(dev->slave_req_fd);
131                 dev->slave_req_fd = -1;
132         }
133 }
134
135 /*
136  * This function just returns success at the moment unless
137  * the device hasn't been initialised.
138  */
139 static int
140 vhost_user_set_owner(void)
141 {
142         return 0;
143 }
144
145 static int
146 vhost_user_reset_owner(struct virtio_net *dev)
147 {
148         if (dev->flags & VIRTIO_DEV_RUNNING) {
149                 dev->flags &= ~VIRTIO_DEV_RUNNING;
150                 dev->notify_ops->destroy_device(dev->vid);
151         }
152
153         cleanup_device(dev, 0);
154         reset_device(dev);
155         return 0;
156 }
157
158 /*
159  * The features that we support are requested.
160  */
161 static uint64_t
162 vhost_user_get_features(struct virtio_net *dev)
163 {
164         uint64_t features = 0;
165
166         rte_vhost_driver_get_features(dev->ifname, &features);
167         return features;
168 }
169
170 /*
171  * We receive the negotiated features supported by us and the virtio device.
172  */
173 static int
174 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
175 {
176         uint64_t vhost_features = 0;
177
178         rte_vhost_driver_get_features(dev->ifname, &vhost_features);
179         if (features & ~vhost_features) {
180                 RTE_LOG(ERR, VHOST_CONFIG,
181                         "(%d) received invalid negotiated features.\n",
182                         dev->vid);
183                 return -1;
184         }
185
186         if ((dev->flags & VIRTIO_DEV_RUNNING) && dev->features != features) {
187                 if (dev->notify_ops->features_changed)
188                         dev->notify_ops->features_changed(dev->vid, features);
189         }
190
191         dev->features = features;
192         if (dev->features &
193                 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
194                 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
195         } else {
196                 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
197         }
198         LOG_DEBUG(VHOST_CONFIG,
199                 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
200                 dev->vid,
201                 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
202                 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
203
204         return 0;
205 }
206
207 /*
208  * The virtio device sends us the size of the descriptor ring.
209  */
210 static int
211 vhost_user_set_vring_num(struct virtio_net *dev,
212                          VhostUserMsg *msg)
213 {
214         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
215
216         vq->size = msg->payload.state.num;
217
218         if (dev->dequeue_zero_copy) {
219                 vq->nr_zmbuf = 0;
220                 vq->last_zmbuf_idx = 0;
221                 vq->zmbuf_size = vq->size;
222                 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
223                                          sizeof(struct zcopy_mbuf), 0);
224                 if (vq->zmbufs == NULL) {
225                         RTE_LOG(WARNING, VHOST_CONFIG,
226                                 "failed to allocate mem for zero copy; "
227                                 "zero copy is force disabled\n");
228                         dev->dequeue_zero_copy = 0;
229                 }
230         }
231
232         vq->shadow_used_ring = rte_malloc(NULL,
233                                 vq->size * sizeof(struct vring_used_elem),
234                                 RTE_CACHE_LINE_SIZE);
235         if (!vq->shadow_used_ring) {
236                 RTE_LOG(ERR, VHOST_CONFIG,
237                         "failed to allocate memory for shadow used ring.\n");
238                 return -1;
239         }
240
241         vq->batch_copy_elems = rte_malloc(NULL,
242                                 vq->size * sizeof(struct batch_copy_elem),
243                                 RTE_CACHE_LINE_SIZE);
244         if (!vq->batch_copy_elems) {
245                 RTE_LOG(ERR, VHOST_CONFIG,
246                         "failed to allocate memory for batching copy.\n");
247                 return -1;
248         }
249
250         return 0;
251 }
252
253 /*
254  * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
255  * same numa node as the memory of vring descriptor.
256  */
257 #ifdef RTE_LIBRTE_VHOST_NUMA
258 static struct virtio_net*
259 numa_realloc(struct virtio_net *dev, int index)
260 {
261         int oldnode, newnode;
262         struct virtio_net *old_dev;
263         struct vhost_virtqueue *old_vq, *vq;
264         int ret;
265
266         old_dev = dev;
267         vq = old_vq = dev->virtqueue[index];
268
269         ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
270                             MPOL_F_NODE | MPOL_F_ADDR);
271
272         /* check if we need to reallocate vq */
273         ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
274                              MPOL_F_NODE | MPOL_F_ADDR);
275         if (ret) {
276                 RTE_LOG(ERR, VHOST_CONFIG,
277                         "Unable to get vq numa information.\n");
278                 return dev;
279         }
280         if (oldnode != newnode) {
281                 RTE_LOG(INFO, VHOST_CONFIG,
282                         "reallocate vq from %d to %d node\n", oldnode, newnode);
283                 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
284                 if (!vq)
285                         return dev;
286
287                 memcpy(vq, old_vq, sizeof(*vq));
288                 rte_free(old_vq);
289         }
290
291         /* check if we need to reallocate dev */
292         ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
293                             MPOL_F_NODE | MPOL_F_ADDR);
294         if (ret) {
295                 RTE_LOG(ERR, VHOST_CONFIG,
296                         "Unable to get dev numa information.\n");
297                 goto out;
298         }
299         if (oldnode != newnode) {
300                 RTE_LOG(INFO, VHOST_CONFIG,
301                         "reallocate dev from %d to %d node\n",
302                         oldnode, newnode);
303                 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
304                 if (!dev) {
305                         dev = old_dev;
306                         goto out;
307                 }
308
309                 memcpy(dev, old_dev, sizeof(*dev));
310                 rte_free(old_dev);
311         }
312
313 out:
314         dev->virtqueue[index] = vq;
315         vhost_devices[dev->vid] = dev;
316
317         return dev;
318 }
319 #else
320 static struct virtio_net*
321 numa_realloc(struct virtio_net *dev, int index __rte_unused)
322 {
323         return dev;
324 }
325 #endif
326
327 /*
328  * Converts QEMU virtual address to Vhost virtual address. This function is
329  * used to convert the ring addresses to our address space.
330  */
331 static uint64_t
332 qva_to_vva(struct virtio_net *dev, uint64_t qva)
333 {
334         struct rte_vhost_mem_region *reg;
335         uint32_t i;
336
337         /* Find the region where the address lives. */
338         for (i = 0; i < dev->mem->nregions; i++) {
339                 reg = &dev->mem->regions[i];
340
341                 if (qva >= reg->guest_user_addr &&
342                     qva <  reg->guest_user_addr + reg->size) {
343                         return qva - reg->guest_user_addr +
344                                reg->host_user_addr;
345                 }
346         }
347
348         return 0;
349 }
350
351 /*
352  * The virtio device sends us the desc, used and avail ring addresses.
353  * This function then converts these to our address space.
354  */
355 static int
356 vhost_user_set_vring_addr(struct virtio_net *dev, VhostUserMsg *msg)
357 {
358         struct vhost_virtqueue *vq;
359
360         if (dev->mem == NULL)
361                 return -1;
362
363         /* addr->index refers to the queue index. The txq 1, rxq is 0. */
364         vq = dev->virtqueue[msg->payload.addr.index];
365
366         /* The addresses are converted from QEMU virtual to Vhost virtual. */
367         vq->desc = (struct vring_desc *)(uintptr_t)qva_to_vva(dev,
368                         msg->payload.addr.desc_user_addr);
369         if (vq->desc == 0) {
370                 RTE_LOG(ERR, VHOST_CONFIG,
371                         "(%d) failed to find desc ring address.\n",
372                         dev->vid);
373                 return -1;
374         }
375
376         dev = numa_realloc(dev, msg->payload.addr.index);
377         vq = dev->virtqueue[msg->payload.addr.index];
378
379         vq->avail = (struct vring_avail *)(uintptr_t)qva_to_vva(dev,
380                         msg->payload.addr.avail_user_addr);
381         if (vq->avail == 0) {
382                 RTE_LOG(ERR, VHOST_CONFIG,
383                         "(%d) failed to find avail ring address.\n",
384                         dev->vid);
385                 return -1;
386         }
387
388         vq->used = (struct vring_used *)(uintptr_t)qva_to_vva(dev,
389                         msg->payload.addr.used_user_addr);
390         if (vq->used == 0) {
391                 RTE_LOG(ERR, VHOST_CONFIG,
392                         "(%d) failed to find used ring address.\n",
393                         dev->vid);
394                 return -1;
395         }
396
397         if (vq->last_used_idx != vq->used->idx) {
398                 RTE_LOG(WARNING, VHOST_CONFIG,
399                         "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
400                         "some packets maybe resent for Tx and dropped for Rx\n",
401                         vq->last_used_idx, vq->used->idx);
402                 vq->last_used_idx  = vq->used->idx;
403                 vq->last_avail_idx = vq->used->idx;
404         }
405
406         vq->log_guest_addr = msg->payload.addr.log_guest_addr;
407
408         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
409                         dev->vid, vq->desc);
410         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
411                         dev->vid, vq->avail);
412         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
413                         dev->vid, vq->used);
414         LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
415                         dev->vid, vq->log_guest_addr);
416
417         return 0;
418 }
419
420 /*
421  * The virtio device sends us the available ring last used index.
422  */
423 static int
424 vhost_user_set_vring_base(struct virtio_net *dev,
425                           VhostUserMsg *msg)
426 {
427         dev->virtqueue[msg->payload.state.index]->last_used_idx  =
428                         msg->payload.state.num;
429         dev->virtqueue[msg->payload.state.index]->last_avail_idx =
430                         msg->payload.state.num;
431
432         return 0;
433 }
434
435 static void
436 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
437                    uint64_t host_phys_addr, uint64_t size)
438 {
439         struct guest_page *page, *last_page;
440
441         if (dev->nr_guest_pages == dev->max_guest_pages) {
442                 dev->max_guest_pages *= 2;
443                 dev->guest_pages = realloc(dev->guest_pages,
444                                         dev->max_guest_pages * sizeof(*page));
445         }
446
447         if (dev->nr_guest_pages > 0) {
448                 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
449                 /* merge if the two pages are continuous */
450                 if (host_phys_addr == last_page->host_phys_addr +
451                                       last_page->size) {
452                         last_page->size += size;
453                         return;
454                 }
455         }
456
457         page = &dev->guest_pages[dev->nr_guest_pages++];
458         page->guest_phys_addr = guest_phys_addr;
459         page->host_phys_addr  = host_phys_addr;
460         page->size = size;
461 }
462
463 static void
464 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
465                 uint64_t page_size)
466 {
467         uint64_t reg_size = reg->size;
468         uint64_t host_user_addr  = reg->host_user_addr;
469         uint64_t guest_phys_addr = reg->guest_phys_addr;
470         uint64_t host_phys_addr;
471         uint64_t size;
472
473         host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)host_user_addr);
474         size = page_size - (guest_phys_addr & (page_size - 1));
475         size = RTE_MIN(size, reg_size);
476
477         add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
478         host_user_addr  += size;
479         guest_phys_addr += size;
480         reg_size -= size;
481
482         while (reg_size > 0) {
483                 size = RTE_MIN(reg_size, page_size);
484                 host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)
485                                                   host_user_addr);
486                 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
487
488                 host_user_addr  += size;
489                 guest_phys_addr += size;
490                 reg_size -= size;
491         }
492 }
493
494 #ifdef RTE_LIBRTE_VHOST_DEBUG
495 /* TODO: enable it only in debug mode? */
496 static void
497 dump_guest_pages(struct virtio_net *dev)
498 {
499         uint32_t i;
500         struct guest_page *page;
501
502         for (i = 0; i < dev->nr_guest_pages; i++) {
503                 page = &dev->guest_pages[i];
504
505                 RTE_LOG(INFO, VHOST_CONFIG,
506                         "guest physical page region %u\n"
507                         "\t guest_phys_addr: %" PRIx64 "\n"
508                         "\t host_phys_addr : %" PRIx64 "\n"
509                         "\t size           : %" PRIx64 "\n",
510                         i,
511                         page->guest_phys_addr,
512                         page->host_phys_addr,
513                         page->size);
514         }
515 }
516 #else
517 #define dump_guest_pages(dev)
518 #endif
519
520 static int
521 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
522 {
523         struct VhostUserMemory memory = pmsg->payload.memory;
524         struct rte_vhost_mem_region *reg;
525         void *mmap_addr;
526         uint64_t mmap_size;
527         uint64_t mmap_offset;
528         uint64_t alignment;
529         uint32_t i;
530         int fd;
531
532         if (dev->mem) {
533                 free_mem_region(dev);
534                 rte_free(dev->mem);
535                 dev->mem = NULL;
536         }
537
538         dev->nr_guest_pages = 0;
539         if (!dev->guest_pages) {
540                 dev->max_guest_pages = 8;
541                 dev->guest_pages = malloc(dev->max_guest_pages *
542                                                 sizeof(struct guest_page));
543                 if (dev->guest_pages == NULL) {
544                         RTE_LOG(ERR, VHOST_CONFIG,
545                                 "(%d) failed to allocate memory "
546                                 "for dev->guest_pages\n",
547                                 dev->vid);
548                         return -1;
549                 }
550         }
551
552         dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
553                 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
554         if (dev->mem == NULL) {
555                 RTE_LOG(ERR, VHOST_CONFIG,
556                         "(%d) failed to allocate memory for dev->mem\n",
557                         dev->vid);
558                 return -1;
559         }
560         dev->mem->nregions = memory.nregions;
561
562         for (i = 0; i < memory.nregions; i++) {
563                 fd  = pmsg->fds[i];
564                 reg = &dev->mem->regions[i];
565
566                 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
567                 reg->guest_user_addr = memory.regions[i].userspace_addr;
568                 reg->size            = memory.regions[i].memory_size;
569                 reg->fd              = fd;
570
571                 mmap_offset = memory.regions[i].mmap_offset;
572                 mmap_size   = reg->size + mmap_offset;
573
574                 /* mmap() without flag of MAP_ANONYMOUS, should be called
575                  * with length argument aligned with hugepagesz at older
576                  * longterm version Linux, like 2.6.32 and 3.2.72, or
577                  * mmap() will fail with EINVAL.
578                  *
579                  * to avoid failure, make sure in caller to keep length
580                  * aligned.
581                  */
582                 alignment = get_blk_size(fd);
583                 if (alignment == (uint64_t)-1) {
584                         RTE_LOG(ERR, VHOST_CONFIG,
585                                 "couldn't get hugepage size through fstat\n");
586                         goto err_mmap;
587                 }
588                 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
589
590                 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
591                                  MAP_SHARED | MAP_POPULATE, fd, 0);
592
593                 if (mmap_addr == MAP_FAILED) {
594                         RTE_LOG(ERR, VHOST_CONFIG,
595                                 "mmap region %u failed.\n", i);
596                         goto err_mmap;
597                 }
598
599                 reg->mmap_addr = mmap_addr;
600                 reg->mmap_size = mmap_size;
601                 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
602                                       mmap_offset;
603
604                 if (dev->dequeue_zero_copy)
605                         add_guest_pages(dev, reg, alignment);
606
607                 RTE_LOG(INFO, VHOST_CONFIG,
608                         "guest memory region %u, size: 0x%" PRIx64 "\n"
609                         "\t guest physical addr: 0x%" PRIx64 "\n"
610                         "\t guest virtual  addr: 0x%" PRIx64 "\n"
611                         "\t host  virtual  addr: 0x%" PRIx64 "\n"
612                         "\t mmap addr : 0x%" PRIx64 "\n"
613                         "\t mmap size : 0x%" PRIx64 "\n"
614                         "\t mmap align: 0x%" PRIx64 "\n"
615                         "\t mmap off  : 0x%" PRIx64 "\n",
616                         i, reg->size,
617                         reg->guest_phys_addr,
618                         reg->guest_user_addr,
619                         reg->host_user_addr,
620                         (uint64_t)(uintptr_t)mmap_addr,
621                         mmap_size,
622                         alignment,
623                         mmap_offset);
624         }
625
626         dump_guest_pages(dev);
627
628         return 0;
629
630 err_mmap:
631         free_mem_region(dev);
632         rte_free(dev->mem);
633         dev->mem = NULL;
634         return -1;
635 }
636
637 static int
638 vq_is_ready(struct vhost_virtqueue *vq)
639 {
640         return vq && vq->desc   &&
641                vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
642                vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
643 }
644
645 static int
646 virtio_is_ready(struct virtio_net *dev)
647 {
648         struct vhost_virtqueue *vq;
649         uint32_t i;
650
651         if (dev->nr_vring == 0)
652                 return 0;
653
654         for (i = 0; i < dev->nr_vring; i++) {
655                 vq = dev->virtqueue[i];
656
657                 if (!vq_is_ready(vq))
658                         return 0;
659         }
660
661         RTE_LOG(INFO, VHOST_CONFIG,
662                 "virtio is now ready for processing.\n");
663         return 1;
664 }
665
666 static void
667 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
668 {
669         struct vhost_vring_file file;
670         struct vhost_virtqueue *vq;
671
672         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
673         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
674                 file.fd = VIRTIO_INVALID_EVENTFD;
675         else
676                 file.fd = pmsg->fds[0];
677         RTE_LOG(INFO, VHOST_CONFIG,
678                 "vring call idx:%d file:%d\n", file.index, file.fd);
679
680         vq = dev->virtqueue[file.index];
681         if (vq->callfd >= 0)
682                 close(vq->callfd);
683
684         vq->callfd = file.fd;
685 }
686
687 static void
688 vhost_user_set_vring_kick(struct virtio_net *dev, struct VhostUserMsg *pmsg)
689 {
690         struct vhost_vring_file file;
691         struct vhost_virtqueue *vq;
692
693         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
694         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
695                 file.fd = VIRTIO_INVALID_EVENTFD;
696         else
697                 file.fd = pmsg->fds[0];
698         RTE_LOG(INFO, VHOST_CONFIG,
699                 "vring kick idx:%d file:%d\n", file.index, file.fd);
700
701         vq = dev->virtqueue[file.index];
702
703         /*
704          * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
705          * the ring starts already enabled. Otherwise, it is enabled via
706          * the SET_VRING_ENABLE message.
707          */
708         if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
709                 vq->enabled = 1;
710
711         if (vq->kickfd >= 0)
712                 close(vq->kickfd);
713         vq->kickfd = file.fd;
714 }
715
716 static void
717 free_zmbufs(struct vhost_virtqueue *vq)
718 {
719         struct zcopy_mbuf *zmbuf, *next;
720
721         for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
722              zmbuf != NULL; zmbuf = next) {
723                 next = TAILQ_NEXT(zmbuf, next);
724
725                 rte_pktmbuf_free(zmbuf->mbuf);
726                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
727         }
728
729         rte_free(vq->zmbufs);
730 }
731
732 /*
733  * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
734  */
735 static int
736 vhost_user_get_vring_base(struct virtio_net *dev,
737                           VhostUserMsg *msg)
738 {
739         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
740
741         /* We have to stop the queue (virtio) if it is running. */
742         if (dev->flags & VIRTIO_DEV_RUNNING) {
743                 dev->flags &= ~VIRTIO_DEV_RUNNING;
744                 dev->notify_ops->destroy_device(dev->vid);
745         }
746
747         dev->flags &= ~VIRTIO_DEV_READY;
748
749         /* Here we are safe to get the last used index */
750         msg->payload.state.num = vq->last_used_idx;
751
752         RTE_LOG(INFO, VHOST_CONFIG,
753                 "vring base idx:%d file:%d\n", msg->payload.state.index,
754                 msg->payload.state.num);
755         /*
756          * Based on current qemu vhost-user implementation, this message is
757          * sent and only sent in vhost_vring_stop.
758          * TODO: cleanup the vring, it isn't usable since here.
759          */
760         if (vq->kickfd >= 0)
761                 close(vq->kickfd);
762
763         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
764
765         if (dev->dequeue_zero_copy)
766                 free_zmbufs(vq);
767         rte_free(vq->shadow_used_ring);
768         vq->shadow_used_ring = NULL;
769
770         rte_free(vq->batch_copy_elems);
771         vq->batch_copy_elems = NULL;
772
773         return 0;
774 }
775
776 /*
777  * when virtio queues are ready to work, qemu will send us to
778  * enable the virtio queue pair.
779  */
780 static int
781 vhost_user_set_vring_enable(struct virtio_net *dev,
782                             VhostUserMsg *msg)
783 {
784         int enable = (int)msg->payload.state.num;
785
786         RTE_LOG(INFO, VHOST_CONFIG,
787                 "set queue enable: %d to qp idx: %d\n",
788                 enable, msg->payload.state.index);
789
790         if (dev->notify_ops->vring_state_changed)
791                 dev->notify_ops->vring_state_changed(dev->vid,
792                                 msg->payload.state.index, enable);
793
794         dev->virtqueue[msg->payload.state.index]->enabled = enable;
795
796         return 0;
797 }
798
799 static void
800 vhost_user_set_protocol_features(struct virtio_net *dev,
801                                  uint64_t protocol_features)
802 {
803         if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
804                 return;
805
806         dev->protocol_features = protocol_features;
807 }
808
809 static int
810 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
811 {
812         int fd = msg->fds[0];
813         uint64_t size, off;
814         void *addr;
815
816         if (fd < 0) {
817                 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
818                 return -1;
819         }
820
821         if (msg->size != sizeof(VhostUserLog)) {
822                 RTE_LOG(ERR, VHOST_CONFIG,
823                         "invalid log base msg size: %"PRId32" != %d\n",
824                         msg->size, (int)sizeof(VhostUserLog));
825                 return -1;
826         }
827
828         size = msg->payload.log.mmap_size;
829         off  = msg->payload.log.mmap_offset;
830         RTE_LOG(INFO, VHOST_CONFIG,
831                 "log mmap size: %"PRId64", offset: %"PRId64"\n",
832                 size, off);
833
834         /*
835          * mmap from 0 to workaround a hugepage mmap bug: mmap will
836          * fail when offset is not page size aligned.
837          */
838         addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
839         close(fd);
840         if (addr == MAP_FAILED) {
841                 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
842                 return -1;
843         }
844
845         /*
846          * Free previously mapped log memory on occasionally
847          * multiple VHOST_USER_SET_LOG_BASE.
848          */
849         if (dev->log_addr) {
850                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
851         }
852         dev->log_addr = (uint64_t)(uintptr_t)addr;
853         dev->log_base = dev->log_addr + off;
854         dev->log_size = size;
855
856         return 0;
857 }
858
859 /*
860  * An rarp packet is constructed and broadcasted to notify switches about
861  * the new location of the migrated VM, so that packets from outside will
862  * not be lost after migration.
863  *
864  * However, we don't actually "send" a rarp packet here, instead, we set
865  * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
866  */
867 static int
868 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
869 {
870         uint8_t *mac = (uint8_t *)&msg->payload.u64;
871
872         RTE_LOG(DEBUG, VHOST_CONFIG,
873                 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
874                 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
875         memcpy(dev->mac.addr_bytes, mac, 6);
876
877         /*
878          * Set the flag to inject a RARP broadcast packet at
879          * rte_vhost_dequeue_burst().
880          *
881          * rte_smp_wmb() is for making sure the mac is copied
882          * before the flag is set.
883          */
884         rte_smp_wmb();
885         rte_atomic16_set(&dev->broadcast_rarp, 1);
886
887         return 0;
888 }
889
890 static int
891 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
892 {
893         if (msg->payload.u64 < VIRTIO_MIN_MTU ||
894                         msg->payload.u64 > VIRTIO_MAX_MTU) {
895                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
896                                 msg->payload.u64);
897
898                 return -1;
899         }
900
901         dev->mtu = msg->payload.u64;
902
903         return 0;
904 }
905
906 static int
907 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
908 {
909         int fd = msg->fds[0];
910
911         if (fd < 0) {
912                 RTE_LOG(ERR, VHOST_CONFIG,
913                                 "Invalid file descriptor for slave channel (%d)\n",
914                                 fd);
915                 return -1;
916         }
917
918         dev->slave_req_fd = fd;
919
920         return 0;
921 }
922
923 static int
924 vhost_user_iotlb_msg(struct virtio_net *dev, struct VhostUserMsg *msg)
925 {
926         struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
927         uint16_t i;
928         uint64_t vva;
929
930         switch (imsg->type) {
931         case VHOST_IOTLB_UPDATE:
932                 vva = qva_to_vva(dev, imsg->uaddr);
933                 if (!vva)
934                         return -1;
935
936                 for (i = 0; i < dev->nr_vring; i++) {
937                         struct vhost_virtqueue *vq = dev->virtqueue[i];
938
939                         vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
940                                         imsg->size, imsg->perm);
941                 }
942                 break;
943         case VHOST_IOTLB_INVALIDATE:
944                 for (i = 0; i < dev->nr_vring; i++) {
945                         struct vhost_virtqueue *vq = dev->virtqueue[i];
946
947                         vhost_user_iotlb_cache_remove(vq, imsg->iova,
948                                         imsg->size);
949                 }
950                 break;
951         default:
952                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
953                                 imsg->type);
954                 return -1;
955         }
956
957         return 0;
958 }
959
960 /* return bytes# of read on success or negative val on failure. */
961 static int
962 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
963 {
964         int ret;
965
966         ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
967                 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
968         if (ret <= 0)
969                 return ret;
970
971         if (msg && msg->size) {
972                 if (msg->size > sizeof(msg->payload)) {
973                         RTE_LOG(ERR, VHOST_CONFIG,
974                                 "invalid msg size: %d\n", msg->size);
975                         return -1;
976                 }
977                 ret = read(sockfd, &msg->payload, msg->size);
978                 if (ret <= 0)
979                         return ret;
980                 if (ret != (int)msg->size) {
981                         RTE_LOG(ERR, VHOST_CONFIG,
982                                 "read control message failed\n");
983                         return -1;
984                 }
985         }
986
987         return ret;
988 }
989
990 static int
991 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
992 {
993         if (!msg)
994                 return 0;
995
996         return send_fd_message(sockfd, (char *)msg,
997                 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
998 }
999
1000 static int
1001 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1002 {
1003         if (!msg)
1004                 return 0;
1005
1006         msg->flags &= ~VHOST_USER_VERSION_MASK;
1007         msg->flags &= ~VHOST_USER_NEED_REPLY;
1008         msg->flags |= VHOST_USER_VERSION;
1009         msg->flags |= VHOST_USER_REPLY_MASK;
1010
1011         return send_vhost_message(sockfd, msg);
1012 }
1013
1014 /*
1015  * Allocate a queue pair if it hasn't been allocated yet
1016  */
1017 static int
1018 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1019 {
1020         uint16_t vring_idx;
1021
1022         switch (msg->request) {
1023         case VHOST_USER_SET_VRING_KICK:
1024         case VHOST_USER_SET_VRING_CALL:
1025         case VHOST_USER_SET_VRING_ERR:
1026                 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1027                 break;
1028         case VHOST_USER_SET_VRING_NUM:
1029         case VHOST_USER_SET_VRING_BASE:
1030         case VHOST_USER_SET_VRING_ENABLE:
1031                 vring_idx = msg->payload.state.index;
1032                 break;
1033         case VHOST_USER_SET_VRING_ADDR:
1034                 vring_idx = msg->payload.addr.index;
1035                 break;
1036         default:
1037                 return 0;
1038         }
1039
1040         if (vring_idx >= VHOST_MAX_VRING) {
1041                 RTE_LOG(ERR, VHOST_CONFIG,
1042                         "invalid vring index: %u\n", vring_idx);
1043                 return -1;
1044         }
1045
1046         if (dev->virtqueue[vring_idx])
1047                 return 0;
1048
1049         return alloc_vring_queue(dev, vring_idx);
1050 }
1051
1052 int
1053 vhost_user_msg_handler(int vid, int fd)
1054 {
1055         struct virtio_net *dev;
1056         struct VhostUserMsg msg;
1057         int ret;
1058
1059         dev = get_device(vid);
1060         if (dev == NULL)
1061                 return -1;
1062
1063         if (!dev->notify_ops) {
1064                 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1065                 if (!dev->notify_ops) {
1066                         RTE_LOG(ERR, VHOST_CONFIG,
1067                                 "failed to get callback ops for driver %s\n",
1068                                 dev->ifname);
1069                         return -1;
1070                 }
1071         }
1072
1073         ret = read_vhost_message(fd, &msg);
1074         if (ret <= 0 || msg.request >= VHOST_USER_MAX) {
1075                 if (ret < 0)
1076                         RTE_LOG(ERR, VHOST_CONFIG,
1077                                 "vhost read message failed\n");
1078                 else if (ret == 0)
1079                         RTE_LOG(INFO, VHOST_CONFIG,
1080                                 "vhost peer closed\n");
1081                 else
1082                         RTE_LOG(ERR, VHOST_CONFIG,
1083                                 "vhost read incorrect message\n");
1084
1085                 return -1;
1086         }
1087
1088         ret = 0;
1089         RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1090                 vhost_message_str[msg.request]);
1091
1092         ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1093         if (ret < 0) {
1094                 RTE_LOG(ERR, VHOST_CONFIG,
1095                         "failed to alloc queue\n");
1096                 return -1;
1097         }
1098
1099         switch (msg.request) {
1100         case VHOST_USER_GET_FEATURES:
1101                 msg.payload.u64 = vhost_user_get_features(dev);
1102                 msg.size = sizeof(msg.payload.u64);
1103                 send_vhost_reply(fd, &msg);
1104                 break;
1105         case VHOST_USER_SET_FEATURES:
1106                 vhost_user_set_features(dev, msg.payload.u64);
1107                 break;
1108
1109         case VHOST_USER_GET_PROTOCOL_FEATURES:
1110                 msg.payload.u64 = VHOST_USER_PROTOCOL_FEATURES;
1111                 msg.size = sizeof(msg.payload.u64);
1112                 send_vhost_reply(fd, &msg);
1113                 break;
1114         case VHOST_USER_SET_PROTOCOL_FEATURES:
1115                 vhost_user_set_protocol_features(dev, msg.payload.u64);
1116                 break;
1117
1118         case VHOST_USER_SET_OWNER:
1119                 vhost_user_set_owner();
1120                 break;
1121         case VHOST_USER_RESET_OWNER:
1122                 vhost_user_reset_owner(dev);
1123                 break;
1124
1125         case VHOST_USER_SET_MEM_TABLE:
1126                 ret = vhost_user_set_mem_table(dev, &msg);
1127                 break;
1128
1129         case VHOST_USER_SET_LOG_BASE:
1130                 vhost_user_set_log_base(dev, &msg);
1131
1132                 /* it needs a reply */
1133                 msg.size = sizeof(msg.payload.u64);
1134                 send_vhost_reply(fd, &msg);
1135                 break;
1136         case VHOST_USER_SET_LOG_FD:
1137                 close(msg.fds[0]);
1138                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1139                 break;
1140
1141         case VHOST_USER_SET_VRING_NUM:
1142                 vhost_user_set_vring_num(dev, &msg);
1143                 break;
1144         case VHOST_USER_SET_VRING_ADDR:
1145                 vhost_user_set_vring_addr(dev, &msg);
1146                 break;
1147         case VHOST_USER_SET_VRING_BASE:
1148                 vhost_user_set_vring_base(dev, &msg);
1149                 break;
1150
1151         case VHOST_USER_GET_VRING_BASE:
1152                 vhost_user_get_vring_base(dev, &msg);
1153                 msg.size = sizeof(msg.payload.state);
1154                 send_vhost_reply(fd, &msg);
1155                 break;
1156
1157         case VHOST_USER_SET_VRING_KICK:
1158                 vhost_user_set_vring_kick(dev, &msg);
1159                 break;
1160         case VHOST_USER_SET_VRING_CALL:
1161                 vhost_user_set_vring_call(dev, &msg);
1162                 break;
1163
1164         case VHOST_USER_SET_VRING_ERR:
1165                 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1166                         close(msg.fds[0]);
1167                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1168                 break;
1169
1170         case VHOST_USER_GET_QUEUE_NUM:
1171                 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1172                 msg.size = sizeof(msg.payload.u64);
1173                 send_vhost_reply(fd, &msg);
1174                 break;
1175
1176         case VHOST_USER_SET_VRING_ENABLE:
1177                 vhost_user_set_vring_enable(dev, &msg);
1178                 break;
1179         case VHOST_USER_SEND_RARP:
1180                 vhost_user_send_rarp(dev, &msg);
1181                 break;
1182
1183         case VHOST_USER_NET_SET_MTU:
1184                 ret = vhost_user_net_set_mtu(dev, &msg);
1185                 break;
1186
1187         case VHOST_USER_SET_SLAVE_REQ_FD:
1188                 ret = vhost_user_set_req_fd(dev, &msg);
1189                 break;
1190
1191         case VHOST_USER_IOTLB_MSG:
1192                 ret = vhost_user_iotlb_msg(dev, &msg);
1193                 break;
1194
1195         default:
1196                 ret = -1;
1197                 break;
1198
1199         }
1200
1201         if (msg.flags & VHOST_USER_NEED_REPLY) {
1202                 msg.payload.u64 = !!ret;
1203                 msg.size = sizeof(msg.payload.u64);
1204                 send_vhost_reply(fd, &msg);
1205         }
1206
1207         if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1208                 dev->flags |= VIRTIO_DEV_READY;
1209
1210                 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1211                         if (dev->dequeue_zero_copy) {
1212                                 RTE_LOG(INFO, VHOST_CONFIG,
1213                                                 "dequeue zero copy is enabled\n");
1214                         }
1215
1216                         if (dev->notify_ops->new_device(dev->vid) == 0)
1217                                 dev->flags |= VIRTIO_DEV_RUNNING;
1218                 }
1219         }
1220
1221         return 0;
1222 }
1223
1224 int
1225 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1226 {
1227         int ret;
1228         struct VhostUserMsg msg = {
1229                 .request = (enum VhostUserRequest)VHOST_USER_SLAVE_IOTLB_MSG,
1230                 .flags = VHOST_USER_VERSION,
1231                 .size = sizeof(msg.payload.iotlb),
1232                 .payload.iotlb = {
1233                         .iova = iova,
1234                         .perm = perm,
1235                         .type = VHOST_IOTLB_MISS,
1236                 },
1237         };
1238
1239         ret = send_vhost_message(dev->slave_req_fd, &msg);
1240         if (ret < 0) {
1241                 RTE_LOG(ERR, VHOST_CONFIG,
1242                                 "Failed to send IOTLB miss message (%d)\n",
1243                                 ret);
1244                 return ret;
1245         }
1246
1247         return 0;
1248 }