New upstream version 17.11.1
[deb_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         if (old_vq != vq)
318                 vhost_user_iotlb_init(dev, index);
319
320         return dev;
321 }
322 #else
323 static struct virtio_net*
324 numa_realloc(struct virtio_net *dev, int index __rte_unused)
325 {
326         return dev;
327 }
328 #endif
329
330 /* Converts QEMU virtual address to Vhost virtual address. */
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 /*
353  * Converts ring address to Vhost virtual address.
354  * If IOMMU is enabled, the ring address is a guest IO virtual address,
355  * else it is a QEMU virtual address.
356  */
357 static uint64_t
358 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
359                 uint64_t ra, uint64_t size)
360 {
361         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
362                 uint64_t vva;
363
364                 vva = vhost_user_iotlb_cache_find(vq, ra,
365                                         &size, VHOST_ACCESS_RW);
366                 if (!vva)
367                         vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
368
369                 return vva;
370         }
371
372         return qva_to_vva(dev, ra);
373 }
374
375 static struct virtio_net *
376 translate_ring_addresses(struct virtio_net *dev, int vq_index)
377 {
378         struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
379         struct vhost_vring_addr *addr = &vq->ring_addrs;
380
381         /* The addresses are converted from QEMU virtual to Vhost virtual. */
382         if (vq->desc && vq->avail && vq->used)
383                 return dev;
384
385         vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
386                         vq, addr->desc_user_addr, sizeof(struct vring_desc));
387         if (vq->desc == 0) {
388                 RTE_LOG(DEBUG, VHOST_CONFIG,
389                         "(%d) failed to find desc ring address.\n",
390                         dev->vid);
391                 return dev;
392         }
393
394         dev = numa_realloc(dev, vq_index);
395         vq = dev->virtqueue[vq_index];
396         addr = &vq->ring_addrs;
397
398         vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
399                         vq, addr->avail_user_addr, sizeof(struct vring_avail));
400         if (vq->avail == 0) {
401                 RTE_LOG(DEBUG, VHOST_CONFIG,
402                         "(%d) failed to find avail ring address.\n",
403                         dev->vid);
404                 return dev;
405         }
406
407         vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
408                         vq, addr->used_user_addr, sizeof(struct vring_used));
409         if (vq->used == 0) {
410                 RTE_LOG(DEBUG, VHOST_CONFIG,
411                         "(%d) failed to find used ring address.\n",
412                         dev->vid);
413                 return dev;
414         }
415
416         if (vq->last_used_idx != vq->used->idx) {
417                 RTE_LOG(WARNING, VHOST_CONFIG,
418                         "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
419                         "some packets maybe resent for Tx and dropped for Rx\n",
420                         vq->last_used_idx, vq->used->idx);
421                 vq->last_used_idx  = vq->used->idx;
422                 vq->last_avail_idx = vq->used->idx;
423         }
424
425         vq->log_guest_addr = addr->log_guest_addr;
426
427         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
428                         dev->vid, vq->desc);
429         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
430                         dev->vid, vq->avail);
431         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
432                         dev->vid, vq->used);
433         LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
434                         dev->vid, vq->log_guest_addr);
435
436         return dev;
437 }
438
439 /*
440  * The virtio device sends us the desc, used and avail ring addresses.
441  * This function then converts these to our address space.
442  */
443 static int
444 vhost_user_set_vring_addr(struct virtio_net **pdev, VhostUserMsg *msg)
445 {
446         struct vhost_virtqueue *vq;
447         struct vhost_vring_addr *addr = &msg->payload.addr;
448         struct virtio_net *dev = *pdev;
449
450         if (dev->mem == NULL)
451                 return -1;
452
453         /* addr->index refers to the queue index. The txq 1, rxq is 0. */
454         vq = dev->virtqueue[msg->payload.addr.index];
455
456         /*
457          * Rings addresses should not be interpreted as long as the ring is not
458          * started and enabled
459          */
460         memcpy(&vq->ring_addrs, addr, sizeof(*addr));
461
462         vring_invalidate(dev, vq);
463
464         if (vq->enabled && (dev->features &
465                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
466                 dev = translate_ring_addresses(dev, msg->payload.state.index);
467                 if (!dev)
468                         return -1;
469
470                 *pdev = dev;
471         }
472
473         return 0;
474 }
475
476 /*
477  * The virtio device sends us the available ring last used index.
478  */
479 static int
480 vhost_user_set_vring_base(struct virtio_net *dev,
481                           VhostUserMsg *msg)
482 {
483         dev->virtqueue[msg->payload.state.index]->last_used_idx  =
484                         msg->payload.state.num;
485         dev->virtqueue[msg->payload.state.index]->last_avail_idx =
486                         msg->payload.state.num;
487
488         return 0;
489 }
490
491 static void
492 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
493                    uint64_t host_phys_addr, uint64_t size)
494 {
495         struct guest_page *page, *last_page;
496
497         if (dev->nr_guest_pages == dev->max_guest_pages) {
498                 dev->max_guest_pages *= 2;
499                 dev->guest_pages = realloc(dev->guest_pages,
500                                         dev->max_guest_pages * sizeof(*page));
501         }
502
503         if (dev->nr_guest_pages > 0) {
504                 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
505                 /* merge if the two pages are continuous */
506                 if (host_phys_addr == last_page->host_phys_addr +
507                                       last_page->size) {
508                         last_page->size += size;
509                         return;
510                 }
511         }
512
513         page = &dev->guest_pages[dev->nr_guest_pages++];
514         page->guest_phys_addr = guest_phys_addr;
515         page->host_phys_addr  = host_phys_addr;
516         page->size = size;
517 }
518
519 static void
520 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
521                 uint64_t page_size)
522 {
523         uint64_t reg_size = reg->size;
524         uint64_t host_user_addr  = reg->host_user_addr;
525         uint64_t guest_phys_addr = reg->guest_phys_addr;
526         uint64_t host_phys_addr;
527         uint64_t size;
528
529         host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
530         size = page_size - (guest_phys_addr & (page_size - 1));
531         size = RTE_MIN(size, reg_size);
532
533         add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
534         host_user_addr  += size;
535         guest_phys_addr += size;
536         reg_size -= size;
537
538         while (reg_size > 0) {
539                 size = RTE_MIN(reg_size, page_size);
540                 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
541                                                   host_user_addr);
542                 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
543
544                 host_user_addr  += size;
545                 guest_phys_addr += size;
546                 reg_size -= size;
547         }
548 }
549
550 #ifdef RTE_LIBRTE_VHOST_DEBUG
551 /* TODO: enable it only in debug mode? */
552 static void
553 dump_guest_pages(struct virtio_net *dev)
554 {
555         uint32_t i;
556         struct guest_page *page;
557
558         for (i = 0; i < dev->nr_guest_pages; i++) {
559                 page = &dev->guest_pages[i];
560
561                 RTE_LOG(INFO, VHOST_CONFIG,
562                         "guest physical page region %u\n"
563                         "\t guest_phys_addr: %" PRIx64 "\n"
564                         "\t host_phys_addr : %" PRIx64 "\n"
565                         "\t size           : %" PRIx64 "\n",
566                         i,
567                         page->guest_phys_addr,
568                         page->host_phys_addr,
569                         page->size);
570         }
571 }
572 #else
573 #define dump_guest_pages(dev)
574 #endif
575
576 static bool
577 vhost_memory_changed(struct VhostUserMemory *new,
578                      struct rte_vhost_memory *old)
579 {
580         uint32_t i;
581
582         if (new->nregions != old->nregions)
583                 return true;
584
585         for (i = 0; i < new->nregions; ++i) {
586                 VhostUserMemoryRegion *new_r = &new->regions[i];
587                 struct rte_vhost_mem_region *old_r = &old->regions[i];
588
589                 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
590                         return true;
591                 if (new_r->memory_size != old_r->size)
592                         return true;
593                 if (new_r->userspace_addr != old_r->guest_user_addr)
594                         return true;
595         }
596
597         return false;
598 }
599
600 static int
601 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
602 {
603         struct VhostUserMemory memory = pmsg->payload.memory;
604         struct rte_vhost_mem_region *reg;
605         void *mmap_addr;
606         uint64_t mmap_size;
607         uint64_t mmap_offset;
608         uint64_t alignment;
609         uint32_t i;
610         int fd;
611
612         if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
613                 RTE_LOG(INFO, VHOST_CONFIG,
614                         "(%d) memory regions not changed\n", dev->vid);
615
616                 for (i = 0; i < memory.nregions; i++)
617                         close(pmsg->fds[i]);
618
619                 return 0;
620         }
621
622         if (dev->mem) {
623                 free_mem_region(dev);
624                 rte_free(dev->mem);
625                 dev->mem = NULL;
626         }
627
628         dev->nr_guest_pages = 0;
629         if (!dev->guest_pages) {
630                 dev->max_guest_pages = 8;
631                 dev->guest_pages = malloc(dev->max_guest_pages *
632                                                 sizeof(struct guest_page));
633                 if (dev->guest_pages == NULL) {
634                         RTE_LOG(ERR, VHOST_CONFIG,
635                                 "(%d) failed to allocate memory "
636                                 "for dev->guest_pages\n",
637                                 dev->vid);
638                         return -1;
639                 }
640         }
641
642         dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
643                 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
644         if (dev->mem == NULL) {
645                 RTE_LOG(ERR, VHOST_CONFIG,
646                         "(%d) failed to allocate memory for dev->mem\n",
647                         dev->vid);
648                 return -1;
649         }
650         dev->mem->nregions = memory.nregions;
651
652         for (i = 0; i < memory.nregions; i++) {
653                 fd  = pmsg->fds[i];
654                 reg = &dev->mem->regions[i];
655
656                 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
657                 reg->guest_user_addr = memory.regions[i].userspace_addr;
658                 reg->size            = memory.regions[i].memory_size;
659                 reg->fd              = fd;
660
661                 mmap_offset = memory.regions[i].mmap_offset;
662                 mmap_size   = reg->size + mmap_offset;
663
664                 /* mmap() without flag of MAP_ANONYMOUS, should be called
665                  * with length argument aligned with hugepagesz at older
666                  * longterm version Linux, like 2.6.32 and 3.2.72, or
667                  * mmap() will fail with EINVAL.
668                  *
669                  * to avoid failure, make sure in caller to keep length
670                  * aligned.
671                  */
672                 alignment = get_blk_size(fd);
673                 if (alignment == (uint64_t)-1) {
674                         RTE_LOG(ERR, VHOST_CONFIG,
675                                 "couldn't get hugepage size through fstat\n");
676                         goto err_mmap;
677                 }
678                 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
679
680                 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
681                                  MAP_SHARED | MAP_POPULATE, fd, 0);
682
683                 if (mmap_addr == MAP_FAILED) {
684                         RTE_LOG(ERR, VHOST_CONFIG,
685                                 "mmap region %u failed.\n", i);
686                         goto err_mmap;
687                 }
688
689                 reg->mmap_addr = mmap_addr;
690                 reg->mmap_size = mmap_size;
691                 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
692                                       mmap_offset;
693
694                 if (dev->dequeue_zero_copy)
695                         add_guest_pages(dev, reg, alignment);
696
697                 RTE_LOG(INFO, VHOST_CONFIG,
698                         "guest memory region %u, size: 0x%" PRIx64 "\n"
699                         "\t guest physical addr: 0x%" PRIx64 "\n"
700                         "\t guest virtual  addr: 0x%" PRIx64 "\n"
701                         "\t host  virtual  addr: 0x%" PRIx64 "\n"
702                         "\t mmap addr : 0x%" PRIx64 "\n"
703                         "\t mmap size : 0x%" PRIx64 "\n"
704                         "\t mmap align: 0x%" PRIx64 "\n"
705                         "\t mmap off  : 0x%" PRIx64 "\n",
706                         i, reg->size,
707                         reg->guest_phys_addr,
708                         reg->guest_user_addr,
709                         reg->host_user_addr,
710                         (uint64_t)(uintptr_t)mmap_addr,
711                         mmap_size,
712                         alignment,
713                         mmap_offset);
714         }
715
716         dump_guest_pages(dev);
717
718         return 0;
719
720 err_mmap:
721         free_mem_region(dev);
722         rte_free(dev->mem);
723         dev->mem = NULL;
724         return -1;
725 }
726
727 static int
728 vq_is_ready(struct vhost_virtqueue *vq)
729 {
730         return vq && vq->desc && vq->avail && vq->used &&
731                vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
732                vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
733 }
734
735 static int
736 virtio_is_ready(struct virtio_net *dev)
737 {
738         struct vhost_virtqueue *vq;
739         uint32_t i;
740
741         if (dev->nr_vring == 0)
742                 return 0;
743
744         for (i = 0; i < dev->nr_vring; i++) {
745                 vq = dev->virtqueue[i];
746
747                 if (!vq_is_ready(vq))
748                         return 0;
749         }
750
751         RTE_LOG(INFO, VHOST_CONFIG,
752                 "virtio is now ready for processing.\n");
753         return 1;
754 }
755
756 static void
757 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
758 {
759         struct vhost_vring_file file;
760         struct vhost_virtqueue *vq;
761
762         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
763         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
764                 file.fd = VIRTIO_INVALID_EVENTFD;
765         else
766                 file.fd = pmsg->fds[0];
767         RTE_LOG(INFO, VHOST_CONFIG,
768                 "vring call idx:%d file:%d\n", file.index, file.fd);
769
770         vq = dev->virtqueue[file.index];
771         if (vq->callfd >= 0)
772                 close(vq->callfd);
773
774         vq->callfd = file.fd;
775 }
776
777 static void
778 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
779 {
780         struct vhost_vring_file file;
781         struct vhost_virtqueue *vq;
782         struct virtio_net *dev = *pdev;
783
784         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
785         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
786                 file.fd = VIRTIO_INVALID_EVENTFD;
787         else
788                 file.fd = pmsg->fds[0];
789         RTE_LOG(INFO, VHOST_CONFIG,
790                 "vring kick idx:%d file:%d\n", file.index, file.fd);
791
792         /* Interpret ring addresses only when ring is started. */
793         dev = translate_ring_addresses(dev, file.index);
794         if (!dev)
795                 return;
796
797         *pdev = dev;
798
799         vq = dev->virtqueue[file.index];
800
801         /*
802          * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
803          * the ring starts already enabled. Otherwise, it is enabled via
804          * the SET_VRING_ENABLE message.
805          */
806         if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
807                 vq->enabled = 1;
808
809         if (vq->kickfd >= 0)
810                 close(vq->kickfd);
811         vq->kickfd = file.fd;
812 }
813
814 static void
815 free_zmbufs(struct vhost_virtqueue *vq)
816 {
817         struct zcopy_mbuf *zmbuf, *next;
818
819         for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
820              zmbuf != NULL; zmbuf = next) {
821                 next = TAILQ_NEXT(zmbuf, next);
822
823                 rte_pktmbuf_free(zmbuf->mbuf);
824                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
825         }
826
827         rte_free(vq->zmbufs);
828 }
829
830 /*
831  * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
832  */
833 static int
834 vhost_user_get_vring_base(struct virtio_net *dev,
835                           VhostUserMsg *msg)
836 {
837         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
838
839         /* We have to stop the queue (virtio) if it is running. */
840         if (dev->flags & VIRTIO_DEV_RUNNING) {
841                 dev->flags &= ~VIRTIO_DEV_RUNNING;
842                 dev->notify_ops->destroy_device(dev->vid);
843         }
844
845         dev->flags &= ~VIRTIO_DEV_READY;
846
847         /* Here we are safe to get the last used index */
848         msg->payload.state.num = vq->last_used_idx;
849
850         RTE_LOG(INFO, VHOST_CONFIG,
851                 "vring base idx:%d file:%d\n", msg->payload.state.index,
852                 msg->payload.state.num);
853         /*
854          * Based on current qemu vhost-user implementation, this message is
855          * sent and only sent in vhost_vring_stop.
856          * TODO: cleanup the vring, it isn't usable since here.
857          */
858         if (vq->kickfd >= 0)
859                 close(vq->kickfd);
860
861         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
862
863         if (dev->dequeue_zero_copy)
864                 free_zmbufs(vq);
865         rte_free(vq->shadow_used_ring);
866         vq->shadow_used_ring = NULL;
867
868         rte_free(vq->batch_copy_elems);
869         vq->batch_copy_elems = NULL;
870
871         return 0;
872 }
873
874 /*
875  * when virtio queues are ready to work, qemu will send us to
876  * enable the virtio queue pair.
877  */
878 static int
879 vhost_user_set_vring_enable(struct virtio_net *dev,
880                             VhostUserMsg *msg)
881 {
882         int enable = (int)msg->payload.state.num;
883
884         RTE_LOG(INFO, VHOST_CONFIG,
885                 "set queue enable: %d to qp idx: %d\n",
886                 enable, msg->payload.state.index);
887
888         if (dev->notify_ops->vring_state_changed)
889                 dev->notify_ops->vring_state_changed(dev->vid,
890                                 msg->payload.state.index, enable);
891
892         dev->virtqueue[msg->payload.state.index]->enabled = enable;
893
894         return 0;
895 }
896
897 static void
898 vhost_user_get_protocol_features(struct virtio_net *dev,
899                                  struct VhostUserMsg *msg)
900 {
901         uint64_t features, protocol_features = VHOST_USER_PROTOCOL_FEATURES;
902
903         rte_vhost_driver_get_features(dev->ifname, &features);
904
905         /*
906          * REPLY_ACK protocol feature is only mandatory for now
907          * for IOMMU feature. If IOMMU is explicitly disabled by the
908          * application, disable also REPLY_ACK feature for older buggy
909          * Qemu versions (from v2.7.0 to v2.9.0).
910          */
911         if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
912                 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
913
914         msg->payload.u64 = protocol_features;
915         msg->size = sizeof(msg->payload.u64);
916 }
917
918 static void
919 vhost_user_set_protocol_features(struct virtio_net *dev,
920                                  uint64_t protocol_features)
921 {
922         if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
923                 return;
924
925         dev->protocol_features = protocol_features;
926 }
927
928 static int
929 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
930 {
931         int fd = msg->fds[0];
932         uint64_t size, off;
933         void *addr;
934
935         if (fd < 0) {
936                 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
937                 return -1;
938         }
939
940         if (msg->size != sizeof(VhostUserLog)) {
941                 RTE_LOG(ERR, VHOST_CONFIG,
942                         "invalid log base msg size: %"PRId32" != %d\n",
943                         msg->size, (int)sizeof(VhostUserLog));
944                 return -1;
945         }
946
947         size = msg->payload.log.mmap_size;
948         off  = msg->payload.log.mmap_offset;
949         RTE_LOG(INFO, VHOST_CONFIG,
950                 "log mmap size: %"PRId64", offset: %"PRId64"\n",
951                 size, off);
952
953         /*
954          * mmap from 0 to workaround a hugepage mmap bug: mmap will
955          * fail when offset is not page size aligned.
956          */
957         addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
958         close(fd);
959         if (addr == MAP_FAILED) {
960                 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
961                 return -1;
962         }
963
964         /*
965          * Free previously mapped log memory on occasionally
966          * multiple VHOST_USER_SET_LOG_BASE.
967          */
968         if (dev->log_addr) {
969                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
970         }
971         dev->log_addr = (uint64_t)(uintptr_t)addr;
972         dev->log_base = dev->log_addr + off;
973         dev->log_size = size;
974
975         return 0;
976 }
977
978 /*
979  * An rarp packet is constructed and broadcasted to notify switches about
980  * the new location of the migrated VM, so that packets from outside will
981  * not be lost after migration.
982  *
983  * However, we don't actually "send" a rarp packet here, instead, we set
984  * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
985  */
986 static int
987 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
988 {
989         uint8_t *mac = (uint8_t *)&msg->payload.u64;
990
991         RTE_LOG(DEBUG, VHOST_CONFIG,
992                 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
993                 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
994         memcpy(dev->mac.addr_bytes, mac, 6);
995
996         /*
997          * Set the flag to inject a RARP broadcast packet at
998          * rte_vhost_dequeue_burst().
999          *
1000          * rte_smp_wmb() is for making sure the mac is copied
1001          * before the flag is set.
1002          */
1003         rte_smp_wmb();
1004         rte_atomic16_set(&dev->broadcast_rarp, 1);
1005
1006         return 0;
1007 }
1008
1009 static int
1010 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
1011 {
1012         if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1013                         msg->payload.u64 > VIRTIO_MAX_MTU) {
1014                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1015                                 msg->payload.u64);
1016
1017                 return -1;
1018         }
1019
1020         dev->mtu = msg->payload.u64;
1021
1022         return 0;
1023 }
1024
1025 static int
1026 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
1027 {
1028         int fd = msg->fds[0];
1029
1030         if (fd < 0) {
1031                 RTE_LOG(ERR, VHOST_CONFIG,
1032                                 "Invalid file descriptor for slave channel (%d)\n",
1033                                 fd);
1034                 return -1;
1035         }
1036
1037         dev->slave_req_fd = fd;
1038
1039         return 0;
1040 }
1041
1042 static int
1043 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1044 {
1045         struct vhost_vring_addr *ra;
1046         uint64_t start, end;
1047
1048         start = imsg->iova;
1049         end = start + imsg->size;
1050
1051         ra = &vq->ring_addrs;
1052         if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1053                 return 1;
1054         if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1055                 return 1;
1056         if (ra->used_user_addr >= start && ra->used_user_addr < end)
1057                 return 1;
1058
1059         return 0;
1060 }
1061
1062 static int
1063 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1064                                 struct vhost_iotlb_msg *imsg)
1065 {
1066         uint64_t istart, iend, vstart, vend;
1067
1068         istart = imsg->iova;
1069         iend = istart + imsg->size - 1;
1070
1071         vstart = (uintptr_t)vq->desc;
1072         vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1073         if (vstart <= iend && istart <= vend)
1074                 return 1;
1075
1076         vstart = (uintptr_t)vq->avail;
1077         vend = vstart + sizeof(struct vring_avail);
1078         vend += sizeof(uint16_t) * vq->size - 1;
1079         if (vstart <= iend && istart <= vend)
1080                 return 1;
1081
1082         vstart = (uintptr_t)vq->used;
1083         vend = vstart + sizeof(struct vring_used);
1084         vend += sizeof(struct vring_used_elem) * vq->size - 1;
1085         if (vstart <= iend && istart <= vend)
1086                 return 1;
1087
1088         return 0;
1089 }
1090
1091 static int
1092 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1093 {
1094         struct virtio_net *dev = *pdev;
1095         struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1096         uint16_t i;
1097         uint64_t vva;
1098
1099         switch (imsg->type) {
1100         case VHOST_IOTLB_UPDATE:
1101                 vva = qva_to_vva(dev, imsg->uaddr);
1102                 if (!vva)
1103                         return -1;
1104
1105                 for (i = 0; i < dev->nr_vring; i++) {
1106                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1107
1108                         vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1109                                         imsg->size, imsg->perm);
1110
1111                         if (is_vring_iotlb_update(vq, imsg))
1112                                 *pdev = dev = translate_ring_addresses(dev, i);
1113                 }
1114                 break;
1115         case VHOST_IOTLB_INVALIDATE:
1116                 for (i = 0; i < dev->nr_vring; i++) {
1117                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1118
1119                         vhost_user_iotlb_cache_remove(vq, imsg->iova,
1120                                         imsg->size);
1121
1122                         if (is_vring_iotlb_invalidate(vq, imsg))
1123                                 vring_invalidate(dev, vq);
1124                 }
1125                 break;
1126         default:
1127                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1128                                 imsg->type);
1129                 return -1;
1130         }
1131
1132         return 0;
1133 }
1134
1135 /* return bytes# of read on success or negative val on failure. */
1136 static int
1137 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1138 {
1139         int ret;
1140
1141         ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1142                 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1143         if (ret <= 0)
1144                 return ret;
1145
1146         if (msg && msg->size) {
1147                 if (msg->size > sizeof(msg->payload)) {
1148                         RTE_LOG(ERR, VHOST_CONFIG,
1149                                 "invalid msg size: %d\n", msg->size);
1150                         return -1;
1151                 }
1152                 ret = read(sockfd, &msg->payload, msg->size);
1153                 if (ret <= 0)
1154                         return ret;
1155                 if (ret != (int)msg->size) {
1156                         RTE_LOG(ERR, VHOST_CONFIG,
1157                                 "read control message failed\n");
1158                         return -1;
1159                 }
1160         }
1161
1162         return ret;
1163 }
1164
1165 static int
1166 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1167 {
1168         if (!msg)
1169                 return 0;
1170
1171         return send_fd_message(sockfd, (char *)msg,
1172                 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1173 }
1174
1175 static int
1176 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1177 {
1178         if (!msg)
1179                 return 0;
1180
1181         msg->flags &= ~VHOST_USER_VERSION_MASK;
1182         msg->flags &= ~VHOST_USER_NEED_REPLY;
1183         msg->flags |= VHOST_USER_VERSION;
1184         msg->flags |= VHOST_USER_REPLY_MASK;
1185
1186         return send_vhost_message(sockfd, msg);
1187 }
1188
1189 /*
1190  * Allocate a queue pair if it hasn't been allocated yet
1191  */
1192 static int
1193 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1194 {
1195         uint16_t vring_idx;
1196
1197         switch (msg->request.master) {
1198         case VHOST_USER_SET_VRING_KICK:
1199         case VHOST_USER_SET_VRING_CALL:
1200         case VHOST_USER_SET_VRING_ERR:
1201                 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1202                 break;
1203         case VHOST_USER_SET_VRING_NUM:
1204         case VHOST_USER_SET_VRING_BASE:
1205         case VHOST_USER_SET_VRING_ENABLE:
1206                 vring_idx = msg->payload.state.index;
1207                 break;
1208         case VHOST_USER_SET_VRING_ADDR:
1209                 vring_idx = msg->payload.addr.index;
1210                 break;
1211         default:
1212                 return 0;
1213         }
1214
1215         if (vring_idx >= VHOST_MAX_VRING) {
1216                 RTE_LOG(ERR, VHOST_CONFIG,
1217                         "invalid vring index: %u\n", vring_idx);
1218                 return -1;
1219         }
1220
1221         if (dev->virtqueue[vring_idx])
1222                 return 0;
1223
1224         return alloc_vring_queue(dev, vring_idx);
1225 }
1226
1227 static void
1228 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1229 {
1230         unsigned int i = 0;
1231         unsigned int vq_num = 0;
1232
1233         while (vq_num < dev->nr_vring) {
1234                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1235
1236                 if (vq) {
1237                         rte_spinlock_lock(&vq->access_lock);
1238                         vq_num++;
1239                 }
1240                 i++;
1241         }
1242 }
1243
1244 static void
1245 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1246 {
1247         unsigned int i = 0;
1248         unsigned int vq_num = 0;
1249
1250         while (vq_num < dev->nr_vring) {
1251                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1252
1253                 if (vq) {
1254                         rte_spinlock_unlock(&vq->access_lock);
1255                         vq_num++;
1256                 }
1257                 i++;
1258         }
1259 }
1260
1261 int
1262 vhost_user_msg_handler(int vid, int fd)
1263 {
1264         struct virtio_net *dev;
1265         struct VhostUserMsg msg;
1266         int ret;
1267         int unlock_required = 0;
1268
1269         dev = get_device(vid);
1270         if (dev == NULL)
1271                 return -1;
1272
1273         if (!dev->notify_ops) {
1274                 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1275                 if (!dev->notify_ops) {
1276                         RTE_LOG(ERR, VHOST_CONFIG,
1277                                 "failed to get callback ops for driver %s\n",
1278                                 dev->ifname);
1279                         return -1;
1280                 }
1281         }
1282
1283         ret = read_vhost_message(fd, &msg);
1284         if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1285                 if (ret < 0)
1286                         RTE_LOG(ERR, VHOST_CONFIG,
1287                                 "vhost read message failed\n");
1288                 else if (ret == 0)
1289                         RTE_LOG(INFO, VHOST_CONFIG,
1290                                 "vhost peer closed\n");
1291                 else
1292                         RTE_LOG(ERR, VHOST_CONFIG,
1293                                 "vhost read incorrect message\n");
1294
1295                 return -1;
1296         }
1297
1298         ret = 0;
1299         if (msg.request.master != VHOST_USER_IOTLB_MSG)
1300                 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1301                         vhost_message_str[msg.request.master]);
1302         else
1303                 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1304                         vhost_message_str[msg.request.master]);
1305
1306         ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1307         if (ret < 0) {
1308                 RTE_LOG(ERR, VHOST_CONFIG,
1309                         "failed to alloc queue\n");
1310                 return -1;
1311         }
1312
1313         /*
1314          * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE,
1315          * since it is sent when virtio stops and device is destroyed.
1316          * destroy_device waits for queues to be inactive, so it is safe.
1317          * Otherwise taking the access_lock would cause a dead lock.
1318          */
1319         switch (msg.request.master) {
1320         case VHOST_USER_SET_FEATURES:
1321         case VHOST_USER_SET_PROTOCOL_FEATURES:
1322         case VHOST_USER_SET_OWNER:
1323         case VHOST_USER_RESET_OWNER:
1324         case VHOST_USER_SET_MEM_TABLE:
1325         case VHOST_USER_SET_LOG_BASE:
1326         case VHOST_USER_SET_LOG_FD:
1327         case VHOST_USER_SET_VRING_NUM:
1328         case VHOST_USER_SET_VRING_ADDR:
1329         case VHOST_USER_SET_VRING_BASE:
1330         case VHOST_USER_SET_VRING_KICK:
1331         case VHOST_USER_SET_VRING_CALL:
1332         case VHOST_USER_SET_VRING_ERR:
1333         case VHOST_USER_SET_VRING_ENABLE:
1334         case VHOST_USER_SEND_RARP:
1335         case VHOST_USER_NET_SET_MTU:
1336         case VHOST_USER_SET_SLAVE_REQ_FD:
1337                 vhost_user_lock_all_queue_pairs(dev);
1338                 unlock_required = 1;
1339                 break;
1340         default:
1341                 break;
1342
1343         }
1344
1345         switch (msg.request.master) {
1346         case VHOST_USER_GET_FEATURES:
1347                 msg.payload.u64 = vhost_user_get_features(dev);
1348                 msg.size = sizeof(msg.payload.u64);
1349                 send_vhost_reply(fd, &msg);
1350                 break;
1351         case VHOST_USER_SET_FEATURES:
1352                 vhost_user_set_features(dev, msg.payload.u64);
1353                 break;
1354
1355         case VHOST_USER_GET_PROTOCOL_FEATURES:
1356                 vhost_user_get_protocol_features(dev, &msg);
1357                 send_vhost_reply(fd, &msg);
1358                 break;
1359         case VHOST_USER_SET_PROTOCOL_FEATURES:
1360                 vhost_user_set_protocol_features(dev, msg.payload.u64);
1361                 break;
1362
1363         case VHOST_USER_SET_OWNER:
1364                 vhost_user_set_owner();
1365                 break;
1366         case VHOST_USER_RESET_OWNER:
1367                 vhost_user_reset_owner(dev);
1368                 break;
1369
1370         case VHOST_USER_SET_MEM_TABLE:
1371                 ret = vhost_user_set_mem_table(dev, &msg);
1372                 break;
1373
1374         case VHOST_USER_SET_LOG_BASE:
1375                 vhost_user_set_log_base(dev, &msg);
1376
1377                 /* it needs a reply */
1378                 msg.size = sizeof(msg.payload.u64);
1379                 send_vhost_reply(fd, &msg);
1380                 break;
1381         case VHOST_USER_SET_LOG_FD:
1382                 close(msg.fds[0]);
1383                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1384                 break;
1385
1386         case VHOST_USER_SET_VRING_NUM:
1387                 vhost_user_set_vring_num(dev, &msg);
1388                 break;
1389         case VHOST_USER_SET_VRING_ADDR:
1390                 vhost_user_set_vring_addr(&dev, &msg);
1391                 break;
1392         case VHOST_USER_SET_VRING_BASE:
1393                 vhost_user_set_vring_base(dev, &msg);
1394                 break;
1395
1396         case VHOST_USER_GET_VRING_BASE:
1397                 vhost_user_get_vring_base(dev, &msg);
1398                 msg.size = sizeof(msg.payload.state);
1399                 send_vhost_reply(fd, &msg);
1400                 break;
1401
1402         case VHOST_USER_SET_VRING_KICK:
1403                 vhost_user_set_vring_kick(&dev, &msg);
1404                 break;
1405         case VHOST_USER_SET_VRING_CALL:
1406                 vhost_user_set_vring_call(dev, &msg);
1407                 break;
1408
1409         case VHOST_USER_SET_VRING_ERR:
1410                 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1411                         close(msg.fds[0]);
1412                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1413                 break;
1414
1415         case VHOST_USER_GET_QUEUE_NUM:
1416                 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1417                 msg.size = sizeof(msg.payload.u64);
1418                 send_vhost_reply(fd, &msg);
1419                 break;
1420
1421         case VHOST_USER_SET_VRING_ENABLE:
1422                 vhost_user_set_vring_enable(dev, &msg);
1423                 break;
1424         case VHOST_USER_SEND_RARP:
1425                 vhost_user_send_rarp(dev, &msg);
1426                 break;
1427
1428         case VHOST_USER_NET_SET_MTU:
1429                 ret = vhost_user_net_set_mtu(dev, &msg);
1430                 break;
1431
1432         case VHOST_USER_SET_SLAVE_REQ_FD:
1433                 ret = vhost_user_set_req_fd(dev, &msg);
1434                 break;
1435
1436         case VHOST_USER_IOTLB_MSG:
1437                 ret = vhost_user_iotlb_msg(&dev, &msg);
1438                 break;
1439
1440         default:
1441                 ret = -1;
1442                 break;
1443
1444         }
1445
1446         if (unlock_required)
1447                 vhost_user_unlock_all_queue_pairs(dev);
1448
1449         if (msg.flags & VHOST_USER_NEED_REPLY) {
1450                 msg.payload.u64 = !!ret;
1451                 msg.size = sizeof(msg.payload.u64);
1452                 send_vhost_reply(fd, &msg);
1453         }
1454
1455         if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1456                 dev->flags |= VIRTIO_DEV_READY;
1457
1458                 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1459                         if (dev->dequeue_zero_copy) {
1460                                 RTE_LOG(INFO, VHOST_CONFIG,
1461                                                 "dequeue zero copy is enabled\n");
1462                         }
1463
1464                         if (dev->notify_ops->new_device(dev->vid) == 0)
1465                                 dev->flags |= VIRTIO_DEV_RUNNING;
1466                 }
1467         }
1468
1469         return 0;
1470 }
1471
1472 int
1473 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1474 {
1475         int ret;
1476         struct VhostUserMsg msg = {
1477                 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1478                 .flags = VHOST_USER_VERSION,
1479                 .size = sizeof(msg.payload.iotlb),
1480                 .payload.iotlb = {
1481                         .iova = iova,
1482                         .perm = perm,
1483                         .type = VHOST_IOTLB_MISS,
1484                 },
1485         };
1486
1487         ret = send_vhost_message(dev->slave_req_fd, &msg);
1488         if (ret < 0) {
1489                 RTE_LOG(ERR, VHOST_CONFIG,
1490                                 "Failed to send IOTLB miss message (%d)\n",
1491                                 ret);
1492                 return ret;
1493         }
1494
1495         return 0;
1496 }