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