lib/librte_vhost/virtio-net.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 <dirent.h>
  35 #include <fuse/cuse_lowlevel.h>
  36 #include <linux/vhost.h>
  37 #include <linux/virtio_net.h>
  38 #include <stddef.h>
  39 #include <stdint.h>
  40 #include <stdlib.h>
  41 #include <sys/eventfd.h>
  42 #include <sys/ioctl.h>
  43 #include <sys/mman.h>
  44 #include <unistd.h>
  45
  46 #include <rte_ethdev.h>
  47 #include <rte_log.h>
  48 #include <rte_string_fns.h>
  49 #include <rte_memory.h>
  50
  51 #include "main.h"
  52 #include "virtio-net.h"
  53 #include "vhost-net-cdev.h"
  54 #include "eventfd_link/eventfd_link.h"
  55
  56 const char eventfd_cdev[] = "/dev/eventfd-link";
  57
  58 /* device ops to add/remove device to data core. */
  59 static struct virtio_net_device_ops const * notify_ops;
  60 /* Root address of the linked list in the configuration core. */
  61 static struct virtio_net_config_ll                      *ll_root = NULL;
  62
  63 /* Features supported by this application. RX merge buffers are disabled by default. */
  64 uint64_t VHOST_FEATURES = (0ULL << VIRTIO_NET_F_MRG_RXBUF);
  65
  66 /* Line size for reading maps file. */
  67 const uint32_t BUFSIZE = PATH_MAX;
  68
  69 /* Size of prot char array in procmap. */
  70 #define PROT_SZ 5
  71
  72 /* Number of elements in procmap struct. */
  73 #define PROCMAP_SZ 8
  74
  75 /* Structure containing information gathered from maps file. */
  76 struct procmap
  77 {
  78         uint64_t        va_start;                       /* Start virtual address in file. */
  79         uint64_t        len;                            /* Size of file. */
  80         uint64_t        pgoff;                          /* Not used. */
  81         uint32_t        maj;                            /* Not used. */
  82         uint32_t        min;                            /* Not used. */
  83         uint32_t        ino;                            /* Not used. */
  84         char            prot[PROT_SZ];          /* Not used. */
  85         char            fname[PATH_MAX];        /* File name. */
  86 };
  87
  88 /*
  89  * Converts QEMU virtual address to Vhost virtual address. This function is used
  90  * to convert the ring addresses to our address space.
  91  */
  92 static uint64_t
  93 qva_to_vva(struct virtio_net *dev, uint64_t qemu_va)
  94 {
  95         struct virtio_memory_regions *region;
  96         uint64_t vhost_va = 0;
  97         uint32_t regionidx = 0;
  98
  99         /* Find the region where the address lives. */
 100         for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
 101                 region = &dev->mem->regions[regionidx];
 102                 if ((qemu_va >= region->userspace_address) &&
 103                                 (qemu_va <= region->userspace_address +
 104                                 region->memory_size)) {
 105                         vhost_va = dev->mem->mapped_address + qemu_va - dev->mem->base_address;
 106                         break;
 107                 }
 108         }
 109         return vhost_va;
 110 }
 111
 112 /*
 113  * Locate the file containing QEMU's memory space and map it to our address space.
 114  */
 115 static int
 116 host_memory_map (struct virtio_net *dev, struct virtio_memory *mem, pid_t pid, uint64_t addr)
 117 {
 118         struct dirent *dptr = NULL;
 119         struct procmap procmap;
 120         DIR *dp = NULL;
 121         int fd;
 122         int i;
 123         char memfile[PATH_MAX];
 124         char mapfile[PATH_MAX];
 125         char procdir[PATH_MAX];
 126         char resolved_path[PATH_MAX];
 127         FILE            *fmap;
 128         void            *map;
 129         uint8_t         found = 0;
 130         char            line[BUFSIZE];
 131         char dlm[] = "-   :   ";
 132         char *str, *sp, *in[PROCMAP_SZ];
 133         char *end = NULL;
 134
 135         /* Path where mem files are located. */
 136         snprintf (procdir, PATH_MAX, "/proc/%u/fd/", pid);
 137         /* Maps file used to locate mem file. */
 138         snprintf (mapfile, PATH_MAX, "/proc/%u/maps", pid);
 139
 140         fmap = fopen(mapfile, "r");
 141         if (fmap == NULL) {
 142                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to open maps file for pid %d\n", dev->device_fh, pid);
 143                 return -1;
 144         }
 145
 146         /* Read through maps file until we find out base_address. */
 147         while (fgets(line, BUFSIZE, fmap) != 0) {
 148                 str = line;
 149                 errno = 0;
 150                 /* Split line in to fields. */
 151                 for (i = 0; i < PROCMAP_SZ; i++) {
 152                         if (((in[i] = strtok_r(str, &dlm[i], &sp)) == NULL) || (errno != 0)) {
 153                                 fclose(fmap);
 154                                 return -1;
 155                         }
 156                         str = NULL;
 157                 }
 158
 159                 /* Convert/Copy each field as needed. */
 160                 procmap.va_start = strtoull(in[0], &end, 16);
 161                 if ((in[0] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0)) {
 162                         fclose(fmap);
 163                         return -1;
 164                 }
 165
 166                 procmap.len = strtoull(in[1], &end, 16);
 167                 if ((in[1] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0)) {
 168                         fclose(fmap);
 169                         return -1;
 170                 }
 171
 172                 procmap.pgoff = strtoull(in[3], &end, 16);
 173                 if ((in[3] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0)) {
 174                         fclose(fmap);
 175                         return -1;
 176                 }
 177
 178                 procmap.maj = strtoul(in[4], &end, 16);
 179                 if ((in[4] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0)) {
 180                         fclose(fmap);
 181                         return -1;
 182                 }
 183
 184                 procmap.min = strtoul(in[5], &end, 16);
 185                 if ((in[5] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0)) {
 186                         fclose(fmap);
 187                         return -1;
 188                 }
 189
 190                 procmap.ino = strtoul(in[6], &end, 16);
 191                 if ((in[6] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0)) {
 192                         fclose(fmap);
 193                         return -1;
 194                 }
 195
 196                 memcpy(&procmap.prot, in[2], PROT_SZ);
 197                 memcpy(&procmap.fname, in[7], PATH_MAX);
 198
 199                 if (procmap.va_start == addr) {
 200                         procmap.len = procmap.len - procmap.va_start;
 201                         found = 1;
 202                         break;
 203                 }
 204         }
 205         fclose(fmap);
 206
 207         if (!found) {
 208                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to find memory file in pid %d maps file\n", dev->device_fh, pid);
 209                 return -1;
 210         }
 211
 212         /* Find the guest memory file among the process fds. */
 213         dp = opendir(procdir);
 214         if (dp == NULL) {
 215                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Cannot open pid %d process directory \n", dev->device_fh, pid);
 216                 return -1;
 217
 218         }
 219
 220         found = 0;
 221
 222         /* Read the fd directory contents. */
 223         while (NULL != (dptr = readdir(dp))) {
 224                 snprintf (memfile, PATH_MAX, "/proc/%u/fd/%s", pid, dptr->d_name);
 225             realpath(memfile, resolved_path);
 226                 if (resolved_path == NULL) {
 227                         RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to resolve fd directory\n", dev->device_fh);
 228                         closedir(dp);
 229                         return -1;
 230                 }
 231                 if (strncmp(resolved_path, procmap.fname,
 232                         strnlen(procmap.fname, PATH_MAX)) == 0) {
 233                         found = 1;
 234                         break;
 235                 }
 236         }
 237
 238         closedir(dp);
 239
 240         if (found == 0) {
 241                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to find memory file for pid %d\n", dev->device_fh, pid);
 242                 return -1;
 243         }
 244         /* Open the shared memory file and map the memory into this process. */
 245         fd = open(memfile, O_RDWR);
 246
 247         if (fd == -1) {
 248                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to open %s for pid %d\n", dev->device_fh, memfile, pid);
 249                 return -1;
 250         }
 251
 252         map = mmap(0, (size_t)procmap.len, PROT_READ|PROT_WRITE , MAP_POPULATE|MAP_SHARED, fd, 0);
 253         close (fd);
 254
 255         if (map == MAP_FAILED) {
 256                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Error mapping the file %s for pid %d\n",  dev->device_fh, memfile, pid);
 257                 return -1;
 258         }
 259
 260         /* Store the memory address and size in the device data structure */
 261         mem->mapped_address = (uint64_t)(uintptr_t)map;
 262         mem->mapped_size = procmap.len;
 263
 264         LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") Mem File: %s->%s - Size: %llu - VA: %p\n", dev->device_fh,
 265                 memfile, resolved_path, (long long unsigned)mem->mapped_size, map);
 266
 267         return 0;
 268 }
 269
 270 /*
 271  * Retrieves an entry from the devices configuration linked list.
 272  */
 273 static struct virtio_net_config_ll *
 274 get_config_ll_entry(struct vhost_device_ctx ctx)
 275 {
 276         struct virtio_net_config_ll *ll_dev = ll_root;
 277
 278         /* Loop through linked list until the device_fh is found. */
 279         while (ll_dev != NULL) {
 280                 if (ll_dev->dev.device_fh == ctx.fh)
 281                         return ll_dev;
 282                 ll_dev = ll_dev->next;
 283         }
 284
 285         return NULL;
 286 }
 287
 288 /*
 289  * Searches the configuration core linked list and retrieves the device if it exists.
 290  */
 291 static struct virtio_net *
 292 get_device(struct vhost_device_ctx ctx)
 293 {
 294         struct virtio_net_config_ll *ll_dev;
 295
 296         ll_dev = get_config_ll_entry(ctx);
 297
 298         /* If a matching entry is found in the linked list, return the device in that entry. */
 299         if (ll_dev) {
 300                 return &ll_dev->dev;
 301         }
 302
 303         RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Device not found in linked list.\n", ctx.fh);
 304         return NULL;
 305 }
 306
 307 /*
 308  * Add entry containing a device to the device configuration linked list.
 309  */
 310 static void
 311 add_config_ll_entry(struct virtio_net_config_ll *new_ll_dev)
 312 {
 313         struct virtio_net_config_ll *ll_dev = ll_root;
 314
 315         /* If ll_dev == NULL then this is the first device so go to else */
 316         if (ll_dev) {
 317                 /* If the 1st device_fh != 0 then we insert our device here. */
 318                 if (ll_dev->dev.device_fh != 0) {
 319                         new_ll_dev->dev.device_fh = 0;
 320                         new_ll_dev->next = ll_dev;
 321                         ll_root = new_ll_dev;
 322                 } else {
 323                         /* Increment through the ll until we find un unused device_fh. Insert the device at that entry*/
 324                         while ((ll_dev->next != NULL) && (ll_dev->dev.device_fh == (ll_dev->next->dev.device_fh - 1)))
 325                                 ll_dev = ll_dev->next;
 326
 327                         new_ll_dev->dev.device_fh = ll_dev->dev.device_fh + 1;
 328                         new_ll_dev->next = ll_dev->next;
 329                         ll_dev->next = new_ll_dev;
 330                 }
 331         } else {
 332                 ll_root = new_ll_dev;
 333                 ll_root->dev.device_fh = 0;
 334         }
 335
 336 }
 337
 338 /*
 339  * Unmap any memory, close any file descriptors and free any memory owned by a device.
 340  */
 341 static void
 342 cleanup_device(struct virtio_net *dev)
 343 {
 344         /* Unmap QEMU memory file if mapped. */
 345         if (dev->mem) {
 346                 munmap((void*)(uintptr_t)dev->mem->mapped_address, (size_t)dev->mem->mapped_size);
 347                 free(dev->mem);
 348         }
 349
 350         /* Close any event notifiers opened by device. */
 351         if (dev->virtqueue[VIRTIO_RXQ]->callfd)
 352                 close((int)dev->virtqueue[VIRTIO_RXQ]->callfd);
 353         if (dev->virtqueue[VIRTIO_RXQ]->kickfd)
 354                 close((int)dev->virtqueue[VIRTIO_RXQ]->kickfd);
 355         if (dev->virtqueue[VIRTIO_TXQ]->callfd)
 356                 close((int)dev->virtqueue[VIRTIO_TXQ]->callfd);
 357         if (dev->virtqueue[VIRTIO_TXQ]->kickfd)
 358                 close((int)dev->virtqueue[VIRTIO_TXQ]->kickfd);
 359 }
 360
 361 /*
 362  * Release virtqueues and device memory.
 363  */
 364 static void
 365 free_device(struct virtio_net_config_ll *ll_dev)
 366 {
 367         /* Free any malloc'd memory */
 368         free(ll_dev->dev.virtqueue[VIRTIO_RXQ]);
 369         free(ll_dev->dev.virtqueue[VIRTIO_TXQ]);
 370         free(ll_dev);
 371 }
 372 /*
 373  * Remove an entry from the device configuration linked list.
 374  */
 375 static struct virtio_net_config_ll *
 376 rm_config_ll_entry(struct virtio_net_config_ll *ll_dev, struct virtio_net_config_ll *ll_dev_last)
 377 {
 378         /* First remove the device and then clean it up. */
 379         if (ll_dev == ll_root) {
 380                 ll_root = ll_dev->next;
 381                 cleanup_device(&ll_dev->dev);
 382                 free_device(ll_dev);
 383                 return ll_root;
 384         } else {
 385                 if (likely(ll_dev_last != NULL)) {
 386                         ll_dev_last->next = ll_dev->next;
 387                         cleanup_device(&ll_dev->dev);
 388                         free_device(ll_dev);
 389                         return ll_dev_last->next;
 390                 } else {
 391                         cleanup_device(&ll_dev->dev);
 392                         free_device(ll_dev);
 393                         RTE_LOG(ERR, VHOST_CONFIG, "Remove entry from config_ll failed\n");
 394                         return NULL;
 395                 }
 396         }
 397 }
 398
 399 /*
 400  *  Initialise all variables in device structure.
 401  */
 402 static void
 403 init_device(struct virtio_net *dev)
 404 {
 405         uint64_t vq_offset;
 406
 407         /* Virtqueues have already been malloced so we don't want to set them to NULL. */
 408         vq_offset = offsetof(struct virtio_net, mem);
 409
 410         /* Set everything to 0. */
 411         memset((void*)(uintptr_t)((uint64_t)(uintptr_t)dev + vq_offset), 0,
 412                 (sizeof(struct virtio_net) - (size_t)vq_offset));
 413         memset(dev->virtqueue[VIRTIO_RXQ], 0, sizeof(struct vhost_virtqueue));
 414         memset(dev->virtqueue[VIRTIO_TXQ], 0, sizeof(struct vhost_virtqueue));
 415
 416         /* Backends are set to -1 indicating an inactive device. */
 417         dev->virtqueue[VIRTIO_RXQ]->backend = VIRTIO_DEV_STOPPED;
 418         dev->virtqueue[VIRTIO_TXQ]->backend = VIRTIO_DEV_STOPPED;
 419 }
 420
 421 /*
 422  * Function is called from the CUSE open function. The device structure is
 423  * initialised and a new entry is added to the device configuration linked
 424  * list.
 425  */
 426 static int
 427 new_device(struct vhost_device_ctx ctx)
 428 {
 429         struct virtio_net_config_ll *new_ll_dev;
 430         struct vhost_virtqueue *virtqueue_rx, *virtqueue_tx;
 431
 432         /* Setup device and virtqueues. */
 433         new_ll_dev = malloc(sizeof(struct virtio_net_config_ll));
 434         if (new_ll_dev == NULL) {
 435                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to allocate memory for dev.\n", ctx.fh);
 436                 return -1;
 437         }
 438
 439         virtqueue_rx = malloc(sizeof(struct vhost_virtqueue));
 440         if (virtqueue_rx == NULL) {
 441                 free(new_ll_dev);
 442                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to allocate memory for virtqueue_rx.\n", ctx.fh);
 443                 return -1;
 444         }
 445
 446         virtqueue_tx = malloc(sizeof(struct vhost_virtqueue));
 447         if (virtqueue_tx == NULL) {
 448                 free(virtqueue_rx);
 449                 free(new_ll_dev);
 450                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to allocate memory for virtqueue_tx.\n", ctx.fh);
 451                 return -1;
 452         }
 453
 454         new_ll_dev->dev.virtqueue[VIRTIO_RXQ] = virtqueue_rx;
 455         new_ll_dev->dev.virtqueue[VIRTIO_TXQ] = virtqueue_tx;
 456
 457         /* Initialise device and virtqueues. */
 458         init_device(&new_ll_dev->dev);
 459
 460         new_ll_dev->next = NULL;
 461
 462         /* Add entry to device configuration linked list. */
 463         add_config_ll_entry(new_ll_dev);
 464
 465         return new_ll_dev->dev.device_fh;
 466 }
 467
 468 /*
 469  * Function is called from the CUSE release function. This function will cleanup
 470  * the device and remove it from device configuration linked list.
 471  */
 472 static void
 473 destroy_device(struct vhost_device_ctx ctx)
 474 {
 475         struct virtio_net_config_ll *ll_dev_cur_ctx, *ll_dev_last = NULL;
 476         struct virtio_net_config_ll *ll_dev_cur = ll_root;
 477
 478         /* Find the linked list entry for the device to be removed. */
 479         ll_dev_cur_ctx = get_config_ll_entry(ctx);
 480         while (ll_dev_cur != NULL) {
 481                 /* If the device is found or a device that doesn't exist is found then it is removed. */
 482                 if (ll_dev_cur == ll_dev_cur_ctx) {
 483                         /*
 484                          * If the device is running on a data core then call the function to remove it from
 485                          * the data core.
 486                          */
 487                         if ((ll_dev_cur->dev.flags & VIRTIO_DEV_RUNNING))
 488                                 notify_ops->destroy_device(&(ll_dev_cur->dev));
 489                         ll_dev_cur = rm_config_ll_entry(ll_dev_cur, ll_dev_last);
 490                 } else {
 491                         ll_dev_last = ll_dev_cur;
 492                         ll_dev_cur = ll_dev_cur->next;
 493                 }
 494         }
 495 }
 496
 497 /*
 498  * Called from CUSE IOCTL: VHOST_SET_OWNER
 499  * This function just returns success at the moment unless the device hasn't been initialised.
 500  */
 501 static int
 502 set_owner(struct vhost_device_ctx ctx)
 503 {
 504         struct virtio_net *dev;
 505
 506         dev = get_device(ctx);
 507         if (dev == NULL)
 508                 return -1;
 509
 510         return 0;
 511 }
 512
 513 /*
 514  * Called from CUSE IOCTL: VHOST_RESET_OWNER
 515  */
 516 static int
 517 reset_owner(struct vhost_device_ctx ctx)
 518 {
 519         struct virtio_net_config_ll *ll_dev;
 520
 521         ll_dev = get_config_ll_entry(ctx);
 522
 523         cleanup_device(&ll_dev->dev);
 524         init_device(&ll_dev->dev);
 525
 526         return 0;
 527 }
 528
 529 /*
 530  * Called from CUSE IOCTL: VHOST_GET_FEATURES
 531  * The features that we support are requested.
 532  */
 533 static int
 534 get_features(struct vhost_device_ctx ctx, uint64_t *pu)
 535 {
 536         struct virtio_net *dev;
 537
 538         dev = get_device(ctx);
 539         if (dev == NULL)
 540                 return -1;
 541
 542         /* Send our supported features. */
 543         *pu = VHOST_FEATURES;
 544         return 0;
 545 }
 546
 547 /*
 548  * Called from CUSE IOCTL: VHOST_SET_FEATURES
 549  * We receive the negotiated set of features supported by us and the virtio device.
 550  */
 551 static int
 552 set_features(struct vhost_device_ctx ctx, uint64_t *pu)
 553 {
 554         struct virtio_net *dev;
 555
 556         dev = get_device(ctx);
 557         if (dev == NULL)
 558                 return -1;
 559         if (*pu & ~VHOST_FEATURES)
 560                 return -1;
 561
 562         /* Store the negotiated feature list for the device. */
 563         dev->features = *pu;
 564
 565         /* Set the vhost_hlen depending on if VIRTIO_NET_F_MRG_RXBUF is set. */
 566         if (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) {
 567                 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") Mergeable RX buffers enabled\n", dev->device_fh);
 568                 dev->virtqueue[VIRTIO_RXQ]->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
 569                 dev->virtqueue[VIRTIO_TXQ]->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
 570         } else {
 571                 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") Mergeable RX buffers disabled\n", dev->device_fh);
 572                 dev->virtqueue[VIRTIO_RXQ]->vhost_hlen = sizeof(struct virtio_net_hdr);
 573                 dev->virtqueue[VIRTIO_TXQ]->vhost_hlen = sizeof(struct virtio_net_hdr);
 574         }
 575         return 0;
 576 }
 577
 578
 579 /*
 580  * Called from CUSE IOCTL: VHOST_SET_MEM_TABLE
 581  * This function creates and populates the memory structure for the device. This includes
 582  * storing offsets used to translate buffer addresses.
 583  */
 584 static int
 585 set_mem_table(struct vhost_device_ctx ctx, const void *mem_regions_addr, uint32_t nregions)
 586 {
 587         struct virtio_net *dev;
 588         struct vhost_memory_region *mem_regions;
 589         struct virtio_memory *mem;
 590         uint64_t size = offsetof(struct vhost_memory, regions);
 591         uint32_t regionidx, valid_regions;
 592
 593         dev = get_device(ctx);
 594         if (dev == NULL)
 595                 return -1;
 596
 597         if (dev->mem) {
 598                 munmap((void*)(uintptr_t)dev->mem->mapped_address, (size_t)dev->mem->mapped_size);
 599                 free(dev->mem);
 600         }
 601
 602         /* Malloc the memory structure depending on the number of regions. */
 603         mem = calloc(1, sizeof(struct virtio_memory) + (sizeof(struct virtio_memory_regions) * nregions));
 604         if (mem == NULL) {
 605                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to allocate memory for dev->mem.\n", dev->device_fh);
 606                 return -1;
 607         }
 608
 609         mem->nregions = nregions;
 610
 611         mem_regions = (void*)(uintptr_t)((uint64_t)(uintptr_t)mem_regions_addr + size);
 612
 613         for (regionidx = 0; regionidx < mem->nregions; regionidx++) {
 614                 /* Populate the region structure for each region. */
 615                 mem->regions[regionidx].guest_phys_address = mem_regions[regionidx].guest_phys_addr;
 616                 mem->regions[regionidx].guest_phys_address_end = mem->regions[regionidx].guest_phys_address +
 617                         mem_regions[regionidx].memory_size;
 618                 mem->regions[regionidx].memory_size = mem_regions[regionidx].memory_size;
 619                 mem->regions[regionidx].userspace_address = mem_regions[regionidx].userspace_addr;
 620
 621                 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") REGION: %u - GPA: %p - QEMU VA: %p - SIZE (%"PRIu64")\n", dev->device_fh,
 622                                 regionidx, (void*)(uintptr_t)mem->regions[regionidx].guest_phys_address,
 623                                 (void*)(uintptr_t)mem->regions[regionidx].userspace_address,
 624                                 mem->regions[regionidx].memory_size);
 625
 626                 /*set the base address mapping*/
 627                 if (mem->regions[regionidx].guest_phys_address == 0x0) {
 628                         mem->base_address = mem->regions[regionidx].userspace_address;
 629                         /* Map VM memory file */
 630                         if (host_memory_map(dev, mem, ctx.pid, mem->base_address) != 0) {
 631                                 free(mem);
 632                                 return -1;
 633                         }
 634                 }
 635         }
 636
 637         /* Check that we have a valid base address. */
 638         if (mem->base_address == 0) {
 639                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to find base address of qemu memory file.\n", dev->device_fh);
 640                 free(mem);
 641                 return -1;
 642         }
 643
 644         /* Check if all of our regions have valid mappings. Usually one does not exist in the QEMU memory file. */
 645         valid_regions = mem->nregions;
 646         for (regionidx = 0; regionidx < mem->nregions; regionidx++) {
 647                 if ((mem->regions[regionidx].userspace_address < mem->base_address) ||
 648                         (mem->regions[regionidx].userspace_address > (mem->base_address + mem->mapped_size)))
 649                                 valid_regions--;
 650         }
 651
 652         /* If a region does not have a valid mapping we rebuild our memory struct to contain only valid entries. */
 653         if (valid_regions != mem->nregions) {
 654                 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") Not all memory regions exist in the QEMU mem file. Re-populating mem structure\n",
 655                         dev->device_fh);
 656
 657                 /* Re-populate the memory structure with only valid regions. Invalid regions are over-written with memmove. */
 658                 valid_regions = 0;
 659
 660                 for (regionidx = mem->nregions; 0 != regionidx--;) {
 661                         if ((mem->regions[regionidx].userspace_address < mem->base_address) ||
 662                                         (mem->regions[regionidx].userspace_address > (mem->base_address + mem->mapped_size))) {
 663                                 memmove(&mem->regions[regionidx], &mem->regions[regionidx + 1],
 664                                         sizeof(struct virtio_memory_regions) * valid_regions);
 665                         } else {
 666                                 valid_regions++;
 667                         }
 668                 }
 669         }
 670         mem->nregions = valid_regions;
 671         dev->mem = mem;
 672
 673         /*
 674          * Calculate the address offset for each region. This offset is used to identify the vhost virtual address
 675          * corresponding to a QEMU guest physical address.
 676          */
 677         for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
 678                 dev->mem->regions[regionidx].address_offset = dev->mem->regions[regionidx].userspace_address - dev->mem->base_address
 679                         + dev->mem->mapped_address - dev->mem->regions[regionidx].guest_phys_address;
 680
 681         }
 682         return 0;
 683 }
 684
 685 /*
 686  * Called from CUSE IOCTL: VHOST_SET_VRING_NUM
 687  * The virtio device sends us the size of the descriptor ring.
 688  */
 689 static int
 690 set_vring_num(struct vhost_device_ctx ctx, struct vhost_vring_state *state)
 691 {
 692         struct virtio_net *dev;
 693
 694         dev = get_device(ctx);
 695         if (dev == NULL)
 696                 return -1;
 697
 698         /* State->index refers to the queue index. The TX queue is 1, RX queue is 0. */
 699         dev->virtqueue[state->index]->size = state->num;
 700
 701         return 0;
 702 }
 703
 704 /*
 705  * Called from CUSE IOCTL: VHOST_SET_VRING_ADDR
 706  * The virtio device sends us the desc, used and avail ring addresses. This function
 707  * then converts these to our address space.
 708  */
 709 static int
 710 set_vring_addr(struct vhost_device_ctx ctx, struct vhost_vring_addr *addr)
 711 {
 712         struct virtio_net *dev;
 713         struct vhost_virtqueue *vq;
 714
 715         dev = get_device(ctx);
 716         if (dev == NULL)
 717                 return -1;
 718
 719         /* addr->index refers to the queue index. The TX queue is 1, RX queue is 0. */
 720         vq = dev->virtqueue[addr->index];
 721
 722         /* The addresses are converted from QEMU virtual to Vhost virtual. */
 723         vq->desc = (struct vring_desc*)(uintptr_t)qva_to_vva(dev, addr->desc_user_addr);
 724         if (vq->desc == 0) {
 725                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to find descriptor ring address.\n", dev->device_fh);
 726                 return -1;
 727         }
 728
 729         vq->avail = (struct vring_avail*)(uintptr_t)qva_to_vva(dev, addr->avail_user_addr);
 730         if (vq->avail == 0) {
 731                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to find available ring address.\n", dev->device_fh);
 732                 return -1;
 733         }
 734
 735         vq->used = (struct vring_used*)(uintptr_t)qva_to_vva(dev, addr->used_user_addr);
 736         if (vq->used == 0) {
 737                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") Failed to find used ring address.\n", dev->device_fh);
 738                 return -1;
 739         }
 740
 741         LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") mapped address desc: %p\n", dev->device_fh, vq->desc);
 742         LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") mapped address avail: %p\n", dev->device_fh, vq->avail);
 743         LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") mapped address used: %p\n", dev->device_fh, vq->used);
 744
 745         return 0;
 746 }
 747
 748 /*
 749  * Called from CUSE IOCTL: VHOST_SET_VRING_BASE
 750  * The virtio device sends us the available ring last used index.
 751  */
 752 static int
 753 set_vring_base(struct vhost_device_ctx ctx, struct vhost_vring_state *state)
 754 {
 755         struct virtio_net *dev;
 756
 757         dev = get_device(ctx);
 758         if (dev == NULL)
 759                 return -1;
 760
 761         /* State->index refers to the queue index. The TX queue is 1, RX queue is 0. */
 762         dev->virtqueue[state->index]->last_used_idx = state->num;
 763         dev->virtqueue[state->index]->last_used_idx_res = state->num;
 764
 765         return 0;
 766 }
 767
 768 /*
 769  * Called from CUSE IOCTL: VHOST_GET_VRING_BASE
 770  * We send the virtio device our available ring last used index.
 771  */
 772 static int
 773 get_vring_base(struct vhost_device_ctx ctx, uint32_t index, struct vhost_vring_state *state)
 774 {
 775         struct virtio_net *dev;
 776
 777         dev = get_device(ctx);
 778         if (dev == NULL)
 779                 return -1;
 780
 781         state->index = index;
 782         /* State->index refers to the queue index. The TX queue is 1, RX queue is 0. */
 783         state->num = dev->virtqueue[state->index]->last_used_idx;
 784
 785         return 0;
 786 }
 787
 788 /*
 789  * This function uses the eventfd_link kernel module to copy an eventfd file descriptor
 790  * provided by QEMU in to our process space.
 791  */
 792 static int
 793 eventfd_copy(struct virtio_net *dev, struct eventfd_copy *eventfd_copy)
 794 {
 795         int eventfd_link, ret;
 796
 797         /* Open the character device to the kernel module. */
 798         eventfd_link = open(eventfd_cdev, O_RDWR);
 799         if (eventfd_link < 0) {
 800                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") eventfd_link module is not loaded\n",  dev->device_fh);
 801                 return -1;
 802         }
 803
 804         /* Call the IOCTL to copy the eventfd. */
 805         ret = ioctl(eventfd_link, EVENTFD_COPY, eventfd_copy);
 806         close(eventfd_link);
 807
 808         if (ret < 0) {
 809                 RTE_LOG(ERR, VHOST_CONFIG, "(%"PRIu64") EVENTFD_COPY ioctl failed\n",  dev->device_fh);
 810                 return -1;
 811         }
 812
 813
 814         return 0;
 815 }
 816
 817 /*
 818  * Called from CUSE IOCTL: VHOST_SET_VRING_CALL
 819  * The virtio device sends an eventfd to interrupt the guest. This fd gets copied in
 820  * to our process space.
 821  */
 822 static int
 823 set_vring_call(struct vhost_device_ctx ctx, struct vhost_vring_file *file)
 824 {
 825         struct virtio_net *dev;
 826         struct eventfd_copy     eventfd_kick;
 827         struct vhost_virtqueue *vq;
 828
 829         dev = get_device(ctx);
 830         if (dev == NULL)
 831                 return -1;
 832
 833         /* file->index refers to the queue index. The TX queue is 1, RX queue is 0. */
 834         vq = dev->virtqueue[file->index];
 835
 836         if (vq->kickfd)
 837                 close((int)vq->kickfd);
 838
 839         /* Populate the eventfd_copy structure and call eventfd_copy. */
 840         vq->kickfd = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
 841         eventfd_kick.source_fd = vq->kickfd;
 842         eventfd_kick.target_fd = file->fd;
 843         eventfd_kick.target_pid = ctx.pid;
 844
 845         if (eventfd_copy(dev, &eventfd_kick))
 846                 return -1;
 847
 848         return 0;
 849 }
 850
 851 /*
 852  * Called from CUSE IOCTL: VHOST_SET_VRING_KICK
 853  * The virtio device sends an eventfd that it can use to notify us. This fd gets copied in
 854  * to our process space.
 855  */
 856 static int
 857 set_vring_kick(struct vhost_device_ctx ctx, struct vhost_vring_file *file)
 858 {
 859         struct virtio_net *dev;
 860         struct eventfd_copy eventfd_call;
 861         struct vhost_virtqueue *vq;
 862
 863         dev = get_device(ctx);
 864         if (dev == NULL)
 865                 return -1;
 866
 867         /* file->index refers to the queue index. The TX queue is 1, RX queue is 0. */
 868         vq = dev->virtqueue[file->index];
 869
 870         if (vq->callfd)
 871                 close((int)vq->callfd);
 872
 873         /* Populate the eventfd_copy structure and call eventfd_copy. */
 874         vq->callfd = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
 875         eventfd_call.source_fd = vq->callfd;
 876         eventfd_call.target_fd = file->fd;
 877         eventfd_call.target_pid = ctx.pid;
 878
 879         if (eventfd_copy(dev, &eventfd_call))
 880         return -1;
 881
 882         return 0;
 883 }
 884
 885 /*
 886  * Called from CUSE IOCTL: VHOST_NET_SET_BACKEND
 887  * To complete device initialisation when the virtio driver is loaded we are provided with a
 888  * valid fd for a tap device (not used by us). If this happens then we can add the device to a
 889  * data core. When the virtio driver is removed we get fd=-1. At that point we remove the device
 890  * from the data core. The device will still exist in the device configuration linked list.
 891  */
 892 static int
 893 set_backend(struct vhost_device_ctx ctx, struct vhost_vring_file *file)
 894 {
 895         struct virtio_net *dev;
 896
 897         dev = get_device(ctx);
 898         if (dev == NULL) {
 899                 return -1;
 900         }
 901
 902         /* file->index refers to the queue index. The TX queue is 1, RX queue is 0. */
 903         dev->virtqueue[file->index]->backend = file->fd;
 904
 905         /* If the device isn't already running and both backend fds are set we add the device. */
 906         if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
 907                 if (((int)dev->virtqueue[VIRTIO_TXQ]->backend != VIRTIO_DEV_STOPPED) &&
 908                         ((int)dev->virtqueue[VIRTIO_RXQ]->backend != VIRTIO_DEV_STOPPED))
 909                         return notify_ops->new_device(dev);
 910         /* Otherwise we remove it. */
 911         } else
 912                 if (file->fd == VIRTIO_DEV_STOPPED) {
 913                         notify_ops->destroy_device(dev);
 914                 }
 915         return 0;
 916 }
 917
 918 /*
 919  * Function pointers are set for the device operations to allow CUSE to call functions
 920  * when an IOCTL, device_add or device_release is received.
 921  */
 922 static const struct vhost_net_device_ops vhost_device_ops =
 923 {
 924         .new_device = new_device,
 925         .destroy_device = destroy_device,
 926
 927         .get_features = get_features,
 928         .set_features = set_features,
 929
 930         .set_mem_table = set_mem_table,
 931
 932         .set_vring_num = set_vring_num,
 933         .set_vring_addr = set_vring_addr,
 934         .set_vring_base = set_vring_base,
 935         .get_vring_base = get_vring_base,
 936
 937         .set_vring_kick = set_vring_kick,
 938         .set_vring_call = set_vring_call,
 939
 940         .set_backend = set_backend,
 941
 942         .set_owner = set_owner,
 943         .reset_owner = reset_owner,
 944 };
 945
 946 /*
 947  * Called by main to setup callbacks when registering CUSE device.
 948  */
 949 struct vhost_net_device_ops const *
 950 get_virtio_net_callbacks(void)
 951 {
 952         return &vhost_device_ops;
 953 }
 954
 955 /*
 956  * Register ops so that we can add/remove device to data core.
 957  */
 958 int
 959 init_virtio_net(struct virtio_net_device_ops const * const ops)
 960 {
 961         notify_ops = ops;
 962
 963         return 0;
 964 }
 965
 966 /*
 967  * Currently not used as we Ctrl+c to exit application.
 968  */
 969 int
 970 deinit_virtio_net(void)
 971 {
 972         return 0;
 973 }