src/vnet/devices/virtio/vhost_user.c

   1 /*
   2  *------------------------------------------------------------------
   3  * vhost.c - vhost-user
   4  *
   5  * Copyright (c) 2014-2018 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #include <fcntl.h>              /* for open */
  21 #include <sys/ioctl.h>
  22 #include <sys/socket.h>
  23 #include <sys/un.h>
  24 #include <sys/stat.h>
  25 #include <sys/types.h>
  26 #include <sys/uio.h>            /* for iovec */
  27 #include <netinet/in.h>
  28 #include <sys/vfs.h>
  29
  30 #include <linux/if_arp.h>
  31 #include <linux/if_tun.h>
  32
  33 #include <vlib/vlib.h>
  34 #include <vlib/unix/unix.h>
  35
  36 #include <vnet/ethernet/ethernet.h>
  37 #include <vnet/devices/devices.h>
  38 #include <vnet/feature/feature.h>
  39
  40 #include <vnet/devices/virtio/vhost_user.h>
  41 #include <vnet/devices/virtio/vhost_user_inline.h>
  42
  43 /**
  44  * @file
  45  * @brief vHost User Device Driver.
  46  *
  47  * This file contains the source code for vHost User interface.
  48  */
  49
  50
  51 vlib_node_registration_t vhost_user_send_interrupt_node;
  52
  53 /* *INDENT-OFF* */
  54 vhost_user_main_t vhost_user_main = {
  55   .mtu_bytes = 1518,
  56 };
  57
  58 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
  59   .name = "vhost-user",
  60 };
  61 /* *INDENT-ON* */
  62
  63 static long
  64 get_huge_page_size (int fd)
  65 {
  66   struct statfs s;
  67   fstatfs (fd, &s);
  68   return s.f_bsize;
  69 }
  70
  71 static void
  72 unmap_all_mem_regions (vhost_user_intf_t * vui)
  73 {
  74   int i, r, q;
  75   vhost_user_vring_t *vq;
  76
  77   for (i = 0; i < vui->nregions; i++)
  78     {
  79       if (vui->region_mmap_addr[i] != MAP_FAILED)
  80         {
  81
  82           long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
  83
  84           ssize_t map_sz = (vui->regions[i].memory_size +
  85                             vui->regions[i].mmap_offset +
  86                             page_sz - 1) & ~(page_sz - 1);
  87
  88           r =
  89             munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
  90                     map_sz);
  91
  92           vu_log_debug (vui, "unmap memory region %d addr 0x%lx len 0x%lx "
  93                         "page_sz 0x%x", i, vui->region_mmap_addr[i], map_sz,
  94                         page_sz);
  95
  96           vui->region_mmap_addr[i] = MAP_FAILED;
  97
  98           if (r == -1)
  99             {
 100               vu_log_err (vui, "failed to unmap memory region (errno %d)",
 101                           errno);
 102             }
 103           close (vui->region_mmap_fd[i]);
 104         }
 105     }
 106   vui->nregions = 0;
 107
 108   for (q = 0; q < VHOST_VRING_MAX_N; q++)
 109     {
 110       vq = &vui->vrings[q];
 111       vq->avail = 0;
 112       vq->used = 0;
 113       vq->desc = 0;
 114     }
 115 }
 116
 117 static_always_inline void
 118 vhost_user_tx_thread_placement (vhost_user_intf_t * vui)
 119 {
 120   //Let's try to assign one queue to each thread
 121   u32 qid;
 122   u32 thread_index = 0;
 123
 124   vui->use_tx_spinlock = 0;
 125   while (1)
 126     {
 127       for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
 128         {
 129           vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
 130           if (!rxvq->started || !rxvq->enabled)
 131             continue;
 132
 133           vui->per_cpu_tx_qid[thread_index] = qid;
 134           thread_index++;
 135           if (thread_index == vlib_get_thread_main ()->n_vlib_mains)
 136             return;
 137         }
 138       //We need to loop, meaning the spinlock has to be used
 139       vui->use_tx_spinlock = 1;
 140       if (thread_index == 0)
 141         {
 142           //Could not find a single valid one
 143           for (thread_index = 0;
 144                thread_index < vlib_get_thread_main ()->n_vlib_mains;
 145                thread_index++)
 146             {
 147               vui->per_cpu_tx_qid[thread_index] = 0;
 148             }
 149           return;
 150         }
 151     }
 152 }
 153
 154 /**
 155  * @brief Unassign existing interface/queue to thread mappings and re-assign
 156  * new interface/queue to thread mappings
 157  */
 158 static_always_inline void
 159 vhost_user_rx_thread_placement (vhost_user_intf_t * vui, u32 qid)
 160 {
 161   vhost_user_vring_t *txvq = &vui->vrings[qid];
 162   vnet_main_t *vnm = vnet_get_main ();
 163   int rv;
 164   u32 q = qid >> 1;
 165
 166   ASSERT ((qid & 1) == 1);      // should be odd
 167   // Assign new queue mappings for the interface
 168   vnet_hw_interface_set_input_node (vnm, vui->hw_if_index,
 169                                     vhost_user_input_node.index);
 170   vnet_hw_interface_assign_rx_thread (vnm, vui->hw_if_index, q, ~0);
 171   if (txvq->mode == VNET_HW_IF_RX_MODE_UNKNOWN)
 172     /* Set polling as the default */
 173     txvq->mode = VNET_HW_IF_RX_MODE_POLLING;
 174   txvq->qid = q;
 175   rv = vnet_hw_interface_set_rx_mode (vnm, vui->hw_if_index, q, txvq->mode);
 176   if (rv)
 177     vu_log_warn (vui, "unable to set rx mode for interface %d, "
 178                  "queue %d: rc=%d", vui->hw_if_index, q, rv);
 179 }
 180
 181 /** @brief Returns whether at least one TX and one RX vring are enabled */
 182 static_always_inline int
 183 vhost_user_intf_ready (vhost_user_intf_t * vui)
 184 {
 185   int i, found[2] = { };        //RX + TX
 186
 187   for (i = 0; i < VHOST_VRING_MAX_N; i++)
 188     if (vui->vrings[i].started && vui->vrings[i].enabled)
 189       found[i & 1] = 1;
 190
 191   return found[0] && found[1];
 192 }
 193
 194 static_always_inline void
 195 vhost_user_update_iface_state (vhost_user_intf_t * vui)
 196 {
 197   /* if we have pointers to descriptor table, go up */
 198   int is_ready = vhost_user_intf_ready (vui);
 199   if (is_ready != vui->is_ready)
 200     {
 201       vu_log_debug (vui, "interface %d %s", vui->sw_if_index,
 202                     is_ready ? "ready" : "down");
 203       if (vui->admin_up)
 204         vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
 205                                      is_ready ? VNET_HW_INTERFACE_FLAG_LINK_UP
 206                                      : 0);
 207       vui->is_ready = is_ready;
 208     }
 209 }
 210
 211 static void
 212 vhost_user_set_interrupt_pending (vhost_user_intf_t * vui, u32 ifq)
 213 {
 214   u32 qid;
 215   vnet_main_t *vnm = vnet_get_main ();
 216
 217   qid = ifq & 0xff;
 218   if ((qid & 1) == 0)
 219     /* Only care about the odd number, or TX, virtqueue */
 220     return;
 221
 222   if (vhost_user_intf_ready (vui))
 223     // qid >> 1 is to convert virtqueue number to vring queue index
 224     vnet_device_input_set_interrupt_pending (vnm, vui->hw_if_index, qid >> 1);
 225 }
 226
 227 static clib_error_t *
 228 vhost_user_callfd_read_ready (clib_file_t * uf)
 229 {
 230   __attribute__ ((unused)) int n;
 231   u8 buff[8];
 232
 233   n = read (uf->file_descriptor, ((char *) &buff), 8);
 234
 235   return 0;
 236 }
 237
 238 static_always_inline void
 239 vhost_user_thread_placement (vhost_user_intf_t * vui, u32 qid)
 240 {
 241   if (qid & 1)                  // RX is odd, TX is even
 242     {
 243       if (vui->vrings[qid].qid == -1)
 244         vhost_user_rx_thread_placement (vui, qid);
 245     }
 246   else
 247     vhost_user_tx_thread_placement (vui);
 248 }
 249
 250 static clib_error_t *
 251 vhost_user_kickfd_read_ready (clib_file_t * uf)
 252 {
 253   __attribute__ ((unused)) int n;
 254   u8 buff[8];
 255   vhost_user_intf_t *vui =
 256     pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
 257                        uf->private_data >> 8);
 258   u32 qid = uf->private_data & 0xff;
 259
 260   n = read (uf->file_descriptor, ((char *) &buff), 8);
 261   vu_log_debug (vui, "if %d KICK queue %d", uf->private_data >> 8, qid);
 262   if (!vui->vrings[qid].started ||
 263       (vhost_user_intf_ready (vui) != vui->is_ready))
 264     {
 265       if (vui->vrings[qid].started == 0)
 266         {
 267           vui->vrings[qid].started = 1;
 268           vhost_user_thread_placement (vui, qid);
 269           vhost_user_update_iface_state (vui);
 270         }
 271     }
 272
 273   vhost_user_set_interrupt_pending (vui, uf->private_data);
 274   return 0;
 275 }
 276
 277 static_always_inline void
 278 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
 279 {
 280   vhost_user_vring_t *vring = &vui->vrings[qid];
 281   clib_memset (vring, 0, sizeof (*vring));
 282   vring->kickfd_idx = ~0;
 283   vring->callfd_idx = ~0;
 284   vring->errfd = -1;
 285   vring->qid = -1;
 286
 287   /*
 288    * We have a bug with some qemu 2.5, and this may be a fix.
 289    * Feel like interpretation holy text, but this is from vhost-user.txt.
 290    * "
 291    * One queue pair is enabled initially. More queues are enabled
 292    * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
 293    * "
 294    * Don't know who's right, but this is what DPDK does.
 295    */
 296   if (qid == 0 || qid == 1)
 297     vring->enabled = 1;
 298 }
 299
 300 static_always_inline void
 301 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
 302 {
 303   vhost_user_vring_t *vring = &vui->vrings[qid];
 304
 305   if (vring->kickfd_idx != ~0)
 306     {
 307       clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
 308                                            vring->kickfd_idx);
 309       clib_file_del (&file_main, uf);
 310       vring->kickfd_idx = ~0;
 311     }
 312   if (vring->callfd_idx != ~0)
 313     {
 314       clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
 315                                            vring->callfd_idx);
 316       clib_file_del (&file_main, uf);
 317       vring->callfd_idx = ~0;
 318     }
 319   if (vring->errfd != -1)
 320     {
 321       close (vring->errfd);
 322       vring->errfd = -1;
 323     }
 324
 325   // save the qid so that we don't need to unassign and assign_rx_thread
 326   // when the interface comes back up. They are expensive calls.
 327   u16 q = vui->vrings[qid].qid;
 328   vhost_user_vring_init (vui, qid);
 329   vui->vrings[qid].qid = q;
 330 }
 331
 332 static_always_inline void
 333 vhost_user_if_disconnect (vhost_user_intf_t * vui)
 334 {
 335   vnet_main_t *vnm = vnet_get_main ();
 336   int q;
 337
 338   vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
 339
 340   if (vui->clib_file_index != ~0)
 341     {
 342       clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
 343       vui->clib_file_index = ~0;
 344     }
 345
 346   vui->is_ready = 0;
 347
 348   for (q = 0; q < VHOST_VRING_MAX_N; q++)
 349     vhost_user_vring_close (vui, q);
 350
 351   unmap_all_mem_regions (vui);
 352   vu_log_debug (vui, "interface ifindex %d disconnected", vui->sw_if_index);
 353 }
 354
 355 static clib_error_t *
 356 vhost_user_socket_read (clib_file_t * uf)
 357 {
 358   int n, i, j;
 359   int fd, number_of_fds = 0;
 360   int fds[VHOST_MEMORY_MAX_NREGIONS];
 361   vhost_user_msg_t msg;
 362   struct msghdr mh;
 363   struct iovec iov[1];
 364   vhost_user_main_t *vum = &vhost_user_main;
 365   vhost_user_intf_t *vui;
 366   struct cmsghdr *cmsg;
 367   u8 q;
 368   clib_file_t template = { 0 };
 369   vnet_main_t *vnm = vnet_get_main ();
 370   vlib_main_t *vm = vlib_get_main ();
 371
 372   vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
 373
 374   char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
 375
 376   clib_memset (&mh, 0, sizeof (mh));
 377   clib_memset (control, 0, sizeof (control));
 378
 379   for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
 380     fds[i] = -1;
 381
 382   /* set the payload */
 383   iov[0].iov_base = (void *) &msg;
 384   iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
 385
 386   mh.msg_iov = iov;
 387   mh.msg_iovlen = 1;
 388   mh.msg_control = control;
 389   mh.msg_controllen = sizeof (control);
 390
 391   n = recvmsg (uf->file_descriptor, &mh, 0);
 392
 393   if (n != VHOST_USER_MSG_HDR_SZ)
 394     {
 395       if (n == -1)
 396         {
 397           vu_log_debug (vui, "recvmsg returned error %d %s", errno,
 398                         strerror (errno));
 399         }
 400       else
 401         {
 402           vu_log_debug (vui, "n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
 403                         n, VHOST_USER_MSG_HDR_SZ);
 404         }
 405       goto close_socket;
 406     }
 407
 408   if (mh.msg_flags & MSG_CTRUNC)
 409     {
 410       vu_log_debug (vui, "MSG_CTRUNC is set");
 411       goto close_socket;
 412     }
 413
 414   cmsg = CMSG_FIRSTHDR (&mh);
 415
 416   if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
 417       (cmsg->cmsg_type == SCM_RIGHTS) &&
 418       (cmsg->cmsg_len - CMSG_LEN (0) <=
 419        VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
 420     {
 421       number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
 422       clib_memcpy_fast (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
 423     }
 424
 425   /* version 1, no reply bit set */
 426   if ((msg.flags & 7) != 1)
 427     {
 428       vu_log_debug (vui, "malformed message received. closing socket");
 429       goto close_socket;
 430     }
 431
 432   {
 433     int rv;
 434     rv =
 435       read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
 436             msg.size);
 437     if (rv < 0)
 438       {
 439         vu_log_debug (vui, "read failed %s", strerror (errno));
 440         goto close_socket;
 441       }
 442     else if (rv != msg.size)
 443       {
 444         vu_log_debug (vui, "message too short (read %dB should be %dB)", rv,
 445                       msg.size);
 446         goto close_socket;
 447       }
 448   }
 449
 450   switch (msg.request)
 451     {
 452     case VHOST_USER_GET_FEATURES:
 453       msg.flags |= 4;
 454       msg.u64 = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) |
 455         VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ) |
 456         VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT) |
 457         VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC) |
 458         VIRTIO_FEATURE (VHOST_F_LOG_ALL) |
 459         VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_ANNOUNCE) |
 460         VIRTIO_FEATURE (VIRTIO_NET_F_MQ) |
 461         VIRTIO_FEATURE (VHOST_USER_F_PROTOCOL_FEATURES) |
 462         VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
 463       msg.u64 &= vui->feature_mask;
 464
 465       if (vui->enable_gso)
 466         msg.u64 |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS;
 467       if (vui->enable_packed)
 468         msg.u64 |= VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
 469
 470       msg.size = sizeof (msg.u64);
 471       vu_log_debug (vui, "if %d msg VHOST_USER_GET_FEATURES - reply "
 472                     "0x%016llx", vui->hw_if_index, msg.u64);
 473       n =
 474         send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
 475       if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
 476         {
 477           vu_log_debug (vui, "could not send message response");
 478           goto close_socket;
 479         }
 480       break;
 481
 482     case VHOST_USER_SET_FEATURES:
 483       vu_log_debug (vui, "if %d msg VHOST_USER_SET_FEATURES features "
 484                     "0x%016llx", vui->hw_if_index, msg.u64);
 485
 486       vui->features = msg.u64;
 487
 488       if (vui->features &
 489           (VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) |
 490            VIRTIO_FEATURE (VIRTIO_F_VERSION_1)))
 491         vui->virtio_net_hdr_sz = 12;
 492       else
 493         vui->virtio_net_hdr_sz = 10;
 494
 495       vui->is_any_layout =
 496         (vui->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
 497
 498       ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
 499       vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vui->hw_if_index);
 500       if (vui->enable_gso &&
 501           ((vui->features & FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS)
 502            == FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS))
 503         hw->flags |=
 504           (VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
 505            VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD);
 506       else
 507         hw->flags &= ~(VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
 508                        VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD);
 509       vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
 510       vui->is_ready = 0;
 511       vhost_user_update_iface_state (vui);
 512       break;
 513
 514     case VHOST_USER_SET_MEM_TABLE:
 515       vu_log_debug (vui, "if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
 516                     vui->hw_if_index, msg.memory.nregions);
 517
 518       if ((msg.memory.nregions < 1) ||
 519           (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
 520         {
 521           vu_log_debug (vui, "number of mem regions must be between 1 and %i",
 522                         VHOST_MEMORY_MAX_NREGIONS);
 523           goto close_socket;
 524         }
 525
 526       if (msg.memory.nregions != number_of_fds)
 527         {
 528           vu_log_debug (vui, "each memory region must have FD");
 529           goto close_socket;
 530         }
 531
 532       /* Do the mmap without barrier sync */
 533       void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
 534       for (i = 0; i < msg.memory.nregions; i++)
 535         {
 536           long page_sz = get_huge_page_size (fds[i]);
 537
 538           /* align size to page */
 539           ssize_t map_sz = (msg.memory.regions[i].memory_size +
 540                             msg.memory.regions[i].mmap_offset +
 541                             page_sz - 1) & ~(page_sz - 1);
 542
 543           region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
 544                                       MAP_SHARED, fds[i], 0);
 545           if (region_mmap_addr[i] == MAP_FAILED)
 546             {
 547               vu_log_err (vui, "failed to map memory. errno is %d", errno);
 548               for (j = 0; j < i; j++)
 549                 munmap (region_mmap_addr[j], map_sz);
 550               goto close_socket;
 551             }
 552           vu_log_debug (vui, "map memory region %d addr 0 len 0x%lx fd %d "
 553                         "mapped 0x%lx page_sz 0x%x", i, map_sz, fds[i],
 554                         region_mmap_addr[i], page_sz);
 555         }
 556
 557       vlib_worker_thread_barrier_sync (vm);
 558       unmap_all_mem_regions (vui);
 559       for (i = 0; i < msg.memory.nregions; i++)
 560         {
 561           clib_memcpy_fast (&(vui->regions[i]), &msg.memory.regions[i],
 562                             sizeof (vhost_user_memory_region_t));
 563
 564           vui->region_mmap_addr[i] = region_mmap_addr[i];
 565           vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
 566           vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
 567             vui->regions[i].memory_size;
 568
 569           vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
 570           vui->region_mmap_fd[i] = fds[i];
 571
 572           vui->nregions++;
 573         }
 574
 575       /*
 576        * Re-compute desc, used, and avail descriptor table if vring address
 577        * is set.
 578        */
 579       for (q = 0; q < VHOST_VRING_MAX_N; q++)
 580         {
 581           if (vui->vrings[q].desc_user_addr &&
 582               vui->vrings[q].used_user_addr && vui->vrings[q].avail_user_addr)
 583             {
 584               vui->vrings[q].desc =
 585                 map_user_mem (vui, vui->vrings[q].desc_user_addr);
 586               vui->vrings[q].used =
 587                 map_user_mem (vui, vui->vrings[q].used_user_addr);
 588               vui->vrings[q].avail =
 589                 map_user_mem (vui, vui->vrings[q].avail_user_addr);
 590             }
 591         }
 592       vlib_worker_thread_barrier_release (vm);
 593       break;
 594
 595     case VHOST_USER_SET_VRING_NUM:
 596       vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
 597                     vui->hw_if_index, msg.state.index, msg.state.num);
 598
 599       if ((msg.state.num > 32768) ||    /* maximum ring size is 32768 */
 600           (msg.state.num == 0) ||       /* it cannot be zero */
 601           ((msg.state.num - 1) & msg.state.num) ||      /* must be power of 2 */
 602           (msg.state.index >= VHOST_VRING_MAX_N))
 603         goto close_socket;
 604       vui->vrings[msg.state.index].qsz_mask = msg.state.num - 1;
 605       break;
 606
 607     case VHOST_USER_SET_VRING_ADDR:
 608       vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
 609                     vui->hw_if_index, msg.state.index);
 610
 611       if (msg.state.index >= VHOST_VRING_MAX_N)
 612         {
 613           vu_log_debug (vui, "invalid vring index VHOST_USER_SET_VRING_ADDR:"
 614                         " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
 615           goto close_socket;
 616         }
 617
 618       if (msg.size < sizeof (msg.addr))
 619         {
 620           vu_log_debug (vui, "vhost message is too short (%d < %d)",
 621                         msg.size, sizeof (msg.addr));
 622           goto close_socket;
 623         }
 624
 625       vring_desc_t *desc = map_user_mem (vui, msg.addr.desc_user_addr);
 626       vring_used_t *used = map_user_mem (vui, msg.addr.used_user_addr);
 627       vring_avail_t *avail = map_user_mem (vui, msg.addr.avail_user_addr);
 628
 629       if ((desc == NULL) || (used == NULL) || (avail == NULL))
 630         {
 631           vu_log_debug (vui, "failed to map user memory for hw_if_index %d",
 632                         vui->hw_if_index);
 633           goto close_socket;
 634         }
 635
 636       vui->vrings[msg.state.index].desc_user_addr = msg.addr.desc_user_addr;
 637       vui->vrings[msg.state.index].used_user_addr = msg.addr.used_user_addr;
 638       vui->vrings[msg.state.index].avail_user_addr = msg.addr.avail_user_addr;
 639
 640       vlib_worker_thread_barrier_sync (vm);
 641       vui->vrings[msg.state.index].desc = desc;
 642       vui->vrings[msg.state.index].used = used;
 643       vui->vrings[msg.state.index].avail = avail;
 644
 645       vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
 646       vui->vrings[msg.state.index].log_used =
 647         (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
 648
 649       /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
 650          the ring is initialized in an enabled state. */
 651       if (!(vui->features & VIRTIO_FEATURE (VHOST_USER_F_PROTOCOL_FEATURES)))
 652         vui->vrings[msg.state.index].enabled = 1;
 653
 654       vui->vrings[msg.state.index].last_used_idx =
 655         vui->vrings[msg.state.index].last_avail_idx =
 656         vui->vrings[msg.state.index].used->idx;
 657
 658       /* tell driver that we don't want interrupts */
 659       if (vhost_user_is_packed_ring_supported (vui))
 660         vui->vrings[msg.state.index].used_event->flags =
 661           VRING_EVENT_F_DISABLE;
 662       else
 663         vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
 664       vlib_worker_thread_barrier_release (vm);
 665       vhost_user_update_iface_state (vui);
 666       break;
 667
 668     case VHOST_USER_SET_OWNER:
 669       vu_log_debug (vui, "if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
 670       break;
 671
 672     case VHOST_USER_RESET_OWNER:
 673       vu_log_debug (vui, "if %d msg VHOST_USER_RESET_OWNER",
 674                     vui->hw_if_index);
 675       break;
 676
 677     case VHOST_USER_SET_VRING_CALL:
 678       vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_CALL %d",
 679                     vui->hw_if_index, msg.u64);
 680
 681       q = (u8) (msg.u64 & 0xFF);
 682       if (q >= VHOST_VRING_MAX_N)
 683         goto close_socket;
 684
 685       /* if there is old fd, delete and close it */
 686       if (vui->vrings[q].callfd_idx != ~0)
 687         {
 688           clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
 689                                                vui->vrings[q].callfd_idx);
 690           clib_file_del (&file_main, uf);
 691           vui->vrings[q].callfd_idx = ~0;
 692         }
 693
 694       if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
 695         {
 696           if (number_of_fds != 1)
 697             {
 698               vu_log_debug (vui, "More than one fd received !");
 699               goto close_socket;
 700             }
 701
 702           template.read_function = vhost_user_callfd_read_ready;
 703           template.file_descriptor = fds[0];
 704           template.private_data =
 705             ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
 706           vui->vrings[q].callfd_idx = clib_file_add (&file_main, &template);
 707         }
 708       else
 709         vui->vrings[q].callfd_idx = ~0;
 710       break;
 711
 712     case VHOST_USER_SET_VRING_KICK:
 713       vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_KICK %d",
 714                     vui->hw_if_index, msg.u64);
 715
 716       q = (u8) (msg.u64 & 0xFF);
 717       if (q >= VHOST_VRING_MAX_N)
 718         goto close_socket;
 719
 720       if (vui->vrings[q].kickfd_idx != ~0)
 721         {
 722           clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
 723                                                vui->vrings[q].kickfd_idx);
 724           clib_file_del (&file_main, uf);
 725           vui->vrings[q].kickfd_idx = ~0;
 726         }
 727
 728       if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
 729         {
 730           if (number_of_fds != 1)
 731             {
 732               vu_log_debug (vui, "More than one fd received !");
 733               goto close_socket;
 734             }
 735
 736           template.read_function = vhost_user_kickfd_read_ready;
 737           template.file_descriptor = fds[0];
 738           template.private_data =
 739             (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
 740             q;
 741           vui->vrings[q].kickfd_idx = clib_file_add (&file_main, &template);
 742         }
 743       else
 744         {
 745           //When no kickfd is set, the queue is initialized as started
 746           vui->vrings[q].kickfd_idx = ~0;
 747           vui->vrings[q].started = 1;
 748           vhost_user_thread_placement (vui, q);
 749         }
 750       vhost_user_update_iface_state (vui);
 751       break;
 752
 753     case VHOST_USER_SET_VRING_ERR:
 754       vu_log_debug (vui, "if %d msg VHOST_USER_SET_VRING_ERR %d",
 755                     vui->hw_if_index, msg.u64);
 756
 757       q = (u8) (msg.u64 & 0xFF);
 758       if (q >= VHOST_VRING_MAX_N)
 759         goto close_socket;
 760
 761       if (vui->vrings[q].errfd != -1)
 762         close (vui->vrings[q].errfd);
 763
 764       if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
 765         {
 766           if (number_of_fds != 1)
 767             goto close_socket;
 768
 769           vui->vrings[q].errfd = fds[0];
 770         }
 771       else
 772         vui->vrings[q].errfd = -1;
 773       break;
 774
 775     case VHOST_USER_SET_VRING_BASE:
 776       vu_log_debug (vui,
 777                     "if %d msg VHOST_USER_SET_VRING_BASE idx %d num 0x%x",
 778                     vui->hw_if_index, msg.state.index, msg.state.num);
 779       if (msg.state.index >= VHOST_VRING_MAX_N)
 780         goto close_socket;
 781       vlib_worker_thread_barrier_sync (vm);
 782       vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
 783       if (vhost_user_is_packed_ring_supported (vui))
 784         {
 785           /*
 786            *  0                   1                   2                   3
 787            *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 788            * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 789            * |    last avail idx           | |     last used idx           | |
 790            * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 791            *                                ^                               ^
 792            *                                |                               |
 793            *                         avail wrap counter       used wrap counter
 794            */
 795           /* last avail idx at bit 0-14. */
 796           vui->vrings[msg.state.index].last_avail_idx =
 797             msg.state.num & 0x7fff;
 798           /* avail wrap counter at bit 15 */
 799           vui->vrings[msg.state.index].avail_wrap_counter =
 800             ! !(msg.state.num & (1 << 15));
 801
 802           /*
 803            * Although last_used_idx is passed in the upper 16 bits in qemu
 804            * implementation, in practice, last_avail_idx and last_used_idx are
 805            * usually the same. As a result, DPDK does not bother to pass us
 806            * last_used_idx. The spec is not clear on thex coding. I figured it
 807            * out by reading the qemu code. So let's just read last_avail_idx
 808            * and set last_used_idx equals to last_avail_idx.
 809            */
 810           vui->vrings[msg.state.index].last_used_idx =
 811             vui->vrings[msg.state.index].last_avail_idx;
 812           vui->vrings[msg.state.index].used_wrap_counter =
 813             vui->vrings[msg.state.index].avail_wrap_counter;
 814
 815           if (vui->vrings[msg.state.index].avail_wrap_counter == 1)
 816             vui->vrings[msg.state.index].avail_wrap_counter =
 817               VRING_DESC_F_AVAIL;
 818         }
 819       vlib_worker_thread_barrier_release (vm);
 820       break;
 821
 822     case VHOST_USER_GET_VRING_BASE:
 823       if (msg.state.index >= VHOST_VRING_MAX_N)
 824         {
 825           vu_log_debug (vui, "invalid vring index VHOST_USER_GET_VRING_BASE:"
 826                         " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
 827           goto close_socket;
 828         }
 829
 830       /* protection is needed to prevent rx/tx from changing last_avail_idx */
 831       vlib_worker_thread_barrier_sync (vm);
 832       /*
 833        * Copy last_avail_idx from the vring before closing it because
 834        * closing the vring also initializes the vring last_avail_idx
 835        */
 836       msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
 837       if (vhost_user_is_packed_ring_supported (vui))
 838         {
 839           msg.state.num =
 840             (vui->vrings[msg.state.index].last_avail_idx & 0x7fff) |
 841             (! !vui->vrings[msg.state.index].avail_wrap_counter << 15);
 842           msg.state.num |=
 843             ((vui->vrings[msg.state.index].last_used_idx & 0x7fff) |
 844              (! !vui->vrings[msg.state.index].used_wrap_counter << 15)) << 16;
 845         }
 846       msg.flags |= 4;
 847       msg.size = sizeof (msg.state);
 848
 849       /*
 850        * Spec says: Client must [...] stop ring upon receiving
 851        * VHOST_USER_GET_VRING_BASE
 852        */
 853       vhost_user_vring_close (vui, msg.state.index);
 854       vlib_worker_thread_barrier_release (vm);
 855       vu_log_debug (vui,
 856                     "if %d msg VHOST_USER_GET_VRING_BASE idx %d num 0x%x",
 857                     vui->hw_if_index, msg.state.index, msg.state.num);
 858       n =
 859         send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
 860       if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
 861         {
 862           vu_log_debug (vui, "could not send message response");
 863           goto close_socket;
 864         }
 865       vhost_user_update_iface_state (vui);
 866       break;
 867
 868     case VHOST_USER_NONE:
 869       vu_log_debug (vui, "if %d msg VHOST_USER_NONE", vui->hw_if_index);
 870       break;
 871
 872     case VHOST_USER_SET_LOG_BASE:
 873       vu_log_debug (vui, "if %d msg VHOST_USER_SET_LOG_BASE",
 874                     vui->hw_if_index);
 875
 876       if (msg.size != sizeof (msg.log))
 877         {
 878           vu_log_debug (vui, "invalid msg size for VHOST_USER_SET_LOG_BASE:"
 879                         " %d instead of %d", msg.size, sizeof (msg.log));
 880           goto close_socket;
 881         }
 882
 883       if (!(vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
 884         {
 885           vu_log_debug (vui, "VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but "
 886                         "VHOST_USER_SET_LOG_BASE received");
 887           goto close_socket;
 888         }
 889
 890       fd = fds[0];
 891       /* align size to page */
 892       long page_sz = get_huge_page_size (fd);
 893       ssize_t map_sz =
 894         (msg.log.size + msg.log.offset + page_sz - 1) & ~(page_sz - 1);
 895
 896       void *log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
 897                                   MAP_SHARED, fd, 0);
 898
 899       vu_log_debug (vui, "map log region addr 0 len 0x%lx off 0x%lx fd %d "
 900                     "mapped 0x%lx", map_sz, msg.log.offset, fd,
 901                     log_base_addr);
 902
 903       if (log_base_addr == MAP_FAILED)
 904         {
 905           vu_log_err (vui, "failed to map memory. errno is %d", errno);
 906           goto close_socket;
 907         }
 908
 909       vlib_worker_thread_barrier_sync (vm);
 910       vui->log_base_addr = log_base_addr;
 911       vui->log_base_addr += msg.log.offset;
 912       vui->log_size = msg.log.size;
 913       vlib_worker_thread_barrier_release (vm);
 914
 915       msg.flags |= 4;
 916       msg.size = sizeof (msg.u64);
 917       n =
 918         send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
 919       if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
 920         {
 921           vu_log_debug (vui, "could not send message response");
 922           goto close_socket;
 923         }
 924       break;
 925
 926     case VHOST_USER_SET_LOG_FD:
 927       vu_log_debug (vui, "if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
 928       break;
 929
 930     case VHOST_USER_GET_PROTOCOL_FEATURES:
 931       msg.flags |= 4;
 932       msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
 933         (1 << VHOST_USER_PROTOCOL_F_MQ);
 934       msg.size = sizeof (msg.u64);
 935       vu_log_debug (vui, "if %d msg VHOST_USER_GET_PROTOCOL_FEATURES - "
 936                     "reply 0x%016llx", vui->hw_if_index, msg.u64);
 937       n =
 938         send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
 939       if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
 940         {
 941           vu_log_debug (vui, "could not send message response");
 942           goto close_socket;
 943         }
 944       break;
 945
 946     case VHOST_USER_SET_PROTOCOL_FEATURES:
 947       vu_log_debug (vui, "if %d msg VHOST_USER_SET_PROTOCOL_FEATURES "
 948                     "features 0x%016llx", vui->hw_if_index, msg.u64);
 949       vui->protocol_features = msg.u64;
 950       break;
 951
 952     case VHOST_USER_GET_QUEUE_NUM:
 953       msg.flags |= 4;
 954       msg.u64 = VHOST_VRING_MAX_N;
 955       msg.size = sizeof (msg.u64);
 956       vu_log_debug (vui, "if %d msg VHOST_USER_GET_QUEUE_NUM - reply %d",
 957                     vui->hw_if_index, msg.u64);
 958       n =
 959         send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
 960       if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
 961         {
 962           vu_log_debug (vui, "could not send message response");
 963           goto close_socket;
 964         }
 965       break;
 966
 967     case VHOST_USER_SET_VRING_ENABLE:
 968       vu_log_debug (vui, "if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
 969                     vui->hw_if_index, msg.state.num ? "enable" : "disable",
 970                     msg.state.index);
 971       if (msg.state.index >= VHOST_VRING_MAX_N)
 972         {
 973           vu_log_debug (vui, "invalid vring idx VHOST_USER_SET_VRING_ENABLE:"
 974                         " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
 975           goto close_socket;
 976         }
 977
 978       vui->vrings[msg.state.index].enabled = msg.state.num;
 979       vhost_user_thread_placement (vui, msg.state.index);
 980       vhost_user_update_iface_state (vui);
 981       break;
 982
 983     default:
 984       vu_log_debug (vui, "unknown vhost-user message %d received. "
 985                     "closing socket", msg.request);
 986       goto close_socket;
 987     }
 988
 989   return 0;
 990
 991 close_socket:
 992   vlib_worker_thread_barrier_sync (vm);
 993   vhost_user_if_disconnect (vui);
 994   vlib_worker_thread_barrier_release (vm);
 995   vhost_user_update_iface_state (vui);
 996   return 0;
 997 }
 998
 999 static clib_error_t *
1000 vhost_user_socket_error (clib_file_t * uf)
1001 {
1002   vlib_main_t *vm = vlib_get_main ();
1003   vhost_user_main_t *vum = &vhost_user_main;
1004   vhost_user_intf_t *vui =
1005     pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1006
1007   vu_log_debug (vui, "socket error on if %d", vui->sw_if_index);
1008   vlib_worker_thread_barrier_sync (vm);
1009   vhost_user_if_disconnect (vui);
1010   vlib_worker_thread_barrier_release (vm);
1011   return 0;
1012 }
1013
1014 static clib_error_t *
1015 vhost_user_socksvr_accept_ready (clib_file_t * uf)
1016 {
1017   int client_fd, client_len;
1018   struct sockaddr_un client;
1019   clib_file_t template = { 0 };
1020   vhost_user_main_t *vum = &vhost_user_main;
1021   vhost_user_intf_t *vui;
1022
1023   vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1024
1025   client_len = sizeof (client);
1026   client_fd = accept (uf->file_descriptor,
1027                       (struct sockaddr *) &client,
1028                       (socklen_t *) & client_len);
1029
1030   if (client_fd < 0)
1031     return clib_error_return_unix (0, "accept");
1032
1033   if (vui->clib_file_index != ~0)
1034     {
1035       vu_log_debug (vui, "Close client socket for vhost interface %d, fd %d",
1036                     vui->sw_if_index, UNIX_GET_FD (vui->clib_file_index));
1037       clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
1038     }
1039
1040   vu_log_debug (vui, "New client socket for vhost interface %d, fd %d",
1041                 vui->sw_if_index, client_fd);
1042   template.read_function = vhost_user_socket_read;
1043   template.error_function = vhost_user_socket_error;
1044   template.file_descriptor = client_fd;
1045   template.private_data = vui - vhost_user_main.vhost_user_interfaces;
1046   vui->clib_file_index = clib_file_add (&file_main, &template);
1047   return 0;
1048 }
1049
1050 static clib_error_t *
1051 vhost_user_init (vlib_main_t * vm)
1052 {
1053   vhost_user_main_t *vum = &vhost_user_main;
1054   vlib_thread_main_t *tm = vlib_get_thread_main ();
1055
1056   vum->log_default = vlib_log_register_class ("vhost-user", 0);
1057
1058   vum->coalesce_frames = 32;
1059   vum->coalesce_time = 1e-3;
1060
1061   vec_validate (vum->cpus, tm->n_vlib_mains - 1);
1062
1063   vhost_cpu_t *cpu;
1064   vec_foreach (cpu, vum->cpus)
1065   {
1066     /* This is actually not necessary as validate already zeroes it
1067      * Just keeping the loop here for later because I am lazy. */
1068     cpu->rx_buffers_len = 0;
1069   }
1070
1071   vum->random = random_default_seed ();
1072
1073   mhash_init_c_string (&vum->if_index_by_sock_name, sizeof (uword));
1074
1075   return 0;
1076 }
1077
1078 /* *INDENT-OFF* */
1079 VLIB_INIT_FUNCTION (vhost_user_init) =
1080 {
1081   .runs_after = VLIB_INITS("ip4_init"),
1082 };
1083 /* *INDENT-ON* */
1084
1085 static uword
1086 vhost_user_send_interrupt_process (vlib_main_t * vm,
1087                                    vlib_node_runtime_t * rt, vlib_frame_t * f)
1088 {
1089   vhost_user_intf_t *vui;
1090   f64 timeout = 3153600000.0 /* 100 years */ ;
1091   uword event_type, *event_data = 0;
1092   vhost_user_main_t *vum = &vhost_user_main;
1093   u16 qid;
1094   f64 now, poll_time_remaining;
1095   f64 next_timeout;
1096   u8 stop_timer = 0;
1097
1098   while (1)
1099     {
1100       poll_time_remaining =
1101         vlib_process_wait_for_event_or_clock (vm, timeout);
1102       event_type = vlib_process_get_events (vm, &event_data);
1103       vec_reset_length (event_data);
1104
1105       /*
1106        * Use the remaining timeout if it is less than coalesce time to avoid
1107        * resetting the existing timer in the middle of expiration
1108        */
1109       timeout = poll_time_remaining;
1110       if (vlib_process_suspend_time_is_zero (timeout) ||
1111           (timeout > vum->coalesce_time))
1112         timeout = vum->coalesce_time;
1113
1114       now = vlib_time_now (vm);
1115       switch (event_type)
1116         {
1117         case VHOST_USER_EVENT_STOP_TIMER:
1118           stop_timer = 1;
1119           break;
1120
1121         case VHOST_USER_EVENT_START_TIMER:
1122           stop_timer = 0;
1123           if (!vlib_process_suspend_time_is_zero (poll_time_remaining))
1124             break;
1125           /* fall through */
1126
1127         case ~0:
1128           /* *INDENT-OFF* */
1129           pool_foreach (vui, vum->vhost_user_interfaces, {
1130               next_timeout = timeout;
1131               for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid += 2)
1132                 {
1133                   vhost_user_vring_t *rxvq = &vui->vrings[qid];
1134                   vhost_user_vring_t *txvq = &vui->vrings[qid + 1];
1135
1136                   if (txvq->qid == -1)
1137                     continue;
1138                   if (txvq->n_since_last_int)
1139                     {
1140                       if (now >= txvq->int_deadline)
1141                         vhost_user_send_call (vm, txvq);
1142                       else
1143                         next_timeout = txvq->int_deadline - now;
1144                     }
1145
1146                   if (rxvq->n_since_last_int)
1147                     {
1148                       if (now >= rxvq->int_deadline)
1149                         vhost_user_send_call (vm, rxvq);
1150                       else
1151                         next_timeout = rxvq->int_deadline - now;
1152                     }
1153
1154                   if ((next_timeout < timeout) && (next_timeout > 0.0))
1155                     timeout = next_timeout;
1156                 }
1157           });
1158           /* *INDENT-ON* */
1159           break;
1160
1161         default:
1162           clib_warning ("BUG: unhandled event type %d", event_type);
1163           break;
1164         }
1165       /* No less than 1 millisecond */
1166       if (timeout < 1e-3)
1167         timeout = 1e-3;
1168       if (stop_timer)
1169         timeout = 3153600000.0;
1170     }
1171   return 0;
1172 }
1173
1174 /* *INDENT-OFF* */
1175 VLIB_REGISTER_NODE (vhost_user_send_interrupt_node) = {
1176     .function = vhost_user_send_interrupt_process,
1177     .type = VLIB_NODE_TYPE_PROCESS,
1178     .name = "vhost-user-send-interrupt-process",
1179 };
1180 /* *INDENT-ON* */
1181
1182 static uword
1183 vhost_user_process (vlib_main_t * vm,
1184                     vlib_node_runtime_t * rt, vlib_frame_t * f)
1185 {
1186   vhost_user_main_t *vum = &vhost_user_main;
1187   vhost_user_intf_t *vui;
1188   struct sockaddr_un sun;
1189   int sockfd;
1190   clib_file_t template = { 0 };
1191   f64 timeout = 3153600000.0 /* 100 years */ ;
1192   uword *event_data = 0;
1193
1194   sockfd = -1;
1195   sun.sun_family = AF_UNIX;
1196   template.read_function = vhost_user_socket_read;
1197   template.error_function = vhost_user_socket_error;
1198
1199   while (1)
1200     {
1201       vlib_process_wait_for_event_or_clock (vm, timeout);
1202       vlib_process_get_events (vm, &event_data);
1203       vec_reset_length (event_data);
1204
1205       timeout = 3.0;
1206
1207       /* *INDENT-OFF* */
1208       pool_foreach (vui, vum->vhost_user_interfaces, {
1209
1210           if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
1211               if (vui->clib_file_index == ~0)
1212                 {
1213                   if ((sockfd < 0) &&
1214                       ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0))
1215                     {
1216                       /*
1217                        * 1st time error or new error for this interface,
1218                        * spit out the message and record the error
1219                        */
1220                       if (!vui->sock_errno || (vui->sock_errno != errno))
1221                         {
1222                           clib_unix_warning
1223                             ("Error: Could not open unix socket for %s",
1224                              vui->sock_filename);
1225                           vui->sock_errno = errno;
1226                         }
1227                       continue;
1228                     }
1229
1230                   /* try to connect */
1231                   strncpy (sun.sun_path, (char *) vui->sock_filename,
1232                            sizeof (sun.sun_path) - 1);
1233                   sun.sun_path[sizeof (sun.sun_path) - 1] = 0;
1234
1235                   /* Avoid hanging VPP if the other end does not accept */
1236                   if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
1237                       clib_unix_warning ("fcntl");
1238
1239                   if (connect (sockfd, (struct sockaddr *) &sun,
1240                                sizeof (struct sockaddr_un)) == 0)
1241                     {
1242                       /* Set the socket to blocking as it was before */
1243                       if (fcntl(sockfd, F_SETFL, 0) < 0)
1244                         clib_unix_warning ("fcntl2");
1245
1246                       vui->sock_errno = 0;
1247                       template.file_descriptor = sockfd;
1248                       template.private_data =
1249                           vui - vhost_user_main.vhost_user_interfaces;
1250                       vui->clib_file_index = clib_file_add (&file_main, &template);
1251
1252                       /* This sockfd is considered consumed */
1253                       sockfd = -1;
1254                     }
1255                   else
1256                     {
1257                       vui->sock_errno = errno;
1258                     }
1259                 }
1260               else
1261                 {
1262                   /* check if socket is alive */
1263                   int error = 0;
1264                   socklen_t len = sizeof (error);
1265                   int fd = UNIX_GET_FD(vui->clib_file_index);
1266                   int retval =
1267                       getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
1268
1269                   if (retval)
1270                     {
1271                       vu_log_debug (vui, "getsockopt returned %d", retval);
1272                       vhost_user_if_disconnect (vui);
1273                     }
1274                 }
1275           }
1276       });
1277       /* *INDENT-ON* */
1278     }
1279   return 0;
1280 }
1281
1282 /* *INDENT-OFF* */
1283 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
1284     .function = vhost_user_process,
1285     .type = VLIB_NODE_TYPE_PROCESS,
1286     .name = "vhost-user-process",
1287 };
1288 /* *INDENT-ON* */
1289
1290 /**
1291  * Disables and reset interface structure.
1292  * It can then be either init again, or removed from used interfaces.
1293  */
1294 static void
1295 vhost_user_term_if (vhost_user_intf_t * vui)
1296 {
1297   int q;
1298   vhost_user_main_t *vum = &vhost_user_main;
1299
1300   // disconnect interface sockets
1301   vhost_user_if_disconnect (vui);
1302   vhost_user_update_gso_interface_count (vui, 0 /* delete */ );
1303   vhost_user_update_iface_state (vui);
1304
1305   for (q = 0; q < VHOST_VRING_MAX_N; q++)
1306     {
1307       // Remove existing queue mapping for the interface
1308       if (q & 1)
1309         {
1310           int rv;
1311           vnet_main_t *vnm = vnet_get_main ();
1312           vhost_user_vring_t *txvq = &vui->vrings[q];
1313
1314           if (txvq->qid != -1)
1315             {
1316               rv = vnet_hw_interface_unassign_rx_thread (vnm,
1317                                                          vui->hw_if_index,
1318                                                          q >> 1);
1319               if (rv)
1320                 vu_log_warn (vui, "unable to unassign interface %d, "
1321                              "queue %d: rc=%d", vui->hw_if_index, q >> 1, rv);
1322             }
1323         }
1324
1325       clib_mem_free ((void *) vui->vring_locks[q]);
1326     }
1327
1328   if (vui->unix_server_index != ~0)
1329     {
1330       //Close server socket
1331       clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
1332                                            vui->unix_server_index);
1333       clib_file_del (&file_main, uf);
1334       vui->unix_server_index = ~0;
1335       unlink (vui->sock_filename);
1336     }
1337
1338   mhash_unset (&vum->if_index_by_sock_name, vui->sock_filename,
1339                &vui->if_index);
1340 }
1341
1342 int
1343 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
1344 {
1345   vhost_user_main_t *vum = &vhost_user_main;
1346   vhost_user_intf_t *vui;
1347   int rv = 0;
1348   vnet_hw_interface_t *hwif;
1349   u16 qid;
1350
1351   if (!
1352       (hwif =
1353        vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index))
1354       || hwif->dev_class_index != vhost_user_device_class.index)
1355     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1356
1357   vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
1358
1359   vu_log_debug (vui, "Deleting vhost-user interface %s (instance %d)",
1360                 hwif->name, hwif->dev_instance);
1361
1362   for (qid = 1; qid < VHOST_VRING_MAX_N / 2; qid += 2)
1363     {
1364       vhost_user_vring_t *txvq = &vui->vrings[qid];
1365
1366       if (txvq->qid == -1)
1367         continue;
1368       if ((vum->ifq_count > 0) &&
1369           ((txvq->mode == VNET_HW_IF_RX_MODE_INTERRUPT) ||
1370            (txvq->mode == VNET_HW_IF_RX_MODE_ADAPTIVE)))
1371         {
1372           vum->ifq_count--;
1373           // Stop the timer if there is no more interrupt interface/queue
1374           if ((vum->ifq_count == 0) &&
1375               (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
1376             {
1377               vlib_process_signal_event (vm,
1378                                          vhost_user_send_interrupt_node.index,
1379                                          VHOST_USER_EVENT_STOP_TIMER, 0);
1380               break;
1381             }
1382         }
1383     }
1384
1385   // Disable and reset interface
1386   vhost_user_term_if (vui);
1387
1388   // Reset renumbered iface
1389   if (hwif->dev_instance <
1390       vec_len (vum->show_dev_instance_by_real_dev_instance))
1391     vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
1392
1393   // Delete ethernet interface
1394   ethernet_delete_interface (vnm, vui->hw_if_index);
1395
1396   // Back to pool
1397   pool_put (vum->vhost_user_interfaces, vui);
1398
1399   return rv;
1400 }
1401
1402 static clib_error_t *
1403 vhost_user_exit (vlib_main_t * vm)
1404 {
1405   vnet_main_t *vnm = vnet_get_main ();
1406   vhost_user_main_t *vum = &vhost_user_main;
1407   vhost_user_intf_t *vui;
1408
1409   vlib_worker_thread_barrier_sync (vlib_get_main ());
1410   /* *INDENT-OFF* */
1411   pool_foreach (vui, vum->vhost_user_interfaces, {
1412       vhost_user_delete_if (vnm, vm, vui->sw_if_index);
1413   });
1414   /* *INDENT-ON* */
1415   vlib_worker_thread_barrier_release (vlib_get_main ());
1416   return 0;
1417 }
1418
1419 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
1420
1421 /**
1422  * Open server unix socket on specified sock_filename.
1423  */
1424 static int
1425 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
1426 {
1427   int rv = 0;
1428   struct sockaddr_un un = { };
1429   int fd;
1430   /* create listening socket */
1431   if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
1432     return VNET_API_ERROR_SYSCALL_ERROR_1;
1433
1434   un.sun_family = AF_UNIX;
1435   strncpy ((char *) un.sun_path, (char *) sock_filename,
1436            sizeof (un.sun_path) - 1);
1437
1438   /* remove if exists */
1439   unlink ((char *) sock_filename);
1440
1441   if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
1442     {
1443       rv = VNET_API_ERROR_SYSCALL_ERROR_2;
1444       goto error;
1445     }
1446
1447   if (listen (fd, 1) == -1)
1448     {
1449       rv = VNET_API_ERROR_SYSCALL_ERROR_3;
1450       goto error;
1451     }
1452
1453   *sock_fd = fd;
1454   return 0;
1455
1456 error:
1457   close (fd);
1458   return rv;
1459 }
1460
1461 /**
1462  * Create ethernet interface for vhost user interface.
1463  */
1464 static void
1465 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
1466                             vhost_user_intf_t * vui, u8 * hwaddress)
1467 {
1468   vhost_user_main_t *vum = &vhost_user_main;
1469   u8 hwaddr[6];
1470   clib_error_t *error;
1471
1472   /* create hw and sw interface */
1473   if (hwaddress)
1474     {
1475       clib_memcpy (hwaddr, hwaddress, 6);
1476     }
1477   else
1478     {
1479       random_u32 (&vum->random);
1480       clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
1481       hwaddr[0] = 2;
1482       hwaddr[1] = 0xfe;
1483     }
1484
1485   error = ethernet_register_interface
1486     (vnm,
1487      vhost_user_device_class.index,
1488      vui - vum->vhost_user_interfaces /* device instance */ ,
1489      hwaddr /* ethernet address */ ,
1490      &vui->hw_if_index, 0 /* flag change */ );
1491
1492   if (error)
1493     clib_error_report (error);
1494 }
1495
1496 /*
1497  *  Initialize vui with specified attributes
1498  */
1499 static void
1500 vhost_user_vui_init (vnet_main_t * vnm,
1501                      vhost_user_intf_t * vui,
1502                      int server_sock_fd,
1503                      const char *sock_filename,
1504                      u64 feature_mask, u32 * sw_if_index, u8 enable_gso,
1505                      u8 enable_packed)
1506 {
1507   vnet_sw_interface_t *sw;
1508   int q;
1509   vhost_user_main_t *vum = &vhost_user_main;
1510   vnet_hw_interface_t *hw;
1511
1512   hw = vnet_get_hw_interface (vnm, vui->hw_if_index);
1513   sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
1514   if (server_sock_fd != -1)
1515     {
1516       clib_file_t template = { 0 };
1517       template.read_function = vhost_user_socksvr_accept_ready;
1518       template.file_descriptor = server_sock_fd;
1519       template.private_data = vui - vum->vhost_user_interfaces; //hw index
1520       vui->unix_server_index = clib_file_add (&file_main, &template);
1521     }
1522   else
1523     {
1524       vui->unix_server_index = ~0;
1525     }
1526
1527   vui->sw_if_index = sw->sw_if_index;
1528   strncpy (vui->sock_filename, sock_filename,
1529            ARRAY_LEN (vui->sock_filename) - 1);
1530   vui->sock_errno = 0;
1531   vui->is_ready = 0;
1532   vui->feature_mask = feature_mask;
1533   vui->clib_file_index = ~0;
1534   vui->log_base_addr = 0;
1535   vui->if_index = vui - vum->vhost_user_interfaces;
1536   vui->enable_gso = enable_gso;
1537   vui->enable_packed = enable_packed;
1538   /*
1539    * enable_gso takes precedence over configurable feature mask if there
1540    * is a clash.
1541    *   if feature mask disables gso, but enable_gso is configured,
1542    *     then gso is enable
1543    *   if feature mask enables gso, but enable_gso is not configured,
1544    *     then gso is enable
1545    *
1546    * if gso is enable via feature mask, it must enable both host and guest
1547    * gso feature mask, we don't support one sided GSO or partial GSO.
1548    */
1549   if ((vui->enable_gso == 0) &&
1550       ((feature_mask & FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS) ==
1551        (FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS)))
1552     vui->enable_gso = 1;
1553   vhost_user_update_gso_interface_count (vui, 1 /* add */ );
1554   mhash_set_mem (&vum->if_index_by_sock_name, vui->sock_filename,
1555                  &vui->if_index, 0);
1556
1557   for (q = 0; q < VHOST_VRING_MAX_N; q++)
1558     vhost_user_vring_init (vui, q);
1559
1560   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
1561   vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
1562
1563   if (sw_if_index)
1564     *sw_if_index = vui->sw_if_index;
1565
1566   for (q = 0; q < VHOST_VRING_MAX_N; q++)
1567     {
1568       vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
1569                                                     CLIB_CACHE_LINE_BYTES);
1570       clib_memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
1571     }
1572
1573   vec_validate (vui->per_cpu_tx_qid,
1574                 vlib_get_thread_main ()->n_vlib_mains - 1);
1575   vhost_user_tx_thread_placement (vui);
1576 }
1577
1578 int
1579 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
1580                       const char *sock_filename,
1581                       u8 is_server,
1582                       u32 * sw_if_index,
1583                       u64 feature_mask,
1584                       u8 renumber, u32 custom_dev_instance, u8 * hwaddr,
1585                       u8 enable_gso, u8 enable_packed)
1586 {
1587   vhost_user_intf_t *vui = NULL;
1588   u32 sw_if_idx = ~0;
1589   int rv = 0;
1590   int server_sock_fd = -1;
1591   vhost_user_main_t *vum = &vhost_user_main;
1592   uword *if_index;
1593
1594   if (sock_filename == NULL || !(strlen (sock_filename) > 0))
1595     {
1596       return VNET_API_ERROR_INVALID_ARGUMENT;
1597     }
1598
1599   if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
1600   if (if_index)
1601     {
1602       if (sw_if_index)
1603         {
1604           vui = &vum->vhost_user_interfaces[*if_index];
1605           *sw_if_index = vui->sw_if_index;
1606         }
1607       return VNET_API_ERROR_IF_ALREADY_EXISTS;
1608     }
1609
1610   if (is_server)
1611     {
1612       if ((rv =
1613            vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
1614         {
1615           return rv;
1616         }
1617     }
1618
1619   /* Protect the uninitialized vui from being dispatched by rx/tx */
1620   vlib_worker_thread_barrier_sync (vm);
1621   pool_get (vhost_user_main.vhost_user_interfaces, vui);
1622   vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
1623   vlib_worker_thread_barrier_release (vm);
1624
1625   vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
1626                        feature_mask, &sw_if_idx, enable_gso, enable_packed);
1627   vnet_sw_interface_set_mtu (vnm, vui->sw_if_index, 9000);
1628   vhost_user_rx_thread_placement (vui, 1);
1629
1630   if (renumber)
1631     vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1632
1633   if (sw_if_index)
1634     *sw_if_index = sw_if_idx;
1635
1636   // Process node must connect
1637   vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
1638
1639   return rv;
1640 }
1641
1642 int
1643 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
1644                       const char *sock_filename,
1645                       u8 is_server,
1646                       u32 sw_if_index,
1647                       u64 feature_mask, u8 renumber, u32 custom_dev_instance,
1648                       u8 enable_gso, u8 enable_packed)
1649 {
1650   vhost_user_main_t *vum = &vhost_user_main;
1651   vhost_user_intf_t *vui = NULL;
1652   u32 sw_if_idx = ~0;
1653   int server_sock_fd = -1;
1654   int rv = 0;
1655   vnet_hw_interface_t *hwif;
1656   uword *if_index;
1657
1658   if (!
1659       (hwif =
1660        vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index))
1661       || hwif->dev_class_index != vhost_user_device_class.index)
1662     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1663
1664   if (sock_filename == NULL || !(strlen (sock_filename) > 0))
1665     return VNET_API_ERROR_INVALID_ARGUMENT;
1666
1667   vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
1668
1669   /*
1670    * Disallow changing the interface to have the same path name
1671    * as other interface
1672    */
1673   if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
1674   if (if_index && (*if_index != vui->if_index))
1675     return VNET_API_ERROR_IF_ALREADY_EXISTS;
1676
1677   // First try to open server socket
1678   if (is_server)
1679     if ((rv = vhost_user_init_server_sock (sock_filename,
1680                                            &server_sock_fd)) != 0)
1681       return rv;
1682
1683   vhost_user_term_if (vui);
1684   vhost_user_vui_init (vnm, vui, server_sock_fd,
1685                        sock_filename, feature_mask, &sw_if_idx, enable_gso,
1686                        enable_packed);
1687
1688   if (renumber)
1689     vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1690
1691   // Process node must connect
1692   vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
1693
1694   return rv;
1695 }
1696
1697 clib_error_t *
1698 vhost_user_connect_command_fn (vlib_main_t * vm,
1699                                unformat_input_t * input,
1700                                vlib_cli_command_t * cmd)
1701 {
1702   unformat_input_t _line_input, *line_input = &_line_input;
1703   u8 *sock_filename = NULL;
1704   u32 sw_if_index;
1705   u8 is_server = 0;
1706   u64 feature_mask = (u64) ~ (0ULL);
1707   u8 renumber = 0;
1708   u32 custom_dev_instance = ~0;
1709   u8 hwaddr[6];
1710   u8 *hw = NULL;
1711   clib_error_t *error = NULL;
1712   u8 enable_gso = 0, enable_packed = 0;
1713
1714   /* Get a line of input. */
1715   if (!unformat_user (input, unformat_line_input, line_input))
1716     return 0;
1717
1718   /* GSO feature is disable by default */
1719   feature_mask &= ~FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS;
1720   /* packed-ring feature is disable by default */
1721   feature_mask &= ~VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
1722   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1723     {
1724       if (unformat (line_input, "socket %s", &sock_filename))
1725         ;
1726       else if (unformat (line_input, "server"))
1727         is_server = 1;
1728       else if (unformat (line_input, "gso"))
1729         enable_gso = 1;
1730       else if (unformat (line_input, "packed"))
1731         enable_packed = 1;
1732       else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
1733         ;
1734       else
1735         if (unformat
1736             (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
1737         hw = hwaddr;
1738       else if (unformat (line_input, "renumber %d", &custom_dev_instance))
1739         {
1740           renumber = 1;
1741         }
1742       else
1743         {
1744           error = clib_error_return (0, "unknown input `%U'",
1745                                      format_unformat_error, line_input);
1746           goto done;
1747         }
1748     }
1749
1750   vnet_main_t *vnm = vnet_get_main ();
1751
1752   int rv;
1753   if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
1754                                   is_server, &sw_if_index, feature_mask,
1755                                   renumber, custom_dev_instance, hw,
1756                                   enable_gso, enable_packed)))
1757     {
1758       error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
1759       goto done;
1760     }
1761
1762   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
1763                    sw_if_index);
1764
1765 done:
1766   vec_free (sock_filename);
1767   unformat_free (line_input);
1768
1769   return error;
1770 }
1771
1772 clib_error_t *
1773 vhost_user_delete_command_fn (vlib_main_t * vm,
1774                               unformat_input_t * input,
1775                               vlib_cli_command_t * cmd)
1776 {
1777   unformat_input_t _line_input, *line_input = &_line_input;
1778   u32 sw_if_index = ~0;
1779   vnet_main_t *vnm = vnet_get_main ();
1780   clib_error_t *error = NULL;
1781
1782   /* Get a line of input. */
1783   if (!unformat_user (input, unformat_line_input, line_input))
1784     return 0;
1785
1786   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1787     {
1788       if (unformat (line_input, "sw_if_index %d", &sw_if_index))
1789         ;
1790       else if (unformat
1791                (line_input, "%U", unformat_vnet_sw_interface, vnm,
1792                 &sw_if_index))
1793         {
1794           vnet_hw_interface_t *hwif =
1795             vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
1796           if (hwif == NULL ||
1797               vhost_user_device_class.index != hwif->dev_class_index)
1798             {
1799               error = clib_error_return (0, "Not a vhost interface");
1800               goto done;
1801             }
1802         }
1803       else
1804         {
1805           error = clib_error_return (0, "unknown input `%U'",
1806                                      format_unformat_error, line_input);
1807           goto done;
1808         }
1809     }
1810
1811   vhost_user_delete_if (vnm, vm, sw_if_index);
1812
1813 done:
1814   unformat_free (line_input);
1815
1816   return error;
1817 }
1818
1819 int
1820 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
1821                      vhost_user_intf_details_t ** out_vuids)
1822 {
1823   int rv = 0;
1824   vhost_user_main_t *vum = &vhost_user_main;
1825   vhost_user_intf_t *vui;
1826   vhost_user_intf_details_t *r_vuids = NULL;
1827   vhost_user_intf_details_t *vuid = NULL;
1828   u32 *hw_if_indices = 0;
1829   vnet_hw_interface_t *hi;
1830   int i;
1831
1832   if (!out_vuids)
1833     return -1;
1834
1835   pool_foreach (vui, vum->vhost_user_interfaces,
1836                 vec_add1 (hw_if_indices, vui->hw_if_index);
1837     );
1838
1839   for (i = 0; i < vec_len (hw_if_indices); i++)
1840     {
1841       hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1842       vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
1843
1844       vec_add2 (r_vuids, vuid, 1);
1845       vuid->sw_if_index = vui->sw_if_index;
1846       vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
1847       vuid->features = vui->features;
1848       vuid->num_regions = vui->nregions;
1849       vuid->is_server = vui->unix_server_index != ~0;
1850       vuid->sock_errno = vui->sock_errno;
1851       snprintf ((char *) vuid->sock_filename, sizeof (vuid->sock_filename),
1852                 "%s", vui->sock_filename);
1853       memcpy_s (vuid->if_name, sizeof (vuid->if_name), hi->name,
1854                 clib_min (vec_len (hi->name), sizeof (vuid->if_name) - 1));
1855       vuid->if_name[sizeof (vuid->if_name) - 1] = 0;
1856     }
1857
1858   vec_free (hw_if_indices);
1859
1860   *out_vuids = r_vuids;
1861
1862   return rv;
1863 }
1864
1865 static u8 *
1866 format_vhost_user_desc (u8 * s, va_list * args)
1867 {
1868   char *fmt = va_arg (*args, char *);
1869   vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1870   vring_desc_t *desc_table = va_arg (*args, vring_desc_t *);
1871   int idx = va_arg (*args, int);
1872   u32 *mem_hint = va_arg (*args, u32 *);
1873
1874   s = format (s, fmt, idx, desc_table[idx].addr, desc_table[idx].len,
1875               desc_table[idx].flags, desc_table[idx].next,
1876               pointer_to_uword (map_guest_mem (vui, desc_table[idx].addr,
1877                                                mem_hint)));
1878   return s;
1879 }
1880
1881 static u8 *
1882 format_vhost_user_vring (u8 * s, va_list * args)
1883 {
1884   char *fmt = va_arg (*args, char *);
1885   vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1886   int q = va_arg (*args, int);
1887
1888   s = format (s, fmt, vui->vrings[q].avail->flags, vui->vrings[q].avail->idx,
1889               vui->vrings[q].used->flags, vui->vrings[q].used->idx);
1890   return s;
1891 }
1892
1893 static void
1894 vhost_user_show_fds (vlib_main_t * vm, vhost_user_intf_t * vui, int q)
1895 {
1896   int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
1897   int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
1898
1899   vlib_cli_output (vm, "  kickfd %d callfd %d errfd %d\n", kickfd, callfd,
1900                    vui->vrings[q].errfd);
1901 }
1902
1903 static void
1904 vhost_user_show_desc (vlib_main_t * vm, vhost_user_intf_t * vui, int q,
1905                       int show_descr, int show_verbose)
1906 {
1907   int j;
1908   u32 mem_hint = 0;
1909   u32 idx;
1910   u32 n_entries;
1911   vring_desc_t *desc_table;
1912
1913   if (vui->vrings[q].avail && vui->vrings[q].used)
1914     vlib_cli_output (vm, "%U", format_vhost_user_vring,
1915                      "  avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
1916                      vui, q);
1917
1918   vhost_user_show_fds (vm, vui, q);
1919
1920   if (show_descr)
1921     {
1922       vlib_cli_output (vm, "\n  descriptor table:\n");
1923       vlib_cli_output (vm,
1924                        "  slot         addr         len  flags  next      "
1925                        "user_addr\n");
1926       vlib_cli_output (vm,
1927                        "  ===== ================== ===== ====== ===== "
1928                        "==================\n");
1929       for (j = 0; j < vui->vrings[q].qsz_mask + 1; j++)
1930         {
1931           desc_table = vui->vrings[q].desc;
1932           vlib_cli_output (vm, "%U", format_vhost_user_desc,
1933                            "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n", vui,
1934                            desc_table, j, &mem_hint);
1935           if (show_verbose && (desc_table[j].flags & VRING_DESC_F_INDIRECT))
1936             {
1937               n_entries = desc_table[j].len / sizeof (vring_desc_t);
1938               desc_table = map_guest_mem (vui, desc_table[j].addr, &mem_hint);
1939               if (desc_table)
1940                 {
1941                   for (idx = 0; idx < clib_min (20, n_entries); idx++)
1942                     {
1943                       vlib_cli_output
1944                         (vm, "%U", format_vhost_user_desc,
1945                          ">  %-4u 0x%016lx %-5u 0x%04x %-5u 0x%016lx\n", vui,
1946                          desc_table, idx, &mem_hint);
1947                     }
1948                   if (n_entries >= 20)
1949                     vlib_cli_output (vm, "Skip displaying entries 20...%u\n",
1950                                      n_entries);
1951                 }
1952             }
1953         }
1954     }
1955 }
1956
1957 static u8 *
1958 format_vhost_user_packed_desc (u8 * s, va_list * args)
1959 {
1960   char *fmt = va_arg (*args, char *);
1961   vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1962   vring_packed_desc_t *desc_table = va_arg (*args, vring_packed_desc_t *);
1963   int idx = va_arg (*args, int);
1964   u32 *mem_hint = va_arg (*args, u32 *);
1965
1966   s = format (s, fmt, idx, desc_table[idx].addr, desc_table[idx].len,
1967               desc_table[idx].flags, desc_table[idx].id,
1968               pointer_to_uword (map_guest_mem (vui, desc_table[idx].addr,
1969                                                mem_hint)));
1970   return s;
1971 }
1972
1973 static u8 *
1974 format_vhost_user_vring_packed (u8 * s, va_list * args)
1975 {
1976   char *fmt = va_arg (*args, char *);
1977   vhost_user_intf_t *vui = va_arg (*args, vhost_user_intf_t *);
1978   int q = va_arg (*args, int);
1979
1980   s = format (s, fmt, vui->vrings[q].avail_event->flags,
1981               vui->vrings[q].avail_event->off_wrap,
1982               vui->vrings[q].used_event->flags,
1983               vui->vrings[q].used_event->off_wrap,
1984               vui->vrings[q].avail_wrap_counter,
1985               vui->vrings[q].used_wrap_counter);
1986   return s;
1987 }
1988
1989 static void
1990 vhost_user_show_desc_packed (vlib_main_t * vm, vhost_user_intf_t * vui, int q,
1991                              int show_descr, int show_verbose)
1992 {
1993   int j;
1994   u32 mem_hint = 0;
1995   u32 idx;
1996   u32 n_entries;
1997   vring_packed_desc_t *desc_table;
1998
1999   if (vui->vrings[q].avail_event && vui->vrings[q].used_event)
2000     vlib_cli_output (vm, "%U", format_vhost_user_vring_packed,
2001                      "  avail_event.flags %x avail_event.off_wrap %u "
2002                      "used_event.flags %x used_event.off_wrap %u\n"
2003                      "  avail wrap counter %u, used wrap counter %u\n",
2004                      vui, q);
2005
2006   vhost_user_show_fds (vm, vui, q);
2007
2008   if (show_descr)
2009     {
2010       vlib_cli_output (vm, "\n  descriptor table:\n");
2011       vlib_cli_output (vm,
2012                        "  slot         addr         len  flags  id    "
2013                        "user_addr\n");
2014       vlib_cli_output (vm,
2015                        "  ===== ================== ===== ====== ===== "
2016                        "==================\n");
2017       for (j = 0; j < vui->vrings[q].qsz_mask + 1; j++)
2018         {
2019           desc_table = vui->vrings[q].packed_desc;
2020           vlib_cli_output (vm, "%U", format_vhost_user_packed_desc,
2021                            "  %-5u 0x%016lx %-5u 0x%04x %-5u 0x%016lx\n", vui,
2022                            desc_table, j, &mem_hint);
2023           if (show_verbose && (desc_table[j].flags & VRING_DESC_F_INDIRECT))
2024             {
2025               n_entries = desc_table[j].len >> 4;
2026               desc_table = map_guest_mem (vui, desc_table[j].addr, &mem_hint);
2027               if (desc_table)
2028                 {
2029                   for (idx = 0; idx < clib_min (20, n_entries); idx++)
2030                     {
2031                       vlib_cli_output
2032                         (vm, "%U", format_vhost_user_packed_desc,
2033                          ">  %-4u 0x%016lx %-5u 0x%04x %-5u 0x%016lx\n", vui,
2034                          desc_table, idx, &mem_hint);
2035                     }
2036                   if (n_entries >= 20)
2037                     vlib_cli_output (vm, "Skip displaying entries 20...%u\n",
2038                                      n_entries);
2039                 }
2040             }
2041         }
2042     }
2043 }
2044
2045 clib_error_t *
2046 show_vhost_user_command_fn (vlib_main_t * vm,
2047                             unformat_input_t * input,
2048                             vlib_cli_command_t * cmd)
2049 {
2050   clib_error_t *error = 0;
2051   vnet_main_t *vnm = vnet_get_main ();
2052   vhost_user_main_t *vum = &vhost_user_main;
2053   vhost_user_intf_t *vui;
2054   u32 hw_if_index, *hw_if_indices = 0;
2055   vnet_hw_interface_t *hi;
2056   u16 qid;
2057   u32 ci;
2058   int i, j, q;
2059   int show_descr = 0;
2060   int show_verbose = 0;
2061   struct feat_struct
2062   {
2063     u8 bit;
2064     char *str;
2065   };
2066   struct feat_struct *feat_entry;
2067
2068   static struct feat_struct feat_array[] = {
2069 #define _(s,b) { .str = #s, .bit = b, },
2070     foreach_virtio_net_features
2071 #undef _
2072     {.str = NULL}
2073   };
2074
2075 #define foreach_protocol_feature \
2076   _(VHOST_USER_PROTOCOL_F_MQ) \
2077   _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
2078
2079   static struct feat_struct proto_feat_array[] = {
2080 #define _(s) { .str = #s, .bit = s},
2081     foreach_protocol_feature
2082 #undef _
2083     {.str = NULL}
2084   };
2085
2086   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2087     {
2088       if (unformat
2089           (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
2090         {
2091           hi = vnet_get_hw_interface (vnm, hw_if_index);
2092           if (vhost_user_device_class.index != hi->dev_class_index)
2093             {
2094               error = clib_error_return (0, "unknown input `%U'",
2095                                          format_unformat_error, input);
2096               goto done;
2097             }
2098           vec_add1 (hw_if_indices, hw_if_index);
2099         }
2100       else if (unformat (input, "descriptors") || unformat (input, "desc"))
2101         show_descr = 1;
2102       else if (unformat (input, "verbose"))
2103         show_verbose = 1;
2104       else
2105         {
2106           error = clib_error_return (0, "unknown input `%U'",
2107                                      format_unformat_error, input);
2108           goto done;
2109         }
2110     }
2111   if (vec_len (hw_if_indices) == 0)
2112     {
2113       pool_foreach (vui, vum->vhost_user_interfaces,
2114                     vec_add1 (hw_if_indices, vui->hw_if_index);
2115         );
2116     }
2117   vlib_cli_output (vm, "Virtio vhost-user interfaces");
2118   vlib_cli_output (vm, "Global:\n  coalesce frames %d time %e",
2119                    vum->coalesce_frames, vum->coalesce_time);
2120   vlib_cli_output (vm, "  Number of rx virtqueues in interrupt mode: %d",
2121                    vum->ifq_count);
2122   vlib_cli_output (vm, "  Number of GSO interfaces: %d", vum->gso_count);
2123
2124   for (i = 0; i < vec_len (hw_if_indices); i++)
2125     {
2126       hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
2127       vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
2128       vlib_cli_output (vm, "Interface: %U (ifindex %d)",
2129                        format_vnet_hw_if_index_name, vnm, hw_if_indices[i],
2130                        hw_if_indices[i]);
2131       if (vui->enable_gso)
2132         vlib_cli_output (vm, "  GSO enable");
2133       if (vui->enable_packed)
2134         vlib_cli_output (vm, "  Packed ring enable");
2135
2136       vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
2137                        " features mask (0x%llx): \n"
2138                        " features (0x%llx): \n",
2139                        vui->virtio_net_hdr_sz, vui->feature_mask,
2140                        vui->features);
2141
2142       feat_entry = (struct feat_struct *) &feat_array;
2143       while (feat_entry->str)
2144         {
2145           if (vui->features & (1ULL << feat_entry->bit))
2146             vlib_cli_output (vm, "   %s (%d)", feat_entry->str,
2147                              feat_entry->bit);
2148           feat_entry++;
2149         }
2150
2151       vlib_cli_output (vm, "  protocol features (0x%llx)",
2152                        vui->protocol_features);
2153       feat_entry = (struct feat_struct *) &proto_feat_array;
2154       while (feat_entry->str)
2155         {
2156           if (vui->protocol_features & (1ULL << feat_entry->bit))
2157             vlib_cli_output (vm, "   %s (%d)", feat_entry->str,
2158                              feat_entry->bit);
2159           feat_entry++;
2160         }
2161
2162       vlib_cli_output (vm, "\n");
2163
2164       vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
2165                        vui->sock_filename,
2166                        (vui->unix_server_index != ~0) ? "server" : "client",
2167                        strerror (vui->sock_errno));
2168
2169       vlib_cli_output (vm, " rx placement: ");
2170
2171       for (qid = 1; qid < VHOST_VRING_MAX_N / 2; qid += 2)
2172         {
2173           vnet_main_t *vnm = vnet_get_main ();
2174           uword thread_index;
2175           vnet_hw_if_rx_mode mode;
2176           vhost_user_vring_t *txvq = &vui->vrings[qid];
2177
2178           if (txvq->qid == -1)
2179             continue;
2180           thread_index =
2181             vnet_get_device_input_thread_index (vnm, vui->hw_if_index,
2182                                                 qid >> 1);
2183           vnet_hw_interface_get_rx_mode (vnm, vui->hw_if_index, qid >> 1,
2184                                          &mode);
2185           vlib_cli_output (vm, "   thread %d on vring %d, %U\n",
2186                            thread_index, qid,
2187                            format_vnet_hw_if_rx_mode, mode);
2188         }
2189
2190       vlib_cli_output (vm, " tx placement: %s\n",
2191                        vui->use_tx_spinlock ? "spin-lock" : "lock-free");
2192
2193       vec_foreach_index (ci, vui->per_cpu_tx_qid)
2194       {
2195         vlib_cli_output (vm, "   thread %d on vring %d\n", ci,
2196                          VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
2197       }
2198
2199       vlib_cli_output (vm, "\n");
2200
2201       vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
2202
2203       if (vui->nregions)
2204         {
2205           vlib_cli_output (vm,
2206                            " region fd    guest_phys_addr    memory_size        userspace_addr     mmap_offset        mmap_addr\n");
2207           vlib_cli_output (vm,
2208                            " ====== ===== ================== ================== ================== ================== ==================\n");
2209         }
2210       for (j = 0; j < vui->nregions; j++)
2211         {
2212           vlib_cli_output (vm,
2213                            "  %d     %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
2214                            j, vui->region_mmap_fd[j],
2215                            vui->regions[j].guest_phys_addr,
2216                            vui->regions[j].memory_size,
2217                            vui->regions[j].userspace_addr,
2218                            vui->regions[j].mmap_offset,
2219                            pointer_to_uword (vui->region_mmap_addr[j]));
2220         }
2221       for (q = 0; q < VHOST_VRING_MAX_N; q++)
2222         {
2223           if (!vui->vrings[q].started)
2224             continue;
2225
2226           vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
2227                            (q & 1) ? "RX" : "TX",
2228                            vui->vrings[q].enabled ? "" : " disabled");
2229
2230           vlib_cli_output (vm,
2231                            "  qsz %d last_avail_idx %d last_used_idx %d\n",
2232                            vui->vrings[q].qsz_mask + 1,
2233                            vui->vrings[q].last_avail_idx,
2234                            vui->vrings[q].last_used_idx);
2235
2236           if (vhost_user_is_packed_ring_supported (vui))
2237             vhost_user_show_desc_packed (vm, vui, q, show_descr,
2238                                          show_verbose);
2239           else
2240             vhost_user_show_desc (vm, vui, q, show_descr, show_verbose);
2241         }
2242       vlib_cli_output (vm, "\n");
2243     }
2244 done:
2245   vec_free (hw_if_indices);
2246   return error;
2247 }
2248
2249 /*
2250  * CLI functions
2251  */
2252
2253 /*?
2254  * Create a vHost User interface. Once created, a new virtual interface
2255  * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
2256  * is the next free index.
2257  *
2258  * There are several parameters associated with a vHost interface:
2259  *
2260  * - <b>socket <socket-filename></b> - Name of the linux socket used by hypervisor
2261  * and VPP to manage the vHost interface. If in '<em>server</em>' mode, VPP will
2262  * create the socket if it does not already exist. If in '<em>client</em>' mode,
2263  * hypervisor will create the socket if it does not already exist. The VPP code
2264  * is indifferent to the file location. However, if SELinux is enabled, then the
2265  * socket needs to be created in '<em>/var/run/vpp/</em>'.
2266  *
2267  * - <b>server</b> - Optional flag to indicate that VPP should be the server for
2268  * the linux socket. If not provided, VPP will be the client. In '<em>server</em>'
2269  *  mode, the VM can be reset without tearing down the vHost Interface. In
2270  * '<em>client</em>' mode, VPP can be reset without bringing down the VM and
2271  * tearing down the vHost Interface.
2272  *
2273  * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
2274  * startup. <b>This is intended for degugging only.</b> It is recommended that this
2275  * parameter not be used except by experienced users. By default, all supported
2276  * features will be advertised. Otherwise, provide the set of features desired.
2277  *   - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
2278  *   - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
2279  *   - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
2280  *   - 0x000400000 (22) - VIRTIO_NET_F_MQ
2281  *   - 0x004000000 (26) - VHOST_F_LOG_ALL
2282  *   - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
2283  *   - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
2284  *   - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
2285  *   - 0x100000000 (32) - VIRTIO_F_VERSION_1
2286  *
2287  * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
2288  * X:X:X:X:X:X unix or X.X.X cisco format.
2289  *
2290  * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
2291  * in the name to be specified. If instance already exists, name will be used
2292  * anyway and multiple instances will have the same name. Use with caution.
2293  *
2294  * @cliexpar
2295  * Example of how to create a vhost interface with VPP as the client and all features enabled:
2296  * @cliexstart{create vhost-user socket /var/run/vpp/vhost1.sock}
2297  * VirtualEthernet0/0/0
2298  * @cliexend
2299  * Example of how to create a vhost interface with VPP as the server and with just
2300  * multiple queues enabled:
2301  * @cliexstart{create vhost-user socket /var/run/vpp/vhost2.sock server feature-mask 0x40400000}
2302  * VirtualEthernet0/0/1
2303  * @cliexend
2304  * Once the vHost interface is created, enable the interface using:
2305  * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
2306 ?*/
2307 /* *INDENT-OFF* */
2308 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
2309     .path = "create vhost-user",
2310     .short_help = "create vhost-user socket <socket-filename> [server] "
2311     "[feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>] [gso] "
2312     "[packed]",
2313     .function = vhost_user_connect_command_fn,
2314     .is_mp_safe = 1,
2315 };
2316 /* *INDENT-ON* */
2317
2318 /*?
2319  * Delete a vHost User interface using the interface name or the
2320  * software interface index. Use the '<em>show interface</em>'
2321  * command to determine the software interface index. On deletion,
2322  * the linux socket will not be deleted.
2323  *
2324  * @cliexpar
2325  * Example of how to delete a vhost interface by name:
2326  * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
2327  * Example of how to delete a vhost interface by software interface index:
2328  * @cliexcmd{delete vhost-user sw_if_index 1}
2329 ?*/
2330 /* *INDENT-OFF* */
2331 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
2332     .path = "delete vhost-user",
2333     .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
2334     .function = vhost_user_delete_command_fn,
2335 };
2336
2337 /*?
2338  * Display the attributes of a single vHost User interface (provide interface
2339  * name), multiple vHost User interfaces (provide a list of interface names seperated
2340  * by spaces) or all Vhost User interfaces (omit an interface name to display all
2341  * vHost interfaces).
2342  *
2343  * @cliexpar
2344  * @parblock
2345  * Example of how to display a vhost interface:
2346  * @cliexstart{show vhost-user VirtualEthernet0/0/0}
2347  * Virtio vhost-user interfaces
2348  * Global:
2349  *   coalesce frames 32 time 1e-3
2350  * Interface: VirtualEthernet0/0/0 (ifindex 1)
2351  * virtio_net_hdr_sz 12
2352  *  features mask (0xffffffffffffffff):
2353  *  features (0x50408000):
2354  *    VIRTIO_NET_F_MRG_RXBUF (15)
2355  *    VIRTIO_NET_F_MQ (22)
2356  *    VIRTIO_F_INDIRECT_DESC (28)
2357  *    VHOST_USER_F_PROTOCOL_FEATURES (30)
2358  *   protocol features (0x3)
2359  *    VHOST_USER_PROTOCOL_F_MQ (0)
2360  *    VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
2361  *
2362  *  socket filename /var/run/vpp/vhost1.sock type client errno "Success"
2363  *
2364  * rx placement:
2365  *    thread 1 on vring 1
2366  *    thread 1 on vring 5
2367  *    thread 2 on vring 3
2368  *    thread 2 on vring 7
2369  *  tx placement: spin-lock
2370  *    thread 0 on vring 0
2371  *    thread 1 on vring 2
2372  *    thread 2 on vring 0
2373  *
2374  * Memory regions (total 2)
2375  * region fd    guest_phys_addr    memory_size        userspace_addr     mmap_offset        mmap_addr
2376  * ====== ===== ================== ================== ================== ================== ==================
2377  *   0     60    0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
2378  *   1     61    0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
2379  *
2380  *  Virtqueue 0 (TX)
2381  *   qsz 256 last_avail_idx 0 last_used_idx 0
2382  *   avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2383  *   kickfd 62 callfd 64 errfd -1
2384  *
2385  *  Virtqueue 1 (RX)
2386  *   qsz 256 last_avail_idx 0 last_used_idx 0
2387  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2388  *   kickfd 65 callfd 66 errfd -1
2389  *
2390  *  Virtqueue 2 (TX)
2391  *   qsz 256 last_avail_idx 0 last_used_idx 0
2392  *   avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2393  *   kickfd 63 callfd 70 errfd -1
2394  *
2395  *  Virtqueue 3 (RX)
2396  *   qsz 256 last_avail_idx 0 last_used_idx 0
2397  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2398  *   kickfd 72 callfd 74 errfd -1
2399  *
2400  *  Virtqueue 4 (TX disabled)
2401  *   qsz 256 last_avail_idx 0 last_used_idx 0
2402  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2403  *   kickfd 76 callfd 78 errfd -1
2404  *
2405  *  Virtqueue 5 (RX disabled)
2406  *   qsz 256 last_avail_idx 0 last_used_idx 0
2407  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2408  *   kickfd 80 callfd 82 errfd -1
2409  *
2410  *  Virtqueue 6 (TX disabled)
2411  *   qsz 256 last_avail_idx 0 last_used_idx 0
2412  *  avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2413  *   kickfd 84 callfd 86 errfd -1
2414  *
2415  *  Virtqueue 7 (RX disabled)
2416  *   qsz 256 last_avail_idx 0 last_used_idx 0
2417  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
2418  *   kickfd 88 callfd 90 errfd -1
2419  *
2420  * @cliexend
2421  *
2422  * The optional '<em>descriptors</em>' parameter will display the same output as
2423  * the previous example but will include the descriptor table for each queue.
2424  * The output is truncated below:
2425  * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
2426  * Virtio vhost-user interfaces
2427  * Global:
2428  *   coalesce frames 32 time 1e-3
2429  * Interface: VirtualEthernet0/0/0 (ifindex 1)
2430  * virtio_net_hdr_sz 12
2431  *  features mask (0xffffffffffffffff):
2432  *  features (0x50408000):
2433  *    VIRTIO_NET_F_MRG_RXBUF (15)
2434  *    VIRTIO_NET_F_MQ (22)
2435  * :
2436  *  Virtqueue 0 (TX)
2437  *   qsz 256 last_avail_idx 0 last_used_idx 0
2438  *   avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
2439  *   kickfd 62 callfd 64 errfd -1
2440  *
2441  *   descriptor table:
2442  *    id          addr         len  flags  next      user_addr
2443  *   ===== ================== ===== ====== ===== ==================
2444  *   0     0x0000000010b6e974 2060  0x0002 1     0x00002aabbc76e974
2445  *   1     0x0000000010b6e034 2060  0x0002 2     0x00002aabbc76e034
2446  *   2     0x0000000010b6d6f4 2060  0x0002 3     0x00002aabbc76d6f4
2447  *   3     0x0000000010b6cdb4 2060  0x0002 4     0x00002aabbc76cdb4
2448  *   4     0x0000000010b6c474 2060  0x0002 5     0x00002aabbc76c474
2449  *   5     0x0000000010b6bb34 2060  0x0002 6     0x00002aabbc76bb34
2450  *   6     0x0000000010b6b1f4 2060  0x0002 7     0x00002aabbc76b1f4
2451  *   7     0x0000000010b6a8b4 2060  0x0002 8     0x00002aabbc76a8b4
2452  *   8     0x0000000010b69f74 2060  0x0002 9     0x00002aabbc769f74
2453  *   9     0x0000000010b69634 2060  0x0002 10    0x00002aabbc769634
2454  *   10    0x0000000010b68cf4 2060  0x0002 11    0x00002aabbc768cf4
2455  * :
2456  *   249   0x0000000000000000 0     0x0000 250   0x00002aab2b400000
2457  *   250   0x0000000000000000 0     0x0000 251   0x00002aab2b400000
2458  *   251   0x0000000000000000 0     0x0000 252   0x00002aab2b400000
2459  *   252   0x0000000000000000 0     0x0000 253   0x00002aab2b400000
2460  *   253   0x0000000000000000 0     0x0000 254   0x00002aab2b400000
2461  *   254   0x0000000000000000 0     0x0000 255   0x00002aab2b400000
2462  *   255   0x0000000000000000 0     0x0000 32768 0x00002aab2b400000
2463  *
2464  *  Virtqueue 1 (RX)
2465  *   qsz 256 last_avail_idx 0 last_used_idx 0
2466  * :
2467  * @cliexend
2468  * @endparblock
2469 ?*/
2470 /* *INDENT-OFF* */
2471 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
2472     .path = "show vhost-user",
2473     .short_help = "show vhost-user [<interface> [<interface> [..]]] "
2474     "[[descriptors] [verbose]]",
2475     .function = show_vhost_user_command_fn,
2476 };
2477 /* *INDENT-ON* */
2478
2479
2480 static clib_error_t *
2481 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
2482 {
2483   vhost_user_main_t *vum = &vhost_user_main;
2484
2485   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2486     {
2487       if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
2488         ;
2489       else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
2490         ;
2491       else if (unformat (input, "dont-dump-memory"))
2492         vum->dont_dump_vhost_user_memory = 1;
2493       else
2494         return clib_error_return (0, "unknown input `%U'",
2495                                   format_unformat_error, input);
2496     }
2497
2498   return 0;
2499 }
2500
2501 /* vhost-user { ... } configuration. */
2502 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
2503
2504 void
2505 vhost_user_unmap_all (void)
2506 {
2507   vhost_user_main_t *vum = &vhost_user_main;
2508   vhost_user_intf_t *vui;
2509
2510   if (vum->dont_dump_vhost_user_memory)
2511     {
2512       pool_foreach (vui, vum->vhost_user_interfaces,
2513                     unmap_all_mem_regions (vui);
2514         );
2515     }
2516 }
2517
2518 /*
2519  * fd.io coding-style-patch-verification: ON
2520  *
2521  * Local Variables:
2522  * eval: (c-set-style "gnu")
2523  * End:
2524  */